diff options
31 files changed, 1706 insertions, 1692 deletions
diff --git a/paramiko/__init__.py b/paramiko/__init__.py index 7f60b1fa..99123858 100644 --- a/paramiko/__init__.py +++ b/paramiko/__init__.py @@ -17,35 +17,35 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -I{Paramiko} (a combination of the esperanto words for "paranoid" and "friend") +Paramiko (a combination of the esperanto words for "paranoid" and "friend") is a module for python 2.5 or greater that implements the SSH2 protocol for secure (encrypted and authenticated) connections to remote machines. Unlike SSL (aka TLS), the SSH2 protocol does not require hierarchical certificates signed by a powerful central authority. You may know SSH2 as the protocol that -replaced C{telnet} and C{rsh} for secure access to remote shells, but the +replaced ``telnet`` and ``rsh`` for secure access to remote shells, but the protocol also includes the ability to open arbitrary channels to remote -services across an encrypted tunnel. (This is how C{sftp} works, for example.) +services across an encrypted tunnel. (This is how ``sftp`` works, for example.) -The high-level client API starts with creation of an L{SSHClient} object. +The high-level client API starts with creation of an :class:`SSHClient` object. For more direct control, pass a socket (or socket-like object) to a -L{Transport}, and use L{start_server <Transport.start_server>} or -L{start_client <Transport.start_client>} to negoatite +:class:`Transport`, and use :class:`start_server <Transport.start_server>` or +:class:`start_client <Transport.start_client>` to negoatite with the remote host as either a server or client. As a client, you are responsible for authenticating using a password or private key, and checking -the server's host key. I{(Key signature and verification is done by paramiko, +the server's host key. (Key signature and verification is done by paramiko, but you will need to provide private keys and check that the content of a -public key matches what you expected to see.)} As a server, you are +public key matches what you expected to see.) As a server, you are responsible for deciding which users, passwords, and keys to allow, and what kind of channels to allow. -Once you have finished, either side may request flow-controlled L{Channel}s to -the other side, which are python objects that act like sockets, but send and +Once you have finished, either side may request flow-controlled :class:`channels <Channel>` +to the other side, which are python objects that act like sockets, but send and receive data over the encrypted session. Paramiko is written entirely in python (no C or platform-dependent code) and is released under the GNU Lesser General Public License (LGPL). -Website: U{https://github.com/paramiko/paramiko/} +Website: https://github.com/paramiko/paramiko/ """ import sys diff --git a/paramiko/agent.py b/paramiko/agent.py index 23a5a2e4..a09851bc 100644 --- a/paramiko/agent.py +++ b/paramiko/agent.py @@ -44,7 +44,7 @@ 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 L{PKey} objects which can be used when + connect to it and retreive :class:`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 @@ -61,8 +61,8 @@ class AgentSSH(object): no SSH agent was running (or it couldn't be contacted), an empty list will be returned. - @return: a list of keys available on the SSH agent - @rtype: tuple of L{AgentKey} + :return: a list of keys available on the SSH agent + :rtype: tuple of :class:`AgentKey` """ return self._keys @@ -238,9 +238,9 @@ class AgentClientProxy(object): class AgentServerProxy(AgentSSH): """ - @param t : transport used for the Forward for SSH Agent communication + :param t : transport used for the Forward for SSH Agent communication - @raise SSHException: mostly if we lost the agent + :raises SSHException: mostly if we lost the agent """ def __init__(self, t): AgentSSH.__init__(self) @@ -276,8 +276,8 @@ class AgentServerProxy(AgentSSH): """ Helper for the environnement under unix - @return: the SSH_AUTH_SOCK Environnement variables - @rtype: dict + :return: the SSH_AUTH_SOCK Environnement variables + :rtype: dict """ env = {} env['SSH_AUTH_SOCK'] = self._get_filename() @@ -307,7 +307,7 @@ class Agent(AgentSSH): """ 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 L{PKey} objects which can be used when + connect to it and retreive :class:`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 @@ -318,10 +318,10 @@ class Agent(AgentSSH): 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 L{get_keys} + If no agent is running, initialization will succeed, but :class:`get_keys` will return an empty tuple. - @raise SSHException: if an SSH agent is found, but speaks an + :raises SSHException: if an SSH agent is found, but speaks an incompatible protocol """ AgentSSH.__init__(self) diff --git a/paramiko/auth_handler.py b/paramiko/auth_handler.py index acb7c8b8..56bd37d5 100644 --- a/paramiko/auth_handler.py +++ b/paramiko/auth_handler.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{AuthHandler} +:class:`AuthHandler` """ import threading diff --git a/paramiko/buffered_pipe.py b/paramiko/buffered_pipe.py index 4ef5cf74..23ed9f44 100644 --- a/paramiko/buffered_pipe.py +++ b/paramiko/buffered_pipe.py @@ -29,7 +29,7 @@ import time class PipeTimeout (IOError): """ - Indicates that a timeout was reached on a read from a L{BufferedPipe}. + Indicates that a timeout was reached on a read from a :class:`BufferedPipe`. """ pass @@ -38,7 +38,7 @@ class BufferedPipe (object): """ A buffer that obeys normal read (with timeout) & close semantics for a file or socket, but is fed data from another thread. This is used by - L{Channel}. + :class:`Channel`. """ def __init__(self): @@ -54,8 +54,8 @@ class BufferedPipe (object): buffer has been closed), the event will be set. When no data is ready, the event will be cleared. - @param event: the event to set/clear - @type event: Event + :param event: the event to set/clear + :type event: Event """ self._event = event if len(self._buffer) > 0: @@ -68,8 +68,8 @@ class BufferedPipe (object): Feed new data into this pipe. This method is assumed to be called from a separate thread, so synchronization is done. - @param data: the data to add - @type data: str + :param data: the data to add + :type data: str """ self._lock.acquire() try: @@ -83,12 +83,12 @@ class BufferedPipe (object): def read_ready(self): """ Returns true if data is buffered and ready to be read from this - feeder. A C{False} result does not mean that the feeder has closed; + feeder. A ``False`` result does not mean that the feeder has closed; it means you may need to wait before more data arrives. - @return: C{True} if a L{read} call would immediately return at least - one byte; C{False} otherwise. - @rtype: bool + :return: ``True`` if a :class:`read` call would immediately return at least + one byte; ``False`` otherwise. + :rtype: bool """ self._lock.acquire() try: @@ -102,23 +102,23 @@ class BufferedPipe (object): """ Read data from the pipe. The return value is a string representing the data received. The maximum amount of data to be received at once - is specified by C{nbytes}. If a string of length zero is returned, + is specified by ``nbytes``. If a string of length zero is returned, the pipe has been closed. - The optional C{timeout} argument can be a nonnegative float expressing - seconds, or C{None} for no timeout. If a float is given, a - C{PipeTimeout} will be raised if the timeout period value has + The optional ``timeout`` argument can be a nonnegative float expressing + seconds, or ``None`` for no timeout. If a float is given, a + ``PipeTimeout`` will be raised if the timeout period value has elapsed before any data arrives. - @param nbytes: maximum number of bytes to read - @type nbytes: int - @param timeout: maximum seconds to wait (or C{None}, the default, to + :param nbytes: maximum number of bytes to read + :type nbytes: int + :param timeout: maximum seconds to wait (or ``None``, the default, to wait forever) - @type timeout: float - @return: data - @rtype: str + :type timeout: float + :return: data + :rtype: str - @raise PipeTimeout: if a timeout was specified and no data was ready + :raises PipeTimeout: if a timeout was specified and no data was ready before that timeout """ out = '' @@ -158,8 +158,8 @@ class BufferedPipe (object): """ Clear out the buffer and return all data that was in it. - @return: any data that was in the buffer prior to clearing it out - @rtype: str + :return: any data that was in the buffer prior to clearing it out + :rtype: str """ self._lock.acquire() try: @@ -173,7 +173,7 @@ class BufferedPipe (object): def close(self): """ - Close this pipe object. Future calls to L{read} after the buffer + Close this pipe object. Future calls to :class:`read` after the buffer has been emptied will return immediately with an empty string. """ self._lock.acquire() @@ -189,8 +189,8 @@ class BufferedPipe (object): """ Return the number of bytes buffered. - @return: number of bytes bufferes - @rtype: int + :return: number of bytes bufferes + :rtype: int """ self._lock.acquire() try: diff --git a/paramiko/channel.py b/paramiko/channel.py index c680e44b..7a430435 100644 --- a/paramiko/channel.py +++ b/paramiko/channel.py @@ -42,7 +42,7 @@ MIN_PACKET_SIZE = 1024 class Channel (object): """ - A secure tunnel across an SSH L{Transport}. A Channel is meant to behave + A secure tunnel across an SSH :class:`Transport`. A Channel is meant to behave like a socket, and has an API that should be indistinguishable from the python socket API. @@ -51,20 +51,20 @@ class Channel (object): you any more data until you read some of it. (This won't affect other channels on the same transport -- all channels on a single transport are flow-controlled independently.) Similarly, if the server isn't reading - data you send, calls to L{send} may block, unless you set a timeout. This + data you send, calls to :class:`send` may block, unless you set a timeout. This is exactly like a normal network socket, so it shouldn't be too surprising. """ def __init__(self, chanid): """ Create a new channel. The channel is not associated with any - particular session or L{Transport} until the Transport attaches it. + particular session or :class:`Transport` until the Transport attaches it. Normally you would only call this method from the constructor of a - subclass of L{Channel}. + subclass of :class:`Channel`. - @param chanid: the ID of this channel, as passed by an existing - L{Transport}. - @type chanid: int + :param chanid: the ID of this channel, as passed by an existing + :class:`Transport`. + :type chanid: int """ self.chanid = chanid self.remote_chanid = 0 @@ -105,7 +105,7 @@ class Channel (object): """ Return a string representation of this object, for debugging. - @rtype: str + :rtype: str """ out = '<paramiko.Channel %d' % self.chanid if self.closed: @@ -127,22 +127,22 @@ class Channel (object): """ Request a pseudo-terminal from the server. This is usually used right after creating a client channel, to ask the server to provide some - basic terminal semantics for a shell invoked with L{invoke_shell}. + basic terminal semantics for a shell invoked with :class:`invoke_shell`. It isn't necessary (or desirable) to call this method if you're going - to exectue a single command with L{exec_command}. - - @param term: the terminal type to emulate (for example, C{'vt100'}) - @type term: str - @param width: width (in characters) of the terminal screen - @type width: int - @param height: height (in characters) of the terminal screen - @type height: int - @param width_pixels: width (in pixels) of the terminal screen - @type width_pixels: int - @param height_pixels: height (in pixels) of the terminal screen - @type height_pixels: int + to exectue a single command with :class:`exec_command`. + + :param term: the terminal type to emulate (for example, ``'vt100'``) + :type term: str + :param width: width (in characters) of the terminal screen + :type width: int + :param height: height (in characters) of the terminal screen + :type height: int + :param width_pixels: width (in pixels) of the terminal screen + :type width_pixels: int + :param height_pixels: height (in pixels) of the terminal screen + :type height_pixels: int - @raise SSHException: if the request was rejected or the channel was + :raises SSHException: if the request was rejected or the channel was closed """ if self.closed or self.eof_received or self.eof_sent or not self.active: @@ -168,14 +168,14 @@ class Channel (object): allows it, the channel will then be directly connected to the stdin, stdout, and stderr of the shell. - Normally you would call L{get_pty} before this, in which case the + Normally you would call :class:`get_pty` before this, in which case the shell will operate through the pty, and the channel will be connected to the stdin and stdout of the pty. When the shell exits, the channel will be closed and can't be reused. You must open a new channel if you wish to open another shell. - @raise SSHException: if the request was rejected or the channel was + :raises SSHException: if the request was rejected or the channel was closed """ if self.closed or self.eof_received or self.eof_sent or not self.active: @@ -199,10 +199,10 @@ class Channel (object): can't be reused. You must open a new channel if you wish to execute another command. - @param command: a shell command to execute. - @type command: str + :param command: a shell command to execute. + :type command: str - @raise SSHException: if the request was rejected or the channel was + :raises SSHException: if the request was rejected or the channel was closed """ if self.closed or self.eof_received or self.eof_sent or not self.active: @@ -219,17 +219,17 @@ class Channel (object): def invoke_subsystem(self, subsystem): """ - Request a subsystem on the server (for example, C{sftp}). If the + Request a subsystem on the server (for example, ``sftp``). If the server allows it, the channel will then be directly connected to the requested subsystem. When the subsystem finishes, the channel will be closed and can't be reused. - @param subsystem: name of the subsystem being requested. - @type subsystem: str + :param subsystem: name of the subsystem being requested. + :type subsystem: str - @raise SSHException: if the request was rejected or the channel was + :raises SSHException: if the request was rejected or the channel was closed """ if self.closed or self.eof_received or self.eof_sent or not self.active: @@ -247,18 +247,18 @@ class Channel (object): def resize_pty(self, width=80, height=24, width_pixels=0, height_pixels=0): """ Resize the pseudo-terminal. This can be used to change the width and - height of the terminal emulation created in a previous L{get_pty} call. - - @param width: new width (in characters) of the terminal screen - @type width: int - @param height: new height (in characters) of the terminal screen - @type height: int - @param width_pixels: new width (in pixels) of the terminal screen - @type width_pixels: int - @param height_pixels: new height (in pixels) of the terminal screen - @type height_pixels: int - - @raise SSHException: if the request was rejected or the channel was + height of the terminal emulation created in a previous :class:`get_pty` call. + + :param width: new width (in characters) of the terminal screen + :type width: int + :param height: new height (in characters) of the terminal screen + :type height: int + :param width_pixels: new width (in pixels) of the terminal screen + :type width_pixels: int + :param height_pixels: new height (in pixels) of the terminal screen + :type height_pixels: int + + :raises SSHException: if the request was rejected or the channel was closed """ if self.closed or self.eof_received or self.eof_sent or not self.active: @@ -278,27 +278,27 @@ class Channel (object): """ Return true if the remote process has exited and returned an exit status. You may use this to poll the process status if you don't - want to block in L{recv_exit_status}. Note that the server may not + want to block in :class:`recv_exit_status`. Note that the server may not return an exit status in some cases (like bad servers). - @return: True if L{recv_exit_status} will return immediately - @rtype: bool - @since: 1.7.3 + :return: True if :class:`recv_exit_status` will return immediately + :rtype: bool + .. versionadded:: 1.7.3 """ return self.closed or self.status_event.isSet() def recv_exit_status(self): """ Return the exit status from the process on the server. This is - mostly useful for retrieving the reults of an L{exec_command}. + mostly useful for retrieving the reults of an :class:`exec_command`. If the command hasn't finished yet, this method will wait until it does, or until the channel is closed. If no exit status is provided by the server, -1 is returned. - @return: the exit code of the process on the server. - @rtype: int + :return: the exit code of the process on the server. + :rtype: int - @since: 1.2 + .. versionadded:: 1.2 """ self.status_event.wait() assert self.status_event.isSet() @@ -311,10 +311,10 @@ class Channel (object): get some sort of status code back from an executed command after it completes. - @param status: the exit code of the process - @type status: int + :param status: the exit code of the process + :type status: int - @since: 1.2 + .. versionadded:: 1.2 """ # in many cases, the channel will not still be open here. # that's fine. @@ -347,25 +347,25 @@ class Channel (object): If a handler is passed in, the handler is called from another thread whenever a new x11 connection arrives. The default handler queues up incoming x11 connections, which may be retrieved using - L{Transport.accept}. The handler's calling signature is:: + :class:`Transport.accept`. The handler's calling signature is:: handler(channel: Channel, (address: str, port: int)) - @param screen_number: the x11 screen number (0, 10, etc) - @type screen_number: int - @param auth_protocol: the name of the X11 authentication method used; - if none is given, C{"MIT-MAGIC-COOKIE-1"} is used - @type auth_protocol: str - @param auth_cookie: hexadecimal string containing the x11 auth cookie; + :param screen_number: the x11 screen number (0, 10, etc) + :type screen_number: int + :param auth_protocol: the name of the X11 authentication method used; + if none is given, ``"MIT-MAGIC-COOKIE-1"`` is used + :type auth_protocol: str + :param auth_cookie: hexadecimal string containing the x11 auth cookie; if none is given, a secure random 128-bit value is generated - @type auth_cookie: str - @param single_connection: if True, only a single x11 connection will be + :type auth_cookie: str + :param single_connection: if True, only a single x11 connection will be forwarded (by default, any number of x11 connections can arrive over this session) - @type single_connection: bool - @param handler: an optional handler to use for incoming X11 connections - @type handler: function - @return: the auth_cookie used + :type single_connection: bool + :param handler: an optional handler to use for incoming X11 connections + :type handler: function + :return: the auth_cookie used """ if self.closed or self.eof_received or self.eof_sent or not self.active: raise SSHException('Channel is not open') @@ -394,13 +394,13 @@ class Channel (object): Request for a forward SSH Agent on this channel. This is only valid for an ssh-agent from openssh !!! - @param handler: a required handler to use for incoming SSH Agent connections - @type handler: function + :param handler: a required handler to use for incoming SSH Agent connections + :type handler: function - @return: if we are ok or not (at that time we always return ok) - @rtype: boolean + :return: if we are ok or not (at that time we always return ok) + :rtype: boolean - @raise: SSHException in case of channel problem. + :raises: SSHException in case of channel problem. """ if self.closed or self.eof_received or self.eof_sent or not self.active: raise SSHException('Channel is not open') @@ -416,10 +416,10 @@ class Channel (object): def get_transport(self): """ - Return the L{Transport} associated with this channel. + Return the :class:`Transport` associated with this channel. - @return: the L{Transport} that was used to create this channel. - @rtype: L{Transport} + :return: the :class:`Transport` that was used to create this channel. + :rtype: :class:`Transport` """ return self.transport @@ -427,55 +427,55 @@ class Channel (object): """ Set a name for this channel. Currently it's only used to set the name of the channel in logfile entries. The name can be fetched with the - L{get_name} method. + :class:`get_name` method. - @param name: new channel name - @type name: str + :param name: new channel name + :type name: str """ self._name = name def get_name(self): """ - Get the name of this channel that was previously set by L{set_name}. + Get the name of this channel that was previously set by :class:`set_name`. - @return: the name of this channel. - @rtype: str + :return: the name of this channel. + :rtype: str """ return self._name def get_id(self): """ Return the ID # for this channel. The channel ID is unique across - a L{Transport} and usually a small number. It's also the number - passed to L{ServerInterface.check_channel_request} when determining + a :class:`Transport` and usually a small number. It's also the number + passed to :class:`ServerInterface.check_channel_request` when determining whether to accept a channel request in server mode. - @return: the ID of this channel. - @rtype: int + :return: the ID of this channel. + :rtype: int """ return self.chanid def set_combine_stderr(self, combine): """ Set whether stderr should be combined into stdout on this channel. - The default is C{False}, but in some cases it may be convenient to + The default is ``False``, but in some cases it may be convenient to have both streams combined. - If this is C{False}, and L{exec_command} is called (or C{invoke_shell} - with no pty), output to stderr will not show up through the L{recv} - and L{recv_ready} calls. You will have to use L{recv_stderr} and - L{recv_stderr_ready} to get stderr output. + If this is ``False``, and :class:`exec_command` is called (or ``invoke_shell`` + with no pty), output to stderr will not show up through the :class:`recv` + and :class:`recv_ready` calls. You will have to use :class:`recv_stderr` and + :class:`recv_stderr_ready` to get stderr output. - If this is C{True}, data will never show up via L{recv_stderr} or - L{recv_stderr_ready}. + If this is ``True``, data will never show up via :class:`recv_stderr` or + :class:`recv_stderr_ready`. - @param combine: C{True} if stderr output should be combined into + :param combine: ``True`` if stderr output should be combined into stdout on this channel. - @type combine: bool - @return: previous setting. - @rtype: bool + :type combine: bool + :return: previous setting. + :rtype: bool - @since: 1.1 + .. versionadded:: 1.1 """ data = '' self.lock.acquire() @@ -497,51 +497,51 @@ class Channel (object): def settimeout(self, timeout): """ - Set a timeout on blocking read/write operations. The C{timeout} - argument can be a nonnegative float expressing seconds, or C{None}. If + Set a timeout on blocking read/write operations. The ``timeout`` + argument can be a nonnegative float expressing seconds, or ``None``. If a float is given, subsequent channel read/write operations will raise a timeout exception if the timeout period value has elapsed before the - operation has completed. Setting a timeout of C{None} disables + operation has completed. Setting a timeout of ``None`` disables timeouts on socket operations. - C{chan.settimeout(0.0)} is equivalent to C{chan.setblocking(0)}; - C{chan.settimeout(None)} is equivalent to C{chan.setblocking(1)}. + ``chan.settimeout(0.0)`` is equivalent to ``chan.setblocking(0)``; + ``chan.settimeout(None)`` is equivalent to ``chan.setblocking(1)``. - @param timeout: seconds to wait for a pending read/write operation - before raising C{socket.timeout}, or C{None} for no timeout. - @type timeout: float + :param timeout: seconds to wait for a pending read/write operation + before raising ``socket.timeout``, or ``None`` for no timeout. + :type timeout: float """ self.timeout = timeout def gettimeout(self): """ Returns the timeout in seconds (as a float) associated with socket - operations, or C{None} if no timeout is set. This reflects the last - call to L{setblocking} or L{settimeout}. + operations, or ``None`` if no timeout is set. This reflects the last + call to :class:`setblocking` or :class:`settimeout`. - @return: timeout in seconds, or C{None}. - @rtype: float + :return: timeout in seconds, or ``None``. + :rtype: float """ return self.timeout def setblocking(self, blocking): """ - Set blocking or non-blocking mode of the channel: if C{blocking} is 0, + Set blocking or non-blocking mode of the channel: if ``blocking`` is 0, the channel is set to non-blocking mode; otherwise it's set to blocking mode. Initially all channels are in blocking mode. - In non-blocking mode, if a L{recv} call doesn't find any data, or if a - L{send} call can't immediately dispose of the data, an error exception + In non-blocking mode, if a :class:`recv` call doesn't find any data, or if a + :class:`send` call can't immediately dispose of the data, an error exception is raised. In blocking mode, the calls block until they can proceed. An - EOF condition is considered "immediate data" for L{recv}, so if the + EOF condition is considered "immediate data" for :class:`recv`, so if the channel is closed in the read direction, it will never block. - C{chan.setblocking(0)} is equivalent to C{chan.settimeout(0)}; - C{chan.setblocking(1)} is equivalent to C{chan.settimeout(None)}. + ``chan.setblocking(0)`` is equivalent to ``chan.settimeout(0)``; + ``chan.setblocking(1)`` is equivalent to ``chan.settimeout(None)``. - @param blocking: 0 to set non-blocking mode; non-0 to set blocking + :param blocking: 0 to set non-blocking mode; non-0 to set blocking mode. - @type blocking: int + :type blocking: int """ if blocking: self.settimeout(None) @@ -551,12 +551,12 @@ class Channel (object): def getpeername(self): """ Return the address of the remote side of this Channel, if possible. - This is just a wrapper around C{'getpeername'} on the Transport, used + This is just a wrapper around ``'getpeername'`` on the Transport, used to provide enough of a socket-like interface to allow asyncore to work. - (asyncore likes to call C{'getpeername'}.) + (asyncore likes to call ``'getpeername'``.) - @return: the address if the remote host, if known - @rtype: tuple(str, int) + :return: the address if the remote host, if known + :rtype: tuple(str, int) """ return self.transport.getpeername() @@ -564,7 +564,7 @@ class Channel (object): """ Close the channel. All future read/write operations on the channel will fail. The remote end will receive no more data (after queued data - is flushed). Channels are automatically closed when their L{Transport} + is flushed). Channels are automatically closed when their :class:`Transport` is closed or when they are garbage collected. """ self.lock.acquire() @@ -589,12 +589,12 @@ class Channel (object): def recv_ready(self): """ Returns true if data is buffered and ready to be read from this - channel. A C{False} result does not mean that the channel has closed; + channel. A ``False`` result does not mean that the channel has closed; it means you may need to wait before more data arrives. - @return: C{True} if a L{recv} call on this channel would immediately - return at least one byte; C{False} otherwise. - @rtype: boolean + :return: ``True`` if a :class:`recv` call on this channel would immediately + return at least one byte; ``False`` otherwise. + :rtype: boolean """ return self.in_buffer.read_ready() @@ -602,16 +602,16 @@ class Channel (object): """ Receive data from the channel. The return value is a string representing the data received. The maximum amount of data to be - received at once is specified by C{nbytes}. If a string of length zero + received at once is specified by ``nbytes``. If a string of length zero is returned, the channel stream has closed. - @param nbytes: maximum number of bytes to read. - @type nbytes: int - @return: data. - @rtype: str + :param nbytes: maximum number of bytes to read. + :type nbytes: int + :return: data. + :rtype: str - @raise socket.timeout: if no data is ready before the timeout set by - L{settimeout}. + :raises socket.timeout: if no data is ready before the timeout set by + :class:`settimeout`. """ try: out = self.in_buffer.read(nbytes, self.timeout) @@ -632,36 +632,36 @@ class Channel (object): def recv_stderr_ready(self): """ Returns true if data is buffered and ready to be read from this - channel's stderr stream. Only channels using L{exec_command} or - L{invoke_shell} without a pty will ever have data on the stderr + channel's stderr stream. Only channels using :class:`exec_command` or + :class:`invoke_shell` without a pty will ever have data on the stderr stream. - @return: C{True} if a L{recv_stderr} call on this channel would - immediately return at least one byte; C{False} otherwise. - @rtype: boolean + :return: ``True`` if a :class:`recv_stderr` call on this channel would + immediately return at least one byte; ``False`` otherwise. + :rtype: boolean - @since: 1.1 + .. versionadded:: 1.1 """ return self.in_stderr_buffer.read_ready() def recv_stderr(self, nbytes): """ Receive data from the channel's stderr stream. Only channels using - L{exec_command} or L{invoke_shell} without a pty will ever have data + :class:`exec_command` or :class:`invoke_shell` without a pty will ever have data on the stderr stream. The return value is a string representing the data received. The maximum amount of data to be received at once is - specified by C{nbytes}. If a string of length zero is returned, the + specified by ``nbytes``. If a string of length zero is returned, the channel stream has closed. - @param nbytes: maximum number of bytes to read. - @type nbytes: int - @return: data. - @rtype: str + :param nbytes: maximum number of bytes to read. + :type nbytes: int + :return: data. + :rtype: str - @raise socket.timeout: if no data is ready before the timeout set by - L{settimeout}. + :raises socket.timeout: if no data is ready before the timeout set by + :class:`settimeout`. - @since: 1.1 + .. versionadded:: 1.1 """ try: out = self.in_stderr_buffer.read(nbytes, self.timeout) @@ -685,12 +685,12 @@ class Channel (object): This means the channel is either closed (so any write attempt would return immediately) or there is at least one byte of space in the outbound buffer. If there is at least one byte of space in the - outbound buffer, a L{send} call will succeed immediately and return + outbound buffer, a :class:`send` call will succeed immediately and return the number of bytes actually written. - @return: C{True} if a L{send} call on this channel would immediately + :return: ``True`` if a :class:`send` call on this channel would immediately succeed or fail - @rtype: boolean + :rtype: boolean """ self.lock.acquire() try: @@ -708,13 +708,13 @@ class Channel (object): transmitted, the application needs to attempt delivery of the remaining data. - @param s: data to send - @type s: str - @return: number of bytes actually sent - @rtype: int + :param s: data to send + :type s: str + :return: number of bytes actually sent + :rtype: int - @raise socket.timeout: if no data could be sent before the timeout set - by L{settimeout}. + :raises socket.timeout: if no data could be sent before the timeout set + by :class:`settimeout`. """ size = len(s) self.lock.acquire() @@ -743,15 +743,15 @@ class Channel (object): data has been sent: if only some of the data was transmitted, the application needs to attempt delivery of the remaining data. - @param s: data to send. - @type s: str - @return: number of bytes actually sent. - @rtype: int + :param s: data to send. + :type s: str + :return: number of bytes actually sent. + :rtype: int - @raise socket.timeout: if no data could be sent before the timeout set - by L{settimeout}. + :raises socket.timeout: if no data could be sent before the timeout set + by :class:`settimeout`. - @since: 1.1 + .. versionadded:: 1.1 """ size = len(s) self.lock.acquire() @@ -775,18 +775,18 @@ class Channel (object): def sendall(self, s): """ Send data to the channel, without allowing partial results. Unlike - L{send}, this method continues to send data from the given string until + :class:`send`, this method continues to send data from the given string until either all data has been sent or an error occurs. Nothing is returned. - @param s: data to send. - @type s: str + :param s: data to send. + :type s: str - @raise socket.timeout: if sending stalled for longer than the timeout - set by L{settimeout}. - @raise socket.error: if an error occured before the entire string was + :raises socket.timeout: if sending stalled for longer than the timeout + set by :class:`settimeout`. + :raises socket.error: if an error occured before the entire string was sent. - @note: If the channel is closed while only part of the data hase been + .. note:: If the channel is closed while only part of the data hase been sent, there is no way to determine how much data (if any) was sent. This is irritating, but identically follows python's API. """ @@ -801,19 +801,19 @@ class Channel (object): def sendall_stderr(self, s): """ Send data to the channel's "stderr" stream, without allowing partial - results. Unlike L{send_stderr}, this method continues to send data + results. Unlike :class:`send_stderr`, this method continues to send data from the given string until all data has been sent or an error occurs. Nothing is returned. - @param s: data to send to the client as "stderr" output. - @type s: str + :param s: data to send to the client as "stderr" output. + :type s: str - @raise socket.timeout: if sending stalled for longer than the timeout - set by L{settimeout}. - @raise socket.error: if an error occured before the entire string was + :raises socket.timeout: if sending stalled for longer than the timeout + set by :class:`settimeout`. + :raises socket.error: if an error occured before the entire string was sent. - @since: 1.1 + .. versionadded:: 1.1 """ while s: if self.closed: @@ -825,48 +825,48 @@ class Channel (object): def makefile(self, *params): """ Return a file-like object associated with this channel. The optional - C{mode} and C{bufsize} arguments are interpreted the same way as by - the built-in C{file()} function in python. + ``mode`` and ``bufsize`` arguments are interpreted the same way as by + the built-in ``file()`` function in python. - @return: object which can be used for python file I/O. - @rtype: L{ChannelFile} + :return: object which can be used for python file I/O. + :rtype: :class:`ChannelFile` """ return ChannelFile(*([self] + list(params))) def makefile_stderr(self, *params): """ Return a file-like object associated with this channel's stderr - stream. Only channels using L{exec_command} or L{invoke_shell} + stream. Only channels using :class:`exec_command` or :class:`invoke_shell` without a pty will ever have data on the stderr stream. - The optional C{mode} and C{bufsize} arguments are interpreted the - same way as by the built-in C{file()} function in python. For a + The optional ``mode`` and ``bufsize`` arguments are interpreted the + same way as by the built-in ``file()`` function in python. For a client, it only makes sense to open this file for reading. For a server, it only makes sense to open this file for writing. - @return: object which can be used for python file I/O. - @rtype: L{ChannelFile} + :return: object which can be used for python file I/O. + :rtype: :class:`ChannelFile` - @since: 1.1 + .. versionadded:: 1.1 """ return ChannelStderrFile(*([self] + list(params))) def fileno(self): """ Returns an OS-level file descriptor which can be used for polling, but - but I{not} for reading or writing. This is primaily to allow python's - C{select} module to work. + but not for reading or writing. This is primaily to allow python's + ``select`` module to work. - The first time C{fileno} is called on a channel, a pipe is created to + The first time ``fileno`` is called on a channel, a pipe is created to simulate real OS-level file descriptor (FD) behavior. Because of this, two OS-level FDs are created, which will use up FDs faster than normal. (You won't notice this effect unless you have hundreds of channels open at the same time.) - @return: an OS-level file descriptor - @rtype: int + :return: an OS-level file descriptor + :rtype: int - @warning: This method causes channel reads to be slightly less + .. warning:: This method causes channel reads to be slightly less efficient. """ self.lock.acquire() @@ -884,14 +884,14 @@ class Channel (object): def shutdown(self, how): """ - Shut down one or both halves of the connection. If C{how} is 0, - further receives are disallowed. If C{how} is 1, further sends - are disallowed. If C{how} is 2, further sends and receives are + Shut down one or both halves of the connection. If ``how`` is 0, + further receives are disallowed. If ``how`` is 1, further sends + are disallowed. If ``how`` is 2, further sends and receives are disallowed. This closes the stream in one or both directions. - @param how: 0 (stop receiving), 1 (stop sending), or 2 (stop + :param how: 0 (stop receiving), 1 (stop sending), or 2 (stop receiving and sending). - @type how: int + :type how: int """ if (how == 0) or (how == 2): # feign "read" shutdown @@ -910,10 +910,10 @@ class Channel (object): Shutdown the receiving side of this socket, closing the stream in the incoming direction. After this call, future reads on this channel will fail instantly. This is a convenience method, equivalent - to C{shutdown(0)}, for people who don't make it a habit to + to ``shutdown(0)``, for people who don't make it a habit to memorize unix constants from the 1970s. - @since: 1.2 + .. versionadded:: 1.2 """ self.shutdown(0) @@ -922,10 +922,10 @@ class Channel (object): Shutdown the sending side of this socket, closing the stream in the outgoing direction. After this call, future writes on this channel will fail instantly. This is a convenience method, equivalent - to C{shutdown(1)}, for people who don't make it a habit to + to ``shutdown(1)``, for people who don't make it a habit to memorize unix constants from the 1970s. - @since: 1.2 + .. versionadded:: 1.2 """ self.shutdown(1) @@ -1189,7 +1189,7 @@ class Channel (object): def _wait_for_send_window(self, size): """ (You are already holding the lock.) - Wait for the send window to open up, and allocate up to C{size} bytes + Wait for the send window to open up, and allocate up to ``size`` bytes for transmission. If no space opens up before the timeout, a timeout exception is raised. Returns the number of bytes available to send (may be less than requested). @@ -1227,13 +1227,13 @@ class Channel (object): class ChannelFile (BufferedFile): """ - A file-like wrapper around L{Channel}. A ChannelFile is created by calling - L{Channel.makefile}. + A file-like wrapper around :class:`Channel`. A ChannelFile is created by calling + :class:`Channel.makefile`. @bug: To correctly emulate the file object created from a socket's - C{makefile} method, a L{Channel} and its C{ChannelFile} should be able + ``makefile`` method, a :class:`Channel` and its ``ChannelFile`` should be able to be closed or garbage-collected independently. Currently, closing - the C{ChannelFile} does nothing but flush the buffer. + the ``ChannelFile`` does nothing but flush the buffer. """ def __init__(self, channel, mode = 'r', bufsize = -1): @@ -1245,7 +1245,7 @@ class ChannelFile (BufferedFile): """ Returns a string representation of this object, for debugging. - @rtype: str + :rtype: str """ return '<paramiko.ChannelFile from ' + repr(self.channel) + '>' diff --git a/paramiko/client.py b/paramiko/client.py index be896091..19a09c2d 100644 --- a/paramiko/client.py +++ b/paramiko/client.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{SSHClient}. +:class:`SSHClient`. """ from binascii import hexlify @@ -40,19 +40,19 @@ from paramiko.util import retry_on_signal class MissingHostKeyPolicy (object): """ - Interface for defining the policy that L{SSHClient} should use when the + Interface for defining the policy that :class:`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 L{HostKeys} object (L{AutoAddPolicy}), - and for automatically rejecting the key (L{RejectPolicy}). + adding the key to the application's :class:`HostKeys` object (:class:`AutoAddPolicy`), + and for automatically rejecting the key (:class:`RejectPolicy`). This function may be used to ask the user to verify the key, for example. """ def missing_host_key(self, client, hostname, key): """ - Called when an L{SSHClient} receives a server key for a server that - isn't in either the system or local L{HostKeys} object. To accept + Called when an :class:`SSHClient` receives a server key for a server that + isn't in either the system or local :class:`HostKeys` object. To accept the key, simply return. To reject, raised an exception (which will be passed to the calling application). """ @@ -62,7 +62,7 @@ class MissingHostKeyPolicy (object): class AutoAddPolicy (MissingHostKeyPolicy): """ Policy for automatically adding the hostname and new host key to the - local L{HostKeys} object, and saving it. This is used by L{SSHClient}. + local :class:`HostKeys` object, and saving it. This is used by :class:`SSHClient`. """ def missing_host_key(self, client, hostname, key): @@ -76,7 +76,7 @@ class AutoAddPolicy (MissingHostKeyPolicy): class RejectPolicy (MissingHostKeyPolicy): """ Policy for automatically rejecting the unknown hostname & key. This is - used by L{SSHClient}. + used by :class:`SSHClient`. """ def missing_host_key(self, client, hostname, key): @@ -88,7 +88,7 @@ class RejectPolicy (MissingHostKeyPolicy): class WarningPolicy (MissingHostKeyPolicy): """ Policy for logging a python-style warning for an unknown host key, but - accepting it. This is used by L{SSHClient}. + accepting it. This is used by :class:`SSHClient`. """ def missing_host_key(self, client, hostname, key): warnings.warn('Unknown %s host key for %s: %s' % @@ -98,7 +98,7 @@ class WarningPolicy (MissingHostKeyPolicy): class SSHClient (object): """ A high-level representation of a session with an SSH server. This class - wraps L{Transport}, L{Channel}, and L{SFTPClient} to take care of most + wraps :class:`Transport`, :class:`Channel`, and :class:`SFTPClient` to take care of most aspects of authenticating and opening channels. A typical use case is:: client = SSHClient() @@ -110,7 +110,7 @@ class SSHClient (object): checking. The default mechanism is to try to use local key files or an SSH agent (if one is running). - @since: 1.6 + .. versionadded:: 1.6 """ def __init__(self): @@ -128,21 +128,21 @@ class SSHClient (object): def load_system_host_keys(self, filename=None): """ Load host keys from a system (read-only) file. Host keys read with - this method will not be saved back by L{save_host_keys}. + this method will not be saved back by :class:`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 C{filename} is left as C{None}, an attempt will be made to read + 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 filename: the filename to read, or C{None} - @type filename: str + :param filename: the filename to read, or ``None`` + :type filename: str - @raise IOError: if a filename was provided and the file could not be + :raises IOError: if a filename was provided and the file could not be read """ if filename is None: @@ -158,19 +158,19 @@ class SSHClient (object): def load_host_keys(self, filename): """ Load host keys from a local host-key file. Host keys read with this - method will be checked I{after} keys loaded via L{load_system_host_keys}, - but will be saved back by L{save_host_keys} (so they can be modified). - The missing host key policy L{AutoAddPolicy} adds keys to this set and + method will be checked after keys loaded via :class:`load_system_host_keys`, + but will be saved back by :class:`save_host_keys` (so they can be modified). + The missing host key policy :class:`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 filename: the filename to read - @type filename: str + :param filename: the filename to read + :type filename: str - @raise IOError: if the filename could not be read + :raises IOError: if the filename could not be read """ self._host_keys_filename = filename self._host_keys.load(filename) @@ -178,13 +178,13 @@ class SSHClient (object): def save_host_keys(self, filename): """ Save the host keys back to a file. Only the host keys loaded with - L{load_host_keys} (plus any added directly) will be saved -- not any - host keys loaded with L{load_system_host_keys}. + :class:`load_host_keys` (plus any added directly) will be saved -- not any + host keys loaded with :class:`load_system_host_keys`. - @param filename: the filename to save to - @type filename: str + :param filename: the filename to save to + :type filename: str - @raise IOError: if the file could not be written + :raises IOError: if the file could not be written """ # update local host keys from file (in case other SSH clients @@ -200,34 +200,34 @@ class SSHClient (object): def get_host_keys(self): """ - Get the local L{HostKeys} object. This can be used to examine the + Get the local :class:`HostKeys` object. This can be used to examine the local host keys or change them. - @return: the local host keys - @rtype: L{HostKeys} + :return: the local host keys + :rtype: :class:`HostKeys` """ return self._host_keys def set_log_channel(self, name): """ - Set the channel for logging. The default is C{"paramiko.transport"} + Set the channel for logging. The default is ``"paramiko.transport"`` but it can be set to anything you want. - @param name: new channel name for logging - @type name: str + :param name: new channel name for logging + :type name: str """ self._log_channel = name def set_missing_host_key_policy(self, policy): """ Set the policy to use when connecting to a server that doesn't have a - host key in either the system or local L{HostKeys} objects. The - default policy is to reject all unknown servers (using L{RejectPolicy}). - You may substitute L{AutoAddPolicy} or write your own policy class. + host key in either the system or local :class:`HostKeys` objects. The + default policy is to reject all unknown servers (using :class:`RejectPolicy`). + You may substitute :class:`AutoAddPolicy` or write your own policy class. - @param policy: the policy to use when receiving a host key from a + :param policy: the policy to use when receiving a host key from a previously-unknown server - @type policy: L{MissingHostKeyPolicy} + :type policy: :class:`MissingHostKeyPolicy` """ self._policy = policy @@ -236,56 +236,56 @@ class SSHClient (object): compress=False, sock=None): """ Connect to an SSH server and authenticate to it. The server's host key - is checked against the system host keys (see L{load_system_host_keys}) - and any local host keys (L{load_host_keys}). If the server's hostname + is checked against the system host keys (see :class:`load_system_host_keys`) + and any local host keys (:class:`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 L{set_missing_host_key_policy}). The default policy is - to reject the key and raise an L{SSHException}. + is used (see :class:`set_missing_host_key_policy`). The default policy is + to reject the key and raise an :class:`SSHException`. Authentication is attempted in the following order of priority: - - The C{pkey} or C{key_filename} passed in (if any) + - The ``pkey`` or ``key_filename`` passed in (if any) - Any key we can find through an SSH agent - - Any "id_rsa" or "id_dsa" key discoverable in C{~/.ssh/} + - Any "id_rsa" or "id_dsa" 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 hostname: the server to connect to - @type hostname: str - @param port: the server port to connect to - @type port: int - @param username: the username to authenticate as (defaults to the + :param hostname: the server to connect to + :type hostname: str + :param port: the server port to connect to + :type port: int + :param username: the username to authenticate as (defaults to the current local username) - @type username: str - @param password: a password to use for authentication or for unlocking + :type username: str + :param password: a password to use for authentication or for unlocking a private key - @type password: str - @param pkey: an optional private key to use for authentication - @type pkey: L{PKey} - @param key_filename: the filename, or list of filenames, of optional + :type password: str + :param pkey: an optional private key to use for authentication + :type pkey: :class:`PKey` + :param key_filename: the filename, or list of filenames, of optional private key(s) to try for authentication - @type key_filename: str or list(str) - @param timeout: an optional timeout (in seconds) for the TCP connect - @type timeout: float - @param allow_agent: set to False to disable connecting to the SSH agent - @type allow_agent: bool - @param look_for_keys: set to False to disable searching for discoverable - private key files in C{~/.ssh/} - @type look_for_keys: bool - @param compress: set to True to turn on compression - @type compress: bool - @param sock: an open socket or socket-like object (such as a - L{Channel}) to use for communication to the target host - @type sock: socket - - @raise BadHostKeyException: if the server's host key could not be + :type key_filename: str or list(str) + :param timeout: an optional timeout (in seconds) for the TCP connect + :type timeout: float + :param allow_agent: set to False to disable connecting to the SSH agent + :type allow_agent: bool + :param look_for_keys: set to False to disable searching for discoverable + private key files in ``~/.ssh/`` + :type look_for_keys: bool + :param compress: set to True to turn on compression + :type compress: bool + :param sock: an open socket or socket-like object (such as a + :class:`Channel`) to use for communication to the target host + :type sock: socket + + :raises BadHostKeyException: if the server's host key could not be verified - @raise AuthenticationException: if authentication failed - @raise SSHException: if there was any other error connecting or + :raises AuthenticationException: if authentication failed + :raises SSHException: if there was any other error connecting or establishing an SSH session - @raise socket.error: if a socket error occurred while connecting + :raises socket.error: if a socket error occurred while connecting """ if not sock: for (family, socktype, proto, canonname, sockaddr) in socket.getaddrinfo(hostname, port, socket.AF_UNSPEC, socket.SOCK_STREAM): @@ -343,7 +343,7 @@ class SSHClient (object): def close(self): """ - Close this SSHClient and its underlying L{Transport}. + Close this SSHClient and its underlying :class:`Transport`. """ if self._transport is None: return @@ -356,21 +356,21 @@ class SSHClient (object): def exec_command(self, command, bufsize=-1, timeout=None, get_pty=False): """ - Execute a command on the SSH server. A new L{Channel} is opened and + Execute a command on the SSH server. A new :class:`Channel` is opened and the requested command is executed. The command's input and output - streams are returned as python C{file}-like objects representing + streams are returned as python ``file``-like objects representing stdin, stdout, and stderr. - @param command: the command to execute - @type command: str - @param bufsize: interpreted the same way as by the built-in C{file()} function in python - @type bufsize: int - @param timeout: set command's channel timeout. See L{Channel.settimeout}.settimeout - @type timeout: int - @return: the stdin, stdout, and stderr of the executing command - @rtype: tuple(L{ChannelFile}, L{ChannelFile}, L{ChannelFile}) + :param command: the command to execute + :type command: str + :param bufsize: interpreted the same way as by the built-in ``file()`` function in python + :type bufsize: int + :param timeout: set command's channel timeout. See :class:`Channel.settimeout`.settimeout + :type timeout: int + :return: the stdin, stdout, and stderr of the executing command + :rtype: tuple(:class:`ChannelFile`, :class:`ChannelFile`, :class:`ChannelFile`) - @raise SSHException: if the server fails to execute the command + :raises SSHException: if the server fails to execute the command """ chan = self._transport.open_session() if(get_pty): @@ -385,24 +385,24 @@ class SSHClient (object): def invoke_shell(self, term='vt100', width=80, height=24, width_pixels=0, height_pixels=0): """ - Start an interactive shell session on the SSH server. A new L{Channel} + Start an interactive shell session on the SSH server. A new :class:`Channel` is opened and connected to a pseudo-terminal using the requested terminal type and size. - @param term: the terminal type to emulate (for example, C{"vt100"}) - @type term: str - @param width: the width (in characters) of the terminal window - @type width: int - @param height: the height (in characters) of the terminal window - @type height: int - @param width_pixels: the width (in pixels) of the terminal window - @type width_pixels: int - @param height_pixels: the height (in pixels) of the terminal window - @type height_pixels: int - @return: a new channel connected to the remote shell - @rtype: L{Channel} - - @raise SSHException: if the server fails to invoke a shell + :param term: the terminal type to emulate (for example, ``"vt100"``) + :type term: str + :param width: the width (in characters) of the terminal window + :type width: int + :param height: the height (in characters) of the terminal window + :type height: int + :param width_pixels: the width (in pixels) of the terminal window + :type width_pixels: int + :param height_pixels: the height (in pixels) of the terminal window + :type height_pixels: int + :return: a new channel connected to the remote shell + :rtype: :class:`Channel` + + :raises SSHException: if the server fails to invoke a shell """ chan = self._transport.open_session() chan.get_pty(term, width, height, width_pixels, height_pixels) @@ -413,19 +413,19 @@ class SSHClient (object): """ Open an SFTP session on the SSH server. - @return: a new SFTP session object - @rtype: L{SFTPClient} + :return: a new SFTP session object + :rtype: :class:`SFTPClient` """ return self._transport.open_sftp_client() def get_transport(self): """ - Return the underlying L{Transport} object for this SSH connection. + Return the underlying :class:`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 - @rtype: L{Transport} + :return: the Transport for this connection + :rtype: :class:`Transport` """ return self._transport diff --git a/paramiko/config.py b/paramiko/config.py index 1705de76..05f59813 100644 --- a/paramiko/config.py +++ b/paramiko/config.py @@ -18,7 +18,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{SSHConfig}. +:class:`SSHConfig`. """ import fnmatch @@ -87,12 +87,12 @@ class LazyFqdn(object): class SSHConfig (object): """ Representation of config information as stored in the format used by - OpenSSH. Queries can be made via L{lookup}. The format is described in - OpenSSH's C{ssh_config} man page. This class is provided primarily as a + OpenSSH. Queries can be made via :class:`lookup`. The format is described in + OpenSSH's ``ssh_config`` man page. This class is provided primarily as a convenience to posix users (since the OpenSSH format is a de-facto standard on posix) but should work fine on Windows too. - @since: 1.6 + .. versionadded:: 1.6 """ def __init__(self): @@ -105,8 +105,8 @@ class SSHConfig (object): """ Read an OpenSSH config from the given file object. - @param file_obj: a file-like object to read the config file from - @type file_obj: file + :param file_obj: a file-like object to read the config file from + :type file_obj: file """ host = {"host": ['*'], "config": {}} for line in file_obj: @@ -152,20 +152,20 @@ class SSHConfig (object): """ Return a dict of config options for a given hostname. - The host-matching rules of OpenSSH's C{ssh_config} man page are used, + The host-matching rules of OpenSSH's ``ssh_config`` man page are used, which means that all configuration options from matching host specifications are merged, with more specific hostmasks taking - precedence. In other words, if C{"Port"} is set under C{"Host *"} - and also C{"Host *.example.com"}, and the lookup is for - C{"ssh.example.com"}, then the port entry for C{"Host *.example.com"} + precedence. In other words, if ``"Port"`` is set under ``"Host *"`` + and also ``"Host *.example.com"``, and the lookup is for + ``"ssh.example.com"``, then the port entry for ``"Host *.example.com"`` will win out. The keys in the returned dict are all normalized to lowercase (look for - C{"port"}, not C{"Port"}. The values are processed according to the - rules for substitution variable expansion in C{ssh_config}. + ``"port"``, not ``"Port"``. The values are processed according to the + rules for substitution variable expansion in ``ssh_config``. - @param hostname: the hostname to lookup - @type hostname: str + :param hostname: the hostname to lookup + :type hostname: str """ matches = [config for config in self._config if @@ -199,13 +199,13 @@ class SSHConfig (object): Return a dict of config options with expanded substitutions for a given hostname. - Please refer to man C{ssh_config} for the parameters that + Please refer to man ``ssh_config`` for the parameters that are replaced. - @param config: the config for the hostname - @type hostname: dict - @param hostname: the hostname that the config belongs to - @type hostname: str + :param config: the config for the hostname + :type hostname: dict + :param hostname: the hostname that the config belongs to + :type hostname: str """ if 'hostname' in config: diff --git a/paramiko/dsskey.py b/paramiko/dsskey.py index f6ecb2a7..2d9f6cef 100644 --- a/paramiko/dsskey.py +++ b/paramiko/dsskey.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{DSSKey} +:class:`DSSKey` """ from Crypto.PublicKey import DSA @@ -153,13 +153,13 @@ class DSSKey (PKey): Generate a new private DSS key. This factory function can be used to generate a new host key or authentication key. - @param bits: number of bits the generated key should be. - @type bits: int - @param progress_func: an optional function to call at key points in - key generation (used by C{pyCrypto.PublicKey}). - @type progress_func: function - @return: new private key - @rtype: L{DSSKey} + :param bits: number of bits the generated key should be. + :type bits: int + :param progress_func: an optional function to call at key points in + key generation (used by ``pyCrypto.PublicKey``). + :type progress_func: function + :return: new private key + :rtype: :class:`DSSKey` """ dsa = DSA.generate(bits, rng.read, progress_func) key = DSSKey(vals=(dsa.p, dsa.q, dsa.g, dsa.y)) diff --git a/paramiko/file.py b/paramiko/file.py index 5fd81cfe..58d9f8bb 100644 --- a/paramiko/file.py +++ b/paramiko/file.py @@ -67,10 +67,10 @@ class BufferedFile (object): file. This iterator happens to return the file itself, since a file is its own iterator. - @raise ValueError: if the file is closed. + :raises ValueError: if the file is closed. - @return: an interator. - @rtype: iterator + :return: an interator. + :rtype: iterator """ if self._closed: raise ValueError('I/O operation on closed file') @@ -94,14 +94,14 @@ class BufferedFile (object): def next(self): """ - Returns the next line from the input, or raises L{StopIteration} when + Returns the next line from the input, or raises :class:`StopIteration` when EOF is hit. Unlike python file objects, it's okay to mix calls to - C{next} and L{readline}. + ``next`` and :class:`readline`. - @raise StopIteration: when the end of the file is reached. + :raises StopIteration: when the end of the file is reached. - @return: a line read from the file. - @rtype: str + :return: a line read from the file. + :rtype: str """ line = self.readline() if not line: @@ -110,15 +110,15 @@ class BufferedFile (object): def read(self, size=None): """ - Read at most C{size} bytes from the file (less if we hit the end of the - file first). If the C{size} argument is negative or omitted, read all + Read at most ``size`` bytes from the file (less if we hit the end of the + file first). If the ``size`` argument is negative or omitted, read all the remaining data in the file. - @param size: maximum number of bytes to read - @type size: int - @return: data read from the file, or an empty string if EOF was + :param size: maximum number of bytes to read + :type size: int + :return: data read from the file, or an empty string if EOF was encountered immediately - @rtype: str + :rtype: str """ if self._closed: raise IOError('File is closed') @@ -171,14 +171,14 @@ class BufferedFile (object): incomplete line may be returned. An empty string is returned only when EOF is encountered immediately. - @note: Unlike stdio's C{fgets()}, the returned string contains null - characters (C{'\\0'}) if they occurred in the input. + .. note:: Unlike stdio's ``fgets()``, the returned string contains null + characters (``'\\0'``) if they occurred in the input. - @param size: maximum length of returned string. - @type size: int - @return: next line of the file, or an empty string if the end of the + :param size: maximum length of returned string. + :type size: int + :return: next line of the file, or an empty string if the end of the file has been reached. - @rtype: str + :rtype: str """ # it's almost silly how complex this function is. if self._closed: @@ -243,15 +243,15 @@ class BufferedFile (object): def readlines(self, sizehint=None): """ - Read all remaining lines using L{readline} and return them as a list. - If the optional C{sizehint} argument is present, instead of reading up + Read all remaining lines using :class:`readline` and return them as a list. + If the optional ``sizehint`` argument is present, instead of reading up to EOF, whole lines totalling approximately sizehint bytes (possibly after rounding up to an internal buffer size) are read. - @param sizehint: desired maximum number of bytes to read. - @type sizehint: int - @return: list of lines read from the file. - @rtype: list + :param sizehint: desired maximum number of bytes to read. + :type sizehint: int + :return: list of lines read from the file. + :rtype: list """ lines = [] bytes = 0 @@ -267,21 +267,21 @@ class BufferedFile (object): def seek(self, offset, whence=0): """ - Set the file's current position, like stdio's C{fseek}. Not all file + Set the file's current position, like stdio's ``fseek``. Not all file objects support seeking. - @note: If a file is opened in append mode (C{'a'} or C{'a+'}), any seek + .. note:: If a file is opened in append mode (``'a'`` or ``'a+'``), any seek operations will be undone at the next write (as the file position will move back to the end of the file). - @param offset: position to move to within the file, relative to - C{whence}. - @type offset: int - @param whence: type of movement: 0 = absolute; 1 = relative to the + :param offset: position to move to within the file, relative to + ``whence``. + :type offset: int + :param whence: type of movement: 0 = absolute; 1 = relative to the current position; 2 = relative to the end of the file. - @type whence: int + :type whence: int - @raise IOError: if the file doesn't support random access. + :raises IOError: if the file doesn't support random access. """ raise IOError('File does not support seeking.') @@ -291,20 +291,20 @@ class BufferedFile (object): useful if the underlying file doesn't support random access, or was opened in append mode. - @return: file position (in bytes). - @rtype: int + :return: file position (in bytes). + :rtype: int """ return self._pos def write(self, data): """ - Write data to the file. If write buffering is on (C{bufsize} was + Write data to the file. If write buffering is on (``bufsize`` was specified and non-zero), some or all of the data may not actually be - written yet. (Use L{flush} or L{close} to force buffered data to be + written yet. (Use :class:`flush` or :class:`close` to force buffered data to be written out.) - @param data: data to write. - @type data: str + :param data: data to write. + :type data: str """ if self._closed: raise IOError('File is closed') @@ -334,11 +334,11 @@ class BufferedFile (object): """ Write a sequence of strings to the file. The sequence can be any iterable object producing strings, typically a list of strings. (The - name is intended to match L{readlines}; C{writelines} does not add line + name is intended to match :class:`readlines`; ``writelines`` does not add line separators.) - @param sequence: an iterable sequence of strings. - @type sequence: sequence + :param sequence: an iterable sequence of strings. + :type sequence: sequence """ for line in sequence: self.write(line) @@ -346,11 +346,11 @@ class BufferedFile (object): def xreadlines(self): """ - Identical to C{iter(f)}. This is a deprecated file interface that + Identical to ``iter(f)``. This is a deprecated file interface that predates python iterator support. - @return: an iterator. - @rtype: iterator + :return: an iterator. + :rtype: iterator """ return self @@ -364,25 +364,25 @@ class BufferedFile (object): def _read(self, size): """ - I{(subclass override)} - Read data from the stream. Return C{None} or raise C{EOFError} to + (subclass override) + Read data from the stream. Return ``None`` or raise ``EOFError`` to indicate EOF. """ raise EOFError() def _write(self, data): """ - I{(subclass override)} + (subclass override) Write data into the stream. """ raise IOError('write not implemented') def _get_size(self): """ - I{(subclass override)} - Return the size of the file. This is called from within L{_set_mode} + (subclass override) + Return the size of the file. This is called from within :class:`_set_mode` if the file is opened in append mode, so the file position can be - tracked and L{seek} and L{tell} will work correctly. If the file is + tracked and :class:`seek` and :class:`tell` will work correctly. If the file is a stream that can't be randomly accessed, you don't need to override this method, """ diff --git a/paramiko/hostkeys.py b/paramiko/hostkeys.py index c34b1738..2767fb4c 100644 --- a/paramiko/hostkeys.py +++ b/paramiko/hostkeys.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{HostKeys} +:class:`HostKeys` """ import base64 @@ -59,8 +59,8 @@ class HostKeyEntry: We don't bother to check for comments or empty lines. All of that should be taken care of before sending the line to us. - @param line: a line from an OpenSSH known_hosts file - @type line: str + :param line: a line from an OpenSSH known_hosts file + :type line: str """ log = get_logger('paramiko.hostkeys') fields = line.split(' ') @@ -112,9 +112,9 @@ class HostKeys (UserDict.DictMixin): verify server keys during SSH negotiation. A HostKeys object can be treated like a dict; any dict lookup is equivalent - to calling L{lookup}. + to calling :class:`lookup`. - @since: 1.5.3 + .. versionadded:: 1.5.3 """ def __init__(self, filename=None): @@ -122,8 +122,8 @@ class HostKeys (UserDict.DictMixin): Create a new HostKeys object, optionally loading keys from an openssh style host-key file. - @param filename: filename to load host keys from, or C{None} - @type filename: str + :param filename: filename to load host keys from, or ``None`` + :type filename: str """ # emulate a dict of { hostname: { keytype: PKey } } self._entries = [] @@ -133,14 +133,14 @@ class HostKeys (UserDict.DictMixin): def add(self, hostname, keytype, key): """ Add a host key entry to the table. Any existing entry for a - C{(hostname, keytype)} pair will be replaced. - - @param hostname: the hostname (or IP) to add - @type hostname: str - @param keytype: key type (C{"ssh-rsa"} or C{"ssh-dss"}) - @type keytype: str - @param key: the key to add - @type key: L{PKey} + ``(hostname, keytype)`` pair will be replaced. + + :param hostname: the hostname (or IP) to add + :type hostname: str + :param keytype: key type (``"ssh-rsa"`` or ``"ssh-dss"``) + :type keytype: str + :param key: the key to add + :type key: :class:`PKey` """ for e in self._entries: if (hostname in e.hostnames) and (e.key.get_name() == keytype): @@ -153,16 +153,16 @@ class HostKeys (UserDict.DictMixin): Read a file of known SSH host keys, in the format used by openssh. This type of file unfortunately doesn't exist on Windows, but on posix, it will usually be stored in - C{os.path.expanduser("~/.ssh/known_hosts")}. + ``os.path.expanduser("~/.ssh/known_hosts")``. If this method is called multiple times, the host keys are merged, - not cleared. So multiple calls to C{load} will just call L{add}, + not cleared. So multiple calls to ``load`` will just call :class:`add`, replacing any existing entries and adding new ones. - @param filename: name of the file to read host keys from - @type filename: str + :param filename: name of the file to read host keys from + :type filename: str - @raise IOError: if there was an error reading the file + :raises IOError: if there was an error reading the file """ f = open(filename, 'r') for lineno, line in enumerate(f): @@ -186,12 +186,12 @@ class HostKeys (UserDict.DictMixin): loaded from a file originally). The single exception is that combined lines will be split into individual key lines, which is arguably a bug. - @param filename: name of the file to write - @type filename: str + :param filename: name of the file to write + :type filename: str - @raise IOError: if there was an error writing the file + :raises IOError: if there was an error writing the file - @since: 1.6.1 + .. versionadded:: 1.6.1 """ f = open(filename, 'w') for e in self._entries: @@ -203,13 +203,13 @@ class HostKeys (UserDict.DictMixin): def lookup(self, hostname): """ Find a hostkey entry for a given hostname or IP. If no entry is found, - C{None} is returned. Otherwise a dictionary of keytype to key is - returned. The keytype will be either C{"ssh-rsa"} or C{"ssh-dss"}. + ``None`` is returned. Otherwise a dictionary of keytype to key is + returned. The keytype will be either ``"ssh-rsa"`` or ``"ssh-dss"``. - @param hostname: the hostname (or IP) to lookup - @type hostname: str - @return: keys associated with this host (or C{None}) - @rtype: dict(str, L{PKey}) + :param hostname: the hostname (or IP) to lookup + :type hostname: str + :return: keys associated with this host (or ``None``) + :rtype: dict(str, :class:`PKey`) """ class SubDict (UserDict.DictMixin): def __init__(self, hostname, entries, hostkeys): @@ -254,13 +254,13 @@ class HostKeys (UserDict.DictMixin): Return True if the given key is associated with the given hostname in this dictionary. - @param hostname: hostname (or IP) of the SSH server - @type hostname: str - @param key: the key to check - @type key: L{PKey} - @return: C{True} if the key is associated with the hostname; C{False} + :param hostname: hostname (or IP) of the SSH server + :type hostname: str + :param key: the key to check + :type key: :class:`PKey` + :return: ``True`` if the key is associated with the hostname; ``False`` if not - @rtype: bool + :rtype: bool """ k = self.lookup(hostname) if k is None: @@ -317,12 +317,12 @@ class HostKeys (UserDict.DictMixin): Return a "hashed" form of the hostname, as used by openssh when storing hashed hostnames in the known_hosts file. - @param hostname: the hostname to hash - @type hostname: str - @param salt: optional salt to use when hashing (must be 20 bytes long) - @type salt: str - @return: the hashed hostname - @rtype: str + :param hostname: the hostname to hash + :type hostname: str + :param salt: optional salt to use when hashing (must be 20 bytes long) + :type salt: str + :return: the hashed hostname + :rtype: str """ if salt is None: salt = rng.read(SHA.digest_size) diff --git a/paramiko/kex_gex.py b/paramiko/kex_gex.py index c0455a1f..c0b24453 100644 --- a/paramiko/kex_gex.py +++ b/paramiko/kex_gex.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -Variant on L{KexGroup1 <paramiko.kex_group1.KexGroup1>} where the prime "p" and +Variant on :class:`KexGroup1 <paramiko.kex_group1.KexGroup1>` where the prime "p" and generator "g" are provided by the server. A bit more work is required on the client side, and a B{lot} more on the server side. """ diff --git a/paramiko/message.py b/paramiko/message.py index c0e8692b..85fb3c09 100644 --- a/paramiko/message.py +++ b/paramiko/message.py @@ -28,9 +28,9 @@ from paramiko import util class Message (object): """ - An SSH2 I{Message} is a stream of bytes that encodes some combination of + An SSH2 Message is a stream of bytes that encodes some combination of strings, integers, bools, and infinite-precision integers (known in python - as I{long}s). This class builds or breaks down such a byte stream. + as longs). This class builds or breaks down such a byte stream. Normally you don't need to deal with anything this low-level, but it's exposed for people implementing custom extensions, or features that @@ -41,9 +41,9 @@ class Message (object): """ Create a new SSH2 Message. - @param content: the byte stream to use as the Message content (passed + :param content: the byte stream to use as the Message content (passed in only when decomposing a Message). - @type content: string + :type content: string """ if content != None: self.packet = cStringIO.StringIO(content) @@ -54,8 +54,8 @@ class Message (object): """ Return the byte stream content of this Message, as a string. - @return: the contents of this Message. - @rtype: string + :return: the contents of this Message. + :rtype: string """ return self.packet.getvalue() @@ -63,7 +63,7 @@ class Message (object): """ Returns a string representation of this object, for debugging. - @rtype: string + :rtype: string """ return 'paramiko.Message(' + repr(self.packet.getvalue()) + ')' @@ -79,8 +79,8 @@ class Message (object): Return the bytes of this Message that haven't already been parsed and returned. - @return: a string of the bytes not parsed yet. - @rtype: string + :return: a string of the bytes not parsed yet. + :rtype: string """ position = self.packet.tell() remainder = self.packet.read() @@ -91,10 +91,10 @@ class Message (object): """ Returns the bytes of this Message that have been parsed and returned. The string passed into a Message's constructor can be regenerated by - concatenating C{get_so_far} and L{get_remainder}. + concatenating ``get_so_far`` and :class:`get_remainder`. - @return: a string of the bytes parsed so far. - @rtype: string + :return: a string of the bytes parsed so far. + :rtype: string """ position = self.packet.tell() self.rewind() @@ -102,12 +102,12 @@ class Message (object): def get_bytes(self, n): """ - Return the next C{n} bytes of the Message, without decomposing into + Return the next ``n`` bytes of the Message, without decomposing into an int, string, etc. Just the raw bytes are returned. - @return: a string of the next C{n} bytes of the Message, or a string - of C{n} zero bytes, if there aren't C{n} bytes remaining. - @rtype: string + :return: a string of the next ``n`` bytes of the Message, or a string + of ``n`` zero bytes, if there aren't ``n`` bytes remaining. + :rtype: string """ b = self.packet.read(n) max_pad_size = 1<<20 # Limit padding to 1 MB @@ -118,11 +118,11 @@ class Message (object): def get_byte(self): """ Return the next byte of the Message, without decomposing it. This - is equivalent to L{get_bytes(1)<get_bytes>}. + is equivalent to :class:`get_bytes(1)<get_bytes>`. - @return: the next byte of the Message, or C{'\000'} if there aren't + :return: the next byte of the Message, or ``'\000'`` if there aren't any bytes remaining. - @rtype: string + :rtype: string """ return self.get_bytes(1) @@ -130,8 +130,8 @@ class Message (object): """ Fetch a boolean from the stream. - @return: C{True} or C{False} (from the Message). - @rtype: bool + :return: ``True`` or ``False`` (from the Message). + :rtype: bool """ b = self.get_bytes(1) return b != '\x00' @@ -140,8 +140,8 @@ class Message (object): """ Fetch an int from the stream. - @return: a 32-bit unsigned integer. - @rtype: int + :return: a 32-bit unsigned integer. + :rtype: int """ return struct.unpack('>I', self.get_bytes(4))[0] @@ -149,8 +149,8 @@ class Message (object): """ Fetch a 64-bit int from the stream. - @return: a 64-bit unsigned integer. - @rtype: long + :return: a 64-bit unsigned integer. + :rtype: long """ return struct.unpack('>Q', self.get_bytes(8))[0] @@ -158,8 +158,8 @@ class Message (object): """ Fetch a long int (mpint) from the stream. - @return: an arbitrary-length integer. - @rtype: long + :return: an arbitrary-length integer. + :rtype: long """ return util.inflate_long(self.get_string()) @@ -169,8 +169,8 @@ class Message (object): contain unprintable characters. (It's not unheard of for a string to contain another byte-stream Message.) - @return: a string. - @rtype: string + :return: a string. + :rtype: string """ return self.get_bytes(self.get_int()) @@ -179,8 +179,8 @@ class Message (object): Fetch a list of strings from the stream. These are trivially encoded as comma-separated values in a string. - @return: a list of strings. - @rtype: list of strings + :return: a list of strings. + :rtype: list of strings """ return self.get_string().split(',') @@ -188,8 +188,8 @@ class Message (object): """ Write bytes to the stream, without any formatting. - @param b: bytes to add - @type b: str + :param b: bytes to add + :type b: str """ self.packet.write(b) return self @@ -198,8 +198,8 @@ class Message (object): """ Write a single byte to the stream, without any formatting. - @param b: byte to add - @type b: str + :param b: byte to add + :type b: str """ self.packet.write(b) return self @@ -208,8 +208,8 @@ class Message (object): """ Add a boolean value to the stream. - @param b: boolean value to add - @type b: bool + :param b: boolean value to add + :type b: bool """ if b: self.add_byte('\x01') @@ -221,8 +221,8 @@ class Message (object): """ Add an integer to the stream. - @param n: integer to add - @type n: int + :param n: integer to add + :type n: int """ self.packet.write(struct.pack('>I', n)) return self @@ -231,8 +231,8 @@ class Message (object): """ Add a 64-bit int to the stream. - @param n: long int to add - @type n: long + :param n: long int to add + :type n: long """ self.packet.write(struct.pack('>Q', n)) return self @@ -242,8 +242,8 @@ class Message (object): Add a long int to the stream, encoded as an infinite-precision integer. This method only works on positive numbers. - @param z: long int to add - @type z: long + :param z: long int to add + :type z: long """ self.add_string(util.deflate_long(z)) return self @@ -252,8 +252,8 @@ class Message (object): """ Add a string to the stream. - @param s: string to add - @type s: str + :param s: string to add + :type s: str """ self.add_int(len(s)) self.packet.write(s) @@ -265,8 +265,8 @@ class Message (object): a single string of values separated by commas. (Yes, really, that's how SSH2 does it.) - @param l: list of strings to add - @type l: list(str) + :param l: list of strings to add + :type l: list(str) """ self.add_string(','.join(l)) return self @@ -293,8 +293,8 @@ class Message (object): Add a sequence of items to the stream. The values are encoded based on their type: str, int, bool, list, or long. - @param seq: the sequence of items - @type seq: sequence + :param seq: the sequence of items + :type seq: sequence @bug: longs are encoded non-deterministically. Don't use this method. """ diff --git a/paramiko/packet.py b/paramiko/packet.py index dce4383a..aab19e06 100644 --- a/paramiko/packet.py +++ b/paramiko/packet.py @@ -168,17 +168,17 @@ class Packetizer (object): def need_rekey(self): """ - Returns C{True} if a new set of keys needs to be negotiated. This + Returns ``True`` if a new set of keys needs to be negotiated. This will be triggered during a packet read or write, so it should be checked after every read or write, or at least after every few. - @return: C{True} if a new set of keys needs to be negotiated + :return: ``True`` if a new set of keys needs to be negotiated """ return self.__need_rekey def set_keepalive(self, interval, callback): """ - Turn on/off the callback keepalive. If C{interval} seconds pass with + Turn on/off the callback keepalive. If ``interval`` seconds pass with no data read from or written to the socket, the callback will be executed and the timer will be reset. """ @@ -190,11 +190,11 @@ class Packetizer (object): """ Read as close to N bytes as possible, blocking as long as necessary. - @param n: number of bytes to read - @type n: int - @return: the data read - @rtype: str - @raise EOFError: if the socket was closed before all the bytes could + :param n: number of bytes to read + :type n: int + :return: the data read + :rtype: str + :raises EOFError: if the socket was closed before all the bytes could be read """ out = '' @@ -332,8 +332,8 @@ class Packetizer (object): Only one thread should ever be in this function (no other locking is done). - @raise SSHException: if the packet is mangled - @raise NeedRekeyException: if the transport should rekey + :raises SSHException: if the packet is mangled + :raises NeedRekeyException: if the transport should rekey """ header = self.read_all(self.__block_size_in, check_rekey=True) if self.__block_engine_in != None: diff --git a/paramiko/pkey.py b/paramiko/pkey.py index b1199df8..bfe7b116 100644 --- a/paramiko/pkey.py +++ b/paramiko/pkey.py @@ -47,30 +47,30 @@ class PKey (object): def __init__(self, msg=None, data=None): """ - Create a new instance of this public key type. If C{msg} is given, + Create a new instance of this public key type. If ``msg`` is given, the key's public part(s) will be filled in from the message. If - C{data} is given, the key's public part(s) will be filled in from + ``data`` is given, the key's public part(s) will be filled in from the string. - @param msg: an optional SSH L{Message} containing a public key of this + :param msg: an optional SSH :class:`Message` containing a public key of this type. - @type msg: L{Message} - @param data: an optional string containing a public key of this type - @type data: str + :type msg: :class:`Message` + :param data: an optional string containing a public key of this type + :type data: str - @raise SSHException: if a key cannot be created from the C{data} or - C{msg} given, or no key was passed in. + :raises SSHException: if a key cannot be created from the ``data`` or + ``msg`` given, or no key was passed in. """ pass def __str__(self): """ - Return a string of an SSH L{Message} made up of the public part(s) of - this key. This string is suitable for passing to L{__init__} to + Return a string of an SSH :class:`Message` made up of the public part(s) of + this key. This string is suitable for passing to :class:`__init__` to re-create the key object later. - @return: string representation of an SSH key message. - @rtype: str + :return: string representation of an SSH key message. + :rtype: str """ return '' @@ -81,10 +81,10 @@ class PKey (object): of the key are compared, so a public key will compare equal to its corresponding private key. - @param other: key to compare to. - @type other: L{PKey} - @return: 0 if the two keys are equivalent, non-0 otherwise. - @rtype: int + :param other: key to compare to. + :type other: :class:`PKey` + :return: 0 if the two keys are equivalent, non-0 otherwise. + :rtype: int """ hs = hash(self) ho = hash(other) @@ -96,9 +96,9 @@ class PKey (object): """ Return the name of this private key implementation. - @return: name of this private key type, in SSH terminology (for - example, C{"ssh-rsa"}). - @rtype: str + :return: name of this private key type, in SSH terminology (for + example, ``"ssh-rsa"``). + :rtype: str """ return '' @@ -107,18 +107,18 @@ class PKey (object): Return the number of significant bits in this key. This is useful for judging the relative security of a key. - @return: bits in the key. - @rtype: int + :return: bits in the key. + :rtype: int """ return 0 def can_sign(self): """ - Return C{True} if this key has the private part necessary for signing + Return ``True`` if this key has the private part necessary for signing data. - @return: C{True} if this is a private key. - @rtype: bool + :return: ``True`` if this is a private key. + :rtype: bool """ return False @@ -127,9 +127,9 @@ class PKey (object): Return an MD5 fingerprint of the public part of this key. Nothing secret is revealed. - @return: a 16-byte string (binary) of the MD5 fingerprint, in SSH + :return: a 16-byte string (binary) of the MD5 fingerprint, in SSH format. - @rtype: str + :rtype: str """ return MD5.new(str(self)).digest() @@ -139,22 +139,22 @@ class PKey (object): secret is revealed. This format is compatible with that used to store public key files or recognized host keys. - @return: a base64 string containing the public part of the key. - @rtype: str + :return: a base64 string containing the public part of the key. + :rtype: str """ return base64.encodestring(str(self)).replace('\n', '') def sign_ssh_data(self, rng, data): """ - Sign a blob of data with this private key, and return a L{Message} + Sign a blob of data with this private key, and return a :class:`Message` representing an SSH signature message. - @param rng: a secure random number generator. - @type rng: L{Crypto.Util.rng.RandomPool} - @param data: the data to sign. - @type data: str - @return: an SSH signature message. - @rtype: L{Message} + :param rng: a secure random number generator. + :type rng: :class:`Crypto.Util.rng.RandomPool` + :param data: the data to sign. + :type data: str + :return: an SSH signature message. + :rtype: :class:`Message` """ return '' @@ -163,37 +163,37 @@ class PKey (object): Given a blob of data, and an SSH message representing a signature of that data, verify that it was signed with this key. - @param data: the data that was signed. - @type data: str - @param msg: an SSH signature message - @type msg: L{Message} - @return: C{True} if the signature verifies correctly; C{False} + :param data: the data that was signed. + :type data: str + :param msg: an SSH signature message + :type msg: :class:`Message` + :return: ``True`` if the signature verifies correctly; ``False`` otherwise. - @rtype: boolean + :rtype: boolean """ return False def from_private_key_file(cls, filename, password=None): """ Create a key object by reading a private key file. If the private - key is encrypted and C{password} is not C{None}, the given password - will be used to decrypt the key (otherwise L{PasswordRequiredException} + key is encrypted and ``password`` is not ``None``, the given password + will be used to decrypt the key (otherwise :class:`PasswordRequiredException` is thrown). Through the magic of python, this factory method will - exist in all subclasses of PKey (such as L{RSAKey} or L{DSSKey}), but + exist in all subclasses of PKey (such as :class:`RSAKey` or :class:`DSSKey`), but is useless on the abstract PKey class. - @param filename: name of the file to read - @type filename: str - @param password: an optional password to use to decrypt the key file, + :param filename: name of the file to read + :type filename: str + :param password: an optional password to use to decrypt the key file, if it's encrypted - @type password: str - @return: a new key object based on the given private key - @rtype: L{PKey} + :type password: str + :return: a new key object based on the given private key + :rtype: :class:`PKey` - @raise IOError: if there was an error reading the file - @raise PasswordRequiredException: if the private key file is - encrypted, and C{password} is C{None} - @raise SSHException: if the key file is invalid + :raises IOError: if there was an error reading the file + :raises PasswordRequiredException: if the private key file is + encrypted, and ``password`` is ``None`` + :raises SSHException: if the key file is invalid """ key = cls(filename=filename, password=password) return key @@ -202,22 +202,22 @@ class PKey (object): def from_private_key(cls, file_obj, password=None): """ Create a key object by reading a private key from a file (or file-like) - object. If the private key is encrypted and C{password} is not C{None}, + object. If the private key is encrypted and ``password`` is not ``None``, the given password will be used to decrypt the key (otherwise - L{PasswordRequiredException} is thrown). + :class:`PasswordRequiredException` is thrown). - @param file_obj: the file to read from - @type file_obj: file - @param password: an optional password to use to decrypt the key, if it's + :param file_obj: the file to read from + :type file_obj: file + :param password: an optional password to use to decrypt the key, if it's encrypted - @type password: str - @return: a new key object based on the given private key - @rtype: L{PKey} + :type password: str + :return: a new key object based on the given private key + :rtype: :class:`PKey` - @raise IOError: if there was an error reading the key - @raise PasswordRequiredException: if the private key file is encrypted, - and C{password} is C{None} - @raise SSHException: if the key file is invalid + :raises IOError: if there was an error reading the key + :raises PasswordRequiredException: if the private key file is encrypted, + and ``password`` is ``None`` + :raises SSHException: if the key file is invalid """ key = cls(file_obj=file_obj, password=password) return key @@ -226,55 +226,55 @@ class PKey (object): def write_private_key_file(self, filename, password=None): """ Write private key contents into a file. If the password is not - C{None}, the key is encrypted before writing. + ``None``, the key is encrypted before writing. - @param filename: name of the file to write - @type filename: str - @param password: an optional password to use to encrypt the key file - @type password: str + :param filename: name of the file to write + :type filename: str + :param password: an optional password to use to encrypt the key file + :type password: str - @raise IOError: if there was an error writing the file - @raise SSHException: if the key is invalid + :raises IOError: if there was an error writing the file + :raises SSHException: if the key is invalid """ raise Exception('Not implemented in PKey') def write_private_key(self, file_obj, password=None): """ Write private key contents into a file (or file-like) object. If the - password is not C{None}, the key is encrypted before writing. + password is not ``None``, the key is encrypted before writing. - @param file_obj: the file object to write into - @type file_obj: file - @param password: an optional password to use to encrypt the key - @type password: str + :param file_obj: the file object to write into + :type file_obj: file + :param password: an optional password to use to encrypt the key + :type password: str - @raise IOError: if there was an error writing to the file - @raise SSHException: if the key is invalid + :raises IOError: if there was an error writing to the file + :raises SSHException: if the key is invalid """ raise Exception('Not implemented in PKey') def _read_private_key_file(self, tag, filename, password=None): """ Read an SSH2-format private key file, looking for a string of the type - C{"BEGIN xxx PRIVATE KEY"} for some C{xxx}, base64-decode the text we + ``"BEGIN xxx PRIVATE KEY"`` for some ``xxx``, base64-decode the text we find, and return it as a string. If the private key is encrypted and - C{password} is not C{None}, the given password will be used to decrypt - the key (otherwise L{PasswordRequiredException} is thrown). - - @param tag: C{"RSA"} or C{"DSA"}, the tag used to mark the data block. - @type tag: str - @param filename: name of the file to read. - @type filename: str - @param password: an optional password to use to decrypt the key file, + ``password`` is not ``None``, the given password will be used to decrypt + the key (otherwise :class:`PasswordRequiredException` is thrown). + + :param tag: ``"RSA"`` or ``"DSA"``, the tag used to mark the data block. + :type tag: str + :param filename: name of the file to read. + :type filename: str + :param password: an optional password to use to decrypt the key file, if it's encrypted. - @type password: str - @return: data blob that makes up the private key. - @rtype: str + :type password: str + :return: data blob that makes up the private key. + :rtype: str - @raise IOError: if there was an error reading the file. - @raise PasswordRequiredException: if the private key file is - encrypted, and C{password} is C{None}. - @raise SSHException: if the key file is invalid. + :raises IOError: if there was an error reading the file. + :raises PasswordRequiredException: if the private key file is + encrypted, and ``password`` is ``None``. + :raises SSHException: if the key file is invalid. """ f = open(filename, 'r') data = self._read_private_key(tag, f, password) @@ -335,16 +335,16 @@ class PKey (object): a trivially-encoded format (base64) which is completely insecure. If a password is given, DES-EDE3-CBC is used. - @param tag: C{"RSA"} or C{"DSA"}, the tag used to mark the data block. - @type tag: str - @param filename: name of the file to write. - @type filename: str - @param data: data blob that makes up the private key. - @type data: str - @param password: an optional password to use to encrypt the file. - @type password: str + :param tag: ``"RSA"`` or ``"DSA"``, the tag used to mark the data block. + :type tag: str + :param filename: name of the file to write. + :type filename: str + :param data: data blob that makes up the private key. + :type data: str + :param password: an optional password to use to encrypt the file. + :type password: str - @raise IOError: if there was an error writing the file. + :raises IOError: if there was an error writing the file. """ f = open(filename, 'w', 0600) # grrr... the mode doesn't always take hold diff --git a/paramiko/primes.py b/paramiko/primes.py index 9419cd6b..86b9953a 100644 --- a/paramiko/primes.py +++ b/paramiko/primes.py @@ -109,7 +109,7 @@ class ModulusPack (object): def read_file(self, filename): """ - @raise IOError: passed from any file operations that fail. + :raises IOError: passed from any file operations that fail. """ self.pack = {} f = open(filename, 'r') diff --git a/paramiko/proxy.py b/paramiko/proxy.py index 218b76e2..08abe9a6 100644 --- a/paramiko/proxy.py +++ b/paramiko/proxy.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{ProxyCommand}. +:class:`ProxyCommand`. """ import os @@ -33,18 +33,18 @@ class ProxyCommand(object): Wraps a subprocess running ProxyCommand-driven programs. This class implements a the socket-like interface needed by the - L{Transport} and L{Packetizer} classes. Using this class instead of a + :class:`Transport` and :class:`Packetizer` classes. Using this class instead of a regular socket makes it possible to talk with a Popen'd command that will proxy traffic between the client and a server hosted in another machine. """ def __init__(self, command_line): """ Create a new CommandProxy instance. The instance created by this - class can be passed as an argument to the L{Transport} class. + class can be passed as an argument to the :class:`Transport` class. - @param command_line: the command that should be executed and + :param command_line: the command that should be executed and used as the proxy. - @type command_line: str + :type command_line: str """ self.cmd = shlsplit(command_line) self.process = Popen(self.cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE) @@ -54,8 +54,8 @@ class ProxyCommand(object): Write the content received from the SSH client to the standard input of the forked command. - @param content: string to be sent to the forked command - @type content: str + :param content: string to be sent to the forked command + :type content: str """ try: self.process.stdin.write(content) @@ -71,11 +71,11 @@ class ProxyCommand(object): """ Read from the standard output of the forked program. - @param size: how many chars should be read - @type size: int + :param size: how many chars should be read + :type size: int - @return: the length of the read content - @rtype: int + :return: the length of the read content + :rtype: int """ try: return os.read(self.process.stdout.fileno(), size) diff --git a/paramiko/resource.py b/paramiko/resource.py index 6ef86d8c..1d1f8da4 100644 --- a/paramiko/resource.py +++ b/paramiko/resource.py @@ -28,13 +28,13 @@ class ResourceManager (object): A registry of objects and resources that should be closed when those objects are deleted. - This is meant to be a safer alternative to python's C{__del__} method, + This is meant to be a safer alternative to python's ``__del__`` method, which can cause reference cycles to never be collected. Objects registered with the ResourceManager can be collected but still free resources when they die. - Resources are registered using L{register}, and when an object is garbage - collected, each registered resource is closed by having its C{close()} + Resources are registered using :class:`register`, and when an object is garbage + collected, each registered resource is closed by having its ``close()`` method called. Multiple resources may be registered per object, but a resource will only be closed once, even if multiple objects register it. (The last object to register it wins.) @@ -47,14 +47,14 @@ class ResourceManager (object): """ Register a resource to be closed with an object is collected. - When the given C{obj} is garbage-collected by the python interpreter, - the C{resource} will be closed by having its C{close()} method called. + When the given ``obj`` is garbage-collected by the python interpreter, + the ``resource`` will be closed by having its ``close()`` method called. Any exceptions are ignored. - @param obj: the object to track - @type obj: object - @param resource: the resource to close when the object is collected - @type resource: object + :param obj: the object to track + :type obj: object + :param resource: the resource to close when the object is collected + :type resource: object """ def callback(ref): try: diff --git a/paramiko/rsakey.py b/paramiko/rsakey.py index c7500f85..46c37d69 100644 --- a/paramiko/rsakey.py +++ b/paramiko/rsakey.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{RSAKey} +:class:`RSAKey` """ from Crypto.PublicKey import RSA @@ -129,13 +129,13 @@ class RSAKey (PKey): Generate a new private RSA key. This factory function can be used to generate a new host key or authentication key. - @param bits: number of bits the generated key should be. - @type bits: int - @param progress_func: an optional function to call at key points in - key generation (used by C{pyCrypto.PublicKey}). - @type progress_func: function - @return: new private key - @rtype: L{RSAKey} + :param bits: number of bits the generated key should be. + :type bits: int + :param progress_func: an optional function to call at key points in + key generation (used by ``pyCrypto.PublicKey``). + :type progress_func: function + :return: new private key + :rtype: :class:`RSAKey` """ rsa = RSA.generate(bits, rng.read, progress_func) key = RSAKey(vals=(rsa.e, rsa.n)) diff --git a/paramiko/server.py b/paramiko/server.py index d737e056..380831ea 100644 --- a/paramiko/server.py +++ b/paramiko/server.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{ServerInterface} is an interface to override for server support. +:class:`ServerInterface` is an interface to override for server support. """ import threading @@ -35,14 +35,14 @@ class InteractiveQuery (object): Create a new interactive query to send to the client. The name and instructions are optional, but are generally displayed to the end user. A list of prompts may be included, or they may be added via - the L{add_prompt} method. + the :class:`add_prompt` method. - @param name: name of this query - @type name: str - @param instructions: user instructions (usually short) about this query - @type instructions: str - @param prompts: one or more authentication prompts - @type prompts: str + :param name: name of this query + :type name: str + :param instructions: user instructions (usually short) about this query + :type instructions: str + :param prompts: one or more authentication prompts + :type prompts: str """ self.name = name self.instructions = instructions @@ -58,11 +58,11 @@ class InteractiveQuery (object): Add a prompt to this query. The prompt should be a (reasonably short) string. Multiple prompts can be added to the same query. - @param prompt: the user prompt - @type prompt: str - @param echo: C{True} (default) if the user's response should be echoed; - C{False} if not (for a password or similar) - @type echo: bool + :param prompt: the user prompt + :type prompt: str + :param echo: ``True`` (default) if the user's response should be echoed; + ``False`` if not (for a password or similar) + :type echo: bool """ self.prompts.append((prompt, echo)) @@ -80,7 +80,7 @@ class ServerInterface (object): def check_channel_request(self, kind, chanid): """ Determine if a channel request of a given type will be granted, and - return C{OPEN_SUCCEEDED} or an error code. This method is + return ``OPEN_SUCCEEDED`` or an error code. This method is called in server mode when the client requests a channel, after authentication is complete. @@ -88,37 +88,37 @@ class ServerInterface (object): useless), you should also override some of the channel request methods below, which are used to determine which services will be allowed on a given channel: - - L{check_channel_pty_request} - - L{check_channel_shell_request} - - L{check_channel_subsystem_request} - - L{check_channel_window_change_request} - - L{check_channel_x11_request} - - L{check_channel_forward_agent_request} - - The C{chanid} parameter is a small number that uniquely identifies the - channel within a L{Transport}. A L{Channel} object is not created - unless this method returns C{OPEN_SUCCEEDED} -- once a - L{Channel} object is created, you can call L{Channel.get_id} to + - :class:`check_channel_pty_request` + - :class:`check_channel_shell_request` + - :class:`check_channel_subsystem_request` + - :class:`check_channel_window_change_request` + - :class:`check_channel_x11_request` + - :class:`check_channel_forward_agent_request` + + The ``chanid`` parameter is a small number that uniquely identifies the + channel within a :class:`Transport`. A :class:`Channel` object is not created + unless this method returns ``OPEN_SUCCEEDED`` -- once a + :class:`Channel` object is created, you can call :class:`Channel.get_id` to retrieve the channel ID. - The return value should either be C{OPEN_SUCCEEDED} (or - C{0}) to allow the channel request, or one of the following error + The return value should either be ``OPEN_SUCCEEDED`` (or + ``0``) to allow the channel request, or one of the following error codes to reject it: - - C{OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED} - - C{OPEN_FAILED_CONNECT_FAILED} - - C{OPEN_FAILED_UNKNOWN_CHANNEL_TYPE} - - C{OPEN_FAILED_RESOURCE_SHORTAGE} + - ``OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED`` + - ``OPEN_FAILED_CONNECT_FAILED`` + - ``OPEN_FAILED_UNKNOWN_CHANNEL_TYPE`` + - ``OPEN_FAILED_RESOURCE_SHORTAGE`` The default implementation always returns - C{OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED}. + ``OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED``. - @param kind: the kind of channel the client would like to open - (usually C{"session"}). - @type kind: str - @param chanid: ID of the channel - @type chanid: int - @return: a success or failure code (listed above) - @rtype: int + :param kind: the kind of channel the client would like to open + (usually ``"session"``). + :type kind: str + :param chanid: ID of the channel + :type chanid: int + :return: a success or failure code (listed above) + :rtype: int """ return OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED @@ -129,15 +129,15 @@ class ServerInterface (object): of authentication methods that might be successful. The "list" is actually a string of comma-separated names of types of - authentication. Possible values are C{"password"}, C{"publickey"}, - and C{"none"}. + authentication. Possible values are ``"password"``, ``"publickey"``, + and ``"none"``. - The default implementation always returns C{"password"}. + The default implementation always returns ``"password"``. - @param username: the username requesting authentication. - @type username: str - @return: a comma-separated list of authentication types - @rtype: str + :param username: the username requesting authentication. + :type username: str + :return: a comma-separated list of authentication types + :rtype: str """ return 'password' @@ -146,17 +146,17 @@ class ServerInterface (object): Determine if a client may open channels with no (further) authentication. - Return L{AUTH_FAILED} if the client must authenticate, or - L{AUTH_SUCCESSFUL} if it's okay for the client to not + Return :class:`AUTH_FAILED` if the client must authenticate, or + :class:`AUTH_SUCCESSFUL` if it's okay for the client to not authenticate. - The default implementation always returns L{AUTH_FAILED}. + The default implementation always returns :class:`AUTH_FAILED`. - @param username: the username of the client. - @type username: str - @return: L{AUTH_FAILED} if the authentication fails; - L{AUTH_SUCCESSFUL} if it succeeds. - @rtype: int + :param username: the username of the client. + :type username: str + :return: :class:`AUTH_FAILED` if the authentication fails; + :class:`AUTH_SUCCESSFUL` if it succeeds. + :rtype: int """ return AUTH_FAILED @@ -165,25 +165,25 @@ class ServerInterface (object): Determine if a given username and password supplied by the client is acceptable for use in authentication. - Return L{AUTH_FAILED} if the password is not accepted, - L{AUTH_SUCCESSFUL} if the password is accepted and completes - the authentication, or L{AUTH_PARTIALLY_SUCCESSFUL} if your + Return :class:`AUTH_FAILED` if the password is not accepted, + :class:`AUTH_SUCCESSFUL` if the password is accepted and completes + the authentication, or :class:`AUTH_PARTIALLY_SUCCESSFUL` if your authentication is stateful, and this key is accepted for authentication, but more authentication is required. (In this latter - case, L{get_allowed_auths} will be called to report to the client what + case, :class:`get_allowed_auths` will be called to report to the client what options it has for continuing the authentication.) - The default implementation always returns L{AUTH_FAILED}. + The default implementation always returns :class:`AUTH_FAILED`. - @param username: the username of the authenticating client. - @type username: str - @param password: the password given by the client. - @type password: str - @return: L{AUTH_FAILED} if the authentication fails; - L{AUTH_SUCCESSFUL} if it succeeds; - L{AUTH_PARTIALLY_SUCCESSFUL} if the password auth is + :param username: the username of the authenticating client. + :type username: str + :param password: the password given by the client. + :type password: str + :return: :class:`AUTH_FAILED` if the authentication fails; + :class:`AUTH_SUCCESSFUL` if it succeeds; + :class:`AUTH_PARTIALLY_SUCCESSFUL` if the password auth is successful, but authentication must continue. - @rtype: int + :rtype: int """ return AUTH_FAILED @@ -194,29 +194,29 @@ class ServerInterface (object): check the username and key and decide if you would accept a signature made using this key. - Return L{AUTH_FAILED} if the key is not accepted, - L{AUTH_SUCCESSFUL} if the key is accepted and completes the - authentication, or L{AUTH_PARTIALLY_SUCCESSFUL} if your + Return :class:`AUTH_FAILED` if the key is not accepted, + :class:`AUTH_SUCCESSFUL` if the key is accepted and completes the + authentication, or :class:`AUTH_PARTIALLY_SUCCESSFUL` if your authentication is stateful, and this password is accepted for authentication, but more authentication is required. (In this latter - case, L{get_allowed_auths} will be called to report to the client what + case, :class:`get_allowed_auths` will be called to report to the client what options it has for continuing the authentication.) Note that you don't have to actually verify any key signtature here. If you're willing to accept the key, paramiko will do the work of verifying the client's signature. - The default implementation always returns L{AUTH_FAILED}. - - @param username: the username of the authenticating client - @type username: str - @param key: the key object provided by the client - @type key: L{PKey <pkey.PKey>} - @return: L{AUTH_FAILED} if the client can't authenticate - with this key; L{AUTH_SUCCESSFUL} if it can; - L{AUTH_PARTIALLY_SUCCESSFUL} if it can authenticate with + The default implementation always returns :class:`AUTH_FAILED`. + + :param username: the username of the authenticating client + :type username: str + :param key: the key object provided by the client + :type key: :class:`PKey <pkey.PKey>` + :return: :class:`AUTH_FAILED` if the client can't authenticate + with this key; :class:`AUTH_SUCCESSFUL` if it can; + :class:`AUTH_PARTIALLY_SUCCESSFUL` if it can authenticate with this key but must continue with authentication - @rtype: int + :rtype: int """ return AUTH_FAILED @@ -224,24 +224,24 @@ class ServerInterface (object): """ Begin an interactive authentication challenge, if supported. You should override this method in server mode if you want to support the - C{"keyboard-interactive"} auth type, which requires you to send a + ``"keyboard-interactive"`` auth type, which requires you to send a series of questions for the client to answer. - Return L{AUTH_FAILED} if this auth method isn't supported. Otherwise, - you should return an L{InteractiveQuery} object containing the prompts + Return :class:`AUTH_FAILED` if this auth method isn't supported. Otherwise, + you should return an :class:`InteractiveQuery` object containing the prompts and instructions for the user. The response will be sent via a call - to L{check_auth_interactive_response}. + to :class:`check_auth_interactive_response`. - The default implementation always returns L{AUTH_FAILED}. + The default implementation always returns :class:`AUTH_FAILED`. - @param username: the username of the authenticating client - @type username: str - @param submethods: a comma-separated list of methods preferred by the + :param username: the username of the authenticating client + :type username: str + :param submethods: a comma-separated list of methods preferred by the client (usually empty) - @type submethods: str - @return: L{AUTH_FAILED} if this auth method isn't supported; otherwise + :type submethods: str + :return: :class:`AUTH_FAILED` if this auth method isn't supported; otherwise an object containing queries for the user - @rtype: int or L{InteractiveQuery} + :rtype: int or :class:`InteractiveQuery` """ return AUTH_FAILED @@ -249,31 +249,31 @@ class ServerInterface (object): """ Continue or finish an interactive authentication challenge, if supported. You should override this method in server mode if you want - to support the C{"keyboard-interactive"} auth type. + to support the ``"keyboard-interactive"`` auth type. - Return L{AUTH_FAILED} if the responses are not accepted, - L{AUTH_SUCCESSFUL} if the responses are accepted and complete - the authentication, or L{AUTH_PARTIALLY_SUCCESSFUL} if your + Return :class:`AUTH_FAILED` if the responses are not accepted, + :class:`AUTH_SUCCESSFUL` if the responses are accepted and complete + the authentication, or :class:`AUTH_PARTIALLY_SUCCESSFUL` if your authentication is stateful, and this set of responses is accepted for authentication, but more authentication is required. (In this latter - case, L{get_allowed_auths} will be called to report to the client what + case, :class:`get_allowed_auths` will be called to report to the client what options it has for continuing the authentication.) If you wish to continue interactive authentication with more questions, - you may return an L{InteractiveQuery} object, which should cause the + you may return an :class:`InteractiveQuery` object, which should cause the client to respond with more answers, calling this method again. This cycle can continue indefinitely. - The default implementation always returns L{AUTH_FAILED}. + The default implementation always returns :class:`AUTH_FAILED`. - @param responses: list of responses from the client - @type responses: list(str) - @return: L{AUTH_FAILED} if the authentication fails; - L{AUTH_SUCCESSFUL} if it succeeds; - L{AUTH_PARTIALLY_SUCCESSFUL} if the interactive auth is + :param responses: list of responses from the client + :type responses: list(str) + :return: :class:`AUTH_FAILED` if the authentication fails; + :class:`AUTH_SUCCESSFUL` if it succeeds; + :class:`AUTH_PARTIALLY_SUCCESSFUL` if the interactive auth is successful, but authentication must continue; otherwise an object containing queries for the user - @rtype: int or L{InteractiveQuery} + :rtype: int or :class:`InteractiveQuery` """ return AUTH_FAILED @@ -281,22 +281,22 @@ class ServerInterface (object): """ Handle a request for port forwarding. The client is asking that connections to the given address and port be forwarded back across - this ssh connection. An address of C{"0.0.0.0"} indicates a global - address (any address associated with this server) and a port of C{0} + this ssh connection. An address of ``"0.0.0.0"`` indicates a global + address (any address associated with this server) and a port of ``0`` indicates that no specific port is requested (usually the OS will pick a port). - The default implementation always returns C{False}, rejecting the + The default implementation always returns ``False``, rejecting the port forwarding request. If the request is accepted, you should return the port opened for listening. - @param address: the requested address - @type address: str - @param port: the requested port - @type port: int - @return: the port number that was opened for listening, or C{False} to + :param address: the requested address + :type address: str + :param port: the requested port + :type port: int + :return: the port number that was opened for listening, or ``False`` to reject - @rtype: int + :rtype: int """ return False @@ -306,19 +306,19 @@ class ServerInterface (object): If the given address and port is being forwarded across this ssh connection, the port should be closed. - @param address: the forwarded address - @type address: str - @param port: the forwarded port - @type port: int + :param address: the forwarded address + :type address: str + :param port: the forwarded port + :type port: int """ pass def check_global_request(self, kind, msg): """ - Handle a global request of the given C{kind}. This method is called + Handle a global request of the given ``kind``. This method is called in server mode and client mode, whenever the remote host makes a global request. If there are any arguments to the request, they will be in - C{msg}. + ``msg``. There aren't any useful global requests defined, aside from port forwarding, so usually this type of request is an extension to the @@ -329,19 +329,19 @@ class ServerInterface (object): sent back with the successful result. (Note that the items in the tuple can only be strings, ints, longs, or bools.) - The default implementation always returns C{False}, indicating that it + The default implementation always returns ``False``, indicating that it does not support any global requests. - @note: Port forwarding requests are handled separately, in - L{check_port_forward_request}. + .. note:: Port forwarding requests are handled separately, in + :class:`check_port_forward_request`. - @param kind: the kind of global request being made. - @type kind: str - @param msg: any extra arguments to the request. - @type msg: L{Message} - @return: C{True} or a tuple of data if the request was granted; - C{False} otherwise. - @rtype: bool + :param kind: the kind of global request being made. + :type kind: str + :param msg: any extra arguments to the request. + :type msg: :class:`Message` + :return: ``True`` or a tuple of data if the request was granted; + ``False`` otherwise. + :rtype: bool """ return False @@ -355,89 +355,89 @@ class ServerInterface (object): Determine if a pseudo-terminal of the given dimensions (usually requested for shell access) can be provided on the given channel. - The default implementation always returns C{False}. - - @param channel: the L{Channel} the pty request arrived on. - @type channel: L{Channel} - @param term: type of terminal requested (for example, C{"vt100"}). - @type term: str - @param width: width of screen in characters. - @type width: int - @param height: height of screen in characters. - @type height: int - @param pixelwidth: width of screen in pixels, if known (may be C{0} if + The default implementation always returns ``False``. + + :param channel: the :class:`Channel` the pty request arrived on. + :type channel: :class:`Channel` + :param term: type of terminal requested (for example, ``"vt100"``). + :type term: str + :param width: width of screen in characters. + :type width: int + :param height: height of screen in characters. + :type height: int + :param pixelwidth: width of screen in pixels, if known (may be ``0`` if unknown). - @type pixelwidth: int - @param pixelheight: height of screen in pixels, if known (may be C{0} + :type pixelwidth: int + :param pixelheight: height of screen in pixels, if known (may be ``0`` if unknown). - @type pixelheight: int - @return: C{True} if the psuedo-terminal has been allocated; C{False} + :type pixelheight: int + :return: ``True`` if the psuedo-terminal has been allocated; ``False`` otherwise. - @rtype: bool + :rtype: bool """ return False def check_channel_shell_request(self, channel): """ Determine if a shell will be provided to the client on the given - channel. If this method returns C{True}, the channel should be + channel. If this method returns ``True``, the channel should be connected to the stdin/stdout of a shell (or something that acts like a shell). - The default implementation always returns C{False}. + The default implementation always returns ``False``. - @param channel: the L{Channel} the request arrived on. - @type channel: L{Channel} - @return: C{True} if this channel is now hooked up to a shell; C{False} + :param channel: the :class:`Channel` the request arrived on. + :type channel: :class:`Channel` + :return: ``True`` if this channel is now hooked up to a shell; ``False`` if a shell can't or won't be provided. - @rtype: bool + :rtype: bool """ return False def check_channel_exec_request(self, channel, command): """ Determine if a shell command will be executed for the client. If this - method returns C{True}, the channel should be connected to the stdin, + method returns ``True``, the channel should be connected to the stdin, stdout, and stderr of the shell command. - The default implementation always returns C{False}. + The default implementation always returns ``False``. - @param channel: the L{Channel} the request arrived on. - @type channel: L{Channel} - @param command: the command to execute. - @type command: str - @return: C{True} if this channel is now hooked up to the stdin, - stdout, and stderr of the executing command; C{False} if the + :param channel: the :class:`Channel` the request arrived on. + :type channel: :class:`Channel` + :param command: the command to execute. + :type command: str + :return: ``True`` if this channel is now hooked up to the stdin, + stdout, and stderr of the executing command; ``False`` if the command will not be executed. - @rtype: bool + :rtype: bool - @since: 1.1 + .. versionadded:: 1.1 """ return False def check_channel_subsystem_request(self, channel, name): """ Determine if a requested subsystem will be provided to the client on - the given channel. If this method returns C{True}, all future I/O + the given channel. If this method returns ``True``, all future I/O through this channel will be assumed to be connected to the requested - subsystem. An example of a subsystem is C{sftp}. + subsystem. An example of a subsystem is ``sftp``. The default implementation checks for a subsystem handler assigned via - L{Transport.set_subsystem_handler}. + :class:`Transport.set_subsystem_handler`. If one has been set, the handler is invoked and this method returns - C{True}. Otherwise it returns C{False}. + ``True``. Otherwise it returns ``False``. - @note: Because the default implementation uses the L{Transport} to + .. note:: Because the default implementation uses the :class:`Transport` to identify valid subsystems, you probably won't need to override this method. - @param channel: the L{Channel} the pty request arrived on. - @type channel: L{Channel} - @param name: name of the requested subsystem. - @type name: str - @return: C{True} if this channel is now hooked up to the requested - subsystem; C{False} if that subsystem can't or won't be provided. - @rtype: bool + :param channel: the :class:`Channel` the pty request arrived on. + :type channel: :class:`Channel` + :param name: name of the requested subsystem. + :type name: str + :return: ``True`` if this channel is now hooked up to the requested + subsystem; ``False`` if that subsystem can't or won't be provided. + :rtype: bool """ handler_class, larg, kwarg = channel.get_transport()._get_subsystem_handler(name) if handler_class is None: @@ -451,102 +451,102 @@ class ServerInterface (object): Determine if the pseudo-terminal on the given channel can be resized. This only makes sense if a pty was previously allocated on it. - The default implementation always returns C{False}. + The default implementation always returns ``False``. - @param channel: the L{Channel} the pty request arrived on. - @type channel: L{Channel} - @param width: width of screen in characters. - @type width: int - @param height: height of screen in characters. - @type height: int - @param pixelwidth: width of screen in pixels, if known (may be C{0} if + :param channel: the :class:`Channel` the pty request arrived on. + :type channel: :class:`Channel` + :param width: width of screen in characters. + :type width: int + :param height: height of screen in characters. + :type height: int + :param pixelwidth: width of screen in pixels, if known (may be ``0`` if unknown). - @type pixelwidth: int - @param pixelheight: height of screen in pixels, if known (may be C{0} + :type pixelwidth: int + :param pixelheight: height of screen in pixels, if known (may be ``0`` if unknown). - @type pixelheight: int - @return: C{True} if the terminal was resized; C{False} if not. - @rtype: bool + :type pixelheight: int + :return: ``True`` if the terminal was resized; ``False`` if not. + :rtype: bool """ return False def check_channel_x11_request(self, channel, single_connection, auth_protocol, auth_cookie, screen_number): """ Determine if the client will be provided with an X11 session. If this - method returns C{True}, X11 applications should be routed through new - SSH channels, using L{Transport.open_x11_channel}. + method returns ``True``, X11 applications should be routed through new + SSH channels, using :class:`Transport.open_x11_channel`. - The default implementation always returns C{False}. + The default implementation always returns ``False``. - @param channel: the L{Channel} the X11 request arrived on - @type channel: L{Channel} - @param single_connection: C{True} if only a single X11 channel should + :param channel: the :class:`Channel` the X11 request arrived on + :type channel: :class:`Channel` + :param single_connection: ``True`` if only a single X11 channel should be opened - @type single_connection: bool - @param auth_protocol: the protocol used for X11 authentication - @type auth_protocol: str - @param auth_cookie: the cookie used to authenticate to X11 - @type auth_cookie: str - @param screen_number: the number of the X11 screen to connect to - @type screen_number: int - @return: C{True} if the X11 session was opened; C{False} if not - @rtype: bool + :type single_connection: bool + :param auth_protocol: the protocol used for X11 authentication + :type auth_protocol: str + :param auth_cookie: the cookie used to authenticate to X11 + :type auth_cookie: str + :param screen_number: the number of the X11 screen to connect to + :type screen_number: int + :return: ``True`` if the X11 session was opened; ``False`` if not + :rtype: bool """ return False def check_channel_forward_agent_request(self, channel): """ Determine if the client will be provided with an forward agent session. - If this method returns C{True}, the server will allow SSH Agent + If this method returns ``True``, the server will allow SSH Agent forwarding. - The default implementation always returns C{False}. + The default implementation always returns ``False``. - @param channel: the L{Channel} the request arrived on - @type channel: L{Channel} - @return: C{True} if the AgentForward was loaded; C{False} if not - @rtype: bool + :param channel: the :class:`Channel` the request arrived on + :type channel: :class:`Channel` + :return: ``True`` if the AgentForward was loaded; ``False`` if not + :rtype: bool """ return False def check_channel_direct_tcpip_request(self, chanid, origin, destination): """ Determine if a local port forwarding channel will be granted, and - return C{OPEN_SUCCEEDED} or an error code. This method is + return ``OPEN_SUCCEEDED`` or an error code. This method is called in server mode when the client requests a channel, after authentication is complete. - The C{chanid} parameter is a small number that uniquely identifies the - channel within a L{Transport}. A L{Channel} object is not created - unless this method returns C{OPEN_SUCCEEDED} -- once a - L{Channel} object is created, you can call L{Channel.get_id} to + The ``chanid`` parameter is a small number that uniquely identifies the + channel within a :class:`Transport`. A :class:`Channel` object is not created + unless this method returns ``OPEN_SUCCEEDED`` -- once a + :class:`Channel` object is created, you can call :class:`Channel.get_id` to retrieve the channel ID. The origin and destination parameters are (ip_address, port) tuples that correspond to both ends of the TCP connection in the forwarding tunnel. - The return value should either be C{OPEN_SUCCEEDED} (or - C{0}) to allow the channel request, or one of the following error + The return value should either be ``OPEN_SUCCEEDED`` (or + ``0``) to allow the channel request, or one of the following error codes to reject it: - - C{OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED} - - C{OPEN_FAILED_CONNECT_FAILED} - - C{OPEN_FAILED_UNKNOWN_CHANNEL_TYPE} - - C{OPEN_FAILED_RESOURCE_SHORTAGE} + - ``OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED`` + - ``OPEN_FAILED_CONNECT_FAILED`` + - ``OPEN_FAILED_UNKNOWN_CHANNEL_TYPE`` + - ``OPEN_FAILED_RESOURCE_SHORTAGE`` The default implementation always returns - C{OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED}. + ``OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED``. - @param chanid: ID of the channel - @type chanid: int - @param origin: 2-tuple containing the IP address and port of the + :param chanid: ID of the channel + :type chanid: int + :param origin: 2-tuple containing the IP address and port of the originator (client side) - @type origin: tuple - @param destination: 2-tuple containing the IP address and port of the + :type origin: tuple + :param destination: 2-tuple containing the IP address and port of the destination (server side) - @type destination: tuple - @return: a success or failure code (listed above) - @rtype: int + :type destination: tuple + :return: a success or failure code (listed above) + :rtype: int """ return OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED @@ -555,33 +555,33 @@ class SubsystemHandler (threading.Thread): """ Handler for a subsytem in server mode. If you create a subclass of this class and pass it to - L{Transport.set_subsystem_handler}, + :class:`Transport.set_subsystem_handler`, an object of this class will be created for each request for this subsystem. Each new object - will be executed within its own new thread by calling L{start_subsystem}. + will be executed within its own new thread by calling :class:`start_subsystem`. When that method completes, the channel is closed. - For example, if you made a subclass C{MP3Handler} and registered it as the - handler for subsystem C{"mp3"}, then whenever a client has successfully - authenticated and requests subsytem C{"mp3"}, an object of class - C{MP3Handler} will be created, and L{start_subsystem} will be called on + For example, if you made a subclass ``MP3Handler`` and registered it as the + handler for subsystem ``"mp3"``, then whenever a client has successfully + authenticated and requests subsytem ``"mp3"``, an object of class + ``MP3Handler`` will be created, and :class:`start_subsystem` will be called on it from a new thread. """ def __init__(self, channel, name, server): """ - Create a new handler for a channel. This is used by L{ServerInterface} + Create a new handler for a channel. This is used by :class:`ServerInterface` to start up a new handler when a channel requests this subsystem. You don't need to override this method, but if you do, be sure to pass the - C{channel} and C{name} parameters through to the original C{__init__} + ``channel`` and ``name`` parameters through to the original ``__init__`` method here. - @param channel: the channel associated with this subsystem request. - @type channel: L{Channel} - @param name: name of the requested subsystem. - @type name: str - @param server: the server object for the session that started this + :param channel: the channel associated with this subsystem request. + :type channel: :class:`Channel` + :param name: name of the requested subsystem. + :type name: str + :param server: the server object for the session that started this subsystem - @type server: L{ServerInterface} + :type server: :class:`ServerInterface` """ threading.Thread.__init__(self, target=self._run) self.__channel = channel @@ -591,10 +591,10 @@ class SubsystemHandler (threading.Thread): def get_server(self): """ - Return the L{ServerInterface} object associated with this channel and + Return the :class:`ServerInterface` object associated with this channel and subsystem. - @rtype: L{ServerInterface} + :rtype: :class:`ServerInterface` """ return self.__server @@ -619,22 +619,22 @@ class SubsystemHandler (threading.Thread): subsystem is finished, this method will return. After this method returns, the channel is closed. - The combination of C{transport} and C{channel} are unique; this handler - corresponds to exactly one L{Channel} on one L{Transport}. + The combination of ``transport`` and ``channel`` are unique; this handler + corresponds to exactly one :class:`Channel` on one :class:`Transport`. - @note: It is the responsibility of this method to exit if the - underlying L{Transport} is closed. This can be done by checking - L{Transport.is_active} or noticing an EOF - on the L{Channel}. If this method loops forever without checking + .. note:: It is the responsibility of this method to exit if the + underlying :class:`Transport` is closed. This can be done by checking + :class:`Transport.is_active` or noticing an EOF + on the :class:`Channel`. If this method loops forever without checking for this case, your python interpreter may refuse to exit because this thread will still be running. - @param name: name of the requested subsystem. - @type name: str - @param transport: the server-mode L{Transport}. - @type transport: L{Transport} - @param channel: the channel associated with this subsystem request. - @type channel: L{Channel} + :param name: name of the requested subsystem. + :type name: str + :param transport: the server-mode :class:`Transport`. + :type transport: :class:`Transport` + :param channel: the channel associated with this subsystem request. + :type channel: :class:`Channel` """ pass @@ -643,6 +643,6 @@ class SubsystemHandler (threading.Thread): Perform any cleanup at the end of a subsystem. The default implementation just closes the channel. - @since: 1.1 + .. versionadded:: 1.1 """ self.__channel.close() diff --git a/paramiko/sftp_attr.py b/paramiko/sftp_attr.py index b459b04b..267bc3ab 100644 --- a/paramiko/sftp_attr.py +++ b/paramiko/sftp_attr.py @@ -26,8 +26,8 @@ class SFTPAttributes (object): """ Representation of the attributes of a file (or proxied file) for SFTP in client or server mode. It attemps to mirror the object returned by - C{os.stat} as closely as possible, so it may have the following fields, - with the same meanings as those returned by an C{os.stat} object: + ``os.stat`` as closely as possible, so it may have the following fields, + with the same meanings as those returned by an ``os.stat`` object: - st_size - st_uid - st_gid @@ -36,8 +36,8 @@ class SFTPAttributes (object): - st_mtime Because SFTP allows flags to have other arbitrary named attributes, these - are stored in a dict named C{attr}. Occasionally, the filename is also - stored, in C{filename}. + are stored in a dict named ``attr``. Occasionally, the filename is also + stored, in ``filename``. """ FLAG_SIZE = 1 @@ -61,15 +61,15 @@ class SFTPAttributes (object): def from_stat(cls, obj, filename=None): """ - Create an SFTPAttributes object from an existing C{stat} object (an - object returned by C{os.stat}). - - @param obj: an object returned by C{os.stat} (or equivalent). - @type obj: object - @param filename: the filename associated with this file. - @type filename: str - @return: new L{SFTPAttributes} object with the same attribute fields. - @rtype: L{SFTPAttributes} + Create an SFTPAttributes object from an existing ``stat`` object (an + object returned by ``os.stat``). + + :param obj: an object returned by ``os.stat`` (or equivalent). + :type obj: object + :param filename: the filename associated with this file. + :type filename: str + :return: new :class:`SFTPAttributes` object with the same attribute fields. + :rtype: :class:`SFTPAttributes` """ attr = cls() attr.st_size = obj.st_size diff --git a/paramiko/sftp_client.py b/paramiko/sftp_client.py index cf94582c..ef64a9fe 100644 --- a/paramiko/sftp_client.py +++ b/paramiko/sftp_client.py @@ -51,22 +51,22 @@ def _to_unicode(s): class SFTPClient (BaseSFTP): """ - SFTP client object. C{SFTPClient} is used to open an sftp session across - an open ssh L{Transport} and do remote file operations. + SFTP client object. ``SFTPClient`` is used to open an sftp session across + an open ssh :class:`Transport` and do remote file operations. """ def __init__(self, sock): """ - Create an SFTP client from an existing L{Channel}. The channel - should already have requested the C{"sftp"} subsystem. + Create an SFTP client from an existing :class:`Channel`. The channel + should already have requested the ``"sftp"`` subsystem. An alternate way to create an SFTP client context is by using - L{from_transport}. + :class:`from_transport`. - @param sock: an open L{Channel} using the C{"sftp"} subsystem - @type sock: L{Channel} + :param sock: an open :class:`Channel` using the ``"sftp"`` subsystem + :type sock: :class:`Channel` - @raise SSHException: if there's an exception while negotiating + :raises SSHException: if there's an exception while negotiating sftp """ BaseSFTP.__init__(self) @@ -91,13 +91,13 @@ class SFTPClient (BaseSFTP): def from_transport(cls, t): """ - Create an SFTP client channel from an open L{Transport}. + Create an SFTP client channel from an open :class:`Transport`. - @param t: an open L{Transport} which is already authenticated - @type t: L{Transport} - @return: a new L{SFTPClient} object, referring to an sftp session + :param t: an open :class:`Transport` which is already authenticated + :type t: :class:`Transport` + :return: a new :class:`SFTPClient` object, referring to an sftp session (channel) across the transport - @rtype: L{SFTPClient} + :rtype: :class:`SFTPClient` """ chan = t.open_session() if chan is None: @@ -117,56 +117,56 @@ class SFTPClient (BaseSFTP): """ Close the SFTP session and its underlying channel. - @since: 1.4 + .. versionadded:: 1.4 """ self._log(INFO, 'sftp session closed.') self.sock.close() def get_channel(self): """ - Return the underlying L{Channel} object for this SFTP session. This + Return the underlying :class:`Channel` object for this SFTP session. This might be useful for doing things like setting a timeout on the channel. - @return: the SSH channel - @rtype: L{Channel} + :return: the SSH channel + :rtype: :class:`Channel` - @since: 1.7.1 + .. versionadded:: 1.7.1 """ return self.sock def listdir(self, path='.'): """ - Return a list containing the names of the entries in the given C{path}. + Return a list containing the names of the entries in the given ``path``. The list is in arbitrary order. It does not include the special - entries C{'.'} and C{'..'} even if they are present in the folder. - This method is meant to mirror C{os.listdir} as closely as possible. - For a list of full L{SFTPAttributes} objects, see L{listdir_attr}. + entries ``'.'`` and ``'..'`` even if they are present in the folder. + This method is meant to mirror ``os.listdir`` as closely as possible. + For a list of full :class:`SFTPAttributes` objects, see :class:`listdir_attr`. - @param path: path to list (defaults to C{'.'}) - @type path: str - @return: list of filenames - @rtype: list of str + :param path: path to list (defaults to ``'.'``) + :type path: str + :return: list of filenames + :rtype: list of str """ return [f.filename for f in self.listdir_attr(path)] def listdir_attr(self, path='.'): """ - Return a list containing L{SFTPAttributes} objects corresponding to - files in the given C{path}. The list is in arbitrary order. It does - not include the special entries C{'.'} and C{'..'} even if they are + Return a list containing :class:`SFTPAttributes` objects corresponding to + files in the given ``path``. The list is in arbitrary order. It does + not include the special entries ``'.'`` and ``'..'`` even if they are present in the folder. - The returned L{SFTPAttributes} objects will each have an additional - field: C{longname}, which may contain a formatted string of the file's + The returned :class:`SFTPAttributes` objects will each have an additional + field: ``longname``, which may contain a formatted string of the file's attributes, in unix format. The content of this string will probably depend on the SFTP server implementation. - @param path: path to list (defaults to C{'.'}) - @type path: str - @return: list of attributes - @rtype: list of L{SFTPAttributes} + :param path: path to list (defaults to ``'.'``) + :type path: str + :return: list of attributes + :rtype: list of :class:`SFTPAttributes` - @since: 1.2 + .. versionadded:: 1.2 """ path = self._adjust_cwd(path) self._log(DEBUG, 'listdir(%r)' % path) @@ -196,37 +196,37 @@ class SFTPClient (BaseSFTP): def open(self, filename, mode='r', bufsize=-1): """ Open a file on the remote server. The arguments are the same as for - python's built-in C{file} (aka C{open}). A file-like object is + python's built-in ``file`` (aka ``open``). A file-like object is returned, which closely mimics the behavior of a normal python file object, including the ability to be used as a context manager. - The mode indicates how the file is to be opened: C{'r'} for reading, - C{'w'} for writing (truncating an existing file), C{'a'} for appending, - C{'r+'} for reading/writing, C{'w+'} for reading/writing (truncating an - existing file), C{'a+'} for reading/appending. The python C{'b'} flag - is ignored, since SSH treats all files as binary. The C{'U'} flag is + The mode indicates how the file is to be opened: ``'r'`` for reading, + ``'w'`` for writing (truncating an existing file), ``'a'`` for appending, + ``'r+'`` for reading/writing, ``'w+'`` for reading/writing (truncating an + existing file), ``'a+'`` for reading/appending. The python ``'b'`` flag + is ignored, since SSH treats all files as binary. The ``'U'`` flag is supported in a compatible way. - Since 1.5.2, an C{'x'} flag indicates that the operation should only + Since 1.5.2, an ``'x'`` flag indicates that the operation should only succeed if the file was created and did not previously exist. This has no direct mapping to python's file flags, but is commonly known as the - C{O_EXCL} flag in posix. + ``O_EXCL`` flag in posix. The file will be buffered in standard python style by default, but - can be altered with the C{bufsize} parameter. C{0} turns off - buffering, C{1} uses line buffering, and any number greater than 1 - (C{>1}) uses that specific buffer size. + can be altered with the ``bufsize`` parameter. ``0`` turns off + buffering, ``1`` uses line buffering, and any number greater than 1 + (``>1``) uses that specific buffer size. - @param filename: name of the file to open - @type filename: str - @param mode: mode (python-style) to open in - @type mode: str - @param bufsize: desired buffering (-1 = default buffer size) - @type bufsize: int - @return: a file object representing the open file - @rtype: SFTPFile + :param filename: name of the file to open + :type filename: str + :param mode: mode (python-style) to open in + :type mode: str + :param bufsize: desired buffering (-1 = default buffer size) + :type bufsize: int + :return: a file object representing the open file + :rtype: SFTPFile - @raise IOError: if the file could not be opened. + :raises IOError: if the file could not be opened. """ filename = self._adjust_cwd(filename) self._log(DEBUG, 'open(%r, %r)' % (filename, mode)) @@ -255,12 +255,12 @@ class SFTPClient (BaseSFTP): def remove(self, path): """ Remove the file at the given path. This only works on files; for - removing folders (directories), use L{rmdir}. + removing folders (directories), use :class:`rmdir`. - @param path: path (absolute or relative) of the file to remove - @type path: str + :param path: path (absolute or relative) of the file to remove + :type path: str - @raise IOError: if the path refers to a folder (directory) + :raises IOError: if the path refers to a folder (directory) """ path = self._adjust_cwd(path) self._log(DEBUG, 'remove(%r)' % path) @@ -270,14 +270,14 @@ class SFTPClient (BaseSFTP): def rename(self, oldpath, newpath): """ - Rename a file or folder from C{oldpath} to C{newpath}. + Rename a file or folder from ``oldpath`` to ``newpath``. - @param oldpath: existing name of the file or folder - @type oldpath: str - @param newpath: new name for the file or folder - @type newpath: str + :param oldpath: existing name of the file or folder + :type oldpath: str + :param newpath: new name for the file or folder + :type newpath: str - @raise IOError: if C{newpath} is a folder, or something else goes + :raises IOError: if ``newpath`` is a folder, or something else goes wrong """ oldpath = self._adjust_cwd(oldpath) @@ -287,14 +287,14 @@ class SFTPClient (BaseSFTP): def mkdir(self, path, mode=0777): """ - Create a folder (directory) named C{path} with numeric mode C{mode}. + Create a folder (directory) named ``path`` with numeric mode ``mode``. The default mode is 0777 (octal). On some systems, mode is ignored. Where it is used, the current umask value is first masked out. - @param path: name of the folder to create - @type path: str - @param mode: permissions (posix-style) for the newly-created folder - @type mode: int + :param path: name of the folder to create + :type path: str + :param mode: permissions (posix-style) for the newly-created folder + :type mode: int """ path = self._adjust_cwd(path) self._log(DEBUG, 'mkdir(%r, %r)' % (path, mode)) @@ -304,10 +304,10 @@ class SFTPClient (BaseSFTP): def rmdir(self, path): """ - Remove the folder named C{path}. + Remove the folder named ``path``. - @param path: name of the folder to remove - @type path: str + :param path: name of the folder to remove + :type path: str """ path = self._adjust_cwd(path) self._log(DEBUG, 'rmdir(%r)' % path) @@ -317,20 +317,20 @@ class SFTPClient (BaseSFTP): """ Retrieve information about a file on the remote system. The return value is an object whose attributes correspond to the attributes of - python's C{stat} structure as returned by C{os.stat}, except that it + python's ``stat`` structure as returned by ``os.stat``, except that it contains fewer fields. An SFTP server may return as much or as little info as it wants, so the results may vary from server to server. - Unlike a python C{stat} object, the result may not be accessed as a + Unlike a python ``stat`` object, the result may not be accessed as a tuple. This is mostly due to the author's slack factor. - The fields supported are: C{st_mode}, C{st_size}, C{st_uid}, C{st_gid}, - C{st_atime}, and C{st_mtime}. + The fields supported are: ``st_mode``, ``st_size``, ``st_uid``, ``st_gid``, + ``st_atime``, and ``st_mtime``. - @param path: the filename to stat - @type path: str - @return: an object containing attributes about the given file - @rtype: SFTPAttributes + :param path: the filename to stat + :type path: str + :return: an object containing attributes about the given file + :rtype: SFTPAttributes """ path = self._adjust_cwd(path) self._log(DEBUG, 'stat(%r)' % path) @@ -343,12 +343,12 @@ class SFTPClient (BaseSFTP): """ Retrieve information about a file on the remote system, without following symbolic links (shortcuts). This otherwise behaves exactly - the same as L{stat}. + the same as :class:`stat`. - @param path: the filename to stat - @type path: str - @return: an object containing attributes about the given file - @rtype: SFTPAttributes + :param path: the filename to stat + :type path: str + :return: an object containing attributes about the given file + :rtype: SFTPAttributes """ path = self._adjust_cwd(path) self._log(DEBUG, 'lstat(%r)' % path) @@ -359,13 +359,13 @@ class SFTPClient (BaseSFTP): def symlink(self, source, dest): """ - Create a symbolic link (shortcut) of the C{source} path at - C{destination}. + Create a symbolic link (shortcut) of the ``source`` path at + ``destination``. - @param source: path of the original file - @type source: str - @param dest: path of the newly created symlink - @type dest: str + :param source: path of the original file + :type source: str + :param dest: path of the newly created symlink + :type dest: str """ dest = self._adjust_cwd(dest) self._log(DEBUG, 'symlink(%r, %r)' % (source, dest)) @@ -376,13 +376,13 @@ class SFTPClient (BaseSFTP): def chmod(self, path, mode): """ Change the mode (permissions) of a file. The permissions are - unix-style and identical to those used by python's C{os.chmod} + unix-style and identical to those used by python's ``os.chmod`` function. - @param path: path of the file to change the permissions of - @type path: str - @param mode: new permissions - @type mode: int + :param path: path of the file to change the permissions of + :type path: str + :param mode: new permissions + :type mode: int """ path = self._adjust_cwd(path) self._log(DEBUG, 'chmod(%r, %r)' % (path, mode)) @@ -392,17 +392,17 @@ class SFTPClient (BaseSFTP): def chown(self, path, uid, gid): """ - Change the owner (C{uid}) and group (C{gid}) of a file. As with - python's C{os.chown} function, you must pass both arguments, so if you - only want to change one, use L{stat} first to retrieve the current + Change the owner (``uid``) and group (``gid``) of a file. As with + python's ``os.chown`` function, you must pass both arguments, so if you + only want to change one, use :class:`stat` first to retrieve the current owner and group. - @param path: path of the file to change the owner and group of - @type path: str - @param uid: new owner's uid - @type uid: int - @param gid: new group id - @type gid: int + :param path: path of the file to change the owner and group of + :type path: str + :param uid: new owner's uid + :type uid: int + :param gid: new group id + :type gid: int """ path = self._adjust_cwd(path) self._log(DEBUG, 'chown(%r, %r, %r)' % (path, uid, gid)) @@ -412,18 +412,18 @@ class SFTPClient (BaseSFTP): def utime(self, path, times): """ - Set the access and modified times of the file specified by C{path}. If - C{times} is C{None}, then the file's access and modified times are set - to the current time. Otherwise, C{times} must be a 2-tuple of numbers, - of the form C{(atime, mtime)}, which is used to set the access and + Set the access and modified times of the file specified by ``path``. If + ``times`` is ``None``, then the file's access and modified times are set + to the current time. Otherwise, ``times`` must be a 2-tuple of numbers, + of the form ``(atime, mtime)``, which is used to set the access and modified times, respectively. This bizarre API is mimicked from python for the sake of consistency -- I apologize. - @param path: path of the file to modify - @type path: str - @param times: C{None} or a tuple of (access time, modified time) in + :param path: path of the file to modify + :type path: str + :param times: ``None`` or a tuple of (access time, modified time) in standard internet epoch time (seconds since 01 January 1970 GMT) - @type times: tuple(int) + :type times: tuple(int) """ path = self._adjust_cwd(path) if times is None: @@ -435,14 +435,14 @@ class SFTPClient (BaseSFTP): def truncate(self, path, size): """ - Change the size of the file specified by C{path}. This usually extends - or shrinks the size of the file, just like the C{truncate()} method on + Change the size of the file specified by ``path``. This usually extends + or shrinks the size of the file, just like the ``truncate()`` method on python file objects. - @param path: path of the file to modify - @type path: str - @param size: the new size of the file - @type size: int or long + :param path: path of the file to modify + :type path: str + :param size: the new size of the file + :type size: int or long """ path = self._adjust_cwd(path) self._log(DEBUG, 'truncate(%r, %r)' % (path, size)) @@ -453,13 +453,13 @@ class SFTPClient (BaseSFTP): def readlink(self, path): """ Return the target of a symbolic link (shortcut). You can use - L{symlink} to create these. The result may be either an absolute or + :class:`symlink` to create these. The result may be either an absolute or relative pathname. - @param path: path of the symbolic link file - @type path: str - @return: target path - @rtype: str + :param path: path of the symbolic link file + :type path: str + :return: target path + :rtype: str """ path = self._adjust_cwd(path) self._log(DEBUG, 'readlink(%r)' % path) @@ -477,15 +477,15 @@ class SFTPClient (BaseSFTP): """ Return the normalized path (on the server) of a given path. This can be used to quickly resolve symbolic links or determine what the - server is considering to be the "current folder" (by passing C{'.'} - as C{path}). + server is considering to be the "current folder" (by passing ``'.'`` + as ``path``). - @param path: path to be normalized - @type path: str - @return: normalized form of the given path - @rtype: str + :param path: path to be normalized + :type path: str + :return: normalized form of the given path + :rtype: str - @raise IOError: if the path can't be resolved on the server + :raises IOError: if the path can't be resolved on the server """ path = self._adjust_cwd(path) self._log(DEBUG, 'normalize(%r)' % path) @@ -503,15 +503,15 @@ class SFTPClient (BaseSFTP): doesn't really have the concept of a current working directory, this is emulated by paramiko. Once you use this method to set a working directory, all operations on this SFTPClient object will be relative - to that path. You can pass in C{None} to stop using a current working + to that path. You can pass in ``None`` to stop using a current working directory. - @param path: new current working directory - @type path: str + :param path: new current working directory + :type path: str - @raise IOError: if the requested path doesn't exist on the server + :raises IOError: if the requested path doesn't exist on the server - @since: 1.4 + .. versionadded:: 1.4 """ if path is None: self._cwd = None @@ -523,43 +523,43 @@ class SFTPClient (BaseSFTP): def getcwd(self): """ Return the "current working directory" for this SFTP session, as - emulated by paramiko. If no directory has been set with L{chdir}, - this method will return C{None}. + emulated by paramiko. If no directory has been set with :class:`chdir`, + this method will return ``None``. - @return: the current working directory on the server, or C{None} - @rtype: str + :return: the current working directory on the server, or ``None`` + :rtype: str - @since: 1.4 + .. versionadded:: 1.4 """ return self._cwd def putfo(self, fl, remotepath, file_size=0, callback=None, confirm=True): """ - Copy the contents of an open file object (C{fl}) to the SFTP server as - C{remotepath}. Any exception raised by operations will be passed through. + Copy the contents of an open file object (``fl``) to the SFTP server as + ``remotepath``. Any exception raised by operations will be passed through. The SFTP operations use pipelining for speed. - @param fl: opened file or file-like object to copy - @type localpath: object - @param remotepath: the destination path on the SFTP server - @type remotepath: str - @param file_size: optional size parameter passed to callback. If none is + :param fl: opened file or file-like object to copy + :type localpath: object + :param remotepath: the destination path on the SFTP server + :type remotepath: str + :param file_size: optional size parameter passed to callback. If none is specified, size defaults to 0 - @type file_size: int - @param callback: optional callback function that accepts the bytes + :type file_size: int + :param callback: optional callback function that accepts the bytes transferred so far and the total bytes to be transferred (since 1.7.4) - @type callback: function(int, int) - @param confirm: whether to do a stat() on the file afterwards to + :type callback: function(int, int) + :param confirm: whether to do a stat() on the file afterwards to confirm the file size (since 1.7.7) - @type confirm: bool + :type confirm: bool - @return: an object containing attributes about the given file + :return: an object containing attributes about the given file (since 1.7.4) - @rtype: SFTPAttributes + :rtype: SFTPAttributes - @since: 1.4 + .. versionadded:: 1.4 """ fr = self.file(remotepath, 'wb') fr.set_pipelined(True) @@ -585,29 +585,29 @@ class SFTPClient (BaseSFTP): def put(self, localpath, remotepath, callback=None, confirm=True): """ - Copy a local file (C{localpath}) to the SFTP server as C{remotepath}. + Copy a local file (``localpath``) to the SFTP server as ``remotepath``. Any exception raised by operations will be passed through. This method is primarily provided as a convenience. The SFTP operations use pipelining for speed. - @param localpath: the local file to copy - @type localpath: str - @param remotepath: the destination path on the SFTP server - @type remotepath: str - @param callback: optional callback function that accepts the bytes + :param localpath: the local file to copy + :type localpath: str + :param remotepath: the destination path on the SFTP server + :type remotepath: str + :param callback: optional callback function that accepts the bytes transferred so far and the total bytes to be transferred (since 1.7.4) - @type callback: function(int, int) - @param confirm: whether to do a stat() on the file afterwards to + :type callback: function(int, int) + :param confirm: whether to do a stat() on the file afterwards to confirm the file size (since 1.7.7) - @type confirm: bool + :type confirm: bool - @return: an object containing attributes about the given file + :return: an object containing attributes about the given file (since 1.7.4) - @rtype: SFTPAttributes + :rtype: SFTPAttributes - @since: 1.4 + .. versionadded:: 1.4 """ file_size = os.stat(localpath).st_size fl = file(localpath, 'rb') @@ -618,23 +618,23 @@ class SFTPClient (BaseSFTP): def getfo(self, remotepath, fl, callback=None): """ - Copy a remote file (C{remotepath}) from the SFTP server and write to - an open file or file-like object, C{fl}. Any exception raised by + Copy a remote file (``remotepath``) from the SFTP server and write to + an open file or file-like object, ``fl``. Any exception raised by operations will be passed through. This method is primarily provided as a convenience. - @param remotepath: opened file or file-like object to copy to - @type remotepath: object - @param fl: the destination path on the local host or open file + :param remotepath: opened file or file-like object to copy to + :type remotepath: object + :param fl: the destination path on the local host or open file object - @type localpath: str - @param callback: optional callback function that accepts the bytes + :type localpath: str + :param callback: optional callback function that accepts the bytes transferred so far and the total bytes to be transferred (since 1.7.4) - @type callback: function(int, int) - @return: the number of bytes written to the opened file object + :type callback: function(int, int) + :return: the number of bytes written to the opened file object - @since: 1.4 + .. versionadded:: 1.4 """ fr = self.file(remotepath, 'rb') file_size = self.stat(remotepath).st_size @@ -655,20 +655,20 @@ class SFTPClient (BaseSFTP): def get(self, remotepath, localpath, callback=None): """ - Copy a remote file (C{remotepath}) from the SFTP server to the local - host as C{localpath}. Any exception raised by operations will be + Copy a remote file (``remotepath``) from the SFTP server to the local + host as ``localpath``. Any exception raised by operations will be passed through. This method is primarily provided as a convenience. - @param remotepath: the remote file to copy - @type remotepath: str - @param localpath: the destination path on the local host - @type localpath: str - @param callback: optional callback function that accepts the bytes + :param remotepath: the remote file to copy + :type remotepath: str + :param localpath: the destination path on the local host + :type localpath: str + :param callback: optional callback function that accepts the bytes transferred so far and the total bytes to be transferred (since 1.7.4) - @type callback: function(int, int) + :type callback: function(int, int) - @since: 1.4 + .. versionadded:: 1.4 """ file_size = self.stat(remotepath).st_size fl = file(localpath, 'wb') @@ -783,5 +783,5 @@ class SFTPClient (BaseSFTP): class SFTP (SFTPClient): - "an alias for L{SFTPClient} for backwards compatability" + "an alias for :class:`SFTPClient` for backwards compatability" pass diff --git a/paramiko/sftp_file.py b/paramiko/sftp_file.py index a39b1f47..f8952889 100644 --- a/paramiko/sftp_file.py +++ b/paramiko/sftp_file.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{SFTPFile} +:class:`SFTPFile` """ from __future__ import with_statement @@ -181,34 +181,34 @@ class SFTPFile (BufferedFile): def settimeout(self, timeout): """ Set a timeout on read/write operations on the underlying socket or - ssh L{Channel}. + ssh :class:`Channel`. - @see: L{Channel.settimeout} - @param timeout: seconds to wait for a pending read/write operation - before raising C{socket.timeout}, or C{None} for no timeout - @type timeout: float + .. seealso:: :class:`Channel.settimeout` + :param timeout: seconds to wait for a pending read/write operation + before raising ``socket.timeout``, or ``None`` for no timeout + :type timeout: float """ self.sftp.sock.settimeout(timeout) def gettimeout(self): """ Returns the timeout in seconds (as a float) associated with the socket - or ssh L{Channel} used for this file. + or ssh :class:`Channel` used for this file. - @see: L{Channel.gettimeout} - @rtype: float + .. seealso:: :class:`Channel.gettimeout` + :rtype: float """ return self.sftp.sock.gettimeout() def setblocking(self, blocking): """ Set blocking or non-blocking mode on the underiying socket or ssh - L{Channel}. + :class:`Channel`. - @see: L{Channel.setblocking} - @param blocking: 0 to set non-blocking mode; non-0 to set blocking + .. seealso:: :class:`Channel.setblocking` + :param blocking: 0 to set non-blocking mode; non-0 to set blocking mode. - @type blocking: int + :type blocking: int """ self.sftp.sock.setblocking(blocking) @@ -226,11 +226,11 @@ class SFTPFile (BufferedFile): def stat(self): """ Retrieve information about this file from the remote system. This is - exactly like L{SFTP.stat}, except that it operates on an already-open + exactly like :class:`SFTP.stat`, except that it operates on an already-open file. - @return: an object containing attributes about this file. - @rtype: SFTPAttributes + :return: an object containing attributes about this file. + :rtype: SFTPAttributes """ t, msg = self.sftp._request(CMD_FSTAT, self.handle) if t != CMD_ATTRS: @@ -240,11 +240,11 @@ class SFTPFile (BufferedFile): def chmod(self, mode): """ Change the mode (permissions) of this file. The permissions are - unix-style and identical to those used by python's C{os.chmod} + unix-style and identical to those used by python's ``os.chmod`` function. - @param mode: new permissions - @type mode: int + :param mode: new permissions + :type mode: int """ self.sftp._log(DEBUG, 'chmod(%s, %r)' % (hexlify(self.handle), mode)) attr = SFTPAttributes() @@ -253,15 +253,15 @@ class SFTPFile (BufferedFile): def chown(self, uid, gid): """ - Change the owner (C{uid}) and group (C{gid}) of this file. As with - python's C{os.chown} function, you must pass both arguments, so if you - only want to change one, use L{stat} first to retrieve the current + Change the owner (``uid``) and group (``gid``) of this file. As with + python's ``os.chown`` function, you must pass both arguments, so if you + only want to change one, use :class:`stat` first to retrieve the current owner and group. - @param uid: new owner's uid - @type uid: int - @param gid: new group id - @type gid: int + :param uid: new owner's uid + :type uid: int + :param gid: new group id + :type gid: int """ self.sftp._log(DEBUG, 'chown(%s, %r, %r)' % (hexlify(self.handle), uid, gid)) attr = SFTPAttributes() @@ -271,15 +271,15 @@ class SFTPFile (BufferedFile): def utime(self, times): """ Set the access and modified times of this file. If - C{times} is C{None}, then the file's access and modified times are set - to the current time. Otherwise, C{times} must be a 2-tuple of numbers, - of the form C{(atime, mtime)}, which is used to set the access and + ``times`` is ``None``, then the file's access and modified times are set + to the current time. Otherwise, ``times`` must be a 2-tuple of numbers, + of the form ``(atime, mtime)``, which is used to set the access and modified times, respectively. This bizarre API is mimicked from python for the sake of consistency -- I apologize. - @param times: C{None} or a tuple of (access time, modified time) in + :param times: ``None`` or a tuple of (access time, modified time) in standard internet epoch time (seconds since 01 January 1970 GMT) - @type times: tuple(int) + :type times: tuple(int) """ if times is None: times = (time.time(), time.time()) @@ -291,11 +291,11 @@ class SFTPFile (BufferedFile): def truncate(self, size): """ Change the size of this file. This usually extends - or shrinks the size of the file, just like the C{truncate()} method on + or shrinks the size of the file, just like the ``truncate()`` method on python file objects. - @param size: the new size of the file - @type size: int or long + :param size: the new size of the file + :type size: int or long """ self.sftp._log(DEBUG, 'truncate(%s, %r)' % (hexlify(self.handle), size)) attr = SFTPAttributes() @@ -308,46 +308,46 @@ class SFTPFile (BufferedFile): to verify a successful upload or download, or for various rsync-like operations. - The file is hashed from C{offset}, for C{length} bytes. If C{length} - is 0, the remainder of the file is hashed. Thus, if both C{offset} - and C{length} are zero, the entire file is hashed. + The file is hashed from ``offset``, for ``length`` bytes. If ``length`` + is 0, the remainder of the file is hashed. Thus, if both ``offset`` + and ``length`` are zero, the entire file is hashed. - Normally, C{block_size} will be 0 (the default), and this method will + Normally, ``block_size`` will be 0 (the default), and this method will return a byte string representing the requested hash (for example, a string of length 16 for MD5, or 20 for SHA-1). If a non-zero - C{block_size} is given, each chunk of the file (from C{offset} to - C{offset + length}) of C{block_size} bytes is computed as a separate + ``block_size`` is given, each chunk of the file (from ``offset`` to + ``offset + length``) of ``block_size`` bytes is computed as a separate hash. The hash results are all concatenated and returned as a single string. - For example, C{check('sha1', 0, 1024, 512)} will return a string of + For example, ``check('sha1', 0, 1024, 512)`` will return a string of length 40. The first 20 bytes will be the SHA-1 of the first 512 bytes of the file, and the last 20 bytes will be the SHA-1 of the next 512 bytes. - @param hash_algorithm: the name of the hash algorithm to use (normally - C{"sha1"} or C{"md5"}) - @type hash_algorithm: str - @param offset: offset into the file to begin hashing (0 means to start + :param hash_algorithm: the name of the hash algorithm to use (normally + ``"sha1"`` or ``"md5"``) + :type hash_algorithm: str + :param offset: offset into the file to begin hashing (0 means to start from the beginning) - @type offset: int or long - @param length: number of bytes to hash (0 means continue to the end of + :type offset: int or long + :param length: number of bytes to hash (0 means continue to the end of the file) - @type length: int or long - @param block_size: number of bytes to hash per result (must not be less + :type length: int or long + :param block_size: number of bytes to hash per result (must not be less than 256; 0 means to compute only one hash of the entire segment) - @type block_size: int - @return: string of bytes representing the hash of each block, + :type block_size: int + :return: string of bytes representing the hash of each block, concatenated together - @rtype: str + :rtype: str - @note: Many (most?) servers don't support this extension yet. + .. note:: Many (most?) servers don't support this extension yet. - @raise IOError: if the server doesn't support the "check-file" + :raises IOError: if the server doesn't support the "check-file" extension, or possibly doesn't support the hash algorithm requested - @since: 1.4 + .. versionadded:: 1.4 """ t, msg = self.sftp._request(CMD_EXTENDED, 'check-file', self.handle, hash_algorithm, long(offset), long(length), block_size) @@ -361,34 +361,34 @@ class SFTPFile (BufferedFile): Turn on/off the pipelining of write operations to this file. When pipelining is on, paramiko won't wait for the server response after each write operation. Instead, they're collected as they come in. - At the first non-write operation (including L{close}), all remaining + At the first non-write operation (including :class:`close`), all remaining server responses are collected. This means that if there was an error with one of your later writes, an exception might be thrown from - within L{close} instead of L{write}. + within :class:`close` instead of :class:`write`. - By default, files are I{not} pipelined. + By default, files are not pipelined. - @param pipelined: C{True} if pipelining should be turned on for this - file; C{False} otherwise - @type pipelined: bool + :param pipelined: ``True`` if pipelining should be turned on for this + file; ``False`` otherwise + :type pipelined: bool - @since: 1.5 + .. versionadded:: 1.5 """ self.pipelined = pipelined def prefetch(self): """ Pre-fetch the remaining contents of this file in anticipation of - future L{read} calls. If reading the entire file, pre-fetching can + future :class:`read` calls. If reading the entire file, pre-fetching can dramatically improve the download speed by avoiding roundtrip latency. The file's contents are incrementally buffered in a background thread. - The prefetched data is stored in a buffer until read via the L{read} + The prefetched data is stored in a buffer until read via the :class:`read` method. Once data has been read, it's removed from the buffer. The - data may be read in a random order (using L{seek}); chunks of the + data may be read in a random order (using :class:`seek`); chunks of the buffer that haven't been read will continue to be buffered. - @since: 1.5.1 + .. versionadded:: 1.5.1 """ size = self.stat().st_size # queue up async reads for the rest of the file @@ -404,17 +404,17 @@ class SFTPFile (BufferedFile): def readv(self, chunks): """ Read a set of blocks from the file by (offset, length). This is more - efficient than doing a series of L{seek} and L{read} calls, since the + efficient than doing a series of :class:`seek` and :class:`read` calls, since the prefetch machinery is used to retrieve all the requested blocks at once. - @param chunks: a list of (offset, length) tuples indicating which + :param chunks: a list of (offset, length) tuples indicating which sections of the file to read - @type chunks: list(tuple(long, int)) - @return: a list of blocks read, in the same order as in C{chunks} - @rtype: list(str) + :type chunks: list(tuple(long, int)) + :return: a list of blocks read, in the same order as in ``chunks`` + :rtype: list(str) - @since: 1.5.4 + .. versionadded:: 1.5.4 """ self.sftp._log(DEBUG, 'readv(%s, %r)' % (hexlify(self.handle), chunks)) diff --git a/paramiko/sftp_handle.py b/paramiko/sftp_handle.py index 29d3d0d8..c591b318 100644 --- a/paramiko/sftp_handle.py +++ b/paramiko/sftp_handle.py @@ -33,16 +33,16 @@ class SFTPHandle (object): by the client to refer to the underlying file. Server implementations can (and should) subclass SFTPHandle to implement - features of a file handle, like L{stat} or L{chattr}. + features of a file handle, like :class:`stat` or :class:`chattr`. """ def __init__(self, flags=0): """ Create a new file handle representing a local file being served over - SFTP. If C{flags} is passed in, it's used to determine if the file + SFTP. If ``flags`` is passed in, it's used to determine if the file is open in append mode. - @param flags: optional flags as passed to L{SFTPServerInterface.open} - @type flags: int + :param flags: optional flags as passed to :class:`SFTPServerInterface.open` + :type flags: int """ self.__flags = flags self.__name = None @@ -56,10 +56,10 @@ class SFTPHandle (object): Normally you would use this method to close the underlying OS level file object(s). - The default implementation checks for attributes on C{self} named - C{readfile} and/or C{writefile}, and if either or both are present, - their C{close()} methods are called. This means that if you are - using the default implementations of L{read} and L{write}, this + The default implementation checks for attributes on ``self`` named + ``readfile`` and/or ``writefile``, and if either or both are present, + their ``close()`` methods are called. This means that if you are + using the default implementations of :class:`read` and :class:`write`, this method's default implementation should be fine also. """ readfile = getattr(self, 'readfile', None) @@ -71,24 +71,24 @@ class SFTPHandle (object): def read(self, offset, length): """ - Read up to C{length} bytes from this file, starting at position - C{offset}. The offset may be a python long, since SFTP allows it + Read up to ``length`` bytes from this file, starting at position + ``offset``. The offset may be a python long, since SFTP allows it to be 64 bits. If the end of the file has been reached, this method may return an - empty string to signify EOF, or it may also return L{SFTP_EOF}. + empty string to signify EOF, or it may also return :class:`SFTP_EOF`. - The default implementation checks for an attribute on C{self} named - C{readfile}, and if present, performs the read operation on the python + The default implementation checks for an attribute on ``self`` named + ``readfile``, and if present, performs the read operation on the python file-like object found there. (This is meant as a time saver for the common case where you are wrapping a python file object.) - @param offset: position in the file to start reading from. - @type offset: int or long - @param length: number of bytes to attempt to read. - @type length: int - @return: data read from the file, or an SFTP error code. - @rtype: str + :param offset: position in the file to start reading from. + :type offset: int or long + :param length: number of bytes to attempt to read. + :type length: int + :return: data read from the file, or an SFTP error code. + :rtype: str """ readfile = getattr(self, 'readfile', None) if readfile is None: @@ -108,23 +108,23 @@ class SFTPHandle (object): def write(self, offset, data): """ - Write C{data} into this file at position C{offset}. Extending the + Write ``data`` into this file at position ``offset``. Extending the file past its original end is expected. Unlike python's normal - C{write()} methods, this method cannot do a partial write: it must - write all of C{data} or else return an error. + ``write()`` methods, this method cannot do a partial write: it must + write all of ``data`` or else return an error. - The default implementation checks for an attribute on C{self} named - C{writefile}, and if present, performs the write operation on the + The default implementation checks for an attribute on ``self`` named + ``writefile``, and if present, performs the write operation on the python file-like object found there. The attribute is named - differently from C{readfile} to make it easy to implement read-only + differently from ``readfile`` to make it easy to implement read-only (or write-only) files, but if both attributes are present, they should refer to the same file. - @param offset: position in the file to start reading from. - @type offset: int or long - @param data: data to write into the file. - @type data: str - @return: an SFTP error code like L{SFTP_OK}. + :param offset: position in the file to start reading from. + :type offset: int or long + :param data: data to write into the file. + :type data: str + :return: an SFTP error code like :class:`SFTP_OK`. """ writefile = getattr(self, 'writefile', None) if writefile is None: @@ -148,26 +148,26 @@ class SFTPHandle (object): def stat(self): """ - Return an L{SFTPAttributes} object referring to this open file, or an - error code. This is equivalent to L{SFTPServerInterface.stat}, except + Return an :class:`SFTPAttributes` object referring to this open file, or an + error code. This is equivalent to :class:`SFTPServerInterface.stat`, except it's called on an open file instead of a path. - @return: an attributes object for the given file, or an SFTP error - code (like L{SFTP_PERMISSION_DENIED}). - @rtype: L{SFTPAttributes} I{or error code} + :return: an attributes object for the given file, or an SFTP error + code (like :class:`SFTP_PERMISSION_DENIED`). + :rtype: :class:`SFTPAttributes` or error code """ return SFTP_OP_UNSUPPORTED def chattr(self, attr): """ - Change the attributes of this file. The C{attr} object will contain + Change the attributes of this file. The ``attr`` object will contain only those fields provided by the client in its request, so you should check for the presence of fields before using them. - @param attr: the attributes to change on this file. - @type attr: L{SFTPAttributes} - @return: an error code like L{SFTP_OK}. - @rtype: int + :param attr: the attributes to change on this file. + :type attr: :class:`SFTPAttributes` + :return: an error code like :class:`SFTP_OK`. + :rtype: int """ return SFTP_OP_UNSUPPORTED diff --git a/paramiko/sftp_server.py b/paramiko/sftp_server.py index 1833c2e8..867acbcb 100644 --- a/paramiko/sftp_server.py +++ b/paramiko/sftp_server.py @@ -40,28 +40,28 @@ _hash_class = { class SFTPServer (BaseSFTP, SubsystemHandler): """ - Server-side SFTP subsystem support. Since this is a L{SubsystemHandler}, - it can be (and is meant to be) set as the handler for C{"sftp"} requests. - Use L{Transport.set_subsystem_handler} to activate this class. + Server-side SFTP subsystem support. Since this is a :class:`SubsystemHandler`, + it can be (and is meant to be) set as the handler for ``"sftp"`` requests. + Use :class:`Transport.set_subsystem_handler` to activate this class. """ def __init__(self, channel, name, server, sftp_si=SFTPServerInterface, *largs, **kwargs): """ The constructor for SFTPServer is meant to be called from within the - L{Transport} as a subsystem handler. C{server} and any additional + :class:`Transport` as a subsystem handler. ``server`` and any additional parameters or keyword parameters are passed from the original call to - L{Transport.set_subsystem_handler}. + :class:`Transport.set_subsystem_handler`. - @param channel: channel passed from the L{Transport}. - @type channel: L{Channel} - @param name: name of the requested subsystem. - @type name: str - @param server: the server object associated with this channel and + :param channel: channel passed from the :class:`Transport`. + :type channel: :class:`Channel` + :param name: name of the requested subsystem. + :type name: str + :param server: the server object associated with this channel and subsystem - @type server: L{ServerInterface} - @param sftp_si: a subclass of L{SFTPServerInterface} to use for handling + :type server: :class:`ServerInterface` + :param sftp_si: a subclass of :class:`SFTPServerInterface` to use for handling individual requests. - @type sftp_si: class + :type sftp_si: class """ BaseSFTP.__init__(self) SubsystemHandler.__init__(self, channel, name, server) @@ -122,14 +122,14 @@ class SFTPServer (BaseSFTP, SubsystemHandler): def convert_errno(e): """ - Convert an errno value (as from an C{OSError} or C{IOError}) into a + Convert an errno value (as from an ``OSError`` or ``IOError``) into a standard SFTP result code. This is a convenience function for trapping exceptions in server code and returning an appropriate result. - @param e: an errno code, as from C{OSError.errno}. - @type e: int - @return: an SFTP error code like L{SFTP_NO_SUCH_FILE}. - @rtype: int + :param e: an errno code, as from ``OSError.errno``. + :type e: int + :return: an SFTP error code like :class:`SFTP_NO_SUCH_FILE`. + :rtype: int """ if e == errno.EACCES: # permission denied @@ -144,18 +144,18 @@ class SFTPServer (BaseSFTP, SubsystemHandler): def set_file_attr(filename, attr): """ Change a file's attributes on the local filesystem. The contents of - C{attr} are used to change the permissions, owner, group ownership, + ``attr`` are used to change the permissions, owner, group ownership, and/or modification & access time of the file, depending on which - attributes are present in C{attr}. + attributes are present in ``attr``. This is meant to be a handy helper function for translating SFTP file requests into local file operations. - @param filename: name of the file to alter (should usually be an + :param filename: name of the file to alter (should usually be an absolute path). - @type filename: str - @param attr: attributes to change. - @type attr: L{SFTPAttributes} + :type filename: str + :param attr: attributes to change. + :type attr: :class:`SFTPAttributes` """ if sys.platform != 'win32': # mode operations are meaningless on win32 diff --git a/paramiko/sftp_si.py b/paramiko/sftp_si.py index b0ee3c42..b203aea0 100644 --- a/paramiko/sftp_si.py +++ b/paramiko/sftp_si.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{SFTPServerInterface} is an interface to override for SFTP server support. +:class:`SFTPServerInterface` is an interface to override for SFTP server support. """ import os @@ -29,7 +29,7 @@ from paramiko.sftp import * class SFTPServerInterface (object): """ This class defines an interface for controlling the behavior of paramiko - when using the L{SFTPServer} subsystem to provide an SFTP server. + when using the :class:`SFTPServer` subsystem to provide an SFTP server. Methods on this class are called from the SFTP session's thread, so you can block as long as necessary without affecting other sessions (even other @@ -46,9 +46,9 @@ class SFTPServerInterface (object): Create a new SFTPServerInterface object. This method does nothing by default and is meant to be overridden by subclasses. - @param server: the server object associated with this channel and + :param server: the server object associated with this channel and SFTP subsystem - @type server: L{ServerInterface} + :type server: :class:`ServerInterface` """ super(SFTPServerInterface, self).__init__(*largs, **kwargs) @@ -64,7 +64,7 @@ class SFTPServerInterface (object): """ The SFTP server session has just ended, either cleanly or via an exception. This method is meant to be overridden to perform any - necessary cleanup before this C{SFTPServerInterface} object is + necessary cleanup before this ``SFTPServerInterface`` object is destroyed. """ pass @@ -72,67 +72,67 @@ class SFTPServerInterface (object): def open(self, path, flags, attr): """ Open a file on the server and create a handle for future operations - on that file. On success, a new object subclassed from L{SFTPHandle} + on that file. On success, a new object subclassed from :class:`SFTPHandle` should be returned. This handle will be used for future operations on the file (read, write, etc). On failure, an error code such as - L{SFTP_PERMISSION_DENIED} should be returned. - - C{flags} contains the requested mode for opening (read-only, - write-append, etc) as a bitset of flags from the C{os} module: - - C{os.O_RDONLY} - - C{os.O_WRONLY} - - C{os.O_RDWR} - - C{os.O_APPEND} - - C{os.O_CREAT} - - C{os.O_TRUNC} - - C{os.O_EXCL} - (One of C{os.O_RDONLY}, C{os.O_WRONLY}, or C{os.O_RDWR} will always + :class:`SFTP_PERMISSION_DENIED` should be returned. + + ``flags`` contains the requested mode for opening (read-only, + write-append, etc) as a bitset of flags from the ``os`` module: + - ``os.O_RDONLY`` + - ``os.O_WRONLY`` + - ``os.O_RDWR`` + - ``os.O_APPEND`` + - ``os.O_CREAT`` + - ``os.O_TRUNC`` + - ``os.O_EXCL`` + (One of ``os.O_RDONLY``, ``os.O_WRONLY``, or ``os.O_RDWR`` will always be set.) - The C{attr} object contains requested attributes of the file if it + The ``attr`` object contains requested attributes of the file if it has to be created. Some or all attribute fields may be missing if the client didn't specify them. - @note: The SFTP protocol defines all files to be in "binary" mode. + .. note:: The SFTP protocol defines all files to be in "binary" mode. There is no equivalent to python's "text" mode. - @param path: the requested path (relative or absolute) of the file + :param path: the requested path (relative or absolute) of the file to be opened. - @type path: str - @param flags: flags or'd together from the C{os} module indicating the + :type path: str + :param flags: flags or'd together from the ``os`` module indicating the requested mode for opening the file. - @type flags: int - @param attr: requested attributes of the file if it is newly created. - @type attr: L{SFTPAttributes} - @return: a new L{SFTPHandle} I{or error code}. - @rtype L{SFTPHandle} + :type flags: int + :param attr: requested attributes of the file if it is newly created. + :type attr: :class:`SFTPAttributes` + :return: a new :class:`SFTPHandle` or error code. + :rtype :class:`SFTPHandle` """ return SFTP_OP_UNSUPPORTED def list_folder(self, path): """ - Return a list of files within a given folder. The C{path} will use - posix notation (C{"/"} separates folder names) and may be an absolute + Return a list of files within a given folder. The ``path`` will use + posix notation (``"/"`` separates folder names) and may be an absolute or relative path. - The list of files is expected to be a list of L{SFTPAttributes} + The list of files is expected to be a list of :class:`SFTPAttributes` objects, which are similar in structure to the objects returned by - C{os.stat}. In addition, each object should have its C{filename} + ``os.stat``. In addition, each object should have its ``filename`` field filled in, since this is important to a directory listing and - not normally present in C{os.stat} results. The method - L{SFTPAttributes.from_stat} will usually do what you want. + not normally present in ``os.stat`` results. The method + :class:`SFTPAttributes.from_stat` will usually do what you want. - In case of an error, you should return one of the C{SFTP_*} error - codes, such as L{SFTP_PERMISSION_DENIED}. + In case of an error, you should return one of the ``SFTP_*`` error + codes, such as :class:`SFTP_PERMISSION_DENIED`. - @param path: the requested path (relative or absolute) to be listed. - @type path: str - @return: a list of the files in the given folder, using - L{SFTPAttributes} objects. - @rtype: list of L{SFTPAttributes} I{or error code} + :param path: the requested path (relative or absolute) to be listed. + :type path: str + :return: a list of the files in the given folder, using + :class:`SFTPAttributes` objects. + :rtype: list of :class:`SFTPAttributes` or error code - @note: You should normalize the given C{path} first (see the - C{os.path} module) and check appropriate permissions before returning + .. note:: You should normalize the given ``path`` first (see the + ``os.path`` module) and check appropriate permissions before returning the list of files. Be careful of malicious clients attempting to use relative paths to escape restricted folders, if you're doing a direct translation from the SFTP server path to your local filesystem. @@ -141,34 +141,34 @@ class SFTPServerInterface (object): def stat(self, path): """ - Return an L{SFTPAttributes} object for a path on the server, or an + Return an :class:`SFTPAttributes` object for a path on the server, or an error code. If your server supports symbolic links (also known as - "aliases"), you should follow them. (L{lstat} is the corresponding + "aliases"), you should follow them. (:class:`lstat` is the corresponding call that doesn't follow symlinks/aliases.) - @param path: the requested path (relative or absolute) to fetch + :param path: the requested path (relative or absolute) to fetch file statistics for. - @type path: str - @return: an attributes object for the given file, or an SFTP error - code (like L{SFTP_PERMISSION_DENIED}). - @rtype: L{SFTPAttributes} I{or error code} + :type path: str + :return: an attributes object for the given file, or an SFTP error + code (like :class:`SFTP_PERMISSION_DENIED`). + :rtype: :class:`SFTPAttributes` or error code """ return SFTP_OP_UNSUPPORTED def lstat(self, path): """ - Return an L{SFTPAttributes} object for a path on the server, or an + Return an :class:`SFTPAttributes` object for a path on the server, or an error code. If your server supports symbolic links (also known as - "aliases"), you should I{not} follow them -- instead, you should - return data on the symlink or alias itself. (L{stat} is the + "aliases"), you should not follow them -- instead, you should + return data on the symlink or alias itself. (:class:`stat` is the corresponding call that follows symlinks/aliases.) - @param path: the requested path (relative or absolute) to fetch + :param path: the requested path (relative or absolute) to fetch file statistics for. - @type path: str - @return: an attributes object for the given file, or an SFTP error - code (like L{SFTP_PERMISSION_DENIED}). - @rtype: L{SFTPAttributes} I{or error code} + :type path: str + :return: an attributes object for the given file, or an SFTP error + code (like :class:`SFTP_PERMISSION_DENIED`). + :rtype: :class:`SFTPAttributes` or error code """ return SFTP_OP_UNSUPPORTED @@ -176,11 +176,11 @@ class SFTPServerInterface (object): """ Delete a file, if possible. - @param path: the requested path (relative or absolute) of the file + :param path: the requested path (relative or absolute) of the file to delete. - @type path: str - @return: an SFTP error code like L{SFTP_OK}. - @rtype: int + :type path: str + :return: an SFTP error code like :class:`SFTP_OK`. + :rtype: int """ return SFTP_OP_UNSUPPORTED @@ -192,83 +192,83 @@ class SFTPServerInterface (object): probably a good idea to implement "move" in this method too, even for files that cross disk partition boundaries, if at all possible. - @note: You should return an error if a file with the same name as - C{newpath} already exists. (The rename operation should be + .. note:: You should return an error if a file with the same name as + ``newpath`` already exists. (The rename operation should be non-desctructive.) - @param oldpath: the requested path (relative or absolute) of the + :param oldpath: the requested path (relative or absolute) of the existing file. - @type oldpath: str - @param newpath: the requested new path of the file. - @type newpath: str - @return: an SFTP error code like L{SFTP_OK}. - @rtype: int + :type oldpath: str + :param newpath: the requested new path of the file. + :type newpath: str + :return: an SFTP error code like :class:`SFTP_OK`. + :rtype: int """ return SFTP_OP_UNSUPPORTED def mkdir(self, path, attr): """ - Create a new directory with the given attributes. The C{attr} + Create a new directory with the given attributes. The ``attr`` object may be considered a "hint" and ignored. - The C{attr} object will contain only those fields provided by the - client in its request, so you should use C{hasattr} to check for - the presense of fields before using them. In some cases, the C{attr} + The ``attr`` object will contain only those fields provided by the + client in its request, so you should use ``hasattr`` to check for + the presense of fields before using them. In some cases, the ``attr`` object may be completely empty. - @param path: requested path (relative or absolute) of the new + :param path: requested path (relative or absolute) of the new folder. - @type path: str - @param attr: requested attributes of the new folder. - @type attr: L{SFTPAttributes} - @return: an SFTP error code like L{SFTP_OK}. - @rtype: int + :type path: str + :param attr: requested attributes of the new folder. + :type attr: :class:`SFTPAttributes` + :return: an SFTP error code like :class:`SFTP_OK`. + :rtype: int """ return SFTP_OP_UNSUPPORTED def rmdir(self, path): """ - Remove a directory if it exists. The C{path} should refer to an + Remove a directory if it exists. The ``path`` should refer to an existing, empty folder -- otherwise this method should return an error. - @param path: requested path (relative or absolute) of the folder + :param path: requested path (relative or absolute) of the folder to remove. - @type path: str - @return: an SFTP error code like L{SFTP_OK}. - @rtype: int + :type path: str + :return: an SFTP error code like :class:`SFTP_OK`. + :rtype: int """ return SFTP_OP_UNSUPPORTED def chattr(self, path, attr): """ - Change the attributes of a file. The C{attr} object will contain + Change the attributes of a file. The ``attr`` object will contain only those fields provided by the client in its request, so you should check for the presence of fields before using them. - @param path: requested path (relative or absolute) of the file to + :param path: requested path (relative or absolute) of the file to change. - @type path: str - @param attr: requested attributes to change on the file. - @type attr: L{SFTPAttributes} - @return: an error code like L{SFTP_OK}. - @rtype: int + :type path: str + :param attr: requested attributes to change on the file. + :type attr: :class:`SFTPAttributes` + :return: an error code like :class:`SFTP_OK`. + :rtype: int """ return SFTP_OP_UNSUPPORTED def canonicalize(self, path): """ Return the canonical form of a path on the server. For example, - if the server's home folder is C{/home/foo}, the path - C{"../betty"} would be canonicalized to C{"/home/betty"}. Note + if the server's home folder is ``/home/foo``, the path + ``"../betty"`` would be canonicalized to ``"/home/betty"``. Note the obvious security issues: if you're serving files only from a specific folder, you probably don't want this method to reveal path names outside that folder. - You may find the python methods in C{os.path} useful, especially - C{os.path.normpath} and C{os.path.realpath}. + You may find the python methods in ``os.path`` useful, especially + ``os.path.normpath`` and ``os.path.realpath``. - The default implementation returns C{os.path.normpath('/' + path)}. + The default implementation returns ``os.path.normpath('/' + path)``. """ if os.path.isabs(path): out = os.path.normpath(path) @@ -285,26 +285,26 @@ class SFTPServerInterface (object): If the specified path doesn't refer to a symbolic link, an error should be returned. - @param path: path (relative or absolute) of the symbolic link. - @type path: str - @return: the target path of the symbolic link, or an error code like - L{SFTP_NO_SUCH_FILE}. - @rtype: str I{or error code} + :param path: path (relative or absolute) of the symbolic link. + :type path: str + :return: the target path of the symbolic link, or an error code like + :class:`SFTP_NO_SUCH_FILE`. + :rtype: str or error code """ return SFTP_OP_UNSUPPORTED def symlink(self, target_path, path): """ - Create a symbolic link on the server, as new pathname C{path}, - with C{target_path} as the target of the link. + Create a symbolic link on the server, as new pathname ``path``, + with ``target_path`` as the target of the link. - @param target_path: path (relative or absolute) of the target for + :param target_path: path (relative or absolute) of the target for this new symbolic link. - @type target_path: str - @param path: path (relative or absolute) of the symbolic link to + :type target_path: str + :param path: path (relative or absolute) of the symbolic link to create. - @type path: str - @return: an error code like C{SFTP_OK}. - @rtype: int + :type path: str + :return: an error code like ``SFTP_OK``. + :rtype: int """ return SFTP_OP_UNSUPPORTED diff --git a/paramiko/ssh_exception.py b/paramiko/ssh_exception.py index b502b563..5b9b4901 100644 --- a/paramiko/ssh_exception.py +++ b/paramiko/ssh_exception.py @@ -34,7 +34,7 @@ class AuthenticationException (SSHException): possible to retry with different credentials. (Other classes specify more specific reasons.) - @since: 1.6 + .. versionadded:: 1.6 """ pass @@ -52,12 +52,12 @@ class BadAuthenticationType (AuthenticationException): the server isn't allowing that type. (It may only allow public-key, for example.) - @ivar allowed_types: list of allowed authentication types provided by the - server (possible values are: C{"none"}, C{"password"}, and - C{"publickey"}). - @type allowed_types: list + :ivar allowed_types: list of allowed authentication types provided by the + server (possible values are: ``"none"``, ``"password"``, and + ``"publickey"``). + :type allowed_types: list - @since: 1.1 + .. versionadded:: 1.1 """ allowed_types = [] @@ -82,12 +82,12 @@ class PartialAuthentication (AuthenticationException): class ChannelException (SSHException): """ - Exception raised when an attempt to open a new L{Channel} fails. + Exception raised when an attempt to open a new :class:`Channel` fails. - @ivar code: the error code returned by the server - @type code: int + :ivar code: the error code returned by the server + :type code: int - @since: 1.6 + .. versionadded:: 1.6 """ def __init__(self, code, text): SSHException.__init__(self, text) @@ -98,14 +98,14 @@ class BadHostKeyException (SSHException): """ The host key given by the SSH server did not match what we were expecting. - @ivar hostname: the hostname of the SSH server - @type hostname: str - @ivar key: the host key presented by the server - @type key: L{PKey} - @ivar expected_key: the host key expected - @type expected_key: L{PKey} + :ivar hostname: the hostname of the SSH server + :type hostname: str + :ivar key: the host key presented by the server + :type key: :class:`PKey` + :ivar expected_key: the host key expected + :type expected_key: :class:`PKey` - @since: 1.6 + .. versionadded:: 1.6 """ def __init__(self, hostname, got_key, expected_key): SSHException.__init__(self, 'Host key for server %s does not match!' % hostname) @@ -118,10 +118,10 @@ class ProxyCommandFailure (SSHException): """ The "ProxyCommand" found in the .ssh/config file returned an error. - @ivar command: The command line that is generating this exception. - @type command: str - @ivar error: The error captured from the proxy command output. - @type error: str + :ivar command: The command line that is generating this exception. + :type command: str + :ivar error: The error captured from the proxy command output. + :type error: str """ def __init__(self, command, error): SSHException.__init__(self, diff --git a/paramiko/transport.py b/paramiko/transport.py index 6c42cc27..7cccd5ff 100644 --- a/paramiko/transport.py +++ b/paramiko/transport.py @@ -17,7 +17,7 @@ # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. """ -L{Transport} handles the core SSH2 protocol. +:class:`Transport` handles the core SSH2 protocol. """ import os @@ -73,10 +73,10 @@ class SecurityOptions (object): exchange algorithms, listed in order of preference. Changing the contents and/or order of these fields affects the underlying - L{Transport} (but only if you change them before starting the session). + :class:`Transport` (but only if you change them before starting the session). If you try to add an algorithm that paramiko doesn't recognize, - C{ValueError} will be raised. If you try to assign something besides a - tuple to one of the fields, C{TypeError} will be raised. + ``ValueError`` will be raised. If you try to assign something besides a + tuple to one of the fields, ``TypeError`` will be raised. """ __slots__ = [ 'ciphers', 'digests', 'key_types', 'kex', 'compression', '_transport' ] @@ -87,7 +87,7 @@ class SecurityOptions (object): """ Returns a string representation of this object, for debugging. - @rtype: str + :rtype: str """ return '<paramiko.SecurityOptions for %s>' % repr(self._transport) @@ -192,7 +192,7 @@ class Transport (threading.Thread): """ An SSH Transport attaches to a stream (usually a socket), negotiates an encrypted session, authenticates, and then creates stream tunnels, called - L{Channel}s, across the session. Multiple channels can be multiplexed + :class:`channels <Channel>`, across the session. Multiple channels can be multiplexed across a single session (and often are, in the case of port forwardings). """ @@ -250,29 +250,29 @@ class Transport (threading.Thread): """ Create a new SSH session over an existing socket, or socket-like object. This only creates the Transport object; it doesn't begin the - SSH session yet. Use L{connect} or L{start_client} to begin a client - session, or L{start_server} to begin a server session. + SSH session yet. Use :class:`connect` or :class:`start_client` to begin a client + session, or :class:`start_server` to begin a server session. If the object is not actually a socket, it must have the following methods: - - C{send(str)}: Writes from 1 to C{len(str)} bytes, and + - ``send(str)``: Writes from 1 to ``len(str)`` bytes, and returns an int representing the number of bytes written. Returns - 0 or raises C{EOFError} if the stream has been closed. - - C{recv(int)}: Reads from 1 to C{int} bytes and returns them as a - string. Returns 0 or raises C{EOFError} if the stream has been + 0 or raises ``EOFError`` if the stream has been closed. + - ``recv(int)``: Reads from 1 to ``int`` bytes and returns them as a + string. Returns 0 or raises ``EOFError`` if the stream has been closed. - - C{close()}: Closes the socket. - - C{settimeout(n)}: Sets a (float) timeout on I/O operations. + - ``close()``: Closes the socket. + - ``settimeout(n)``: Sets a (float) timeout on I/O operations. For ease of use, you may also pass in an address (as a tuple) or a host - string as the C{sock} argument. (A host string is a hostname with an - optional port (separated by C{":"}) which will be converted into a - tuple of C{(hostname, port)}.) A socket will be connected to this - address and used for communication. Exceptions from the C{socket} call + string as the ``sock`` argument. (A host string is a hostname with an + optional port (separated by ``":"``) which will be converted into a + tuple of ``(hostname, port)``.) A socket will be connected to this + address and used for communication. Exceptions from the ``socket`` call may be thrown in this case. - @param sock: a socket or socket-like object to create the session over. - @type sock: socket + :param sock: a socket or socket-like object to create the session over. + :type sock: socket """ if isinstance(sock, (str, unicode)): # convert "host:port" into (host, port) @@ -372,7 +372,7 @@ class Transport (threading.Thread): """ Returns a string representation of this object, for debugging. - @rtype: str + :rtype: str """ out = '<paramiko.Transport at %s' % hex(long(id(self)) & 0xffffffffL) if not self.active: @@ -398,52 +398,52 @@ class Transport (threading.Thread): use the connection (without corrupting the session). Use this method to clean up a Transport object without disrupting the other process. - @since: 1.5.3 + .. versionadded:: 1.5.3 """ self.sock.close() self.close() def get_security_options(self): """ - Return a L{SecurityOptions} object which can be used to tweak the + Return a :class:`SecurityOptions` object which can be used to tweak the encryption algorithms this transport will permit, and the order of preference for them. - @return: an object that can be used to change the preferred algorithms + :return: an object that can be used to change the preferred algorithms for encryption, digest (hash), public key, and key exchange. - @rtype: L{SecurityOptions} + :rtype: :class:`SecurityOptions` """ return SecurityOptions(self) def start_client(self, event=None): """ Negotiate a new SSH2 session as a client. This is the first step after - creating a new L{Transport}. A separate thread is created for protocol + creating a new :class:`Transport`. A separate thread is created for protocol negotiation. If an event is passed in, this method returns immediately. When - negotiation is done (successful or not), the given C{Event} will - be triggered. On failure, L{is_active} will return C{False}. + negotiation is done (successful or not), the given ``Event`` will + be triggered. On failure, :class:`is_active` will return ``False``. - (Since 1.4) If C{event} is C{None}, this method will not return until + (Since 1.4) If ``event`` is ``None``, this method will not return until negotation is done. On success, the method returns normally. Otherwise an SSHException is raised. After a successful negotiation, you will usually want to authenticate, - calling L{auth_password <Transport.auth_password>} or - L{auth_publickey <Transport.auth_publickey>}. + calling :class:`auth_password <Transport.auth_password>` or + :class:`auth_publickey <Transport.auth_publickey>`. - @note: L{connect} is a simpler method for connecting as a client. + .. note:: :class:`connect` is a simpler method for connecting as a client. - @note: After calling this method (or L{start_server} or L{connect}), + .. note:: After calling this method (or :class:`start_server` or :class:`connect`), you should no longer directly read from or write to the original socket object. - @param event: an event to trigger when negotiation is complete + :param event: an event to trigger when negotiation is complete (optional) - @type event: threading.Event + :type event: threading.Event - @raise SSHException: if negotiation fails (and no C{event} was passed + :raises SSHException: if negotiation fails (and no ``event`` was passed in) """ self.active = True @@ -470,41 +470,41 @@ class Transport (threading.Thread): def start_server(self, event=None, server=None): """ Negotiate a new SSH2 session as a server. This is the first step after - creating a new L{Transport} and setting up your server host key(s). A + creating a new :class:`Transport` and setting up your server host key(s). A separate thread is created for protocol negotiation. If an event is passed in, this method returns immediately. When - negotiation is done (successful or not), the given C{Event} will - be triggered. On failure, L{is_active} will return C{False}. + negotiation is done (successful or not), the given ``Event`` will + be triggered. On failure, :class:`is_active` will return ``False``. - (Since 1.4) If C{event} is C{None}, this method will not return until + (Since 1.4) If ``event`` is ``None``, this method will not return until negotation is done. On success, the method returns normally. Otherwise an SSHException is raised. After a successful negotiation, the client will need to authenticate. Override the methods - L{get_allowed_auths <ServerInterface.get_allowed_auths>}, - L{check_auth_none <ServerInterface.check_auth_none>}, - L{check_auth_password <ServerInterface.check_auth_password>}, and - L{check_auth_publickey <ServerInterface.check_auth_publickey>} in the - given C{server} object to control the authentication process. + :class:`get_allowed_auths <ServerInterface.get_allowed_auths>`, + :class:`check_auth_none <ServerInterface.check_auth_none>`, + :class:`check_auth_password <ServerInterface.check_auth_password>`, and + :class:`check_auth_publickey <ServerInterface.check_auth_publickey>` in the + given ``server`` object to control the authentication process. After a successful authentication, the client should request to open a channel. Override - L{check_channel_request <ServerInterface.check_channel_request>} in the - given C{server} object to allow channels to be opened. + :class:`check_channel_request <ServerInterface.check_channel_request>` in the + given ``server`` object to allow channels to be opened. - @note: After calling this method (or L{start_client} or L{connect}), + .. note:: After calling this method (or :class:`start_client` or :class:`connect`), you should no longer directly read from or write to the original socket object. - @param event: an event to trigger when negotiation is complete. - @type event: threading.Event - @param server: an object used to perform authentication and create - L{Channel}s. - @type server: L{server.ServerInterface} + :param event: an event to trigger when negotiation is complete. + :type event: threading.Event + :param server: an object used to perform authentication and create + :class:`channels <Channel>` + :type server: :class:`server.ServerInterface` - @raise SSHException: if negotiation fails (and no C{event} was passed + :raises SSHException: if negotiation fails (and no ``event`` was passed in) """ if server is None: @@ -540,9 +540,9 @@ class Transport (threading.Thread): key info, not just the public half. Only one key of each type (RSA or DSS) is kept. - @param key: the host key to add, usually an L{RSAKey <rsakey.RSAKey>} or - L{DSSKey <dsskey.DSSKey>}. - @type key: L{PKey <pkey.PKey>} + :param key: the host key to add, usually an :class:`RSAKey <rsakey.RSAKey>` or + :class:`DSSKey <dsskey.DSSKey>`. + :type key: :class:`PKey <pkey.PKey>` """ self.server_key_dict[key.get_name()] = key @@ -550,15 +550,15 @@ class Transport (threading.Thread): """ Return the active host key, in server mode. After negotiating with the client, this method will return the negotiated host key. If only one - type of host key was set with L{add_server_key}, that's the only key + type of host key was set with :class:`add_server_key`, that's the only key that will ever be returned. But in cases where you have set more than one type of host key (for example, an RSA key and a DSS key), the key type will be negotiated by the client, and this method will return the key of the type agreed on. If the host key has not been negotiated - yet, C{None} is returned. In client mode, the behavior is undefined. + yet, ``None`` is returned. In client mode, the behavior is undefined. - @return: host key of the type negotiated by the client, or C{None}. - @rtype: L{PKey <pkey.PKey>} + :return: host key of the type negotiated by the client, or ``None``. + :rtype: :class:`PKey <pkey.PKey>` """ try: return self.server_key_dict[self.host_key_type] @@ -568,7 +568,7 @@ class Transport (threading.Thread): def load_server_moduli(filename=None): """ - I{(optional)} + (optional) Load a file of prime moduli for use in doing group-exchange key negotiation in server mode. It's a rather obscure option and can be safely ignored. @@ -577,20 +577,20 @@ class Transport (threading.Thread): negotiation, which asks the server to send a random prime number that fits certain criteria. These primes are pretty difficult to compute, so they can't be generated on demand. But many systems contain a file - of suitable primes (usually named something like C{/etc/ssh/moduli}). - If you call C{load_server_moduli} and it returns C{True}, then this + of suitable primes (usually named something like ``/etc/ssh/moduli``). + If you call ``load_server_moduli`` and it returns ``True``, then this file of primes has been loaded and we will support "group-exchange" in server mode. Otherwise server mode will just claim that it doesn't support that method of key negotiation. - @param filename: optional path to the moduli file, if you happen to + :param filename: optional path to the moduli file, if you happen to know that it's not in a standard location. - @type filename: str - @return: True if a moduli file was successfully loaded; False + :type filename: str + :return: True if a moduli file was successfully loaded; False otherwise. - @rtype: bool + :rtype: bool - @note: This has no effect when used in client mode. + .. note:: This has no effect when used in client mode. """ Transport._modulus_pack = ModulusPack(rng) # places to look for the openssh "moduli" file @@ -624,15 +624,15 @@ class Transport (threading.Thread): """ Return the host key of the server (in client mode). - @note: Previously this call returned a tuple of (key type, key string). + .. note:: Previously this call returned a tuple of (key type, key string). You can get the same effect by calling - L{PKey.get_name <pkey.PKey.get_name>} for the key type, and - C{str(key)} for the key string. + :class:`PKey.get_name <pkey.PKey.get_name>` for the key type, and + ``str(key)`` for the key string. - @raise SSHException: if no session is currently active. + :raises SSHException: if no session is currently active. - @return: public key of the remote server - @rtype: L{PKey <pkey.PKey>} + :return: public key of the remote server + :rtype: :class:`PKey <pkey.PKey>` """ if (not self.active) or (not self.initial_kex_done): raise SSHException('No existing session') @@ -642,37 +642,37 @@ class Transport (threading.Thread): """ Return true if this session is active (open). - @return: True if the session is still active (open); False if the + :return: True if the session is still active (open); False if the session is closed - @rtype: bool + :rtype: bool """ return self.active def open_session(self): """ - Request a new channel to the server, of type C{"session"}. This - is just an alias for C{open_channel('session')}. + Request a new channel to the server, of type ``"session"``. This + is just an alias for ``open_channel('session')``. - @return: a new L{Channel} - @rtype: L{Channel} + :return: a new :class:`Channel` + :rtype: :class:`Channel` - @raise SSHException: if the request is rejected or the session ends + :raises SSHException: if the request is rejected or the session ends prematurely """ return self.open_channel('session') def open_x11_channel(self, src_addr=None): """ - Request a new channel to the client, of type C{"x11"}. This - is just an alias for C{open_channel('x11', src_addr=src_addr)}. + Request a new channel to the client, of type ``"x11"``. This + is just an alias for ``open_channel('x11', src_addr=src_addr)``. - @param src_addr: the source address of the x11 server (port is the + :param src_addr: the source address of the x11 server (port is the x11 port, ie. 6010) - @type src_addr: (str, int) - @return: a new L{Channel} - @rtype: L{Channel} + :type src_addr: (str, int) + :return: a new :class:`Channel` + :rtype: :class:`Channel` - @raise SSHException: if the request is rejected or the session ends + :raises SSHException: if the request is rejected or the session ends prematurely """ return self.open_channel('x11', src_addr=src_addr) @@ -680,51 +680,51 @@ class Transport (threading.Thread): def open_forward_agent_channel(self): """ Request a new channel to the client, of type - C{"auth-agent@openssh.com"}. + ``"auth-agent@openssh.com"``. - This is just an alias for C{open_channel('auth-agent@openssh.com')}. - @return: a new L{Channel} - @rtype: L{Channel} + This is just an alias for ``open_channel('auth-agent@openssh.com')``. + :return: a new :class:`Channel` + :rtype: :class:`Channel` - @raise SSHException: if the request is rejected or the session ends + :raises SSHException: if the request is rejected or the session ends prematurely """ return self.open_channel('auth-agent@openssh.com') def open_forwarded_tcpip_channel(self, (src_addr, src_port), (dest_addr, dest_port)): """ - Request a new channel back to the client, of type C{"forwarded-tcpip"}. + Request a new channel back to the client, of type ``"forwarded-tcpip"``. This is used after a client has requested port forwarding, for sending incoming connections back to the client. - @param src_addr: originator's address - @param src_port: originator's port - @param dest_addr: local (server) connected address - @param dest_port: local (server) connected port + :param src_addr: originator's address + :param src_port: originator's port + :param dest_addr: local (server) connected address + :param dest_port: local (server) connected port """ return self.open_channel('forwarded-tcpip', (dest_addr, dest_port), (src_addr, src_port)) def open_channel(self, kind, dest_addr=None, src_addr=None): """ - Request a new channel to the server. L{Channel}s are socket-like + Request a new channel to the server. :class:`Channels <Channel>` are socket-like objects used for the actual transfer of data across the session. You may only request a channel after negotiating encryption (using - L{connect} or L{start_client}) and authenticating. + :class:`connect` or :class:`start_client`) and authenticating. - @param kind: the kind of channel requested (usually C{"session"}, - C{"forwarded-tcpip"}, C{"direct-tcpip"}, or C{"x11"}) - @type kind: str - @param dest_addr: the destination address of this port forwarding, - if C{kind} is C{"forwarded-tcpip"} or C{"direct-tcpip"} (ignored + :param kind: the kind of channel requested (usually ``"session"``, + ``"forwarded-tcpip"``, ``"direct-tcpip"``, or ``"x11"``) + :type kind: str + :param dest_addr: the destination address of this port forwarding, + if ``kind`` is ``"forwarded-tcpip"`` or ``"direct-tcpip"`` (ignored for other channel types) - @type dest_addr: (str, int) - @param src_addr: the source address of this port forwarding, if - C{kind} is C{"forwarded-tcpip"}, C{"direct-tcpip"}, or C{"x11"} - @type src_addr: (str, int) - @return: a new L{Channel} on success - @rtype: L{Channel} - - @raise SSHException: if the request is rejected or the session ends + :type dest_addr: (str, int) + :param src_addr: the source address of this port forwarding, if + ``kind`` is ``"forwarded-tcpip"``, ``"direct-tcpip"``, or ``"x11"`` + :type src_addr: (str, int) + :return: a new :class:`Channel` on success + :rtype: :class:`Channel` + + :raises SSHException: if the request is rejected or the session ends prematurely """ if not self.active: @@ -782,24 +782,24 @@ class Transport (threading.Thread): handler(channel, (origin_addr, origin_port), (server_addr, server_port)) - where C{server_addr} and C{server_port} are the address and port that + where ``server_addr`` and ``server_port`` are the address and port that the server was listening on. If no handler is set, the default behavior is to send new incoming forwarded connections into the accept queue, to be picked up via - L{accept}. + :class:`accept`. - @param address: the address to bind when forwarding - @type address: str - @param port: the port to forward, or 0 to ask the server to allocate + :param address: the address to bind when forwarding + :type address: str + :param port: the port to forward, or 0 to ask the server to allocate any port - @type port: int - @param handler: optional handler for incoming forwarded connections - @type handler: function(Channel, (str, int), (str, int)) - @return: the port # allocated by the server - @rtype: int + :type port: int + :param handler: optional handler for incoming forwarded connections + :type handler: function(Channel, (str, int), (str, int)) + :return: the port # allocated by the server + :rtype: int - @raise SSHException: if the server refused the TCP forward request + :raises SSHException: if the server refused the TCP forward request """ if not self.active: raise SSHException('SSH session not active') @@ -823,10 +823,10 @@ class Transport (threading.Thread): connections to the given address & port will be forwarded across this ssh connection. - @param address: the address to stop forwarding - @type address: str - @param port: the port to stop forwarding - @type port: int + :param address: the address to stop forwarding + :type address: str + :param port: the port to stop forwarding + :type port: int """ if not self.active: return @@ -839,9 +839,9 @@ class Transport (threading.Thread): an SFTP session will be opened with the remote host, and a new SFTPClient object will be returned. - @return: a new L{SFTPClient} object, referring to an sftp session + :return: a new :class:`SFTPClient` object, referring to an sftp session (channel) across this transport - @rtype: L{SFTPClient} + :rtype: :class:`SFTPClient` """ return SFTPClient.from_transport(self) @@ -852,9 +852,9 @@ class Transport (threading.Thread): also be used as a keep-alive for long lived connections traversing firewalls. - @param bytes: the number of random bytes to send in the payload of the + :param bytes: the number of random bytes to send in the payload of the ignored packet -- defaults to a random number from 10 to 41. - @type bytes: int + :type bytes: int """ m = Message() m.add_byte(chr(MSG_IGNORE)) @@ -872,7 +872,7 @@ class Transport (threading.Thread): traffic both ways as the two sides swap keys and do computations. This method returns when the session has switched to new keys. - @raise SSHException: if the key renegotiation failed (which causes the + :raises SSHException: if the key renegotiation failed (which causes the session to end) """ self.completion_event = threading.Event() @@ -891,13 +891,13 @@ class Transport (threading.Thread): def set_keepalive(self, interval): """ Turn on/off keepalive packets (default is off). If this is set, after - C{interval} seconds without sending any data over the connection, a + ``interval`` seconds without sending any data over the connection, a "keepalive" packet will be sent (and ignored by the remote host). This can be useful to keep connections alive over a NAT, for example. - @param interval: seconds to wait before sending a keepalive packet (or + :param interval: seconds to wait before sending a keepalive packet (or 0 to disable keepalives). - @type interval: int + :type interval: int """ self.packetizer.set_keepalive(interval, lambda x=weakref.proxy(self): x.global_request('keepalive@lag.net', wait=False)) @@ -907,18 +907,18 @@ class Transport (threading.Thread): Make a global request to the remote host. These are normally extensions to the SSH2 protocol. - @param kind: name of the request. - @type kind: str - @param data: an optional tuple containing additional data to attach + :param kind: name of the request. + :type kind: str + :param data: an optional tuple containing additional data to attach to the request. - @type data: tuple - @param wait: C{True} if this method should not return until a response - is received; C{False} otherwise. - @type wait: bool - @return: a L{Message} containing possible additional data if the - request was successful (or an empty L{Message} if C{wait} was - C{False}); C{None} if the request was denied. - @rtype: L{Message} + :type data: tuple + :param wait: ``True`` if this method should not return until a response + is received; ``False`` otherwise. + :type wait: bool + :return: a :class:`Message` containing possible additional data if the + request was successful (or an empty :class:`Message` if ``wait`` was + ``False``); ``None`` if the request was denied. + :rtype: :class:`Message` """ if wait: self.completion_event = threading.Event() @@ -943,14 +943,14 @@ class Transport (threading.Thread): def accept(self, timeout=None): """ Return the next channel opened by the client over this transport, in - server mode. If no channel is opened before the given timeout, C{None} + server mode. If no channel is opened before the given timeout, ``None`` is returned. - @param timeout: seconds to wait for a channel, or C{None} to wait + :param timeout: seconds to wait for a channel, or ``None`` to wait forever - @type timeout: int - @return: a new Channel opened by the client - @rtype: L{Channel} + :type timeout: int + :return: a new Channel opened by the client + :rtype: :class:`Channel` """ self.lock.acquire() try: @@ -971,34 +971,34 @@ class Transport (threading.Thread): """ Negotiate an SSH2 session, and optionally verify the server's host key and authenticate using a password or private key. This is a shortcut - for L{start_client}, L{get_remote_server_key}, and - L{Transport.auth_password} or L{Transport.auth_publickey}. Use those + for :class:`start_client`, :class:`get_remote_server_key`, and + :class:`Transport.auth_password` or :class:`Transport.auth_publickey`. Use those methods if you want more control. You can use this method immediately after creating a Transport to negotiate encryption with a server. If it fails, an exception will be thrown. On success, the method will return cleanly, and an encrypted - session exists. You may immediately call L{open_channel} or - L{open_session} to get a L{Channel} object, which is used for data + session exists. You may immediately call :class:`open_channel` or + :class:`open_session` to get a :class:`Channel` object, which is used for data transfer. - @note: If you fail to supply a password or private key, this method may - succeed, but a subsequent L{open_channel} or L{open_session} call may + .. note:: If you fail to supply a password or private key, this method may + succeed, but a subsequent :class:`open_channel` or :class:`open_session` call may fail because you haven't authenticated yet. - @param hostkey: the host key expected from the server, or C{None} if + :param hostkey: the host key expected from the server, or ``None`` if you don't want to do host key verification. - @type hostkey: L{PKey<pkey.PKey>} - @param username: the username to authenticate as. - @type username: str - @param password: a password to use for authentication, if you want to - use password authentication; otherwise C{None}. - @type password: str - @param pkey: a private key to use for authentication, if you want to - use private key authentication; otherwise C{None}. - @type pkey: L{PKey<pkey.PKey>} - - @raise SSHException: if the SSH2 negotiation fails, the host key + :type hostkey: :class:`PKey<pkey.PKey>` + :param username: the username to authenticate as. + :type username: str + :param password: a password to use for authentication, if you want to + use password authentication; otherwise ``None``. + :type password: str + :param pkey: a private key to use for authentication, if you want to + use private key authentication; otherwise ``None``. + :type pkey: :class:`PKey<pkey.PKey>` + + :raises SSHException: if the SSH2 negotiation fails, the host key supplied by the server is incorrect, or authentication fails. """ if hostkey is not None: @@ -1030,13 +1030,13 @@ class Transport (threading.Thread): """ Return any exception that happened during the last server request. This can be used to fetch more specific error information after using - calls like L{start_client}. The exception (if any) is cleared after + calls like :class:`start_client`. The exception (if any) is cleared after this call. - @return: an exception, or C{None} if there is no stored exception. - @rtype: Exception + :return: an exception, or ``None`` if there is no stored exception. + :rtype: Exception - @since: 1.1 + .. versionadded:: 1.1 """ self.lock.acquire() try: @@ -1050,17 +1050,17 @@ class Transport (threading.Thread): """ Set the handler class for a subsystem in server mode. If a request for this subsystem is made on an open ssh channel later, this handler - will be constructed and called -- see L{SubsystemHandler} for more + will be constructed and called -- see :class:`SubsystemHandler` for more detailed documentation. Any extra parameters (including keyword arguments) are saved and - passed to the L{SubsystemHandler} constructor later. + passed to the :class:`SubsystemHandler` constructor later. - @param name: name of the subsystem. - @type name: str - @param handler: subclass of L{SubsystemHandler} that handles this + :param name: name of the subsystem. + :type name: str + :param handler: subclass of :class:`SubsystemHandler` that handles this subsystem. - @type handler: class + :type handler: class """ try: self.lock.acquire() @@ -1072,10 +1072,10 @@ class Transport (threading.Thread): """ Return true if this session is active and authenticated. - @return: True if the session is still open and has been authenticated + :return: True if the session is still open and has been authenticated successfully; False if authentication failed and/or the session is closed. - @rtype: bool + :rtype: bool """ return self.active and (self.auth_handler is not None) and self.auth_handler.is_authenticated() @@ -1083,10 +1083,10 @@ class Transport (threading.Thread): """ Return the username this connection is authenticated for. If the session is not authenticated (or authentication failed), this method - returns C{None}. + returns ``None``. - @return: username that was authenticated, or C{None}. - @rtype: string + :return: username that was authenticated, or ``None``. + :rtype: string """ if not self.active or (self.auth_handler is None): return None @@ -1097,20 +1097,20 @@ class Transport (threading.Thread): Try to authenticate to the server using no authentication at all. This will almost always fail. It may be useful for determining the list of authentication types supported by the server, by catching the - L{BadAuthenticationType} exception raised. + :class:`BadAuthenticationType` exception raised. - @param username: the username to authenticate as - @type username: string - @return: list of auth types permissible for the next stage of + :param username: the username to authenticate as + :type username: string + :return: list of auth types permissible for the next stage of authentication (normally empty) - @rtype: list + :rtype: list - @raise BadAuthenticationType: if "none" authentication isn't allowed + :raises BadAuthenticationType: if "none" authentication isn't allowed by the server for this user - @raise SSHException: if the authentication failed due to a network + :raises SSHException: if the authentication failed due to a network error - @since: 1.5 + .. versionadded:: 1.5 """ if (not self.active) or (not self.initial_kex_done): raise SSHException('No existing session') @@ -1124,16 +1124,16 @@ class Transport (threading.Thread): Authenticate to the server using a password. The username and password are sent over an encrypted link. - If an C{event} is passed in, this method will return immediately, and + If an ``event`` is passed in, this method will return immediately, and the event will be triggered once authentication succeeds or fails. On - success, L{is_authenticated} will return C{True}. On failure, you may - use L{get_exception} to get more detailed error information. + success, :class:`is_authenticated` will return ``True``. On failure, you may + use :class:`get_exception` to get more detailed error information. Since 1.1, if no event is passed, this method will block until the authentication succeeds or fails. On failure, an exception is raised. Otherwise, the method simply returns. - Since 1.5, if no event is passed and C{fallback} is C{True} (the + Since 1.5, if no event is passed and ``fallback`` is ``True`` (the default), if the server doesn't support plain password authentication but does support so-called "keyboard-interactive" mode, an attempt will be made to authenticate using this interactive mode. If it fails, @@ -1146,26 +1146,26 @@ class Transport (threading.Thread): this method will return a list of auth types permissible for the next step. Otherwise, in the normal case, an empty list is returned. - @param username: the username to authenticate as - @type username: str - @param password: the password to authenticate with - @type password: str or unicode - @param event: an event to trigger when the authentication attempt is + :param username: the username to authenticate as + :type username: str + :param password: the password to authenticate with + :type password: str or unicode + :param event: an event to trigger when the authentication attempt is complete (whether it was successful or not) - @type event: threading.Event - @param fallback: C{True} if an attempt at an automated "interactive" + :type event: threading.Event + :param fallback: ``True`` if an attempt at an automated "interactive" password auth should be made if the server doesn't support normal password auth - @type fallback: bool - @return: list of auth types permissible for the next stage of + :type fallback: bool + :return: list of auth types permissible for the next stage of authentication (normally empty) - @rtype: list + :rtype: list - @raise BadAuthenticationType: if password authentication isn't + :raises BadAuthenticationType: if password authentication isn't allowed by the server for this user (and no event was passed in) - @raise AuthenticationException: if the authentication failed (and no + :raises AuthenticationException: if the authentication failed (and no event was passed in) - @raise SSHException: if there was a network error + :raises SSHException: if there was a network error """ if (not self.active) or (not self.initial_kex_done): # we should never try to send the password unless we're on a secure link @@ -1207,10 +1207,10 @@ class Transport (threading.Thread): Authenticate to the server using a private key. The key is used to sign data from the server, so it must include the private part. - If an C{event} is passed in, this method will return immediately, and + If an ``event`` is passed in, this method will return immediately, and the event will be triggered once authentication succeeds or fails. On - success, L{is_authenticated} will return C{True}. On failure, you may - use L{get_exception} to get more detailed error information. + success, :class:`is_authenticated` will return ``True``. On failure, you may + use :class:`get_exception` to get more detailed error information. Since 1.1, if no event is passed, this method will block until the authentication succeeds or fails. On failure, an exception is raised. @@ -1220,22 +1220,22 @@ class Transport (threading.Thread): this method will return a list of auth types permissible for the next step. Otherwise, in the normal case, an empty list is returned. - @param username: the username to authenticate as - @type username: string - @param key: the private key to authenticate with - @type key: L{PKey <pkey.PKey>} - @param event: an event to trigger when the authentication attempt is + :param username: the username to authenticate as + :type username: string + :param key: the private key to authenticate with + :type key: :class:`PKey <pkey.PKey>` + :param event: an event to trigger when the authentication attempt is complete (whether it was successful or not) - @type event: threading.Event - @return: list of auth types permissible for the next stage of + :type event: threading.Event + :return: list of auth types permissible for the next stage of authentication (normally empty) - @rtype: list + :rtype: list - @raise BadAuthenticationType: if public-key authentication isn't + :raises BadAuthenticationType: if public-key authentication isn't allowed by the server for this user (and no event was passed in) - @raise AuthenticationException: if the authentication failed (and no + :raises AuthenticationException: if the authentication failed (and no event was passed in) - @raise SSHException: if there was a network error + :raises SSHException: if there was a network error """ if (not self.active) or (not self.initial_kex_done): # we should never try to authenticate unless we're on a secure link @@ -1263,15 +1263,15 @@ class Transport (threading.Thread): if the server continues to ask questions. The handler is expected to be a callable that will handle calls of the - form: C{handler(title, instructions, prompt_list)}. The C{title} is - meant to be a dialog-window title, and the C{instructions} are user - instructions (both are strings). C{prompt_list} will be a list of - prompts, each prompt being a tuple of C{(str, bool)}. The string is + form: ``handler(title, instructions, prompt_list)``. The ``title`` is + meant to be a dialog-window title, and the ``instructions`` are user + instructions (both are strings). ``prompt_list`` will be a list of + prompts, each prompt being a tuple of ``(str, bool)``. The string is the prompt and the boolean indicates whether the user text should be echoed. A sample call would thus be: - C{handler('title', 'instructions', [('Password:', False)])}. + ``handler('title', 'instructions', [('Password:', False)])``. The handler should return a list or tuple of answers to the server's questions. @@ -1280,22 +1280,22 @@ class Transport (threading.Thread): this method will return a list of auth types permissible for the next step. Otherwise, in the normal case, an empty list is returned. - @param username: the username to authenticate as - @type username: string - @param handler: a handler for responding to server questions - @type handler: callable - @param submethods: a string list of desired submethods (optional) - @type submethods: str - @return: list of auth types permissible for the next stage of + :param username: the username to authenticate as + :type username: string + :param handler: a handler for responding to server questions + :type handler: callable + :param submethods: a string list of desired submethods (optional) + :type submethods: str + :return: list of auth types permissible for the next stage of authentication (normally empty). - @rtype: list + :rtype: list - @raise BadAuthenticationType: if public-key authentication isn't + :raises BadAuthenticationType: if public-key authentication isn't allowed by the server for this user - @raise AuthenticationException: if the authentication failed - @raise SSHException: if there was a network error + :raises AuthenticationException: if the authentication failed + :raises SSHException: if there was a network error - @since: 1.5 + .. versionadded:: 1.5 """ if (not self.active) or (not self.initial_kex_done): # we should never try to authenticate unless we're on a secure link @@ -1308,14 +1308,14 @@ class Transport (threading.Thread): def set_log_channel(self, name): """ Set the channel for this transport's logging. The default is - C{"paramiko.transport"} but it can be set to anything you want. - (See the C{logging} module for more info.) SSH Channels will log + ``"paramiko.transport"`` but it can be set to anything you want. + (See the ``logging`` module for more info.) SSH Channels will log to a sub-channel of the one specified. - @param name: new channel name for logging - @type name: str + :param name: new channel name for logging + :type name: str - @since: 1.1 + .. versionadded:: 1.1 """ self.log_name = name self.logger = util.get_logger(name) @@ -1325,10 +1325,10 @@ class Transport (threading.Thread): """ Return the channel name used for this transport's logging. - @return: channel name. - @rtype: str + :return: channel name. + :rtype: str - @since: 1.2 + .. versionadded:: 1.2 """ return self.log_name @@ -1338,35 +1338,35 @@ class Transport (threading.Thread): the logs. Normally you would want this off (which is the default), but if you are debugging something, it may be useful. - @param hexdump: C{True} to log protocol traffix (in hex) to the log; - C{False} otherwise. - @type hexdump: bool + :param hexdump: ``True`` to log protocol traffix (in hex) to the log; + ``False`` otherwise. + :type hexdump: bool """ self.packetizer.set_hexdump(hexdump) def get_hexdump(self): """ - Return C{True} if the transport is currently logging hex dumps of + Return ``True`` if the transport is currently logging hex dumps of protocol traffic. - @return: C{True} if hex dumps are being logged - @rtype: bool + :return: ``True`` if hex dumps are being logged + :rtype: bool - @since: 1.4 + .. versionadded:: 1.4 """ return self.packetizer.get_hexdump() def use_compression(self, compress=True): """ Turn on/off compression. This will only have an affect before starting - the transport (ie before calling L{connect}, etc). By default, + the transport (ie before calling :class:`connect`, etc). By default, compression is off since it negatively affects interactive sessions. - @param compress: C{True} to ask the remote client/server to compress - traffic; C{False} to refuse compression - @type compress: bool + :param compress: ``True`` to ask the remote client/server to compress + traffic; ``False`` to refuse compression + :type compress: bool - @since: 1.5.2 + .. versionadded:: 1.5.2 """ if compress: self._preferred_compression = ( 'zlib@openssh.com', 'zlib', 'none' ) @@ -1376,12 +1376,12 @@ class Transport (threading.Thread): def getpeername(self): """ Return the address of the remote side of this Transport, if possible. - This is effectively a wrapper around C{'getpeername'} on the underlying - socket. If the socket-like object has no C{'getpeername'} method, - then C{("unknown", 0)} is returned. + This is effectively a wrapper around ``'getpeername'`` on the underlying + socket. If the socket-like object has no ``'getpeername'`` method, + then ``("unknown", 0)`` is returned. - @return: the address if the remote host, if known - @rtype: tuple(str, int) + :return: the address if the remote host, if known + :rtype: tuple(str, int) """ gp = getattr(self.sock, 'getpeername', None) if gp is None: diff --git a/paramiko/util.py b/paramiko/util.py index 9db512de..a0f4b429 100644 --- a/paramiko/util.py +++ b/paramiko/util.py @@ -154,17 +154,17 @@ def generate_key_bytes(hashclass, salt, key, nbytes): through a secure hash into some keyworthy bytes. This specific algorithm is used for encrypting/decrypting private key files. - @param hashclass: class from L{Crypto.Hash} that can be used as a secure - hashing function (like C{MD5} or C{SHA}). - @type hashclass: L{Crypto.Hash} - @param salt: data to salt the hash with. - @type salt: string - @param key: human-entered password or passphrase. - @type key: string - @param nbytes: number of bytes to generate. - @type nbytes: int - @return: key data - @rtype: string + :param hashclass: class from :class:`Crypto.Hash` that can be used as a secure + hashing function (like ``MD5`` or ``SHA``). + :type hashclass: :class:`Crypto.Hash` + :param salt: data to salt the hash with. + :type salt: string + :param key: human-entered password or passphrase. + :type key: string + :param nbytes: number of bytes to generate. + :type nbytes: int + :return: key data + :rtype: string """ keydata = '' digest = '' @@ -185,26 +185,26 @@ def generate_key_bytes(hashclass, salt, key, nbytes): def load_host_keys(filename): """ Read a file of known SSH host keys, in the format used by openssh, and - return a compound dict of C{hostname -> keytype ->} L{PKey <paramiko.pkey.PKey>}. + return a compound dict of ``hostname -> keytype ->`` :class:`PKey <paramiko.pkey.PKey>`. The hostname may be an IP address or DNS name. The keytype will be either - C{"ssh-rsa"} or C{"ssh-dss"}. + ``"ssh-rsa"`` or ``"ssh-dss"``. This type of file unfortunately doesn't exist on Windows, but on posix, - it will usually be stored in C{os.path.expanduser("~/.ssh/known_hosts")}. + it will usually be stored in ``os.path.expanduser("~/.ssh/known_hosts")``. - Since 1.5.3, this is just a wrapper around L{HostKeys}. + Since 1.5.3, this is just a wrapper around :class:`HostKeys`. - @param filename: name of the file to read host keys from - @type filename: str - @return: dict of host keys, indexed by hostname and then keytype - @rtype: dict(hostname, dict(keytype, L{PKey <paramiko.pkey.PKey>})) + :param filename: name of the file to read host keys from + :type filename: str + :return: dict of host keys, indexed by hostname and then keytype + :rtype: dict(hostname, dict(keytype, :class:`PKey <paramiko.pkey.PKey>`)) """ from paramiko.hostkeys import HostKeys return HostKeys(filename) def parse_ssh_config(file_obj): """ - Provided only as a backward-compatible wrapper around L{SSHConfig}. + Provided only as a backward-compatible wrapper around :class:`SSHConfig`. """ config = SSHConfig() config.parse(file_obj) @@ -212,7 +212,7 @@ def parse_ssh_config(file_obj): def lookup_ssh_host_config(hostname, config): """ - Provided only as a backward-compatible wrapper around L{SSHConfig}. + Provided only as a backward-compatible wrapper around :class:`SSHConfig`. """ return config.lookup(hostname) diff --git a/sites/docs/api.rst b/sites/docs/api.rst new file mode 100644 index 00000000..47615709 --- /dev/null +++ b/sites/docs/api.rst @@ -0,0 +1,8 @@ +.. _api: + +API +=== + +.. automodule:: paramiko + :members: + :special-members: diff --git a/sites/docs/conf.py b/sites/docs/conf.py index 0c7ffe55..94267f0a 100644 --- a/sites/docs/conf.py +++ b/sites/docs/conf.py @@ -1,4 +1,7 @@ # Obtain shared config values import os, sys sys.path.append(os.path.abspath('..')) +sys.path.append(os.path.abspath('../..')) from shared_conf import * + +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx'] diff --git a/sites/docs/index.rst b/sites/docs/index.rst index 08b34320..7ec5825e 100644 --- a/sites/docs/index.rst +++ b/sites/docs/index.rst @@ -4,3 +4,6 @@ Welcome to Paramiko's documentation! This site covers Paramiko's usage & API documentation. For basic info on what Paramiko is, including its public changelog & how the project is maintained, please see `the main website <http://paramiko.org>`_. + +.. toctree:: + api |