cardano-crypto-wrapper-1.7.0.0: Cryptographic primitives used in Byron era of the Cardano project
Safe HaskellNone
LanguageHaskell2010

Cardano.Crypto.Signing

Synopsis

Documentation

module Cardano.Crypto.Signing.Redeem

module Cardano.Crypto.Signing.Safe

sign Source #

Arguments

∷ EncCBOR a 
⇒ ProtocolMagicId 
→ SignTag

See docs for SignTag

→ SigningKey 
→ a 
→ Signature a 

Encode something with EncCBOR and sign it

newtype Signature a Source #

Wrapper around XSignature

Constructors

Signature XSignature 

Instances

Instances details
(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 #

Monad m ⇒ ToJSON m (Signature w) Source # 
Instance details

Defined in Cardano.Crypto.Signing.Signature

Methods

toJSON ∷ Signature w → m JSValue 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 #

omittedField ∷ Maybe (Signature w) 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 #

omitField ∷ Signature w → Bool 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 #

Typeable a ⇒ ToCBOR (Signature a) Source # 
Instance details

Defined in Cardano.Crypto.Signing.Signature

Methods

toCBOR ∷ Signature a → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (Signature a) → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Signature a] → Size Source #

Typeable a ⇒ DecCBOR (Signature a) Source # 
Instance details

Defined in Cardano.Crypto.Signing.Signature

Methods

decCBOR ∷ Decoder s (Signature a) Source #

dropCBOR ∷ Proxy (Signature a) → Decoder s () Source #

label ∷ Proxy (Signature a) → Text Source #

Typeable a ⇒ EncCBOR (Signature a) Source # 
Instance details

Defined in Cardano.Crypto.Signing.Signature

Methods

encCBOR ∷ Signature a → Encoding Source #

NFData (Signature a) Source # 
Instance details

Defined in Cardano.Crypto.Signing.Signature

Methods

rnf ∷ Signature a → () #

Buildable (Signature a) Source # 
Instance details

Defined in Cardano.Crypto.Signing.Signature

Methods

build ∷ Signature a → Builder Source #

Generic (Signature a) Source # 
Instance details

Defined in Cardano.Crypto.Signing.Signature

Associated Types

type Rep (Signature a) 
Instance details

Defined in Cardano.Crypto.Signing.Signature

