Modulekes-agent-1.3.0.0Haskell2010

Cardano.KESAgent.Protocols.Control.V3.Protocol

8 types
1 value

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

datadata AgentInfo

Constructors

AgentInfo
- agentInfoProgramVersion :: !Text
- agentInfoCurrentBundle :: !Maybe TaggedBundleInfo
- agentInfoStagedKey :: !Maybe KeyInfo
- agentInfoCurrentTime :: !UTCTime
- agentInfoCurrentKESPeriod :: !KESPeriod
- agentInfoCurrentKESPeriodStart :: !UTCTime
- agentInfoCurrentKESPeriodEnd :: !UTCTime
- agentInfoBootstrapConnections :: ![BootstrapInfo]

Instances9Eq, Show, Generic, NFData, FromAgentInfo, ToAgentInfo, …

Eq (VerKeyKES (KES StandardCrypto)) => Eq AgentInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
Show AgentInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
Generic AgentInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
NFData AgentInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
FromAgentInfo StandardCrypto AgentInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Processes.Agent.ControlDrivers
ToAgentInfo StandardCrypto AgentInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Processes.ControlClient
HasInfo (DirectCodec m) AgentInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Driver · orphan
(Monad (MonadEncode (DirectCodec m)), Monad (MonadDecode (DirectCodec m)), Serializable (DirectCodec m) Text, Serializable (DirectCodec m) (Maybe TaggedBundleInfo), Serializable (DirectCodec m) (Maybe KeyInfo), Serializable (DirectCodec m) UTCTime, Serializable (DirectCodec m) KESPeriod, Serializable (DirectCodec m) UTCTime, Serializable (DirectCodec m) UTCTime, Serializable (DirectCodec m) [BootstrapInfo]) => Serializable (DirectCodec m) AgentInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Driver · orphan
type Rep AgentInfo = D1 ('MetaData "AgentInfo" "Cardano.KESAgent.Protocols.Control.V3.Protocol" "kes-agent-1.3.0.0-CjPUY4LS7YJ95LTDqEpdnQ" 'False) (C1 ('MetaCons "AgentInfo" 'PrefixI 'True) (((S1 ('MetaSel ('Just "agentInfoProgramVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "agentInfoCurrentBundle") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe TaggedBundleInfo))) :*: (S1 ('MetaSel ('Just "agentInfoStagedKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe KeyInfo)) :*: S1 ('MetaSel ('Just "agentInfoCurrentTime") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UTCTime))) :*: ((S1 ('MetaSel ('Just "agentInfoCurrentKESPeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 KESPeriod) :*: S1 ('MetaSel ('Just "agentInfoCurrentKESPeriodStart") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UTCTime)) :*: (S1 ('MetaSel ('Just "agentInfoCurrentKESPeriodEnd") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "agentInfoBootstrapConnections") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [BootstrapInfo])))))Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.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.V3.Protocol
Show BootstrapInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
Generic BootstrapInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
NFData BootstrapInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
HasInfo (DirectCodec m) BootstrapInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.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.V3.Driver · orphan
type Rep BootstrapInfo = D1 ('MetaData "BootstrapInfo" "Cardano.KESAgent.Protocols.Control.V3.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.V3.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.V3.Protocol
Enum ConnectionStatusDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
Eq ConnectionStatusDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
Ord ConnectionStatusDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
Read ConnectionStatusDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
Show ConnectionStatusDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
Generic ConnectionStatusDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
NFData ConnectionStatusDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
(Codec codec, HasInfo codec Word8, HasInfo codec (DefEnumEncoding codec)) => HasInfo codec ConnectionStatusDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.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.V3.Driver · orphan
type Rep ConnectionStatus = D1 ('MetaData "ConnectionStatus" "Cardano.KESAgent.Protocols.Control.V3.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.V3.Protocol

datadata TaggedBundleInfo

Constructors

TaggedBundleInfo
- taggedBundleInfo :: Maybe BundleInfo
- taggedBundleInfoTimestamp :: Maybe UTCTime

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

Eq TaggedBundleInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
Show TaggedBundleInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
Generic TaggedBundleInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
NFData TaggedBundleInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
HasInfo (DirectCodec m) TaggedBundleInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Driver · orphan
(Monad (MonadEncode (DirectCodec m)), Monad (MonadDecode (DirectCodec m)), Serializable (DirectCodec m) (Maybe BundleInfo), Serializable (DirectCodec m) (Maybe UTCTime)) => Serializable (DirectCodec m) TaggedBundleInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Driver · orphan
type Rep TaggedBundleInfo = D1 ('MetaData "TaggedBundleInfo" "Cardano.KESAgent.Protocols.Control.V3.Protocol" "kes-agent-1.3.0.0-CjPUY4LS7YJ95LTDqEpdnQ" 'False) (C1 ('MetaCons "TaggedBundleInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "taggedBundleInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe BundleInfo)) :*: S1 ('MetaSel ('Just "taggedBundleInfoTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe UTCTime))))Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol

datadata BundleInfo

Constructors

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

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

Eq BundleInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
Show BundleInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
Generic BundleInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
NFData BundleInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
HasInfo (DirectCodec m) BundleInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.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 StandardCrypto)), Serializable (DirectCodec m) (SignedDSIGN (DSIGN StandardCrypto) (OCertSignable StandardCrypto))) => Serializable (DirectCodec m) BundleInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Driver · orphan
type Rep BundleInfo = D1 ('MetaData "BundleInfo" "Cardano.KESAgent.Protocols.Control.V3.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 StandardCrypto))) :*: S1 ('MetaSel ('Just "bundleInfoSigma") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 (SignedDSIGN (DSIGN StandardCrypto) (OCertSignable StandardCrypto)))))))Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol

newtypenewtype KeyInfo

Constructors

KeyInfo
- keyInfoVK :: VerKeyKES (KES StandardCrypto)

Instances5Eq, Show, NFData, HasInfo, Serializable

Eq (VerKeyKES (KES StandardCrypto)) => Eq KeyInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
Show KeyInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
NFData KeyInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
(Codec codec, HasInfo codec (VerKeyKES (KES StandardCrypto))) => HasInfo codec KeyInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Driver · orphan
(Codec codec, Monad (MonadEncode codec), Monad (MonadDecode codec), Serializable codec (VerKeyKES (KES StandardCrypto))) => Serializable codec KeyInfoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Driver · orphan

datadata ControlProtocol (m :: Type -> Type) 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
Default state after connecting, but before the protocol version has been negotiated.
IdleState :: ControlProtocol m
System is idling, waiting for the server to push the next key.
WaitForPublicKeyState :: ControlProtocol m
Client has made a request that will result in a public key being returned.
WaitForDropConfirmationState :: ControlProtocol m
Client has requested an installed key to be dropped.
WaitForInfoState :: ControlProtocol m
Client has requested agent information
WaitForKeyConfirmationState :: ControlProtocol m
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
The server has closed the connection, thus signalling the end of the session.

Instances28Protocol, VersionedProtocol, IsControlHandler, StateTokenI, HasInfo, Message, …

Protocol (ControlProtocol m)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
VersionedProtocol (ControlProtocol m)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
(MonadControlHandler m, NFData a) => IsControlHandler (ControlProtocol m) 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.V3.Protocol
StateTokenI 'IdleStateDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
StateTokenI 'InitialStateDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
StateTokenI 'WaitForDropConfirmationStateDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
StateTokenI 'WaitForInfoStateDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
StateTokenI 'WaitForKeyConfirmationStateDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
StateTokenI 'WaitForPublicKeyStateDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
HasInfo (DirectCodec m) (VerKeyKES (KES StandardCrypto)) => HasInfo (DirectCodec m) (Message (ControlProtocol m) 'IdleState 'WaitForKeyConfirmationState)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Driver · orphan
HasInfo (DirectCodec m) (VerKeyKES (KES StandardCrypto)) => HasInfo (DirectCodec m) (Message (ControlProtocol m) 'WaitForInfoState 'IdleState)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Driver · orphan
HasInfo (DirectCodec m) (VerKeyKES (KES StandardCrypto)) => HasInfo (DirectCodec m) (Message (ControlProtocol m) 'WaitForPublicKeyState 'IdleState)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Driver · orphan
HasInfo (DirectCodec m) (Message (ControlProtocol m) 'IdleState 'WaitForInfoState)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Driver · orphan
HasInfo (DirectCodec m) (Message (ControlProtocol m) 'IdleState 'WaitForPublicKeyState)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Driver · orphan
HasInfo (DirectCodec m) (Message (ControlProtocol m) 'InitialState 'IdleState)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Driver · orphan
HasInfo (DirectCodec m) (Message (ControlProtocol m) 'WaitForKeyConfirmationState 'IdleState)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Driver · orphan
HasInfo (DirectCodec m) (Message (ControlProtocol m) _st 'EndState)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Driver · orphan
data Message (ControlProtocol m)
- VersionMessage :: R:MessageControlProtocolstst' m 'InitialState 'IdleState
- GenStagedKeyMessage :: R:MessageControlProtocolstst' m 'IdleState 'WaitForPublicKeyState
- QueryStagedKeyMessage :: R:MessageControlProtocolstst' m 'IdleState 'WaitForPublicKeyState
- DropStagedKeyMessage :: R:MessageControlProtocolstst' m 'IdleState 'WaitForPublicKeyState
- PublicKeyMessage :: Maybe (VerKeyKES (KES StandardCrypto)) -> R:MessageControlProtocolstst' m 'WaitForPublicKeyState 'IdleState
- InstallKeyMessage :: OCert StandardCrypto -> R:MessageControlProtocolstst' m 'IdleState 'WaitForKeyConfirmationState
- InstallResultMessage :: RecvResult -> R:MessageControlProtocolstst' m 'WaitForKeyConfirmationState 'IdleState
- DropKeyMessage :: R:MessageControlProtocolstst' m 'IdleState 'WaitForDropConfirmationState
- DropKeyResultMessage :: RecvResult -> R:MessageControlProtocolstst' m 'WaitForDropConfirmationState 'IdleState
- RequestInfoMessage :: R:MessageControlProtocolstst' m 'IdleState 'WaitForInfoState
- InfoMessage :: AgentInfo -> R:MessageControlProtocolstst' m 'WaitForInfoState 'IdleState
- AbortMessage :: R:MessageControlProtocolstst' m 'InitialState 'EndState
- EndMessage :: R:MessageControlProtocolstst' m 'IdleState 'EndState
- ProtocolErrorMessage :: R:MessageControlProtocolstst' m st 'EndState
Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
type StateAgency 'EndState = 'NobodyAgencyDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
type StateAgency 'IdleState = 'ServerAgencyDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
type StateAgency 'InitialState = 'ServerAgencyDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
type StateAgency 'WaitForDropConfirmationState = 'ClientAgencyDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
type StateAgency 'WaitForInfoState = 'ClientAgencyDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
type StateAgency 'WaitForKeyConfirmationState = 'ClientAgencyDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
type StateAgency 'WaitForPublicKeyState = 'ClientAgencyDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
type StateToken = SControlProtocolDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Protocols.Control.V3.Protocol
type InitialState (ControlProtocol m) = 'InitialStateDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Processes.ControlClient

datadata SControlProtocol (st :: ControlProtocol m) where

valuecpVersionIdentifier :: VersionIdentifier