74 lines
1.9 KiB
ReStructuredText
74 lines
1.9 KiB
ReStructuredText
====================================
|
|
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>`_.
|
|
|
|
|
|
API documentation
|
|
=================
|
|
|
|
The high-level client API starts with creation of an `.SSHClient` object. For
|
|
more direct control, pass a socket (or socket-like object) to a `.Transport`,
|
|
and use `start_server <.Transport.start_server>` or `start_client
|
|
<.Transport.start_client>` to negotiate 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. (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 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 `channels
|
|
<.Channel>` to the other side, which are Python objects that act like sockets,
|
|
but send and receive data over the encrypted session.
|
|
|
|
For details, please see the following tables of contents (which are organized
|
|
by area of interest.)
|
|
|
|
|
|
Core SSH protocol classes
|
|
-------------------------
|
|
|
|
.. toctree::
|
|
api/channel
|
|
api/client
|
|
api/message
|
|
api/packet
|
|
api/transport
|
|
|
|
|
|
Authentication & keys
|
|
---------------------
|
|
|
|
.. toctree::
|
|
api/agent
|
|
api/hostkeys
|
|
api/keys
|
|
api/win_pageant
|
|
|
|
|
|
Other primary functions
|
|
-----------------------
|
|
|
|
.. toctree::
|
|
api/config
|
|
api/proxy
|
|
api/server
|
|
api/sftp
|
|
|
|
|
|
Miscellany
|
|
----------
|
|
|
|
.. toctree::
|
|
api/buffered_pipe
|
|
api/file
|
|
api/pipe
|
|
api/ssh_exception
|