Modulecardano-crypto-class-2.5.1.0

Cardano.Crypto.KES.Class

Synopsis

value fixedSize
value decodeSigKES
value decodeSignKeyKES
value decodeSignedKES
value decodeUnsoundPureSignKeyKES
value decodeVerKeyKES
value encodeSigKES
value encodeSignKeyKES
value encodeSignedKES
value encodeUnsoundPureSignKeyKES
value encodeVerKeyKES
value encodedSigKESSizeExpr
value encodedSignKeyKESSizeExpr
value encodedVerKeyKESSizeExpr
value forgetSignKeyKES
value genKeyKES
value hashPairOfVKeys
value mungeName
value rawDeserialiseSignKeyKES
value seedSizeKES
value sigSizeKES
value signKeySizeKES
value signedKES
value sizeSigKES
value sizeSignKeyKES
value sizeVerKeyKES
value unsoundPureSignKeyKESToSoundSignKeyKESViaSer
value unsoundPureSignedKES
value updateKES
value updateKESWithPeriod
value verKeySizeKES
value verifyOptimizedKES
value verifySignedKES
class KESAlgorithm
class OptimizedKESAlgorithm
type Period
data SignKeyWithPeriodKES
newtype SignedKES
class UnsoundKESAlgorithm
class UnsoundPureKESAlgorithm

Packagecardano-crypto-class-2.5.1.0
Exports40
LicenceApache-2.0

valuefixedSize :: FixedSizeCodec a => proxy a -> Word

valuedecodeSigKES :: KESAlgorithm v => Decoder s (SigKES v)

Deprecated. Use decodeFixedSized instead

valuedecodeSignKeyKES :: (UnsoundKESAlgorithm v, MonadST m, MonadThrow m) => Decoder s (m (Maybe (SignKeyKES v)))

valuedecodeSignedKES :: KESAlgorithm v => Decoder s (SignedKES v a)

Deprecated. Use decodeFixedSized instead

valuedecodeUnsoundPureSignKeyKES :: UnsoundPureKESAlgorithm v => Decoder s (UnsoundPureSignKeyKES v)

Deprecated. Use decodeFixedSized instead

valuedecodeVerKeyKES :: KESAlgorithm v => Decoder s (VerKeyKES v)

Deprecated. Use decodeFixedSized instead

valueencodeSigKES :: KESAlgorithm v => SigKES v -> Encoding

Deprecated. Use encodeFixedSized instead

valueencodeSignKeyKES

:: (UnsoundKESAlgorithm v, MonadST m, MonadThrow m)
=> SignKeyKES v
-> m Encoding

valueencodeSignedKES :: KESAlgorithm v => SignedKES v a -> Encoding

Deprecated. Use encodeFixedSized instead

valueencodeUnsoundPureSignKeyKES

:: UnsoundPureKESAlgorithm v
=> UnsoundPureSignKeyKES v
-> Encoding

Deprecated. Use encodeFixedSized instead

valueencodeVerKeyKES :: KESAlgorithm v => VerKeyKES v -> Encoding

Deprecated. Use encodeFixedSized instead

valueencodedSigKESSizeExpr :: KESAlgorithm v => Proxy (SigKES v) -> Size

valueencodedSignKeyKESSizeExpr :: KESAlgorithm v => Proxy (SignKeyKES v) -> Size

valueencodedVerKeyKESSizeExpr :: KESAlgorithm v => Proxy (VerKeyKES v) -> Size

valueforgetSignKeyKES

:: (KESAlgorithm v, MonadST m, MonadThrow m)
=> SignKeyKES v
-> m ()

valuegenKeyKES

:: (KESAlgorithm v, MonadST m, MonadThrow m)
=> MLockedSeed (SeedSizeKES v)
-> m (SignKeyKES v)

valuehashPairOfVKeys

:: (KESAlgorithm d, HashAlgorithm h)
=> (VerKeyKES d, VerKeyKES d)
-> Hash h (VerKeyKES d, VerKeyKES d)

valuemungeName :: String -> String

valuerawDeserialiseSignKeyKES

:: (UnsoundKESAlgorithm v, MonadST m, MonadThrow m)
=> ByteString
-> m (Maybe (SignKeyKES v))

valueseedSizeKES :: KESAlgorithm v => proxy v -> Word

valuesigSizeKES :: KESAlgorithm v => proxy v -> Word

