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

=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_CTX_set_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_CTX_get_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_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
	5	EVP_MAC-GMAC - The GMAC EVP_MAC implementation
	6
	7	=head1 DESCRIPTION
	8
	9	Support for computing GMAC MACs through the B<EVP_MAC> API.
	10
	11	=head2 Identity
	12
	13	This implementation is identified with this name and properties, to be
	14	used with EVP_MAC_fetch():
	15
	16	=over 4
	17
745fc918	18	=item "GMAC", "provider=default" or "provider=fips"
e592dbde RL	19
	20	=back
	21
	22	=head2 Supported parameters
	23
	24	The general description of these parameters can be found in
fddb1847	25	L<EVP_MAC(3)/PARAMETERS>.
e592dbde RL	26
	27	The following parameter can be set with EVP_MAC_CTX_set_params():
	28
	29	=over 4
	30
0c452a51	31	=item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
e592dbde	32
0c452a51	33	=item "iv" (B<OSSL_MAC_PARAM_IV>) <octet string>
e592dbde	34
0c452a51	35	=item "cipher" (B<OSSL_MAC_PARAM_CIPHER>) <UTF8 string>
e592dbde	36
0c452a51	37	=item "properties" (B<OSSL_MAC_PARAM_PROPERTIES>) <UTF8 string>
e592dbde RL	38
	39	=back
	40
	41	The following parameters can be retrieved with
	42	EVP_MAC_CTX_get_params():
	43
	44	=over 4
	45
0c452a51	46	=item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
e592dbde RL	47
	48	=back
	49
	50	The "size" parameter can also be retrieved with EVP_MAC_size().
f49a65d0	51	The length of the "size" parameter is equal to that of an B<unsigned int>.
e592dbde RL	52
	53	=head1 SEE ALSO
	54
	55	L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
fddb1847	56	L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
e592dbde RL	57
	58	=head1 COPYRIGHT
	59
	60	Copyright 2018-2019 The OpenSSL Project Authors. All Rights Reserved.
	61
	62	Licensed under the Apache License 2.0 (the "License"). You may not use
	63	this file except in compliance with the License. You can obtain a copy
	64	in the file LICENSE in the source distribution or at
	65	L<https://www.openssl.org/source/license.html>.
	66
	67	=cut