diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2016-01-30 16:27:33 -0600 |
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2016-01-30 16:27:33 -0600 |
| commit | 2c1458eca6afd83fd58c3e0929dec898a35a0c69 (patch) | |
| tree | 23269ce2fda85aff0edab38ef719986588a02d09 | |
| parent | 1489a96df302640c351c58a692d18ffc6de9b9e4 (diff) | |
| parent | b80a5ab961dacb2ae553b7cbf61cb74e902f3460 (diff) | |
| download | cryptography-2c1458eca6afd83fd58c3e0929dec898a35a0c69.tar.gz cryptography-2c1458eca6afd83fd58c3e0929dec898a35a0c69.tar.bz2 cryptography-2c1458eca6afd83fd58c3e0929dec898a35a0c69.zip | |
Merge pull request #2701 from alex/document-key
Fixed #2700 -- corrtected the create_hmac_ctx interface docs
| -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. |