Guido van Rossum | 8ceef41 | 2001-09-11 15:54:00 +0000 | [diff] [blame] | 1 | """HMAC (Keyed-Hashing for Message Authentication) Python module. |
| 2 | |
| 3 | Implements the HMAC algorithm as described by RFC 2104. |
| 4 | """ |
| 5 | |
Guido van Rossum | a19f80c | 2007-11-06 20:51:31 +0000 | [diff] [blame] | 6 | import warnings as _warnings |
| 7 | |
Guido van Rossum | 3f42908 | 2007-07-10 13:35:52 +0000 | [diff] [blame] | 8 | trans_5C = bytes((x ^ 0x5C) for x in range(256)) |
| 9 | trans_36 = bytes((x ^ 0x36) for x in range(256)) |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 10 | |
Andrew M. Kuchling | 1ccdff9 | 2001-11-02 21:49:20 +0000 | [diff] [blame] | 11 | # The size of the digests returned by HMAC depends on the underlying |
Thomas Wouters | 902d6eb | 2007-01-09 23:18:33 +0000 | [diff] [blame] | 12 | # hashing module used. Use digest_size from the instance of HMAC instead. |
Andrew M. Kuchling | 1ccdff9 | 2001-11-02 21:49:20 +0000 | [diff] [blame] | 13 | digest_size = None |
| 14 | |
Tim Peters | 934d31b | 2004-03-20 20:11:29 +0000 | [diff] [blame] | 15 | |
Charles-François Natali | 7feb9f4 | 2012-05-13 19:53:07 +0200 | [diff] [blame] | 16 | def secure_compare(a, b): |
| 17 | """Returns the equivalent of 'a == b', but using a time-independent |
| 18 | comparison method to prevent timing attacks.""" |
| 19 | if not ((isinstance(a, str) and isinstance(b, str)) or |
| 20 | (isinstance(a, bytes) and isinstance(b, bytes))): |
| 21 | raise TypeError("inputs must be strings or bytes") |
| 22 | |
| 23 | if len(a) != len(b): |
| 24 | return False |
| 25 | |
| 26 | result = 0 |
| 27 | if isinstance(a, bytes): |
| 28 | for x, y in zip(a, b): |
| 29 | result |= x ^ y |
| 30 | else: |
| 31 | for x, y in zip(a, b): |
| 32 | result |= ord(x) ^ ord(y) |
| 33 | |
| 34 | return result == 0 |
| 35 | |
| 36 | |
Guido van Rossum | 8ceef41 | 2001-09-11 15:54:00 +0000 | [diff] [blame] | 37 | class HMAC: |
Guido van Rossum | a19f80c | 2007-11-06 20:51:31 +0000 | [diff] [blame] | 38 | """RFC 2104 HMAC class. Also complies with RFC 4231. |
Guido van Rossum | 8ceef41 | 2001-09-11 15:54:00 +0000 | [diff] [blame] | 39 | |
Andrew M. Kuchling | 1ccdff9 | 2001-11-02 21:49:20 +0000 | [diff] [blame] | 40 | This supports the API for Cryptographic Hash Functions (PEP 247). |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 41 | """ |
Thomas Wouters | 902d6eb | 2007-01-09 23:18:33 +0000 | [diff] [blame] | 42 | blocksize = 64 # 512-bit HMAC; can be changed in subclasses. |
Guido van Rossum | 8ceef41 | 2001-09-11 15:54:00 +0000 | [diff] [blame] | 43 | |
| 44 | def __init__(self, key, msg = None, digestmod = None): |
| 45 | """Create a new HMAC object. |
| 46 | |
| 47 | key: key for the keyed hash object. |
| 48 | msg: Initial input for the hash, if provided. |
Gregory P. Smith | f21a5f7 | 2005-08-21 18:45:59 +0000 | [diff] [blame] | 49 | digestmod: A module supporting PEP 247. *OR* |
| 50 | A hashlib constructor returning a new hash object. |
| 51 | Defaults to hashlib.md5. |
Guido van Rossum | 3f42908 | 2007-07-10 13:35:52 +0000 | [diff] [blame] | 52 | |
| 53 | Note: key and msg must be bytes objects. |
Guido van Rossum | 8ceef41 | 2001-09-11 15:54:00 +0000 | [diff] [blame] | 54 | """ |
Tim Peters | 934d31b | 2004-03-20 20:11:29 +0000 | [diff] [blame] | 55 | |
Alexandre Vassalotti | a351f77 | 2008-03-03 02:59:49 +0000 | [diff] [blame] | 56 | if not isinstance(key, bytes): |
| 57 | raise TypeError("expected bytes, but got %r" % type(key).__name__) |
Guido van Rossum | 3f42908 | 2007-07-10 13:35:52 +0000 | [diff] [blame] | 58 | |
Raymond Hettinger | 7fdfc2d | 2002-05-31 17:49:10 +0000 | [diff] [blame] | 59 | if digestmod is None: |
Gregory P. Smith | f21a5f7 | 2005-08-21 18:45:59 +0000 | [diff] [blame] | 60 | import hashlib |
| 61 | digestmod = hashlib.md5 |
Guido van Rossum | 8ceef41 | 2001-09-11 15:54:00 +0000 | [diff] [blame] | 62 | |
Florent Xicluna | 5d1155c | 2011-10-28 14:45:05 +0200 | [diff] [blame] | 63 | if callable(digestmod): |
Gregory P. Smith | f21a5f7 | 2005-08-21 18:45:59 +0000 | [diff] [blame] | 64 | self.digest_cons = digestmod |
| 65 | else: |
Guido van Rossum | 3f42908 | 2007-07-10 13:35:52 +0000 | [diff] [blame] | 66 | self.digest_cons = lambda d=b'': digestmod.new(d) |
Gregory P. Smith | f21a5f7 | 2005-08-21 18:45:59 +0000 | [diff] [blame] | 67 | |
| 68 | self.outer = self.digest_cons() |
| 69 | self.inner = self.digest_cons() |
| 70 | self.digest_size = self.inner.digest_size |
Tim Peters | 8876848 | 2001-11-13 21:51:26 +0000 | [diff] [blame] | 71 | |
Guido van Rossum | a19f80c | 2007-11-06 20:51:31 +0000 | [diff] [blame] | 72 | if hasattr(self.inner, 'block_size'): |
| 73 | blocksize = self.inner.block_size |
| 74 | if blocksize < 16: |
Guido van Rossum | a19f80c | 2007-11-06 20:51:31 +0000 | [diff] [blame] | 75 | _warnings.warn('block_size of %d seems too small; using our ' |
| 76 | 'default of %d.' % (blocksize, self.blocksize), |
| 77 | RuntimeWarning, 2) |
| 78 | blocksize = self.blocksize |
| 79 | else: |
| 80 | _warnings.warn('No block_size attribute on given digest object; ' |
| 81 | 'Assuming %d.' % (self.blocksize), |
| 82 | RuntimeWarning, 2) |
| 83 | blocksize = self.blocksize |
| 84 | |
Guido van Rossum | 8ceef41 | 2001-09-11 15:54:00 +0000 | [diff] [blame] | 85 | if len(key) > blocksize: |
Gregory P. Smith | f21a5f7 | 2005-08-21 18:45:59 +0000 | [diff] [blame] | 86 | key = self.digest_cons(key).digest() |
Guido van Rossum | 8ceef41 | 2001-09-11 15:54:00 +0000 | [diff] [blame] | 87 | |
Guido van Rossum | 3f42908 | 2007-07-10 13:35:52 +0000 | [diff] [blame] | 88 | key = key + bytes(blocksize - len(key)) |
Thomas Wouters | 902d6eb | 2007-01-09 23:18:33 +0000 | [diff] [blame] | 89 | self.outer.update(key.translate(trans_5C)) |
| 90 | self.inner.update(key.translate(trans_36)) |
Raymond Hettinger | 094662a | 2002-06-01 01:29:16 +0000 | [diff] [blame] | 91 | if msg is not None: |
Guido van Rossum | 8ceef41 | 2001-09-11 15:54:00 +0000 | [diff] [blame] | 92 | self.update(msg) |
| 93 | |
Guido van Rossum | 8ceef41 | 2001-09-11 15:54:00 +0000 | [diff] [blame] | 94 | def update(self, msg): |
| 95 | """Update this hashing object with the string msg. |
| 96 | """ |
Alexandre Vassalotti | a351f77 | 2008-03-03 02:59:49 +0000 | [diff] [blame] | 97 | if not isinstance(msg, bytes): |
| 98 | raise TypeError("expected bytes, but got %r" % type(msg).__name__) |
Guido van Rossum | 8ceef41 | 2001-09-11 15:54:00 +0000 | [diff] [blame] | 99 | self.inner.update(msg) |
| 100 | |
| 101 | def copy(self): |
| 102 | """Return a separate copy of this hashing object. |
| 103 | |
| 104 | An update to this copy won't affect the original object. |
| 105 | """ |
Benjamin Peterson | 0cc7444 | 2010-08-21 02:45:15 +0000 | [diff] [blame] | 106 | # Call __new__ directly to avoid the expensive __init__. |
| 107 | other = self.__class__.__new__(self.__class__) |
Gregory P. Smith | f21a5f7 | 2005-08-21 18:45:59 +0000 | [diff] [blame] | 108 | other.digest_cons = self.digest_cons |
Tim Peters | 934d31b | 2004-03-20 20:11:29 +0000 | [diff] [blame] | 109 | other.digest_size = self.digest_size |
Andrew M. Kuchling | 1ccdff9 | 2001-11-02 21:49:20 +0000 | [diff] [blame] | 110 | other.inner = self.inner.copy() |
| 111 | other.outer = self.outer.copy() |
| 112 | return other |
Guido van Rossum | 8ceef41 | 2001-09-11 15:54:00 +0000 | [diff] [blame] | 113 | |
Thomas Wouters | 902d6eb | 2007-01-09 23:18:33 +0000 | [diff] [blame] | 114 | def _current(self): |
| 115 | """Return a hash object for the current state. |
| 116 | |
| 117 | To be used only internally with digest() and hexdigest(). |
| 118 | """ |
| 119 | h = self.outer.copy() |
| 120 | h.update(self.inner.digest()) |
| 121 | return h |
| 122 | |
Guido van Rossum | 8ceef41 | 2001-09-11 15:54:00 +0000 | [diff] [blame] | 123 | def digest(self): |
| 124 | """Return the hash value of this hashing object. |
| 125 | |
| 126 | This returns a string containing 8-bit data. The object is |
| 127 | not altered in any way by this function; you can continue |
| 128 | updating the object after calling this function. |
| 129 | """ |
Thomas Wouters | 902d6eb | 2007-01-09 23:18:33 +0000 | [diff] [blame] | 130 | h = self._current() |
Guido van Rossum | 8ceef41 | 2001-09-11 15:54:00 +0000 | [diff] [blame] | 131 | return h.digest() |
| 132 | |
| 133 | def hexdigest(self): |
| 134 | """Like digest(), but returns a string of hexadecimal digits instead. |
| 135 | """ |
Thomas Wouters | 902d6eb | 2007-01-09 23:18:33 +0000 | [diff] [blame] | 136 | h = self._current() |
| 137 | return h.hexdigest() |
Guido van Rossum | 8ceef41 | 2001-09-11 15:54:00 +0000 | [diff] [blame] | 138 | |
| 139 | def new(key, msg = None, digestmod = None): |
| 140 | """Create a new hashing object and return it. |
| 141 | |
| 142 | key: The starting key for the hash. |
| 143 | msg: if available, will immediately be hashed into the object's starting |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 144 | state. |
Guido van Rossum | 8ceef41 | 2001-09-11 15:54:00 +0000 | [diff] [blame] | 145 | |
| 146 | You can now feed arbitrary strings into the object using its update() |
| 147 | method, and can ask for the hash value at any time by calling its digest() |
| 148 | method. |
| 149 | """ |
| 150 | return HMAC(key, msg, digestmod) |