Deprecated. Use fixedSize instead

valuesignKeySizeKES :: KESAlgorithm v => proxy v -> Word

valuesignedKES

:: (KESAlgorithm v, Signable v a, MonadST m, MonadThrow m)
=> ContextKES v
-> Period
-> a
-> SignKeyKES v
-> m (SignedKES v a)

valuesizeSigKES :: KESAlgorithm v => proxy v -> Word

Deprecated. Use fixedSize instead

valuesizeSignKeyKES :: KESAlgorithm v => proxy v -> Word

Deprecated. In favor of signKeySizeKES

valuesizeVerKeyKES :: KESAlgorithm v => proxy v -> Word

Deprecated. Use fixedSize instead

valueunsoundPureSignKeyKESToSoundSignKeyKESViaSer

:: (MonadST m, MonadThrow m, UnsoundKESAlgorithm k, UnsoundPureKESAlgorithm k)
=> UnsoundPureSignKeyKES k
-> m (SignKeyKES k)

valueunsoundPureSignedKES

:: (UnsoundPureKESAlgorithm v, Signable v a)
=> ContextKES v
-> Period
-> a
-> UnsoundPureSignKeyKES v
-> SignedKES v a

valueupdateKES

:: (KESAlgorithm v, MonadST m, MonadThrow m)
=> ContextKES v
-> SignKeyKES v
-> Period
-> m (Maybe (SignKeyKES v))

valueupdateKESWithPeriod

:: (KESAlgorithm v, MonadST m, MonadThrow m)
=> ContextKES v
-> SignKeyWithPeriodKES v
-> m (Maybe (SignKeyWithPeriodKES v))

valueverKeySizeKES :: KESAlgorithm v => proxy v -> Word

Deprecated. Use fixedSize instead

valueverifyOptimizedKES

:: (OptimizedKESAlgorithm v, Signable v a, HasCallStack)
=> ContextKES v
-> VerKeyKES v
-> Period
-> a
-> SigKES v
-> Either String ()

valueverifySignedKES

:: (KESAlgorithm v, Signable v a)
=> ContextKES v
-> VerKeyKES v
-> Period
-> a
-> SignedKES v a
-> Either String ()

class

class (Typeable v, Show (VerKeyKES v), Eq (VerKeyKES v), Show (SigKES v), Eq (SigKES v), NoThunks (SigKES v), NoThunks (SignKeyKES v), NoThunks (VerKeyKES v), KnownNat (SeedSizeKES v), KnownNat (VerKeySizeKES v), KnownNat (SignKeySizeKES v), KnownNat (SigSizeKES v), KnownNat (TotalPeriodsKES v), FixedSizeCodec (VerKeyKES v), FixedSizeCodec (SigKES v)) => KESAlgorithm v where

Associated types

data family VerKeyKES v
data family SigKES v
data family SignKeyKES v
type family SeedSizeKES v :: Nat
type family VerKeySizeKES v :: Nat
type family SignKeySizeKES v :: Nat
type family SigSizeKES v :: Nat
type family TotalPeriodsKES v :: Nat
type family SizeVerKeyKES v :: Nat
type family SizeSignKeyKES v :: Nat
type family SizeSigKES v :: Nat
type family ContextKES v
type family Signable v :: Type -> Constraint

Methods

algorithmNameKES :: proxy v -> String
hashVerKeyKES :: HashAlgorithm h => VerKeyKES v -> Hash h (VerKeyKES v)
verifyKES :: (Signable v a, HasCallStack) => ContextKES v -> VerKeyKES v -> Period -> a -> SigKES v -> Either String ()
totalPeriodsKES :: proxy v -> Word
rawSerialiseVerKeyKES :: VerKeyKES v -> ByteString
rawSerialiseSigKES :: SigKES v -> ByteString
rawDeserialiseVerKeyKES :: ByteString -> Maybe (VerKeyKES v)
rawDeserialiseSigKES :: ByteString -> Maybe (SigKES v)
deriveVerKeyKES :: (MonadST m, MonadThrow m) => SignKeyKES v -> m (VerKeyKES v)
signKES :: (Signable v a, MonadST m, MonadThrow m) => ContextKES v -> Period -> a -> SignKeyKES v -> m (SigKES v)
updateKESWith :: (MonadST m, MonadThrow m) => MLockedAllocator m -> ContextKES v -> SignKeyKES v -> Period -> m (Maybe (SignKeyKES v))
genKeyKESWith :: (MonadST m, MonadThrow m) => MLockedAllocator m -> MLockedSeed (SeedSizeKES v) -> m (SignKeyKES v)
forgetSignKeyKESWith :: (MonadST m, MonadThrow m) => MLockedAllocator m -> SignKeyKES v -> m ()

Instances7KESAlgorithm, …

KESAlgorithm NeverKESDefined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.NeverUsed
KnownNat t => KESAlgorithm (MockKES t)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Mock
(DSIGNMAlgorithm d, KnownNat (FixedSize (VerKeyDSIGN d)), KnownNat (FixedSize (SigDSIGN d))) => KESAlgorithm (SingleKES d)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Single
(DSIGNMAlgorithm d, KnownNat (SigSizeDSIGN d + VerKeySizeDSIGN d)) => KESAlgorithm (CompactSingleKES d)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.CompactSingle
(DSIGNMAlgorithm d, KnownNat t, KnownNat (SeedSizeDSIGN d * t), KnownNat (VerKeySizeDSIGN d * t), KnownNat (SignKeySizeDSIGN d * t)) => KESAlgorithm (SimpleKES d t)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Simple
(KESAlgorithm d, SodiumHashAlgorithm h, HashSize h ~ SeedSizeKES d, KnownNat ((SignKeySizeKES d + SeedSizeKES d) + (2 * VerKeySizeKES d)), KnownNat (SigSizeKES d + (VerKeySizeKES d * 2)), KnownNat (2 * TotalPeriodsKES d)) => KESAlgorithm (SumKES h d)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Sum
(OptimizedKESAlgorithm d, SodiumHashAlgorithm h, HashSize h ~ SeedSizeKES d, NoThunks (VerKeyKES (CompactSumKES h d)), KnownNat (VerKeySizeKES (CompactSumKES h d)), KnownNat (SignKeySizeKES (CompactSumKES h d)), KnownNat (SigSizeKES (CompactSumKES h d)), KnownNat (2 * TotalPeriodsKES d)) => KESAlgorithm (CompactSumKES h d)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.CompactSum

classclass KESAlgorithm v => OptimizedKESAlgorithm v where

Methods

verifySigKES :: (Signable v a, HasCallStack) => ContextKES v -> Period -> a -> SigKES v -> Either String ()
verKeyFromSigKES :: ContextKES v -> Period -> SigKES v -> VerKeyKES v

Instances2OptimizedKESAlgorithm

(KESAlgorithm (CompactSingleKES d), DSIGNMAlgorithm d) => OptimizedKESAlgorithm (CompactSingleKES d)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.CompactSingle
(KESAlgorithm (CompactSumKES h d), OptimizedKESAlgorithm d, HashAlgorithm h) => OptimizedKESAlgorithm (CompactSumKES h d)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.CompactSum

typetype Period = Word

datadata SignKeyWithPeriodKES v

Constructors

SignKeyWithPeriodKES
- skWithoutPeriodKES :: !SignKeyKES v
- periodKES :: !Period

Instances5Eq, Show, Generic, NoThunks, Rep

