Package paramiko :: Class Agent |
[frames] | no frames]

# Class Agent

source code

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) Open a session with the local machine's SSH agent, if one is running. | source code
close(self) Close the SSH agent connection. | source code
tuple of AgentKey |
get_keys(self) Return the list of keys available through the SSH agent, if any. | source code

Method Details

### __init__(self) (Constructor) | source code
Open a session with the local machine's SSH agent, if one is running. If no agent is running, initialization will succeed, but get_keys will return an empty tuple. Raises: `SSHException` - if an SSH agent is found, but speaks an incompatible protocol

### 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