projects / thirdparty / openssl.git / blame
| Commit | Line | Data |
|---|---|---|
| e592dbde RL |
1 | =pod |
| 2 | ||
| 3 | =head1 NAME | |
| 4 | ||
| 5 | EVP_MAC-HMAC - The HMAC EVP_MAC implementation | |
| 6 | ||
| 7 | =head1 DESCRIPTION | |
| 8 | ||
| 9 | Support for computing HMAC 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 | ||
| 18 | =item "HMAC", "default=yes" | |
| 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 | ||
| 31 | =item B<OSSL_MAC_PARAM_KEY> ("key") <octet string> | |
| 32 | ||
| 33 | =item B<OSSL_MAC_PARAM_FLAGS> ("flags") <octet string> | |
| 34 | ||
| e592dbde RL |
35 | =item B<OSSL_MAC_PARAM_DIGEST> ("digest") <utf8 string> |
| 36 | ||
| 37 | =item B<OSSL_MAC_PARAM_PROPERTIES> ("properties") <utf8 string> | |
| 38 | ||
| 39 | =back | |
| 40 | ||
| 41 | The "flags" parameter is passed directly to HMAC_CTX_set_flags(). | |
| 42 | ||
| 43 | The following parameters can be retrieved with | |
| 44 | EVP_MAC_CTX_get_params(): | |
| 45 | ||
| 46 | =over 4 | |
| 47 | ||
| 48 | =item B<OSSL_MAC_PARAM_SIZE> ("size") <unsigned int> | |
| 49 | ||
| 50 | =back | |
| 51 | ||
| 52 | The "size" parameter can also be retrieved with EVP_MAC_size(). | |
| 53 | ||
| 54 | =head1 SEE ALSO | |
| 55 | ||
| 56 | L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>, | |
| fddb1847 | 57 | L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>, L<HMAC(3)> |
| e592dbde RL |
58 | |
| 59 | =head1 COPYRIGHT | |
| 60 | ||
| 61 | Copyright 2018-2019 The OpenSSL Project Authors. All Rights Reserved. | |
| 62 | ||
| 63 | Licensed under the Apache License 2.0 (the "License"). You may not use | |
| 64 | this file except in compliance with the License. You can obtain a copy | |
| 65 | in the file LICENSE in the source distribution or at | |
| 66 | L<https://www.openssl.org/source/license.html>. | |
| 67 | ||
| 68 | =cut |