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

=pod

=head1 NAME

EVP_MAC-KMAC, EVP_MAC-KMAC128, EVP_MAC-KMAC256
- The KMAC EVP_MAC implementations

=head1 DESCRIPTION

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

=head2 Identity

These implementations are identified with one of these names and
properties, to be used with EVP_MAC_fetch():

=over 4

=item "KMAC-128", "provider=default" or "provider=fips"

=item "KMAC-256", "provider=default" or "provider=fips"

=back

=head2 Supported parameters

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

All these parameters can be set with EVP_MAC_CTX_set_params().
Furthermore, the "size" parameter can be retrieved with
EVP_MAC_CTX_get_params(), or with EVP_MAC_size().
The length of the "size" parameter should not exceed that of a B<size_t>.

=over 4

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

=item "custom" (B<OSSL_MAC_PARAM_CUSTOM>) <octet string>

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

=item "xof" (B<OSSL_MAC_PARAM_XOF>) <integer>

=back

The "xof" parameter value is expected to be 1 or 0. Use 1 to enable XOF
mode. If XOF is enabled then the output length that is encoded as part of
the input stream is set to zero.

=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-2019 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
d7cea0b8	5	EVP_MAC-KMAC, EVP_MAC-KMAC128, EVP_MAC-KMAC256
e592dbde RL	6	- The KMAC EVP_MAC implementations
	7
	8	=head1 DESCRIPTION
	9
	10	Support for computing KMAC MACs through the B<EVP_MAC> API.
	11
	12	=head2 Identity
	13
	14	These implementations are identified with one of these names and
	15	properties, to be used with EVP_MAC_fetch():
	16
	17	=over 4
	18
745fc918	19	=item "KMAC-128", "provider=default" or "provider=fips"
e592dbde	20
745fc918	21	=item "KMAC-256", "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 RL	29
	30	All these parameters can be set with EVP_MAC_CTX_set_params().
	31	Furthermore, the "size" parameter can be retrieved with
	32	EVP_MAC_CTX_get_params(), or with EVP_MAC_size().
f49a65d0	33	The length of the "size" parameter should not exceed that of a B<size_t>.
e592dbde RL	34
	35	=over 4
	36
0c452a51	37	=item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
e592dbde	38
0c452a51	39	=item "custom" (B<OSSL_MAC_PARAM_CUSTOM>) <octet string>
e592dbde	40
0c452a51	41	=item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
e592dbde	42
0c452a51	43	=item "xof" (B<OSSL_MAC_PARAM_XOF>) <integer>
e592dbde RL	44
	45	=back
	46
1242f3c7 SL	47	The "xof" parameter value is expected to be 1 or 0. Use 1 to enable XOF
1242f3c7 SL	48	mode. If XOF is enabled then the output length that is encoded as part of
e592dbde RL	49	the input stream is set to zero.
	50
	51	=head1 SEE ALSO
	52
	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
	58	Copyright 2018-2019 The OpenSSL Project Authors. All Rights Reserved.
	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