1*b077aed3SPierre Pronchery=pod 2*b077aed3SPierre Pronchery 3*b077aed3SPierre Pronchery=head1 NAME 4*b077aed3SPierre Pronchery 5*b077aed3SPierre ProncheryEVP_MAC-GMAC - The GMAC EVP_MAC implementation 6*b077aed3SPierre Pronchery 7*b077aed3SPierre Pronchery=head1 DESCRIPTION 8*b077aed3SPierre Pronchery 9*b077aed3SPierre ProncherySupport for computing GMAC MACs through the B<EVP_MAC> API. 10*b077aed3SPierre Pronchery 11*b077aed3SPierre ProncheryThis implementation uses EVP_CIPHER functions to get access to the underlying 12*b077aed3SPierre Proncherycipher. 13*b077aed3SPierre Pronchery 14*b077aed3SPierre Pronchery=head2 Identity 15*b077aed3SPierre Pronchery 16*b077aed3SPierre ProncheryThis implementation is identified with this name and properties, to be 17*b077aed3SPierre Proncheryused with EVP_MAC_fetch(): 18*b077aed3SPierre Pronchery 19*b077aed3SPierre Pronchery=over 4 20*b077aed3SPierre Pronchery 21*b077aed3SPierre Pronchery=item "GMAC", "provider=default" or "provider=fips" 22*b077aed3SPierre Pronchery 23*b077aed3SPierre Pronchery=back 24*b077aed3SPierre Pronchery 25*b077aed3SPierre Pronchery=head2 Supported parameters 26*b077aed3SPierre Pronchery 27*b077aed3SPierre ProncheryThe general description of these parameters can be found in 28*b077aed3SPierre ProncheryL<EVP_MAC(3)/PARAMETERS>. 29*b077aed3SPierre Pronchery 30*b077aed3SPierre ProncheryThe following parameter can be set with EVP_MAC_CTX_set_params(): 31*b077aed3SPierre Pronchery 32*b077aed3SPierre Pronchery=over 4 33*b077aed3SPierre Pronchery 34*b077aed3SPierre Pronchery=item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string> 35*b077aed3SPierre Pronchery 36*b077aed3SPierre ProncherySets the MAC key. 37*b077aed3SPierre ProncherySetting this parameter is identical to passing a I<key> to L<EVP_MAC_init(3)>. 38*b077aed3SPierre Pronchery 39*b077aed3SPierre Pronchery=item "iv" (B<OSSL_MAC_PARAM_IV>) <octet string> 40*b077aed3SPierre Pronchery 41*b077aed3SPierre ProncherySets the IV of the underlying cipher, when applicable. 42*b077aed3SPierre Pronchery 43*b077aed3SPierre Pronchery=item "cipher" (B<OSSL_MAC_PARAM_CIPHER>) <UTF8 string> 44*b077aed3SPierre Pronchery 45*b077aed3SPierre ProncherySets the name of the underlying cipher to be used. 46*b077aed3SPierre Pronchery 47*b077aed3SPierre Pronchery=item "properties" (B<OSSL_MAC_PARAM_PROPERTIES>) <UTF8 string> 48*b077aed3SPierre Pronchery 49*b077aed3SPierre ProncherySets the properties to be queried when trying to fetch the underlying cipher. 50*b077aed3SPierre ProncheryThis must be given together with the cipher naming parameter to be considered 51*b077aed3SPierre Proncheryvalid. 52*b077aed3SPierre Pronchery 53*b077aed3SPierre Pronchery=back 54*b077aed3SPierre Pronchery 55*b077aed3SPierre ProncheryThe following parameters can be retrieved with 56*b077aed3SPierre ProncheryEVP_MAC_CTX_get_params(): 57*b077aed3SPierre Pronchery 58*b077aed3SPierre Pronchery=over 4 59*b077aed3SPierre Pronchery 60*b077aed3SPierre Pronchery=item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer> 61*b077aed3SPierre Pronchery 62*b077aed3SPierre ProncheryGets the MAC size. 63*b077aed3SPierre Pronchery 64*b077aed3SPierre Pronchery=back 65*b077aed3SPierre Pronchery 66*b077aed3SPierre ProncheryThe "size" parameter can also be retrieved with EVP_MAC_CTX_get_mac_size(). 67*b077aed3SPierre ProncheryThe length of the "size" parameter is equal to that of an B<unsigned int>. 68*b077aed3SPierre Pronchery 69*b077aed3SPierre Pronchery=head1 SEE ALSO 70*b077aed3SPierre Pronchery 71*b077aed3SPierre ProncheryL<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>, 72*b077aed3SPierre ProncheryL<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)> 73*b077aed3SPierre Pronchery 74*b077aed3SPierre Pronchery=head1 COPYRIGHT 75*b077aed3SPierre Pronchery 76*b077aed3SPierre ProncheryCopyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved. 77*b077aed3SPierre Pronchery 78*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License"). You may not use 79*b077aed3SPierre Proncherythis file except in compliance with the License. You can obtain a copy 80*b077aed3SPierre Proncheryin the file LICENSE in the source distribution or at 81*b077aed3SPierre ProncheryL<https://www.openssl.org/source/license.html>. 82*b077aed3SPierre Pronchery 83*b077aed3SPierre Pronchery=cut 84