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