diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2016-01-30 16:24:19 -0500 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2016-01-30 16:24:19 -0500 |
| commit | b80a5ab961dacb2ae553b7cbf61cb74e902f3460 (patch) | |
| tree | 09c6dc20bcb5bfe9bc7d390267483cd8c42fbe6c /docs/hazmat/backends/interfaces.rst | |
| parent | a63879cddd5590542fe54844691c78d93b46f6a8 (diff) | |
| download | cryptography-b80a5ab961dacb2ae553b7cbf61cb74e902f3460.tar.gz cryptography-b80a5ab961dacb2ae553b7cbf61cb74e902f3460.tar.bz2 cryptography-b80a5ab961dacb2ae553b7cbf61cb74e902f3460.zip | |
Fixed #2700 -- corrtected the create_hmac_ctx interface docs
Diffstat (limited to 'docs/hazmat/backends/interfaces.rst')
| -rw-r--r-- | docs/hazmat/backends/interfaces.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/hazmat/backends/interfaces.rst b/docs/hazmat/backends/interfaces.rst index 73011dd0..83ec6f19 100644 --- a/docs/hazmat/backends/interfaces.rst +++ b/docs/hazmat/backends/interfaces.rst @@ -133,13 +133,15 @@ A specific ``backend`` may provide one or more of these interfaces. :returns: ``True`` if the specified ``algorithm`` is supported for HMAC by this backend, otherwise ``False``. - .. method:: create_hmac_ctx(algorithm) + .. method:: create_hmac_ctx(key, algorithm) Create a :class:`~cryptography.hazmat.primitives.hashes.HashContext` that uses the specified ``algorithm`` to calculate a hash-based message authentication code. + :param bytes key: Secret key as ``bytes``. + :param algorithm: An instance of a :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` provider. |