Interface SshAgent

What a key-derivation lock/unlock needs from an SSH agent (the reference's SSHAgent trait, asynchronous here).

An implementation reports its own failures as a ComponentsError; a failure to sign is reported by the caller as SSH agent refused to sign whatever the implementation threw.

interface SshAgent {
    listIdentities(): Promise<readonly SSHPublicKey[]>;
    sign(
        identity: SSHPublicKey,
        data: Uint8Array,
    ): Promise<Uint8Array<ArrayBufferLike>>;
}

Implemented by

MemorySshAgent

Index

Methods

listIdentities sign

Methods

listIdentities

listIdentities(): Promise<readonly SSHPublicKey[]>
The public keys the agent holds, each with its comment.

Returns Promise<readonly SSHPublicKey[]>
- Defined in ssh-agent/ssh-agent.ts:25

sign

sign(
identity: SSHPublicKey,
data: Uint8Array,
): Promise<Uint8Array<ArrayBufferLike>>
The raw signature bytes (for Ed25519 the 64-byte signature) over data.
Parameters
- identity: SSHPublicKey
- data: Uint8Array
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in ssh-agent/ssh-agent.ts:27