| Current File : //lib/python2.7/site-packages/paramiko/client.pyc |
�
=OXc @ s� d Z d d l m Z d d l Z d d l Z d d l Z d d l Z d d l m Z m Z d d l
m Z d d l m
Z
d d l m Z d d l m Z d d l m Z d d
l m Z d d l m Z d d l m Z d d
l m Z d d l m Z m Z m Z d d l m! Z! d d l" m# Z# m$ Z$ d e$ f d � � YZ% d e& f d � � YZ' d e' f d � � YZ( d e' f d � � YZ) d e' f d � � YZ* d S( s
SSH client & key policies
i����( t hexlifyN( t ECONNREFUSEDt EHOSTUNREACH( t Agent( t DEBUG( t SSH_PORT( t DSSKey( t ECDSAKey( t HostKeys( t string_types( t ResourceManager( t RSAKey( t SSHExceptiont BadHostKeyExceptiont NoValidConnectionsError( t Transport( t retry_on_signalt ClosingContextManagert SSHClientc B s� e Z d Z d � Z d d � Z d � Z d � Z d � Z d � Z d � Z
d � Z e d d d d d e
e
e d e e e
d d d � Z d
� Z d d e d d � Z d
d d d d d d � Z d � Z d � Z d � Z d � Z RS( s�
A high-level representation of a session with an SSH server. This class
wraps `.Transport`, `.Channel`, and `.SFTPClient` to take care of most
aspects of authenticating and opening channels. A typical use case is::
client = SSHClient()
client.load_system_host_keys()
client.connect('ssh.example.com')
stdin, stdout, stderr = client.exec_command('ls -l')
You may pass in explicit overrides for authentication and server host key
checking. The default mechanism is to try to use local key files or an
SSH agent (if one is running).
Instances of this class may be used as context managers.
.. versionadded:: 1.6
c C sL t � | _ t � | _ d | _ d | _ t � | _ d | _ d | _ d S( s)
Create a new SSHClient.
N(
R t _system_host_keyst
_host_keyst Nonet _host_keys_filenamet _log_channelt RejectPolicyt _policyt
_transportt _agent( t self( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyt __init__B s c C s^ | d k rJ t j j d � } y | j j | � Wn t k
rE n Xd S| j j | � d S( s�
Load host keys from a system (read-only) file. Host keys read with
this method will not be saved back by `save_host_keys`.
This method can be called multiple times. Each new set of host keys
will be merged with the existing set (new replacing old if there are
conflicts).
If ``filename`` is left as ``None``, an attempt will be made to read
keys from the user's local "known hosts" file, as used by OpenSSH,
and no exception will be raised if the file can't be read. This is
probably only useful on posix.
:param str filename: the filename to read, or ``None``
:raises IOError:
if a filename was provided and the file could not be read
s ~/.ssh/known_hostsN( R t ost patht
expanduserR t loadt IOError( R t filename( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyt load_system_host_keysN s
c C s | | _ | j j | � d S( s�
Load host keys from a local host-key file. Host keys read with this
method will be checked after keys loaded via `load_system_host_keys`,
but will be saved back by `save_host_keys` (so they can be modified).
The missing host key policy `.AutoAddPolicy` adds keys to this set and
saves them, when connecting to a previously-unknown server.
This method can be called multiple times. Each new set of host keys
will be merged with the existing set (new replacing old if there are
conflicts). When automatically saving, the last hostname is used.
:param str filename: the filename to read
:raises IOError: if the filename could not be read
N( R R R! ( R R# ( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyt load_host_keysk s c C s� | j d k r" | j | j � n t | d � �d } xZ | j j � D]I \ } } x: | j � D], \ } } | j d | | | j � f � q] WqD WWd QXd S( sH
Save the host keys back to a file. Only the host keys loaded with
`load_host_keys` (plus any added directly) will be saved -- not any
host keys loaded with `load_system_host_keys`.
:param str filename: the filename to save to
:raises IOError: if the file could not be written
t ws %s %s %s
N( R R R% t openR t itemst writet
get_base64( R R# t ft hostnamet keyst keytypet key( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyt save_host_keys~ s
c C s | j S( s�
Get the local `.HostKeys` object. This can be used to examine the
local host keys or change them.
:return: the local host keys as a `.HostKeys` object.
( R ( R ( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyt
get_host_keys� s c C s
| | _ d S( s�
Set the channel for logging. The default is ``"paramiko.transport"``
but it can be set to anything you want.
:param str name: new channel name for logging
N( R ( R t name( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyt set_log_channel� s c C s
| | _ d S( s�
Set policy to use when connecting to servers without a known host key.
Specifically:
* A **policy** is an instance of a "policy class", namely some subclass
of `.MissingHostKeyPolicy` such as `.RejectPolicy` (the default),
`.AutoAddPolicy`, `.WarningPolicy`, or a user-created subclass.
.. note::
This method takes class **instances**, not **classes** themselves.
Thus it must be called as e.g.
``.set_missing_host_key_policy(WarningPolicy())`` and *not*
``.set_missing_host_key_policy(WarningPolicy)``.
* A host key is **known** when it appears in the client object's cached
host keys structures (those manipulated by `load_system_host_keys`
and/or `load_host_keys`).
:param .MissingHostKeyPolicy policy:
the policy to use when receiving a host key from a
previously-unknown server
N( R ( R t policy( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyt set_missing_host_key_policy� s c c s� t } t j | | t j t j � } x@ | D]8 \ } } } } } | t j k r+ | | f Vt } q+ q+ W| r� x+ | D] \ } }
}
}
} | | f Vqt Wn d S( s
Yield pairs of address families and addresses to try for connecting.
:param str hostname: the server to connect to
:param int port: the server port to connect to
:returns: Yields an iterable of ``(family, address)`` tuples
N( t Truet sockett getaddrinfot AF_UNSPECt SOCK_STREAMt False( R R, t portt guesst addrinfost familyt socktypet protot canonnamet sockaddrt _( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyt _families_and_addresses� s
c
sE � s� i } t | j | | � � } x� | D]� \ } � yZ t j | t j � � | d k ry y � j | � Wqy qy Xn t � � f d � � PWq+ t j k
r� } | j t t
f k r� � n | | � <q+ Xq+ Wt | � t | � k r� t | � � q� n t
� d |
d | �} | _ | j d |
� |
rN| d k rN| j | � n" |
rp| d k rp| j | � n | j d k r�| j | j � n | d k r�| | _ n | j d | � t j | | � | j � } | j � } | t k r�| } n d | | f } | j j s�| j j | i � j | d � } | d k rd| j j | i � j | d � } n | d k r�| j j | | | � | } n | | k r�t | | | � � q�n | d k r�t! j" � } n | d k r�g } n! t# | t$ � r�| g } n | } | d k r| } n | j% | | | | | | | |
| | �
d S( s
Connect to an SSH server and authenticate to it. The server's host key
is checked against the system host keys (see `load_system_host_keys`)
and any local host keys (`load_host_keys`). If the server's hostname
is not found in either set of host keys, the missing host key policy
is used (see `set_missing_host_key_policy`). The default policy is
to reject the key and raise an `.SSHException`.
Authentication is attempted in the following order of priority:
- The ``pkey`` or ``key_filename`` passed in (if any)
- Any key we can find through an SSH agent
- Any "id_rsa", "id_dsa" or "id_ecdsa" key discoverable in
``~/.ssh/``
- Plain username/password auth, if a password was given
If a private key requires a password to unlock it, and a password is
passed in, that password will be used to attempt to unlock the key.
:param str hostname: the server to connect to
:param int port: the server port to connect to
:param str username:
the username to authenticate as (defaults to the current local
username)
:param str password:
a password to use for authentication or for unlocking a private key
:param .PKey pkey: an optional private key to use for authentication
:param str key_filename:
the filename, or list of filenames, of optional private key(s) to
try for authentication
:param float timeout:
an optional timeout (in seconds) for the TCP connect
:param bool allow_agent:
set to False to disable connecting to the SSH agent
:param bool look_for_keys:
set to False to disable searching for discoverable private key
files in ``~/.ssh/``
:param bool compress: set to True to turn on compression
:param socket sock:
an open socket or socket-like object (such as a `.Channel`) to use
for communication to the target host
:param bool gss_auth:
``True`` if you want to use GSS-API authentication
:param bool gss_kex:
Perform GSS-API Key Exchange and user authentication
:param bool gss_deleg_creds: Delegate GSS-API client credentials or not
:param str gss_host:
The targets name in the kerberos database. default: hostname
:param float banner_timeout: an optional timeout (in seconds) to wait
for the SSH banner to be presented.
:raises BadHostKeyException: if the server's host key could not be
verified
:raises AuthenticationException: if authentication failed
:raises SSHException: if there was any other error connecting or
establishing an SSH session
:raises socket.error: if a socket error occurred while connecting
.. versionchanged:: 1.15
Added the ``banner_timeout``, ``gss_auth``, ``gss_kex``,
``gss_deleg_creds`` and ``gss_host`` arguments.
c s
� j � � S( N( t connect( ( t addrt sock( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyt <lambda>1 s t gss_kext gss_deleg_credst compresst timeouts [%s]:%dN(& t listRE R7 R: R t
settimeoutR t errort errnoR R t lenR R R t use_compressiont set_gss_hostR R3 t banner_timeoutt start_clientR
t registert get_remote_server_keyt get_nameR t use_gss_kexR t getR R t missing_host_keyR
t getpasst getusert
isinstanceR t _auth( R R, R< t usernamet passwordt pkeyt key_filenameRM t allow_agentt
look_for_keysRL RH t gss_authRJ RK t gss_hostRU t errorst to_tryt aft et tt
server_keyR. t server_hostkey_namet our_server_keyt
key_filenames( ( RG RH s3 /usr/lib/python2.7/site-packages/paramiko/client.pyRF � sv Q c C sU | j d k r d S| j j � d | _ | j d k rQ | j j � d | _ n d S( s�
Close this SSHClient and its underlying `.Transport`.
.. warning::
Failure to do this may, in some situations, cause your Python
interpreter to hang at shutdown (often due to race conditions).
It's good practice to `close` your client objects anytime you're
done using them, instead of relying on garbage collection.
N( R R t closeR ( R ( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyRr ~ s
i����c
C s� | j j d | � } | r( | j � n | j | � | rK | j | � n | j | � | j d | � } | j d | � } | j d | � } | | | f S( sM
Execute a command on the SSH server. A new `.Channel` is opened and
the requested command is executed. The command's input and output
streams are returned as Python ``file``-like objects representing
stdin, stdout, and stderr.
:param str command: the command to execute
:param int bufsize:
interpreted the same way as by the built-in ``file()`` function in
Python
:param int timeout:
set command's channel timeout. See `Channel.settimeout`.settimeout
:param dict environment:
a dict of shell environment variables, to be merged into the
default environment that the remote command executes within.
.. warning::
Servers may silently reject some environment variables; see the
warning in `.Channel.set_environment_variable` for details.
:return:
the stdin, stdout, and stderr of the executing command, as a
3-tuple
:raises SSHException: if the server fails to execute the command
RM t wbt r( R t open_sessiont get_ptyRO t update_environmentt exec_commandt makefilet makefile_stderr(
R t commandt bufsizeRM Rv t environmentt chant stdint stdoutt stderr( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyRx � s "
t vt100iP i i c C s6 | j j � } | j | | | | | � | j � | S( s
Start an interactive shell session on the SSH server. A new `.Channel`
is opened and connected to a pseudo-terminal using the requested
terminal type and size.
:param str term:
the terminal type to emulate (for example, ``"vt100"``)
:param int width: the width (in characters) of the terminal window
:param int height: the height (in characters) of the terminal window
:param int width_pixels: the width (in pixels) of the terminal window
:param int height_pixels: the height (in pixels) of the terminal window
:param dict environment: the command's environment
:return: a new `.Channel` connected to the remote shell
:raises SSHException: if the server fails to invoke a shell
( R Ru Rv t invoke_shell( R t termt widtht heightt width_pixelst
height_pixelsR} R~ ( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyR� � s
c C s
| j j � S( sn
Open an SFTP session on the SSH server.
:return: a new `.SFTPClient` session object
( R t open_sftp_client( R ( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyt open_sftp� s c C s | j S( s�
Return the underlying `.Transport` object for this SSH connection.
This can be used to perform lower-level tasks, like opening specific
kinds of channels.
:return: the `.Transport` for this connection
( R ( R ( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyt
get_transport� s c C sl d } t } t � }
t d d g � } | rp | j j rp y | j j | � d SWqp t k
rl } | } qp Xn | r� y | j j | |
| � d SWq� t k
r� } | } q� Xn | d k r1yS | j t d t
| j � � � t | j j | | � � }
|
| @} | sd SWq1t
k
r-} | } q1Xn | s�x� | D]� } x� t t t f D]� } yl | j | | � } | j t d t
| j � � | f � t | j j | | � � }
|
| @} | s�d SPWqTt
k
r�} | } qTXqTWq>Wn | r�| r�| j d k rt � | _ n x� | j j � D]v } yT | j t d t
| j � � � t | j j | | � � }
|
| @} | s�d SPWq(t
k
r�} | } q(Xq(Wn | s�g } t j j d � } t j j d � } t j j d � } t j j | � r| j t | f � n t j j | � r7| j t | f � n t j j | � r_| j t | f � n t j j d
� } t j j d � } t j j d � } t j j | � r�| j t | f � n t j j | � r�| j t | f � n t j j | � r
| j t | f � n | s g } n x� | D]� \ } } yl | j | | � } | j t d
t
| j � � | f � t | j j | | � � }
|
| @} | s�d SPWq#t
t f k
r�} | } q#Xq#Wn | d k r
y | j j | | � d SWqGt
k
r} | } qGXn= | rGy | j j | � d SWqGt
k
rC} | } qGXn | d k r\| � n t
d � � d S( s�
Try, in order:
- The key passed in, if one was passed in.
- Any key we can find through an SSH agent (if allowed).
- Any "id_rsa", "id_dsa" or "id_ecdsa" key discoverable in ~/.ssh/
(if allowed).
- Plain username/password auth, if a password was given.
(The password might be needed to unlock a private key, or for
two-factor authentication [for which it is required].)
s keyboard-interactiveRb Ns Trying SSH key %ss Trying key %s from %ss Trying SSH agent key %ss
~/.ssh/id_rsas
~/.ssh/id_dsas ~/.ssh/id_ecdsas ~/ssh/id_rsas ~/ssh/id_dsas ~/ssh/id_ecdsas Trying discovered key %s in %ss# No authentication methods available( R R; t setR t gss_kex_usedt auth_gssapi_keyext Exceptiont auth_gssapi_with_mict _logR R t get_fingerprintt auth_publickeyR R R R t from_private_key_fileR R t get_keysR R R t isfilet appendR" t
auth_passwordt auth_interactive_dumb( R Ra Rb Rc Rq Re Rf Rg RJ RK Rh t saved_exceptiont
two_factort
allowed_typest two_factor_typesRl Rd t
pkey_classR/ t keyfilest rsa_keyt dsa_keyt ecdsa_keyR# ( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyR` � s�
&
&
c C s | j j | | � d S( N( R R� ( R t levelt msg( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyR� p s N( t __name__t
__module__t __doc__R R R$ R% R0 R1 R3 R5 RE R R6 R; RF Rr Rx R� R� R� R` R� ( ( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyR . sF � (
�t MissingHostKeyPolicyc B s e Z d Z d � Z RS( s�
Interface for defining the policy that `.SSHClient` should use when the
SSH server's hostname is not in either the system host keys or the
application's keys. Pre-made classes implement policies for automatically
adding the key to the application's `.HostKeys` object (`.AutoAddPolicy`),
and for automatically rejecting the key (`.RejectPolicy`).
This function may be used to ask the user to verify the key, for example.
c C s d S( s
Called when an `.SSHClient` receives a server key for a server that
isn't in either the system or local `.HostKeys` object. To accept
the key, simply return. To reject, raised an exception (which will
be passed to the calling application).
N( ( R t clientR, R/ ( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyR\ s ( R� R� R� R\ ( ( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyR� t s t
AutoAddPolicyc B s e Z d Z d � Z RS( s�
Policy for automatically adding the hostname and new host key to the
local `.HostKeys` object, and saving it. This is used by `.SSHClient`.
c C sq | j j | | j � | � | j d k r> | j | j � n | j t d | j � | t | j � � f � d S( Ns Adding %s host key for %s: %s(
R t addRY R R R0 R� R R R� ( R R� R, R/ ( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyR\ � s
( R� R� R� R\ ( ( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyR� � s R c B s e Z d Z d � Z RS( sk
Policy for automatically rejecting the unknown hostname & key. This is
used by `.SSHClient`.
c C sC | j t d | j � | t | j � � f � t d | � � d S( Ns Rejecting %s host key for %s: %ss" Server %r not found in known_hosts( R� R RY R R� R ( R R� R, R/ ( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyR\ � s #( R� R� R� R\ ( ( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyR � s t
WarningPolicyc B s e Z d Z d � Z RS( s�
Policy for logging a Python-style warning for an unknown host key, but
accepting it. This is used by `.SSHClient`.
c C s0 t j d | j � | t | j � � f � d S( Ns Unknown %s host key for %s: %s( t warningst warnRY R R� ( R R� R, R/ ( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyR\ � s ( R� R� R� R\ ( ( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyR� � s (+ R� t binasciiR R] R R7 R� RQ R R t paramiko.agentR t paramiko.commonR t paramiko.configR t paramiko.dsskeyR t paramiko.ecdsakeyR t paramiko.hostkeysR t paramiko.py3compatR t paramiko.resourceR
t paramiko.rsakeyR t paramiko.ssh_exceptionR R
R t paramiko.transportR t
paramiko.utilR R R t objectR� R� R R� ( ( ( s3 /usr/lib/python2.7/site-packages/paramiko/client.pyt <module> s2 � � H