aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/backends
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2014-01-28 15:07:49 -0600
committerPaul Kehrer <paul.l.kehrer@gmail.com>2014-01-28 15:07:49 -0600
commit98e40e658ef00dc6972f5420896bd57b385c8435 (patch)
treed9d922ec9483e9c289ceb0d6996e7846f7347f94 /docs/hazmat/backends
parent695313ff7cb1a7026a2624b8c61d495978d6f41c (diff)
downloadcryptography-98e40e658ef00dc6972f5420896bd57b385c8435.tar.gz
cryptography-98e40e658ef00dc6972f5420896bd57b385c8435.tar.bz2
cryptography-98e40e658ef00dc6972f5420896bd57b385c8435.zip
rename PBKDF2 to PBKDF2HMAC, address many other review comments
Diffstat (limited to 'docs/hazmat/backends')
-rw-r--r--docs/hazmat/backends/interfaces.rst16
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/hazmat/backends/interfaces.rst b/docs/hazmat/backends/interfaces.rst
index 975a7b02..e22c6bb3 100644
--- a/docs/hazmat/backends/interfaces.rst
+++ b/docs/hazmat/backends/interfaces.rst
@@ -134,32 +134,32 @@ A specific ``backend`` may provide one or more of these interfaces.
-.. class:: PBKDF2Backend
+.. class:: PBKDF2HMACBackend
.. versionadded:: 0.2
- A backend with methods for using PBKDF2.
+ A backend with methods for using PBKDF2 using HMAC as a PRF.
- .. method:: pbkdf2_hash_supported(algorithm)
+ .. method:: pbkdf2_hmac_supported(algorithm)
Check if the specified ``algorithm`` is supported by this backend.
- :param algorithm: An instance of a
+ :param prf: An instance of a
:class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm`
provider.
:returns: ``True`` if the specified ``algorithm`` is supported for
- PBKDF2 by this backend, otherwise ``False``.
+ PBKDF2 HMAC by this backend, otherwise ``False``.
- .. method:: derive_pbkdf2(self, algorithm, length, salt, iterations,
- key_material)
+ .. method:: derive_pbkdf2_hmac(self, algorithm, length, salt, iterations,
+ key_material)
:param algorithm: An instance of a
:class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm`
provider.
:param int length: The desired length of the derived key. Maximum is
- 2\ :sup:`31` - 1.
+ (2\ :sup:`32` - 1) * ``algorithm.digest_size``
:param bytes salt: A salt.