xref: /freebsd/crypto/openssl/doc/man7/EVP_MAC-CMAC.pod (revision e0c4386e7e71d93b0edc0c8fa156263fc4a8b0b6)
1=pod
2
3=head1 NAME
4
5EVP_MAC-CMAC - The CMAC EVP_MAC implementation
6
7=head1 DESCRIPTION
8
9Support for computing CMAC MACs through the B<EVP_MAC> API.
10
11This implementation uses EVP_CIPHER functions to get access to the underlying
12cipher.
13
14=head2 Identity
15
16This implementation is identified with this name and properties, to be
17used with EVP_MAC_fetch():
18
19=over 4
20
21=item "CMAC", "provider=default" or "provider=fips"
22
23=back
24
25=head2 Supported parameters
26
27The general description of these parameters can be found in
28L<EVP_MAC(3)/PARAMETERS>.
29
30The following parameter can be set with EVP_MAC_CTX_set_params():
31
32=over 4
33
34=item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
35
36Sets the MAC key.
37Setting this parameter is identical to passing a I<key> to L<EVP_MAC_init(3)>.
38
39=item "cipher" (B<OSSL_MAC_PARAM_CIPHER>) <UTF8 string>
40
41Sets the name of the underlying cipher to be used.
42
43=item "properties" (B<OSSL_MAC_PARAM_PROPERTIES>) <UTF8 string>
44
45Sets the properties to be queried when trying to fetch the underlying cipher.
46This must be given together with the cipher naming parameter to be considered
47valid.
48
49=back
50
51The following parameters can be retrieved with
52EVP_MAC_CTX_get_params():
53
54=over 4
55
56=item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
57
58The "size" parameter can also be retrieved with with EVP_MAC_CTX_get_mac_size().
59The length of the "size" parameter is equal to that of an B<unsigned int>.
60
61=back
62
63=over 4
64
65=item "block-size" (B<OSSL_MAC_PARAM_BLOCK_SIZE>) <unsigned integer>
66
67Gets the MAC block size.  The "block-size" parameter can also be retrieved with
68EVP_MAC_CTX_get_block_size().
69
70=back
71
72=head1 SEE ALSO
73
74L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
75L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
76
77=head1 COPYRIGHT
78
79Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.
80
81Licensed under the Apache License 2.0 (the "License").  You may not use
82this file except in compliance with the License.  You can obtain a copy
83in the file LICENSE in the source distribution or at
84L<https://www.openssl.org/source/license.html>.
85
86=cut
87