cardano-crypto-class-2.0.0: Type classes abstracting over cryptography primitives for Cardano
Safe HaskellNone
LanguageHaskell2010

Cardano.Crypto.DSIGN.Class

Description

Abstract digital signatures.

Synopsis

DSIGN algorithm class

class (Typeable v, Show (VerKeyDSIGN v), Eq (VerKeyDSIGN v), Show (SignKeyDSIGN v), Show (SigDSIGN v), Eq (SigDSIGN v), NoThunks (SigDSIGN v), NoThunks (SignKeyDSIGN v), NoThunks (VerKeyDSIGN v), KnownNat (SeedSizeDSIGN v), KnownNat (SizeVerKeyDSIGN v), KnownNat (SizeSignKeyDSIGN v), KnownNat (SizeSigDSIGN v)) => DSIGNAlgorithm v where Source #

Minimal complete definition

algorithmNameDSIGN, deriveVerKeyDSIGN, signDSIGN, verifyDSIGN, genKeyDSIGN, rawSerialiseVerKeyDSIGN, rawSerialiseSignKeyDSIGN, rawSerialiseSigDSIGN, rawDeserialiseVerKeyDSIGN, rawDeserialiseSignKeyDSIGN, rawDeserialiseSigDSIGN

Associated Types

type SeedSizeDSIGN v :: Nat Source #

type SizeVerKeyDSIGN v :: Nat Source #

type SizeSignKeyDSIGN v :: Nat Source #

type SizeSigDSIGN v :: Nat Source #

data VerKeyDSIGN v :: Type Source #

data SignKeyDSIGN v :: Type Source #

data SigDSIGN v :: Type Source #

type ContextDSIGN v :: Type Source #

Context required to run the DSIGN algorithm

Unit by default (no context required)

type ContextDSIGN v = ()

type Signable v :: Type -> Constraint Source #

type Signable v = Empty

Methods

algorithmNameDSIGN :: proxy v -> String Source #

deriveVerKeyDSIGN :: SignKeyDSIGN v -> VerKeyDSIGN v Source #

hashVerKeyDSIGN :: HashAlgorithm h => VerKeyDSIGN v -> Hash h (VerKeyDSIGN v) Source #

signDSIGN :: (Signable v a, HasCallStack) => ContextDSIGN v -> a -> SignKeyDSIGN v -> SigDSIGN v Source #

verifyDSIGN :: (Signable v a, HasCallStack) => ContextDSIGN v -> VerKeyDSIGN v -> a -> SigDSIGN v -> Either String () Source #

genKeyDSIGN :: Seed -> SignKeyDSIGN v Source #

rawSerialiseVerKeyDSIGN :: VerKeyDSIGN v -> ByteString Source #

rawSerialiseSignKeyDSIGN :: SignKeyDSIGN v -> ByteString Source #

rawSerialiseSigDSIGN :: SigDSIGN v -> ByteString Source #

rawDeserialiseVerKeyDSIGN :: ByteString -> Maybe (VerKeyDSIGN v) Source #

rawDeserialiseSignKeyDSIGN :: ByteString -> Maybe (SignKeyDSIGN v) Source #

rawDeserialiseSigDSIGN :: ByteString -> Maybe (SigDSIGN v) Source #

Instances

Instances details
DSIGNAlgorithm NeverDSIGN Source # 
Instance details

Defined in Cardano.Crypto.DSIGN.NeverUsed

Associated Types

type SeedSizeDSIGN NeverDSIGN :: Nat Source #

type SizeVerKeyDSIGN NeverDSIGN :: Nat Source #

type SizeSignKeyDSIGN NeverDSIGN :: Nat Source #

type SizeSigDSIGN NeverDSIGN :: Nat Source #

data VerKeyDSIGN NeverDSIGN Source #

data SignKeyDSIGN NeverDSIGN Source #

data SigDSIGN NeverDSIGN Source #

type ContextDSIGN NeverDSIGN Source #

