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