(KESAlgorithm v, Eq (SignKeyKES v)) => Eq (SignKeyWithPeriodKES v)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Class
(KESAlgorithm v, Show (SignKeyKES v)) => Show (SignKeyWithPeriodKES v)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Class
Generic (SignKeyWithPeriodKES v)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Class
KESAlgorithm v => NoThunks (SignKeyWithPeriodKES v)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Class
type Rep (SignKeyWithPeriodKES v) = D1 ('MetaData "SignKeyWithPeriodKES" "Cardano.Crypto.KES.Class" "cardano-crypto-class-2.5.1.0-9Hxz66BmoEBJD8IKFJBbAB" 'False) (C1 ('MetaCons "SignKeyWithPeriodKES" 'PrefixI 'True) (S1 ('MetaSel ('Just "skWithoutPeriodKES") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SignKeyKES v)) :*: S1 ('MetaSel ('Just "periodKES") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Period)))Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Class

newtypenewtype SignedKES v a

Constructors

SignedKES
- getSig :: SigKES v

Instances7Eq, Show, Generic, NoThunks, FixedSizeCodec, Rep, …

KESAlgorithm v => Eq (SignedKES v a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Class
KESAlgorithm v => Show (SignedKES v a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Class
Generic (SignedKES v a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Class
KESAlgorithm v => NoThunks (SignedKES v a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Class
KESAlgorithm v => FixedSizeCodec (SignedKES v a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Class
type Rep (SignedKES v a) = D1 ('MetaData "SignedKES" "Cardano.Crypto.KES.Class" "cardano-crypto-class-2.5.1.0-9Hxz66BmoEBJD8IKFJBbAB" 'True) (C1 ('MetaCons "SignedKES" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SigKES v))))Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Class
type FixedSize (SignedKES v a) = FixedSize (SigKES v)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Class

classclass KESAlgorithm v => UnsoundKESAlgorithm v where

Methods

rawDeserialiseSignKeyKESWith :: (MonadST m, MonadThrow m) => MLockedAllocator m -> ByteString -> m (Maybe (SignKeyKES v))
rawSerialiseSignKeyKES :: (MonadST m, MonadThrow m) => SignKeyKES v -> m ByteString

Instances7UnsoundKESAlgorithm, …

UnsoundKESAlgorithm NeverKESDefined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.NeverUsed
KnownNat t => UnsoundKESAlgorithm (MockKES t)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Mock
(KESAlgorithm (CompactSingleKES d), UnsoundDSIGNMAlgorithm d) => UnsoundKESAlgorithm (CompactSingleKES d)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.CompactSingle
(KESAlgorithm (SingleKES d), UnsoundDSIGNMAlgorithm d) => UnsoundKESAlgorithm (SingleKES d)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Single
(UnsoundDSIGNMAlgorithm d, KnownNat t, KESAlgorithm (SimpleKES d t)) => UnsoundKESAlgorithm (SimpleKES d t)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Simple
(KESAlgorithm (CompactSumKES h d), UnsoundKESAlgorithm d) => UnsoundKESAlgorithm (CompactSumKES h d)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.CompactSum
(KESAlgorithm (SumKES h d), UnsoundKESAlgorithm d) => UnsoundKESAlgorithm (SumKES h d)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Sum

class

class (KESAlgorithm v, NoThunks (UnsoundPureSignKeyKES v), FixedSizeCodec (UnsoundPureSignKeyKES v)) => UnsoundPureKESAlgorithm v where

Associated types

data family UnsoundPureSignKeyKES v

Methods

unsoundPureSignKES :: Signable v a => ContextKES v -> Period -> a -> UnsoundPureSignKeyKES v -> SigKES v
unsoundPureUpdateKES :: ContextKES v -> UnsoundPureSignKeyKES v -> Period -> Maybe (UnsoundPureSignKeyKES v)
unsoundPureGenKeyKES :: Seed -> UnsoundPureSignKeyKES v
unsoundPureDeriveVerKeyKES :: UnsoundPureSignKeyKES v -> VerKeyKES v
unsoundPureSignKeyKESToSoundSignKeyKES :: (MonadST m, MonadThrow m) => UnsoundPureSignKeyKES v -> m (SignKeyKES v)
rawSerialiseUnsoundPureSignKeyKES :: UnsoundPureSignKeyKES v -> ByteString
rawDeserialiseUnsoundPureSignKeyKES :: ByteString -> Maybe (UnsoundPureSignKeyKES v)

Instances7UnsoundPureKESAlgorithm, …

UnsoundPureKESAlgorithm NeverKESDefined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.NeverUsed
KnownNat t => UnsoundPureKESAlgorithm (MockKES t)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Mock
(KESAlgorithm (CompactSingleKES d), UnsoundDSIGNMAlgorithm d) => UnsoundPureKESAlgorithm (CompactSingleKES d)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.CompactSingle
(KESAlgorithm (SingleKES d), UnsoundDSIGNMAlgorithm d) => UnsoundPureKESAlgorithm (SingleKES d)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Single
(KESAlgorithm (CompactSumKES h d), HashAlgorithm h, UnsoundPureKESAlgorithm d) => UnsoundPureKESAlgorithm (CompactSumKES h d)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.CompactSum
(KESAlgorithm (SimpleKES d t), KnownNat t, DSIGNAlgorithm d, UnsoundDSIGNMAlgorithm d) => UnsoundPureKESAlgorithm (SimpleKES d t)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Simple
(KESAlgorithm (SumKES h d), HashAlgorithm h, UnsoundPureKESAlgorithm d) => UnsoundPureKESAlgorithm (SumKES h d)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.KES.Sum