type Signable NeverDSIGN :: Type -> Constraint Source #

Methods

algorithmNameDSIGN :: proxy NeverDSIGN -> String Source #

deriveVerKeyDSIGN :: SignKeyDSIGN NeverDSIGN -> VerKeyDSIGN NeverDSIGN Source #

hashVerKeyDSIGN :: HashAlgorithm h => VerKeyDSIGN NeverDSIGN -> Hash h (VerKeyDSIGN NeverDSIGN) Source #

signDSIGN :: (Signable NeverDSIGN a, HasCallStack) => ContextDSIGN NeverDSIGN -> a -> SignKeyDSIGN NeverDSIGN -> SigDSIGN NeverDSIGN Source #

verifyDSIGN :: (Signable NeverDSIGN a, HasCallStack) => ContextDSIGN NeverDSIGN -> VerKeyDSIGN NeverDSIGN -> a -> SigDSIGN NeverDSIGN -> Either String () Source #

genKeyDSIGN :: Seed -> SignKeyDSIGN NeverDSIGN Source #

rawSerialiseVerKeyDSIGN :: VerKeyDSIGN NeverDSIGN -> ByteString Source #

rawSerialiseSignKeyDSIGN :: SignKeyDSIGN NeverDSIGN -> ByteString Source #

rawSerialiseSigDSIGN :: SigDSIGN NeverDSIGN -> ByteString Source #

rawDeserialiseVerKeyDSIGN :: ByteString -> Maybe (VerKeyDSIGN NeverDSIGN) Source #

rawDeserialiseSignKeyDSIGN :: ByteString -> Maybe (SignKeyDSIGN NeverDSIGN) Source #

rawDeserialiseSigDSIGN :: ByteString -> Maybe (SigDSIGN NeverDSIGN) Source #

DSIGNAlgorithm MockDSIGN Source # 
Instance details

Defined in Cardano.Crypto.DSIGN.Mock

Associated Types

type SeedSizeDSIGN MockDSIGN :: Nat Source #

type SizeVerKeyDSIGN MockDSIGN :: Nat Source #

type SizeSignKeyDSIGN MockDSIGN :: Nat Source #

type SizeSigDSIGN MockDSIGN :: Nat Source #

data VerKeyDSIGN MockDSIGN Source #

data SignKeyDSIGN MockDSIGN Source #

data SigDSIGN MockDSIGN Source #

type ContextDSIGN MockDSIGN Source #

type Signable MockDSIGN :: Type -> Constraint Source #

Methods

algorithmNameDSIGN :: proxy MockDSIGN -> String Source #

deriveVerKeyDSIGN :: SignKeyDSIGN MockDSIGN -> VerKeyDSIGN MockDSIGN Source #

hashVerKeyDSIGN :: HashAlgorithm h => VerKeyDSIGN MockDSIGN -> Hash h (VerKeyDSIGN MockDSIGN) Source #

signDSIGN :: (Signable MockDSIGN a, HasCallStack) => ContextDSIGN MockDSIGN -> a -> SignKeyDSIGN MockDSIGN -> SigDSIGN MockDSIGN Source #

verifyDSIGN :: (Signable MockDSIGN a, HasCallStack) => ContextDSIGN MockDSIGN -> VerKeyDSIGN MockDSIGN -> a -> SigDSIGN MockDSIGN -> Either String () Source #

genKeyDSIGN :: Seed -> SignKeyDSIGN MockDSIGN Source #

rawSerialiseVerKeyDSIGN :: VerKeyDSIGN MockDSIGN -> ByteString Source #

rawSerialiseSignKeyDSIGN :: SignKeyDSIGN MockDSIGN -> ByteString Source #

rawSerialiseSigDSIGN :: SigDSIGN MockDSIGN -> ByteString Source #

rawDeserialiseVerKeyDSIGN :: ByteString -> Maybe (VerKeyDSIGN MockDSIGN) Source #

