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

=pod

=head1 NAME

EVP_MAC-Poly1305 - The Poly1305 EVP_MAC implementation

=head1 DESCRIPTION

Support for computing Poly1305 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 "POLY1305", "provider=default"

=back

=head2 Supported parameters

The general description of these parameters can be found in
L<EVP_MAC(3)/PARAMETERS>.

The following parameter can be set with EVP_MAC_CTX_set_params():

=over 4

=item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>

Sets the MAC key.
Setting this parameter is identical to passing a I<key> to L<EVP_MAC_init(3)>.

=back

The following parameters can be retrieved with
EVP_MAC_CTX_get_params():

=over 4

=item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>

Gets the MAC size.

=back

The "size" parameter can also be retrieved with with EVP_MAC_CTX_get_mac_size().
The length of the "size" parameter should not exceed that of an B<unsigned int>.

=head1 SEE ALSO

L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>

=head1 COPYRIGHT

Copyright 2018-2021 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
Commit	Line	Data
e592dbde RL	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
745fc918	18	=item "POLY1305", "provider=default"
e592dbde RL	19
	20	=back
	21
	22	=head2 Supported parameters
	23
	24	The general description of these parameters can be found in
fddb1847	25	L<EVP_MAC(3)/PARAMETERS>.
e592dbde	26
865adf97	27	The following parameter can be set with EVP_MAC_CTX_set_params():
e592dbde RL	28
	29	=over 4
	30
0c452a51	31	=item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
e592dbde	32
8593ff00 RL	33	Sets the MAC key.
	34	Setting this parameter is identical to passing a I<key> to L<EVP_MAC_init(3)>.
	35
e592dbde RL	36	=back
	37
	38	The following parameters can be retrieved with
865adf97	39	EVP_MAC_CTX_get_params():
e592dbde RL	40
	41	=over 4
	42
0c452a51	43	=item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
e592dbde	44
8593ff00 RL	45	Gets the MAC size.
8593ff00 RL	46
e592dbde RL	47	=back
e592dbde RL	48
90a2576b	49	The "size" parameter can also be retrieved with with EVP_MAC_CTX_get_mac_size().
f49a65d0	50	The length of the "size" parameter should not exceed that of an B<unsigned int>.
e592dbde RL	51
	52	=head1 SEE ALSO
	53
865adf97	54	L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
fddb1847	55	L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
e592dbde RL	56
	57	=head1 COPYRIGHT
	58
8020d79b	59	Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.
e592dbde RL	60
	61	Licensed under the Apache License 2.0 (the "License"). You may not use
	62	this file except in compliance with the License. You can obtain a copy
	63	in the file LICENSE in the source distribution or at
	64	L<https://www.openssl.org/source/license.html>.
	65
	66	=cut