summaryrefslogtreecommitdiffstats
path: root/doc/man7
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2018-10-24 21:20:00 +0200
committerRichard Levitte <levitte@openssl.org>2018-10-30 05:49:54 +0100
commit6723f86746ab7e8ff9a914603db4f85c53eafc7c (patch)
tree55d8bd25665c11ea596d0fa7d4dd913ecc8f330b /doc/man7
parent56adb7d93721a72bfae532845cbebc4a565ceb65 (diff)
EVP_MAC: Add HMAC implementation
Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from https://github.com/openssl/openssl/pull/7483)
Diffstat (limited to 'doc/man7')
-rw-r--r--doc/man7/EVP_MAC_HMAC.pod71
1 files changed, 71 insertions, 0 deletions
diff --git a/doc/man7/EVP_MAC_HMAC.pod b/doc/man7/EVP_MAC_HMAC.pod
new file mode 100644
index 0000000000..8276ff3f5b
--- /dev/null
+++ b/doc/man7/EVP_MAC_HMAC.pod
@@ -0,0 +1,71 @@
+=pod
+
+=head1 NAME
+
+EVP_MAC_HMAC - The HMAC EVP_MAC implementation
+
+=head1 DESCRIPTION
+
+Support for computing HMAC MACs through the B<EVP_MAC> API.
+
+=head2 Numeric identity
+
+B<EVP_MAC_HMAC> 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 to type string 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_FLAGS>
+
+Sets HMAC flags. This is passed directly to HMAC_CTX_set_flags().
+
+There are no corresponding string control types.
+
+=item B<EVP_MAC_CTRL_SET_ENGINE>
+
+=item B<EVP_MAC_CTRL_SET_MD>
+
+These work as described in L<EVP_MAC(3)/CONTROLS>.
+
+EVP_MAC_ctrl_str() type string for B<EVP_MAC_CTRL_SET_DIGEST>: "digest"
+
+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