From fbe96a0a6d8b703a4bef33c674789eb553f67c75 Mon Sep 17 00:00:00 2001
From: shortcutme <tamas@zeronet.io>
Date: Thu, 6 Apr 2017 19:21:32 +0200
Subject: [PATCH] Update rsa to 3.4.2
---
src/lib/rsa/CHANGELOG.txt | 55 -----
src/lib/rsa/README.rst | 31 ---
src/lib/rsa/__init__.py | 17 +-
src/lib/rsa/_compat.py | 16 +-
src/lib/rsa/_version133.py | 45 ++--
src/lib/rsa/_version200.py | 46 +----
src/lib/rsa/asn1.py | 32 +--
src/lib/rsa/bigfile.py | 72 +++++--
src/lib/rsa/cli.py | 138 +++++++------
src/lib/rsa/common.py | 73 +++----
src/lib/rsa/core.py | 19 +-
src/lib/rsa/key.py | 407 ++++++++++++++++++++++++-------------
src/lib/rsa/parallel.py | 48 +++--
src/lib/rsa/pem.py | 43 ++--
src/lib/rsa/pkcs1.py | 262 ++++++++++++------------
src/lib/rsa/prime.py | 174 ++++++++--------
src/lib/rsa/randnum.py | 35 +++-
src/lib/rsa/transform.py | 42 ++--
src/lib/rsa/util.py | 36 ++--
src/lib/rsa/varblock.py | 66 ++++--
20 files changed, 871 insertions(+), 786 deletions(-)
delete mode 100644 src/lib/rsa/CHANGELOG.txt
delete mode 100644 src/lib/rsa/README.rst
diff --git a/src/lib/rsa/CHANGELOG.txt b/src/lib/rsa/CHANGELOG.txt
deleted file mode 100644
index 2d8f5cf9..00000000
--- a/src/lib/rsa/CHANGELOG.txt
+++ /dev/null
@@ -1,55 +0,0 @@
-Python-RSA changelog
-========================================
-
-Version 3.1.1 - in development
-----------------------------------------
-
-- Fixed doctests for Python 2.7
-- Removed obsolete unittest so all tests run fine on Python 3.2
-
-Version 3.1 - released 2012-06-17
-----------------------------------------
-
-- Big, big credits to Yesudeep Mangalapilly for all the changes listed
- below!
-- Added ability to generate keys on multiple cores simultaneously.
-- Massive speedup
-- Partial Python 3.2 compatibility (core functionality works, but
- saving or loading keys doesn't, for that the pyasn1 package needs to
- be ported to Python 3 first)
-- Lots of bug fixes
-
-
-
-Version 3.0.1 - released 2011-08-07
-----------------------------------------
-
-- Removed unused import of abc module
-
-
-Version 3.0 - released 2011-08-05
-----------------------------------------
-
-- Changed the meaning of the keysize to mean the size of ``n`` rather than
- the size of both ``p`` and ``q``. This is the common interpretation of
- RSA keysize. To get the old behaviour, double the keysize when generating a
- new key.
-
-- Added a lot of doctests
-
-- Added random-padded encryption and decryption using PKCS#1 version 1.5
-
-- Added hash-based signatures and verification using PKCS#1v1.5
-
-- Modeling private and public key as real objects rather than dicts.
-
-- Support for saving and loading keys as PEM and DER files.
-
-- Ability to extract a public key from a private key (PEM+DER)
-
-
-Version 2.0
-----------------------------------------
-
-- Security improvements by Barry Mead.
-
diff --git a/src/lib/rsa/README.rst b/src/lib/rsa/README.rst
deleted file mode 100644
index 9f348636..00000000
--- a/src/lib/rsa/README.rst
+++ /dev/null
@@ -1,31 +0,0 @@
-Pure Python RSA implementation
-==============================
-
-`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. It can be used as a Python
-library as well as on the commandline. The code was mostly written by
-Sybren A. Stüvel.
-
-Documentation can be found at the Python-RSA homepage:
-http://stuvel.eu/rsa
-
-Download and install using::
-
- pip install rsa
-
-or::
-
- easy_install rsa
-
-or download it from the `Python Package Index`_.
-
-The source code is maintained in a `Mercurial repository`_ and is
-licensed under the `Apache License, version 2.0`_
-
-
-.. _`Python-RSA`: http://stuvel.eu/rsa
-.. _`Mercurial repository`: https://bitbucket.org/sybren/python-rsa
-.. _`Python Package Index`: http://pypi.python.org/pypi/rsa
-.. _`Apache License, version 2.0`: http://www.apache.org/licenses/LICENSE-2.0
-
diff --git a/src/lib/rsa/__init__.py b/src/lib/rsa/__init__.py
index 99fd6689..c572c06b 100644
--- a/src/lib/rsa/__init__.py
+++ b/src/lib/rsa/__init__.py
@@ -6,7 +6,7 @@
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
@@ -22,24 +22,21 @@ WARNING: this implementation does not use random padding, compression of the
cleartext input to prevent repetitions, or other common security improvements.
Use with care.
-If you want to have a more secure implementation, use the functions from the
-``rsa.pkcs1`` module.
-
"""
-__author__ = "Sybren Stuvel, Barry Mead and Yesudeep Mangalapilly"
-__date__ = "2015-11-05"
-__version__ = '3.2.3'
-
from rsa.key import newkeys, PrivateKey, PublicKey
from rsa.pkcs1 import encrypt, decrypt, sign, verify, DecryptionError, \
VerificationError
+__author__ = "Sybren Stuvel, Barry Mead and Yesudeep Mangalapilly"
+__date__ = "2016-03-29"
+__version__ = '3.4.2'
+
# Do doctest if we're run directly
if __name__ == "__main__":
import doctest
+
doctest.testmod()
__all__ = ["newkeys", "encrypt", "decrypt", "sign", "verify", 'PublicKey',
- 'PrivateKey', 'DecryptionError', 'VerificationError']
-
+ 'PrivateKey', 'DecryptionError', 'VerificationError']
diff --git a/src/lib/rsa/_compat.py b/src/lib/rsa/_compat.py
index 3c4eb81b..93393d9f 100644
--- a/src/lib/rsa/_compat.py
+++ b/src/lib/rsa/_compat.py
@@ -6,7 +6,7 @@
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
@@ -16,7 +16,6 @@
"""Python compatibility wrappers."""
-
from __future__ import absolute_import
import sys
@@ -42,15 +41,12 @@ else:
# Else we just assume 64-bit processor keeping up with modern times.
MACHINE_WORD_SIZE = 64
-
try:
# < Python3
unicode_type = unicode
- have_python3 = False
except NameError:
# Python3.
unicode_type = str
- have_python3 = True
# Fake byte literals.
if str is unicode_type:
@@ -68,14 +64,6 @@ except NameError:
b = byte_literal
-try:
- # Python 2.6 or higher.
- bytes_type = bytes
-except NameError:
- # Python 2.5
- bytes_type = str
-
-
# To avoid calling b() multiple times in tight loops.
ZERO_BYTE = b('\x00')
EMPTY_BYTE = b('')
@@ -90,7 +78,7 @@ def is_bytes(obj):
:returns:
``True`` if ``value`` is a byte string; ``False`` otherwise.
"""
- return isinstance(obj, bytes_type)
+ return isinstance(obj, bytes)
def is_integer(obj):
diff --git a/src/lib/rsa/_version133.py b/src/lib/rsa/_version133.py
index dff0dda8..ff03b45f 100644
--- a/src/lib/rsa/_version133.py
+++ b/src/lib/rsa/_version133.py
@@ -6,7 +6,7 @@
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,8 +14,11 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-"""RSA module
-pri = k[1] //Private part of keys d,p,q
+"""Deprecated version of the RSA module
+
+.. deprecated:: 2.0
+
+ This submodule is deprecated and will be completely removed as of version 4.0.
Module for calculating large primes, and RSA encryption, decryption,
signing and verification. Includes generating public and private keys.
@@ -34,7 +37,11 @@ __version__ = '1.3.3'
# NOTE: Python's modulo can return negative numbers. We compensate for
# this behaviour using the abs() function
-from cPickle import dumps, loads
+try:
+ import cPickle as pickle
+except ImportError:
+ import pickle
+from pickle import dumps, loads
import base64
import math
import os
@@ -49,6 +56,9 @@ from rsa._compat import byte
import warnings
warnings.warn('Insecure version of the RSA module is imported as %s, be careful'
% __name__)
+warnings.warn('This submodule is deprecated and will be completely removed as of version 4.0.',
+ DeprecationWarning)
+
def gcd(p, q):
"""Returns the greatest common divisor of p and q
@@ -63,12 +73,6 @@ def gcd(p, q):
def bytes2int(bytes):
"""Converts a list of bytes or a string to an integer
-
- >>> (128*256 + 64)*256 + + 15
- 8405007
- >>> l = [128, 64, 15]
- >>> bytes2int(l)
- 8405007
"""
if not (type(bytes) is types.ListType or type(bytes) is types.StringType):
@@ -85,9 +89,6 @@ def bytes2int(bytes):
def int2bytes(number):
"""Converts a number to a string of bytes
-
- >>> bytes2int(int2bytes(123456789))
- 123456789
"""
if not (type(number) is types.LongType or type(number) is types.IntType):
@@ -204,11 +205,6 @@ def randomized_primality_testing(n, k):
def is_prime(number):
"""Returns True if the number is prime, and False otherwise.
-
- >>> is_prime(42)
- 0
- >>> is_prime(41)
- 1
"""
"""
@@ -228,14 +224,6 @@ def is_prime(number):
def getprime(nbits):
"""Returns a prime number of max. 'math.ceil(nbits/8)*8' bits. In
other words: nbits is rounded up to whole bytes.
-
- >>> p = getprime(8)
- >>> is_prime(p-1)
- 0
- >>> is_prime(p)
- 1
- >>> is_prime(p+1)
- 0
"""
nbytes = int(math.ceil(nbits/8.))
@@ -256,11 +244,6 @@ def getprime(nbits):
def are_relatively_prime(a, b):
"""Returns True if a and b are relatively prime, and False if they
are not.
-
- >>> are_relatively_prime(2, 3)
- 1
- >>> are_relatively_prime(2, 4)
- 0
"""
d = gcd(a, b)
diff --git a/src/lib/rsa/_version200.py b/src/lib/rsa/_version200.py
index 28f36018..1a169494 100644
--- a/src/lib/rsa/_version200.py
+++ b/src/lib/rsa/_version200.py
@@ -6,7 +6,7 @@
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,14 +14,11 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-"""RSA module
+"""Deprecated version of the RSA module
-Module for calculating large primes, and RSA encryption, decryption,
-signing and verification. Includes generating public and private keys.
+.. deprecated:: 3.0
-WARNING: this implementation does not use random padding, compression of the
-cleartext input to prevent repetitions, or other common security improvements.
-Use with care.
+ This submodule is deprecated and will be completely removed as of version 4.0.
"""
@@ -39,6 +36,8 @@ from rsa._compat import byte
# Display a warning that this insecure version is imported.
import warnings
warnings.warn('Insecure version of the RSA module is imported as %s' % __name__)
+warnings.warn('This submodule is deprecated and will be completely removed as of version 4.0.',
+ DeprecationWarning)
def bit_size(number):
@@ -59,13 +58,7 @@ def gcd(p, q):
def bytes2int(bytes):
- """Converts a list of bytes or a string to an integer
-
- >>> (((128 * 256) + 64) * 256) + 15
- 8405007
- >>> l = [128, 64, 15]
- >>> bytes2int(l) #same as bytes2int('\x80@\x0f')
- 8405007
+ r"""Converts a list of bytes or a string to an integer
"""
if not (type(bytes) is types.ListType or type(bytes) is types.StringType):
@@ -99,9 +92,6 @@ def int2bytes(number):
def to64(number):
"""Converts a number in the range of 0 to 63 into base 64 digit
character in the range of '0'-'9', 'A'-'Z', 'a'-'z','-','_'.
-
- >>> to64(10)
- 'A'
"""
if not (type(number) is types.LongType or type(number) is types.IntType):
@@ -128,9 +118,6 @@ def to64(number):
def from64(number):
"""Converts an ordinal character value in the range of
0-9,A-Z,a-z,-,_ to a number in the range of 0-63.
-
- >>> from64(49)
- 1
"""
if not (type(number) is types.LongType or type(number) is types.IntType):
@@ -157,9 +144,6 @@ def from64(number):
def int2str64(number):
"""Converts a number to a string of base64 encoded characters in
the range of '0'-'9','A'-'Z,'a'-'z','-','_'.
-
- >>> int2str64(123456789)
- '7MyqL'
"""
if not (type(number) is types.LongType or type(number) is types.IntType):
@@ -177,9 +161,6 @@ def int2str64(number):
def str642int(string):
"""Converts a base64 encoded string into an integer.
The chars of this string in in the range '0'-'9','A'-'Z','a'-'z','-','_'
-
- >>> str642int('7MyqL')
- 123456789
"""
if not (type(string) is types.ListType or type(string) is types.StringType):
@@ -270,11 +251,6 @@ def randomized_primality_testing(n, k):
def is_prime(number):
"""Returns True if the number is prime, and False otherwise.
-
- >>> is_prime(42)
- 0
- >>> is_prime(41)
- 1
"""
if randomized_primality_testing(number, 6):
@@ -288,14 +264,6 @@ def is_prime(number):
def getprime(nbits):
"""Returns a prime number of max. 'math.ceil(nbits/8)*8' bits. In
other words: nbits is rounded up to whole bytes.
-
- >>> p = getprime(8)
- >>> is_prime(p-1)
- 0
- >>> is_prime(p)
- 1
- >>> is_prime(p+1)
- 0
"""
while True:
diff --git a/src/lib/rsa/asn1.py b/src/lib/rsa/asn1.py
index 6eb6da53..b724b8f5 100644
--- a/src/lib/rsa/asn1.py
+++ b/src/lib/rsa/asn1.py
@@ -6,7 +6,7 @@
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,38 +14,40 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-'''ASN.1 definitions.
+"""ASN.1 definitions.
Not all ASN.1-handling code use these definitions, but when it does, they should be here.
-'''
+"""
from pyasn1.type import univ, namedtype, tag
+
class PubKeyHeader(univ.Sequence):
componentType = namedtype.NamedTypes(
- namedtype.NamedType('oid', univ.ObjectIdentifier()),
- namedtype.NamedType('parameters', univ.Null()),
+ namedtype.NamedType('oid', univ.ObjectIdentifier()),
+ namedtype.NamedType('parameters', univ.Null()),
)
+
class OpenSSLPubKey(univ.Sequence):
componentType = namedtype.NamedTypes(
- namedtype.NamedType('header', PubKeyHeader()),
-
- # This little hack (the implicit tag) allows us to get a Bit String as Octet String
- namedtype.NamedType('key', univ.OctetString().subtype(
- implicitTag=tag.Tag(tagClass=0, tagFormat=0, tagId=3))),
+ namedtype.NamedType('header', PubKeyHeader()),
+
+ # This little hack (the implicit tag) allows us to get a Bit String as Octet String
+ namedtype.NamedType('key', univ.OctetString().subtype(
+ implicitTag=tag.Tag(tagClass=0, tagFormat=0, tagId=3))),
)
class AsnPubKey(univ.Sequence):
- '''ASN.1 contents of DER encoded public key:
-
+ """ASN.1 contents of DER encoded public key:
+
RSAPublicKey ::= SEQUENCE {
modulus INTEGER, -- n
publicExponent INTEGER, -- e
- '''
+ """
componentType = namedtype.NamedTypes(
- namedtype.NamedType('modulus', univ.Integer()),
- namedtype.NamedType('publicExponent', univ.Integer()),
+ namedtype.NamedType('modulus', univ.Integer()),
+ namedtype.NamedType('publicExponent', univ.Integer()),
)
diff --git a/src/lib/rsa/bigfile.py b/src/lib/rsa/bigfile.py
index 516cf56b..3a09716a 100644
--- a/src/lib/rsa/bigfile.py
+++ b/src/lib/rsa/bigfile.py
@@ -6,7 +6,7 @@
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,7 +14,27 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-'''Large file support
+"""Large file support
+
+.. deprecated:: 3.4
+
+ The VARBLOCK format is NOT recommended for general use, has been deprecated since
+ Python-RSA 3.4, and will be removed in a future release. It's vulnerable to a
+ number of attacks:
+
+ 1. decrypt/encrypt_bigfile() does not implement `Authenticated encryption`_ nor
+ uses MACs to verify messages before decrypting public key encrypted messages.
+
+ 2. decrypt/encrypt_bigfile() does not use hybrid encryption (it uses plain RSA)
+ and has no method for chaining, so block reordering is possible.
+
+ See `issue #19 on Github`_ for more information.
+
+.. _Authenticated encryption: https://en.wikipedia.org/wiki/Authenticated_encryption
+.. _issue #19 on Github: https://github.com/sybrenstuvel/python-rsa/issues/13
+
+
+This module contains functions to:
- break a file into smaller blocks, and encrypt them, and store the
encrypted blocks in another file.
@@ -37,25 +57,40 @@ The encrypted file format is as follows, where || denotes byte concatenation:
This file format is called the VARBLOCK format, in line with the varint format
used to denote the block sizes.
-'''
+"""
+
+import warnings
from rsa import key, common, pkcs1, varblock
from rsa._compat import byte
+
def encrypt_bigfile(infile, outfile, pub_key):
- '''Encrypts a file, writing it to 'outfile' in VARBLOCK format.
-
+ """Encrypts a file, writing it to 'outfile' in VARBLOCK format.
+
+ .. deprecated:: 3.4
+ This function was deprecated in Python-RSA version 3.4 due to security issues
+ in the VARBLOCK format. See the documentation_ for more information.
+
+ .. _documentation: https://stuvel.eu/python-rsa-doc/usage.html#working-with-big-files
+
:param infile: file-like object to read the cleartext from
:param outfile: file-like object to write the crypto in VARBLOCK format to
:param pub_key: :py:class:`rsa.PublicKey` to encrypt with
- '''
+ """
+
+ warnings.warn("The 'rsa.bigfile.encrypt_bigfile' function was deprecated in Python-RSA version "
+ "3.4 due to security issues in the VARBLOCK format. See "
+ "https://stuvel.eu/python-rsa-doc/usage.html#working-with-big-files "
+ "for more information.",
+ DeprecationWarning, stacklevel=2)
if not isinstance(pub_key, key.PublicKey):
raise TypeError('Public key required, but got %r' % pub_key)
key_bytes = common.bit_size(pub_key.n) // 8
- blocksize = key_bytes - 11 # keep space for PKCS#1 padding
+ blocksize = key_bytes - 11 # keep space for PKCS#1 padding
# Write the version number to the VARBLOCK file
outfile.write(byte(varblock.VARBLOCK_VERSION))
@@ -67,21 +102,34 @@ def encrypt_bigfile(infile, outfile, pub_key):
varblock.write_varint(outfile, len(crypto))
outfile.write(crypto)
+
def decrypt_bigfile(infile, outfile, priv_key):
- '''Decrypts an encrypted VARBLOCK file, writing it to 'outfile'
-
+ """Decrypts an encrypted VARBLOCK file, writing it to 'outfile'
+
+ .. deprecated:: 3.4
+ This function was deprecated in Python-RSA version 3.4 due to security issues
+ in the VARBLOCK format. See the documentation_ for more information.
+
+ .. _documentation: https://stuvel.eu/python-rsa-doc/usage.html#working-with-big-files
+
:param infile: file-like object to read the crypto in VARBLOCK format from
:param outfile: file-like object to write the cleartext to
:param priv_key: :py:class:`rsa.PrivateKey` to decrypt with
- '''
+ """
+
+ warnings.warn("The 'rsa.bigfile.decrypt_bigfile' function was deprecated in Python-RSA version "
+ "3.4 due to security issues in the VARBLOCK format. See "
+ "https://stuvel.eu/python-rsa-doc/usage.html#working-with-big-files "
+ "for more information.",
+ DeprecationWarning, stacklevel=2)
if not isinstance(priv_key, key.PrivateKey):
raise TypeError('Private key required, but got %r' % priv_key)
-
+
for block in varblock.yield_varblocks(infile):
cleartext = pkcs1.decrypt(block, priv_key)
outfile.write(cleartext)
-__all__ = ['encrypt_bigfile', 'decrypt_bigfile']
+__all__ = ['encrypt_bigfile', 'decrypt_bigfile']
diff --git a/src/lib/rsa/cli.py b/src/lib/rsa/cli.py
index 527cc497..3a218782 100644
--- a/src/lib/rsa/cli.py
+++ b/src/lib/rsa/cli.py
@@ -6,7 +6,7 @@
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,10 +14,10 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-'''Commandline scripts.
+"""Commandline scripts.
These scripts are called by the executables defined in setup.py.
-'''
+"""
from __future__ import with_statement, print_function
@@ -31,32 +31,33 @@ import rsa.pkcs1
HASH_METHODS = sorted(rsa.pkcs1.HASH_METHODS.keys())
+
def keygen():
- '''Key generator.'''
+ """Key generator."""
# Parse the CLI options
parser = OptionParser(usage='usage: %prog [options] keysize',
- description='Generates a new RSA keypair of "keysize" bits.')
-
+ description='Generates a new RSA keypair of "keysize" bits.')
+
parser.add_option('--pubout', type='string',
- help='Output filename for the public key. The public key is '
- 'not saved if this option is not present. You can use '
- 'pyrsa-priv2pub to create the public key file later.')
-
+ help='Output filename for the public key. The public key is '
+ 'not saved if this option is not present. You can use '
+ 'pyrsa-priv2pub to create the public key file later.')
+
parser.add_option('-o', '--out', type='string',
- help='Output filename for the private key. The key is '
- 'written to stdout if this option is not present.')
+ help='Output filename for the private key. The key is '
+ 'written to stdout if this option is not present.')
parser.add_option('--form',
- help='key format of the private and public keys - default PEM',
- choices=('PEM', 'DER'), default='PEM')
+ help='key format of the private and public keys - default PEM',
+ choices=('PEM', 'DER'), default='PEM')
(cli, cli_args) = parser.parse_args(sys.argv[1:])
if len(cli_args) != 1:
parser.print_help()
raise SystemExit(1)
-
+
try:
keysize = int(cli_args[0])
except ValueError:
@@ -67,7 +68,6 @@ def keygen():
print('Generating %i-bit key' % keysize, file=sys.stderr)
(pub_key, priv_key) = rsa.newkeys(keysize)
-
# Save public key
if cli.pubout:
print('Writing public key to %s' % cli.pubout, file=sys.stderr)
@@ -77,7 +77,7 @@ def keygen():
# Save private key
data = priv_key.save_pkcs1(format=cli.form)
-
+
if cli.out:
print('Writing private key to %s' % cli.out, file=sys.stderr)
with open(cli.out, 'wb') as outfile:
@@ -88,20 +88,20 @@ def keygen():
class CryptoOperation(object):
- '''CLI callable that operates with input, output, and a key.'''
+ """CLI callable that operates with input, output, and a key."""
__metaclass__ = abc.ABCMeta
- keyname = 'public' # or 'private'
+ keyname = 'public' # or 'private'
usage = 'usage: %%prog [options] %(keyname)s_key'
description = None
operation = 'decrypt'
operation_past = 'decrypted'
operation_progressive = 'decrypting'
input_help = 'Name of the file to %(operation)s. Reads from stdin if ' \
- 'not specified.'
+ 'not specified.'
output_help = 'Name of the file to write the %(operation_past)s file ' \
- 'to. Written to stdout if this option is not present.'
+ 'to. Written to stdout if this option is not present.'
expected_cli_args = 1
has_output = True
@@ -114,15 +114,15 @@ class CryptoOperation(object):
@abc.abstractmethod
def perform_operation(self, indata, key, cli_args=None):
- '''Performs the program's operation.
+ """Performs the program's operation.
Implement in a subclass.
:returns: the data to write to the output.
- '''
+ """
def __call__(self):
- '''Runs the program.'''
+ """Runs the program."""
(cli, cli_args) = self.parse_cli()
@@ -137,21 +137,21 @@ class CryptoOperation(object):
self.write_outfile(outdata, cli.output)
def parse_cli(self):
- '''Parse the CLI options
-
+ """Parse the CLI options
+
:returns: (cli_opts, cli_args)
- '''
+ """
parser = OptionParser(usage=self.usage, description=self.description)
-
+
parser.add_option('-i', '--input', type='string', help=self.input_help)
if self.has_output:
parser.add_option('-o', '--output', type='string', help=self.output_help)
parser.add_option('--keyform',
- help='Key format of the %s key - default PEM' % self.keyname,
- choices=('PEM', 'DER'), default='PEM')
+ help='Key format of the %s key - default PEM' % self.keyname,
+ choices=('PEM', 'DER'), default='PEM')
(cli, cli_args) = parser.parse_args(sys.argv[1:])
@@ -159,19 +159,19 @@ class CryptoOperation(object):
parser.print_help()
raise SystemExit(1)
- return (cli, cli_args)
+ return cli, cli_args
def read_key(self, filename, keyform):
- '''Reads a public or private key.'''
+ """Reads a public or private key."""
print('Reading %s key from %s' % (self.keyname, filename), file=sys.stderr)
with open(filename, 'rb') as keyfile:
keydata = keyfile.read()
return self.key_class.load_pkcs1(keydata, keyform)
-
+
def read_infile(self, inname):
- '''Read the input file'''
+ """Read the input file"""
if inname:
print('Reading input from %s' % inname, file=sys.stderr)
@@ -182,7 +182,7 @@ class CryptoOperation(object):
return sys.stdin.read()
def write_outfile(self, outdata, outname):
- '''Write the output file'''
+ """Write the output file"""
if outname:
print('Writing output to %s' % outname, file=sys.stderr)
@@ -192,47 +192,49 @@ class CryptoOperation(object):
print('Writing output to stdout', file=sys.stderr)
sys.stdout.write(outdata)
+
class EncryptOperation(CryptoOperation):
- '''Encrypts a file.'''
+ """Encrypts a file."""
keyname = 'public'
description = ('Encrypts a file. The file must be shorter than the key '
- 'length in order to be encrypted. For larger files, use the '
- 'pyrsa-encrypt-bigfile command.')
+ 'length in order to be encrypted. For larger files, use the '
+ 'pyrsa-encrypt-bigfile command.')
operation = 'encrypt'
operation_past = 'encrypted'
operation_progressive = 'encrypting'
-
def perform_operation(self, indata, pub_key, cli_args=None):
- '''Encrypts files.'''
+ """Encrypts files."""
return rsa.encrypt(indata, pub_key)
+
class DecryptOperation(CryptoOperation):
- '''Decrypts a file.'''
+ """Decrypts a file."""
keyname = 'private'
description = ('Decrypts a file. The original file must be shorter than '
- 'the key length in order to have been encrypted. For larger '
- 'files, use the pyrsa-decrypt-bigfile command.')
+ 'the key length in order to have been encrypted. For larger '
+ 'files, use the pyrsa-decrypt-bigfile command.')
operation = 'decrypt'
operation_past = 'decrypted'
operation_progressive = 'decrypting'
key_class = rsa.PrivateKey
def perform_operation(self, indata, priv_key, cli_args=None):
- '''Decrypts files.'''
+ """Decrypts files."""
return rsa.decrypt(indata, priv_key)
+
class SignOperation(CryptoOperation):
- '''Signs a file.'''
+ """Signs a file."""
keyname = 'private'
usage = 'usage: %%prog [options] private_key hash_method'
description = ('Signs a file, outputs the signature. Choose the hash '
- 'method from %s' % ', '.join(HASH_METHODS))
+ 'method from %s' % ', '.join(HASH_METHODS))
operation = 'sign'
operation_past = 'signature'
operation_progressive = 'Signing'
@@ -240,25 +242,26 @@ class SignOperation(CryptoOperation):
expected_cli_args = 2
output_help = ('Name of the file to write the signature to. Written '
- 'to stdout if this option is not present.')
+ 'to stdout if this option is not present.')
def perform_operation(self, indata, priv_key, cli_args):
- '''Decrypts files.'''
+ """Signs files."""
hash_method = cli_args[1]
if hash_method not in HASH_METHODS:
- raise SystemExit('Invalid hash method, choose one of %s' %
- ', '.join(HASH_METHODS))
+ raise SystemExit('Invalid hash method, choose one of %s' %
+ ', '.join(HASH_METHODS))
return rsa.sign(indata, priv_key, hash_method)
+
class VerifyOperation(CryptoOperation):
- '''Verify a signature.'''
+ """Verify a signature."""
keyname = 'public'
usage = 'usage: %%prog [options] public_key signature_file'
description = ('Verifies a signature, exits with status 0 upon success, '
- 'prints an error message and exits with status 1 upon error.')
+ 'prints an error message and exits with status 1 upon error.')
operation = 'verify'
operation_past = 'verified'
operation_progressive = 'Verifying'
@@ -267,10 +270,10 @@ class VerifyOperation(CryptoOperation):
has_output = False
def perform_operation(self, indata, pub_key, cli_args):
- '''Decrypts files.'''
+ """Verifies files."""
signature_file = cli_args[1]
-
+
with open(signature_file, 'rb') as sigfile:
signature = sigfile.read()
@@ -283,7 +286,7 @@ class VerifyOperation(CryptoOperation):
class BigfileOperation(CryptoOperation):
- '''CryptoOperation that doesn't read the entire file into memory.'''
+ """CryptoOperation that doesn't read the entire file into memory."""
def __init__(self):
CryptoOperation.__init__(self)
@@ -291,13 +294,13 @@ class BigfileOperation(CryptoOperation):
self.file_objects = []
def __del__(self):
- '''Closes any open file handles.'''
+ """Closes any open file handles."""
for fobj in self.file_objects:
fobj.close()
def __call__(self):
- '''Runs the program.'''
+ """Runs the program."""
(cli, cli_args) = self.parse_cli()
@@ -312,7 +315,7 @@ class BigfileOperation(CryptoOperation):
self.perform_operation(infile, outfile, key, cli_args)
def get_infile(self, inname):
- '''Returns the input file object'''
+ """Returns the input file object"""
if inname:
print('Reading input from %s' % inname, file=sys.stderr)
@@ -325,7 +328,7 @@ class BigfileOperation(CryptoOperation):
return fobj
def get_outfile(self, outname):
- '''Returns the output file object'''
+ """Returns the output file object"""
if outname:
print('Will write output to %s' % outname, file=sys.stderr)
@@ -337,35 +340,37 @@ class BigfileOperation(CryptoOperation):
return fobj
+
class EncryptBigfileOperation(BigfileOperation):
- '''Encrypts a file to VARBLOCK format.'''
+ """Encrypts a file to VARBLOCK format."""
keyname = 'public'
description = ('Encrypts a file to an encrypted VARBLOCK file. The file '
- 'can be larger than the key length, but the output file is only '
- 'compatible with Python-RSA.')
+ 'can be larger than the key length, but the output file is only '
+ 'compatible with Python-RSA.')
operation = 'encrypt'
operation_past = 'encrypted'
operation_progressive = 'encrypting'
def perform_operation(self, infile, outfile, pub_key, cli_args=None):
- '''Encrypts files to VARBLOCK.'''
+ """Encrypts files to VARBLOCK."""
return rsa.bigfile.encrypt_bigfile(infile, outfile, pub_key)
+
class DecryptBigfileOperation(BigfileOperation):
- '''Decrypts a file in VARBLOCK format.'''
+ """Decrypts a file in VARBLOCK format."""
keyname = 'private'
description = ('Decrypts an encrypted VARBLOCK file that was encrypted '
- 'with pyrsa-encrypt-bigfile')
+ 'with pyrsa-encrypt-bigfile')
operation = 'decrypt'
operation_past = 'decrypted'
operation_progressive = 'decrypting'
key_class = rsa.PrivateKey
def perform_operation(self, infile, outfile, priv_key, cli_args=None):
- '''Decrypts a VARBLOCK file.'''
+ """Decrypts a VARBLOCK file."""
return rsa.bigfile.decrypt_bigfile(infile, outfile, priv_key)
@@ -376,4 +381,3 @@ sign = SignOperation()
verify = VerifyOperation()
encrypt_bigfile = EncryptBigfileOperation()
decrypt_bigfile = DecryptBigfileOperation()
-
diff --git a/src/lib/rsa/common.py b/src/lib/rsa/common.py
index 39feb8c2..e0743340 100644
--- a/src/lib/rsa/common.py
+++ b/src/lib/rsa/common.py
@@ -6,7 +6,7 @@
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,19 +14,19 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-'''Common functionality shared by several modules.'''
+"""Common functionality shared by several modules."""
def bit_size(num):
- '''
+ """
Number of bits needed to represent a integer excluding any prefix
0 bits.
- As per definition from http://wiki.python.org/moin/BitManipulation and
+ As per definition from https://wiki.python.org/moin/BitManipulation and
to match the behavior of the Python 3 API.
Usage::
-
+
>>> bit_size(1023)
10
>>> bit_size(1024)
@@ -40,7 +40,7 @@ def bit_size(num):
before the number's bit length is determined.
:returns:
Returns the number of bits in the integer.
- '''
+ """
if num == 0:
return 0
if num < 0:
@@ -51,23 +51,23 @@ def bit_size(num):
hex_num = "%x" % num
return ((len(hex_num) - 1) * 4) + {
- '0':0, '1':1, '2':2, '3':2,
- '4':3, '5':3, '6':3, '7':3,
- '8':4, '9':4, 'a':4, 'b':4,
- 'c':4, 'd':4, 'e':4, 'f':4,
- }[hex_num[0]]
+ '0': 0, '1': 1, '2': 2, '3': 2,
+ '4': 3, '5': 3, '6': 3, '7': 3,
+ '8': 4, '9': 4, 'a': 4, 'b': 4,
+ 'c': 4, 'd': 4, 'e': 4, 'f': 4,
+ }[hex_num[0]]
def _bit_size(number):
- '''
+ """
Returns the number of bits required to hold a specific long number.
- '''
+ """
if number < 0:
raise ValueError('Only nonnegative numbers possible: %s' % number)
if number == 0:
return 0
-
+
# This works, even with very large numbers. When using math.log(number, 2),
# you'll get rounding errors and it'll fail.
bits = 0
@@ -79,9 +79,9 @@ def _bit_size(number):
def byte_size(number):
- '''
+ """
Returns the number of bytes required to hold a specific long number.
-
+
The number of bytes is rounded up.
Usage::
@@ -97,17 +97,17 @@ def byte_size(number):
An unsigned integer
:returns:
The number of bytes required to hold a specific long number.
- '''
+ """
quanta, mod = divmod(bit_size(number), 8)
if mod or number == 0:
quanta += 1
return quanta
- #return int(math.ceil(bit_size(number) / 8.0))
+ # return int(math.ceil(bit_size(number) / 8.0))
def extended_gcd(a, b):
- '''Returns a tuple (r, i, j) such that r = gcd(a, b) = ia + jb
- '''
+ """Returns a tuple (r, i, j) such that r = gcd(a, b) = ia + jb
+ """
# r = gcd(a,b) i = multiplicitive inverse of a mod b
# or j = multiplicitive inverse of b mod a
# Neg return values for i or j are made positive mod b or a respectively
@@ -116,26 +116,28 @@ def extended_gcd(a, b):
y = 1
lx = 1
ly = 0
- oa = a #Remember original a/b to remove
- ob = b #negative values from return results
+ oa = a # Remember original a/b to remove
+ ob = b # negative values from return results
while b != 0:
q = a // b
- (a, b) = (b, a % b)
- (x, lx) = ((lx - (q * x)),x)
- (y, ly) = ((ly - (q * y)),y)
- if (lx < 0): lx += ob #If neg wrap modulo orignal b
- if (ly < 0): ly += oa #If neg wrap modulo orignal a
- return (a, lx, ly) #Return only positive values
+ (a, b) = (b, a % b)
+ (x, lx) = ((lx - (q * x)), x)
+ (y, ly) = ((ly - (q * y)), y)
+ if lx < 0:
+ lx += ob # If neg wrap modulo orignal b
+ if ly < 0:
+ ly += oa # If neg wrap modulo orignal a
+ return a, lx, ly # Return only positive values
def inverse(x, n):
- '''Returns x^-1 (mod n)
+ """Returns x^-1 (mod n)
>>> inverse(7, 4)
3
>>> (inverse(143, 4) * 143) % 4
1
- '''
+ """
(divider, inv, _) = extended_gcd(x, n)
@@ -146,14 +148,14 @@ def inverse(x, n):
def crt(a_values, modulo_values):
- '''Chinese Remainder Theorem.
+ """Chinese Remainder Theorem.
Calculates x such that x = a[i] (mod m[i]) for each i.
:param a_values: the a-values of the above equation
:param modulo_values: the m-values of the above equation
:returns: x such that x = a[i] (mod m[i]) for each i
-
+
>>> crt([2, 3], [3, 5])
8
@@ -163,10 +165,10 @@ def crt(a_values, modulo_values):
>>> crt([2, 3, 0], [7, 11, 15])
135
- '''
+ """
m = 1
- x = 0
+ x = 0
for modulo in modulo_values:
m *= modulo
@@ -179,7 +181,8 @@ def crt(a_values, modulo_values):
return x
+
if __name__ == '__main__':
import doctest
- doctest.testmod()
+ doctest.testmod()
diff --git a/src/lib/rsa/core.py b/src/lib/rsa/core.py
index 90dfee8e..b3114d9e 100644
--- a/src/lib/rsa/core.py
+++ b/src/lib/rsa/core.py
@@ -6,7 +6,7 @@
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,24 +14,24 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-'''Core mathematical operations.
+"""Core mathematical operations.
This is the actual core RSA implementation, which is only defined
mathematically on integers.
-'''
-
+"""
from rsa._compat import is_integer
-def assert_int(var, name):
+def assert_int(var, name):
if is_integer(var):
return
raise TypeError('%s should be an integer, not %s' % (name, var.__class__))
+
def encrypt_int(message, ekey, n):
- '''Encrypts a message using encryption key 'ekey', working modulo n'''
+ """Encrypts a message using encryption key 'ekey', working modulo n"""
assert_int(message, 'message')
assert_int(ekey, 'ekey')
@@ -39,15 +39,15 @@ def encrypt_int(message, ekey, n):
if message < 0:
raise ValueError('Only non-negative numbers are supported')
-
+
if message > n:
raise OverflowError("The message %i is too long for n=%i" % (message, n))
return pow(message, ekey, n)
+
def decrypt_int(cyphertext, dkey, n):
- '''Decrypts a cypher text using the decryption key 'dkey', working
- modulo n'''
+ """Decrypts a cypher text using the decryption key 'dkey', working modulo n"""
assert_int(cyphertext, 'cyphertext')
assert_int(dkey, 'dkey')
@@ -55,4 +55,3 @@ def decrypt_int(cyphertext, dkey, n):
message = pow(cyphertext, dkey, n)
return message
-
diff --git a/src/lib/rsa/key.py b/src/lib/rsa/key.py
index b6de7b3f..64600a27 100644
--- a/src/lib/rsa/key.py
+++ b/src/lib/rsa/key.py
@@ -6,7 +6,7 @@
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,7 +14,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-'''RSA key generation code.
+"""RSA key generation code.
Create new keys with the newkeys() function. It will give you a PublicKey and a
PrivateKey object.
@@ -23,70 +23,118 @@ Loading and saving keys requires the pyasn1 module. This module is imported as
late as possible, such that other functionality will remain working in absence
of pyasn1.
-'''
+.. note::
+
+ Storing public and private keys via the `pickle` module is possible.
+ However, it is insecure to load a key from an untrusted source.
+ The pickle module is not secure against erroneous or maliciously
+ constructed data. Never unpickle data received from an untrusted
+ or unauthenticated source.
+
+"""
import logging
-from rsa._compat import b, bytes_type
+from rsa._compat import b
import rsa.prime
import rsa.pem
import rsa.common
+import rsa.randnum
+import rsa.core
log = logging.getLogger(__name__)
-
+DEFAULT_EXPONENT = 65537
class AbstractKey(object):
- '''Abstract superclass for private and public keys.'''
+ """Abstract superclass for private and public keys."""
+
+ __slots__ = ('n', 'e')
+
+ def __init__(self, n, e):
+ self.n = n
+ self.e = e
@classmethod
def load_pkcs1(cls, keyfile, format='PEM'):
- r'''Loads a key in PKCS#1 DER or PEM format.
+ """Loads a key in PKCS#1 DER or PEM format.
:param keyfile: contents of a DER- or PEM-encoded file that contains
the public key.
:param format: the format of the file to load; 'PEM' or 'DER'
:return: a PublicKey object
-
- '''
+ """
methods = {
'PEM': cls._load_pkcs1_pem,
'DER': cls._load_pkcs1_der,
}
- if format not in methods:
- formats = ', '.join(sorted(methods.keys()))
- raise ValueError('Unsupported format: %r, try one of %s' % (format,
- formats))
-
- method = methods[format]
+ method = cls._assert_format_exists(format, methods)
return method(keyfile)
+ @staticmethod
+ def _assert_format_exists(file_format, methods):
+ """Checks whether the given file format exists in 'methods'.
+ """
+
+ try:
+ return methods[file_format]
+ except KeyError:
+ formats = ', '.join(sorted(methods.keys()))
+ raise ValueError('Unsupported format: %r, try one of %s' % (file_format,
+ formats))
+
def save_pkcs1(self, format='PEM'):
- '''Saves the public key in PKCS#1 DER or PEM format.
+ """Saves the public key in PKCS#1 DER or PEM format.
:param format: the format to save; 'PEM' or 'DER'
:returns: the DER- or PEM-encoded public key.
-
- '''
+ """
methods = {
'PEM': self._save_pkcs1_pem,
'DER': self._save_pkcs1_der,
}
- if format not in methods:
- formats = ', '.join(sorted(methods.keys()))
- raise ValueError('Unsupported format: %r, try one of %s' % (format,
- formats))
-
- method = methods[format]
+ method = self._assert_format_exists(format, methods)
return method()
+ def blind(self, message, r):
+ """Performs blinding on the message using random number 'r'.
+
+ :param message: the message, as integer, to blind.
+ :type message: int
+ :param r: the random number to blind with.
+ :type r: int
+ :return: the blinded message.
+ :rtype: int
+
+ The blinding is such that message = unblind(decrypt(blind(encrypt(message))).
+
+ See https://en.wikipedia.org/wiki/Blinding_%28cryptography%29
+ """
+
+ return (message * pow(r, self.e, self.n)) % self.n
+
+ def unblind(self, blinded, r):
+ """Performs blinding on the message using random number 'r'.
+
+ :param blinded: the blinded message, as integer, to unblind.
+ :param r: the random number to unblind with.
+ :return: the original message.
+
+ The blinding is such that message = unblind(decrypt(blind(encrypt(message))).
+
+ See https://en.wikipedia.org/wiki/Blinding_%28cryptography%29
+ """
+
+ return (rsa.common.inverse(r, self.n) * blinded) % self.n
+
+
class PublicKey(AbstractKey):
- '''Represents a public RSA key.
+ """Represents a public RSA key.
This key is also known as the 'encryption key'. It contains the 'n' and 'e'
values.
@@ -107,20 +155,24 @@ class PublicKey(AbstractKey):
>>> key['e']
3
- '''
+ """
__slots__ = ('n', 'e')
- def __init__(self, n, e):
- self.n = n
- self.e = e
-
def __getitem__(self, key):
return getattr(self, key)
def __repr__(self):
return 'PublicKey(%i, %i)' % (self.n, self.e)
+ def __getstate__(self):
+ """Returns the key as tuple for pickling."""
+ return self.n, self.e
+
+ def __setstate__(self, state):
+ """Sets the key from tuple."""
+ self.n, self.e = state
+
def __eq__(self, other):
if other is None:
return False
@@ -135,36 +187,36 @@ class PublicKey(AbstractKey):
@classmethod
def _load_pkcs1_der(cls, keyfile):
- r'''Loads a key in PKCS#1 DER format.
+ """Loads a key in PKCS#1 DER format.
- @param keyfile: contents of a DER-encoded file that contains the public
+ :param keyfile: contents of a DER-encoded file that contains the public
key.
- @return: a PublicKey object
+ :return: a PublicKey object
First let's construct a DER encoded key:
>>> import base64
>>> b64der = 'MAwCBQCNGmYtAgMBAAE='
- >>> der = base64.decodestring(b64der)
+ >>> der = base64.standard_b64decode(b64der)
This loads the file:
>>> PublicKey._load_pkcs1_der(der)
PublicKey(2367317549, 65537)
- '''
+ """
from pyasn1.codec.der import decoder
from rsa.asn1 import AsnPubKey
-
+
(priv, _) = decoder.decode(keyfile, asn1Spec=AsnPubKey())
return cls(n=int(priv['modulus']), e=int(priv['publicExponent']))
def _save_pkcs1_der(self):
- '''Saves the public key in PKCS#1 DER format.
+ """Saves the public key in PKCS#1 DER format.
@returns: the DER-encoded public key.
- '''
+ """
from pyasn1.codec.der import encoder
from rsa.asn1 import AsnPubKey
@@ -178,71 +230,70 @@ class PublicKey(AbstractKey):
@classmethod
def _load_pkcs1_pem(cls, keyfile):
- '''Loads a PKCS#1 PEM-encoded public key file.
+ """Loads a PKCS#1 PEM-encoded public key file.
The contents of the file before the "-----BEGIN RSA PUBLIC KEY-----" and
after the "-----END RSA PUBLIC KEY-----" lines is ignored.
- @param keyfile: contents of a PEM-encoded file that contains the public
+ :param keyfile: contents of a PEM-encoded file that contains the public
key.
- @return: a PublicKey object
- '''
+ :return: a PublicKey object
+ """
der = rsa.pem.load_pem(keyfile, 'RSA PUBLIC KEY')
return cls._load_pkcs1_der(der)
def _save_pkcs1_pem(self):
- '''Saves a PKCS#1 PEM-encoded public key file.
+ """Saves a PKCS#1 PEM-encoded public key file.
- @return: contents of a PEM-encoded file that contains the public key.
- '''
+ :return: contents of a PEM-encoded file that contains the public key.
+ """
der = self._save_pkcs1_der()
return rsa.pem.save_pem(der, 'RSA PUBLIC KEY')
@classmethod
def load_pkcs1_openssl_pem(cls, keyfile):
- '''Loads a PKCS#1.5 PEM-encoded public key file from OpenSSL.
-
+ """Loads a PKCS#1.5 PEM-encoded public key file from OpenSSL.
+
These files can be recognised in that they start with BEGIN PUBLIC KEY
rather than BEGIN RSA PUBLIC KEY.
-
+
The contents of the file before the "-----BEGIN PUBLIC KEY-----" and
after the "-----END PUBLIC KEY-----" lines is ignored.
- @param keyfile: contents of a PEM-encoded file that contains the public
+ :param keyfile: contents of a PEM-encoded file that contains the public
key, from OpenSSL.
- @return: a PublicKey object
- '''
+ :return: a PublicKey object
+ """
der = rsa.pem.load_pem(keyfile, 'PUBLIC KEY')
return cls.load_pkcs1_openssl_der(der)
@classmethod
def load_pkcs1_openssl_der(cls, keyfile):
- '''Loads a PKCS#1 DER-encoded public key file from OpenSSL.
+ """Loads a PKCS#1 DER-encoded public key file from OpenSSL.
- @param keyfile: contents of a DER-encoded file that contains the public
+ :param keyfile: contents of a DER-encoded file that contains the public
key, from OpenSSL.
- @return: a PublicKey object
- '''
-
+ :return: a PublicKey object
+
+ """
+
from rsa.asn1 import OpenSSLPubKey
from pyasn1.codec.der import decoder
from pyasn1.type import univ
-
+
(keyinfo, _) = decoder.decode(keyfile, asn1Spec=OpenSSLPubKey())
-
+
if keyinfo['header']['oid'] != univ.ObjectIdentifier('1.2.840.113549.1.1.1'):
raise TypeError("This is not a DER-encoded OpenSSL-compatible public key")
-
+
return cls._load_pkcs1_der(keyinfo['key'][1:])
-
-
class PrivateKey(AbstractKey):
- '''Represents a private RSA key.
+ """Represents a private RSA key.
This key is also known as the 'decryption key'. It contains the 'n', 'e',
'd', 'p', 'q' and other values.
@@ -253,13 +304,13 @@ class PrivateKey(AbstractKey):
>>> PrivateKey(3247, 65537, 833, 191, 17)
PrivateKey(3247, 65537, 833, 191, 17)
- exp1, exp2 and coef don't have to be given, they will be calculated:
+ exp1, exp2 and coef can be given, but if None or omitted they will be calculated:
- >>> pk = PrivateKey(3727264081, 65537, 3349121513, 65063, 57287)
+ >>> pk = PrivateKey(3727264081, 65537, 3349121513, 65063, 57287, exp2=4)
>>> pk.exp1
55063
- >>> pk.exp2
- 10095
+ >>> pk.exp2 # this is of course not a correct value, but it is the one we passed.
+ 4
>>> pk.coef
50797
@@ -273,13 +324,12 @@ class PrivateKey(AbstractKey):
>>> pk.coef
8
- '''
+ """
__slots__ = ('n', 'e', 'd', 'p', 'q', 'exp1', 'exp2', 'coef')
def __init__(self, n, e, d, p, q, exp1=None, exp2=None, coef=None):
- self.n = n
- self.e = e
+ AbstractKey.__init__(self, n, e)
self.d = d
self.p = p
self.q = q
@@ -290,7 +340,7 @@ class PrivateKey(AbstractKey):
else:
self.exp1 = exp1
- if exp1 is None:
+ if exp2 is None:
self.exp2 = int(d % (q - 1))
else:
self.exp2 = exp2
@@ -306,6 +356,14 @@ class PrivateKey(AbstractKey):
def __repr__(self):
return 'PrivateKey(%(n)i, %(e)i, %(d)i, %(p)i, %(q)i)' % self
+ def __getstate__(self):
+ """Returns the key as tuple for pickling."""
+ return self.n, self.e, self.d, self.p, self.q, self.exp1, self.exp2, self.coef
+
+ def __setstate__(self, state):
+ """Sets the key from tuple."""
+ self.n, self.e, self.d, self.p, self.q, self.exp1, self.exp2, self.coef = state
+
def __eq__(self, other):
if other is None:
return False
@@ -314,37 +372,68 @@ class PrivateKey(AbstractKey):
return False
return (self.n == other.n and
- self.e == other.e and
- self.d == other.d and
- self.p == other.p and
- self.q == other.q and
- self.exp1 == other.exp1 and
- self.exp2 == other.exp2 and
- self.coef == other.coef)
+ self.e == other.e and
+ self.d == other.d and
+ self.p == other.p and
+ self.q == other.q and
+ self.exp1 == other.exp1 and
+ self.exp2 == other.exp2 and
+ self.coef == other.coef)
def __ne__(self, other):
return not (self == other)
+ def blinded_decrypt(self, encrypted):
+ """Decrypts the message using blinding to prevent side-channel attacks.
+
+ :param encrypted: the encrypted message
+ :type encrypted: int
+
+ :returns: the decrypted message
+ :rtype: int
+ """
+
+ blind_r = rsa.randnum.randint(self.n - 1)
+ blinded = self.blind(encrypted, blind_r) # blind before decrypting
+ decrypted = rsa.core.decrypt_int(blinded, self.d, self.n)
+
+ return self.unblind(decrypted, blind_r)
+
+ def blinded_encrypt(self, message):
+ """Encrypts the message using blinding to prevent side-channel attacks.
+
+ :param message: the message to encrypt
+ :type message: int
+
+ :returns: the encrypted message
+ :rtype: int
+ """
+
+ blind_r = rsa.randnum.randint(self.n - 1)
+ blinded = self.blind(message, blind_r) # blind before encrypting
+ encrypted = rsa.core.encrypt_int(blinded, self.d, self.n)
+ return self.unblind(encrypted, blind_r)
+
@classmethod
def _load_pkcs1_der(cls, keyfile):
- r'''Loads a key in PKCS#1 DER format.
+ """Loads a key in PKCS#1 DER format.
- @param keyfile: contents of a DER-encoded file that contains the private
+ :param keyfile: contents of a DER-encoded file that contains the private
key.
- @return: a PrivateKey object
+ :return: a PrivateKey object
First let's construct a DER encoded key:
>>> import base64
>>> b64der = 'MC4CAQACBQDeKYlRAgMBAAECBQDHn4npAgMA/icCAwDfxwIDANcXAgInbwIDAMZt'
- >>> der = base64.decodestring(b64der)
+ >>> der = base64.standard_b64decode(b64der)
This loads the file:
>>> PrivateKey._load_pkcs1_der(der)
PrivateKey(3727264081, 65537, 3349121513, 65063, 57287)
- '''
+ """
from pyasn1.codec.der import decoder
(priv, _) = decoder.decode(keyfile)
@@ -352,16 +441,16 @@ class PrivateKey(AbstractKey):
# ASN.1 contents of DER encoded private key:
#
# RSAPrivateKey ::= SEQUENCE {
- # version Version,
+ # version Version,
# modulus INTEGER, -- n
# publicExponent INTEGER, -- e
# privateExponent INTEGER, -- d
# prime1 INTEGER, -- p
# prime2 INTEGER, -- q
# exponent1 INTEGER, -- d mod (p-1)
- # exponent2 INTEGER, -- d mod (q-1)
+ # exponent2 INTEGER, -- d mod (q-1)
# coefficient INTEGER, -- (inverse of q) mod p
- # otherPrimeInfos OtherPrimeInfos OPTIONAL
+ # otherPrimeInfos OtherPrimeInfos OPTIONAL
# }
if priv[0] != 0:
@@ -371,25 +460,25 @@ class PrivateKey(AbstractKey):
return cls(*as_ints)
def _save_pkcs1_der(self):
- '''Saves the private key in PKCS#1 DER format.
+ """Saves the private key in PKCS#1 DER format.
@returns: the DER-encoded private key.
- '''
+ """
from pyasn1.type import univ, namedtype
from pyasn1.codec.der import encoder
class AsnPrivKey(univ.Sequence):
componentType = namedtype.NamedTypes(
- namedtype.NamedType('version', univ.Integer()),
- namedtype.NamedType('modulus', univ.Integer()),
- namedtype.NamedType('publicExponent', univ.Integer()),
- namedtype.NamedType('privateExponent', univ.Integer()),
- namedtype.NamedType('prime1', univ.Integer()),
- namedtype.NamedType('prime2', univ.Integer()),
- namedtype.NamedType('exponent1', univ.Integer()),
- namedtype.NamedType('exponent2', univ.Integer()),
- namedtype.NamedType('coefficient', univ.Integer()),
+ namedtype.NamedType('version', univ.Integer()),
+ namedtype.NamedType('modulus', univ.Integer()),
+ namedtype.NamedType('publicExponent', univ.Integer()),
+ namedtype.NamedType('privateExponent', univ.Integer()),
+ namedtype.NamedType('prime1', univ.Integer()),
+ namedtype.NamedType('prime2', univ.Integer()),
+ namedtype.NamedType('exponent1', univ.Integer()),
+ namedtype.NamedType('exponent2', univ.Integer()),
+ namedtype.NamedType('coefficient', univ.Integer()),
)
# Create the ASN object
@@ -408,31 +497,32 @@ class PrivateKey(AbstractKey):
@classmethod
def _load_pkcs1_pem(cls, keyfile):
- '''Loads a PKCS#1 PEM-encoded private key file.
+ """Loads a PKCS#1 PEM-encoded private key file.
The contents of the file before the "-----BEGIN RSA PRIVATE KEY-----" and
after the "-----END RSA PRIVATE KEY-----" lines is ignored.
- @param keyfile: contents of a PEM-encoded file that contains the private
+ :param keyfile: contents of a PEM-encoded file that contains the private
key.
- @return: a PrivateKey object
- '''
+ :return: a PrivateKey object
+ """
der = rsa.pem.load_pem(keyfile, b('RSA PRIVATE KEY'))
return cls._load_pkcs1_der(der)
def _save_pkcs1_pem(self):
- '''Saves a PKCS#1 PEM-encoded private key file.
+ """Saves a PKCS#1 PEM-encoded private key file.
- @return: contents of a PEM-encoded file that contains the private key.
- '''
+ :return: contents of a PEM-encoded file that contains the private key.
+ """
der = self._save_pkcs1_der()
return rsa.pem.save_pem(der, b('RSA PRIVATE KEY'))
+
def find_p_q(nbits, getprime_func=rsa.prime.getprime, accurate=True):
- ''''Returns a tuple of two different primes of nbits bits each.
-
+ """Returns a tuple of two different primes of nbits bits each.
+
The resulting p * q has exacty 2 * nbits bits, and the returned p and q
will not be equal.
@@ -458,9 +548,9 @@ def find_p_q(nbits, getprime_func=rsa.prime.getprime, accurate=True):
True
>>> common.bit_size(p * q) > 240
True
-
- '''
-
+
+ """
+
total_bits = nbits * 2
# Make sure that p and q aren't too close or the factoring programs can
@@ -468,7 +558,7 @@ def find_p_q(nbits, getprime_func=rsa.prime.getprime, accurate=True):
shift = nbits // 16
pbits = nbits + shift
qbits = nbits - shift
-
+
# Choose the two initial primes
log.debug('find_p_q(%i): Finding p', nbits)
p = getprime_func(pbits)
@@ -476,11 +566,11 @@ def find_p_q(nbits, getprime_func=rsa.prime.getprime, accurate=True):
q = getprime_func(qbits)
def is_acceptable(p, q):
- '''Returns True iff p and q are acceptable:
-
+ """Returns True iff p and q are acceptable:
+
- p and q differ
- (p * q) has the right nr of bits (when accurate=True)
- '''
+ """
if p == q:
return False
@@ -505,49 +595,80 @@ def find_p_q(nbits, getprime_func=rsa.prime.getprime, accurate=True):
# We want p > q as described on
# http://www.di-mgt.com.au/rsa_alg.html#crt
- return (max(p, q), min(p, q))
+ return max(p, q), min(p, q)
-def calculate_keys(p, q, nbits):
- '''Calculates an encryption and a decryption key given p and q, and
- returns them as a tuple (e, d)
- '''
+def calculate_keys_custom_exponent(p, q, exponent):
+ """Calculates an encryption and a decryption key given p, q and an exponent,
+ and returns them as a tuple (e, d)
+
+ :param p: the first large prime
+ :param q: the second large prime
+ :param exponent: the exponent for the key; only change this if you know
+ what you're doing, as the exponent influences how difficult your
+ private key can be cracked. A very common choice for e is 65537.
+ :type exponent: int
+
+ """
phi_n = (p - 1) * (q - 1)
- # A very common choice for e is 65537
- e = 65537
-
try:
- d = rsa.common.inverse(e, phi_n)
+ d = rsa.common.inverse(exponent, phi_n)
except ValueError:
raise ValueError("e (%d) and phi_n (%d) are not relatively prime" %
- (e, phi_n))
+ (exponent, phi_n))
- if (e * d) % phi_n != 1:
+ if (exponent * d) % phi_n != 1:
raise ValueError("e (%d) and d (%d) are not mult. inv. modulo "
- "phi_n (%d)" % (e, d, phi_n))
+ "phi_n (%d)" % (exponent, d, phi_n))
- return (e, d)
+ return exponent, d
-def gen_keys(nbits, getprime_func, accurate=True):
- '''Generate RSA keys of nbits bits. Returns (p, q, e, d).
+
+def calculate_keys(p, q):
+ """Calculates an encryption and a decryption key given p and q, and
+ returns them as a tuple (e, d)
+
+ :param p: the first large prime
+ :param q: the second large prime
+
+ :return: tuple (e, d) with the encryption and decryption exponents.
+ """
+
+ return calculate_keys_custom_exponent(p, q, DEFAULT_EXPONENT)
+
+
+def gen_keys(nbits, getprime_func, accurate=True, exponent=DEFAULT_EXPONENT):
+ """Generate RSA keys of nbits bits. Returns (p, q, e, d).
Note: this can take a long time, depending on the key size.
-
+
:param nbits: the total number of bits in ``p`` and ``q``. Both ``p`` and
``q`` will use ``nbits/2`` bits.
:param getprime_func: either :py:func:`rsa.prime.getprime` or a function
with similar signature.
- '''
+ :param exponent: the exponent for the key; only change this if you know
+ what you're doing, as the exponent influences how difficult your
+ private key can be cracked. A very common choice for e is 65537.
+ :type exponent: int
+ """
- (p, q) = find_p_q(nbits // 2, getprime_func, accurate)
- (e, d) = calculate_keys(p, q, nbits // 2)
+ # Regenerate p and q values, until calculate_keys doesn't raise a
+ # ValueError.
+ while True:
+ (p, q) = find_p_q(nbits // 2, getprime_func, accurate)
+ try:
+ (e, d) = calculate_keys_custom_exponent(p, q, exponent=exponent)
+ break
+ except ValueError:
+ pass
- return (p, q, e, d)
+ return p, q, e, d
-def newkeys(nbits, accurate=True, poolsize=1):
- '''Generates public and private keys, and returns them as (pub, priv).
+
+def newkeys(nbits, accurate=True, poolsize=1, exponent=DEFAULT_EXPONENT):
+ """Generates public and private keys, and returns them as (pub, priv).
The public key is also known as the 'encryption key', and is a
:py:class:`rsa.PublicKey` object. The private key is also known as the
@@ -560,13 +681,17 @@ def newkeys(nbits, accurate=True, poolsize=1):
:param poolsize: the number of processes to use to generate the prime
numbers. If set to a number > 1, a parallel algorithm will be used.
This requires Python 2.6 or newer.
+ :param exponent: the exponent for the key; only change this if you know
+ what you're doing, as the exponent influences how difficult your
+ private key can be cracked. A very common choice for e is 65537.
+ :type exponent: int
:returns: a tuple (:py:class:`rsa.PublicKey`, :py:class:`rsa.PrivateKey`)
The ``poolsize`` parameter was added in *Python-RSA 3.1* and requires
Python 2.6 or newer.
-
- '''
+
+ """
if nbits < 16:
raise ValueError('Key too small')
@@ -580,11 +705,12 @@ def newkeys(nbits, accurate=True, poolsize=1):
import functools
getprime_func = functools.partial(parallel.getprime, poolsize=poolsize)
- else: getprime_func = rsa.prime.getprime
+ else:
+ getprime_func = rsa.prime.getprime
# Generate the key components
- (p, q, e, d) = gen_keys(nbits, getprime_func)
-
+ (p, q, e, d) = gen_keys(nbits, getprime_func, accurate=accurate, exponent=exponent)
+
# Create the key objects
n = p * q
@@ -593,11 +719,12 @@ def newkeys(nbits, accurate=True, poolsize=1):
PrivateKey(n, e, d, p, q)
)
+
__all__ = ['PublicKey', 'PrivateKey', 'newkeys']
if __name__ == '__main__':
import doctest
-
+
try:
for count in range(100):
(failures, tests) = doctest.testmod()
diff --git a/src/lib/rsa/parallel.py b/src/lib/rsa/parallel.py
index e5034ac7..edc924fd 100644
--- a/src/lib/rsa/parallel.py
+++ b/src/lib/rsa/parallel.py
@@ -6,7 +6,7 @@
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,7 +14,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-'''Functions for parallel computation on multiple cores.
+"""Functions for parallel computation on multiple cores.
Introduced in Python-RSA 3.1.
@@ -22,7 +22,7 @@ Introduced in Python-RSA 3.1.
Requires Python 2.6 or newer.
-'''
+"""
from __future__ import print_function
@@ -31,20 +31,19 @@ import multiprocessing as mp
import rsa.prime
import rsa.randnum
+
def _find_prime(nbits, pipe):
while True:
- integer = rsa.randnum.read_random_int(nbits)
-
- # Make sure it's odd
- integer |= 1
+ integer = rsa.randnum.read_random_odd_int(nbits)
# Test for primeness
if rsa.prime.is_prime(integer):
pipe.send(integer)
return
+
def getprime(nbits, poolsize):
- '''Returns a prime number that can be stored in 'nbits' bits.
+ """Returns a prime number that can be stored in 'nbits' bits.
Works in multiple threads at the same time.
@@ -55,40 +54,47 @@ def getprime(nbits, poolsize):
True
>>> rsa.prime.is_prime(p+1)
False
-
+
>>> from rsa import common
>>> common.bit_size(p) == 128
True
-
- '''
+
+ """
(pipe_recv, pipe_send) = mp.Pipe(duplex=False)
# Create processes
- procs = [mp.Process(target=_find_prime, args=(nbits, pipe_send))
- for _ in range(poolsize)]
- [p.start() for p in procs]
+ try:
+ procs = [mp.Process(target=_find_prime, args=(nbits, pipe_send))
+ for _ in range(poolsize)]
+ # Start processes
+ for p in procs:
+ p.start()
- result = pipe_recv.recv()
+ result = pipe_recv.recv()
+ finally:
+ pipe_recv.close()
+ pipe_send.close()
- [p.terminate() for p in procs]
+ # Terminate processes
+ for p in procs:
+ p.terminate()
return result
+
__all__ = ['getprime']
-
if __name__ == '__main__':
print('Running doctests 1000x or until failure')
import doctest
-
+
for count in range(100):
(failures, tests) = doctest.testmod()
if failures:
break
-
+
if count and count % 10 == 0:
print('%i times' % count)
-
- print('Doctests done')
+ print('Doctests done')
diff --git a/src/lib/rsa/pem.py b/src/lib/rsa/pem.py
index b1c3a0ed..0f68cb2a 100644
--- a/src/lib/rsa/pem.py
+++ b/src/lib/rsa/pem.py
@@ -6,7 +6,7 @@
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,15 +14,16 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-'''Functions that load and write PEM-encoded files.'''
+"""Functions that load and write PEM-encoded files."""
import base64
from rsa._compat import b, is_bytes
+
def _markers(pem_marker):
- '''
+ """
Returns the start and end PEM markers
- '''
+ """
if is_bytes(pem_marker):
pem_marker = pem_marker.decode('utf-8')
@@ -30,20 +31,25 @@ def _markers(pem_marker):
return (b('-----BEGIN %s-----' % pem_marker),
b('-----END %s-----' % pem_marker))
-def load_pem(contents, pem_marker):
- '''Loads a PEM file.
- @param contents: the contents of the file to interpret
- @param pem_marker: the marker of the PEM content, such as 'RSA PRIVATE KEY'
+def load_pem(contents, pem_marker):
+ """Loads a PEM file.
+
+ :param contents: the contents of the file to interpret
+ :param pem_marker: the marker of the PEM content, such as 'RSA PRIVATE KEY'
when your file has '-----BEGIN RSA PRIVATE KEY-----' and
'-----END RSA PRIVATE KEY-----' markers.
- @return the base64-decoded content between the start and end markers.
+ :return: the base64-decoded content between the start and end markers.
@raise ValueError: when the content is invalid, for example when the start
marker cannot be found.
- '''
+ """
+
+ # We want bytes, not text. If it's text, it can be converted to ASCII bytes.
+ if not is_bytes(contents):
+ contents = contents.encode('ascii')
(pem_start, pem_end) = _markers(pem_marker)
@@ -89,26 +95,26 @@ def load_pem(contents, pem_marker):
# Base64-decode the contents
pem = b('').join(pem_lines)
- return base64.decodestring(pem)
+ return base64.standard_b64decode(pem)
def save_pem(contents, pem_marker):
- '''Saves a PEM file.
+ """Saves a PEM file.
- @param contents: the contents to encode in PEM format
- @param pem_marker: the marker of the PEM content, such as 'RSA PRIVATE KEY'
+ :param contents: the contents to encode in PEM format
+ :param pem_marker: the marker of the PEM content, such as 'RSA PRIVATE KEY'
when your file has '-----BEGIN RSA PRIVATE KEY-----' and
'-----END RSA PRIVATE KEY-----' markers.
- @return the base64-encoded content between the start and end markers.
+ :return: the base64-encoded content between the start and end markers.
- '''
+ """
(pem_start, pem_end) = _markers(pem_marker)
- b64 = base64.encodestring(contents).replace(b('\n'), b(''))
+ b64 = base64.standard_b64encode(contents).replace(b('\n'), b(''))
pem_lines = [pem_start]
-
+
for block_start in range(0, len(b64), 64):
block = b64[block_start:block_start + 64]
pem_lines.append(block)
@@ -117,4 +123,3 @@ def save_pem(contents, pem_marker):
pem_lines.append(b(''))
return b('\n').join(pem_lines)
-
diff --git a/src/lib/rsa/pkcs1.py b/src/lib/rsa/pkcs1.py
index 15e4cf63..28f0dc54 100644
--- a/src/lib/rsa/pkcs1.py
+++ b/src/lib/rsa/pkcs1.py
@@ -6,7 +6,7 @@
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,7 +14,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-'''Functions for PKCS#1 version 1.5 encryption and signing
+"""Functions for PKCS#1 version 1.5 encryption and signing
This module implements certain functionality from PKCS#1 version 1.5. For a
very clear example, read http://www.di-mgt.com.au/rsa_alg.html#pkcs1schemes
@@ -22,17 +22,17 @@ very clear example, read http://www.di-mgt.com.au/rsa_alg.html#pkcs1schemes
At least 8 bytes of random padding is used when encrypting a message. This makes
these methods much more secure than the ones in the ``rsa`` module.
-WARNING: this module leaks information when decryption or verification fails.
-The exceptions that are raised contain the Python traceback information, which
-can be used to deduce where in the process the failure occurred. DO NOT PASS
-SUCH INFORMATION to your users.
-'''
+WARNING: this module leaks information when decryption fails. The exceptions
+that are raised contain the Python traceback information, which can be used to
+deduce where in the process the failure occurred. DO NOT PASS SUCH INFORMATION
+to your users.
+"""
import hashlib
import os
from rsa._compat import b
-from rsa import common, transform, core, varblock
+from rsa import common, transform, core
# ASN.1 codes that describe the hash algorithm used.
HASH_ASN1 = {
@@ -51,133 +51,138 @@ HASH_METHODS = {
'SHA-512': hashlib.sha512,
}
+
class CryptoError(Exception):
- '''Base class for all exceptions in this module.'''
+ """Base class for all exceptions in this module."""
+
class DecryptionError(CryptoError):
- '''Raised when decryption fails.'''
+ """Raised when decryption fails."""
+
class VerificationError(CryptoError):
- '''Raised when verification fails.'''
-
+ """Raised when verification fails."""
+
+
def _pad_for_encryption(message, target_length):
- r'''Pads the message for encryption, returning the padded message.
-
+ r"""Pads the message for encryption, returning the padded message.
+
:return: 00 02 RANDOM_DATA 00 MESSAGE
-
- >>> block = _pad_for_encryption('hello', 16)
+
+ >>> block = _pad_for_encryption(b'hello', 16)
>>> len(block)
16
>>> block[0:2]
- '\x00\x02'
+ b'\x00\x02'
>>> block[-6:]
- '\x00hello'
+ b'\x00hello'
- '''
+ """
max_msglength = target_length - 11
msglength = len(message)
-
+
if msglength > max_msglength:
raise OverflowError('%i bytes needed for message, but there is only'
- ' space for %i' % (msglength, max_msglength))
-
+ ' space for %i' % (msglength, max_msglength))
+
# Get random padding
padding = b('')
padding_length = target_length - msglength - 3
-
+
# We remove 0-bytes, so we'll end up with less padding than we've asked for,
# so keep adding data until we're at the correct length.
while len(padding) < padding_length:
needed_bytes = padding_length - len(padding)
-
+
# Always read at least 8 bytes more than we need, and trim off the rest
# after removing the 0-bytes. This increases the chance of getting
# enough bytes, especially when needed_bytes is small
new_padding = os.urandom(needed_bytes + 5)
new_padding = new_padding.replace(b('\x00'), b(''))
padding = padding + new_padding[:needed_bytes]
-
+
assert len(padding) == padding_length
-
+
return b('').join([b('\x00\x02'),
- padding,
- b('\x00'),
- message])
-
+ padding,
+ b('\x00'),
+ message])
+
def _pad_for_signing(message, target_length):
- r'''Pads the message for signing, returning the padded message.
-
+ r"""Pads the message for signing, returning the padded message.
+
The padding is always a repetition of FF bytes.
-
+
:return: 00 01 PADDING 00 MESSAGE
-
- >>> block = _pad_for_signing('hello', 16)
+
+ >>> block = _pad_for_signing(b'hello', 16)
>>> len(block)
16
>>> block[0:2]
- '\x00\x01'
+ b'\x00\x01'
>>> block[-6:]
- '\x00hello'
+ b'\x00hello'
>>> block[2:-6]
- '\xff\xff\xff\xff\xff\xff\xff\xff'
-
- '''
+ b'\xff\xff\xff\xff\xff\xff\xff\xff'
+
+ """
max_msglength = target_length - 11
msglength = len(message)
-
+
if msglength > max_msglength:
raise OverflowError('%i bytes needed for message, but there is only'
- ' space for %i' % (msglength, max_msglength))
-
+ ' space for %i' % (msglength, max_msglength))
+
padding_length = target_length - msglength - 3
-
+
return b('').join([b('\x00\x01'),
- padding_length * b('\xff'),
- b('\x00'),
- message])
-
-
+ padding_length * b('\xff'),
+ b('\x00'),
+ message])
+
+
def encrypt(message, pub_key):
- '''Encrypts the given message using PKCS#1 v1.5
-
+ """Encrypts the given message using PKCS#1 v1.5
+
:param message: the message to encrypt. Must be a byte string no longer than
``k-11`` bytes, where ``k`` is the number of bytes needed to encode
the ``n`` component of the public key.
:param pub_key: the :py:class:`rsa.PublicKey` to encrypt with.
:raise OverflowError: when the message is too large to fit in the padded
block.
-
+
>>> from rsa import key, common
>>> (pub_key, priv_key) = key.newkeys(256)
- >>> message = 'hello'
+ >>> message = b'hello'
>>> crypto = encrypt(message, pub_key)
-
+
The crypto text should be just as long as the public key 'n' component:
>>> len(crypto) == common.byte_size(pub_key.n)
True
-
- '''
-
+
+ """
+
keylength = common.byte_size(pub_key.n)
padded = _pad_for_encryption(message, keylength)
-
+
payload = transform.bytes2int(padded)
encrypted = core.encrypt_int(payload, pub_key.e, pub_key.n)
block = transform.int2bytes(encrypted, keylength)
-
+
return block
+
def decrypt(crypto, priv_key):
- r'''Decrypts the given message using PKCS#1 v1.5
-
+ r"""Decrypts the given message using PKCS#1 v1.5
+
The decryption is considered 'failed' when the resulting cleartext doesn't
start with the bytes 00 02, or when the 00 byte between the padding and
the message cannot be found.
-
+
:param crypto: the crypto text as returned by :py:func:`rsa.encrypt`
:param priv_key: the :py:class:`rsa.PrivateKey` to decrypt with.
:raise DecryptionError: when the decryption fails. No details are given as
@@ -190,15 +195,15 @@ def decrypt(crypto, priv_key):
It works with strings:
- >>> crypto = encrypt('hello', pub_key)
+ >>> crypto = encrypt(b'hello', pub_key)
>>> decrypt(crypto, priv_key)
- 'hello'
-
+ b'hello'
+
And with binary data:
- >>> crypto = encrypt('\x00\x00\x00\x00\x01', pub_key)
+ >>> crypto = encrypt(b'\x00\x00\x00\x00\x01', pub_key)
>>> decrypt(crypto, priv_key)
- '\x00\x00\x00\x00\x01'
+ b'\x00\x00\x00\x00\x01'
Altering the encrypted information will *likely* cause a
:py:class:`rsa.pkcs1.DecryptionError`. If you want to be *sure*, use
@@ -213,38 +218,39 @@ def decrypt(crypto, priv_key):
It's only a tiny bit of information, but every bit makes cracking the
keys easier.
- >>> crypto = encrypt('hello', pub_key)
- >>> crypto = crypto[0:5] + 'X' + crypto[6:] # change a byte
+ >>> crypto = encrypt(b'hello', pub_key)
+ >>> crypto = crypto[0:5] + b'X' + crypto[6:] # change a byte
>>> decrypt(crypto, priv_key)
Traceback (most recent call last):
...
- DecryptionError: Decryption failed
+ rsa.pkcs1.DecryptionError: Decryption failed
+
+ """
- '''
-
blocksize = common.byte_size(priv_key.n)
encrypted = transform.bytes2int(crypto)
- decrypted = core.decrypt_int(encrypted, priv_key.d, priv_key.n)
+ decrypted = priv_key.blinded_decrypt(encrypted)
cleartext = transform.int2bytes(decrypted, blocksize)
# If we can't find the cleartext marker, decryption failed.
if cleartext[0:2] != b('\x00\x02'):
raise DecryptionError('Decryption failed')
-
+
# Find the 00 separator between the padding and the message
try:
sep_idx = cleartext.index(b('\x00'), 2)
except ValueError:
raise DecryptionError('Decryption failed')
-
- return cleartext[sep_idx+1:]
-
+
+ return cleartext[sep_idx + 1:]
+
+
def sign(message, priv_key, hash):
- '''Signs the message with the private key.
+ """Signs the message with the private key.
Hashes the message, then signs the hash with the given key. This is known
as a "detached signature", because the message itself isn't altered.
-
+
:param message: the message to sign. Can be an 8-bit string or a file-like
object. If ``message`` has a ``read()`` method, it is assumed to be a
file-like object.
@@ -255,13 +261,13 @@ def sign(message, priv_key, hash):
:raise OverflowError: if the private key is too small to contain the
requested hash.
- '''
+ """
# Get the ASN1 code for this hash method
if hash not in HASH_ASN1:
raise ValueError('Invalid hash method: %s' % hash)
asn1code = HASH_ASN1[hash]
-
+
# Calculate the hash
hash = _hash(message, hash)
@@ -269,18 +275,19 @@ def sign(message, priv_key, hash):
cleartext = asn1code + hash
keylength = common.byte_size(priv_key.n)
padded = _pad_for_signing(cleartext, keylength)
-
+
payload = transform.bytes2int(padded)
- encrypted = core.encrypt_int(payload, priv_key.d, priv_key.n)
+ encrypted = priv_key.blinded_encrypt(payload)
block = transform.int2bytes(encrypted, keylength)
-
+
return block
+
def verify(message, signature, pub_key):
- '''Verifies that the signature matches the message.
-
+ """Verifies that the signature matches the message.
+
The hash method is detected automatically from the signature.
-
+
:param message: the signed message. Can be an 8-bit string or a file-like
object. If ``message`` has a ``read()`` method, it is assumed to be a
file-like object.
@@ -288,59 +295,49 @@ def verify(message, signature, pub_key):
:param pub_key: the :py:class:`rsa.PublicKey` of the person signing the message.
:raise VerificationError: when the signature doesn't match the message.
- .. warning::
+ """
- Never display the stack trace of a
- :py:class:`rsa.pkcs1.VerificationError` exception. It shows where in
- the code the exception occurred, and thus leaks information about the
- key. It's only a tiny bit of information, but every bit makes cracking
- the keys easier.
-
- '''
-
- blocksize = common.byte_size(pub_key.n)
+ keylength = common.byte_size(pub_key.n)
encrypted = transform.bytes2int(signature)
decrypted = core.decrypt_int(encrypted, pub_key.e, pub_key.n)
- clearsig = transform.int2bytes(decrypted, blocksize)
+ clearsig = transform.int2bytes(decrypted, keylength)
- # If we can't find the signature marker, verification failed.
- if clearsig[0:2] != b('\x00\x01'):
- raise VerificationError('Verification failed')
-
- # Find the 00 separator between the padding and the payload
- try:
- sep_idx = clearsig.index(b('\x00'), 2)
- except ValueError:
- raise VerificationError('Verification failed')
-
- # Get the hash and the hash method
- (method_name, signature_hash) = _find_method_hash(clearsig[sep_idx+1:])
+ # Get the hash method
+ method_name = _find_method_hash(clearsig)
message_hash = _hash(message, method_name)
- # Compare the real hash to the hash in the signature
- if message_hash != signature_hash:
+ # Reconstruct the expected padded hash
+ cleartext = HASH_ASN1[method_name] + message_hash
+ expected = _pad_for_signing(cleartext, keylength)
+
+ # Compare with the signed one
+ if expected != clearsig:
raise VerificationError('Verification failed')
return True
+
def _hash(message, method_name):
- '''Returns the message digest.
-
+ """Returns the message digest.
+
:param message: the signed message. Can be an 8-bit string or a file-like
object. If ``message`` has a ``read()`` method, it is assumed to be a
file-like object.
:param method_name: the hash method, must be a key of
:py:const:`HASH_METHODS`.
-
- '''
+
+ """
if method_name not in HASH_METHODS:
raise ValueError('Invalid hash method: %s' % method_name)
-
+
method = HASH_METHODS[method_name]
hasher = method()
if hasattr(message, 'read') and hasattr(message.read, '__call__'):
+ # Late import to prevent DeprecationWarnings.
+ from . import varblock
+
# read as 1K blocks
for block in varblock.yield_fixedblocks(message, 1024):
hasher.update(block)
@@ -351,25 +348,18 @@ def _hash(message, method_name):
return hasher.digest()
-def _find_method_hash(method_hash):
- '''Finds the hash method and the hash itself.
-
- :param method_hash: ASN1 code for the hash method concatenated with the
- hash itself.
-
- :return: tuple (method, hash) where ``method`` is the used hash method, and
- ``hash`` is the hash itself.
-
- :raise VerificationFailed: when the hash method cannot be found
+def _find_method_hash(clearsig):
+ """Finds the hash method.
- '''
+ :param clearsig: full padded ASN1 and hash.
+ :return: the used hash method.
+ :raise VerificationFailed: when the hash method cannot be found
+ """
for (hashname, asn1code) in HASH_ASN1.items():
- if not method_hash.startswith(asn1code):
- continue
-
- return (hashname, method_hash[len(asn1code):])
-
+ if asn1code in clearsig:
+ return hashname
+
raise VerificationError('Verification failed')
@@ -379,13 +369,13 @@ __all__ = ['encrypt', 'decrypt', 'sign', 'verify',
if __name__ == '__main__':
print('Running doctests 1000x or until failure')
import doctest
-
+
for count in range(1000):
(failures, tests) = doctest.testmod()
if failures:
break
-
+
if count and count % 100 == 0:
print('%i times' % count)
-
+
print('Doctests done')
diff --git a/src/lib/rsa/prime.py b/src/lib/rsa/prime.py
index 7422eb1d..6f23f9da 100644
--- a/src/lib/rsa/prime.py
+++ b/src/lib/rsa/prime.py
@@ -6,7 +6,7 @@
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,102 +14,115 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-'''Numerical functions related to primes.
+"""Numerical functions related to primes.
Implementation based on the book Algorithm Design by Michael T. Goodrich and
Roberto Tamassia, 2002.
-'''
-
-__all__ = [ 'getprime', 'are_relatively_prime']
+"""
import rsa.randnum
+__all__ = ['getprime', 'are_relatively_prime']
+
+
def gcd(p, q):
- '''Returns the greatest common divisor of p and q
+ """Returns the greatest common divisor of p and q
>>> gcd(48, 180)
12
- '''
+ """
while q != 0:
- if p < q: (p,q) = (q,p)
- (p,q) = (q, p % q)
+ (p, q) = (q, p % q)
return p
-
-def jacobi(a, b):
- '''Calculates the value of the Jacobi symbol (a/b) where both a and b are
- positive integers, and b is odd
- :returns: -1, 0 or 1
- '''
+def miller_rabin_primality_testing(n, k):
+ """Calculates whether n is composite (which is always correct) or prime
+ (which theoretically is incorrect with error probability 4**-k), by
+ applying Miller-Rabin primality testing.
- assert a > 0
- assert b > 0
+ For reference and implementation example, see:
+ https://en.wikipedia.org/wiki/Miller%E2%80%93Rabin_primality_test
- if a == 0: return 0
- result = 1
- while a > 1:
- if a & 1:
- if ((a-1)*(b-1) >> 2) & 1:
- result = -result
- a, b = b % a, a
- else:
- if (((b * b) - 1) >> 3) & 1:
- result = -result
- a >>= 1
- if a == 0: return 0
- return result
+ :param n: Integer to be tested for primality.
+ :type n: int
+ :param k: Number of rounds (witnesses) of Miller-Rabin testing.
+ :type k: int
+ :return: False if the number is composite, True if it's probably prime.
+ :rtype: bool
+ """
-def jacobi_witness(x, n):
- '''Returns False if n is an Euler pseudo-prime with base x, and
- True otherwise.
- '''
+ # prevent potential infinite loop when d = 0
+ if n < 2:
+ return False
- j = jacobi(x, n) % n
+ # Decompose (n - 1) to write it as (2 ** r) * d
+ # While d is even, divide it by 2 and increase the exponent.
+ d = n - 1
+ r = 0
- f = pow(x, n >> 1, n)
-
- if j == f: return False
- return True
-
-def randomized_primality_testing(n, k):
- '''Calculates whether n is composite (which is always correct) or
- prime (which is incorrect with error probability 2**-k)
-
- Returns False if the number is composite, and True if it's
- probably prime.
- '''
-
- # 50% of Jacobi-witnesses can report compositness of non-prime numbers
-
- # The implemented algorithm using the Jacobi witness function has error
- # probability q <= 0.5, according to Goodrich et. al
- #
- # q = 0.5
- # t = int(math.ceil(k / log(1 / q, 2)))
- # So t = k / log(2, 2) = k / 1 = k
- # this means we can use range(k) rather than range(t)
+ while not (d & 1):
+ r += 1
+ d >>= 1
+ # Test k witnesses.
for _ in range(k):
- x = rsa.randnum.randint(n-1)
- if jacobi_witness(x, n): return False
-
+ # Generate random integer a, where 2 <= a <= (n - 2)
+ a = rsa.randnum.randint(n - 4) + 2
+
+ x = pow(a, d, n)
+ if x == 1 or x == n - 1:
+ continue
+
+ for _ in range(r - 1):
+ x = pow(x, 2, n)
+ if x == 1:
+ # n is composite.
+ return False
+ if x == n - 1:
+ # Exit inner loop and continue with next witness.
+ break
+ else:
+ # If loop doesn't break, n is composite.
+ return False
+
return True
+
def is_prime(number):
- '''Returns True if the number is prime, and False otherwise.
+ """Returns True if the number is prime, and False otherwise.
+ >>> is_prime(2)
+ True
>>> is_prime(42)
False
>>> is_prime(41)
True
- '''
+ >>> [x for x in range(901, 1000) if is_prime(x)]
+ [907, 911, 919, 929, 937, 941, 947, 953, 967, 971, 977, 983, 991, 997]
+ """
+
+ # Check for small numbers.
+ if number < 10:
+ return number in [2, 3, 5, 7]
+
+ # Check for even numbers.
+ if not (number & 1):
+ return False
+
+ # According to NIST FIPS 186-4, Appendix C, Table C.3, minimum number of
+ # rounds of M-R testing, using an error probability of 2 ** (-100), for
+ # different p, q bitsizes are:
+ # * p, q bitsize: 512; rounds: 7
+ # * p, q bitsize: 1024; rounds: 4
+ # * p, q bitsize: 1536; rounds: 3
+ # See: http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-4.pdf
+ return miller_rabin_primality_testing(number, 7)
- return randomized_primality_testing(number, 6)
def getprime(nbits):
- '''Returns a prime number that can be stored in 'nbits' bits.
+ """Returns a prime number that can be stored in 'nbits' bits.
>>> p = getprime(128)
>>> is_prime(p-1)
@@ -118,49 +131,48 @@ def getprime(nbits):
True
>>> is_prime(p+1)
False
-
+
>>> from rsa import common
>>> common.bit_size(p) == 128
True
-
- '''
+ """
+
+ assert nbits > 3 # the loop wil hang on too small numbers
while True:
- integer = rsa.randnum.read_random_int(nbits)
-
- # Make sure it's odd
- integer |= 1
+ integer = rsa.randnum.read_random_odd_int(nbits)
# Test for primeness
if is_prime(integer):
return integer
- # Retry if not prime
+ # Retry if not prime
def are_relatively_prime(a, b):
- '''Returns True if a and b are relatively prime, and False if they
+ """Returns True if a and b are relatively prime, and False if they
are not.
>>> are_relatively_prime(2, 3)
- 1
+ True
>>> are_relatively_prime(2, 4)
- 0
- '''
+ False
+ """
d = gcd(a, b)
- return (d == 1)
-
+ return d == 1
+
+
if __name__ == '__main__':
print('Running doctests 1000x or until failure')
import doctest
-
+
for count in range(1000):
(failures, tests) = doctest.testmod()
if failures:
break
-
+
if count and count % 100 == 0:
print('%i times' % count)
-
+
print('Doctests done')
diff --git a/src/lib/rsa/randnum.py b/src/lib/rsa/randnum.py
index 0e782744..3c788a57 100644
--- a/src/lib/rsa/randnum.py
+++ b/src/lib/rsa/randnum.py
@@ -6,7 +6,7 @@
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,7 +14,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-'''Functions for generating random numbers.'''
+"""Functions for generating random numbers."""
# Source inspired by code by Yesudeep Mangalapilly <yesudeep@gmail.com>
@@ -23,12 +23,13 @@ import os
from rsa import common, transform
from rsa._compat import byte
+
def read_random_bits(nbits):
- '''Reads 'nbits' random bits.
+ """Reads 'nbits' random bits.
If nbits isn't a whole number of bytes, an extra byte will be appended with
only the lower bits set.
- '''
+ """
nbytes, rbits = divmod(nbits, 8)
@@ -45,8 +46,8 @@ def read_random_bits(nbits):
def read_random_int(nbits):
- '''Reads a random integer of approximately nbits bits.
- '''
+ """Reads a random integer of approximately nbits bits.
+ """
randomdata = read_random_bits(nbits)
value = transform.bytes2int(randomdata)
@@ -57,13 +58,27 @@ def read_random_int(nbits):
return value
+
+def read_random_odd_int(nbits):
+ """Reads a random odd integer of approximately nbits bits.
+
+ >>> read_random_odd_int(512) & 1
+ 1
+ """
+
+ value = read_random_int(nbits)
+
+ # Make sure it's odd
+ return value | 1
+
+
def randint(maxvalue):
- '''Returns a random integer x with 1 <= x <= maxvalue
-
+ """Returns a random integer x with 1 <= x <= maxvalue
+
May take a very long time in specific situations. If maxvalue needs N bits
to store, the closer maxvalue is to (2 ** N) - 1, the faster this function
is.
- '''
+ """
bit_size = common.bit_size(maxvalue)
@@ -81,5 +96,3 @@ def randint(maxvalue):
tries += 1
return value
-
-
diff --git a/src/lib/rsa/transform.py b/src/lib/rsa/transform.py
index c740b2d2..16061a94 100644
--- a/src/lib/rsa/transform.py
+++ b/src/lib/rsa/transform.py
@@ -6,7 +6,7 @@
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,10 +14,10 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-'''Data transformation functions.
+"""Data transformation functions.
From bytes to a number, number to bytes, etc.
-'''
+"""
from __future__ import absolute_import
@@ -26,6 +26,7 @@ try:
# Using psyco (if available) cuts down the execution time on Python 2.5
# at least by half.
import psyco
+
psyco.full()
except ImportError:
pass
@@ -37,32 +38,32 @@ from rsa._compat import is_integer, b, byte, get_word_alignment, ZERO_BYTE, EMPT
def bytes2int(raw_bytes):
- r'''Converts a list of bytes or an 8-bit string to an integer.
+ r"""Converts a list of bytes or an 8-bit string to an integer.
When using unicode strings, encode it to some encoding like UTF8 first.
>>> (((128 * 256) + 64) * 256) + 15
8405007
- >>> bytes2int('\x80@\x0f')
+ >>> bytes2int(b'\x80@\x0f')
8405007
- '''
+ """
return int(binascii.hexlify(raw_bytes), 16)
def _int2bytes(number, block_size=None):
- r'''Converts a number to a string of bytes.
+ r"""Converts a number to a string of bytes.
Usage::
>>> _int2bytes(123456789)
- '\x07[\xcd\x15'
+ b'\x07[\xcd\x15'
>>> bytes2int(_int2bytes(123456789))
123456789
>>> _int2bytes(123456789, 6)
- '\x00\x00\x07[\xcd\x15'
+ b'\x00\x00\x07[\xcd\x15'
>>> bytes2int(_int2bytes(123456789, 128))
123456789
@@ -78,11 +79,12 @@ def _int2bytes(number, block_size=None):
@throws OverflowError when block_size is given and the number takes up more
bytes than fit into the block.
- '''
+ """
+
# Type checking
if not is_integer(number):
raise TypeError("You must pass an integer for 'number', not %s" %
- number.__class__)
+ number.__class__)
if number < 0:
raise ValueError('Negative numbers cannot be used: %i' % number)
@@ -99,7 +101,7 @@ def _int2bytes(number, block_size=None):
if block_size and block_size > 0:
if needed_bytes > block_size:
raise OverflowError('Needed %i bytes for number, but block size '
- 'is %i' % (needed_bytes, block_size))
+ 'is %i' % (needed_bytes, block_size))
# Convert the number to bytes.
while number > 0:
@@ -116,7 +118,7 @@ def _int2bytes(number, block_size=None):
def bytes_leading(raw_bytes, needle=ZERO_BYTE):
- '''
+ """
Finds the number of prefixed byte occurrences in the haystack.
Useful when you want to deal with padding.
@@ -127,7 +129,8 @@ def bytes_leading(raw_bytes, needle=ZERO_BYTE):
The byte to count. Default \000.
:returns:
The number of leading needle bytes.
- '''
+ """
+
leading = 0
# Indexing keeps compatibility between Python 2.x and Python 3.x
_byte = needle[0]
@@ -140,7 +143,7 @@ def bytes_leading(raw_bytes, needle=ZERO_BYTE):
def int2bytes(number, fill_size=None, chunk_size=None, overflow=False):
- '''
+ """
Convert an unsigned integer to bytes (base-256 representation)::
Does not preserve leading zeros if you don't specify a chunk size or
@@ -172,7 +175,8 @@ def int2bytes(number, fill_size=None, chunk_size=None, overflow=False):
bytes than fit into the block. This requires the ``overflow``
argument to this function to be set to ``False`` otherwise, no
error will be raised.
- '''
+ """
+
if number < 0:
raise ValueError("Number must be an unsigned integer: %d" % number)
@@ -202,8 +206,8 @@ def int2bytes(number, fill_size=None, chunk_size=None, overflow=False):
if fill_size and fill_size > 0:
if not overflow and length > fill_size:
raise OverflowError(
- "Need %d bytes for number, but fill size is %d" %
- (length, fill_size)
+ "Need %d bytes for number, but fill size is %d" %
+ (length, fill_size)
)
raw_bytes = raw_bytes.rjust(fill_size, ZERO_BYTE)
elif chunk_size and chunk_size > 0:
@@ -216,5 +220,5 @@ def int2bytes(number, fill_size=None, chunk_size=None, overflow=False):
if __name__ == '__main__':
import doctest
- doctest.testmod()
+ doctest.testmod()
diff --git a/src/lib/rsa/util.py b/src/lib/rsa/util.py
index 5bbb70be..29d5eb12 100644
--- a/src/lib/rsa/util.py
+++ b/src/lib/rsa/util.py
@@ -6,7 +6,7 @@
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,7 +14,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-'''Utility functions.'''
+"""Utility functions."""
from __future__ import with_statement, print_function
@@ -23,34 +23,35 @@ from optparse import OptionParser
import rsa.key
+
def private_to_public():
- '''Reads a private key and outputs the corresponding public key.'''
+ """Reads a private key and outputs the corresponding public key."""
# Parse the CLI options
parser = OptionParser(usage='usage: %prog [options]',
- description='Reads a private key and outputs the '
- 'corresponding public key. Both private and public keys use '
- 'the format described in PKCS#1 v1.5')
+ description='Reads a private key and outputs the '
+ 'corresponding public key. Both private and public keys use '
+ 'the format described in PKCS#1 v1.5')
parser.add_option('-i', '--input', dest='infilename', type='string',
- help='Input filename. Reads from stdin if not specified')
+ help='Input filename. Reads from stdin if not specified')
parser.add_option('-o', '--output', dest='outfilename', type='string',
- help='Output filename. Writes to stdout of not specified')
+ help='Output filename. Writes to stdout of not specified')
parser.add_option('--inform', dest='inform',
- help='key format of input - default PEM',
- choices=('PEM', 'DER'), default='PEM')
+ help='key format of input - default PEM',
+ choices=('PEM', 'DER'), default='PEM')
parser.add_option('--outform', dest='outform',
- help='key format of output - default PEM',
- choices=('PEM', 'DER'), default='PEM')
+ help='key format of output - default PEM',
+ choices=('PEM', 'DER'), default='PEM')
(cli, cli_args) = parser.parse_args(sys.argv)
# Read the input data
if cli.infilename:
- print('Reading private key from %s in %s format' % \
- (cli.infilename, cli.inform), file=sys.stderr)
+ print('Reading private key from %s in %s format' %
+ (cli.infilename, cli.inform), file=sys.stderr)
with open(cli.infilename, 'rb') as infile:
in_data = infile.read()
else:
@@ -60,7 +61,6 @@ def private_to_public():
assert type(in_data) == bytes, type(in_data)
-
# Take the public fields and create a public key
priv_key = rsa.key.PrivateKey.load_pkcs1(in_data, cli.inform)
pub_key = rsa.key.PublicKey(priv_key.n, priv_key.e)
@@ -69,13 +69,11 @@ def private_to_public():
out_data = pub_key.save_pkcs1(cli.outform)
if cli.outfilename:
- print('Writing public key to %s in %s format' % \
- (cli.outfilename, cli.outform), file=sys.stderr)
+ print('Writing public key to %s in %s format' %
+ (cli.outfilename, cli.outform), file=sys.stderr)
with open(cli.outfilename, 'wb') as outfile:
outfile.write(out_data)
else:
print('Writing public key to stdout in %s format' % cli.outform,
file=sys.stderr)
sys.stdout.write(out_data.decode('ascii'))
-
-
diff --git a/src/lib/rsa/varblock.py b/src/lib/rsa/varblock.py
index c7d96ae6..1c8d8390 100644
--- a/src/lib/rsa/varblock.py
+++ b/src/lib/rsa/varblock.py
@@ -6,7 +6,7 @@
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,7 +14,25 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-'''VARBLOCK file support
+"""VARBLOCK file support
+
+.. deprecated:: 3.4
+
+ The VARBLOCK format is NOT recommended for general use, has been deprecated since
+ Python-RSA 3.4, and will be removed in a future release. It's vulnerable to a
+ number of attacks:
+
+ 1. decrypt/encrypt_bigfile() does not implement `Authenticated encryption`_ nor
+ uses MACs to verify messages before decrypting public key encrypted messages.
+
+ 2. decrypt/encrypt_bigfile() does not use hybrid encryption (it uses plain RSA)
+ and has no method for chaining, so block reordering is possible.
+
+ See `issue #19 on Github`_ for more information.
+
+.. _Authenticated encryption: https://en.wikipedia.org/wiki/Authenticated_encryption
+.. _issue #19 on Github: https://github.com/sybrenstuvel/python-rsa/issues/13
+
The VARBLOCK file format is as follows, where || denotes byte concatenation:
@@ -31,25 +49,32 @@ The VARBLOCK file format is as follows, where || denotes byte concatenation:
This file format is called the VARBLOCK format, in line with the varint format
used to denote the block sizes.
-'''
+"""
+
+import warnings
from rsa._compat import byte, b
-
ZERO_BYTE = b('\x00')
VARBLOCK_VERSION = 1
+warnings.warn("The 'rsa.varblock' module was deprecated in Python-RSA version "
+ "3.4 due to security issues in the VARBLOCK format. See "
+ "https://github.com/sybrenstuvel/python-rsa/issues/13 for more information.",
+ DeprecationWarning)
+
+
def read_varint(infile):
- '''Reads a varint from the file.
+ """Reads a varint from the file.
When the first byte to be read indicates EOF, (0, 0) is returned. When an
EOF occurs when at least one byte has been read, an EOFError exception is
raised.
- @param infile: the file-like object to read from. It should have a read()
+ :param infile: the file-like object to read from. It should have a read()
method.
- @returns (varint, length), the read varint and the number of read bytes.
- '''
+ :returns: (varint, length), the read varint and the number of read bytes.
+ """
varint = 0
read_bytes = 0
@@ -58,7 +83,7 @@ def read_varint(infile):
char = infile.read(1)
if len(char) == 0:
if read_bytes == 0:
- return (0, 0)
+ return 0, 0
raise EOFError('EOF while reading varint, value is %i so far' %
varint)
@@ -68,16 +93,16 @@ def read_varint(infile):
read_bytes += 1
if not byte & 0x80:
- return (varint, read_bytes)
+ return varint, read_bytes
def write_varint(outfile, value):
- '''Writes a varint to a file.
+ """Writes a varint to a file.
- @param outfile: the file-like object to write to. It should have a write()
+ :param outfile: the file-like object to write to. It should have a write()
method.
- @returns the number of written bytes.
- '''
+ :returns: the number of written bytes.
+ """
# there is a big difference between 'write the value 0' (this case) and
# 'there is nothing left to write' (the false-case of the while loop)
@@ -89,7 +114,7 @@ def write_varint(outfile, value):
written_bytes = 0
while value > 0:
to_write = value & 0x7f
- value = value >> 7
+ value >>= 7
if value > 0:
to_write |= 0x80
@@ -101,12 +126,12 @@ def write_varint(outfile, value):
def yield_varblocks(infile):
- '''Generator, yields each block in the input file.
+ """Generator, yields each block in the input file.
- @param infile: file to read, is expected to have the VARBLOCK format as
+ :param infile: file to read, is expected to have the VARBLOCK format as
described in the module's docstring.
@yields the contents of each block.
- '''
+ """
# Check the version number
first_char = infile.read(1)
@@ -135,11 +160,11 @@ def yield_varblocks(infile):
def yield_fixedblocks(infile, blocksize):
- '''Generator, yields each block of ``blocksize`` bytes in the input file.
+ """Generator, yields each block of ``blocksize`` bytes in the input file.
:param infile: file to read and separate in blocks.
:returns: a generator that yields the contents of each block
- '''
+ """
while True:
block = infile.read(blocksize)
@@ -152,4 +177,3 @@ def yield_fixedblocks(infile, blocksize):
if read_bytes < blocksize:
break
-