EVP_sha224.3ossl 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  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_SHA224 3ossl"
  58. .TH EVP_SHA224 3ossl 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_sha224,
  65. EVP_sha256,
  66. EVP_sha512_224,
  67. EVP_sha512_256,
  68. EVP_sha384,
  69. EVP_sha512
  70. \&\- SHA\-2 For EVP
  71. .SH SYNOPSIS
  72. .IX Header "SYNOPSIS"
  73. .Vb 1
  74. \& #include <openssl/evp.h>
  75. \&
  76. \& const EVP_MD *EVP_sha224(void);
  77. \& const EVP_MD *EVP_sha256(void);
  78. \& const EVP_MD *EVP_sha512_224(void);
  79. \& const EVP_MD *EVP_sha512_256(void);
  80. \& const EVP_MD *EVP_sha384(void);
  81. \& const EVP_MD *EVP_sha512(void);
  82. .Ve
  83. .SH DESCRIPTION
  84. .IX Header "DESCRIPTION"
  85. SHA\-2 (Secure Hash Algorithm 2) is a family of cryptographic hash functions
  86. standardized in NIST FIPS 180\-4, first published in 2001.
  87. .IP "\fBEVP_sha224()\fR, \fBEVP_sha256()\fR, EVP_sha512_224, EVP_sha512_256, \fBEVP_sha384()\fR, \fBEVP_sha512()\fR" 4
  88. .IX Item "EVP_sha224(), EVP_sha256(), EVP_sha512_224, EVP_sha512_256, EVP_sha384(), EVP_sha512()"
  89. The SHA\-2 SHA\-224, SHA\-256, SHA\-512/224, SHA512/256, SHA\-384 and SHA\-512
  90. algorithms, which generate 224, 256, 224, 256, 384 and 512 bits
  91. respectively of output from a given input.
  92. .Sp
  93. The two algorithms: SHA\-512/224 and SHA512/256 are truncated forms of the
  94. SHA\-512 algorithm. They are distinct from SHA\-224 and SHA\-256 even though
  95. their outputs are of the same size.
  96. .SH NOTES
  97. .IX Header "NOTES"
  98. Developers should be aware of the negative performance implications of
  99. calling these functions multiple times and should consider using
  100. \&\fBEVP_MD_fetch\fR\|(3) with \fBEVP_MD\-SHA2\fR\|(7)instead.
  101. See "Performance" in \fBcrypto\fR\|(7) for further information.
  102. .SH "RETURN VALUES"
  103. .IX Header "RETURN VALUES"
  104. These functions return a \fBEVP_MD\fR structure that contains the
  105. implementation of the message digest. See \fBEVP_MD_meth_new\fR\|(3) for
  106. details of the \fBEVP_MD\fR structure.
  107. .SH "CONFORMING TO"
  108. .IX Header "CONFORMING TO"
  109. NIST FIPS 180\-4.
  110. .SH "SEE ALSO"
  111. .IX Header "SEE ALSO"
  112. \&\fBevp\fR\|(7),
  113. \&\fBEVP_DigestInit\fR\|(3)
  114. .SH COPYRIGHT
  115. .IX Header "COPYRIGHT"
  116. Copyright 2017\-2023 The OpenSSL Project Authors. All Rights Reserved.
  117. .PP
  118. Licensed under the Apache License 2.0 (the "License"). You may not use
  119. this file except in compliance with the License. You can obtain a copy
  120. in the file LICENSE in the source distribution or at
  121. <https://www.openssl.org/source/license.html>.