summaryrefslogtreecommitdiff
path: root/doc/index.rst
blob: 548622489a3677bbc898ca67abef17cfbcf91d43 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
.. Python-RSA documentation master file, created by
   sphinx-quickstart on Sat Jul 30 23:11:07 2011.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

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.


Security notice
--------------------------------------------------

This RSA implementation has seen the eyes of a security expert, and it
uses an industry standard random padding method. However, there are
still possible vectors of attack. Just to name one example, it doesn't
compress the input stream to remove repetitions, and if you display
the stack trace of a ``Decryptionerror`` exception you'll leak
information about the reason why decryption failed. And I'm sure that
those aren't the only insecurities. Use your own judgement to decide
whether this module is secure enough for your application.

If you have the time and skill to improve the implementation, by all
means be my guest. The best way is to clone the Mercurial repository
and send me a merge request when you've got something worth merging.


Contents
--------------------------------------------------

.. toctree::
    :maxdepth: 2

    intro
    installation
    licence
    usage
    cli
    compatibility
    reference


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`