rest25/library/hashlib.rst => rest262/library/hashlib.rst
f1
2:mod:`hashlib` --- Secure hashes and message digests
3====================================================
4
5.. module:: hashlib
6   :synopsis: Secure hash and message digest algorithms.
n7-.. moduleauthor:: Gregory P. Smith <greg@users.sourceforge.net>
n7+.. moduleauthor:: Gregory P. Smith <greg@krypto.org>
8-.. sectionauthor:: Gregory P. Smith <greg@users.sourceforge.net>
8+.. sectionauthor:: Gregory P. Smith <greg@krypto.org>
9
10
11.. versionadded:: 2.5
12
13.. index::
14   single: message digest, MD5
15   single: secure hash algorithm, SHA1, SHA224, SHA256, SHA384, SHA512
16
17This module implements a common interface to many different secure hash and
18message digest algorithms.  Included are the FIPS secure hash algorithms SHA1,
19SHA224, SHA256, SHA384, and SHA512 (defined in FIPS 180-2) as well as RSA's MD5
20algorithm (defined in Internet :rfc:`1321`). The terms secure hash and message
21digest are interchangeable.  Older algorithms were called message digests.  The
22modern term is secure hash.
23
n24+.. note::
25+   If you want the adler32 or crc32 hash functions they are available in
26+   the :mod:`zlib` module.
27+ 
24.. warning::
25
26   Some algorithms have known hash collision weaknesses, see the FAQ at the end.
27
28There is one constructor method named for each type of :dfn:`hash`.  All return
29a hash object with the same simple interface. For example: use :func:`sha1` to
30create a SHA1 hash object. You can now feed this object with arbitrary strings
31using the :meth:`update` method.  At any point you can ask it for the
32:dfn:`digest` of the concatenation of the strings fed to it so far using the
33:meth:`digest` or :meth:`hexdigest` methods.
34
n35-.. index:: single: OpenSSL
n39+.. index:: single: OpenSSL; (use in module hashlib)
36
37Constructors for hash algorithms that are always present in this module are
38:func:`md5`, :func:`sha1`, :func:`sha224`, :func:`sha256`, :func:`sha384`, and
39:func:`sha512`.  Additional algorithms may also be available depending upon the
40OpenSSL library that Python uses on your platform.
41
42For example, to obtain the digest of the string ``'Nobody inspects the spammish
n43-repetition'``::
n47+repetition'``:
44
45   >>> import hashlib
46   >>> m = hashlib.md5()
47   >>> m.update("Nobody inspects")
48   >>> m.update(" the spammish repetition")
49   >>> m.digest()
50   '\xbbd\x9c\x83\xdd\x1e\xa5\xc9\xd9\xde\xc9\xa1\x8d\xf0\xff\xe9'
n55+   >>> m.digest_size
56+   16
57+   >>> m.block_size
58+   64
51
n52-More condensed::
n60+More condensed:
53
54   >>> hashlib.sha224("Nobody inspects the spammish repetition").hexdigest()
55   'a4337bc45a8fc544c03f52dc550cd6e1e87021bc896588bd79e901e2'
56
57A generic :func:`new` constructor that takes the string name of the desired
58algorithm as its first parameter also exists to allow access to the above listed
59hashes as well as any other algorithms that your OpenSSL library may offer.  The
60named constructors are much faster than :func:`new` and should be preferred.
61
n62-Using :func:`new` with an algorithm provided by OpenSSL::
n70+Using :func:`new` with an algorithm provided by OpenSSL:
63
64   >>> h = hashlib.new('ripemd160')
65   >>> h.update("Nobody inspects the spammish repetition")
66   >>> h.hexdigest()
67   'cc4a5ce1b3df48aec5d22d1f16b894a0b894eccc'
68
69The following values are provided as constant attributes of the hash objects
70returned by the constructors:
71
72
73.. data:: digest_size
74
t75-   The size of the resulting digest in bytes.
t83+   The size of the resulting hash in bytes.
84+ 
85+.. data:: block_size
86+ 
87+   The internal block size of the hash algorithm in bytes.
76
77A hash object has the following methods:
78
79
80.. method:: hash.update(arg)
81
82   Update the hash object with the string *arg*.  Repeated calls are equivalent to
83   a single call with the concatenation of all the arguments: ``m.update(a);
Legends
Colors
 Added 
Changed
Deleted
Links
(f)irst change
(n)ext change
(t)op