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

=pod

=head1 NAME

EVP_MAC-BLAKE2, EVP_MAC-BLAKE2BMAC, EVP_MAC-BLAKE2SMAC
- The BLAKE2 EVP_MAC implementations

=head1 DESCRIPTION

Support for computing BLAKE2 MACs through the B<EVP_MAC> API.

=head2 Identity

These implementations are identified with one of these names and
properties, to be used with EVP_MAC_fetch():

=over 4

=item "BLAKE2BMAC", "provider=default"

=item "BLAKE2SMAC", "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_CTX_set_params().
Furthermore, the "size" parameter can be retrieved with
EVP_MAC_CTX_get_params(), or with EVP_MAC_CTX_get_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>

Sets the MAC key.
It may be at most 64 bytes for BLAKE2BMAC or 32 for BLAKE2SMAC and at
least 1 byte in both cases.
Setting this parameter is identical to passing a I<key> to L<EVP_MAC_init(3)>.

=item "custom" (B<OSSL_MAC_PARAM_CUSTOM>) <octet string>

Sets the custom value.
It is an optional value of at most 16 bytes for BLAKE2BMAC or 8 for
BLAKE2SMAC, and is empty by default.

=item "salt" (B<OSSL_MAC_PARAM_SALT>) <octet string>

Sets the salt.
It is an optional value of at most 16 bytes for BLAKE2BMAC or 8 for
BLAKE2SMAC, and is empty by default.

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

Sets the MAC size.
It can be any number between 1 and 32 for EVP_MAC_BLAKE2S or between 1
and 64 for EVP_MAC_BLAKE2B.
It is 32 and 64 respectively by default.

=back

=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 HISTORY

The macros and functions described here were added to OpenSSL 3.0.

=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-BLAKE2, EVP_MAC-BLAKE2BMAC, EVP_MAC-BLAKE2SMAC
	6	- The BLAKE2 EVP_MAC implementations
	7
	8	=head1 DESCRIPTION
	9
	10	Support for computing BLAKE2 MACs through the B<EVP_MAC> API.
	11
	12	=head2 Identity
	13
	14	These implementations are identified with one of these names and
	15	properties, to be used with EVP_MAC_fetch():
	16
	17	=over 4
	18
745fc918	19	=item "BLAKE2BMAC", "provider=default"
e592dbde	20
745fc918	21	=item "BLAKE2SMAC", "provider=default"
e592dbde RL	22
	23	=back
	24
	25	=head2 Supported parameters
	26
	27	The general description of these parameters can be found in
fddb1847	28	L<EVP_MAC(3)/PARAMETERS>.
e592dbde	29
865adf97	30	All these parameters can be set with EVP_MAC_CTX_set_params().
e592dbde	31	Furthermore, the "size" parameter can be retrieved with
90a2576b	32	EVP_MAC_CTX_get_params(), or with EVP_MAC_CTX_get_mac_size().
f49a65d0	33	The length of the "size" parameter should not exceed that of a B<size_t>.
e592dbde RL	34
	35	=over 4
	36
0c452a51	37	=item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
e592dbde	38
8593ff00 RL	39	Sets the MAC key.
	40	It may be at most 64 bytes for BLAKE2BMAC or 32 for BLAKE2SMAC and at
	41	least 1 byte in both cases.
	42	Setting this parameter is identical to passing a I<key> to L<EVP_MAC_init(3)>.
e592dbde	43
0c452a51	44	=item "custom" (B<OSSL_MAC_PARAM_CUSTOM>) <octet string>
e592dbde	45
8593ff00 RL	46	Sets the custom value.
	47	It is an optional value of at most 16 bytes for BLAKE2BMAC or 8 for
	48	BLAKE2SMAC, and is empty by default.
e592dbde	49
0c452a51	50	=item "salt" (B<OSSL_MAC_PARAM_SALT>) <octet string>
e592dbde	51
8593ff00 RL	52	Sets the salt.
	53	It is an optional value of at most 16 bytes for BLAKE2BMAC or 8 for
	54	BLAKE2SMAC, and is empty by default.
e592dbde	55
0c452a51	56	=item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
e592dbde	57
8593ff00 RL	58	Sets the MAC size.
	59	It can be any number between 1 and 32 for EVP_MAC_BLAKE2S or between 1
	60	and 64 for EVP_MAC_BLAKE2B.
e592dbde RL	61	It is 32 and 64 respectively by default.
	62
	63	=back
	64
	65	=head1 SEE ALSO
	66
865adf97	67	L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
fddb1847	68	L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
e592dbde RL	69
	70	=head1 HISTORY
	71
	72	The macros and functions described here were added to OpenSSL 3.0.
	73
	74	=head1 COPYRIGHT
	75
8020d79b	76	Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.
e592dbde RL	77
	78	Licensed under the Apache License 2.0 (the "License"). You may not use
	79	this file except in compliance with the License. You can obtain a copy
	80	in the file LICENSE in the source distribution or at
	81	L<https://www.openssl.org/source/license.html>.
	82
	83	=cut