rsa.pkcs1.verify() should return True when successful

theckman · theckman · commit 7446f0a8d0ea · 2012-10-17T21:09:43.000-04:00
- when verification passes verify() will return True, instead of
  None. If verification fails the function will still raise a
  rsa.pkcs1.VerificationError for legacy purposes.
- update the docs to note that the verify() function returns True
  when successful
- write unit tests to verify this new behavior

This commit passes all build tests:

    Ran 44 tests in 1.217s

    OK
diff --git a/doc/usage.rst b/doc/usage.rst
@@ -197,10 +197,11 @@ possible, check the :py:func:`rsa.sign` function documentation for
 details. The hash is then signed with the private key.
 
 In order to verify the signature, use the :py:func:`rsa.verify`
-function.
+function. This function returns True if the verification is successful:
 
     >>> message = 'Go left at the blue tree'
     >>> rsa.verify(message, signature, pubkey)
+    True
 
 Modify the message, and the signature is no longer valid and a
 :py:class:`rsa.pkcs1.VerificationError` is thrown:
diff --git a/rsa/pkcs1.py b/rsa/pkcs1.py
@@ -321,6 +321,8 @@ def verify(message, signature, pub_key):
     if message_hash != signature_hash:
         raise VerificationError('Verification failed')
 
+    return True
+
 def _hash(message, method_name):
     '''Returns the message digest.
     
diff --git a/tests/test_bigfile.py b/tests/test_bigfile.py
@@ -51,7 +51,7 @@ def test_sign_verify_bigfile(self):
 
         # Check the signature
         msgfile.seek(0)
-        pkcs1.verify(msgfile, signature, pub_key)
+        self.assertTrue(pkcs1.verify(msgfile, signature, pub_key))
 
         # Alter the message, re-check
         msgfile = BytesIO(b('123456sybren'))
diff --git a/tests/test_pkcs1.py b/tests/test_pkcs1.py
@@ -64,7 +64,7 @@ def test_sign_verify(self):
         signature = pkcs1.sign(message, self.priv, 'SHA-256')
         print("\tSignature: %r" % signature)
 
-        pkcs1.verify(message, signature, self.pub)
+        self.assertTrue(pkcs1.verify(message, signature, self.pub))
 
     def test_alter_message(self):
         '''Altering the message should let the verification fail.'''
