Safe Haskell	None
Language	Haskell2010

Cardano.Crypto.Signing

Contents

Signature
Signing
Verification

Synopsis

newtype VerificationKey = VerificationKey {
- unVerificationKey :: XPub
}
formatFullVerificationKey :: VerificationKey -> Builder
fullVerificationKeyF :: Format r ( VerificationKey -> r)
fullVerificationKeyHexF :: Format r ( VerificationKey -> r)
shortVerificationKeyHexF :: Format r ( VerificationKey -> r)
parseFullVerificationKey :: Text -> Either VerificationKeyParseError VerificationKey
data SignTag
- = SignForTestingOnly
- | SignTx
- | SignRedeemTx
- | SignVssCert
- | SignUSProposal
- | SignCommitment
- | SignUSVote
- | SignBlock VerificationKey
- | SignCertificate
signTag :: ProtocolMagicId -> SignTag -> ByteString
signTagDecoded :: Annotated ProtocolMagicId ByteString -> SignTag -> ByteString
newtype SigningKey = SigningKey {
- unSigningKey :: XPrv
}
toVerification :: SigningKey -> VerificationKey
toCBORXPrv :: XPrv -> Encoding
fromCBORXPrv :: Decoder s XPrv
newtype Signature a = Signature XSignature
toCBORXSignature :: XSignature -> Encoding
fromCBORXSignature :: Decoder s XSignature
fullSignatureHexF :: Format r ( Signature a -> r)
parseFullSignature :: Text -> Either SignatureParseError ( Signature a)
sign :: ToCBOR a => ProtocolMagicId -> SignTag -> SigningKey -> a -> Signature a
signEncoded :: ProtocolMagicId -> SignTag -> SigningKey -> Encoding -> Signature a
signRaw :: ProtocolMagicId -> Maybe SignTag -> SigningKey -> ByteString -> Signature Raw
safeSign :: ToCBOR a => ProtocolMagicId -> SignTag -> SafeSigner -> a -> Signature a
safeSignRaw :: ProtocolMagicId -> Maybe SignTag -> SafeSigner -> ByteString -> Signature Raw
verifySignature :: (a -> Encoding ) -> ProtocolMagicId -> SignTag -> VerificationKey -> a -> Signature a -> Bool
verifySignatureDecoded :: Decoded t => Annotated ProtocolMagicId ByteString -> SignTag -> VerificationKey -> t -> Signature ( BaseType t) -> Bool
verifySignatureRaw :: VerificationKey -> ByteString -> Signature Raw -> Bool
module Cardano.Crypto.Signing.Safe
module Cardano.Crypto.Signing.Redeem
keyGen :: MonadRandom m => m ( VerificationKey , SigningKey )
deterministicKeyGen :: ByteString -> ( VerificationKey , SigningKey )

Documentation

newtype VerificationKey Source #

Wrapper around XPub .

Constructors

VerificationKey
Fields unVerificationKey :: XPub

Instances

Instances details

