]> git.ipfire.org Git - thirdparty/openssl.git/blobdiff - doc/man7/EVP_MAC-GMAC.pod
DOCS: Fix provider-mac.pod and the docs of our implementations
[thirdparty/openssl.git] / doc / man7 / EVP_MAC-GMAC.pod
index d662e7d5d2f6f257f7f4950fa74c36b27349c76c..a392cf3dfec5f11c3823f33467d17f47e4596b97 100644 (file)
@@ -8,6 +8,9 @@ EVP_MAC-GMAC - The GMAC EVP_MAC implementation
 
 Support for computing GMAC MACs through the B<EVP_MAC> API.
 
+This implementation uses EVP_CIPHER functions to get access to the underlying
+cipher.
+
 =head2 Identity
 
 This implementation is identified with this name and properties, to be
@@ -30,12 +33,23 @@ The following parameter can be set with EVP_MAC_CTX_set_params():
 
 =item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
 
+Sets the MAC key.
+Setting this parameter is identical to passing a I<key> to L<EVP_MAC_init(3)>.
+
 =item "iv" (B<OSSL_MAC_PARAM_IV>) <octet string>
 
+Sets the IV of the underlying cipher, when applicable.
+
 =item "cipher" (B<OSSL_MAC_PARAM_CIPHER>) <UTF8 string>
 
+Sets the name of the underlying cipher to be used.
+
 =item "properties" (B<OSSL_MAC_PARAM_PROPERTIES>) <UTF8 string>
 
+Sets the properties to be queried when trying to fetch the underlying cipher.
+This must be given together with the cipher naming parameter to be considered
+valid.
+
 =back
 
 The following parameters can be retrieved with
@@ -45,6 +59,8 @@ EVP_MAC_CTX_get_params():
 
 =item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
 
+Gets the MAC size.
+
 =back
 
 The "size" parameter can also be retrieved with EVP_MAC_CTX_get_mac_size().