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

151 lines
6.2 KiB
Plaintext
Raw Normal View History

[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-22] fix MANIFEST.in, change version numbers to 0.9-doduo, fix LPGL notices fixed MANIFEST.in to include the demo scripts, LICENSE, and ChangeLog. upped everything to version 0.9-doduo. fixed the copyright notice, and added the LGPL banner to the top of every python file.
2004-01-04 05:26:00 -05:00
paramiko 0.9
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-56] add forward.py demo script; bump to gyarados add a demo script to show how to do local port forwarding. add gyarados to all the docs and bump the version number everywhere.
2004-05-31 19:48:10 -04:00
"gyarados" release, 31 may 2004
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--base-0] initial import (automatically generated log message)
2003-11-04 03:34:24 -05:00
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-22] fix MANIFEST.in, change version numbers to 0.9-doduo, fix LPGL notices fixed MANIFEST.in to include the demo scripts, LICENSE, and ChangeLog. upped everything to version 0.9-doduo. fixed the copyright notice, and added the LGPL banner to the top of every python file.
2004-01-04 05:26:00 -05:00
Copyright (c) 2003-2004 Robey Pointer <robey@lag.net>
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--base-0] initial import (automatically generated log message)
2003-11-04 03:34:24 -05:00
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-9] rename secsh -> paramiko also, rename SecshException back to SSHException. sigh. :)
2003-11-10 03:49:50 -05:00
http://www.lag.net/~robey/paramiko/
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--base-0] initial import (automatically generated log message)
2003-11-04 03:34:24 -05:00
*** WHAT
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-9] rename secsh -> paramiko also, rename SecshException back to SSHException. sigh. :)
2003-11-10 03:49:50 -05:00
"paramiko" is a combination of the esperanto words for "paranoid" and "friend".
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-42] support py22, more or less add roger binns' patches for supporting python 2.2. i hedged a bit on the logging stuff and just added some trickery to let logging be stubbed out for python 2.2. this changed a lot of import statements but i managed to avoid hacking at any of the existing logging. socket timeouts are required for the threads to notice when they've been deactivated. worked around it by using the 'select' module on py22. also fixed the sftp unit tests to cope with a password-protected private key.
2004-04-06 04:16:02 -04:00
it's a module for python 2.2+ that implements the SSH2 protocol for secure
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--base-0] initial import (automatically generated log message)
2003-11-04 03:34:24 -05:00
(encrypted and authenticated) connections to remote machines. unlike SSL (aka
TLS), SSH2 protocol does not require heirarchical certificates signed by a
powerful central authority. you may know SSH2 as the protocol that 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 the
encrypted tunnel (this is how sftp works, for example).
it is written entirely in python (no C or platform-dependent code) and is
released under the GNU LGPL (lesser GPL).
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-20] more docs, and password-protected key files can now be read lots more documentation, some of it moved out of the README file, which is now much smaller and less rambling. repr(Transport) now reports the number of bits used in the cipher. cleaned up BER to use util functions, and throw a proper exception (the new BERException) on error. it doesn't ever have to be a full BER decoder, but it can at least comb its hair and tuck in its shirt. lots of stuff added to PKey.read_private_key_file so it can try to decode password-protected key files. right now it only understands "DES-EDE3-CBC" format, but this is the only format i've seen openssh make so far. if the key is password-protected, but no password was given, a new exception (PasswordRequiredException) is raised so an outer layer can ask for a password and try again.
2004-01-04 04:29:13 -05:00
the package and its API is fairly well documented in the "doc/" folder that
should have come with this archive.
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--base-0] initial import (automatically generated log message)
2003-11-04 03:34:24 -05:00
*** REQUIREMENTS
python 2.3 <http://www.python.org/>
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-42] support py22, more or less add roger binns' patches for supporting python 2.2. i hedged a bit on the logging stuff and just added some trickery to let logging be stubbed out for python 2.2. this changed a lot of import statements but i managed to avoid hacking at any of the existing logging. socket timeouts are required for the threads to notice when they've been deactivated. worked around it by using the 'select' module on py22. also fixed the sftp unit tests to cope with a password-protected private key.
2004-04-06 04:16:02 -04:00
(python 2.2 may work with some pain)
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-20] more docs, and password-protected key files can now be read lots more documentation, some of it moved out of the README file, which is now much smaller and less rambling. repr(Transport) now reports the number of bits used in the cipher. cleaned up BER to use util functions, and throw a proper exception (the new BERException) on error. it doesn't ever have to be a full BER decoder, but it can at least comb its hair and tuck in its shirt. lots of stuff added to PKey.read_private_key_file so it can try to decode password-protected key files. right now it only understands "DES-EDE3-CBC" format, but this is the only format i've seen openssh make so far. if the key is password-protected, but no password was given, a new exception (PasswordRequiredException) is raised so an outer layer can ask for a password and try again.
2004-01-04 04:29:13 -05:00
pyCrypt <http://www.amk.ca/python/code/crypto.html>
PyCrypt compiled for Win32 can be downloaded from the HashTar homepage:
http://nitace.bsd.uchicago.edu:8080/hashtar
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-48] set version number to fearow set version number to fearow.
2004-04-08 01:48:16 -04:00
you can also build it yourself using the free MinGW tools and this command
line (thanks to Roger Binns for the info):
python setup.py build --compiler=mingw32 bdist_wininst
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--base-0] initial import (automatically generated log message)
2003-11-04 03:34:24 -05:00
*** PORTABILITY
i code and test this library on Linux and MacOS X. for that reason, i'm
pretty sure that it works for all posix platforms, including MacOS. i also
think it will work on Windows, though i've never tested it there. if you
run into Windows problems, send me a patch: portability is important to me.
the Channel object supports a "fileno()" call so that it can be passed into
select or poll, for polling on posix. once you call "fileno()" on a Channel,
it changes behavior in some fundamental ways, and these ways require posix.
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-20] more docs, and password-protected key files can now be read lots more documentation, some of it moved out of the README file, which is now much smaller and less rambling. repr(Transport) now reports the number of bits used in the cipher. cleaned up BER to use util functions, and throw a proper exception (the new BERException) on error. it doesn't ever have to be a full BER decoder, but it can at least comb its hair and tuck in its shirt. lots of stuff added to PKey.read_private_key_file so it can try to decode password-protected key files. right now it only understands "DES-EDE3-CBC" format, but this is the only format i've seen openssh make so far. if the key is password-protected, but no password was given, a new exception (PasswordRequiredException) is raised so an outer layer can ask for a password and try again.
2004-01-04 04:29:13 -05:00
so don't call "fileno()" on a Channel on Windows. this is detailed in the
documentation for the "fileno" method.
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--base-0] initial import (automatically generated log message)
2003-11-04 03:34:24 -05:00
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-42] support py22, more or less add roger binns' patches for supporting python 2.2. i hedged a bit on the logging stuff and just added some trickery to let logging be stubbed out for python 2.2. this changed a lot of import statements but i managed to avoid hacking at any of the existing logging. socket timeouts are required for the threads to notice when they've been deactivated. worked around it by using the 'select' module on py22. also fixed the sftp unit tests to cope with a password-protected private key.
2004-04-06 04:16:02 -04:00
python 2.2 may work, thanks to some patches from Roger Binns. things to watch
out for:
* sockets in 2.2 don't support timeouts, so the 'select' module is imported
to do polling. this may not work on windows. (works fine on osx.)
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-46] README update notes added notes on what's new, what to watch out for in py22. added a "since: fearow" to all the relevant API calls that are new.
2004-04-07 12:05:48 -04:00
* logging is mostly stubbed out. it works just enough to let paramiko create
log files for debugging, if you want them. to get real logging, you can
backport python 2.3's logging package. Roger has done that already:
http://sourceforge.net/project/showfiles.php?group_id=75211&package_id=113804
you really should upgrade to python 2.3. laziness is no excuse! :)
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-42] support py22, more or less add roger binns' patches for supporting python 2.2. i hedged a bit on the logging stuff and just added some trickery to let logging be stubbed out for python 2.2. this changed a lot of import statements but i managed to avoid hacking at any of the existing logging. socket timeouts are required for the threads to notice when they've been deactivated. worked around it by using the 'select' module on py22. also fixed the sftp unit tests to cope with a password-protected private key.
2004-04-06 04:16:02 -04:00
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-53] add note about utf8 encodings add info to the README about what to do if python complains about missing encodings. veleriy pogrebitskiy ran into this and had advice.
2004-05-29 14:48:23 -04:00
some python distributions don't include the utf-8 string encodings, for reasons
of space (misdirected as that is). if your distribution is missing encodings,
you'll see an error like this:
LookupError: no codec search functions registered: can't find encoding
this means you need to copy string encodings over from a working system.
(it probably only happens on embedded systems, not normal python installls.)
Valeriy Pogrebitskiy says the best place to look is
'.../lib/python*/encodings/__init__.py'.
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--base-0] initial import (automatically generated log message)
2003-11-04 03:34:24 -05:00
*** DEMO
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-8] doc changes
2003-11-10 01:52:35 -05:00
the demo client (demo.py) is a raw implementation of the normal 'ssh' CLI tool.
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-9] rename secsh -> paramiko also, rename SecshException back to SSHException. sigh. :)
2003-11-10 03:49:50 -05:00
while the paramiko library should work on all platforms, the demo app will only
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--base-0] initial import (automatically generated log message)
2003-11-04 03:34:24 -05:00
run on posix, because it uses select.
you can run demo.py with no arguments, or you can give a hostname (or
username@hostname) on the command line. if you don't, it'll prompt you for
a hostname and username. if you have an ".ssh/" folder, it will try to read
the host keys from there, though it's easily confused. you can choose to
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-20] more docs, and password-protected key files can now be read lots more documentation, some of it moved out of the README file, which is now much smaller and less rambling. repr(Transport) now reports the number of bits used in the cipher. cleaned up BER to use util functions, and throw a proper exception (the new BERException) on error. it doesn't ever have to be a full BER decoder, but it can at least comb its hair and tuck in its shirt. lots of stuff added to PKey.read_private_key_file so it can try to decode password-protected key files. right now it only understands "DES-EDE3-CBC" format, but this is the only format i've seen openssh make so far. if the key is password-protected, but no password was given, a new exception (PasswordRequiredException) is raised so an outer layer can ask for a password and try again.
2004-01-04 04:29:13 -05:00
authenticate with a password, or with an RSA or DSS key.
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--base-0] initial import (automatically generated log message)
2003-11-04 03:34:24 -05:00
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-9] rename secsh -> paramiko also, rename SecshException back to SSHException. sigh. :)
2003-11-10 03:49:50 -05:00
the demo app leaves a logfile called "demo.log" so you can see what paramiko
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--base-0] initial import (automatically generated log message)
2003-11-04 03:34:24 -05:00
logs as it works. but the most interesting part is probably the code itself,
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-9] rename secsh -> paramiko also, rename SecshException back to SSHException. sigh. :)
2003-11-10 03:49:50 -05:00
which hopefully demonstrates how you can use the paramiko library.
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--base-0] initial import (automatically generated log message)
2003-11-04 03:34:24 -05:00
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-20] more docs, and password-protected key files can now be read lots more documentation, some of it moved out of the README file, which is now much smaller and less rambling. repr(Transport) now reports the number of bits used in the cipher. cleaned up BER to use util functions, and throw a proper exception (the new BERException) on error. it doesn't ever have to be a full BER decoder, but it can at least comb its hair and tuck in its shirt. lots of stuff added to PKey.read_private_key_file so it can try to decode password-protected key files. right now it only understands "DES-EDE3-CBC" format, but this is the only format i've seen openssh make so far. if the key is password-protected, but no password was given, a new exception (PasswordRequiredException) is raised so an outer layer can ask for a password and try again.
2004-01-04 04:29:13 -05:00
a simpler example is in demo_simple.py, which is a copy of the demo client
that uses the simpler "connect" method call (new with 0.9-doduo).
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-8] doc changes
2003-11-10 01:52:35 -05:00
there's also now a demo server (demo_server.py) which listens on port 2200
and accepts a login (robey/foo) and pretends to be a BBS, just to demonstrate
how to perform the server side of things.
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--base-0] initial import (automatically generated log message)
2003-11-04 03:34:24 -05:00
*** USE
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-20] more docs, and password-protected key files can now be read lots more documentation, some of it moved out of the README file, which is now much smaller and less rambling. repr(Transport) now reports the number of bits used in the cipher. cleaned up BER to use util functions, and throw a proper exception (the new BERException) on error. it doesn't ever have to be a full BER decoder, but it can at least comb its hair and tuck in its shirt. lots of stuff added to PKey.read_private_key_file so it can try to decode password-protected key files. right now it only understands "DES-EDE3-CBC" format, but this is the only format i've seen openssh make so far. if the key is password-protected, but no password was given, a new exception (PasswordRequiredException) is raised so an outer layer can ask for a password and try again.
2004-01-04 04:29:13 -05:00
the demo clients (demo.py & demo_simple.py) and the demo server
(demo_server.py) are probably the best example of how to use this package.
there is also a lot of documentation, generated with epydoc, in the doc/
folder. point your browser there. seriously, do it. mad props to epydoc,
which actually motivated me to write more documentation than i ever would
have before.
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-8] doc changes
2003-11-10 01:52:35 -05:00
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-31] bump version number to eevee bump the version number to eevee in a few places and talk about the unit tests.
2004-03-08 12:52:25 -05:00
there are also unit tests here:
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-42] support py22, more or less add roger binns' patches for supporting python 2.2. i hedged a bit on the logging stuff and just added some trickery to let logging be stubbed out for python 2.2. this changed a lot of import statements but i managed to avoid hacking at any of the existing logging. socket timeouts are required for the threads to notice when they've been deactivated. worked around it by using the 'select' module on py22. also fixed the sftp unit tests to cope with a password-protected private key.
2004-04-06 04:16:02 -04:00
$ python ./test.py
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-31] bump version number to eevee bump the version number to eevee in a few places and talk about the unit tests.
2004-03-08 12:52:25 -05:00
which will verify that some of the core components are working correctly.
not much is tested yet, but it's a start. the tests for SFTP are probably
the best and easiest examples of how to use the SFTP class.
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--base-0] initial import (automatically generated log message)
2003-11-04 03:34:24 -05:00
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-46] README update notes added notes on what's new, what to watch out for in py22. added a "since: fearow" to all the relevant API calls that are new.
2004-04-07 12:05:48 -04:00
*** WHAT'S NEW
highlights of what's new in each release:
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-56] add forward.py demo script; bump to gyarados add a demo script to show how to do local port forwarding. add gyarados to all the docs and bump the version number everywhere.
2004-05-31 19:48:10 -04:00
v0.9 GYARADOS
* Transport.open_channel() -- supports local & remote port forwarding now
* now imports UTF-8 encodings explicitly as a hint to "freeze" utilities
* no longer rejects older SFTP servers
* default packet size bumped to 8kB
* fixed deadlock in closing a channel
* Transport.connect() -- fixed bug where it would always fail when given a
host key to verify
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-46] README update notes added notes on what's new, what to watch out for in py22. added a "since: fearow" to all the relevant API calls that are new.
2004-04-07 12:05:48 -04:00
v0.9 FEAROW
* Transport.send_ignore() -- send random ignored bytes
* RSAKey/DSSKey added from_private_key_file() as a factory constructor;
write_private_key_file() & generate() to create and save ssh2 keys;
get_base64() to retrieve the exported public key
* Transport added global_request() [client] and check_global_request() [server]
* Transport.get_remove_server_key() now returns a PKey object instead of a
tuple of strings
* Transport.get_username() -- return the username you auth'd as [client]
* Transport.set_keepalive() -- makes paramiko send periodic junk packets to the
remote host, to keep the session active
* python 2.2 support (thanks to Roger Binns)
* misc. bug fixes
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--base-0] initial import (automatically generated log message)
2003-11-04 03:34:24 -05:00
*** MISSING LINKS
* ctr forms of ciphers are missing (blowfish-ctr, aes128-ctr, aes256-ctr)
* multi-part auth not supported (ie, need username AND pk)
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-20] more docs, and password-protected key files can now be read lots more documentation, some of it moved out of the README file, which is now much smaller and less rambling. repr(Transport) now reports the number of bits used in the cipher. cleaned up BER to use util functions, and throw a proper exception (the new BERException) on error. it doesn't ever have to be a full BER decoder, but it can at least comb its hair and tuck in its shirt. lots of stuff added to PKey.read_private_key_file so it can try to decode password-protected key files. right now it only understands "DES-EDE3-CBC" format, but this is the only format i've seen openssh make so far. if the key is password-protected, but no password was given, a new exception (PasswordRequiredException) is raised so an outer layer can ask for a password and try again.
2004-01-04 04:29:13 -05:00
* server mode needs better documentation
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-31] bump version number to eevee bump the version number to eevee in a few places and talk about the unit tests.
2004-03-08 12:52:25 -05:00
* sftp server mode
[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-53] add note about utf8 encodings add info to the README about what to do if python complains about missing encodings. veleriy pogrebitskiy ran into this and had advice.
2004-05-29 14:48:23 -04:00
* make invoke_subsystem, etc wait for a reply