openssl/doc/man3/EVP_blake2b512.pod
slontis e798248c84 Add provider pre-fetching documentation
Clearly document that implicit fetching is slower when using providers,
and explain prefetching. Added to crypto.pod and migration_guide.pod
links to it.

Add a link to EVP_default_properties_enable_fips() in crypto.pod.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/20354)
2023-02-28 14:29:42 +11:00

71 lines
1.6 KiB
Plaintext

=pod
=head1 NAME
EVP_blake2b512,
EVP_blake2s256
- BLAKE2 For EVP
=head1 SYNOPSIS
#include <openssl/evp.h>
const EVP_MD *EVP_blake2b512(void);
const EVP_MD *EVP_blake2s256(void);
=head1 DESCRIPTION
BLAKE2 is an improved version of BLAKE, which was submitted to the NIST SHA-3
algorithm competition. The BLAKE2s and BLAKE2b algorithms are described in
RFC 7693.
=over 4
=item EVP_blake2s256()
The BLAKE2s algorithm that produces a 256-bit output from a given input.
=item EVP_blake2b512()
The BLAKE2b algorithm that produces a 512-bit output from a given input.
=back
=head1 NOTES
Developers should be aware of the negative performance implications of
calling these functions multiple times and should consider using
L<EVP_MD_fetch(3)> instead.
See L<crypto(7)/Performance> for further information.
While the BLAKE2b and BLAKE2s algorithms supports a variable length digest,
this implementation outputs a digest of a fixed length (the maximum length
supported), which is 512-bits for BLAKE2b and 256-bits for BLAKE2s.
=head1 RETURN VALUES
These functions return a B<EVP_MD> structure that contains the
implementation of the message digest. See L<EVP_MD_meth_new(3)> for
details of the B<EVP_MD> structure.
=head1 CONFORMING TO
RFC 7693.
=head1 SEE ALSO
L<evp(7)>,
L<EVP_DigestInit(3)>
=head1 COPYRIGHT
Copyright 2017-2022 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