| Sybren A. Stüvel | ae99db6 | 2011-07-30 23:13:04 +0200 | [diff] [blame] | 1 | .. Python-RSA documentation master file, created by |
| 2 | sphinx-quickstart on Sat Jul 30 23:11:07 2011. |
| 3 | You can adapt this file completely to your liking, but it should at least |
| 4 | contain the root `toctree` directive. |
| 5 | |
| 6 | Welcome to Python-RSA's documentation! |
| 7 | ====================================== |
| 8 | |
| Sybren A. Stüvel | aa28c04 | 2011-07-30 23:48:00 +0200 | [diff] [blame] | 9 | Python-RSA is a pure-Python RSA implementation. It supports |
| 10 | encryption and decryption, signing and verifying signatures, and key |
| 11 | generation according to PKCS#1 version 1.5. |
| 12 | |
| Sybren A. Stüvel | 062b132 | 2011-08-03 14:46:49 +0200 | [diff] [blame] | 13 | If you have the time and skill to improve the implementation, by all |
| Sybren A. Stüvel | 3934ab4 | 2016-02-05 16:01:20 +0100 | [diff] [blame] | 14 | means be my guest. The best way is to clone the `Git |
| Sybren A. Stüvel | 062b132 | 2011-08-03 14:46:49 +0200 | [diff] [blame] | 15 | repository`_ and send me a merge request when you've got something |
| 16 | worth merging. |
| 17 | |
| Sybren A. Stüvel | 3934ab4 | 2016-02-05 16:01:20 +0100 | [diff] [blame] | 18 | .. _`Git repository`: https://github.com/sybrenstuvel/python-rsa |
| Sybren A. Stüvel | 062b132 | 2011-08-03 14:46:49 +0200 | [diff] [blame] | 19 | |
| Sybren A. Stüvel | a3fd61a | 2011-07-31 00:22:31 +0200 | [diff] [blame] | 20 | |
| 21 | Security notice |
| Sybren A. Stüvel | 3934ab4 | 2016-02-05 16:01:20 +0100 | [diff] [blame] | 22 | --------------- |
| Sybren A. Stüvel | a3fd61a | 2011-07-31 00:22:31 +0200 | [diff] [blame] | 23 | |
| 24 | This RSA implementation has seen the eyes of a security expert, and it |
| 25 | uses an industry standard random padding method. However, there are |
| 26 | still possible vectors of attack. Just to name one example, it doesn't |
| 27 | compress the input stream to remove repetitions, and if you display |
| Sybren A. Stüvel | c1c455d | 2011-08-01 23:04:30 +0200 | [diff] [blame] | 28 | the stack trace of a :py:class:`rsa.pkcs1.CryptoError` exception |
| 29 | you'll leak information about the reason why decryption or |
| 30 | verification failed. |
| 31 | |
| 32 | I'm sure that those aren't the only insecurities. Use your own |
| 33 | judgement to decide whether this module is secure enough for your |
| 34 | application. |
| Sybren A. Stüvel | a3fd61a | 2011-07-31 00:22:31 +0200 | [diff] [blame] | 35 | |
| Sybren A. Stüvel | a3fd61a | 2011-07-31 00:22:31 +0200 | [diff] [blame] | 36 | Contents |
| Sybren A. Stüvel | 3934ab4 | 2016-02-05 16:01:20 +0100 | [diff] [blame] | 37 | -------- |
| Sybren A. Stüvel | ae99db6 | 2011-07-30 23:13:04 +0200 | [diff] [blame] | 38 | |
| 39 | .. toctree:: |
| Sybren A. Stüvel | a3fd61a | 2011-07-31 00:22:31 +0200 | [diff] [blame] | 40 | :maxdepth: 2 |
| Sybren A. Stüvel | dbea213 | 2011-08-03 13:31:57 +0200 | [diff] [blame] | 41 | :numbered: |
| Sybren A. Stüvel | ae99db6 | 2011-07-30 23:13:04 +0200 | [diff] [blame] | 42 | |
| Sybren A. Stüvel | a3fd61a | 2011-07-31 00:22:31 +0200 | [diff] [blame] | 43 | intro |
| 44 | installation |
| Sybren A. Stüvel | dbea213 | 2011-08-03 13:31:57 +0200 | [diff] [blame] | 45 | upgrading |
| Sybren A. Stüvel | a3fd61a | 2011-07-31 00:22:31 +0200 | [diff] [blame] | 46 | licence |
| 47 | usage |
| Sybren A. Stüvel | 8d8cc31 | 2011-07-31 23:03:23 +0200 | [diff] [blame] | 48 | cli |
| Sybren A. Stüvel | a3fd61a | 2011-07-31 00:22:31 +0200 | [diff] [blame] | 49 | compatibility |
| Sybren A. Stüvel | d92b667 | 2011-07-31 17:44:44 +0200 | [diff] [blame] | 50 | reference |
| Sybren A. Stüvel | aa28c04 | 2011-07-30 23:48:00 +0200 | [diff] [blame] | 51 | |
| 52 | |
| Sybren A. Stüvel | ae99db6 | 2011-07-30 23:13:04 +0200 | [diff] [blame] | 53 | * :ref:`genindex` |
| Sybren A. Stüvel | 062b132 | 2011-08-03 14:46:49 +0200 | [diff] [blame] | 54 | * :ref:`search` |
