cardano-crypto-class-2.1.1.0: Type classes abstracting over cryptography primitives for Cardano
Safe HaskellSafe-Inferred
LanguageHaskell2010

Cardano.Crypto.DSIGNM.Class

Description

Abstract digital signatures.

Synopsis

DSIGNMM algorithm class

class (Typeable v, Show (VerKeyDSIGNM v), Eq (VerKeyDSIGNM v), Show (SignKeyDSIGNM v), Show (SigDSIGNM v), Eq (SigDSIGNM v), NoThunks (SigDSIGNM v), NoThunks (SignKeyDSIGNM v), NoThunks (VerKeyDSIGNM v), KnownNat (SeedSizeDSIGNM v), KnownNat (SizeVerKeyDSIGNM v), KnownNat (SizeSignKeyDSIGNM v), KnownNat (SizeSigDSIGNM v)) => DSIGNMAlgorithmBase v where #

Minimal complete definition

algorithmNameDSIGNM, verifyDSIGNM, rawSerialiseVerKeyDSIGNM, rawSerialiseSigDSIGNM, rawDeserialiseVerKeyDSIGNM, rawDeserialiseSigDSIGNM

Associated Types

type SeedSizeDSIGNM v :: Nat #

type SizeVerKeyDSIGNM v :: Nat #

type SizeSignKeyDSIGNM v :: Nat #

type SizeSigDSIGNM v :: Nat #

data VerKeyDSIGNM v :: Type #

data SignKeyDSIGNM v :: Type #

data SigDSIGNM v :: Type #

type ContextDSIGNM v :: Type #

Context required to run the DSIGNM algorithm

Unit by default (no context required)

type ContextDSIGNM v = ()

type SignableM v :: Type -> Constraint #

type SignableM v = Empty

Methods

algorithmNameDSIGNM :: proxy v -> String #

hashVerKeyDSIGNM :: HashAlgorithm h => VerKeyDSIGNM v -> Hash h (VerKeyDSIGNM v) #

verifyDSIGNM :: (SignableM v a, HasCallStack) => ContextDSIGNM v -> VerKeyDSIGNM v -> a -> SigDSIGNM v -> Either String () #

rawSerialiseVerKeyDSIGNM :: VerKeyDSIGNM v -> ByteString #

rawSerialiseSigDSIGNM :: SigDSIGNM v -> ByteString #

rawDeserialiseVerKeyDSIGNM :: ByteString -> Maybe (VerKeyDSIGNM v) #

rawDeserialiseSigDSIGNM :: ByteString -> Maybe (SigDSIGNM v) #

Instances

Instances details
DSIGNMAlgorithmBase Ed25519DSIGNM # 
Instance details

Defined in Cardano.Crypto.DSIGN.Ed25519ML

Associated Types

type SeedSizeDSIGNM Ed25519DSIGNM :: Nat #

type SizeVerKeyDSIGNM Ed25519DSIGNM :: Nat #

type SizeSignKeyDSIGNM Ed25519DSIGNM :: Nat #

type SizeSigDSIGNM Ed25519DSIGNM :: Nat #

data VerKeyDSIGNM Ed25519DSIGNM #

data SignKeyDSIGNM Ed25519DSIGNM #

data SigDSIGNM Ed25519DSIGNM #

type ContextDSIGNM Ed25519DSIGNM #

type SignableM Ed25519DSIGNM :: Type -> Constraint #

Methods

algorithmNameDSIGNM :: proxy Ed25519DSIGNM -> String #

hashVerKeyDSIGNM :: HashAlgorithm h => VerKeyDSIGNM Ed25519DSIGNM -> Hash h (VerKeyDSIGNM Ed25519DSIGNM) #

verifyDSIGNM :: (SignableM Ed25519DSIGNM a, HasCallStack) => ContextDSIGNM Ed25519DSIGNM -> VerKeyDSIGNM Ed25519DSIGNM -> a -> SigDSIGNM Ed25519DSIGNM -> Either String () #

rawSerialiseVerKeyDSIGNM :: VerKeyDSIGNM Ed25519DSIGNM -> ByteString #

rawSerialiseSigDSIGNM :: SigDSIGNM Ed25519DSIGNM -> ByteString #

rawDeserialiseVerKeyDSIGNM :: ByteString -> Maybe (VerKeyDSIGNM Ed25519DSIGNM) #

rawDeserialiseSigDSIGNM :: ByteString -> Maybe (SigDSIGNM Ed25519DSIGNM) #

