Struct Extension

pub struct Extension {
    pub name: String,
    pub details: Unparsed,
}

Container for SSH agent protocol extension messages

This structure is sent as part of a Request::Extension (SSH_AGENT_EXTENSION_RESPONSE) message.

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

Fields

name: String

Indicates the type of the extension message (as a UTF-8 string)

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

details: Unparsed

Extension-specific content

Implementations

impl Extension

pub fn new_message<T>(extension: T) -> Result<Self>

where T: MessageExtension + Encode,

Create a new Extension from a MessageExtension structure implementing ssh_encoding::Encode

pub fn parse_message<T>(&self) -> Result<Option<T>, <T as Decode>::Error>

where T: MessageExtension + Decode,

Attempt to parse a an extension object into a MessageExtension structure implementing ssh_encoding::Decode.

If there is a mismatch between the extension name and the MessageExtension::NAME, this method will return None

pub fn new_key_constraint<T>(extension: T) -> Result<Self>

where T: KeyConstraintExtension + Encode,

Create a new Extension from a KeyConstraintExtension structure implementing ssh_encoding::Encode

pub fn parse_key_constraint<T>(&self) -> Result<Option<T>, <T as Decode>::Error>

where T: KeyConstraintExtension + Decode,

Attempt to parse a an extension object into a KeyConstraintExtension structure implementing ssh_encoding::Decode.

If there is a mismatch between the extension name and the KeyConstraintExtension::NAME, this method will return None

Trait Implementations

impl Clone for Extension

fn clone(&self) -> Extension

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Extension

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

Formats the value using the given formatter.

impl Decode for Extension

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 Extension

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 Extension

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