diff options
| author | David Reid <dreid@dreid.org> | 2013-11-20 13:55:08 -0800 |
|---|---|---|
| committer | David Reid <dreid@dreid.org> | 2013-11-20 13:55:08 -0800 |
| commit | 663295d015d4aa65258f14d91c6350726604350c (patch) | |
| tree | 516710a9ca1992d64ed737e4e131f89e5c4ddae7 /docs/hazmat/primitives/hmac.rst | |
| parent | 63fa19ace98c2c88a6065acc9e944a71480ff651 (diff) | |
| download | cryptography-663295d015d4aa65258f14d91c6350726604350c.tar.gz cryptography-663295d015d4aa65258f14d91c6350726604350c.tar.bz2 cryptography-663295d015d4aa65258f14d91c6350726604350c.zip | |
Document all the parameters including cross references to specific providers where appropriate.
Diffstat (limited to 'docs/hazmat/primitives/hmac.rst')
| -rw-r--r-- | docs/hazmat/primitives/hmac.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/hazmat/primitives/hmac.rst b/docs/hazmat/primitives/hmac.rst index 10db40ee..db5e98d3 100644 --- a/docs/hazmat/primitives/hmac.rst +++ b/docs/hazmat/primitives/hmac.rst @@ -34,6 +34,16 @@ message. >>> h.finalize() '#F\xdaI\x8b"e\xc4\xf1\xbb\x9a\x8fc\xff\xf5\xdex.\xbc\xcd/+\x8a\x86\x1d\x84\'\xc3\xa6\x1d\xd8J' + + :param key: Secret key as ``bytes``. + :param algorithm: A + :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm` + provider such as those described in + :ref:`Cryptographic Hashes <cryptographic-hash-algorithms>`. + :param backend: A + :class:`~cryptography.hazmat.bindings.interfaces.HMACBackend` + provider. + .. method:: update(msg) :param bytes msg: The bytes to hash and authenticate. |