Package paramiko :: Module agent :: Class AgentSSH

Class AgentSSH

object --+
         |
        AgentSSH

Known Subclasses:

Client interface for using private keys from an SSH agent running on the local machine. If an SSH agent is running, this class can be used to connect to it and retreive PKey objects which can be used when attempting to authenticate to remote SSH servers.

Because the SSH agent protocol uses environment variables and unix-domain sockets, this probably doesn't work on Windows. It does work on most posix platforms though (Linux and MacOS X, for example).

Instance Methods

__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

tuple of AgentKey

get_keys(self)
Return the list of keys available through the SSH agent, if any.

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
Inherited from `object`: `__class__`

Method Details

init(self)
(Constructor)

source code

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

get_keys(self)

source code

Return the list of keys available through the SSH agent, if any. If no SSH agent was running (or it couldn't be contacted), an empty list will be returned.

Returns: tuple of AgentKey: a list of keys available on the SSH agent

Class AgentSSH

__init__(self) (Constructor)

get_keys(self)

init(self)
(Constructor)