mirror of
https://github.com/openssl/openssl.git
synced 2024-12-27 06:21:43 +08:00
1e55cbc874
The provider- manuals are meant to describe the general interface for their respective operation. This is not the place to describe implementation specific details. This change creates a number of doc/man7/EVP_MD manuals, one for each algorithm or set of algorithms, as well as doc/man7/EVP_MD-common.pod to describe what's common to them all. While we're at it, correct the SHA3 settable context params array to match what's actually settable. Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/11270)
68 lines
1.6 KiB
Plaintext
68 lines
1.6 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
EVP_MD-common - The OpenSSL EVP_MD implementations, common things
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
All the OpenSSL EVP_MD implementations understand the following
|
|
L<OSSL_PARAM(3)> entries:
|
|
|
|
=over 4
|
|
|
|
Gettable with L<EVP_MD_get_params(3)>:
|
|
|
|
=over 4
|
|
|
|
=item "blocksize" (B<OSSL_DIGEST_PARAM_BLOCK_SIZE>) <unsigned integer>
|
|
|
|
The digest block size.
|
|
The length of the "blocksize" parameter should not exceed that of a
|
|
B<size_t>.
|
|
|
|
This value can also be retrieved with L<EVP_MD_block_size(3)>.
|
|
|
|
=item "size" (B<OSSL_DIGEST_PARAM_SIZE>) <unsigned integer>
|
|
|
|
The digest output size.
|
|
The length of the "size" parameter should not exceed that of a B<size_t>.
|
|
|
|
This value can also be retrieved with L<EVP_MD_size(3)>.
|
|
|
|
=item "flags" (B<OSSL_DIGEST_PARAM_FLAGS>) <unsigned integer>
|
|
|
|
Diverse flags that describe exceptional behaviour for the digest.
|
|
These flags are described in L<EVP_MD_meth_set_flags(3)/DESCRIPTION>.
|
|
|
|
The length of the "flags" parameter should equal that of an
|
|
B<unsigned long int>.
|
|
|
|
=begin comment
|
|
|
|
The description of these flags should probably be moved. Also,
|
|
EVP_MD_FLAG_FIPS isn't relevant any more.
|
|
|
|
=end comment
|
|
|
|
This value can also be retrieved with L<EVP_MD_flags(3)>.
|
|
|
|
=back
|
|
|
|
=back
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<EVP_MD_get_params(3)>, L<provider-digest(7)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 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
|