Commit Graph

67 Commits

Author SHA1 Message Date
Cheryl Sabella 2d6097d027 bpo-11233: Create availability directive for documentation (GH-9692)
Replace "Availability: xxx" with ".. availability:: xxx" in the doc.
Original patch by Georg Brandl.

Co-Authored-By: Georg Brandl <georg@python.org>
2018-10-12 16:55:20 +02:00
Ville Skyttä 959625b5a5 Use bytes.hex instead of binascii.hexlify in pbkdf2_hmac example (GH-8420) 2018-09-10 18:07:19 -07:00
Serhiy Storchaka f1d36d8efa
bpo-33729: Fix issues with arguments parsing in hashlib. (GH-8346)
* help(hashlib) didn't work because of incorrect module name in blake2b and
  blake2s classes.
* Constructors blake2*(), sha3_*(), shake_*() and keccak_*() incorrectly
  accepted keyword argument "string" for binary data, but documented as
  accepting the "data" keyword argument. Now this parameter is positional-only.
* Keyword-only parameters in blake2b() and blake2s() were not documented as
  keyword-only.
* Default value for some parameters of blake2b() and blake2s() was None,
  which is not acceptable value.
* The length argument for shake_*.digest() was wrapped out to 32 bits.
* The argument for shake_128.digest() and shake_128.hexdigest() was not
  positional-only as intended.
* TypeError messages for incorrect arguments in all constructors sha3_*(),
  shake_*() and keccak_*() incorrectly referred to sha3_224.

Also made the following enhancements:

* More accurately specified input and result types for strings, bytes and
  bytes-like objects.
