mirror of
https://github.com/openssl/openssl.git
synced 2024-12-09 05:51:54 +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)
68 lines
1.5 KiB
Plaintext
68 lines
1.5 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
EVP_MAC-GMAC - The GMAC EVP_MAC implementation
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Support for computing GMAC MACs through the B<EVP_MAC> API.
|
|
|
|
=head2 Identity
|
|
|
|
This implementation is identified with this name and properties, to be
|
|
used with EVP_MAC_fetch():
|
|
|
|
=over 4
|
|
|
|
=item "GMAC", "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_set_ctx_params():
|
|
|
|
=over 4
|
|
|
|
=item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
|
|
|
|
=item "iv" (B<OSSL_MAC_PARAM_IV>) <octet string>
|
|
|
|
=item "cipher" (B<OSSL_MAC_PARAM_CIPHER>) <UTF8 string>
|
|
|
|
=item "properties" (B<OSSL_MAC_PARAM_PROPERTIES>) <UTF8 string>
|
|
|
|
=back
|
|
|
|
The following parameters can be retrieved with
|
|
EVP_MAC_get_ctx_params():
|
|
|
|
=over 4
|
|
|
|
=item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
|
|
|
|
=back
|
|
|
|
The "size" parameter can also be retrieved with EVP_MAC_size().
|
|
The length of the "size" parameter is equal to that of an B<unsigned int>.
|
|
|
|
=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
|