Skip to main content

AgentSession

Struct AgentSession 

Source
pub struct AgentSession { /* private fields */ }
Expand description

Wraps an AgentHandle to implement the ssh_agent_lib::agent::Session trait.

Each AgentSession holds a reference to an AgentHandle, enabling multiple independent agent instances to coexist.

Implementations§

Source§

impl AgentSession

Source

pub fn new(handle: Arc<AgentHandle>) -> Self

Creates a new AgentSession wrapping the given AgentHandle.

Source

pub fn handle(&self) -> &AgentHandle

Returns a reference to the underlying agent handle.

Trait Implementations§

Source§

impl Clone for AgentSession

Source§

fn clone(&self) -> AgentSession

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AgentSession

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Session for AgentSession

Source§

fn request_identities<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Vec<Identity>, SSHAgentError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Request a list of keys managed by this session.
Source§

fn sign<'life0, 'async_trait>( &'life0 mut self, request: SignRequest, ) -> Pin<Box<dyn Future<Output = Result<Signature, SSHAgentError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Perform a private key signature operation.
Source§

fn add_identity<'life0, 'async_trait>( &'life0 mut self, identity: AddIdentity, ) -> Pin<Box<dyn Future<Output = Result<(), SSHAgentError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Add a private key to the agent.
Source§

fn remove_identity<'life0, 'async_trait>( &'life0 mut self, identity: RemoveIdentity, ) -> Pin<Box<dyn Future<Output = Result<(), SSHAgentError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Remove private key from an agent.
Source§

fn remove_all_identities<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), SSHAgentError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Remove all keys from an agent.
Source§

fn add_identity_constrained<'life0, 'async_trait>( &'life0 mut self, _identity: AddIdentityConstrained, ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Add a private key to the agent with a set of constraints.
Source§

fn add_smartcard_key<'life0, 'async_trait>( &'life0 mut self, _key: SmartcardKey, ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Add a key stored on a smartcard.
Source§

fn add_smartcard_key_constrained<'life0, 'async_trait>( &'life0 mut self, _key: AddSmartcardKeyConstrained, ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Add a key stored on a smartcard with a set of constraints.
Source§

fn remove_smartcard_key<'life0, 'async_trait>( &'life0 mut self, _key: SmartcardKey, ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Remove a smartcard key from the agent.
Source§

fn lock<'life0, 'async_trait>( &'life0 mut self, _key: String, ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Temporarily lock the agent with a password.
Source§

fn unlock<'life0, 'async_trait>( &'life0 mut self, _key: String, ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Unlock the agent with a password.
Source§

fn extension<'life0, 'async_trait>( &'life0 mut self, _extension: Extension, ) -> Pin<Box<dyn Future<Output = Result<Option<Extension>, AgentError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Invoke a custom, vendor-specific extension on the agent.
Source§

fn handle<'life0, 'async_trait>( &'life0 mut self, message: Request, ) -> Pin<Box<dyn Future<Output = Result<Response, AgentError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Handle a raw SSH agent request and return agent response. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Agent<TcpListener> for T
where T: Clone + Send + Sync + Session,

Source§

fn new_session(&mut self, _socket: &TcpStream) -> impl Session

Create a Session object for a given socket.
Source§

impl<T> Agent<UnixListener> for T
where T: Clone + Send + Sync + Session,

Source§

fn new_session(&mut self, _socket: &UnixStream) -> impl Session

Create a Session object for a given socket.
Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V