xref: /linux/Documentation/crypto/libcrypto-hash.rst (revision 88b8c6ae2ccb3ef9dbb04c8e13a4d1a98c42e922)
1.. SPDX-License-Identifier: GPL-2.0-or-later
2
3Hash functions, MACs, and XOFs
4==============================
5
6AES-CMAC and AES-XCBC-MAC
7-------------------------
8
9This API provides support for the AES-CMAC and AES-XCBC-MAC message
10authentication codes.
11
12.. kernel-doc:: include/crypto/aes-cbc-macs.h
13
14BLAKE2b
15-------
16
17This API provides support for the BLAKE2b cryptographic hash function.
18
19.. kernel-doc:: include/crypto/blake2b.h
20
21BLAKE2s
22-------
23
24This API provides support for the BLAKE2s cryptographic hash function.
25
26.. kernel-doc:: include/crypto/blake2s.h
27
28GHASH and POLYVAL
29-----------------
30
31This API provides support for the GHASH and POLYVAL universal hash functions.
32These algorithms are used only as internal components of other algorithms.
33
34.. kernel-doc:: include/crypto/gf128hash.h
35
36MD5
37---
38
39This API provides support for the MD5 cryptographic hash function and HMAC-MD5.
40This algorithm is obsolete and is supported only for backwards compatibility.
41
42.. kernel-doc:: include/crypto/md5.h
43
44NH
45--
46
47This API provides support for the NH universal hash function.  This algorithm is
48used only as an internal component of other algorithms.
49
50.. kernel-doc:: include/crypto/nh.h
51
52Poly1305
53--------
54
55This API provides support for the Poly1305 universal hash function.  This
56algorithm is used only as an internal component of other algorithms.
57
58.. kernel-doc:: include/crypto/poly1305.h
59
60SHA-1
61-----
62
63This API provides support for the SHA-1 cryptographic hash function and
64HMAC-SHA1.  This algorithm is obsolete and is supported only for backwards
65compatibility.
66
67.. kernel-doc:: include/crypto/sha1.h
68
69SHA-2
70-----
71
72This API provides support for the SHA-2 family of cryptographic hash functions,
73including SHA-224, SHA-256, SHA-384, and SHA-512.  This also includes their
74corresponding HMACs: HMAC-SHA224, HMAC-SHA256, HMAC-SHA384, and HMAC-SHA512.
75
76.. kernel-doc:: include/crypto/sha2.h
77
78SHA-3
79-----
80
81The SHA-3 API is documented in :ref:`sha3`.
82
83SM3
84---
85
86This API provides support for the SM3 cryptographic hash function.
87
88.. kernel-doc:: include/crypto/sm3.h
89