projects / thirdparty / openssl.git / blame
| Commit | Line | Data |
|---|---|---|
| afc580b9 P |
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 Numeric identity | |
| 12 | ||
| 13 | B<EVP_MAC_GMAC> is the numeric identity for this implementation, and | |
| 14 | can be used in functions like EVP_MAC_CTX_new_id() and | |
| 15 | EVP_get_macbynid(). | |
| 16 | ||
| 17 | =head2 Supported controls | |
| 18 | ||
| 19 | The supported controls are: | |
| 20 | ||
| 21 | =over 4 | |
| 22 | ||
| 23 | =item B<EVP_MAC_CTRL_SET_KEY> | |
| 24 | ||
| 25 | EVP_MAC_ctrl_str() takes two type strings for this control: | |
| 26 | ||
| 27 | =over 4 | |
| 28 | ||
| 29 | =item "key" | |
| 30 | ||
| 31 | The value string is used as is. | |
| 32 | ||
| 33 | =item "hexkey" | |
| 34 | ||
| 35 | The value string is expected to be a hexadecimal number, which will be | |
| 36 | decoded before passing on as control value. | |
| 37 | ||
| 38 | =back | |
| 39 | ||
| 40 | =item B<EVP_MAC_CTRL_SET_IV> | |
| 41 | ||
| 42 | EVP_MAC_ctrl_str() takes two type strings for this control: | |
| 43 | ||
| 44 | =over 4 | |
| 45 | ||
| 46 | =item "iv" | |
| 47 | ||
| 48 | The value string is used as is. | |
| 49 | ||
| 50 | =item "hexiv" | |
| 51 | ||
| 52 | The value string is expected to be a hexadecimal number, which will be | |
| 53 | decoded before passing on as control value. | |
| 54 | ||
| 55 | =back | |
| 56 | ||
| 57 | =item B<EVP_MAC_CTRL_SET_ENGINE> | |
| 58 | ||
| 59 | =item B<EVP_MAC_CTRL_SET_CIPHER> | |
| 60 | ||
| 61 | These work as described in L<EVP_MAC(3)/CONTROLS> with the restriction that the | |
| 62 | cipher must be an AEAD one. | |
| 63 | ||
| 64 | EVP_MAC_ctrl_str() type string for B<EVP_MAC_CTRL_SET_CIPHER>: "cipher" | |
| 65 | ||
| 66 | The value is expected to be the name of a cipher. | |
| 67 | ||
| 68 | =back | |
| 69 | ||
| 70 | =head1 SEE ALSO | |
| 71 | ||
| 72 | L<EVP_MAC_ctrl(3)>, L<EVP_MAC(3)/CONTROLS> | |
| 73 | ||
| 74 | =head1 COPYRIGHT | |
| 75 | ||
| 76 | Copyright 2018 The OpenSSL Project Authors. All Rights Reserved. | |
| 77 | ||
| 3187791e | 78 | Licensed under the Apache License 2.0 (the "License"). You may not use |
| afc580b9 P |
79 | this file except in compliance with the License. You can obtain a copy |
| 80 | in the file LICENSE in the source distribution or at | |
| 81 | L<https://www.openssl.org/source/license.html>. | |
| 82 | ||
| 83 | =cut |