secure/lib/libcrypto/man/EVP_DigestInit.3

   1 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
   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 turned on, 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 "EVP_DigestInit 3"
 136 .TH EVP_DigestInit 3 "2015-12-03" "0.9.8zh" "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 EVP_MD_CTX_init, EVP_MD_CTX_create, EVP_DigestInit_ex, EVP_DigestUpdate,
 143 EVP_DigestFinal_ex, EVP_MD_CTX_cleanup, EVP_MD_CTX_destroy, EVP_MAX_MD_SIZE,
 144 EVP_MD_CTX_copy_ex, EVP_MD_CTX_copy, EVP_MD_type, EVP_MD_pkey_type, EVP_MD_size,
 145 EVP_MD_block_size, EVP_MD_CTX_md, EVP_MD_CTX_size, EVP_MD_CTX_block_size, EVP_MD_CTX_type,
 146 EVP_md_null, EVP_md2, EVP_md5, EVP_sha, EVP_sha1, EVP_dss, EVP_dss1, EVP_mdc2,
 147 EVP_ripemd160, EVP_get_digestbyname, EVP_get_digestbynid, EVP_get_digestbyobj \-
 148 EVP digest routines
 149 .SH "SYNOPSIS"
 150 .IX Header "SYNOPSIS"
 151 .Vb 1
 152 \& #include <openssl/evp.h>
 153 \&
 154 \& void EVP_MD_CTX_init(EVP_MD_CTX *ctx);
 155 \& EVP_MD_CTX *EVP_MD_CTX_create(void);
 156 \&
 157 \& int EVP_DigestInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl);
 158 \& int EVP_DigestUpdate(EVP_MD_CTX *ctx, const void *d, size_t cnt);
 159 \& int EVP_DigestFinal_ex(EVP_MD_CTX *ctx, unsigned char *md,
 160 \&        unsigned int *s);
 161 \&
 162 \& int EVP_MD_CTX_cleanup(EVP_MD_CTX *ctx);
 163 \& void EVP_MD_CTX_destroy(EVP_MD_CTX *ctx);
 164 \&
 165 \& int EVP_MD_CTX_copy_ex(EVP_MD_CTX *out,const EVP_MD_CTX *in);
 166 \&
 167 \& int EVP_DigestInit(EVP_MD_CTX *ctx, const EVP_MD *type);
 168 \& int EVP_DigestFinal(EVP_MD_CTX *ctx, unsigned char *md,
 169 \&        unsigned int *s);
 170 \&
 171 \& int EVP_MD_CTX_copy(EVP_MD_CTX *out,EVP_MD_CTX *in);
 172 \&
 173 \& #define EVP_MAX_MD_SIZE (16+20) /* The SSLv3 md5+sha1 type */
 174 \&
 175 \&
 176 \& #define EVP_MD_type(e)                 ((e)\->type)
 177 \& #define EVP_MD_pkey_type(e)            ((e)\->pkey_type)
 178 \& #define EVP_MD_size(e)                 ((e)\->md_size)
 179 \& #define EVP_MD_block_size(e)           ((e)\->block_size)
 180 \&
 181 \& #define EVP_MD_CTX_md(e)               (e)\->digest)
 182 \& #define EVP_MD_CTX_size(e)             EVP_MD_size((e)\->digest)
 183 \& #define EVP_MD_CTX_block_size(e)       EVP_MD_block_size((e)\->digest)
 184 \& #define EVP_MD_CTX_type(e)             EVP_MD_type((e)\->digest)
 185 \&
 186 \& const EVP_MD *EVP_md_null(void);
 187 \& const EVP_MD *EVP_md2(void);
 188 \& const EVP_MD *EVP_md5(void);
 189 \& const EVP_MD *EVP_sha(void);
 190 \& const EVP_MD *EVP_sha1(void);
 191 \& const EVP_MD *EVP_dss(void);
 192 \& const EVP_MD *EVP_dss1(void);
 193 \& const EVP_MD *EVP_mdc2(void);
 194 \& const EVP_MD *EVP_ripemd160(void);
 195 \&
 196 \& const EVP_MD *EVP_get_digestbyname(const char *name);
 197 \& #define EVP_get_digestbynid(a) EVP_get_digestbyname(OBJ_nid2sn(a))
 198 \& #define EVP_get_digestbyobj(a) EVP_get_digestbynid(OBJ_obj2nid(a))
 199 .Ve
 200 .SH "DESCRIPTION"
 201 .IX Header "DESCRIPTION"
 202 The \s-1EVP\s0 digest routines are a high level interface to message digests.
 203 .PP
 204 \&\fIEVP_MD_CTX_init()\fR initializes digest context \fBctx\fR.
 205 .PP
 206 \&\fIEVP_MD_CTX_create()\fR allocates, initializes and returns a digest context.
 207 .PP
 208 \&\fIEVP_DigestInit_ex()\fR sets up digest context \fBctx\fR to use a digest
 209 \&\fBtype\fR from \s-1ENGINE \s0\fBimpl\fR. \fBctx\fR must be initialized before calling this
 210 function. \fBtype\fR will typically be supplied by a functionsuch as \fIEVP_sha1()\fR.
 211 If \fBimpl\fR is \s-1NULL\s0 then the default implementation of digest \fBtype\fR is used.
 212 .PP
 213 \&\fIEVP_DigestUpdate()\fR hashes \fBcnt\fR bytes of data at \fBd\fR into the
 214 digest context \fBctx\fR. This function can be called several times on the
 215 same \fBctx\fR to hash additional data.
 216 .PP
 217 \&\fIEVP_DigestFinal_ex()\fR retrieves the digest value from \fBctx\fR and places
 218 it in \fBmd\fR. If the \fBs\fR parameter is not \s-1NULL\s0 then the number of
 219 bytes of data written (i.e. the length of the digest) will be written
 220 to the integer at \fBs\fR, at most \fB\s-1EVP_MAX_MD_SIZE\s0\fR bytes will be written.
 221 After calling \fIEVP_DigestFinal_ex()\fR no additional calls to \fIEVP_DigestUpdate()\fR
 222 can be made, but \fIEVP_DigestInit_ex()\fR can be called to initialize a new
 223 digest operation.
 224 .PP
 225 \&\fIEVP_MD_CTX_cleanup()\fR cleans up digest context \fBctx\fR, it should be called
 226 after a digest context is no longer needed.
 227 .PP
 228 \&\fIEVP_MD_CTX_destroy()\fR cleans up digest context \fBctx\fR and frees up the
 229 space allocated to it, it should be called only on a context created
 230 using \fIEVP_MD_CTX_create()\fR.
 231 .PP
 232 \&\fIEVP_MD_CTX_copy_ex()\fR can be used to copy the message digest state from
 233 \&\fBin\fR to \fBout\fR. This is useful if large amounts of data are to be
 234 hashed which only differ in the last few bytes. \fBout\fR must be initialized
 235 before calling this function.
 236 .PP
 237 \&\fIEVP_DigestInit()\fR behaves in the same way as \fIEVP_DigestInit_ex()\fR except
 238 the passed context \fBctx\fR does not have to be initialized, and it always
 239 uses the default digest implementation.
 240 .PP
 241 \&\fIEVP_DigestFinal()\fR is similar to \fIEVP_DigestFinal_ex()\fR except the digest
 242 context \fBctx\fR is automatically cleaned up.
 243 .PP
 244 \&\fIEVP_MD_CTX_copy()\fR is similar to \fIEVP_MD_CTX_copy_ex()\fR except the destination
 245 \&\fBout\fR does not have to be initialized.
 246 .PP
 247 \&\fIEVP_MD_size()\fR and \fIEVP_MD_CTX_size()\fR return the size of the message digest
 248 when passed an \fB\s-1EVP_MD\s0\fR or an \fB\s-1EVP_MD_CTX\s0\fR structure, i.e. the size of the
 249 hash.
 250 .PP
 251 \&\fIEVP_MD_block_size()\fR and \fIEVP_MD_CTX_block_size()\fR return the block size of the
 252 message digest when passed an \fB\s-1EVP_MD\s0\fR or an \fB\s-1EVP_MD_CTX\s0\fR structure.
 253 .PP
 254 \&\fIEVP_MD_type()\fR and \fIEVP_MD_CTX_type()\fR return the \s-1NID\s0 of the \s-1OBJECT IDENTIFIER\s0
 255 representing the given message digest when passed an \fB\s-1EVP_MD\s0\fR structure.
 256 For example EVP_MD_type(\fIEVP_sha1()\fR) returns \fBNID_sha1\fR. This function is
 257 normally used when setting \s-1ASN1\s0 OIDs.
 258 .PP
 259 \&\fIEVP_MD_CTX_md()\fR returns the \fB\s-1EVP_MD\s0\fR structure corresponding to the passed
 260 \&\fB\s-1EVP_MD_CTX\s0\fR.
 261 .PP
 262 \&\fIEVP_MD_pkey_type()\fR returns the \s-1NID\s0 of the public key signing algorithm associated
 263 with this digest. For example \fIEVP_sha1()\fR is associated with \s-1RSA\s0 so this will
 264 return \fBNID_sha1WithRSAEncryption\fR. This \*(L"link\*(R" between digests and signature
 265 algorithms may not be retained in future versions of OpenSSL.
 266 .PP
 267 \&\fIEVP_md2()\fR, \fIEVP_md5()\fR, \fIEVP_sha()\fR, \fIEVP_sha1()\fR, \fIEVP_mdc2()\fR and \fIEVP_ripemd160()\fR
 268 return \fB\s-1EVP_MD\s0\fR structures for the \s-1MD2, MD5, SHA, SHA1, MDC2\s0 and \s-1RIPEMD160\s0 digest
 269 algorithms respectively. The associated signature algorithm is \s-1RSA\s0 in each case.
 270 .PP
 271 \&\fIEVP_dss()\fR and \fIEVP_dss1()\fR return \fB\s-1EVP_MD\s0\fR structures for \s-1SHA\s0 and \s-1SHA1\s0 digest
 272 algorithms but using \s-1DSS \s0(\s-1DSA\s0) for the signature algorithm.
 273 .PP
 274 \&\fIEVP_md_null()\fR is a \*(L"null\*(R" message digest that does nothing: i.e. the hash it
 275 returns is of zero length.
 276 .PP
 277 \&\fIEVP_get_digestbyname()\fR, \fIEVP_get_digestbynid()\fR and \fIEVP_get_digestbyobj()\fR
 278 return an \fB\s-1EVP_MD\s0\fR structure when passed a digest name, a digest \s-1NID\s0 or
 279 an \s-1ASN1_OBJECT\s0 structure respectively. The digest table must be initialized
 280 using, for example, \fIOpenSSL_add_all_digests()\fR for these functions to work.
 281 .SH "RETURN VALUES"
 282 .IX Header "RETURN VALUES"
 283 \&\fIEVP_DigestInit_ex()\fR, \fIEVP_DigestUpdate()\fR and \fIEVP_DigestFinal_ex()\fR return 1 for
 284 success and 0 for failure.
 285 .PP
 286 \&\fIEVP_MD_CTX_copy_ex()\fR returns 1 if successful or 0 for failure.
 287 .PP
 288 \&\fIEVP_MD_type()\fR, \fIEVP_MD_pkey_type()\fR and \fIEVP_MD_type()\fR return the \s-1NID\s0 of the
 289 corresponding \s-1OBJECT IDENTIFIER\s0 or NID_undef if none exists.
 290 .PP
 291 \&\fIEVP_MD_size()\fR, \fIEVP_MD_block_size()\fR, EVP_MD_CTX_size(e), \fIEVP_MD_size()\fR,
 292 \&\fIEVP_MD_CTX_block_size()\fR and \fIEVP_MD_block_size()\fR return the digest or block
 293 size in bytes.
 294 .PP
 295 \&\fIEVP_md_null()\fR, \fIEVP_md2()\fR, \fIEVP_md5()\fR, \fIEVP_sha()\fR, \fIEVP_sha1()\fR, \fIEVP_dss()\fR,
 296 \&\fIEVP_dss1()\fR, \fIEVP_mdc2()\fR and \fIEVP_ripemd160()\fR return pointers to the
 297 corresponding \s-1EVP_MD\s0 structures.
 298 .PP
 299 \&\fIEVP_get_digestbyname()\fR, \fIEVP_get_digestbynid()\fR and \fIEVP_get_digestbyobj()\fR
 300 return either an \fB\s-1EVP_MD\s0\fR structure or \s-1NULL\s0 if an error occurs.
 301 .SH "NOTES"
 302 .IX Header "NOTES"
 303 The \fB\s-1EVP\s0\fR interface to message digests should almost always be used in
 304 preference to the low level interfaces. This is because the code then becomes
 305 transparent to the digest used and much more flexible.
 306 .PP
 307 \&\s-1SHA1\s0 is the digest of choice for new applications. The other digest algorithms
 308 are still in common use.
 309 .PP
 310 For most applications the \fBimpl\fR parameter to \fIEVP_DigestInit_ex()\fR will be
 311 set to \s-1NULL\s0 to use the default digest implementation.
 312 .PP
 313 The functions \fIEVP_DigestInit()\fR, \fIEVP_DigestFinal()\fR and \fIEVP_MD_CTX_copy()\fR are
 314 obsolete but are retained to maintain compatibility with existing code. New
 315 applications should use \fIEVP_DigestInit_ex()\fR, \fIEVP_DigestFinal_ex()\fR and
 316 \&\fIEVP_MD_CTX_copy_ex()\fR because they can efficiently reuse a digest context
 317 instead of initializing and cleaning it up on each call and allow non default
 318 implementations of digests to be specified.
 319 .PP
 320 In OpenSSL 0.9.7 and later if digest contexts are not cleaned up after use
 321 memory leaks will occur.
 322 .SH "EXAMPLE"
 323 .IX Header "EXAMPLE"
 324 This example digests the data \*(L"Test Message\en\*(R" and \*(L"Hello World\en\*(R", using the
 325 digest name passed on the command line.
 326 .PP
 327 .Vb 2
 328 \& #include <stdio.h>
 329 \& #include <openssl/evp.h>
 330 \&
 331 \& main(int argc, char *argv[])
 332 \& {
 333 \& EVP_MD_CTX mdctx;
 334 \& const EVP_MD *md;
 335 \& char mess1[] = "Test Message\en";
 336 \& char mess2[] = "Hello World\en";
 337 \& unsigned char md_value[EVP_MAX_MD_SIZE];
 338 \& int md_len, i;
 339 \&
 340 \& OpenSSL_add_all_digests();
 341 \&
 342 \& if(!argv[1]) {
 343 \&        printf("Usage: mdtest digestname\en");
 344 \&        exit(1);
 345 \& }
 346 \&
 347 \& md = EVP_get_digestbyname(argv[1]);
 348 \&
 349 \& if(!md) {
 350 \&        printf("Unknown message digest %s\en", argv[1]);
 351 \&        exit(1);
 352 \& }
 353 \&
 354 \& EVP_MD_CTX_init(&mdctx);
 355 \& EVP_DigestInit_ex(&mdctx, md, NULL);
 356 \& EVP_DigestUpdate(&mdctx, mess1, strlen(mess1));
 357 \& EVP_DigestUpdate(&mdctx, mess2, strlen(mess2));
 358 \& EVP_DigestFinal_ex(&mdctx, md_value, &md_len);
 359 \& EVP_MD_CTX_cleanup(&mdctx);
 360 \&
 361 \& printf("Digest is: ");
 362 \& for(i = 0; i < md_len; i++) printf("%02x", md_value[i]);
 363 \& printf("\en");
 364 \& }
 365 .Ve
 366 .SH "BUGS"
 367 .IX Header "BUGS"
 368 The link between digests and signing algorithms results in a situation where
 369 \&\fIEVP_sha1()\fR must be used with \s-1RSA\s0 and \fIEVP_dss1()\fR must be used with \s-1DSS\s0
 370 even though they are identical digests.
 371 .SH "SEE ALSO"
 372 .IX Header "SEE ALSO"
 373 \&\fIevp\fR\|(3), \fIhmac\fR\|(3), \fImd2\fR\|(3),
 374 \&\fImd5\fR\|(3), \fImdc2\fR\|(3), \fIripemd\fR\|(3),
 375 \&\fIsha\fR\|(3), \fIdgst\fR\|(1)
 376 .SH "HISTORY"
 377 .IX Header "HISTORY"
 378 \&\fIEVP_DigestInit()\fR, \fIEVP_DigestUpdate()\fR and \fIEVP_DigestFinal()\fR are
 379 available in all versions of SSLeay and OpenSSL.
 380 .PP
 381 \&\fIEVP_MD_CTX_init()\fR, \fIEVP_MD_CTX_create()\fR, \fIEVP_MD_CTX_copy_ex()\fR,
 382 \&\fIEVP_MD_CTX_cleanup()\fR, \fIEVP_MD_CTX_destroy()\fR, \fIEVP_DigestInit_ex()\fR
 383 and \fIEVP_DigestFinal_ex()\fR were added in OpenSSL 0.9.7.
 384 .PP
 385 \&\fIEVP_md_null()\fR, \fIEVP_md2()\fR, \fIEVP_md5()\fR, \fIEVP_sha()\fR, \fIEVP_sha1()\fR,
 386 \&\fIEVP_dss()\fR, \fIEVP_dss1()\fR, \fIEVP_mdc2()\fR and \fIEVP_ripemd160()\fR were
 387 changed to return truely const \s-1EVP_MD\s0 * in OpenSSL 0.9.7.