diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2013-10-29 10:46:05 -0500 |
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2013-10-29 10:46:05 -0500 |
| commit | 50a881572bc7617d4d49c4ae7b200c3bcb7398d9 (patch) | |
| tree | 5c2310701431dc5898562946ffec3a1b37fa12fc /docs | |
| parent | ca8ed2953a1602fdceaee86d44b77d27f135926b (diff) | |
| download | cryptography-50a881572bc7617d4d49c4ae7b200c3bcb7398d9.tar.gz cryptography-50a881572bc7617d4d49c4ae7b200c3bcb7398d9.tar.bz2 cryptography-50a881572bc7617d4d49c4ae7b200c3bcb7398d9.zip | |
update hmac docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/hazmat/primitives/hmac.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/hazmat/primitives/hmac.rst b/docs/hazmat/primitives/hmac.rst index aec406b9..bfbe3255 100644 --- a/docs/hazmat/primitives/hmac.rst +++ b/docs/hazmat/primitives/hmac.rst @@ -21,9 +21,10 @@ message. .. class:: cryptography.hazmat.primitives.hmac.HMAC(key, msg=None, digestmod=None) HMAC objects take a ``key``, a hash class derived from - :class:`~cryptography.primitives.hashes.BaseHash`, and optional msg. The - ``key`` should be randomly generated bytes and the length of the - ``block_size`` of the hash. You must keep the ``key`` secret. + :class:`~cryptography.primitives.hashes.BaseHash`, and optional message. + The ``key`` should be randomly generated bytes and is recommended to be + equal in length to the ``digest_size`` of the hash function chosen. + You must keep the ``key`` secret. .. doctest:: @@ -35,7 +36,7 @@ message. .. method:: update(msg) - :param bytes msg: The bytes you wish to hash. + :param bytes msg: The bytes to hash and authenticate. .. method:: copy() |