class (DSIGNMAlgorithmBase v, Monad m) => DSIGNMAlgorithm m v where #

Methods

deriveVerKeyDSIGNM :: SignKeyDSIGNM v -> m (VerKeyDSIGNM v) #

signDSIGNM :: (SignableM v a, HasCallStack) => ContextDSIGNM v -> a -> SignKeyDSIGNM v -> m (SigDSIGNM v) #

genKeyDSIGNM :: MLockedSeed (SeedSizeDSIGNM v) -> m (SignKeyDSIGNM v) #

cloneKeyDSIGNM :: SignKeyDSIGNM v -> m (SignKeyDSIGNM v) #

getSeedDSIGNM :: Proxy v -> SignKeyDSIGNM v -> m (MLockedSeed (SeedSizeDSIGNM v)) #

forgetSignKeyDSIGNM :: SignKeyDSIGNM v -> m () #

Instances

Instances details
(MonadST m, MonadSodium m, MonadThrow m) => DSIGNMAlgorithm m Ed25519DSIGNM # 
Instance details

Defined in Cardano.Crypto.DSIGN.Ed25519ML

Methods

deriveVerKeyDSIGNM :: SignKeyDSIGNM Ed25519DSIGNM -> m (VerKeyDSIGNM Ed25519DSIGNM) #

signDSIGNM :: (SignableM Ed25519DSIGNM a, HasCallStack) => ContextDSIGNM Ed25519DSIGNM -> a -> SignKeyDSIGNM Ed25519DSIGNM -> m (SigDSIGNM Ed25519DSIGNM) #

genKeyDSIGNM :: MLockedSeed (SeedSizeDSIGNM Ed25519DSIGNM) -> m (SignKeyDSIGNM Ed25519DSIGNM) #

cloneKeyDSIGNM :: SignKeyDSIGNM Ed25519DSIGNM -> m (SignKeyDSIGNM Ed25519DSIGNM) #

getSeedDSIGNM :: Proxy Ed25519DSIGNM -> SignKeyDSIGNM Ed25519DSIGNM -> m (MLockedSeed (SeedSizeDSIGNM Ed25519DSIGNM)) #

forgetSignKeyDSIGNM :: SignKeyDSIGNM Ed25519DSIGNM -> m () #

data MLockedSeed n #

A seed of size n, stored in mlocked memory. This is required to prevent the seed from leaking to disk via swapping and reclaiming or scanning memory after its content has been moved.

Instances

Instances details
(MonadSodium m, MonadST m, KnownNat n) => MEq m (MLockedSeed n) # 
Instance details

Defined in Cardano.Crypto.MLockedSeed

Methods

equalsM :: MLockedSeed n -> MLockedSeed n -> m Bool #

NFData (MLockedSeed n) # 
Instance details

Defined in Cardano.Crypto.MLockedSeed

Methods

rnf :: MLockedSeed n -> () Source #

NoThunks (MLockedSeed n) # 
Instance details

Defined in Cardano.Crypto.MLockedSeed

Methods

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

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

showTypeOf :: Proxy (MLockedSeed n) -> String Source #

seedSizeDSIGNM :: forall v proxy. DSIGNMAlgorithmBase v => proxy v -> Word #

The upper bound on the seed size needed by genKeyDSIGNM

sizeVerKeyDSIGNM :: forall v proxy. DSIGNMAlgorithmBase v => proxy v -> Word #

sizeSignKeyDSIGNM :: forall v proxy. DSIGNMAlgorithmBase v => proxy v -> Word #

sizeSigDSIGNM :: forall v proxy. DSIGNMAlgorithmBase v => proxy v -> Word #

SignedDSIGNM wrapper

newtype SignedDSIGNM v a #

Constructors

SignedDSIGNM (SigDSIGNM v) 

Instances

Instances details
Generic (SignedDSIGNM v a) # 
Instance details

Defined in Cardano.Crypto.DSIGNM.Class

Associated Types

type Rep (SignedDSIGNM v a) :: Type -> Type Source #

Methods

from :: SignedDSIGNM v a -> Rep (SignedDSIGNM v a) x Source #

to :: Rep (SignedDSIGNM v a) x -> SignedDSIGNM v a Source #

DSIGNMAlgorithmBase v => Show (SignedDSIGNM v a) # 
Instance details

Defined in Cardano.Crypto.DSIGNM.Class

Methods

showsPrec :: Int -> SignedDSIGNM v a -> ShowS Source #

show :: SignedDSIGNM v a -> String Source #

