MD5.3ossl 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  1. .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
  2. .\"
  3. .\" Standard preamble:
  4. .\" ========================================================================
  5. .de Sp \" Vertical space (when we can't use .PP)
  6. .if t .sp .5v
  7. .if n .sp
  8. ..
  9. .de Vb \" Begin verbatim text
  10. .ft CW
  11. .nf
  12. .ne \\$1
  13. ..
  14. .de Ve \" End verbatim text
  15. .ft R
  16. .fi
  17. ..
  18. .\" Set up some character translations and predefined strings. \*(-- will
  19. .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20. .\" double quote, and \*(R" will give a right double quote. \*(C+ will
  21. .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
  22. .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
  23. .\" nothing in troff, for use with C<>.
  24. .tr \(*W-
  25. .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26. .ie n \{\
  27. . ds -- \(*W-
  28. . ds PI pi
  29. . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30. . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
  31. . ds L" ""
  32. . ds R" ""
  33. . ds C` ""
  34. . ds C' ""
  35. 'br\}
  36. .el\{\
  37. . ds -- \|\(em\|
  38. . ds PI \(*p
  39. . ds L" ``
  40. . ds R" ''
  41. . ds C`
  42. . ds C'
  43. 'br\}
  44. .\"
  45. .\" Escape single quotes in literal strings from groff's Unicode transform.
  46. .ie \n(.g .ds Aq \(aq
  47. .el .ds Aq '
  48. .\"
  49. .\" If the F register is >0, we'll generate index entries on stderr for
  50. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51. .\" entries marked with X<> in POD. Of course, you'll have to process the
  52. .\" output yourself in some meaningful fashion.
  53. .\"
  54. .\" Avoid warning from groff about undefined register 'F'.
  55. .de IX
  56. ..
  57. .nr rF 0
  58. .if \n(.g .if rF .nr rF 1
  59. .if (\n(rF:(\n(.g==0)) \{\
  60. . if \nF \{\
  61. . de IX
  62. . tm Index:\\$1\t\\n%\t"\\$2"
  63. ..
  64. . if !\nF==2 \{\
  65. . nr % 0
  66. . nr F 2
  67. . \}
  68. . \}
  69. .\}
  70. .rr rF
  71. .\"
  72. .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73. .\" Fear. Run. Save yourself. No user-serviceable parts.
  74. . \" fudge factors for nroff and troff
  75. .if n \{\
  76. . ds #H 0
  77. . ds #V .8m
  78. . ds #F .3m
  79. . ds #[ \f1
  80. . ds #] \fP
  81. .\}
  82. .if t \{\
  83. . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84. . ds #V .6m
  85. . ds #F 0
  86. . ds #[ \&
  87. . ds #] \&
  88. .\}
  89. . \" simple accents for nroff and troff
  90. .if n \{\
  91. . ds ' \&
  92. . ds ` \&
  93. . ds ^ \&
  94. . ds , \&
  95. . ds ~ ~
  96. . ds /
  97. .\}
  98. .if t \{\
  99. . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  100. . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  101. . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  102. . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  103. . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  104. . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  105. .\}
  106. . \" troff and (daisy-wheel) nroff accents
  107. .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  108. .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
  109. .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
  110. .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
  111. .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
  112. .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
  113. .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
  114. .ds ae a\h'-(\w'a'u*4/10)'e
  115. .ds Ae A\h'-(\w'A'u*4/10)'E
  116. . \" corrections for vroff
  117. .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
  118. .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
  119. . \" for low resolution devices (crt and lpr)
  120. .if \n(.H>23 .if \n(.V>19 \
  121. \{\
  122. . ds : e
  123. . ds 8 ss
  124. . ds o a
  125. . ds d- d\h'-1'\(ga
  126. . ds D- D\h'-1'\(hy
  127. . ds th \o'bp'
  128. . ds Th \o'LP'
  129. . ds ae ae
  130. . ds Ae AE
  131. .\}
  132. .rm #[ #] #H #V #F C
  133. .\" ========================================================================
  134. .\"
  135. .IX Title "MD5 3ossl"
  136. .TH MD5 3ossl "2024-09-03" "3.3.2" "OpenSSL"
  137. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  138. .\" way too many mistakes in technical documents.
  139. .if n .ad l
  140. .nh
  141. .SH "NAME"
  142. MD2, MD4, MD5, MD2_Init, MD2_Update, MD2_Final, MD4_Init, MD4_Update,
  143. MD4_Final, MD5_Init, MD5_Update, MD5_Final \- MD2, MD4, and MD5 hash functions
  144. .SH "SYNOPSIS"
  145. .IX Header "SYNOPSIS"
  146. The following functions have been deprecated since OpenSSL 3.0, and can be
  147. hidden entirely by defining \fB\s-1OPENSSL_API_COMPAT\s0\fR with a suitable version value,
  148. see \fBopenssl_user_macros\fR\|(7):
  149. .PP
  150. .Vb 1
  151. \& #include <openssl/md2.h>
  152. \&
  153. \& unsigned char *MD2(const unsigned char *d, unsigned long n, unsigned char *md);
  154. \&
  155. \& int MD2_Init(MD2_CTX *c);
  156. \& int MD2_Update(MD2_CTX *c, const unsigned char *data, unsigned long len);
  157. \& int MD2_Final(unsigned char *md, MD2_CTX *c);
  158. .Ve
  159. .PP
  160. The following functions have been deprecated since OpenSSL 3.0, and can be
  161. hidden entirely by defining \fB\s-1OPENSSL_API_COMPAT\s0\fR with a suitable version value,
  162. see \fBopenssl_user_macros\fR\|(7):
  163. .PP
  164. .Vb 1
  165. \& #include <openssl/md4.h>
  166. \&
  167. \& unsigned char *MD4(const unsigned char *d, unsigned long n, unsigned char *md);
  168. \&
  169. \& int MD4_Init(MD4_CTX *c);
  170. \& int MD4_Update(MD4_CTX *c, const void *data, unsigned long len);
  171. \& int MD4_Final(unsigned char *md, MD4_CTX *c);
  172. .Ve
  173. .PP
  174. The following functions have been deprecated since OpenSSL 3.0, and can be
  175. hidden entirely by defining \fB\s-1OPENSSL_API_COMPAT\s0\fR with a suitable version value,
  176. see \fBopenssl_user_macros\fR\|(7):
  177. .PP
  178. .Vb 1
  179. \& #include <openssl/md5.h>
  180. \&
  181. \& unsigned char *MD5(const unsigned char *d, unsigned long n, unsigned char *md);
  182. \&
  183. \& int MD5_Init(MD5_CTX *c);
  184. \& int MD5_Update(MD5_CTX *c, const void *data, unsigned long len);
  185. \& int MD5_Final(unsigned char *md, MD5_CTX *c);
  186. .Ve
  187. .SH "DESCRIPTION"
  188. .IX Header "DESCRIPTION"
  189. All of the functions described on this page are deprecated.
  190. Applications should instead use \fBEVP_DigestInit_ex\fR\|(3), \fBEVP_DigestUpdate\fR\|(3)
  191. and \fBEVP_DigestFinal_ex\fR\|(3).
  192. .PP
  193. \&\s-1MD2, MD4,\s0 and \s-1MD5\s0 are cryptographic hash functions with a 128 bit output.
  194. .PP
  195. \&\s-1\fBMD2\s0()\fR, \s-1\fBMD4\s0()\fR, and \s-1\fBMD5\s0()\fR compute the \s-1MD2, MD4,\s0 and \s-1MD5\s0 message digest
  196. of the \fBn\fR bytes at \fBd\fR and place it in \fBmd\fR (which must have space
  197. for \s-1MD2_DIGEST_LENGTH\s0 == \s-1MD4_DIGEST_LENGTH\s0 == \s-1MD5_DIGEST_LENGTH\s0 == 16
  198. bytes of output). If \fBmd\fR is \s-1NULL,\s0 the digest is placed in a static
  199. array.
  200. .PP
  201. The following functions may be used if the message is not completely
  202. stored in memory:
  203. .PP
  204. \&\fBMD2_Init()\fR initializes a \fB\s-1MD2_CTX\s0\fR structure.
  205. .PP
  206. \&\fBMD2_Update()\fR can be called repeatedly with chunks of the message to
  207. be hashed (\fBlen\fR bytes at \fBdata\fR).
  208. .PP
  209. \&\fBMD2_Final()\fR places the message digest in \fBmd\fR, which must have space
  210. for \s-1MD2_DIGEST_LENGTH\s0 == 16 bytes of output, and erases the \fB\s-1MD2_CTX\s0\fR.
  211. .PP
  212. \&\fBMD4_Init()\fR, \fBMD4_Update()\fR, \fBMD4_Final()\fR, \fBMD5_Init()\fR, \fBMD5_Update()\fR, and
  213. \&\fBMD5_Final()\fR are analogous using an \fB\s-1MD4_CTX\s0\fR and \fB\s-1MD5_CTX\s0\fR structure.
  214. .PP
  215. Applications should use the higher level functions
  216. \&\fBEVP_DigestInit\fR\|(3)
  217. etc. instead of calling the hash functions directly.
  218. .SH "NOTE"
  219. .IX Header "NOTE"
  220. \&\s-1MD2, MD4,\s0 and \s-1MD5\s0 are recommended only for compatibility with existing
  221. applications. In new applications, hashes from the \s-1SHA\-2\s0 or \s-1SHA\-3\s0 family
  222. should be preferred.
  223. .SH "RETURN VALUES"
  224. .IX Header "RETURN VALUES"
  225. \&\s-1\fBMD2\s0()\fR, \s-1\fBMD4\s0()\fR, and \s-1\fBMD5\s0()\fR return pointers to the hash value.
  226. .PP
  227. \&\fBMD2_Init()\fR, \fBMD2_Update()\fR, \fBMD2_Final()\fR, \fBMD4_Init()\fR, \fBMD4_Update()\fR,
  228. \&\fBMD4_Final()\fR, \fBMD5_Init()\fR, \fBMD5_Update()\fR, and \fBMD5_Final()\fR return 1 for
  229. success, 0 otherwise.
  230. .SH "CONFORMING TO"
  231. .IX Header "CONFORMING TO"
  232. \&\s-1RFC 1319, RFC 1320, RFC 1321\s0
  233. .SH "SEE ALSO"
  234. .IX Header "SEE ALSO"
  235. \&\fBEVP_DigestInit\fR\|(3), \s-1\fBEVP_MD\-SHA2\s0\fR\|(7), \s-1\fBEVP_MD\-SHA3\s0\fR\|(7)
  236. .SH "HISTORY"
  237. .IX Header "HISTORY"
  238. All of these functions were deprecated in OpenSSL 3.0.
  239. .SH "COPYRIGHT"
  240. .IX Header "COPYRIGHT"
  241. Copyright 2000\-2024 The OpenSSL Project Authors. All Rights Reserved.
  242. .PP
  243. Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
  244. this file except in compliance with the License. You can obtain a copy
  245. in the file \s-1LICENSE\s0 in the source distribution or at
  246. <https://www.openssl.org/source/license.html>.