* Unified positional parameter names for update() and constructors.
* Improved formatting.
2018-07-31 09:50:16 +03:00
Andrés Delfino 5092439c2c bpo-33892: Doc: Use gender neutral words (GH-7770) 2018-06-18 13:34:30 +09:00
Serhiy Storchaka 0a36ac1a09
bpo-33641: Convert RFC references into links. (GH-7103)
85% of them are already links.
2018-05-31 07:39:00 +03:00
Sanyam Khurana 338cd83c5d bpo-25910: Link redirections in docs (#1933)
Fixes some redirection links in docs.
2018-01-20 01:25:37 +01:00
Sanyam Khurana 1b4587a246 bpo-25910: Fixes redirection from http to https (#4674) 2017-12-06 17:39:33 +01:00
Victor Stinner 8c663fd60e
Replace KB unit with KiB (#4293)
kB (*kilo* byte) unit means 1000 bytes, whereas KiB ("kibibyte")
means 1024 bytes. KB was misused: replace kB or KB with KiB when
appropriate.

Same change for MB and GB which become MiB and GiB.

Change the output of Tools/iobench/iobench.py.

Round also the size of the documentation from 5.5 MB to 5 MiB.
2017-11-08 14:44:44 -08:00
Dmitry Chestnykh aecc08ac3a Docs: correct hashlib.blake2 keyed hashing example (bpo-31560) 2017-09-23 10:18:40 -07:00
sww 312ffead1e Improve code examples in hashlib cookie signing (GH-3562)
The `blake2b` function does not take the `data` keyword argument.
The hex digest returned by sign was a string, whereas compare_digest expects bytes-like objects.
Typo fix: compare_digesty -> compare_digest
2017-09-13 23:24:36 -07:00
INADA Naoki e2f9e77df2 Issue #29062: Merge hashlib-blake2.rst into hashlib.rst 2017-01-13 19:29:58 +09:00
Christian Heimes 6fe2a75b64 Issue #16113: Add SHA-3 and SHAKE support to hashlib module. 2016-09-07 11:58:24 +02:00
Christian Heimes 121b9487d1 Issue #26798: Add BLAKE2 (blake2b and blake2s) to hashlib. 2016-09-06 22:03:25 +02:00
Christian Heimes 39093e9e68 Issue #27928: Add scrypt (password-based key derivation function) to hashlib module (requires OpenSSL 1.1.0). 2016-09-06 20:22:28 +02:00
Zachary Ware 306c3dd6f5 Issue #27200: Merge with 3.5 2016-08-10 01:05:56 -05:00
Zachary Ware 4199bbaf63 Issue #27200: Fix doctests in Doc/library/hashlib.rst 2016-08-10 01:05:19 -05:00
Gregory P. Smith 7bfb415c8d Clarify that md5 is in the algorithms_guaranteed list despite what
some upstream vendors may do to their odd "FIPS compliant" builds.
issue15468.
2016-06-11 18:02:13 -07:00
Gregory P. Smith 8907dcd3ff issue15468 - use sha256 instead of md5 or sha1 in the examples.
document that md5 may be missing in the rare case someone is using a
"FIPS compliant" build.  I've only ever heard of Redhat creating one
of those - CPython itself offers no such build mode out of the box.
2016-06-11 17:56:12 -07:00
Terry Jan Reedy fa089b9b0b Issue #22558: Add remaining doc links to source code for Python-coded modules.
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00
Serhiy Storchaka e5ea1abf91 Issue #27036: Fixed formatting references to "bytes-like object" in plural. 2016-05-18 13:54:54 +03:00
Serhiy Storchaka 6dff0205b7 Issue #26736: Used HTTPS for external links in the documentation if possible. 2016-05-07 10:49:07 +03:00
Martin Panter bc85e35fe6 Issue #26390: Fix and test pbkdf2_hmac() parameter names
Based on patch by Daan Bakker.
2016-02-22 09:21:49 +00:00
Benjamin Peterson 1dd72e6bc5 make wikipedia link https 2015-09-27 02:05:01 -07:00
Benjamin Peterson c402d8dcea shorten and fix casing of title 2015-09-27 01:23:10 -07:00
Benjamin Peterson 5e2c4d2de0 grammar and sentence flow fix 2014-05-26 15:48:12 -07:00
Benjamin Peterson f9ea5f39d8 format reST directive in the usual way 2014-05-26 15:45:14 -07:00
Benjamin Peterson 0d81d80f6e link to wikipedia description of cryptographic salt 2014-05-26 15:42:29 -07:00
Benjamin Peterson 0ccff4d3e1 oxford comma 2014-05-26 15:41:26 -07:00
Larry Hastings 3732ed2414 Merge in all documentation changes since branching 3.4.0rc1. 2014-03-15 21:13:56 -07:00
Martin v. Löwis 24e43308b7 * Issue #16113: Remove sha3 module again.
Patch by Christian Heimes, with modifications.
2014-01-03 14:05:06 +01:00
R David Murray cde1a06a54 Include sha3 addition in hashlib section of whatsnew.
And link to it from the summary, and link to the Hash Algorithms
section of hashlib from the linked description.
2013-12-20 16:33:52 -05:00
Christian Heimes e723622775 Issue #18582: provide a faster C implementation of pbkdf2_hmac that works with OpenSSL < 1.0 2013-10-19 14:24:44 +02:00
Christian Heimes 3626a505db Issue #19254: Provide an optimized Python implementation of PBKDF2_HMAC 2013-10-19 14:12:02 +02:00
Christian Heimes e92ef13b0a Issue #18582: Add 'pbkdf2_hmac' to the hashlib module. 2013-10-13 00:52:43 +02:00
Georg Brandl 7cc439a877 merge with 3.3 2013-10-06 18:26:43 +02:00
Georg Brandl 6e94a3098e The "FAQ" link at the end was changed to a Wikipedia link; reflect that. 2013-10-06 18:26:36 +02:00
Jesus Cea cc5d49e3da MERGE: Close #19160: Inconsistent size for GIL release in hashlib 2013-10-04 04:21:02 +02:00
Jesus Cea 5b22dd87aa Close #19160: Inconsistent size for GIL release in hashlib 2013-10-04 04:20:37 +02:00
Jesus Cea 5f0f51239b MERGE: Close #19160: Inconsistent size for GIL release in hashlib 2013-10-04 04:15:48 +02:00
Jesus Cea f5c499e16c Close #19160: Inconsistent size for GIL release in hashlib 2013-10-04 04:15:06 +02:00
Jason R. Coombs b2aa6f4055 Issue 18532: Added tests and documentation to formally specify the .name attribute on hashlib objects. 2013-08-03 11:39:39 +02:00
Ezio Melotti 4cfc0b5411 #16518: merge with 3.3. 2013-05-04 18:07:12 +03:00
Ezio Melotti c228e96726 #16518: use "bytes-like object" throughout the docs. 2013-05-04 18:06:34 +03:00
Benjamin Peterson 301162b43d merge 3.3 (closes #16687) 2012-12-20 20:25:00 -06:00
Benjamin Peterson 9cb7bd2df4 link to GIL as a term
Patch from Jeff Knupp.
2012-12-20 20:24:37 -06:00
Benjamin Peterson bd584d559b fix typo (#16687)
Patch from Jeff Knupp.
2012-12-20 20:22:47 -06:00
Christian Heimes 4a0270d82b Issue #16113: integrade SHA-3 (Keccak) patch from http://hg.python.org/sandbox/cheimes 2012-10-06 02:23:36 +02:00
Raymond Hettinger 469271d4ea More source links 2011-01-27 20:38:46 +00:00
Senthil Kumaran 627284c67f Fix Issue10793 - hashlib documentation issue on return type of digest 2010-12-30 07:07:58 +00:00
Gregory P. Smith 13b55291ac hashlib has two new constant attributes: algorithms_guaranteed and
algorithms_avaiable that respectively list the names of hash algorithms
guaranteed to exist in all Python implementations and the names of hash
algorithms available in the current process.

Renames the attribute new in 3.2a0 'algorithms' to 'algorithms_guaranteed'.
2010-09-06 08:30:23 +00:00