diff options
| author | Sybren A. St?vel <sybren@stuvel.eu> | 2011-07-30 23:48:00 +0200 |
|---|---|---|
| committer | Sybren A. St?vel <sybren@stuvel.eu> | 2011-07-30 23:48:00 +0200 |
| commit | 0da21049963ed18926de367d805ff3439a7958f7 (patch) | |
| tree | 904ce017d11136116a36ba34e24cf2a63bf471d1 /doc | |
| parent | 1ce1ef03ab25ff65308a13a2bf789dc38bc3efaf (diff) | |
| download | rsa-0da21049963ed18926de367d805ff3439a7958f7.tar.gz | |
More documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/index.rst | 11 | ||||
| -rw-r--r-- | doc/installation.rst | 13 | ||||
| -rw-r--r-- | doc/intro.rst | 19 | ||||
| -rw-r--r-- | doc/usage.rst | 11 |
4 files changed, 54 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst index db66dd7..4963221 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -6,11 +6,22 @@ Welcome to Python-RSA's documentation! ====================================== +Python-RSA is a pure-Python RSA implementation. It supports +encryption and decryption, signing and verifying signatures, and key +generation according to PKCS#1 version 1.5. + Contents: .. toctree:: :maxdepth: 2 + intro + installation + license + usage + compatibility + + Indices and tables ================== diff --git a/doc/installation.rst b/doc/installation.rst new file mode 100644 index 0000000..595793a --- /dev/null +++ b/doc/installation.rst @@ -0,0 +1,13 @@ +Installation +================================================== + +Installation can be done in various ways. The simplest form uses pip +or easy_install. Either one will work:: + + pip install rsa + easy_install rsa + +Depending on your system you may need to use ``sudo pip`` or ``sudo +easy_install``. + + diff --git a/doc/intro.rst b/doc/intro.rst new file mode 100644 index 0000000..e27a7a2 --- /dev/null +++ b/doc/intro.rst @@ -0,0 +1,19 @@ +Introduction +================================================== + +Python-RSA's history starts in 2006. As a student assignment for the +University of Amsterdam we wrote a RSA implementation. We chose Python +for various reasons; one of the most important reasons was the +`unlimited precision integer`_ support. + +.. _`unlimited precision integer`: http://docs.python.org/library/stdtypes.html#numeric-types-int-float-long-complex + +It started out as just a module for calculating large primes, and RSA +encryption, decryption, signing and verification using those large +numbers. It also included generating public and private keys. There +was no functionality for working with byte sequences (such as files) +yet. + +.. TODO:: write more history + + diff --git a/doc/usage.rst b/doc/usage.rst new file mode 100644 index 0000000..2c01cec --- /dev/null +++ b/doc/usage.rst @@ -0,0 +1,11 @@ +Usage +================================================== + + +.. toctree:: + + keygen + simple_enc_dec + sign_verify + big_files + |