summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2018-10-25 00:17:45 +0200
committerRichard Levitte <levitte@openssl.org>2018-10-30 08:09:07 +0100
commitc89d9cdab1727553e3cfa964e9f082cbc5a194c2 (patch)
tree5b26c9223e983f0ef1624d166b77759081af8b71 /doc
parentcf3d6ef7af7d6c47f5ccd4ce58d822972018b21c (diff)
downloadopenssl-new-c89d9cdab1727553e3cfa964e9f082cbc5a194c2.tar.gz
EVP_MAC: Add SipHash implementation
Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from https://github.com/openssl/openssl/pull/7494)
Diffstat (limited to 'doc')
-rw-r--r--doc/man3/EVP_MAC.pod3
-rw-r--r--doc/man7/EVP_MAC_SIPHASH.pod61
2 files changed, 63 insertions, 1 deletions
diff --git a/doc/man3/EVP_MAC.pod b/doc/man3/EVP_MAC.pod
index 02a48660db..a320181174 100644
--- a/doc/man3/EVP_MAC.pod
+++ b/doc/man3/EVP_MAC.pod
@@ -327,7 +327,8 @@ F<./foo>)
=head1 SEE ALSO
L<EVP_MAC_CMAC(7)>,
-L<EVP_MAC_HMAC(7)>
+L<EVP_MAC_HMAC(7)>,
+L<EVP_MAC_SIPHASH(7)>
=head1 COPYRIGHT
diff --git a/doc/man7/EVP_MAC_SIPHASH.pod b/doc/man7/EVP_MAC_SIPHASH.pod
new file mode 100644
index 0000000000..841cd7d6a8
--- /dev/null
+++ b/doc/man7/EVP_MAC_SIPHASH.pod
@@ -0,0 +1,61 @@
+=pod
+
+=head1 NAME
+
+EVP_MAC_SIPHASH - The SipHash EVP_MAC implementation
+
+=head1 DESCRIPTION
+
+Support for computing SipHash MACs through the B<EVP_MAC> API.
+
+=head2 Numeric identity
+
+B<EVP_MAC_SIPHASH> 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_SIZE>
+
+EVP_MAC_ctrl_str() type string: "digestsize"
+
+The value string is expected to contain a decimal number.
+
+=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
+
+=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