Enum KeyConstraint

pub enum KeyConstraint {
    Lifetime(u32),
    Confirm,
    Extension(Extension),
}

A key constraint, used to place limitations on how and where a key can be used.

Key constraints are set along with a key when are added to an agent.

Specifically, they appear in special SSH_AGENTC_ADD_* message variants:

• Request::AddIdConstrained
• Request::AddSmartcardKeyConstrained

Variants

Lifetime(u32)

Limit the key’s lifetime by deleting it after the specified duration (in seconds)

Confirm

Require explicit user confirmation for each private key operation using the key.

Extension(Extension)

Experimental or private-use constraints

Contains:

• An extension name indicating the type of the constraint (as a UTF-8 string).
• Extension-specific content

Extension names should be suffixed by the implementation domain as per RFC4251 § 4.2, e.g. “foo@example.com”

Trait Implementations

impl Clone for KeyConstraint

fn clone(&self) -> KeyConstraint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyConstraint

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

Formats the value using the given formatter.

impl Decode for KeyConstraint

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 KeyConstraint

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 KeyConstraint

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