dorian
/
paramiko
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix up AgentSSH vs Agent classes/docstrings, sigh

This commit is contained in:
Jeff Forcier 2014-02-24 17:00:53 -08:00
parent b47b578e59
commit 9ae46dcbfa
2 changed files with 9 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
paramiko/agent.py
View File

@ -17,7 +17,7 @@
# 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
""" """
SSH Agent interface for Unix clients. SSH Agent interface
""" """
import os import os
@ -42,16 +42,6 @@ SSH2_AGENTC_REQUEST_IDENTITIES, SSH2_AGENT_IDENTITIES_ANSWER, \
class AgentSSH(object): class AgentSSH(object):
"""
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).
"""
def __init__(self): def __init__(self):
self._conn = None self._conn = None
self._keys = () self._keys = ()
@ -318,19 +308,14 @@ class Agent(AgentSSH):
connect to it and retreive `.PKey` objects which can be used when connect to it and retreive `.PKey` objects which can be used when
attempting to authenticate to remote SSH servers. attempting to authenticate to remote SSH servers.
Because the SSH agent protocol uses environment variables and unix-domain Upon initialization, a session with the local machine's SSH agent is
sockets, this probably doesn't work on Windows. It does work on most opened, if one is running. If no agent is running, initialization will
posix platforms though (Linux and MacOS X, for example). succeed, but `get_keys` will return an empty tuple.
:raises SSHException:
if an SSH agent is found, but speaks an incompatible protocol
""" """
def __init__(self): def __init__(self):
"""
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
"""
AgentSSH.__init__(self) AgentSSH.__init__(self)
if ('SSH_AUTH_SOCK' in os.environ) and (sys.platform != 'win32'): if ('SSH_AUTH_SOCK' in os.environ) and (sys.platform != 'win32'):

2
sites/docs/api/agent.rst
View File

@ -2,3 +2,5 @@ SSH Agents
========== ==========
.. automodule:: paramiko.agent .. automodule:: paramiko.agent
:inherited-members:
:no-special-members: