Lib/hmac.py

   1 """HMAC (Keyed-Hashing for Message Authentication) Python module.
   2
   3 Implements the HMAC algorithm as described by RFC 2104.
   4 """
   5
   6 def _strxor(s1, s2):
   7     """Utility method. XOR the two strings s1 and s2 (must have same length).
   8     """
   9     return "".join(map(lambda x, y: chr(ord(x) ^ ord(y)), s1, s2))
  10
  11 # The size of the digests returned by HMAC depends on the underlying
  12 # hashing module used.
  13 digest_size = None
  14
  15 class HMAC:
  16     """RFC2104 HMAC class.
  17
  18     This supports the API for Cryptographic Hash Functions (PEP 247).
  19     """
  20
  21     def __init__(self, key, msg = None, digestmod = None):
  22         """Create a new HMAC object.
  23
  24         key:       key for the keyed hash object.
  25         msg:       Initial input for the hash, if provided.
  26         digestmod: A module supporting PEP 247. Defaults to the md5 module.
  27         """
  28         if digestmod is None:
  29             import md5
  30             digestmod = md5
  31
  32         self.digestmod = digestmod
  33         self.outer = digestmod.new()
  34         self.inner = digestmod.new()
  35         self.digest_size = digestmod.digest_size
  36
  37         blocksize = 64
  38         ipad = "\x36" * blocksize
  39         opad = "\x5C" * blocksize
  40
  41         if len(key) > blocksize:
  42             key = digestmod.new(key).digest()
  43
  44         key = key + chr(0) * (blocksize - len(key))
  45         self.outer.update(_strxor(key, opad))
  46         self.inner.update(_strxor(key, ipad))
  47         if msg is not None:
  48             self.update(msg)
  49
  50 ##    def clear(self):
  51 ##        raise NotImplementedError, "clear() method not available in HMAC."
  52
  53     def update(self, msg):
  54         """Update this hashing object with the string msg.
  55         """
  56         self.inner.update(msg)
  57
  58     def copy(self):
  59         """Return a separate copy of this hashing object.
  60
  61         An update to this copy won't affect the original object.
  62         """
  63         other = HMAC("")
  64         other.digestmod = self.digestmod
  65         other.inner = self.inner.copy()
  66         other.outer = self.outer.copy()
  67         return other
  68
  69     def digest(self):
  70         """Return the hash value of this hashing object.
  71
  72         This returns a string containing 8-bit data.  The object is
  73         not altered in any way by this function; you can continue
  74         updating the object after calling this function.
  75         """
  76         h = self.outer.copy()
  77         h.update(self.inner.digest())
  78         return h.digest()
  79
  80     def hexdigest(self):
  81         """Like digest(), but returns a string of hexadecimal digits instead.
  82         """
  83         return "".join([hex(ord(x))[2:].zfill(2)
  84                         for x in tuple(self.digest())])
  85
  86 def new(key, msg = None, digestmod = None):
  87     """Create a new hashing object and return it.
  88
  89     key: The starting key for the hash.
  90     msg: if available, will immediately be hashed into the object's starting
  91     state.
  92
  93     You can now feed arbitrary strings into the object using its update()
  94     method, and can ask for the hash value at any time by calling its digest()
  95     method.
  96     """
  97     return HMAC(key, msg, digestmod)