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 that are
  11 gettable 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
  17 The digest block size.
  18 The length of the "blocksize" parameter should not exceed that of a
  19 B<size_t>.
  20
  21 This value can also be retrieved with L<EVP_MD_block_size(3)>.
  22
  23 =item "size" (B<OSSL_DIGEST_PARAM_SIZE>) <unsigned integer>
  24
  25 The digest output size.
  26 The length of the "size" parameter should not exceed that of a B<size_t>.
  27
  28 This value can also be retrieved with L<EVP_MD_size(3)>.
  29
  30 =item "flags" (B<OSSL_DIGEST_PARAM_FLAGS>) <unsigned integer>
  31
  32 Diverse flags that describe exceptional behaviour for the digest.
  33 These flags are described in L<EVP_MD_meth_set_flags(3)/DESCRIPTION>.
  34
  35 The length of the "flags" parameter should equal that of an
  36 B<unsigned long int>.
  37
  38 =begin comment
  39
  40 The description of these flags should probably be moved.  Also,
  41 EVP_MD_FLAG_FIPS isn't relevant any more.
  42
  43 =end comment
  44
  45 This value can also be retrieved with L<EVP_MD_flags(3)>.
  46
  47 =back
  48
  49 =head1 SEE ALSO
  50
  51 L<EVP_MD_get_params(3)>, L<provider-digest(7)>
  52
  53 =head1 COPYRIGHT
  54
  55 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
  56
  57 Licensed under the Apache License 2.0 (the "License").  You may not use
  58 this file except in compliance with the License.  You can obtain a copy
  59 in the file LICENSE in the source distribution or at
  60 L<https://www.openssl.org/source/license.html>.
  61
  62 =cut