rawDeserialiseSignKeyDSIGN :: ByteString -> Maybe (SignKeyDSIGN MockDSIGN) Source #

rawDeserialiseSigDSIGN :: ByteString -> Maybe (SigDSIGN MockDSIGN) Source #

DSIGNAlgorithm Ed448DSIGN Source # 
Instance details

Defined in Cardano.Crypto.DSIGN.Ed448

Associated Types

type SeedSizeDSIGN Ed448DSIGN :: Nat Source #

type SizeVerKeyDSIGN Ed448DSIGN :: Nat Source #

type SizeSignKeyDSIGN Ed448DSIGN :: Nat Source #

type SizeSigDSIGN Ed448DSIGN :: Nat Source #

data VerKeyDSIGN Ed448DSIGN Source #

data SignKeyDSIGN Ed448DSIGN Source #

data SigDSIGN Ed448DSIGN Source #

type ContextDSIGN Ed448DSIGN Source #

type Signable Ed448DSIGN :: Type -> Constraint Source #

Methods

algorithmNameDSIGN :: proxy Ed448DSIGN -> String Source #

deriveVerKeyDSIGN :: SignKeyDSIGN Ed448DSIGN -> VerKeyDSIGN Ed448DSIGN Source #

hashVerKeyDSIGN :: HashAlgorithm h => VerKeyDSIGN Ed448DSIGN -> Hash h (VerKeyDSIGN Ed448DSIGN) Source #

signDSIGN :: (Signable Ed448DSIGN a, HasCallStack) => ContextDSIGN Ed448DSIGN -> a -> SignKeyDSIGN Ed448DSIGN -> SigDSIGN Ed448DSIGN Source #

verifyDSIGN :: (Signable Ed448DSIGN a, HasCallStack) => ContextDSIGN Ed448DSIGN -> VerKeyDSIGN Ed448DSIGN -> a -> SigDSIGN Ed448DSIGN -> Either String () Source #

genKeyDSIGN :: Seed -> SignKeyDSIGN Ed448DSIGN Source #

rawSerialiseVerKeyDSIGN :: VerKeyDSIGN Ed448DSIGN -> ByteString Source #

rawSerialiseSignKeyDSIGN :: SignKeyDSIGN Ed448DSIGN -> ByteString Source #

rawSerialiseSigDSIGN :: SigDSIGN Ed448DSIGN -> ByteString Source #

rawDeserialiseVerKeyDSIGN :: ByteString -> Maybe (VerKeyDSIGN Ed448DSIGN) Source #

rawDeserialiseSignKeyDSIGN :: ByteString -> Maybe (SignKeyDSIGN Ed448DSIGN) Source #

rawDeserialiseSigDSIGN :: ByteString -> Maybe (SigDSIGN Ed448DSIGN) Source #

DSIGNAlgorithm Ed25519DSIGN Source # 
Instance details

Defined in Cardano.Crypto.DSIGN.Ed25519

Associated Types

type SeedSizeDSIGN Ed25519DSIGN :: Nat Source #

type SizeVerKeyDSIGN Ed25519DSIGN :: Nat Source #

type SizeSignKeyDSIGN Ed25519DSIGN :: Nat Source #

type SizeSigDSIGN Ed25519DSIGN :: Nat Source #

data VerKeyDSIGN Ed25519DSIGN Source #

data SignKeyDSIGN Ed25519DSIGN Source #

data SigDSIGN Ed25519DSIGN Source #

type ContextDSIGN Ed25519DSIGN Source #

type Signable Ed25519DSIGN :: Type -> Constraint Source #

Methods

algorithmNameDSIGN :: proxy Ed25519DSIGN -> String Source #

deriveVerKeyDSIGN :: SignKeyDSIGN Ed25519DSIGN -> VerKeyDSIGN Ed25519DSIGN Source #

hashVerKeyDSIGN :: HashAlgorithm h => VerKeyDSIGN Ed25519DSIGN -> Hash h (VerKeyDSIGN Ed25519DSIGN) Source #

