EVP_MD-common.7ossl 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  1. .\" -*- mode: troff; coding: utf-8 -*-
  2. .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
  3. .\"
  4. .\" Standard preamble:
  5. .\" ========================================================================
  6. .de Sp \" Vertical space (when we can't use .PP)
  7. .if t .sp .5v
  8. .if n .sp
  9. ..
  10. .de Vb \" Begin verbatim text
  11. .ft CW
  12. .nf
  13. .ne \\$1
  14. ..
  15. .de Ve \" End verbatim text
  16. .ft R
  17. .fi
  18. ..
  19. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
  20. .ie n \{\
  21. . ds C` ""
  22. . ds C' ""
  23. 'br\}
  24. .el\{\
  25. . ds C`
  26. . ds C'
  27. 'br\}
  28. .\"
  29. .\" Escape single quotes in literal strings from groff's Unicode transform.
  30. .ie \n(.g .ds Aq \(aq
  31. .el .ds Aq '
  32. .\"
  33. .\" If the F register is >0, we'll generate index entries on stderr for
  34. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  35. .\" entries marked with X<> in POD. Of course, you'll have to process the
  36. .\" output yourself in some meaningful fashion.
  37. .\"
  38. .\" Avoid warning from groff about undefined register 'F'.
  39. .de IX
  40. ..
  41. .nr rF 0
  42. .if \n(.g .if rF .nr rF 1
  43. .if (\n(rF:(\n(.g==0)) \{\
  44. . if \nF \{\
  45. . de IX
  46. . tm Index:\\$1\t\\n%\t"\\$2"
  47. ..
  48. . if !\nF==2 \{\
  49. . nr % 0
  50. . nr F 2
  51. . \}
  52. . \}
  53. .\}
  54. .rr rF
  55. .\" ========================================================================
  56. .\"
  57. .IX Title "EVP_MD-COMMON 7ossl"
  58. .TH EVP_MD-COMMON 7ossl 2025-01-17 3.4.0 OpenSSL
  59. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  60. .\" way too many mistakes in technical documents.
  61. .if n .ad l
  62. .nh
  63. .SH NAME
  64. EVP_MD\-common \- The OpenSSL EVP_MD implementations, common things
  65. .SH DESCRIPTION
  66. .IX Header "DESCRIPTION"
  67. All the OpenSSL EVP_MD implementations understand the following
  68. \&\fBOSSL_PARAM\fR\|(3) entries that are
  69. gettable with \fBEVP_MD_get_params\fR\|(3), as well as these:
  70. .IP """blocksize"" (\fBOSSL_DIGEST_PARAM_BLOCK_SIZE\fR) <unsigned integer>" 4
  71. .IX Item """blocksize"" (OSSL_DIGEST_PARAM_BLOCK_SIZE) <unsigned integer>"
  72. The digest block size.
  73. The length of the "blocksize" parameter should not exceed that of a
  74. \&\fBsize_t\fR.
  75. .Sp
  76. This value can also be retrieved with \fBEVP_MD_get_block_size\fR\|(3).
  77. .IP """size"" (\fBOSSL_DIGEST_PARAM_SIZE\fR) <unsigned integer>" 4
  78. .IX Item """size"" (OSSL_DIGEST_PARAM_SIZE) <unsigned integer>"
  79. The digest output size.
  80. The length of the "size" parameter should not exceed that of a \fBsize_t\fR.
  81. .Sp
  82. This value can also be retrieved with \fBEVP_MD_get_size\fR\|(3).
  83. .IP """flags"" (\fBOSSL_DIGEST_PARAM_FLAGS\fR) <unsigned integer>" 4
  84. .IX Item """flags"" (OSSL_DIGEST_PARAM_FLAGS) <unsigned integer>"
  85. Diverse flags that describe exceptional behaviour for the digest.
  86. These flags are described in "DESCRIPTION" in \fBEVP_MD_meth_set_flags\fR\|(3).
  87. .Sp
  88. The length of the "flags" parameter should equal that of an
  89. \&\fBunsigned long int\fR.
  90. .Sp
  91. This value can also be retrieved with \fBEVP_MD_get_flags\fR\|(3).
  92. .SH "SEE ALSO"
  93. .IX Header "SEE ALSO"
  94. "PARAMETERS" in \fBEVP_DigestInit\fR\|(3), \fBEVP_MD_get_params\fR\|(3), \fBprovider\-digest\fR\|(7)
  95. .SH COPYRIGHT
  96. .IX Header "COPYRIGHT"
  97. Copyright 2020\-2024 The OpenSSL Project Authors. All Rights Reserved.
  98. .PP
  99. Licensed under the Apache License 2.0 (the "License"). You may not use
  100. this file except in compliance with the License. You can obtain a copy
  101. in the file LICENSE in the source distribution or at
  102. <https://www.openssl.org/source/license.html>.