Skip to content
This repository was archived by the owner on Apr 20, 2025. It is now read-only.

Commit 3ef578e

Browse files
committed
updated docs
1 parent 832b720 commit 3ef578e

File tree

3 files changed

+10
-3
lines changed

3 files changed

+10
-3
lines changed

doc/compatibility.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@ Compatibility with standards
55
.. index:: compatibility
66

77
Python-RSA implements encryption and signatures according to PKCS#1
8-
version 1.5. This makes it compatible with the OpenSSL RSA module.
8+
version 1.5. Additionally, Python-RSA implements multiprime encryption according to PKCS#1
9+
version 2.1. This makes it largely compatible with the OpenSSL RSA module.
910

10-
Keys are stored in PEM or DER format according to PKCS#1 v1.5. Private
11+
Keys are stored in PEM or DER format according to PKCS#1 v2.1. Private
1112
keys are compatible with OpenSSL. However, OpenSSL uses X.509 for its
1213
public keys, which are not supported.
1314

doc/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ Welcome to Python-RSA's documentation!
88

99
Python-RSA is a pure-Python RSA implementation. It supports
1010
encryption and decryption, signing and verifying signatures, and key
11-
generation according to PKCS#1 version 1.5.
11+
generation according to PKCS#1 version 1.5. Additionally, Python-RSA
12+
implements multirime encryption according to PKCS#1 version 2.1.
1213

1314
If you have the time and skill to improve the implementation, by all
1415
means be my guest. The best way is to clone the `Git

doc/usage.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ Alternatively you can use :py:meth:`rsa.PrivateKey.load_pkcs1` and
4040
... keydata = privatefile.read()
4141
>>> privkey = rsa.PrivateKey.load_pkcs1(keydata)
4242

43+
PKCS#1 v2.1 allows you to generate RSA keys with multiple primes:
44+
45+
>>> import rsa
46+
>>> (pubkey, privkey) = rsa.newkeys(512, nprimes=3)
47+
4348

4449
Time to generate a key
4550
++++++++++++++++++++++

0 commit comments

Comments
 (0)