Rework the documentation of our individual MAC implementations
[openssl.git] / doc / man7 / EVP_MAC-CMAC.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_MAC-CMAC - The CMAC EVP_MAC implementation
6
7 =head1 DESCRIPTION
8
9 Support for computing CMAC 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 "CMAC", "default=yes"
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)/PARAMETER NAMES>.
26
27 The following parameter can be set with EVP_MAC_CTX_set_params():
28
29 =over 4
30
31 =item B<OSSL_MAC_PARAM_KEY> ("key") <octet string>
32
33 =item B<OSSL_MAC_PARAM_ENGINE> ("engine") <utf8 string>
34
35 =item B<OSSL_MAC_PARAM_CIPHER> ("cipher") <utf8 string>
36
37 =item B<OSSL_MAC_PARAM_PROPERTIES> ("properties") <utf8 string>
38
39 =back
40
41 The following parameters can be retrieved with
42 EVP_MAC_CTX_get_params():
43
44 =over 4
45
46 =item B<OSSL_MAC_PARAM_SIZE> ("size") <unsigned int>
47
48 =back
49
50 The "size" parameter can also be retrieved with with EVP_MAC_size().
51
52 =head1 SEE ALSO
53
54 L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
55 L<EVP_MAC(3)/PARAMETER NAMES>, L<OSSL_PARAM(3)>
56
57 =head1 COPYRIGHT
58
59 Copyright 2018-2019 The OpenSSL Project Authors. All Rights Reserved.
60
61 Licensed under the Apache License 2.0 (the "License").  You may not use
62 this file except in compliance with the License.  You can obtain a copy
63 in the file LICENSE in the source distribution or at
64 L<https://www.openssl.org/source/license.html>.
65
66 =cut