Rework the documentation of our individual MAC implementations

[thirdparty/openssl.git] / doc / man7 / EVP_MAC-Siphash.pod

diff --git a/doc/man7/EVP_MAC-Siphash.pod b/doc/man7/EVP_MAC-Siphash.pod
new file mode 100644 (file)
index 0000000..25e0a8f
--- /dev/null
+++ b/doc/man7/EVP_MAC-Siphash.pod
@@ -0,0 +1,54 @@
+=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 Identity
+
+This implementation is identified with this name and properties, to be
+used with EVP_MAC_fetch():
+
+=over 4
+
+=item "Siphash", "default=yes"
+
+=back
+
+
+=head2 Supported parameters
+
+The general description of these parameters can be found in
+L<EVP_MAC(3)/PARAMETER NAMES>.
+
+All these parameters can be set with EVP_MAC_CTX_set_params().
+Furthermore, the "size" parameter can be retrieved with
+EVP_MAC_CTX_get_params(), or with EVP_MAC_size().
+
+=over 4
+
+=item B<OSSL_MAC_PARAM_KEY> ("key") <octet string>
+
+=item B<OSSL_MAC_PARAM_SIZE> ("size") <size_t>
+
+=back
+
+=head1 SEE ALSO
+
+L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
+L<EVP_MAC(3)/PARAMETER NAMES>, L<OSSL_PARAM(3)>
+
+=head1 COPYRIGHT
+
+Copyright 2018-2019 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