The EVP_MAC functions have been renamed for consistency. The EVP_MAC_CTX_*
[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 Identity
12
13 This implementation is identified with this name and properties, to be
14 used with EVP_MAC_fetch():
15
16 =over 4
17
18 =item "POLY1305", "provider=default"
19
20 =back
21
22 =head2 Supported parameters
23
24 The general description of these parameters can be found in
25 L<EVP_MAC(3)/PARAMETERS>.
26
27 The following parameter can be set with EVP_MAC_set_ctx_params():
28
29 =over 4
30
31 =item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
32
33 =back
34
35 The following parameters can be retrieved with
36 EVP_MAC_get_ctx_params():
37
38 =over 4
39
40 =item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
41
42 =back
43
44 The "size" parameter can also be retrieved with with EVP_MAC_size().
45 The length of the "size" parameter should not exceed that of an B<unsigned int>.
46
47 =head1 SEE ALSO
48
49 L<EVP_MAC_get_ctx_params(3)>, L<EVP_MAC_set_ctx_params(3)>,
50 L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
51
52 =head1 COPYRIGHT
53
54 Copyright 2018-2020 The OpenSSL Project Authors. All Rights Reserved.
55
56 Licensed under the Apache License 2.0 (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