Modulekes-agent-1.3.0.0Haskell2010

Cardano.KESAgent.Protocols.Control.V0.Protocol

7 types
1 value

Packagekes-agent-1.3.0.0
Exports8
LanguageHaskell2010
LicenceApache-2.0
SourceProtocol.hs

datadata AgentInfo c

Constructors

AgentInfo
- agentInfoCurrentBundle :: !Maybe (BundleInfo c)
- agentInfoStagedKey :: !Maybe (KeyInfo c)
- agentInfoCurrentTime :: !UTCTime
- agentInfoCurrentKESPeriod :: !KESPeriod
- agentInfoBootstrapConnections :: ![BootstrapInfo]

Instances9FromAgentInfo, ToAgentInfo, Eq, Show, Generic, NFData, …

FromAgentInfo c (AgentInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Processes.Agent.ControlDrivers
ToAgentInfo c (AgentInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Processes.ControlClient
(DSIGNAlgorithm (DSIGN c), KESAlgorithm (KES c)) => Eq (AgentInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
(DSIGNAlgorithm (DSIGN c), KESAlgorithm (KES c)) => Show (AgentInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
Generic (AgentInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
(NFData (VerKeyKES kes), kes ~ KES c, NFData (SigDSIGN dsign), dsign ~ DSIGN c) => NFData (AgentInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
(HasInfo (DirectCodec m) (Maybe (BundleInfo c)), HasInfo (DirectCodec m) (Maybe (KeyInfo c))) => HasInfo (DirectCodec m) (AgentInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Driver · orphan
(Monad (MonadEncode (DirectCodec m)), Monad (MonadDecode (DirectCodec m)), Serializable (DirectCodec m) (Maybe (BundleInfo c)), Serializable (DirectCodec m) (Maybe (KeyInfo c)), Serializable (DirectCodec m) UTCTime, Serializable (DirectCodec m) KESPeriod, Serializable (DirectCodec m) [BootstrapInfo]) => Serializable (DirectCodec m) (AgentInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Driver · orphan
type Rep (AgentInfo c) = D1 ('MetaData "AgentInfo" "Cardano.KESAgent.Protocols.Control.V0.Protocol" "kes-agent-1.3.0.0-CjPUY4LS7YJ95LTDqEpdnQ" 'False) (C1 ('MetaCons "AgentInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "agentInfoCurrentBundle") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe (BundleInfo c))) :*: S1 ('MetaSel ('Just "agentInfoStagedKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe (KeyInfo c)))) :*: (S1 ('MetaSel ('Just "agentInfoCurrentTime") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UTCTime) :*: (S1 ('MetaSel ('Just "agentInfoCurrentKESPeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 KESPeriod) :*: S1 ('MetaSel ('Just "agentInfoBootstrapConnections") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [BootstrapInfo])))))Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol

datadata BootstrapInfo

Constructors

BootstrapInfo
- bootstrapInfoAddress :: !Text
- bootstrapInfoStatus :: !ConnectionStatus

Instances7Eq, Show, Generic, NFData, HasInfo, Serializable, …

Eq BootstrapInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
Show BootstrapInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
Generic BootstrapInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
NFData BootstrapInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
HasInfo (DirectCodec m) BootstrapInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Driver · orphan
(Monad (MonadEncode (DirectCodec m)), Monad (MonadDecode (DirectCodec m)), Serializable (DirectCodec m) Text, Serializable (DirectCodec m) ConnectionStatus) => Serializable (DirectCodec m) BootstrapInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Driver · orphan
type Rep BootstrapInfo = D1 ('MetaData "BootstrapInfo" "Cardano.KESAgent.Protocols.Control.V0.Protocol" "kes-agent-1.3.0.0-CjPUY4LS7YJ95LTDqEpdnQ" 'False) (C1 ('MetaCons "BootstrapInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "bootstrapInfoAddress") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "bootstrapInfoStatus") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ConnectionStatus)))Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol

datadata ConnectionStatus

ConnectionUp ConnectionConnecting ConnectionDown

Instances11Bounded, Enum, Eq, Ord, Read, Show, …

Bounded ConnectionStatusDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
Enum ConnectionStatusDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
Eq ConnectionStatusDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
Ord ConnectionStatusDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
Read ConnectionStatusDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
Show ConnectionStatusDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
Generic ConnectionStatusDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
NFData ConnectionStatusDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
(Codec codec, HasInfo codec Word8, HasInfo codec (DefEnumEncoding codec)) => HasInfo codec ConnectionStatusDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Driver · orphan
(Codec codec, Serializable codec Word8, Monad (MonadEncode codec), Monad (MonadDecode codec)) => Serializable codec ConnectionStatusDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Driver · orphan
type Rep ConnectionStatus = D1 ('MetaData "ConnectionStatus" "Cardano.KESAgent.Protocols.Control.V0.Protocol" "kes-agent-1.3.0.0-CjPUY4LS7YJ95LTDqEpdnQ" 'False) (C1 ('MetaCons "ConnectionUp" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "ConnectionConnecting" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ConnectionDown" 'PrefixI 'False) U1))Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol

datadata BundleInfo c

Constructors

BundleInfo
- bundleInfoEvolution :: !Word32
- bundleInfoStartKESPeriod :: !KESPeriod
- bundleInfoOCertN :: !Word64
- bundleInfoVK :: !VerKeyKES (KES c)
- bundleInfoSigma :: !SignedDSIGN (DSIGN c) (OCertSignable c)

Instances7Eq, Show, Generic, NFData, HasInfo, Serializable, …

(DSIGNAlgorithm (DSIGN c), KESAlgorithm (KES c)) => Eq (BundleInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
(DSIGNAlgorithm (DSIGN c), KESAlgorithm (KES c)) => Show (BundleInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
Generic (BundleInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
(NFData (VerKeyKES kes), kes ~ KES c, NFData (SignedDSIGN dsign (OCertSignable c)), dsign ~ DSIGN c) => NFData (BundleInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
(HasInfo (DirectCodec m) (VerKeyKES (KES c)), HasInfo (DirectCodec m) (SignedDSIGN (DSIGN c) (OCertSignable c))) => HasInfo (DirectCodec m) (BundleInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Driver · orphan
(Monad (MonadEncode (DirectCodec m)), Monad (MonadDecode (DirectCodec m)), Serializable (DirectCodec m) Word32, Serializable (DirectCodec m) KESPeriod, Serializable (DirectCodec m) Word64, Serializable (DirectCodec m) (VerKeyKES (KES c)), Serializable (DirectCodec m) (SignedDSIGN (DSIGN c) (OCertSignable c))) => Serializable (DirectCodec m) (BundleInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Driver · orphan
type Rep (BundleInfo c) = D1 ('MetaData "BundleInfo" "Cardano.KESAgent.Protocols.Control.V0.Protocol" "kes-agent-1.3.0.0-CjPUY4LS7YJ95LTDqEpdnQ" 'False) (C1 ('MetaCons "BundleInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bundleInfoEvolution") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word32) :*: S1 ('MetaSel ('Just "bundleInfoStartKESPeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 KESPeriod)) :*: (S1 ('MetaSel ('Just "bundleInfoOCertN") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word64) :*: (S1 ('MetaSel ('Just "bundleInfoVK") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (VerKeyKES (KES c))) :*: S1 ('MetaSel ('Just "bundleInfoSigma") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SignedDSIGN (DSIGN c) (OCertSignable c)))))))Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol

newtypenewtype KeyInfo c

Constructors

KeyInfo
- keyInfoVK :: VerKeyKES (KES c)

Instances7HasInfo, Serializable, Eq, Show, Generic, NFData, …

(HasInfo codec (VerKeyKES (KES c)), KESAlgorithm (KES c), Codec codec) => HasInfo codec (KeyInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Driver · orphan
(Serializable codec (VerKeyKES (KES c)), KESAlgorithm (KES c), Codec codec, Monad (MonadEncode codec), Monad (MonadDecode codec)) => Serializable codec (KeyInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Driver · orphan
(DSIGNAlgorithm (DSIGN c), KESAlgorithm (KES c)) => Eq (KeyInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
KESAlgorithm (KES c) => Show (KeyInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
Generic (KeyInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
(NFData (VerKeyKES kes), kes ~ KES c) => NFData (KeyInfo c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
type Rep (KeyInfo c) = D1 ('MetaData "KeyInfo" "Cardano.KESAgent.Protocols.Control.V0.Protocol" "kes-agent-1.3.0.0-CjPUY4LS7YJ95LTDqEpdnQ" 'True) (C1 ('MetaCons "KeyInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyInfoVK") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (VerKeyKES (KES c)))))Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol

datadata ControlProtocol (m :: Type -> Type) k where

The protocol for pushing KES keys.

Intended use:

The Agent acts as the Client, and the Control Server as a Server
When the Control Server connects, it pushes a key to the Agent
The Agent stores the key locally in memory and pushes it to any connected Nodes.

All pushes are confirmed from the receiving end, to make sure they have gone through. This allows the control client to report success to the user, but it also helps make things more predictable in testing, because it means that sending keys is now synchronous.

Constructors

InitialState :: ControlProtocol m k
Default state after connecting, but before the protocol version has been negotiated.
IdleState :: ControlProtocol m k
System is idling, waiting for the server to push the next key.
WaitForPublicKeyState :: ControlProtocol m k
Client has requested a new KES key to be generated in the staging area.
WaitForInfoState :: ControlProtocol m k
Client has requested agent information
WaitForConfirmationState :: ControlProtocol m k
An OpCert has been pushed, client must now confirm that it has been received, and that it matches the staged KES key.
EndState :: ControlProtocol m k
The server has closed the connection, thus signalling the end of the session.

Instances26HasInfo, Protocol, VersionedProtocol, IsControlHandler, StateTokenI, Message, …

NamedCrypto c => HasInfo (DirectCodec m) (Message (ControlProtocol m c) 'IdleState 'WaitForInfoState)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Driver · orphan
NamedCrypto c => HasInfo (DirectCodec m) (Message (ControlProtocol m c) 'IdleState 'WaitForPublicKeyState)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Driver · orphan
NamedCrypto c => HasInfo (DirectCodec m) (Message (ControlProtocol m c) 'InitialState 'IdleState)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Driver · orphan
NamedCrypto c => HasInfo (DirectCodec m) (Message (ControlProtocol m c) 'WaitForConfirmationState 'IdleState)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Driver · orphan
NamedCrypto c => HasInfo (DirectCodec m) (Message (ControlProtocol m c) _st 'EndState)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Driver · orphan
(NamedCrypto c, KESAlgorithm (KES c), DSIGNAlgorithm (DSIGN c), HasInfo (DirectCodec m) (VerKeyKES (KES c)), HasInfo (DirectCodec m) (AgentInfo c)) => HasInfo (DirectCodec m) (Message (ControlProtocol m c) 'WaitForInfoState 'IdleState)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Driver · orphan
(NamedCrypto c, HasInfo (DirectCodec m) (VerKeyKES (KES c))) => HasInfo (DirectCodec m) (Message (ControlProtocol m c) 'WaitForPublicKeyState 'IdleState)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Driver · orphan
(NamedCrypto c, HasInfo (DirectCodec m) (VerKeyKES (KES c)), KESAlgorithm (KES c), DSIGNAlgorithm (DSIGN c)) => HasInfo (DirectCodec m) (Message (ControlProtocol m c) 'IdleState 'WaitForConfirmationState)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Driver · orphan
Protocol (ControlProtocol m c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
NamedCrypto c => VersionedProtocol (ControlProtocol m c)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
(MonadControlHandler m, Crypto c, Typeable c, NamedCrypto c, DirectSerialise (SignKeyKES (KES c)), DirectDeserialise (SignKeyKES (KES c)), NFData a) => IsControlHandler (ControlProtocol m c) m aDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Processes.ControlClient
StateTokenI 'EndStateDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
StateTokenI 'IdleStateDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
StateTokenI 'InitialStateDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
StateTokenI 'WaitForConfirmationStateDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
StateTokenI 'WaitForInfoStateDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
StateTokenI 'WaitForPublicKeyStateDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
data Message (ControlProtocol m c)
- VersionMessage :: R:MessageControlProtocolstst' m c 'InitialState 'IdleState
- GenStagedKeyMessage :: R:MessageControlProtocolstst' m c 'IdleState 'WaitForPublicKeyState
- QueryStagedKeyMessage :: R:MessageControlProtocolstst' m c 'IdleState 'WaitForPublicKeyState
- DropStagedKeyMessage :: R:MessageControlProtocolstst' m c 'IdleState 'WaitForPublicKeyState
- PublicKeyMessage :: Maybe (VerKeyKES (KES c)) -> R:MessageControlProtocolstst' m c 'WaitForPublicKeyState 'IdleState
- InstallKeyMessage :: OCert c -> R:MessageControlProtocolstst' m c 'IdleState 'WaitForConfirmationState
- InstallResultMessage :: RecvResult -> R:MessageControlProtocolstst' m c 'WaitForConfirmationState 'IdleState
- RequestInfoMessage :: R:MessageControlProtocolstst' m c 'IdleState 'WaitForInfoState
- InfoMessage :: AgentInfo c -> R:MessageControlProtocolstst' m c 'WaitForInfoState 'IdleState
- AbortMessage :: R:MessageControlProtocolstst' m c 'InitialState 'EndState
- EndMessage :: R:MessageControlProtocolstst' m c 'IdleState 'EndState
- ProtocolErrorMessage :: R:MessageControlProtocolstst' m c st 'EndState
Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
type StateAgency 'EndState = 'NobodyAgencyDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
type StateAgency 'IdleState = 'ServerAgencyDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
type StateAgency 'InitialState = 'ServerAgencyDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
type StateAgency 'WaitForConfirmationState = 'ClientAgencyDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
type StateAgency 'WaitForInfoState = 'ClientAgencyDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
type StateAgency 'WaitForPublicKeyState = 'ClientAgencyDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
type StateToken = SControlProtocolDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V0.Protocol
type InitialState (ControlProtocol m c) = 'InitialStateDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Processes.ControlClient

datadata SControlProtocol (st :: ControlProtocol m c) where

Constructors

SInitialState :: SControlProtocol 'InitialState
SIdleState :: SControlProtocol 'IdleState
SWaitForConfirmationState :: SControlProtocol 'WaitForConfirmationState
SWaitForPublicKeyState :: SControlProtocol 'WaitForPublicKeyState
SWaitForInfoState :: SControlProtocol 'WaitForInfoState
SEndState :: SControlProtocol 'EndState

valuecpVersionIdentifier