Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Protocol.Ledger.HotKey

Contents

KES Info
KES Status
Hot Key

Description

Hot key

Intended for qualified import

Synopsis

type KESEvolution = Period
data KESInfo = KESInfo {
- kesStartPeriod ∷ !KESPeriod
- kesEndPeriod ∷ !KESPeriod
- kesEvolution ∷ !KESEvolution
}
kesAbsolutePeriod ∷ KESInfo → KESPeriod
data KESStatus
kesStatus ∷ KESInfo → KESPeriod → KESStatus
data HotKey c (m ∷ Type → Type) = HotKey {
- evolve ∷ KESPeriod → m KESEvolutionInfo
- getInfo ∷ m KESInfo
- getOCertMaybe ∷ m (Maybe (OCert c))
- isPoisoned ∷ m Bool
- sign_ ∷ ∀ toSign. (Signable (KES c) toSign, HasCallStack) ⇒ toSign → m (SignedKES (KES c) toSign)
- finalize ∷ m ()
}
data KESEvolutionError
- = KESCouldNotEvolve KESInfo KESPeriod
- | KESKeyAlreadyPoisoned KESInfo KESPeriod
type KESEvolutionInfo = UpdateInfo KESInfo KESEvolutionError
getOCert ∷ Monad m ⇒ HotKey c m → m (OCert c)
mkDynamicHotKey ∷ ∀ m c. (Crypto c, IOLike m) ⇒ Word64 → Maybe (KeyProducer c m) → m (HotKey c m)
mkEmptyHotKey ∷ ∀ m c. (Crypto c, IOLike m) ⇒ Word64 → m (HotKey c m)
mkHotKey ∷ ∀ m c. (Crypto c, IOLike m) ⇒ OCert c → SignKeyKES (KES c) → KESPeriod → Word64 → m (HotKey c m)
mkHotKeyAtEvolution ∷ ∀ m c. (Crypto c, IOLike m) ⇒ Word → OCert c → SignKeyKES (KES c) → KESPeriod → Word64 → m (HotKey c m)
sign ∷ (Signable (KES c) toSign, HasCallStack) ⇒ HotKey c m → toSign → m (SignedKES (KES c) toSign)

KES Info

type KESEvolution = Period Source #

We call the relative periods that a KES key is valid its evolution, to avoid confusion with absolute periods.

data KESInfo Source #

Constructors

KESInfo
Fields kesStartPeriod ∷ !KESPeriod kesEndPeriod ∷ !KESPeriod Currently derived from `TPraosParams`: > kesEndPeriod = kesStartPeriod + tpraosMaxKESEvo kesEvolution ∷ !KESEvolution Current evolution or relative period. Invariant: > kesStartPeriod + kesEvolution in [kesStartPeriod, kesEndPeriod)

Instances

Instances details

Generic KESInfo Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.Ledger.HotKey

Associated Types

type Rep KESInfo

Instance details

Defined in Ouroboros.Consensus.Protocol.Ledger.HotKey

