Debian Codegraph @

upstream/debian-unstable/man7/EVP_MAC-CMAC.7ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "EVP_MAC-CMAC 7SSL"
58 .TH EVP_MAC-CMAC 7SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 EVP_MAC\-CMAC \- The CMAC EVP_MAC implementation
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 Support for computing CMAC MACs through the \fBEVP_MAC\fR API.
68 .PP
69 This implementation uses EVP_CIPHER functions to get access to the underlying
70 cipher.
71 .SS Identity
72 .IX Subsection "Identity"
73 This implementation is identified with this name and properties, to be
74 used with \fBEVP_MAC_fetch()\fR:
75 .IP """CMAC"", ""provider=default"" or ""provider=fips""" 4
76 .IX Item """CMAC"", ""provider=default"" or ""provider=fips"""
77 .SS "Supported parameters"
78 .IX Subsection "Supported parameters"
79 The general description of these parameters can be found in
80 "PARAMETERS" in \fBEVP_MAC\fR\|(3).
81 .PP
82 The following parameter can be set with \fBEVP_MAC_CTX_set_params()\fR:
83 .IP """key"" (\fBOSSL_MAC_PARAM_KEY\fR) <octet string>" 4
84 .IX Item """key"" (OSSL_MAC_PARAM_KEY) <octet string>"
85 Sets the MAC key.
86 Setting this parameter is identical to passing a \fIkey\fR to \fBEVP_MAC_init\fR\|(3).
87 .IP """cipher"" (\fBOSSL_MAC_PARAM_CIPHER\fR) <UTF8 string>" 4
88 .IX Item """cipher"" (OSSL_MAC_PARAM_CIPHER) <UTF8 string>"
89 Sets the name of the underlying cipher to be used. The mode of the cipher
90 must be CBC.
91 .IP """properties"" (\fBOSSL_MAC_PARAM_PROPERTIES\fR) <UTF8 string>" 4
92 .IX Item """properties"" (OSSL_MAC_PARAM_PROPERTIES) <UTF8 string>"
93 Sets the properties to be queried when trying to fetch the underlying cipher.
94 This must be given together with the cipher naming parameter to be considered
95 valid.
96 .IP """encrypt-check"" (\fBOSSL_CIPHER_PARAM_FIPS_ENCRYPT_CHECK\fR) <integer>" 4
97 .IX Item """encrypt-check"" (OSSL_CIPHER_PARAM_FIPS_ENCRYPT_CHECK) <integer>"
98 This option is used by the OpenSSL FIPS provider.
99 If required this parameter should be set before \fBEVP_MAC_init()\fR
100 .Sp
101 The default value of 1 causes an error when a unapproved Triple-DES encryption
102 operation is triggered.
103 Setting this to 0 will ignore the error and set the approved
104 "fips-indicator" to 0.
105 This option breaks FIPS compliance if it causes the approved "fips-indicator"
106 to return 0.
107 .PP
108 The following parameters can be retrieved with
109 \&\fBEVP_MAC_CTX_get_params()\fR:
110 .IP """size"" (\fBOSSL_MAC_PARAM_SIZE\fR) <unsigned integer>" 4
111 .IX Item """size"" (OSSL_MAC_PARAM_SIZE) <unsigned integer>"
112 The "size" parameter can also be retrieved with with \fBEVP_MAC_CTX_get_mac_size()\fR.
113 The length of the "size" parameter is equal to that of an \fBunsigned int\fR.
114 .IP """block-size"" (\fBOSSL_MAC_PARAM_BLOCK_SIZE\fR) <unsigned integer>" 4
115 .IX Item """block-size"" (OSSL_MAC_PARAM_BLOCK_SIZE) <unsigned integer>"
116 Gets the MAC block size. The "block-size" parameter can also be retrieved with
117 \&\fBEVP_MAC_CTX_get_block_size()\fR.
118 .IP """fips-indicator"" (\fBOSSL_CIPHER_PARAM_FIPS_APPROVED_INDICATOR\fR) <integer>" 4
119 .IX Item """fips-indicator"" (OSSL_CIPHER_PARAM_FIPS_APPROVED_INDICATOR) <integer>"
120 This option is used by the OpenSSL FIPS provider.
121 .Sp
122 A getter that returns 1 if the operation is FIPS approved, or 0 otherwise.
123 This may be used after calling \fBEVP_MAC_final()\fR.
124 It may return 0 if the "encrypt-check" option is set to 0.
125 .SH "SEE ALSO"
126 .IX Header "SEE ALSO"
127 \&\fBEVP_MAC_CTX_get_params\fR\|(3), \fBEVP_MAC_CTX_set_params\fR\|(3),
128 "PARAMETERS" in \fBEVP_MAC\fR\|(3), \fBOSSL_PARAM\fR\|(3)
129 .SH COPYRIGHT
130 .IX Header "COPYRIGHT"
131 Copyright 2018\-2024 The OpenSSL Project Authors. All Rights Reserved.
132 .PP
133 Licensed under the Apache License 2.0 (the "License"). You may not use
134 this file except in compliance with the License. You can obtain a copy
135 in the file LICENSE in the source distribution or at
136 <https://www.openssl.org/source/license.html>.