summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2014-02-24 17:21:12 -0800
committerJeff Forcier <jeff@bitprophet.org>2014-02-24 17:21:12 -0800
commit0bf0f08ee46aa210bd820e40a67648a34ba85cd6 (patch)
treeb79daed8fd514af6cd4bade9ee7d4e714df72ee2
parenta00316af157a8b798b47b8ab1336d5b1a878d3ed (diff)
downloadparamiko-0bf0f08ee46aa210bd820e40a67648a34ba85cd6.tar.gz
Reformat + fix links
-rw-r--r--paramiko/transport.py38
1 files changed, 20 insertions, 18 deletions
diff --git a/paramiko/transport.py b/paramiko/transport.py
index dc493746..060012f3 100644
--- a/paramiko/transport.py
+++ b/paramiko/transport.py
@@ -360,27 +360,29 @@ class Transport (threading.Thread):
Otherwise an SSHException is raised.
After a successful negotiation, the client will need to authenticate.
- Override the methods
- `get_allowed_auths <ServerInterface.get_allowed_auths>`,
- `check_auth_none <ServerInterface.check_auth_none>`,
- `check_auth_password <ServerInterface.check_auth_password>`, and
- `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
- `check_channel_request <ServerInterface.check_channel_request>` in the
- given ``server`` object to allow channels to be opened.
-
- .. note:: After calling this method (or `start_client` or `connect`),
- you should no longer directly read from or write to the original
- socket object.
+ Override the methods `get_allowed_auths
+ <.ServerInterface.get_allowed_auths>`, `check_auth_none
+ <.ServerInterface.check_auth_none>`, `check_auth_password
+ <.ServerInterface.check_auth_password>`, and `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 `check_channel_request
+ <.ServerInterface.check_channel_request>` in the given ``server``
+ object to allow channels to be opened.
+
+ .. note::
+ After calling this method (or `start_client` or `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
- `channels <Channel>`
- :type server: `server.ServerInterface`
+ :param server:
+ an object used to perform authentication and create `channels
+ <.Channel>`
+ :type server: `.ServerInterface`
:raises SSHException: if negotiation fails (and no ``event`` was passed
in)