Enum Request

pub enum Request {
    RequestIdentities,
    SignRequest(SignRequest),
    AddIdentity(AddIdentity),
    RemoveIdentity(RemoveIdentity),
    RemoveAllIdentities,
    AddSmartcardKey(SmartcardKey),
    RemoveSmartcardKey(SmartcardKey),
    Lock(String),
    Unlock(String),
    AddIdConstrained(AddIdentityConstrained),
    AddSmartcardKeyConstrained(AddSmartcardKeyConstrained),
    Extension(Extension),
}

SSH agent protocol request messages.

These message types are sent from a client to an agent.

Described in draft-miller-ssh-agent-14 § 3.

Variants

RequestIdentities

Request a list of all identities (public key/certificate & comment) from an agent

SignRequest(SignRequest)

Perform a private key signature operation using a key stored in the agent

AddIdentity(AddIdentity)

Add an identity (private key/certificate & comment) to an agent

RemoveIdentity(RemoveIdentity)

Remove an identity from an agent

RemoveAllIdentities

Remove all identities from an agent

AddSmartcardKey(SmartcardKey)

Add an identity (private key/certificate & comment) to an agent where the private key is stored on a hardware token

RemoveSmartcardKey(SmartcardKey)

Remove a key stored on a hardware token from an agent

Lock(String)

Temporarily lock an agent with a pass-phrase

Unlock(String)

Unlock a locked agaent with a pass-phrase

AddIdConstrained(AddIdentityConstrained)

Add an identity (private key/certificate & comment) to an agent, with constraints on it’s usage

AddSmartcardKeyConstrained(AddSmartcardKeyConstrained)

Add an identity (private key/certificate & comment) to an agent where the private key is stored on a hardware token, with constraints on it’s usage

Extension(Extension)

Send a vendor-specific message via the agent protocol, identified by an extension type.

Implementations

impl Request

pub fn message_id(&self) -> u8

The protocol message identifier for a given Request message type.

Described in draft-miller-ssh-agent-14 § 6.1.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Request

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Decode for Request

type Error = ProtoError

Type returned in the event of a decoding error.

fn decode(reader: &mut impl Reader) -> Result<Self>

Attempt to decode a value of this type using the provided Reader.

impl Encode for Request

fn encoded_len(&self) -> Result<usize>

Get the length of this type encoded in bytes, prior to Base64 encoding.

fn encode(&self, writer: &mut impl Writer) -> Result<()>

Encode this value using the provided Writer.

fn encoded_len_prefixed(&self) -> Result<usize, Error>

Return the length of this type after encoding when prepended with a uint32 length prefix.

fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Error>

Encode this value, first prepending a uint32 length prefix set to Encode::encoded_len.

impl PartialEq for Request

fn eq(&self, other: &Request) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Request