signDSIGN :: (Signable Ed25519DSIGN a, HasCallStack) => ContextDSIGN Ed25519DSIGN -> a -> SignKeyDSIGN Ed25519DSIGN -> SigDSIGN Ed25519DSIGN Source #

verifyDSIGN :: (Signable Ed25519DSIGN a, HasCallStack) => ContextDSIGN Ed25519DSIGN -> VerKeyDSIGN Ed25519DSIGN -> a -> SigDSIGN Ed25519DSIGN -> Either String () Source #

genKeyDSIGN :: Seed -> SignKeyDSIGN Ed25519DSIGN Source #

rawSerialiseVerKeyDSIGN :: VerKeyDSIGN Ed25519DSIGN -> ByteString Source #

rawSerialiseSignKeyDSIGN :: SignKeyDSIGN Ed25519DSIGN -> ByteString Source #

rawSerialiseSigDSIGN :: SigDSIGN Ed25519DSIGN -> ByteString Source #

rawDeserialiseVerKeyDSIGN :: ByteString -> Maybe (VerKeyDSIGN Ed25519DSIGN) Source #

rawDeserialiseSignKeyDSIGN :: ByteString -> Maybe (SignKeyDSIGN Ed25519DSIGN) Source #

rawDeserialiseSigDSIGN :: ByteString -> Maybe (SigDSIGN Ed25519DSIGN) Source #

data Seed Source #

A seed contains a finite number of bytes, and is used for seeding cryptographic algorithms including key generation.

This is not itself a PRNG, but can be used to seed a PRNG.

Instances

Instances details
Eq Seed Source # 
Instance details

Defined in Cardano.Crypto.Seed

Methods

(==) :: Seed -> Seed -> Bool #

(/=) :: Seed -> Seed -> Bool #

Show Seed Source # 
Instance details

Defined in Cardano.Crypto.Seed

Methods

showsPrec :: Int -> Seed -> ShowS #

show :: Seed -> String #

showList :: [Seed] -> ShowS #

Semigroup Seed Source # 
Instance details

Defined in Cardano.Crypto.Seed

Methods

(<>) :: Seed -> Seed -> Seed #

sconcat :: NonEmpty Seed -> Seed #

stimes :: Integral b => b -> Seed -> Seed #

Monoid Seed Source # 
Instance details

Defined in Cardano.Crypto.Seed

Methods

mempty :: Seed #

mappend :: Seed -> Seed -> Seed #

mconcat :: [Seed] -> Seed #

NFData Seed Source # 
Instance details

Defined in Cardano.Crypto.Seed

Methods

rnf :: Seed -> () #

NoThunks Seed Source # 
Instance details

Defined in Cardano.Crypto.Seed

Methods

noThunks :: Context -> Seed -> IO (Maybe ThunkInfo) Source #

wNoThunks :: Context -> Seed -> IO (Maybe ThunkInfo) Source #

showTypeOf :: Proxy Seed -> String Source #

seedSizeDSIGN :: forall v proxy. DSIGNAlgorithm v => proxy v -> Word Source #

The upper bound on the Seed size needed by genKeyDSIGN

sizeVerKeyDSIGN :: forall v proxy. DSIGNAlgorithm v => proxy v -> Word Source #

sizeSignKeyDSIGN :: forall v proxy. DSIGNAlgorithm v => proxy v -> Word Source #

sizeSigDSIGN :: forall v proxy. DSIGNAlgorithm v => proxy v -> Word Source #

SignedDSIGN wrapper

newtype SignedDSIGN v a Source #

Constructors

SignedDSIGN (SigDSIGN v) 

Instances

Instances details
DSIGNAlgorithm v => Eq (SignedDSIGN v a) Source # 
Instance details

Defined in Cardano.Crypto.DSIGN.Class

Methods

(==) :: SignedDSIGN v a -> SignedDSIGN v a -> Bool #

