Struct SessionBind

pub struct SessionBind {
    pub host_key: KeyData,
    pub session_id: Vec<u8>,
    pub signature: Signature,
    pub is_forwarding: bool,
}

session-bind@openssh.com message extension.

This message extension allows an SSH client to bind an agent connection to a particular SSH session.

Note: This is an OpenSSH-specific extension to the agent protocol.

Described in OpenSSH PROTOCOL.agent § 1

Fields

host_key: KeyData

Server host public key.

session_id: Vec<u8>

Hash derived from the initial key exchange.

signature: Signature

Server’s signature of the session identifier using the private hostkey.

is_forwarding: bool

Flag indicating whether this connection should be bound for user authentication or forwarding.

Implementations

impl SessionBind

pub fn verify_signature(&self) -> Result<(), ProtoError>

Verify the server’s signature of the session identifier using the public host_key.

When an agent receives [a session-bind@openssh.com message], it will verify the signature.

Described in OpenSSH PROTOCOL.agent § 1

Trait Implementations

impl Clone for SessionBind

fn clone(&self) -> SessionBind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SessionBind

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

Formats the value using the given formatter.

impl Decode for SessionBind

type Error = ProtoError

Type returned in the event of a decoding error.

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

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

impl Encode for SessionBind

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 MessageExtension for SessionBind

const NAME: &'static str = "session-bind@openssh.com"

Extension name, indicating the type of the message (as a UTF-8 string).

impl PartialEq for SessionBind

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