[thirdparty/openssl.git] / doc / man7 / EVP_MAC-CMAC.pod

=pod

=head1 NAME

EVP_MAC-CMAC - The CMAC EVP_MAC implementation

=head1 DESCRIPTION

Support for computing CMAC MACs through the B<EVP_MAC> API.

This implementation uses EVP_CIPHER functions to get access to the underlying
cipher.

=head2 Identity

This implementation is identified with this name and properties, to be
used with EVP_MAC_fetch():

=over 4

=item "CMAC", "provider=default" or "provider=fips"

=back

=head2 Supported parameters

The general description of these parameters can be found in
L<EVP_MAC(3)/PARAMETERS>.

The following parameter can be set with EVP_MAC_CTX_set_params():

=over 4

=item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>

Sets the MAC key.
Setting this parameter is identical to passing a I<key> to L<EVP_MAC_init(3)>.

=item "cipher" (B<OSSL_MAC_PARAM_CIPHER>) <UTF8 string>

Sets the name of the underlying cipher to be used.

=item "properties" (B<OSSL_MAC_PARAM_PROPERTIES>) <UTF8 string>

Sets the properties to be queried when trying to fetch the underlying cipher.
This must be given together with the cipher naming parameter to be considered
valid.

=back

The following parameters can be retrieved with
EVP_MAC_CTX_get_params():

=over 4

=item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>

=back

The "size" parameter can also be retrieved with with EVP_MAC_CTX_get_mac_size().
The length of the "size" parameter is equal to that of an B<unsigned int>.

=head1 SEE ALSO

L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>

=head1 COPYRIGHT

Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut
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
8593ff00 RL	11	This implementation uses EVP_CIPHER functions to get access to the underlying
	12	cipher.
	13
e592dbde RL	14	=head2 Identity
	15
	16	This implementation is identified with this name and properties, to be
	17	used with EVP_MAC_fetch():
	18
	19	=over 4
	20
745fc918	21	=item "CMAC", "provider=default" or "provider=fips"
e592dbde RL	22
	23	=back
	24
	25	=head2 Supported parameters
	26
	27	The general description of these parameters can be found in
fddb1847	28	L<EVP_MAC(3)/PARAMETERS>.
e592dbde	29
865adf97	30	The following parameter can be set with EVP_MAC_CTX_set_params():
e592dbde RL	31
	32	=over 4
	33
0c452a51	34	=item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
e592dbde	35
8593ff00 RL	36	Sets the MAC key.
	37	Setting this parameter is identical to passing a I<key> to L<EVP_MAC_init(3)>.
	38
0c452a51	39	=item "cipher" (B<OSSL_MAC_PARAM_CIPHER>) <UTF8 string>
e592dbde	40
8593ff00 RL	41	Sets the name of the underlying cipher to be used.
8593ff00 RL	42
0c452a51	43	=item "properties" (B<OSSL_MAC_PARAM_PROPERTIES>) <UTF8 string>
e592dbde	44
8593ff00 RL	45	Sets the properties to be queried when trying to fetch the underlying cipher.
	46	This must be given together with the cipher naming parameter to be considered
	47	valid.
	48
e592dbde RL	49	=back
	50
	51	The following parameters can be retrieved with
865adf97	52	EVP_MAC_CTX_get_params():
e592dbde RL	53
	54	=over 4
	55
0c452a51	56	=item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
e592dbde RL	57
	58	=back
	59
90a2576b	60	The "size" parameter can also be retrieved with with EVP_MAC_CTX_get_mac_size().
f49a65d0	61	The length of the "size" parameter is equal to that of an B<unsigned int>.
e592dbde RL	62
	63	=head1 SEE ALSO
	64
865adf97	65	L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
fddb1847	66	L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
e592dbde RL	67
	68	=head1 COPYRIGHT
	69
8020d79b	70	Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.
e592dbde RL	71
	72	Licensed under the Apache License 2.0 (the "License"). You may not use
	73	this file except in compliance with the License. You can obtain a copy
	74	in the file LICENSE in the source distribution or at
	75	L<https://www.openssl.org/source/license.html>.
	76
	77	=cut