type Rep (Signature a) = D1 ('MetaData "Signature" "Cardano.Crypto.Signing.Signature" "cardano-crypto-wrapper-1.7.0.0-inplace" 'True) (C1 ('MetaCons "Signature" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 XSignature)))

Methods

from ∷ Signature a → Rep (Signature a) x #

to ∷ Rep (Signature a) x → Signature a #

Show (Signature a) Source # 
Instance details

Defined in Cardano.Crypto.Signing.Signature

Methods

showsPrec ∷ Int → Signature a → ShowS #

show ∷ Signature a → String #

showList ∷ [Signature a] → ShowS #

Eq (Signature a) Source # 
Instance details

Defined in Cardano.Crypto.Signing.Signature

Methods

(==) ∷ Signature a → Signature a → Bool #

(/=) ∷ Signature a → Signature a → Bool #

Ord (Signature a) Source # 
Instance details

Defined in Cardano.Crypto.Signing.Signature

Methods

compare ∷ Signature a → Signature a → Ordering #

(<) ∷ Signature a → Signature a → Bool #

(<=) ∷ Signature a → Signature a → Bool #

(>) ∷ Signature a → Signature a → Bool #

(>=) ∷ Signature a → Signature a → Bool #

max ∷ Signature a → Signature a → Signature a #

min ∷ Signature a → Signature a → Signature a #

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.7.0.0-inplace" 'True) (C1 ('MetaCons "Signature" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 XSignature)))

newtype SigningKey Source #

Wrapper around XPrv.

Constructors

SigningKey 

Fields

Instances

Instances details
FromCBOR SigningKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.SigningKey

Methods

fromCBOR ∷ Decoder s SigningKey Source #

label ∷ Proxy SigningKey → Text Source #

ToCBOR SigningKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.SigningKey

Methods

toCBOR ∷ SigningKey → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy SigningKey → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [SigningKey] → Size Source #

DecCBOR SigningKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.SigningKey

Methods

decCBOR ∷ Decoder s SigningKey Source #

dropCBOR ∷ Proxy SigningKey → Decoder s () Source #

label ∷ Proxy SigningKey → Text Source #

EncCBOR SigningKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.SigningKey

Methods

encCBOR ∷ SigningKey → Encoding Source #

NFData SigningKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.SigningKey

Methods

rnf ∷ SigningKey → () #

Buildable SigningKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.SigningKey

Methods

build ∷ SigningKey → Builder Source #

Show SigningKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.SigningKey

Methods

showsPrec ∷ Int → SigningKey → ShowS #

show ∷ SigningKey → String #

showList ∷ [SigningKey] → ShowS #

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 #

newtype VerificationKey Source #

Wrapper around XPub.

Constructors

VerificationKey 

Fields

Instances

Instances details
FromJSON VerificationKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.VerificationKey

Methods

parseJSON ∷ Value → Parser VerificationKey Source #

parseJSONList ∷ Value → Parser [VerificationKey] Source #

omittedField ∷ Maybe 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 #

omitField ∷ VerificationKey → Bool Source #

FromCBOR VerificationKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.VerificationKey

Methods

fromCBOR ∷ Decoder s VerificationKey Source #

label ∷ Proxy VerificationKey → Text Source #

ToCBOR VerificationKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.VerificationKey

Methods

toCBOR ∷ VerificationKey → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy VerificationKey → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [VerificationKey] → Size Source #

DecCBOR VerificationKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.VerificationKey

Methods

decCBOR ∷ Decoder s VerificationKey Source #

dropCBOR ∷ Proxy VerificationKey → Decoder s () Source #

label ∷ Proxy VerificationKey → Text Source #

EncCBOR VerificationKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.VerificationKey

Methods

encCBOR ∷ VerificationKey → Encoding Source #

NFData VerificationKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.VerificationKey

Methods

rnf ∷ VerificationKey → () #

Buildable VerificationKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.VerificationKey

Methods

build ∷ VerificationKey → Builder Source #

Generic VerificationKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.VerificationKey

Associated Types

type Rep VerificationKey 
Instance details

Defined in Cardano.Crypto.Signing.VerificationKey

type Rep VerificationKey = D1 ('MetaData "VerificationKey" "Cardano.Crypto.Signing.VerificationKey" "cardano-crypto-wrapper-1.7.0.0-inplace" 'True) (C1 ('MetaCons "VerificationKey" 'PrefixI 'True) (S1 ('MetaSel ('Just "unVerificationKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 XPub)))

Methods

from ∷ VerificationKey → Rep VerificationKey x #

to ∷ Rep VerificationKey x → VerificationKey #

Show VerificationKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.VerificationKey

Methods

showsPrec ∷ Int → VerificationKey → ShowS #

show ∷ VerificationKey → String #

showList ∷ [VerificationKey] → ShowS #

Eq VerificationKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.VerificationKey

Methods

(==) ∷ VerificationKey → VerificationKey → Bool #

(/=) ∷ VerificationKey → VerificationKey → Bool #

Ord VerificationKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.VerificationKey

Methods

compare ∷ VerificationKey → VerificationKey → Ordering #

(<) ∷ VerificationKey → VerificationKey → Bool #

(<=) ∷ VerificationKey → VerificationKey → Bool #

(>) ∷ VerificationKey → VerificationKey → Bool #

(>=) ∷ VerificationKey → VerificationKey → Bool #

max ∷ VerificationKey → VerificationKey → VerificationKey #

min ∷ VerificationKey → VerificationKey → VerificationKey #

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 #

MonadError SchemaError m ⇒ FromJSON m VerificationKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.VerificationKey

Methods

fromJSON ∷ JSValue → m VerificationKey Source #

Monad m ⇒ ToJSON m VerificationKey Source # 
Instance details

Defined in Cardano.Crypto.Signing.VerificationKey

Methods

toJSON ∷ VerificationKey → m JSValue 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.7.0.0-inplace" 'True) (C1 ('MetaCons "VerificationKey" 'PrefixI 'True) (S1 ('MetaSel ('Just "unVerificationKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 XPub)))

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.

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
Buildable SignTag Source # 
Instance details

Defined in Cardano.Crypto.Signing.Tag

Methods

build ∷ SignTag → Builder Source #

Generic SignTag Source # 
Instance details

Defined in Cardano.Crypto.Signing.Tag

Associated Types

type Rep SignTag 
Instance details

Defined in Cardano.Crypto.Signing.Tag

type Rep SignTag = D1 ('MetaData "SignTag" "Cardano.Crypto.Signing.Tag" "cardano-crypto-wrapper-1.7.0.0-inplace" '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)))))

Methods

from ∷ SignTag → Rep SignTag x #

to ∷ Rep SignTag x → SignTag #

Show SignTag Source # 
Instance details

Defined in Cardano.Crypto.Signing.Tag

Methods

showsPrec ∷ Int → SignTag → ShowS #

show ∷ SignTag → String #

showList ∷ [SignTag] → ShowS #

Eq SignTag Source # 
Instance details

Defined in Cardano.Crypto.Signing.Tag

Methods

(==) ∷ SignTag → SignTag → Bool #

(/=) ∷ SignTag → SignTag → Bool #

Ord SignTag Source # 
Instance details

Defined in Cardano.Crypto.Signing.Tag

Methods

compare ∷ SignTag → SignTag → Ordering #

(<) ∷ SignTag → SignTag → Bool #

(<=) ∷ SignTag → SignTag → Bool #

(>) ∷ SignTag → SignTag → Bool #

(>=) ∷ SignTag → SignTag → Bool #

max ∷ SignTag → SignTag → SignTag #

min ∷ SignTag → SignTag → SignTag #

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.7.0.0-inplace" '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

toVerification ∷ SigningKey → VerificationKey Source #

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

encCBORXSignature ∷ XSignature → Encoding Source #

decCBORXSignature ∷ 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.

signEncoded ∷ ProtocolMagicId → SignTag → SigningKey → Encoding → Signature a Source #

Like sign but without the EncCBOR 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 ∷ EncCBOR a ⇒ ProtocolMagicId → SignTag → SafeSigner → a → Signature a Source #

safeSignRaw ∷ ProtocolMagicId → Maybe SignTag → SafeSigner → ByteString → Signature Raw Source #

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

encCBORXPrv ∷ XPrv → Encoding Source #

decCBORXPrv ∷ Decoder s XPrv Source #

toCBORXPrv ∷ XPrv → Encoding Source #

fromCBORXPrv ∷ Decoder s XPrv Source #

shortVerificationKeyHexF ∷ Format r (VerificationKey → r) Source #

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

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.

parseFullVerificationKey ∷ Text → Either VerificationKeyParseError VerificationKey Source #

Parse VerificationKey from base64 encoded string