Documentation Language: Swift

Structure

SSHAgentKey

A representation of an SSH key from the agent.

struct SSHAgentKey

Overview

This structure encapsulates the key data and metadata returned by an SSH agent, providing access to both the raw key blob and the public key representation needed for SSH authentication operations.

The key maintains the original binary representation as received from the agent whilst also providing convenient access to the parsed public key for use with the NIOSSH framework. Comments associated with keys in the agent are preserved to assist with key identification and debugging.

Topics

Initializers

?
init(keyBlob:comment:debug:)

Creates a new SSH agent key representation.

Instance Properties

V
comment

The key comment/description from the agent

V
keyBlob

The raw key blob as returned by the SSH agent

V
publicKey

The parsed public key for use with NIOSSH

Relationships

Conforms To

See Also

Core Types

?
SSHAgent

An actor that implements communication with SSH agents using the standard protocol.

E
SSHAgentError

Errors raised whilst communicating with an SSH agent.

E
SSHAgentMessageType

SSH agent protocol message identifiers used on the wire.

S
SSHAgentSignFlags

SSH agent signing flags defined by the OpenSSH agent protocol.

T
SendableData

DataProtocol value that is also safe to send across concurrency domains.