Eq VerificationKey Source #
Instance details Defined in Cardano.Crypto.Signing.VerificationKey Methods (==) :: VerificationKey -> VerificationKey -> Bool Source # (/=) :: VerificationKey -> VerificationKey -> Bool Source #
Ord VerificationKey Source #
Instance details Defined in Cardano.Crypto.Signing.VerificationKey Methods compare :: VerificationKey -> VerificationKey -> Ordering Source # (<) :: VerificationKey -> VerificationKey -> Bool Source # (<=) :: VerificationKey -> VerificationKey -> Bool Source # (>) :: VerificationKey -> VerificationKey -> Bool Source # (>=) :: VerificationKey -> VerificationKey -> Bool Source # max :: VerificationKey -> VerificationKey -> VerificationKey Source # min :: VerificationKey -> VerificationKey -> VerificationKey Source #
Show VerificationKey Source #
Instance details Defined in Cardano.Crypto.Signing.VerificationKey Methods showsPrec :: Int -> VerificationKey -> ShowS Source # show :: VerificationKey -> String Source # showList :: [ VerificationKey ] -> ShowS Source #
Generic VerificationKey Source #
Instance details Defined in Cardano.Crypto.Signing.VerificationKey Associated Types type Rep VerificationKey :: Type -> Type Source # Methods from :: VerificationKey -> Rep VerificationKey x Source # to :: Rep VerificationKey x -> VerificationKey Source #
ToJSON VerificationKey Source #
Instance details Defined in Cardano.Crypto.Signing.VerificationKey Methods toJSON :: VerificationKey -> Value Source # toEncoding :: VerificationKey -> Encoding Source # toJSONList :: [ VerificationKey ] -> Value Source # toEncodingList :: [ VerificationKey ] -> Encoding Source #
FromJSON VerificationKey Source #
Instance details Defined in Cardano.Crypto.Signing.VerificationKey Methods parseJSON :: Value -> Parser VerificationKey Source # parseJSONList :: Value -> Parser [ VerificationKey ] Source #
ToCBOR VerificationKey Source #
Instance details Defined in Cardano.Crypto.Signing.VerificationKey Methods toCBOR :: VerificationKey -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy VerificationKey -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ VerificationKey ] -> Size Source #
FromCBOR VerificationKey Source #
Instance details Defined in Cardano.Crypto.Signing.VerificationKey Methods fromCBOR :: Decoder s VerificationKey Source # label :: Proxy VerificationKey -> Text Source #
NFData VerificationKey Source #
Instance details Defined in Cardano.Crypto.Signing.VerificationKey Methods rnf :: VerificationKey -> () Source #
Buildable VerificationKey Source #
Instance details Defined in Cardano.Crypto.Signing.VerificationKey Methods build :: VerificationKey -> Builder Source #
NoThunks VerificationKey Source #
Instance details Defined in Cardano.Crypto.Signing.VerificationKey Methods noThunks :: Context -> VerificationKey -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> VerificationKey -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy VerificationKey -> String Source #
Monad m => ToJSON m VerificationKey Source #
Instance details Defined in Cardano.Crypto.Signing.VerificationKey Methods toJSON :: VerificationKey -> m JSValue Source #
MonadError SchemaError m => FromJSON m VerificationKey Source #
Instance details Defined in Cardano.Crypto.Signing.VerificationKey Methods fromJSON :: JSValue -> m VerificationKey Source #
type Rep VerificationKey Source #
Instance details Defined in Cardano.Crypto.Signing.VerificationKey type Rep VerificationKey = D1 (' MetaData "VerificationKey" "Cardano.Crypto.Signing.VerificationKey" "cardano-crypto-wrapper-1.3.0-IHV099LYIDeGXjcjOEcwKY" ' True ) ( C1 (' MetaCons "VerificationKey" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "unVerificationKey") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 XPub )))

formatFullVerificationKey :: VerificationKey -> Builder Source #

Builder for VerificationKey to show it in base64 encoded form.

fullVerificationKeyF :: Format r ( VerificationKey -> r) Source #

Formatter for VerificationKey to show it in base64.

fullVerificationKeyHexF :: Format r ( VerificationKey -> r) Source #

Formatter for VerificationKey to show it in hex.

shortVerificationKeyHexF :: Format r ( VerificationKey -> r) Source #

Formatter for VerificationKey to show it in hex, but only first 8 chars.

parseFullVerificationKey :: Text -> Either VerificationKeyParseError VerificationKey Source #

Parse VerificationKey from base64 encoded string

data SignTag Source #

To protect against replay attacks (i.e. when an attacker intercepts a signed piece of data and later sends it again), we add a tag to all data that we sign. This ensures that even if some bytestring can be deserialized into two different types of messages (A and B), the attacker can't take message A and send it as message B.

We also automatically add the network tag ( protocolMagic ) whenever it makes sense, to ensure that things intended for testnet won't work for mainnet.

Constructors

SignForTestingOnly	Anything (to be used for testing only)
SignTx	Tx: `TxSigData`
SignRedeemTx	Redeem tx: `TxSigData`
SignVssCert	Vss certificate: `(VssVerificationKey, EpochNumber)`
SignUSProposal	Update proposal: `UpdateProposalToSign`
SignCommitment	Commitment: `(EpochNumber, Commitment)`
SignUSVote	US proposal vote: `(UpId, Bool)`
SignBlock VerificationKey	Block header: `ToSign` This constructor takes the `VerificationKey` of the delegation certificate issuer, which is prepended to the signature as part of the sign tag
SignCertificate	Certificate: `Certificate`

Instances

Instances details

Eq SignTag Source #
Instance details Defined in Cardano.Crypto.Signing.Tag Methods (==) :: SignTag -> SignTag -> Bool Source # (/=) :: SignTag -> SignTag -> Bool Source #
Ord SignTag Source #
Instance details Defined in Cardano.Crypto.Signing.Tag Methods compare :: SignTag -> SignTag -> Ordering Source # (<) :: SignTag -> SignTag -> Bool Source # (<=) :: SignTag -> SignTag -> Bool Source # (>) :: SignTag -> SignTag -> Bool Source # (>=) :: SignTag -> SignTag -> Bool Source # max :: SignTag -> SignTag -> SignTag Source # min :: SignTag -> SignTag -> SignTag Source #
Show SignTag Source #
Instance details Defined in Cardano.Crypto.Signing.Tag Methods showsPrec :: Int -> SignTag -> ShowS Source # show :: SignTag -> String Source # showList :: [ SignTag ] -> ShowS Source #
Generic SignTag Source #
Instance details Defined in Cardano.Crypto.Signing.Tag Associated Types type Rep SignTag :: Type -> Type Source # Methods from :: SignTag -> Rep SignTag x Source # to :: Rep SignTag x -> SignTag Source #
Buildable SignTag Source #
Instance details Defined in Cardano.Crypto.Signing.Tag Methods build :: SignTag -> Builder Source #
type Rep SignTag Source #
Instance details Defined in Cardano.Crypto.Signing.Tag type Rep SignTag = D1 (' MetaData "SignTag" "Cardano.Crypto.Signing.Tag" "cardano-crypto-wrapper-1.3.0-IHV099LYIDeGXjcjOEcwKY" ' False ) ((( C1 (' MetaCons "SignForTestingOnly" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "SignTx" ' PrefixI ' False ) ( U1 :: Type -> Type )) :+: ( C1 (' MetaCons "SignRedeemTx" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "SignVssCert" ' PrefixI ' False ) ( U1 :: Type -> Type ))) :+: (( C1 (' MetaCons "SignUSProposal" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "SignCommitment" ' PrefixI ' False ) ( U1 :: Type -> Type )) :+: ( C1 (' MetaCons "SignUSVote" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: ( C1 (' MetaCons "SignBlock" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 VerificationKey )) :+: C1 (' MetaCons "SignCertificate" ' PrefixI ' False ) ( U1 :: Type -> Type )))))

signTag :: ProtocolMagicId -> SignTag -> ByteString Source #

Get magic bytes corresponding to a SignTag . Guaranteed to be different (and begin with a different byte) for different tags.

signTagDecoded :: Annotated ProtocolMagicId ByteString -> SignTag -> ByteString Source #

Get magic bytes corresponding to a SignTag , taking ProtocolMagic bytes from the annotation

newtype SigningKey Source #

Wrapper around XPrv .

Constructors

SigningKey
Fields unSigningKey :: XPrv

Instances

Instances details

Show SigningKey Source #
Instance details Defined in Cardano.Crypto.Signing.SigningKey Methods showsPrec :: Int -> SigningKey -> ShowS Source # show :: SigningKey -> String Source # showList :: [ SigningKey ] -> ShowS Source #
ToCBOR SigningKey Source #
Instance details Defined in Cardano.Crypto.Signing.SigningKey Methods toCBOR :: SigningKey -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy SigningKey -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ SigningKey ] -> Size Source #
FromCBOR SigningKey Source #
Instance details Defined in Cardano.Crypto.Signing.SigningKey Methods fromCBOR :: Decoder s SigningKey Source # label :: Proxy SigningKey -> Text Source #
NFData SigningKey Source #
Instance details Defined in Cardano.Crypto.Signing.SigningKey Methods rnf :: SigningKey -> () Source #
Buildable SigningKey Source #
Instance details Defined in Cardano.Crypto.Signing.SigningKey Methods build :: SigningKey -> Builder Source #
NoThunks SigningKey Source #
Instance details Defined in Cardano.Crypto.Signing.SigningKey Methods noThunks :: Context -> SigningKey -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> SigningKey -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy SigningKey -> String Source #

toVerification :: SigningKey -> VerificationKey Source #

Generate a verification key from a signing key. Fast (it just drops some bytes off the signing key).

toCBORXPrv :: XPrv -> Encoding Source #

fromCBORXPrv :: Decoder s XPrv Source #

Signature

newtype Signature a Source #

Wrapper around XSignature

Constructors

Signature XSignature

Instances

Instances details

Monad m => ToJSON m ( Signature w) Source #
Instance details Defined in Cardano.Crypto.Signing.Signature Methods toJSON :: Signature w -> m JSValue Source #
( Typeable x, MonadError SchemaError m) => FromJSON m ( Signature x) Source #
Instance details Defined in Cardano.Crypto.Signing.Signature Methods fromJSON :: JSValue -> m ( Signature x) Source #
Eq ( Signature a) Source #
Instance details Defined in Cardano.Crypto.Signing.Signature Methods (==) :: Signature a -> Signature a -> Bool Source # (/=) :: Signature a -> Signature a -> Bool Source #
Ord ( Signature a) Source #
Instance details Defined in Cardano.Crypto.Signing.Signature Methods compare :: Signature a -> Signature a -> Ordering Source # (<) :: Signature a -> Signature a -> Bool Source # (<=) :: Signature a -> Signature a -> Bool Source # (>) :: Signature a -> Signature a -> Bool Source # (>=) :: Signature a -> Signature a -> Bool Source # max :: Signature a -> Signature a -> Signature a Source # min :: Signature a -> Signature a -> Signature a Source #
Show ( Signature a) Source #
Instance details Defined in Cardano.Crypto.Signing.Signature Methods showsPrec :: Int -> Signature a -> ShowS Source # show :: Signature a -> String Source # showList :: [ Signature a] -> ShowS Source #
Generic ( Signature a) Source #
Instance details Defined in Cardano.Crypto.Signing.Signature Associated Types type Rep ( Signature a) :: Type -> Type Source # Methods from :: Signature a -> Rep ( Signature a) x Source # to :: Rep ( Signature a) x -> Signature a Source #
ToJSON ( Signature w) Source #
Instance details Defined in Cardano.Crypto.Signing.Signature Methods toJSON :: Signature w -> Value Source # toEncoding :: Signature w -> Encoding Source # toJSONList :: [ Signature w] -> Value Source # toEncodingList :: [ Signature w] -> Encoding Source #
FromJSON ( Signature w) Source #
Instance details Defined in Cardano.Crypto.Signing.Signature Methods parseJSON :: Value -> Parser ( Signature w) Source # parseJSONList :: Value -> Parser [ Signature w] Source #
Typeable a => ToCBOR ( Signature a) Source #
Instance details Defined in Cardano.Crypto.Signing.Signature Methods toCBOR :: Signature a -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy ( Signature a) -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ Signature a] -> Size Source #
Typeable a => FromCBOR ( Signature a) Source #
Instance details Defined in Cardano.Crypto.Signing.Signature Methods fromCBOR :: Decoder s ( Signature a) Source # label :: Proxy ( Signature a) -> Text Source #
NFData ( Signature a) Source #
Instance details Defined in Cardano.Crypto.Signing.Signature Methods rnf :: Signature a -> () Source #
Buildable ( Signature a) Source #
Instance details Defined in Cardano.Crypto.Signing.Signature Methods build :: Signature a -> Builder Source #
NoThunks ( Signature a) Source #
Instance details Defined in Cardano.Crypto.Signing.Signature Methods noThunks :: Context -> Signature a -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> Signature a -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( Signature a) -> String Source #
type Rep ( Signature a) Source #
Instance details Defined in Cardano.Crypto.Signing.Signature type Rep ( Signature a) = D1 (' MetaData "Signature" "Cardano.Crypto.Signing.Signature" "cardano-crypto-wrapper-1.3.0-IHV099LYIDeGXjcjOEcwKY" ' True ) ( C1 (' MetaCons "Signature" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 XSignature )))

toCBORXSignature :: XSignature -> Encoding Source #

fromCBORXSignature :: Decoder s XSignature Source #

fullSignatureHexF :: Format r ( Signature a -> r) Source #

Formatter for Signature to show it in hex.

parseFullSignature :: Text -> Either SignatureParseError ( Signature a) Source #

Parse Signature from base16 encoded string.

Signing

sign Source #

Arguments

:: ToCBOR a
=> ProtocolMagicId
-> SignTag	See docs for `SignTag`
-> SigningKey
-> a
-> Signature a

Encode something with ToCBOR and sign it

signEncoded :: ProtocolMagicId -> SignTag -> SigningKey -> Encoding -> Signature a Source #

Like sign but without the ToCBOR constraint

signRaw Source #

Arguments

:: ProtocolMagicId
-> Maybe SignTag	See docs for `SignTag` . Unlike in `sign` , we allow no tag to be provided just in case you need to sign exactly the bytestring you provided.
-> SigningKey
-> ByteString
-> Signature Raw

Sign a Raw bytestring

safeSign :: ToCBOR a => ProtocolMagicId -> SignTag -> SafeSigner -> a -> Signature a Source #

safeSignRaw :: ProtocolMagicId -> Maybe SignTag -> SafeSigner -> ByteString -> Signature Raw Source #

Verification

verifySignature :: (a -> Encoding ) -> ProtocolMagicId -> SignTag -> VerificationKey -> a -> Signature a -> Bool Source #

Verify a signature

verifySignatureDecoded :: Decoded t => Annotated ProtocolMagicId ByteString -> SignTag -> VerificationKey -> t -> Signature ( BaseType t) -> Bool Source #

Verify a signature

verifySignatureRaw :: VerificationKey -> ByteString -> Signature Raw -> Bool Source #

Verify Raw signature

module Cardano.Crypto.Signing.Safe

module Cardano.Crypto.Signing.Redeem

keyGen :: MonadRandom m => m ( VerificationKey , SigningKey ) Source #

Generate a key pair. It's recommended to run it with runSecureRandom from Cardano.Crypto.Random because the OpenSSL generator is probably safer than the default IO generator.

deterministicKeyGen :: ByteString -> ( VerificationKey , SigningKey ) Source #

Create key pair deterministically from 32 bytes.