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 6Welcome to Python-RSA's documentation! 7====================================== 8 9Python-RSA is a pure-Python RSA implementation. It supports 10encryption and decryption, signing and verifying signatures, and key 11generation according to PKCS#1 version 1.5. 12 13If you have the time and skill to improve the implementation, by all 14means be my guest. The best way is to clone the `Git 15repository`_ and send me a merge request when you've got something 16worth merging. 17 18.. _`Git repository`: https://github.com/sybrenstuvel/python-rsa 19 20 21Security notice 22--------------- 23 24This RSA implementation has seen the eyes of a security expert, and it 25uses an industry standard random padding method. However, there are 26still possible vectors of attack. Just to name one example, it doesn't 27compress the input stream to remove repetitions, and if you display 28the stack trace of a :py:class:`rsa.pkcs1.CryptoError` exception 29you'll leak information about the reason why decryption or 30verification failed. 31 32I'm sure that those aren't the only insecurities. Use your own 33judgement to decide whether this module is secure enough for your 34application. 35 36Contents 37-------- 38 39.. toctree:: 40 :maxdepth: 2 41 :numbered: 42 43 intro 44 installation 45 upgrading 46 licence 47 usage 48 cli 49 compatibility 50 reference 51 52 53* :ref:`genindex` 54* :ref:`search` 55