Struct SmartcardKey

pub struct SmartcardKey {
    pub id: String,
    pub pin: SecretString,
}

Pointer to a key in a hardware token, along with an optional PIN.

This structure is sent in a Request::AddSmartcardKey (SSH_AGENTC_ADD_SMARTCARD_KEY) message.

Described in draft-miller-ssh-agent-14 § 3.2

Fields

id: String

An opaque identifier for the hardware token

Note: the interpretation of “id” is not defined by the protocol, but is left solely up to the agent.

pin: SecretString

An optional password to unlock the key

Trait Implementations

impl Clone for SmartcardKey

fn clone(&self) -> SmartcardKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SmartcardKey

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

Formats the value using the given formatter.

impl Decode for SmartcardKey

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 SmartcardKey

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 SmartcardKey

fn eq(&self, other: &Self) -> 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.