secure/lib/libcrypto/man/EVP_DigestInit.3

   1 .\" Automatically generated by Pod::Man version 1.15
   2 .\" Tue Jul 30 09:21:40 2002
   3 .\"
   4 .\" Standard preamble:
   5 .\" ======================================================================
   6 .de Sh \" Subsection heading
   7 .br
   8 .if t .Sp
   9 .ne 5
  10 .PP
  11 \fB\\$1\fR
  12 .PP
  13 ..
  14 .de Sp \" Vertical space (when we can't use .PP)
  15 .if t .sp .5v
  16 .if n .sp
  17 ..
  18 .de Ip \" List item
  19 .br
  20 .ie \\n(.$>=3 .ne \\$3
  21 .el .ne 3
  22 .IP "\\$1" \\$2
  23 ..
  24 .de Vb \" Begin verbatim text
  25 .ft CW
  26 .nf
  27 .ne \\$1
  28 ..
  29 .de Ve \" End verbatim text
  30 .ft R
  31
  32 .fi
  33 ..
  34 .\" Set up some character translations and predefined strings.  \*(-- will
  35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  36 .\" double quote, and \*(R" will give a right double quote.  | will give a
  37 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
  38 .\" to do unbreakable dashes and therefore won't be available.  \*(C` and
  39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
  40 .tr \(*W-|\(bv\*(Tr
  41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  42 .ie n \{\
  43 .    ds -- \(*W-
  44 .    ds PI pi
  45 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  46 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  47 .    ds L" ""
  48 .    ds R" ""
  49 .    ds C` ""
  50 .    ds C' ""
  51 'br\}
  52 .el\{\
  53 .    ds -- \|\(em\|
  54 .    ds PI \(*p
  55 .    ds L" ``
  56 .    ds R" ''
  57 'br\}
  58 .\"
  59 .\" If the F register is turned on, we'll generate index entries on stderr
  60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
  61 .\" index entries marked with X<> in POD.  Of course, you'll have to process
  62 .\" the output yourself in some meaningful fashion.
  63 .if \nF \{\
  64 .    de IX
  65 .    tm Index:\\$1\t\\n%\t"\\$2"
  66 ..
  67 .    nr % 0
  68 .    rr F
  69 .\}
  70 .\"
  71 .\" For nroff, turn off justification.  Always turn off hyphenation; it
  72 .\" makes way too many mistakes in technical documents.
  73 .hy 0
  74 .if n .na
  75 .\"
  76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  77 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  78 .bd B 3
  79 .    \" fudge factors for nroff and troff
  80 .if n \{\
  81 .    ds #H 0
  82 .    ds #V .8m
  83 .    ds #F .3m
  84 .    ds #[ \f1
  85 .    ds #] \fP
  86 .\}
  87 .if t \{\
  88 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  89 .    ds #V .6m
  90 .    ds #F 0
  91 .    ds #[ \&
  92 .    ds #] \&
  93 .\}
  94 .    \" simple accents for nroff and troff
  95 .if n \{\
  96 .    ds ' \&
  97 .    ds ` \&
  98 .    ds ^ \&
  99 .    ds , \&
 100 .    ds ~ ~
 101 .    ds /
 102 .\}
 103 .if t \{\
 104 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 105 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 106 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 107 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 108 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 109 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 110 .\}
 111 .    \" troff and (daisy-wheel) nroff accents
 112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 119 .ds ae a\h'-(\w'a'u*4/10)'e
 120 .ds Ae A\h'-(\w'A'u*4/10)'E
 121 .    \" corrections for vroff
 122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 124 .    \" for low resolution devices (crt and lpr)
 125 .if \n(.H>23 .if \n(.V>19 \
 126 \{\
 127 .    ds : e
 128 .    ds 8 ss
 129 .    ds o a
 130 .    ds d- d\h'-1'\(ga
 131 .    ds D- D\h'-1'\(hy
 132 .    ds th \o'bp'
 133 .    ds Th \o'LP'
 134 .    ds ae ae
 135 .    ds Ae AE
 136 .\}
 137 .rm #[ #] #H #V #F C
 138 .\" ======================================================================
 139 .\"
 140 .IX Title "EVP_DigestInit 3"
 141 .TH EVP_DigestInit 3 "0.9.6e" "2002-07-30" "OpenSSL"
 142 .UC
 143 .SH "NAME"
 144 EVP_DigestInit, EVP_DigestUpdate, EVP_DigestFinal, \s-1EVP_MAX_MD_SIZE\s0,
 145 EVP_MD_CTX_copy, EVP_MD_type, EVP_MD_pkey_type, EVP_MD_size, EVP_MD_block_size,
 146 EVP_MD_CTX_md, EVP_MD_CTX_size, EVP_MD_CTX_block_size, EVP_MD_CTX_type,
 147 EVP_md_null, EVP_md2, EVP_md5, EVP_sha, EVP_sha1, EVP_dss, EVP_dss1, EVP_mdc2,
 148 EVP_ripemd160, EVP_get_digestbyname, EVP_get_digestbynid, EVP_get_digestbyobj \-
 149 \&\s-1EVP\s0 digest routines
 150 .SH "SYNOPSIS"
 151 .IX Header "SYNOPSIS"
 152 .Vb 1
 153 \& #include <openssl/evp.h>
 154 .Ve
 155 .Vb 4
 156 \& void EVP_DigestInit(EVP_MD_CTX *ctx, const EVP_MD *type);
 157 \& void EVP_DigestUpdate(EVP_MD_CTX *ctx, const void *d, unsigned int cnt);
 158 \& void EVP_DigestFinal(EVP_MD_CTX *ctx, unsigned char *md,
 159 \&        unsigned int *s);
 160 .Ve
 161 .Vb 1
 162 \& #define EVP_MAX_MD_SIZE (16+20) /* The SSLv3 md5+sha1 type */
 163 .Ve
 164 .Vb 1
 165 \& int EVP_MD_CTX_copy(EVP_MD_CTX *out,EVP_MD_CTX *in);
 166 .Ve
 167 .Vb 4
 168 \& #define EVP_MD_type(e)                 ((e)->type)
 169 \& #define EVP_MD_pkey_type(e)            ((e)->pkey_type)
 170 \& #define EVP_MD_size(e)                 ((e)->md_size)
 171 \& #define EVP_MD_block_size(e)           ((e)->block_size)
 172 .Ve
 173 .Vb 4
 174 \& #define EVP_MD_CTX_md(e)               (e)->digest)
 175 \& #define EVP_MD_CTX_size(e)             EVP_MD_size((e)->digest)
 176 \& #define EVP_MD_CTX_block_size(e)       EVP_MD_block_size((e)->digest)
 177 \& #define EVP_MD_CTX_type(e)             EVP_MD_type((e)->digest)
 178 .Ve
 179 .Vb 9
 180 \& EVP_MD *EVP_md_null(void);
 181 \& EVP_MD *EVP_md2(void);
 182 \& EVP_MD *EVP_md5(void);
 183 \& EVP_MD *EVP_sha(void);
 184 \& EVP_MD *EVP_sha1(void);
 185 \& EVP_MD *EVP_dss(void);
 186 \& EVP_MD *EVP_dss1(void);
 187 \& EVP_MD *EVP_mdc2(void);
 188 \& EVP_MD *EVP_ripemd160(void);
 189 .Ve
 190 .Vb 3
 191 \& const EVP_MD *EVP_get_digestbyname(const char *name);
 192 \& #define EVP_get_digestbynid(a) EVP_get_digestbyname(OBJ_nid2sn(a))
 193 \& #define EVP_get_digestbyobj(a) EVP_get_digestbynid(OBJ_obj2nid(a))
 194 .Ve
 195 .SH "DESCRIPTION"
 196 .IX Header "DESCRIPTION"
 197 The \s-1EVP\s0 digest routines are a high level interface to message digests.
 198 .PP
 199 \&\fIEVP_DigestInit()\fR initializes a digest context \fBctx\fR to use a digest
 200 \&\fBtype\fR: this will typically be supplied by a function such as
 201 \&\fIEVP_sha1()\fR.
 202 .PP
 203 \&\fIEVP_DigestUpdate()\fR hashes \fBcnt\fR bytes of data at \fBd\fR into the
 204 digest context \fBctx\fR. This function can be called several times on the
 205 same \fBctx\fR to hash additional data.
 206 .PP
 207 \&\fIEVP_DigestFinal()\fR retrieves the digest value from \fBctx\fR and places
 208 it in \fBmd\fR. If the \fBs\fR parameter is not \s-1NULL\s0 then the number of
 209 bytes of data written (i.e. the length of the digest) will be written
 210 to the integer at \fBs\fR, at most \fB\s-1EVP_MAX_MD_SIZE\s0\fR bytes will be written.
 211 After calling \fIEVP_DigestFinal()\fR no additional calls to \fIEVP_DigestUpdate()\fR
 212 can be made, but \fIEVP_DigestInit()\fR can be called to initialize a new
 213 digest operation.
 214 .PP
 215 \&\fIEVP_MD_CTX_copy()\fR can be used to copy the message digest state from
 216 \&\fBin\fR to \fBout\fR. This is useful if large amounts of data are to be
 217 hashed which only differ in the last few bytes.
 218 .PP
 219 \&\fIEVP_MD_size()\fR and \fIEVP_MD_CTX_size()\fR return the size of the message digest
 220 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
 221 hash.
 222 .PP
 223 \&\fIEVP_MD_block_size()\fR and \fIEVP_MD_CTX_block_size()\fR return the block size of the
 224 message digest when passed an \fB\s-1EVP_MD\s0\fR or an \fB\s-1EVP_MD_CTX\s0\fR structure.
 225 .PP
 226 \&\fIEVP_MD_type()\fR and \fIEVP_MD_CTX_type()\fR return the \s-1NID\s0 of the \s-1OBJECT\s0 \s-1IDENTIFIER\s0
 227 representing the given message digest when passed an \fB\s-1EVP_MD\s0\fR structure.
 228 For example EVP_MD_type(\fIEVP_sha1()\fR) returns \fBNID_sha1\fR. This function is
 229 normally used when setting \s-1ASN1\s0 OIDs.
 230 .PP
 231 \&\fIEVP_MD_CTX_md()\fR returns the \fB\s-1EVP_MD\s0\fR structure corresponding to the passed
 232 \&\fB\s-1EVP_MD_CTX\s0\fR.
 233 .PP
 234 \&\fIEVP_MD_pkey_type()\fR returns the \s-1NID\s0 of the public key signing algorithm associated
 235 with this digest. For example \fIEVP_sha1()\fR is associated with \s-1RSA\s0 so this will
 236 return \fBNID_sha1WithRSAEncryption\fR. This \*(L"link\*(R" between digests and signature
 237 algorithms may not be retained in future versions of OpenSSL.
 238 .PP
 239 \&\fIEVP_md2()\fR, \fIEVP_md5()\fR, \fIEVP_sha()\fR, \fIEVP_sha1()\fR, \fIEVP_mdc2()\fR and \fIEVP_ripemd160()\fR
 240 return \fB\s-1EVP_MD\s0\fR structures for the \s-1MD2\s0, \s-1MD5\s0, \s-1SHA\s0, \s-1SHA1\s0, \s-1MDC2\s0 and \s-1RIPEMD160\s0 digest
 241 algorithms respectively. The associated signature algorithm is \s-1RSA\s0 in each case.
 242 .PP
 243 \&\fIEVP_dss()\fR and \fIEVP_dss1()\fR return \fB\s-1EVP_MD\s0\fR structures for \s-1SHA\s0 and \s-1SHA1\s0 digest
 244 algorithms but using \s-1DSS\s0 (\s-1DSA\s0) for the signature algorithm.
 245 .PP
 246 \&\fIEVP_md_null()\fR is a \*(L"null\*(R" message digest that does nothing: i.e. the hash it
 247 returns is of zero length.
 248 .PP
 249 \&\fIEVP_get_digestbyname()\fR, \fIEVP_get_digestbynid()\fR and \fIEVP_get_digestbyobj()\fR
 250 return an \fB\s-1EVP_MD\s0\fR structure when passed a digest name, a digest \s-1NID\s0 or
 251 an \s-1ASN1_OBJECT\s0 structure respectively. The digest table must be initialized
 252 using, for example, \fIOpenSSL_add_all_digests()\fR for these functions to work.
 253 .SH "RETURN VALUES"
 254 .IX Header "RETURN VALUES"
 255 \&\fIEVP_DigestInit()\fR, \fIEVP_DigestUpdate()\fR and \fIEVP_DigestFinal()\fR do not return values.
 256 .PP
 257 \&\fIEVP_MD_CTX_copy()\fR returns 1 if successful or 0 for failure.
 258 .PP
 259 \&\fIEVP_MD_type()\fR, \fIEVP_MD_pkey_type()\fR and \fIEVP_MD_type()\fR return the \s-1NID\s0 of the
 260 corresponding \s-1OBJECT\s0 \s-1IDENTIFIER\s0 or NID_undef if none exists.
 261 .PP
 262 \&\fIEVP_MD_size()\fR, \fIEVP_MD_block_size()\fR, \fIEVP_MD_CTX_size\fR\|(e), \fIEVP_MD_size()\fR,
 263 \&\fIEVP_MD_CTX_block_size()\fR and \fIEVP_MD_block_size()\fR return the digest or block
 264 size in bytes.
 265 .PP
 266 \&\fIEVP_md_null()\fR, \fIEVP_md2()\fR, \fIEVP_md5()\fR, \fIEVP_sha()\fR, \fIEVP_sha1()\fR, \fIEVP_dss()\fR,
 267 \&\fIEVP_dss1()\fR, \fIEVP_mdc2()\fR and \fIEVP_ripemd160()\fR return pointers to the
 268 corresponding \s-1EVP_MD\s0 structures.
 269 .PP
 270 \&\fIEVP_get_digestbyname()\fR, \fIEVP_get_digestbynid()\fR and \fIEVP_get_digestbyobj()\fR
 271 return either an \fB\s-1EVP_MD\s0\fR structure or \s-1NULL\s0 if an error occurs.
 272 .SH "NOTES"
 273 .IX Header "NOTES"
 274 The \fB\s-1EVP\s0\fR interface to message digests should almost always be used in
 275 preference to the low level interfaces. This is because the code then becomes
 276 transparent to the digest used and much more flexible.
 277 .PP
 278 \&\s-1SHA1\s0 is the digest of choice for new applications. The other digest algorithms
 279 are still in common use.
 280 .SH "EXAMPLE"
 281 .IX Header "EXAMPLE"
 282 This example digests the data \*(L"Test Message\en\*(R" and \*(L"Hello World\en\*(R", using the
 283 digest name passed on the command line.
 284 .PP
 285 .Vb 2
 286 \& #include <stdio.h>
 287 \& #include <openssl/evp.h>
 288 .Ve
 289 .Vb 8
 290 \& main(int argc, char *argv[])
 291 \& {
 292 \& EVP_MD_CTX mdctx;
 293 \& const EVP_MD *md;
 294 \& char mess1[] = "Test Message\en";
 295 \& char mess2[] = "Hello World\en";
 296 \& unsigned char md_value[EVP_MAX_MD_SIZE];
 297 \& int md_len, i;
 298 .Ve
 299 .Vb 1
 300 \& OpenSSL_add_all_digests();
 301 .Ve
 302 .Vb 4
 303 \& if(!argv[1]) {
 304 \&        printf("Usage: mdtest digestname\en");
 305 \&        exit(1);
 306 \& }
 307 .Ve
 308 .Vb 1
 309 \& md = EVP_get_digestbyname(argv[1]);
 310 .Ve
 311 .Vb 4
 312 \& if(!md) {
 313 \&        printf("Unknown message digest %s\en", argv[1]);
 314 \&        exit(1);
 315 \& }
 316 .Ve
 317 .Vb 4
 318 \& EVP_DigestInit(&mdctx, md);
 319 \& EVP_DigestUpdate(&mdctx, mess1, strlen(mess1));
 320 \& EVP_DigestUpdate(&mdctx, mess2, strlen(mess2));
 321 \& EVP_DigestFinal(&mdctx, md_value, &md_len);
 322 .Ve
 323 .Vb 4
 324 \& printf("Digest is: ");
 325 \& for(i = 0; i < md_len; i++) printf("%02x", md_value[i]);
 326 \& printf("\en");
 327 \& }
 328 .Ve
 329 .SH "BUGS"
 330 .IX Header "BUGS"
 331 Several of the functions do not return values: maybe they should. Although the
 332 internal digest operations will never fail some future hardware based operations
 333 might.
 334 .PP
 335 The link between digests and signing algorithms results in a situation where
 336 \&\fIEVP_sha1()\fR must be used with \s-1RSA\s0 and \fIEVP_dss1()\fR must be used with \s-1DSS\s0
 337 even though they are identical digests.
 338 .PP
 339 The size of an \fB\s-1EVP_MD_CTX\s0\fR structure is determined at compile time: this results
 340 in code that must be recompiled if the size of \fB\s-1EVP_MD_CTX\s0\fR increases.
 341 .SH "SEE ALSO"
 342 .IX Header "SEE ALSO"
 343 evp(3), hmac(3), md2(3),
 344 md5(3), mdc2(3), ripemd(3),
 345 sha(3), dgst(1)
 346 .SH "HISTORY"
 347 .IX Header "HISTORY"
 348 \&\fIEVP_DigestInit()\fR, \fIEVP_DigestUpdate()\fR and \fIEVP_DigestFinal()\fR are
 349 available in all versions of SSLeay and OpenSSL.