xref: /freebsd/crypto/openssl/doc/man7/EVP_MD-common.pod (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1*b077aed3SPierre Pronchery=pod
2*b077aed3SPierre Pronchery
3*b077aed3SPierre Pronchery=head1 NAME
4*b077aed3SPierre Pronchery
5*b077aed3SPierre ProncheryEVP_MD-common - The OpenSSL EVP_MD implementations, common things
6*b077aed3SPierre Pronchery
7*b077aed3SPierre Pronchery=head1 DESCRIPTION
8*b077aed3SPierre Pronchery
9*b077aed3SPierre ProncheryAll the OpenSSL EVP_MD implementations understand the following
10*b077aed3SPierre ProncheryL<OSSL_PARAM(3)> entries that are
11*b077aed3SPierre Proncherygettable with L<EVP_MD_get_params(3)>, as well as these:
12*b077aed3SPierre Pronchery
13*b077aed3SPierre Pronchery=over 4
14*b077aed3SPierre Pronchery
15*b077aed3SPierre Pronchery=item "blocksize" (B<OSSL_DIGEST_PARAM_BLOCK_SIZE>) <unsigned integer>
16*b077aed3SPierre Pronchery
17*b077aed3SPierre ProncheryThe digest block size.
18*b077aed3SPierre ProncheryThe length of the "blocksize" parameter should not exceed that of a
19*b077aed3SPierre ProncheryB<size_t>.
20*b077aed3SPierre Pronchery
21*b077aed3SPierre ProncheryThis value can also be retrieved with L<EVP_MD_get_block_size(3)>.
22*b077aed3SPierre Pronchery
23*b077aed3SPierre Pronchery=item "size" (B<OSSL_DIGEST_PARAM_SIZE>) <unsigned integer>
24*b077aed3SPierre Pronchery
25*b077aed3SPierre ProncheryThe digest output size.
26*b077aed3SPierre ProncheryThe length of the "size" parameter should not exceed that of a B<size_t>.
27*b077aed3SPierre Pronchery
28*b077aed3SPierre ProncheryThis value can also be retrieved with L<EVP_MD_get_size(3)>.
29*b077aed3SPierre Pronchery
30*b077aed3SPierre Pronchery=item "flags" (B<OSSL_DIGEST_PARAM_FLAGS>) <unsigned integer>
31*b077aed3SPierre Pronchery
32*b077aed3SPierre ProncheryDiverse flags that describe exceptional behaviour for the digest.
33*b077aed3SPierre ProncheryThese flags are described in L<EVP_MD_meth_set_flags(3)/DESCRIPTION>.
34*b077aed3SPierre Pronchery
35*b077aed3SPierre ProncheryThe length of the "flags" parameter should equal that of an
36*b077aed3SPierre ProncheryB<unsigned long int>.
37*b077aed3SPierre Pronchery
38*b077aed3SPierre Pronchery=begin comment
39*b077aed3SPierre Pronchery
40*b077aed3SPierre ProncheryThe description of these flags should probably be moved.  Also,
41*b077aed3SPierre ProncheryEVP_MD_FLAG_FIPS isn't relevant any more.
42*b077aed3SPierre Pronchery
43*b077aed3SPierre Pronchery=end comment
44*b077aed3SPierre Pronchery
45*b077aed3SPierre ProncheryThis value can also be retrieved with L<EVP_MD_get_flags(3)>.
46*b077aed3SPierre Pronchery
47*b077aed3SPierre Pronchery=back
48*b077aed3SPierre Pronchery
49*b077aed3SPierre Pronchery=head1 SEE ALSO
50*b077aed3SPierre Pronchery
51*b077aed3SPierre ProncheryL<EVP_MD_get_params(3)>, L<provider-digest(7)>
52*b077aed3SPierre Pronchery
53*b077aed3SPierre Pronchery=head1 COPYRIGHT
54*b077aed3SPierre Pronchery
55*b077aed3SPierre ProncheryCopyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
56*b077aed3SPierre Pronchery
57*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
58*b077aed3SPierre Proncherythis file except in compliance with the License.  You can obtain a copy
59*b077aed3SPierre Proncheryin the file LICENSE in the source distribution or at
60*b077aed3SPierre ProncheryL<https://www.openssl.org/source/license.html>.
61*b077aed3SPierre Pronchery
62*b077aed3SPierre Pronchery=cut
63