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

=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", "provider=default"

=back


=head2 Supported parameters

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

All these parameters can be set with EVP_MAC_set_ctx_params().
Furthermore, the "size" parameter can be retrieved with
EVP_MAC_get_ctx_params(), or with EVP_MAC_size().
The length of the "size" parameter should not exceed that of a B<size_t>.

=over 4

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

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

=back

=head1 SEE ALSO

L<EVP_MAC_get_ctx_params(3)>, L<EVP_MAC_set_ctx_params(3)>,
L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>

=head1 COPYRIGHT

Copyright 2018-2020 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-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 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 "SIPHASH", "provider=default"
e592dbde RL	19
	20	=back
	21
	22
	23	=head2 Supported parameters
	24
	25	The general description of these parameters can be found in
fddb1847	26	L<EVP_MAC(3)/PARAMETERS>.
e592dbde	27
d9c2fd51	28	All these parameters can be set with EVP_MAC_set_ctx_params().
e592dbde	29	Furthermore, the "size" parameter can be retrieved with
d9c2fd51	30	EVP_MAC_get_ctx_params(), or with EVP_MAC_size().
f49a65d0	31	The length of the "size" parameter should not exceed that of a B<size_t>.
e592dbde RL	32
	33	=over 4
	34
0c452a51	35	=item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
e592dbde	36
0c452a51	37	=item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
e592dbde RL	38
	39	=back
	40
	41	=head1 SEE ALSO
	42
d9c2fd51	43	L<EVP_MAC_get_ctx_params(3)>, L<EVP_MAC_set_ctx_params(3)>,
fddb1847	44	L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
e592dbde RL	45
	46	=head1 COPYRIGHT
	47
33388b44	48	Copyright 2018-2020 The OpenSSL Project Authors. All Rights Reserved.
e592dbde RL	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