mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2024-12-27 06:21:43 +08:00
Code Issues Packages Projects Releases Wiki Activity
2b9bafe607
openssl/doc/man7/EVP_MAC-KMAC.pod

66 lines
1.6 KiB
Plaintext
Raw Normal View History

Rework the documentation of our individual MAC implementations 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)
2019-08-28 15:13:21 +08:00
=pod
=head1 NAME
Fix some broken doc links Replace L<> link to header-file with a C<> reference. Change some broken L<provider(3)> links to L<provider(7)>. For consistency, rename four cipher pages to have a specific mode. Fix up all references to any "generic" names to point to specific names. Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/10100)
2019-08-22 13:21:25 +08:00
EVP_MAC-KMAC, EVP_MAC-KMAC128, EVP_MAC-KMAC256
Rework the documentation of our individual MAC implementations 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)
2019-08-28 15:13:21 +08:00
- 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
Introduce the provider property Replace the properties default, fips and legacy with a single property called "provider". So, for example, instead of writing "default=yes" to get algorithms from the default provider you would instead write "provider=default". We also have a new "fips" property to indicate that an algorithm is compatible with FIPS mode. This applies to all the algorithms in the FIPS provider, as well as any non-cryptographic algorithms (currently only serializers). Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/11097)
2020-02-15 06:49:26 +08:00
=item "KMAC-128", "provider=default" or "provider=fips"
Rework the documentation of our individual MAC implementations 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)
2019-08-28 15:13:21 +08:00
Introduce the provider property Replace the properties default, fips and legacy with a single property called "provider". So, for example, instead of writing "default=yes" to get algorithms from the default provider you would instead write "provider=default". We also have a new "fips" property to indicate that an algorithm is compatible with FIPS mode. This applies to all the algorithms in the FIPS provider, as well as any non-cryptographic algorithms (currently only serializers). Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/11097)
2020-02-15 06:49:26 +08:00
=item "KMAC-256", "provider=default" or "provider=fips"
Rework the documentation of our individual MAC implementations 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)
2019-08-28 15:13:21 +08:00
=back
=head2 Supported parameters
The general description of these parameters can be found in
Change PARAMETER NAMES links to PARAMETERS Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/9905)
2019-09-17 06:46:49 +08:00
L<EVP_MAC(3)/PARAMETERS>.
Rework the documentation of our individual MAC implementations 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)
2019-08-28 15:13:21 +08:00
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().
Use OSSL_PARAM types for MAC documentation Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10011)
2019-09-25 18:27:36 +08:00
The length of the "size" parameter should not exceed that of a B<size_t>.
Rework the documentation of our individual MAC implementations 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)
2019-08-28 15:13:21 +08:00
=over 4
Reformat param description lines Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10024)
2019-09-10 16:05:57 +08:00
=item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
Rework the documentation of our individual MAC implementations 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)
2019-08-28 15:13:21 +08:00
Reformat param description lines Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10024)
2019-09-10 16:05:57 +08:00
=item "custom" (B<OSSL_MAC_PARAM_CUSTOM>) <octet string>
Rework the documentation of our individual MAC implementations 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)
2019-08-28 15:13:21 +08:00
Reformat param description lines Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10024)
2019-09-10 16:05:57 +08:00
=item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
Rework the documentation of our individual MAC implementations 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)
2019-08-28 15:13:21 +08:00
Reformat param description lines Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10024)
2019-09-10 16:05:57 +08:00
=item "xof" (B<OSSL_MAC_PARAM_XOF>) <integer>
Rework the documentation of our individual MAC implementations 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)
2019-08-28 15:13:21 +08:00
=back
Fix KMAC docs Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> (Merged from https://github.com/openssl/openssl/pull/9970)
2019-09-22 07:19:05 +08:00
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
Rework the documentation of our individual MAC implementations 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)
2019-08-28 15:13:21 +08:00
the input stream is set to zero.
=head1 SEE ALSO
L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
Change PARAMETER NAMES links to PARAMETERS Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/9905)
2019-09-17 06:46:49 +08:00
L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
Rework the documentation of our individual MAC implementations 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)
2019-08-28 15:13:21 +08:00
=head1 COPYRIGHT
Update copyright year Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/11616)
2020-04-23 20:55:52 +08:00
Copyright 2018-2020 The OpenSSL Project Authors. All Rights Reserved.
Rework the documentation of our individual MAC implementations 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)
2019-08-28 15:13:21 +08:00
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
Reference in New Issue Copy Permalink