(/=) :: SignedDSIGN v a -> SignedDSIGN v a -> Bool #

DSIGNAlgorithm v => Show (SignedDSIGN v a) Source # 
Instance details

Defined in Cardano.Crypto.DSIGN.Class

Methods

showsPrec :: Int -> SignedDSIGN v a -> ShowS #

show :: SignedDSIGN v a -> String #

showList :: [SignedDSIGN v a] -> ShowS #

Generic (SignedDSIGN v a) Source # 
Instance details

Defined in Cardano.Crypto.DSIGN.Class

Associated Types

type Rep (SignedDSIGN v a) :: Type -> Type #

Methods

from :: SignedDSIGN v a -> Rep (SignedDSIGN v a) x #

to :: Rep (SignedDSIGN v a) x -> SignedDSIGN v a #

DSIGNAlgorithm v => NoThunks (SignedDSIGN v a) Source # 
Instance details

Defined in Cardano.Crypto.DSIGN.Class

Methods

noThunks :: Context -> SignedDSIGN v a -> IO (Maybe ThunkInfo) Source #

wNoThunks :: Context -> SignedDSIGN v a -> IO (Maybe ThunkInfo) Source #

showTypeOf :: Proxy (SignedDSIGN v a) -> String Source #

type Rep (SignedDSIGN v a) Source # 
Instance details

Defined in Cardano.Crypto.DSIGN.Class

type Rep (SignedDSIGN v a) = D1 ('MetaData "SignedDSIGN" "Cardano.Crypto.DSIGN.Class" "cardano-crypto-class-2.0.0-8Wg6S5FD924IEUDdpkXXc" 'True) (C1 ('MetaCons "SignedDSIGN" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SigDSIGN v))))

signedDSIGN :: (DSIGNAlgorithm v, Signable v a) => ContextDSIGN v -> a -> SignKeyDSIGN v -> SignedDSIGN v a Source #

verifySignedDSIGN :: (DSIGNAlgorithm v, Signable v a, HasCallStack) => ContextDSIGN v -> VerKeyDSIGN v -> a -> SignedDSIGN v a -> Either String () Source #

CBOR encoding and decoding

encodeVerKeyDSIGN :: DSIGNAlgorithm v => VerKeyDSIGN v -> Encoding Source #

decodeVerKeyDSIGN :: forall v s. DSIGNAlgorithm v => Decoder s (VerKeyDSIGN v) Source #

encodeSignKeyDSIGN :: DSIGNAlgorithm v => SignKeyDSIGN v -> Encoding Source #

decodeSignKeyDSIGN :: forall v s. DSIGNAlgorithm v => Decoder s (SignKeyDSIGN v) Source #

encodeSigDSIGN :: DSIGNAlgorithm v => SigDSIGN v -> Encoding Source #

decodeSigDSIGN :: forall v s. DSIGNAlgorithm v => Decoder s (SigDSIGN v) Source #

encodeSignedDSIGN :: DSIGNAlgorithm v => SignedDSIGN v a -> Encoding Source #

decodeSignedDSIGN :: DSIGNAlgorithm v => Decoder s (SignedDSIGN v a) Source #

Encoded Size expresssions

encodedVerKeyDSIGNSizeExpr :: forall v. DSIGNAlgorithm v => Proxy (VerKeyDSIGN v) -> Size Source #

Size expression for VerKeyDSIGN which is using sizeVerKeyDSIGN encoded as Size.

encodedSignKeyDESIGNSizeExpr :: forall v. DSIGNAlgorithm v => Proxy (SignKeyDSIGN v) -> Size Source #

Size expression for SignKeyDSIGN which is using sizeSignKeyDSIGN encoded as Size.

encodedSigDSIGNSizeExpr :: forall v. DSIGNAlgorithm v => Proxy (SigDSIGN v) -> Size Source #

Size expression for SigDSIGN which is using sizeSigDSIGN encoded as Size.