]>
Commit | Line | Data |
---|---|---|
e592dbde RL |
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 | ||
745fc918 | 18 | =item "CMAC", "provider=default" or "provider=fips" |
e592dbde RL |
19 | |
20 | =back | |
21 | ||
22 | =head2 Supported parameters | |
23 | ||
24 | The general description of these parameters can be found in | |
fddb1847 | 25 | L<EVP_MAC(3)/PARAMETERS>. |
e592dbde | 26 | |
865adf97 | 27 | The following parameter can be set with EVP_MAC_CTX_set_params(): |
e592dbde RL |
28 | |
29 | =over 4 | |
30 | ||
0c452a51 | 31 | =item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string> |
e592dbde | 32 | |
0c452a51 | 33 | =item "cipher" (B<OSSL_MAC_PARAM_CIPHER>) <UTF8 string> |
e592dbde | 34 | |
0c452a51 | 35 | =item "properties" (B<OSSL_MAC_PARAM_PROPERTIES>) <UTF8 string> |
e592dbde RL |
36 | |
37 | =back | |
38 | ||
39 | The following parameters can be retrieved with | |
865adf97 | 40 | EVP_MAC_CTX_get_params(): |
e592dbde RL |
41 | |
42 | =over 4 | |
43 | ||
0c452a51 | 44 | =item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer> |
e592dbde RL |
45 | |
46 | =back | |
47 | ||
48 | The "size" parameter can also be retrieved with with EVP_MAC_size(). | |
f49a65d0 | 49 | The length of the "size" parameter is equal to that of an B<unsigned int>. |
e592dbde RL |
50 | |
51 | =head1 SEE ALSO | |
52 | ||
865adf97 | 53 | L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>, |
fddb1847 | 54 | L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)> |
e592dbde RL |
55 | |
56 | =head1 COPYRIGHT | |
57 | ||
33388b44 | 58 | Copyright 2018-2020 The OpenSSL Project Authors. All Rights Reserved. |
e592dbde RL |
59 | |
60 | Licensed under the Apache License 2.0 (the "License"). You may not use | |
61 | this file except in compliance with the License. You can obtain a copy | |
62 | in the file LICENSE in the source distribution or at | |
63 | L<https://www.openssl.org/source/license.html>. | |
64 | ||
65 | =cut |