diff options
author | Matt Caswell <matt@openssl.org> | 2020-08-17 17:25:37 +0100 |
---|---|---|
committer | Pauli <paul.dale@oracle.com> | 2020-08-29 17:40:11 +1000 |
commit | 52ae0f8fc23570b6b7cc98d1cb0d6f6dd53ea98a (patch) | |
tree | 6e030d4aeb3c10ee0f0f7cc195e81a00d338c06e /doc/man7/EVP_PKEY-HMAC.pod | |
parent | 2ef9a7ac5eb93c3f5460695c526968faf025b730 (diff) |
Add some documentation about the EVP_PKEY MAC interface
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/12637)
Diffstat (limited to 'doc/man7/EVP_PKEY-HMAC.pod')
-rw-r--r-- | doc/man7/EVP_PKEY-HMAC.pod | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/doc/man7/EVP_PKEY-HMAC.pod b/doc/man7/EVP_PKEY-HMAC.pod new file mode 100644 index 0000000000..7b6c52bb03 --- /dev/null +++ b/doc/man7/EVP_PKEY-HMAC.pod @@ -0,0 +1,95 @@ +=pod + +=head1 NAME + +EVP_PKEY-HMAC, EVP_KEYMGMT-HMAC, EVP_PKEY-SIPHASH, EVP_KEYMGMT-SIPHASH, +EVP_PKEY-POLY1305, EVP_KEYMGMT-POLY1305, EVP_PKEY-CMAC, EVP_KEYMGMT-CMAC +- EVP_PKEY legacy MAC keytypes and algorithm support + +=head1 DESCRIPTION + +The B<HMAC> and B<CMAC> key types are implemented in OpenSSL's default and FIPS +providers. Additionally the B<SIPHASH> and B<POLY1305> key types are implemented +in the default provider. Performing MAC operations via an EVP_PKEY +is considered legacy and are only available for backwards compatibility purposes +and for a restricted set of algorithms. The preferred way of performing MAC +operations is via the EVP_MAC APIs. See L<EVP_MAC_init(3)>. + +For further details on using EVP_PKEY based MAC keys see +L<EVP_SIGNATURE-HMAC(7)>, L<EVP_SIGNATURE-SIPHASH(7)>, +L<EVP_SIGNATURE-POLY1305(7)> or L<EVP_SIGNATURE-CMAC(7)>. + +=head2 Common MAC parameters + +All the B<MAC> keytypes support the following parameters. + +=over 4 + +=item "priv" (B<OSSL_PKEY_PARAM_PRIV_KEY>) <octet string> + +The MAC key value. + +=item "properties" (B<OSSL_PKEY_PARAM_PROPERTIES>) <UTF8 string> + +A property query string to be used when any algorithms are fetched. + +=back + +=head2 CMAC parameters + +As well as the parameters described above, the B<CMAC> keytype additionally +supports the following parameters. + +=over 4 + +=item "cipher" (B<OSSL_PKEY_PARAM_CIPHER>) <UTF8 string> + +The name of a cipher to be used when generating the MAC. + +=item "engine" (B<OSSL_PKEY_PARAM_ENGINE>) <UTF8 string> + +The name of an engine to be used for the specified cipher (if any). + +=back + +=head2 Common MAC key generation parameters + +MAC key generation is unusual in that no new key is actually generated. Instead +a new provider side key object is created with the supplied raw key value. This +is done for backwards compatibility with previous versions of OpenSSL. + +=over 4 + +=item "priv" (B<OSSL_PKEY_PARAM_PRIV_KEY>) <octet string> + +The MAC key value. + +=back + +=head2 CMAC key generation parameters + +In addition to the common MAC key generation parameters, the CMAC key generation +additionally recognises the following. + +=over 4 + +=item "cipher" (B<OSSL_PKEY_PARAM_CIPHER>) <UTF8 string> + +The name of a cipher to be used when generating the MAC. + +=back + +=head1 SEE ALSO + +L<EVP_KEYMGMT(3)>, L<EVP_PKEY(3)>, L<provider-keymgmt(7)> + +=head1 COPYRIGHT + +Copyright 2020 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (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 |