The EVP_MAC functions have been renamed for consistency. The EVP_MAC_CTX_*
[openssl.git] / doc / man7 / EVP_MAC-HMAC.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_MAC-HMAC - The HMAC EVP_MAC implementation
6
7 =head1 DESCRIPTION
8
9 Support for computing HMAC MACs through the B<EVP_MAC> API.
10
11 =head2 Identity
12
13 This implementation is identified with this name and properties, to be
14 used with EVP_MAC_fetch():
15
16 =over 4
17
18 =item "HMAC", "provider=default" or "provider=fips"
19
20 =back
21
22 =head2 Supported parameters
23
24 The general description of these parameters can be found in
25 L<EVP_MAC(3)/PARAMETERS>.
26
27 The following parameter can be set with EVP_MAC_set_ctx_params():
28
29 =over 4
30
31 =item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
32
33 =item "flags" (B<OSSL_MAC_PARAM_FLAGS>) <octet string>
34
35 =item "digest" (B<OSSL_MAC_PARAM_DIGEST>) <UTF8 string>
36
37 =item "properties" (B<OSSL_MAC_PARAM_PROPERTIES>) <UTF8 string>
38
39 =back
40
41 The "flags" parameter is passed directly to HMAC_CTX_set_flags().
42
43 The following parameter can be retrieved with
44 EVP_MAC_get_ctx_params():
45
46 =over 4
47
48 =item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
49
50 =back
51
52 The "size" parameter can also be retrieved with EVP_MAC_size().
53 The length of the "size" parameter is equal to that of an B<unsigned int>.
54
55 =head1 SEE ALSO
56
57 L<EVP_MAC_get_ctx_params(3)>, L<EVP_MAC_set_ctx_params(3)>,
58 L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>, L<HMAC(3)>
59
60 =head1 COPYRIGHT
61
62 Copyright 2018-2020 The OpenSSL Project Authors. All Rights Reserved.
63
64 Licensed under the Apache License 2.0 (the "License").  You may not use
65 this file except in compliance with the License.  You can obtain a copy
66 in the file LICENSE in the source distribution or at
67 L<https://www.openssl.org/source/license.html>.
68
69 =cut