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.

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.

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 rsa.pkcs1.CryptoError exception you’ll leak information about the reason why decryption or verification failed.

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.

Contents

• 1. Introduction & history
• 2. Installation
  • 2.1. Dependencies
  • 2.2. Development dependencies
• 3. Upgrading from older versions
  • 3.1. Converting keys
• 4. Licence
• 5. Usage
  • 5.1. Generating keys
  • 5.2. Key size requirements
  • 5.3. Encryption and decryption
  • 5.4. Signing and verification
  • 5.5. Working with big files
• 6. Commandline interface
• 7. Compatibility with standards
  • 7.1. Interoperability with OpenSSL
  • 7.2. Interoperability with PKCS#8
• 8. Reference
  • 8.1. Functions
  • 8.2. Classes
  • 8.3. Exceptions
  • 8.4. Module: rsa.bigfile
  • 8.5. Module: rsa.core

• Index
• Search Page