Modulekes-agent-1.3.0.0Haskell2010

Cardano.KESAgent.Processes.ControlClient

Control client process. A control client connects to a KES agent to issue commands, such as install-key, drop-key, or info. Control clients never exchange KES signing keys with a KES agent.

5 types
1 value

Packagekes-agent-1.3.0.0
Exports6
LanguageHaskell2010
LicenceApache-2.0
SourceControlClient.hs

datadata ControlClientTrace

Trace log messages a control client can generate.

Constructors

ControlClientVersionHandshakeDriverTrace VersionHandshakeDriverTrace
ControlClientVersionHandshakeFailed
ControlClientDriverTrace ControlDriverTrace
ControlClientSocketClosed
ControlClientConnected
ControlClientAttemptReconnect Int
ControlClientSendingKey
ControlClientAbnormalTermination String
ControlClientKeyAccepted
ControlClientKeyRejected RecvResult

Instances2Show, Pretty

Show ControlClientTraceDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Processes.ControlClient
Pretty ControlClientTraceDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Processes.ControlClient

datadata ControlClientOptions (m :: Type -> Type) fd addr

Configuration options for a control client.

Constructors

ControlClientOptions
- controlClientSnocket :: Snocket m fd addr
  Snocket implementation for dealing with sockets
- controlClientAddress :: addr
  Address to connect to. A KES agent should be listening for control connections on this address.
- controlClientLocalAddress :: Maybe addr
  Local address, if available. Used for logging.
- controlClientRetryDelay :: Int
  Delay, in milliseconds, between reconnection attempts.
- controlClientRetryExponential :: Bool
  Whether the delay between reconnection attempts should increase exponentially (True) or remain fixed (False)
- controlClientRetryAttempts :: Int
  How many reconnection attempts to make before giving up.

datadata ControlClient (m :: Type -> Type) c

Control client protocol interface.

Constructors

ControlClient
- controlGenKey :: ControlHandler m (Maybe (VerKeyKES (KES c)))
  The gen-key command
- controlQueryKey :: ControlHandler m (Maybe (VerKeyKES (KES c)))
  The export-staged-key command
- controlDropStagedKey :: ControlHandler m (Maybe (VerKeyKES (KES c)))
  The drop-staged-key command
- controlInstallKey :: OCert c -> ControlHandler m RecvResult
  The install-key command
- controlDropKey :: ControlHandler m RecvResult
  The drop-key command
- controlGetInfo :: ControlHandler m (AgentInfo c)
  The info command

typetype ControlHandler (m :: Type -> Type) a = RawBearer m -> Tracer m ControlClientTrace -> m a

Compatibility abstraction over control protocols. A control handler function should delegate functionality to a suitable

valuerunControlClient1

:: (ControlClientContext m c, ControlClientDrivers c)
=> ControlClient m c -> ControlHandler m a
-> Proxy c
-> MakeRawBearer m fd
-> ControlClientOptions m fd addr
-> Tracer m ControlClientTrace
-> m a

Connect to a KES agent as a control client, send one command, handle the response, and close the connection.

typetype ControlClientCrypto c = (Crypto c, NamedCrypto c, ControlClientDrivers c)

Typeclasses needed to use a crypto for control client purposes.