EVP_MAC: Add CMAC implementation
[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 Numeric identity
12
13 B<EVP_MAC_CMAC> is the numeric identity for this implementation, and
14 can be used in functions like EVP_MAC_CTX_new_id() and
15 EVP_get_macbynid().
16
17 =head2 Supported controls
18
19 The supported controls are:
20
21 =over 4
22
23 =item B<EVP_MAC_CTRL_SET_KEY>
24
25 EVP_MAC_ctrl_str() takes to type string for this control:
26
27 =over 4
28
29 =item "key"
30
31 The value string is used as is.
32
33 =item "hexkey"
34
35 The value string is expected to be a hexadecimal number, which will be
36 decoded before passing on as control value.
37
38 =back
39
40 =item B<EVP_MAC_CTRL_SET_ENGINE>
41
42 =item B<EVP_MAC_CTRL_SET_CIPHER>
43
44 These work as described in L<EVP_MAC(3)/CONTROLS>.
45
46 EVP_MAC_ctrl_str() type string for B<EVP_MAC_CTRL_SET_CIPHER>: "cipher"
47
48 The value is expected to be the name of a cipher.
49
50 =back
51
52 =head1 SEE ALSO
53
54 L<EVP_MAC_ctrl(3)>, L<EVP_MAC(3)/CONTROLS>
55
56 =head1 COPYRIGHT
57
58 Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
59
60 Licensed under the OpenSSL license (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