showList :: [SignedDSIGNM v a] -> ShowS Source #

DSIGNMAlgorithmBase v => Eq (SignedDSIGNM v a) # 
Instance details

Defined in Cardano.Crypto.DSIGNM.Class

Methods

(==) :: SignedDSIGNM v a -> SignedDSIGNM v a -> Bool Source #

(/=) :: SignedDSIGNM v a -> SignedDSIGNM v a -> Bool Source #

DSIGNMAlgorithmBase v => NoThunks (SignedDSIGNM v a) # 
Instance details

Defined in Cardano.Crypto.DSIGNM.Class

Methods

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

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

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

type Rep (SignedDSIGNM v a) # 
Instance details

Defined in Cardano.Crypto.DSIGNM.Class

type Rep (SignedDSIGNM v a) = D1 ('MetaData "SignedDSIGNM" "Cardano.Crypto.DSIGNM.Class" "cardano-crypto-class-2.1.1.0-inplace" 'True) (C1 ('MetaCons "SignedDSIGNM" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SigDSIGNM v))))

signedDSIGNM :: (DSIGNMAlgorithm m v, SignableM v a) => ContextDSIGNM v -> a -> SignKeyDSIGNM v -> m (SignedDSIGNM v a) #

verifySignedDSIGNM :: (DSIGNMAlgorithmBase v, SignableM v a, HasCallStack) => ContextDSIGNM v -> VerKeyDSIGNM v -> a -> SignedDSIGNM v a -> Either String () #

CBOR encoding and decoding

encodeVerKeyDSIGNM :: DSIGNMAlgorithmBase v => VerKeyDSIGNM v -> Encoding #

decodeVerKeyDSIGNM :: forall v s. DSIGNMAlgorithmBase v => Decoder s (VerKeyDSIGNM v) #

encodeSigDSIGNM :: DSIGNMAlgorithmBase v => SigDSIGNM v -> Encoding #

decodeSigDSIGNM :: forall v s. DSIGNMAlgorithmBase v => Decoder s (SigDSIGNM v) #

encodeSignedDSIGNM :: DSIGNMAlgorithmBase v => SignedDSIGNM v a -> Encoding #

decodeSignedDSIGNM :: DSIGNMAlgorithmBase v => Decoder s (SignedDSIGNM v a) #

Encoded Size expresssions

encodedVerKeyDSIGNMSizeExpr :: forall v. DSIGNMAlgorithmBase v => Proxy (VerKeyDSIGNM v) -> Size #

Size expression for VerKeyDSIGNM which is using sizeVerKeyDSIGNM encoded as Size.

encodedSignKeyDSIGNMSizeExpr :: forall v. DSIGNMAlgorithmBase v => Proxy (SignKeyDSIGNM v) -> Size #

Size expression for SignKeyDSIGNM which is using sizeSignKeyDSIGNM encoded as Size.

encodedSigDSIGNMSizeExpr :: forall v. DSIGNMAlgorithmBase v => Proxy (SigDSIGNM v) -> Size #

Size expression for SigDSIGNM which is using sizeSigDSIGNM encoded as Size.

Unsound API

class DSIGNMAlgorithm m v => UnsoundDSIGNMAlgorithm m v where #

Unsound operations on DSIGNM sign keys. These operations violate secure forgetting constraints by leaking secrets to unprotected memory. Consider using the DirectSerialise / DirectDeserialise APIs instead.

Methods

rawSerialiseSignKeyDSIGNM :: SignKeyDSIGNM v -> m ByteString #

rawDeserialiseSignKeyDSIGNM :: ByteString -> m (Maybe (SignKeyDSIGNM v)) #

Instances

Instances details
(MonadST m, MonadSodium m, MonadThrow m) => UnsoundDSIGNMAlgorithm m Ed25519DSIGNM # 
Instance details

Defined in Cardano.Crypto.DSIGN.Ed25519ML

Methods

rawSerialiseSignKeyDSIGNM :: SignKeyDSIGNM Ed25519DSIGNM -> m ByteString #

rawDeserialiseSignKeyDSIGNM :: ByteString -> m (Maybe (SignKeyDSIGNM Ed25519DSIGNM)) #

encodeSignKeyDSIGNM :: UnsoundDSIGNMAlgorithm m v => SignKeyDSIGNM v -> m Encoding #

decodeSignKeyDSIGNM :: forall m v s. UnsoundDSIGNMAlgorithm m v => Decoder s (m (SignKeyDSIGNM v)) #