Skip to main content

Module runtime

Module runtime 

Source
Expand description

Application-level runtime API for managing the identity agent and keys.

Provides functions to interact with core components: secure key storage (KeyStorage), cryptographic operations, the in-memory agent (AgentCore), and the agent listener. Uses AgentHandle for lifecycle management of agent instances. Also includes functions for interacting with the platform’s SSH agent (on macOS).

Structs§

KeyLoadStatus
Represents the result of trying to load a single key into the agent core.
KeyRegistrationStatus
Represents the status of registering a single key with the system SSH agent.

Enums§

RegistrationOutcome
Represents the outcome of attempting to register a key with the system SSH agent.

Functions§

agent_sign_with_handle
Signs a message using a key currently loaded in the specified agent handle.
clear_agent_keys_with_handle
Clears all unlocked keys from the specified agent handle.
export_key_openssh_pem
Exports the decrypted private key in OpenSSH PEM format.
export_key_openssh_pub
Exports the public key in OpenSSH .pub format.
get_agent_key_count_with_handle
Returns the number of keys currently loaded in the specified agent handle.
load_keys_into_agent_with_handle
Loads specific keys (by alias) from secure storage into the specified agent handle.
register_keys_with_macos_agent_with_handle
Stub function for non-macOS platforms.
rotate_key
Rotates the keypair for a given alias in the secure storage only.
start_agent_listener
Starts the SSH agent listener on the specified Unix domain socket path.
start_agent_listener_with_handle
Starts the SSH agent listener using the provided AgentHandle.