mirror of
https://github.com/openssl/openssl.git
synced 2025-02-11 14:22:43 +08:00
d9c2fd51e2
functions are now EVP_MAC functions, usually with ctx in their names. Before 3.0 is released, the names are mutable and this prevents more inconsistencies being introduced. There are no functional or code changes. Just the renaming and a little reformatting. Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/11997)
66 lines
1.6 KiB
Plaintext
66 lines
1.6 KiB
Plaintext
=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_set_ctx_params().
|
|
Furthermore, the "size" parameter can be retrieved with
|
|
EVP_MAC_get_ctx_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_get_ctx_params(3)>, L<EVP_MAC_set_ctx_params(3)>,
|
|
L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2018-2020 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
|