mirror of
https://github.com/openssl/openssl.git
synced 2024-12-09 05:51:54 +08:00
e592dbde6f
We now describe parameters instead of controls.
Also, since macros like EVP_MAC_CMAC do not exist any more, we rename
the pod files from EVP_MAC_{algo}.pod to EVP_MAC-{algo}.pod. This
allows getting the documentation like this:
man EVP_MAC CMAC
[skip ci]
Fixes #9709
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/9713)
65 lines
1.5 KiB
Plaintext
65 lines
1.5 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
EVP_MAC-KMAC, EVP_MAC-KMAC256, 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 "KMAC128", "default=yes"
|
|
|
|
=item "KMAC256", "default=yes"
|
|
|
|
=back
|
|
|
|
=head2 Supported parameters
|
|
|
|
The general description of these parameters can be found in
|
|
L<EVP_MAC(3)/PARAMETER NAMES>.
|
|
|
|
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().
|
|
|
|
=over 4
|
|
|
|
=item B<OSSL_MAC_PARAM_KEY> ("key") <octet string>
|
|
|
|
=item B<OSSL_MAC_PARAM_CUSTOM> ("custom") <octet string>
|
|
|
|
=item B<OSSL_MAC_PARAM_SIZE> ("size") <size_t>
|
|
|
|
=item B<OSSL_MAC_PARAM_XOF>
|
|
|
|
=back
|
|
|
|
The "xof" parameter value is exptect to be 1 or 0. Use 1 to enable XOF
|
|
mode. If XOF is enabled then the output len 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)/PARAMETER NAMES>, 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
|