0d1349fd47d741914b8379349b1ae70006ac8a34
[openssl.git] / doc / man7 / EVP_MAC_SIPHASH.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_MAC_SIPHASH - The SipHash EVP_MAC implementation
6
7 =head1 DESCRIPTION
8
9 Support for computing SipHash MACs through the B<EVP_MAC> API.
10
11 =head2 Numeric identity
12
13 B<EVP_MAC_SIPHASH> is the numeric identity for this implementation,
14 and can be used in functions like EVP_MAC_CTX_new_id() and
15 EVP_get_macbynid().
16
17 =head2 Supported controls
18
19 The supported controls are:
20
21 =over 4
22
23 =item B<EVP_MAC_CTRL_SET_SIZE>
24
25 EVP_MAC_ctrl_str() type string: "digestsize"
26
27 The value string is expected to contain a decimal number.
28
29 =item B<EVP_MAC_CTRL_SET_KEY>
30
31 EVP_MAC_ctrl_str() takes two type strings for this control:
32
33 =over 4
34
35 =item "key"
36
37 The value string is used as is.
38
39 =item "hexkey"
40
41 The value string is expected to be a hexadecimal number, which will be
42 decoded before passing on as control value.
43
44 =back
45
46 =back
47
48 =head1 SEE ALSO
49
50 L<EVP_MAC_ctrl(3)>, L<EVP_MAC(3)/CONTROLS>
51
52 =head1 COPYRIGHT
53
54 Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
55
56 Licensed under the OpenSSL license (the "License").  You may not use
57 this file except in compliance with the License.  You can obtain a copy
58 in the file LICENSE in the source distribution or at
59 L<https://www.openssl.org/source/license.html>.
60
61 =cut