Fixup internal documentation
[openssl.git] / doc / man7 / EVP_MAC_POLY1305.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_MAC_POLY1305 - The Poly1305 EVP_MAC implementation
6
7 =head1 DESCRIPTION
8
9 Support for computing Poly1305 MACs through the B<EVP_MAC> API.
10
11 =head2 Numeric identity
12
13 B<EVP_MAC_POLY1305> 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_KEY>
24
25 EVP_MAC_ctrl_str() takes two type strings for this control:
26
27 =over 4
28
29 =item "key"
30
31 The value string is used as is.
32
33 =item "hexkey"
34
35 The value string is expected to be a hexadecimal number, which will be
36 decoded before passing on as control value.
37
38 =back
39
40 =back
41
42 =head1 SEE ALSO
43
44 L<EVP_MAC_ctrl(3)>, L<EVP_MAC(3)/CONTROLS>
45
46 =head1 COPYRIGHT
47
48 Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
49
50 Licensed under the Apache License 2.0 (the "License").  You may not use
51 this file except in compliance with the License.  You can obtain a copy
52 in the file LICENSE in the source distribution or at
53 L<https://www.openssl.org/source/license.html>.
54
55 =cut