doc: note that get_params and set_params calls should return true if the param array...
[openssl.git] / doc / man7 / EVP_SIGNATURE-HMAC.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_SIGNATURE-HMAC, EVP_SIGNATURE-Siphash, EVP_SIGNATURE-Poly1305,
6 EVP_SIGNATURE-CMAC
7 - The legacy B<EVP_PKEY> MAC signature implementations
8
9 =head1 DESCRIPTION
10
11 The algorithms described here have legacy support for creating MACs using
12 L<EVP_DigestSignInit(3)> and related functions. This is not the preferred way of
13 creating MACs. Instead you should use the newer L<EVP_MAC_init(3)> functions.
14 This mechanism is provided for backwards compatibility with older versions of
15 OpenSSL.
16
17 The same signature parameters can be set using EVP_PKEY_CTX_set_params() as can
18 be set via EVP_MAC_CTX_set_params() for the underlying EVP_MAC. See
19 L<EVP_MAC-HMAC(7)>, L<EVP_MAC-Siphash(7)>, L<EVP_MAC-Poly1305(7)> and
20 L<EVP_MAC-CMAC(7)> for details.
21
22  See L<EVP_PKEY-HMAC(7)>, L<EVP_PKEY-Siphash(7)>, L<EVP_PKEY-Poly1305(7)> or
23  L<EVP_PKEY-CMAC(7)> for details about parameters that are supported during the
24  creation of an EVP_PKEY.
25
26 =head1 SEE ALSO
27
28 L<EVP_MAC_init(3)>,
29 L<EVP_DigestSignInit(3)>,
30 L<EVP_PKEY-HMAC(7)>,
31 L<EVP_PKEY-Siphash(7)>,
32 L<EVP_PKEY-Poly1305(7)>,
33 L<EVP_PKEY-CMAC(7)>,
34 L<EVP_MAC-HMAC(7)>,
35 L<EVP_MAC-Siphash(7)>,
36 L<EVP_MAC-Poly1305(7)>,
37 L<EVP_MAC-CMAC(7)>,
38 L<provider-signature(7)>,
39
40 =head1 COPYRIGHT
41
42 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
43
44 Licensed under the Apache License 2.0 (the "License").  You may not use
45 this file except in compliance with the License.  You can obtain a copy
46 in the file LICENSE in the source distribution or at
47 L<https://www.openssl.org/source/license.html>.
48
49 =cut