aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2018-11-22 23:42:42 +0800
committerAlex Gaynor <alex.gaynor@gmail.com>2018-11-22 09:42:42 -0600
commit3065e16bcc05ddde3af87484a38b67b06471670e (patch)
tree2c5f497c0a4d4a8008b8d8ea6f17102c9939d1b6 /docs/hazmat
parentcd4de3ce6dc2a0dd4171b869e187857e4125853b (diff)
downloadcryptography-3065e16bcc05ddde3af87484a38b67b06471670e.tar.gz
cryptography-3065e16bcc05ddde3af87484a38b67b06471670e.tar.bz2
cryptography-3065e16bcc05ddde3af87484a38b67b06471670e.zip
add sha3 support (#4573)
* add sha3 support * missed versionadded * add prose, remove block_size
Diffstat (limited to 'docs/hazmat')
-rw-r--r--docs/hazmat/primitives/cryptographic-hashes.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/hazmat/primitives/cryptographic-hashes.rst b/docs/hazmat/primitives/cryptographic-hashes.rst
index 1a96fc2d..bc979365 100644
--- a/docs/hazmat/primitives/cryptographic-hashes.rst
+++ b/docs/hazmat/primitives/cryptographic-hashes.rst
@@ -148,6 +148,43 @@ SHA-family of hashes.
:raises ValueError: If the ``digest_size`` is invalid.
+SHA-3 family
+~~~~~~~~~~~~
+
+SHA-3 is the most recent NIST secure hash algorithm standard. Despite the
+larger number SHA-3 is not considered to be better than SHA-2. Instead, it uses
+a significantly different internal structure so that **if** an attack appears
+against SHA-2 it is unlikely to apply to SHA-3. SHA-3 is significantly slower
+than SHA-2 so at this time most users should choose SHA-2.
+
+.. class:: SHA3_224()
+
+ .. versionadded:: 2.5
+
+ SHA3/224 is a cryptographic hash function from the SHA-3 family and is
+ standardized by NIST. It produces a 224-bit message digest.
+
+.. class:: SHA3_256()
+
+ .. versionadded:: 2.5
+
+ SHA3/256 is a cryptographic hash function from the SHA-3 family and is
+ standardized by NIST. It produces a 256-bit message digest.
+
+.. class:: SHA3_384()
+
+ .. versionadded:: 2.5
+
+ SHA3/384 is a cryptographic hash function from the SHA-3 family and is
+ standardized by NIST. It produces a 384-bit message digest.
+
+.. class:: SHA3_512()
+
+ .. versionadded:: 2.5
+
+ SHA3/512 is a cryptographic hash function from the SHA-3 family and is
+ standardized by NIST. It produces a 512-bit message digest.
+
SHA-1
~~~~~