type Rep KESInfo = D1 ('MetaData "KESInfo" "Ouroboros.Consensus.Protocol.Ledger.HotKey" "ouroboros-consensus-protocol-0.13.0.0-inplace" 'False) (C1 ('MetaCons "KESInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "kesStartPeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KESPeriod) :*: (S1 ('MetaSel ('Just "kesEndPeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KESPeriod) :*: S1 ('MetaSel ('Just "kesEvolution") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KESEvolution))))

Methods

from ∷ KESInfo → Rep KESInfo x #

to ∷ Rep KESInfo x → KESInfo #

Show KESInfo Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.Ledger.HotKey

Methods

showsPrec ∷ Int → KESInfo → ShowS #

show ∷ KESInfo → String #

showList ∷ [KESInfo] → ShowS #

NoThunks KESInfo Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.Ledger.HotKey

Methods

noThunks ∷ Context → KESInfo → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → KESInfo → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy KESInfo → String Source #

type Rep KESInfo Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.Ledger.HotKey

type Rep KESInfo = D1 ('MetaData "KESInfo" "Ouroboros.Consensus.Protocol.Ledger.HotKey" "ouroboros-consensus-protocol-0.13.0.0-inplace" 'False) (C1 ('MetaCons "KESInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "kesStartPeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KESPeriod) :*: (S1 ('MetaSel ('Just "kesEndPeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KESPeriod) :*: S1 ('MetaSel ('Just "kesEvolution") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KESEvolution))))

kesAbsolutePeriod ∷ KESInfo → KESPeriod Source #

Return the absolute KES period

KES Status

data KESStatus Source #

Constructors

BeforeKESStart	The given period is before the start period of the KES key.
Fields KESPeriod Given period KESPeriod Start period of the KES key
InKESRange	The given period is in the range of the KES key.
Fields KESEvolution Relative period or evolution corresponding to the given absolute period
AfterKESEnd	The given period is after the end period of the KES key.
Fields KESPeriod Given period KESPeriod End period of the KES key

kesStatus ∷ KESInfo → KESPeriod → KESStatus Source #

Return the evolution of the given KES period, when it falls within the range of the HotKey ([hkStart, hkEnd)).

Note that the upper bound is exclusive, the spec says: > c0 <= kesPeriod s < c0 + MaxKESEvo

Hot Key

data HotKey c (m ∷ Type → Type) Source #

API to interact with the key.

Constructors

HotKey

Fields

evolve ∷ KESPeriod → m KESEvolutionInfo
Evolve the KES signing key to the given absolute KES period.
When the key cannot evolve anymore, we poison it.
getInfo ∷ m KESInfo
Return KESInfo of the signing key.
getOCertMaybe ∷ m (Maybe (OCert c))
Return the OCert corresponding to the KES signing key, if any.
isPoisoned ∷ m Bool
Check whether a valid KES signing key exists. Poisoned means no key exists; reasons for this could be: - no signing key has been set yet - the signing key has been explicitly erased (forget) - the signing key has been evolved past the end of the available evolutions
sign_ ∷ ∀ toSign. (Signable (KES c) toSign, HasCallStack) ⇒ toSign → m (SignedKES (KES c) toSign)
Sign the given toSign with the current signing key.
PRECONDITION: the key is not poisoned.
POSTCONDITION: the signature is in normal form.
finalize ∷ m ()
Release any resources held by the HotKey, including the signing key itself. This should be called exactly once per HotKey instance.

Instances

Instances details

NoThunks (HotKey c m) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Ledger.HotKey Methods noThunks ∷ Context → HotKey c m → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → HotKey c m → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (HotKey c m) → String Source #

data KESEvolutionError Source #

Failed to evolve the KES key.

Constructors

KESCouldNotEvolve	The KES key could not be evolved to the target period.
Fields KESInfo KESPeriod Target period outside the range of the current KES key. Typically the current KES period according to the wallclock slot.
KESKeyAlreadyPoisoned	The KES key was already poisoned.
Fields KESInfo KESPeriod Target period outside the range of the current KES key. Typically the current KES period according to the wallclock slot.

Instances

Instances details

Show KESEvolutionError Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Ledger.HotKey Methods showsPrec ∷ Int → KESEvolutionError → ShowS # show ∷ KESEvolutionError → String # showList ∷ [KESEvolutionError] → ShowS #

type KESEvolutionInfo = UpdateInfo KESInfo KESEvolutionError Source #

Result of evolving the KES key.

getOCert ∷ Monad m ⇒ HotKey c m → m (OCert c) Source #

mkDynamicHotKey Source #

Arguments

∷ ∀ m c. (Crypto c, IOLike m)
⇒ Word64	Max KES evolutions
→ Maybe (KeyProducer c m)
→ m (HotKey c m)

Create a new HotKey that runs a key-producer action on a separate thread. The key producer action will receive a callback that can be used to pass keys into the HotKey; the HotKey will dynamically update its internal state to reflect new keys as they arrive.

mkEmptyHotKey Source #

Arguments

∷ ∀ m c. (Crypto c, IOLike m)
⇒ Word64	Max KES evolutions
→ m (HotKey c m)

Create a new HotKey and initialize it to a poisoned state (containing no valid KES sign key).

mkHotKey Source #

Arguments

∷ ∀ m c. (Crypto c, IOLike m)
⇒ OCert c
→ SignKeyKES (KES c)
→ KESPeriod	Start period
→ Word64	Max KES evolutions
→ m (HotKey c m)

mkHotKeyAtEvolution Source #

Arguments

∷ ∀ m c. (Crypto c, IOLike m)
⇒ Word
→ OCert c
→ SignKeyKES (KES c)
→ KESPeriod	Start period
→ Word64	Max KES evolutions
→ m (HotKey c m)

sign ∷ (Signable (KES c) toSign, HasCallStack) ⇒ HotKey c m → toSign → m (SignedKES (KES c) toSign) Source #