Skip to content

Commit

Permalink
Issue 18240: The HMAC module is no longer restricted to bytes and acc…
Browse files Browse the repository at this point in the history
…epts

any bytes-like object, e.g. memoryview. Original patch by Jonas Borgström.
  • Loading branch information
tiran committed Jul 1, 2013
1 parent ec4bdac commit 04926ae
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 11 deletions.
18 changes: 12 additions & 6 deletions Doc/library/hmac.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,26 @@ This module implements the HMAC algorithm as described by :rfc:`2104`.

.. function:: new(key, msg=None, digestmod=None)

Return a new hmac object. *key* is a bytes object giving the secret key. If
*msg* is present, the method call ``update(msg)`` is made. *digestmod* is
the digest constructor or module for the HMAC object to use. It defaults to
the :func:`hashlib.md5` constructor.
Return a new hmac object. *key* is a bytes or bytearray object giving the
secret key. If *msg* is present, the method call ``update(msg)`` is made.
*digestmod* is the digest constructor or module for the HMAC object to use.
It defaults to the :func:`hashlib.md5` constructor.

.. versionchanged:: 3.4
Parameter *key* can be a bytes or bytearray object. Parameter *msg* can
be of any type supported by :mod:`hashlib`.

An HMAC object has the following methods:

.. method:: HMAC.update(msg)

Update the hmac object with the bytes object *msg*. Repeated calls are
equivalent to a single call with the concatenation of all the arguments:
Update the hmac object with *msg*. Repeated calls are equivalent to a
single call with the concatenation of all the arguments:
``m.update(a); m.update(b)`` is equivalent to ``m.update(a + b)``.

.. versionchanged:: 3.4
Parameter *msg* can be of any type supported by :mod:`hashlib`.


.. method:: HMAC.digest()

Expand Down
8 changes: 3 additions & 5 deletions Lib/hmac.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ def __init__(self, key, msg = None, digestmod = None):
A hashlib constructor returning a new hash object.
Defaults to hashlib.md5.
Note: key and msg must be bytes objects.
Note: key and msg must be a bytes or bytearray objects.
"""

if not isinstance(key, bytes):
raise TypeError("key: expected bytes, but got %r" % type(key).__name__)
if not isinstance(key, (bytes, bytearray)):
raise TypeError("key: expected bytes or bytearray, but got %r" % type(key).__name__)

if digestmod is None:
import hashlib
Expand Down Expand Up @@ -75,8 +75,6 @@ def __init__(self, key, msg = None, digestmod = None):
def update(self, msg):
"""Update this hashing object with the string msg.
"""
if not isinstance(msg, bytes):
raise TypeError("expected bytes, but got %r" % type(msg).__name__)
self.inner.update(msg)

def copy(self):
Expand Down
14 changes: 14 additions & 0 deletions Lib/test/test_hmac.py
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,20 @@ def test_withtext(self):
except:
self.fail("Constructor call with text argument raised exception.")

def test_with_bytearray(self):
try:
h = hmac.HMAC(bytearray(b"key"), bytearray(b"hash this!"))
self.assertEqual(h.hexdigest(), '34325b639da4cfd95735b381e28cb864')
except:
self.fail("Constructor call with bytearray arguments raised exception.")

def test_with_memoryview_msg(self):
try:
h = hmac.HMAC(b"key", memoryview(b"hash this!"))
self.assertEqual(h.hexdigest(), '34325b639da4cfd95735b381e28cb864')
except:
self.fail("Constructor call with memoryview msg raised exception.")

def test_withmodule(self):
# Constructor call with text and digest module.
try:
Expand Down
1 change: 1 addition & 0 deletions Misc/ACKS
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ Gawain Bolton
Forest Bond
Gregory Bond
Matias Bordese
Jonas Borgström
Jurjen Bos
Peter Bosch
Dan Boswell
Expand Down
3 changes: 3 additions & 0 deletions Misc/NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,9 @@ Core and Builtins
Library
-------

- Issue 18240: The HMAC module is no longer restricted to bytes and accepts
any bytes-like object, e.g. memoryview. Original patch by Jonas Borgström.

- Issue #18224: Removed pydoc script from created venv, as it causes problems
on Windows and adds no value over and above python -m pydoc ...

Expand Down

0 comments on commit 04926ae

Please sign in to comment.