diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/EVP_MAC.pod | 7 | ||||
-rw-r--r-- | doc/man7/EVP_MAC_GMAC.pod | 83 |
2 files changed, 90 insertions, 0 deletions
diff --git a/doc/man3/EVP_MAC.pod b/doc/man3/EVP_MAC.pod index a320181174..473d6c9e6b 100644 --- a/doc/man3/EVP_MAC.pod +++ b/doc/man3/EVP_MAC.pod @@ -163,6 +163,12 @@ For MACs that use an underlying computation algorithm, the algorithm I<must> be set first, see B<EVP_MAC_CTRL_SET_ENGINE>, B<EVP_MAC_CTRL_SET_MD> and B<EVP_MAC_CTRL_SET_CIPHER> below. +=item B<EVP_MAC_CTRL_SET_IV> + +This control expects two arguments: C<unsigned char *key>, C<size_t keylen> + +Some MAC implementations require an IV, this control sets the IV. + =item B<EVP_MAC_CTRL_SET_FLAGS> This control expects one arguments: C<unsigned long flags> @@ -327,6 +333,7 @@ F<./foo>) =head1 SEE ALSO L<EVP_MAC_CMAC(7)>, +L<EVP_MAC_GMAC(7)>, L<EVP_MAC_HMAC(7)>, L<EVP_MAC_SIPHASH(7)> diff --git a/doc/man7/EVP_MAC_GMAC.pod b/doc/man7/EVP_MAC_GMAC.pod new file mode 100644 index 0000000000..c35d781475 --- /dev/null +++ b/doc/man7/EVP_MAC_GMAC.pod @@ -0,0 +1,83 @@ +=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 Numeric identity + +B<EVP_MAC_GMAC> is the numeric identity for this implementation, and +can be used in functions like EVP_MAC_CTX_new_id() and +EVP_get_macbynid(). + +=head2 Supported controls + +The supported controls are: + +=over 4 + +=item B<EVP_MAC_CTRL_SET_KEY> + +EVP_MAC_ctrl_str() takes two type strings for this control: + +=over 4 + +=item "key" + +The value string is used as is. + +=item "hexkey" + +The value string is expected to be a hexadecimal number, which will be +decoded before passing on as control value. + +=back + +=item B<EVP_MAC_CTRL_SET_IV> + +EVP_MAC_ctrl_str() takes two type strings for this control: + +=over 4 + +=item "iv" + +The value string is used as is. + +=item "hexiv" + +The value string is expected to be a hexadecimal number, which will be +decoded before passing on as control value. + +=back + +=item B<EVP_MAC_CTRL_SET_ENGINE> + +=item B<EVP_MAC_CTRL_SET_CIPHER> + +These work as described in L<EVP_MAC(3)/CONTROLS> with the restriction that the +cipher must be an AEAD one. + +EVP_MAC_ctrl_str() type string for B<EVP_MAC_CTRL_SET_CIPHER>: "cipher" + +The value is expected to be the name of a cipher. + +=back + +=head1 SEE ALSO + +L<EVP_MAC_ctrl(3)>, L<EVP_MAC(3)/CONTROLS> + +=head1 COPYRIGHT + +Copyright 2018 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the OpenSSL license (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 |