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/cryptographic-hashes.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/cryptographic-hashes.rst')
| -rw-r--r-- | docs/hazmat/primitives/cryptographic-hashes.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/hazmat/primitives/cryptographic-hashes.rst b/docs/hazmat/primitives/cryptographic-hashes.rst index 92f8fa30..312d7e69 100644 --- a/docs/hazmat/primitives/cryptographic-hashes.rst +++ b/docs/hazmat/primitives/cryptographic-hashes.rst @@ -34,6 +34,14 @@ Message Digests upgrading the hash algorithm you use over time. For more information, see `Lifetimes of cryptographic hash functions`_. + :param algorithm: A + :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm` + provider such as those described in + :ref:`below <cryptographic-hash-algorithms>`. + :param backend: A + :class:`~cryptography.hazmat.bindings.interfaces.HashBackend` + provider. + .. method:: update(data) :param bytes data: The bytes you wish to hash. @@ -60,6 +68,8 @@ Message Digests :return bytes: The message digest as bytes. +.. _cryptographic-hash-algorithms: + SHA-1 ~~~~~ |