db9c04004e51cea1375ec09a28b77f89d09acd14
[openssl.git] / doc / crypto / EVP_DigestInit.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_MD_CTX_new, EVP_MD_CTX_reset, EVP_MD_CTX_free, EVP_MD_CTX_copy_ex,
6 EVP_DigestInit_ex, EVP_DigestUpdate, EVP_DigestFinal_ex, EVP_MAX_MD_SIZE,
7 EVP_DigestInit, EVP_DigestFinal, EVP_MD_CTX_copy, EVP_MD_type,
8 EVP_MD_pkey_type, EVP_MD_size, EVP_MD_block_size, EVP_MD_CTX_md, EVP_MD_CTX_size,
9 EVP_MD_CTX_block_size, EVP_MD_CTX_type, EVP_md_null, EVP_md2, EVP_md5, EVP_sha1,
10 EVP_sha224, EVP_sha256, EVP_sha384, EVP_sha512, EVP_mdc2,
11 EVP_ripemd160, EVP_get_digestbyname, EVP_get_digestbynid, EVP_get_digestbyobj -
12 EVP digest routines
13
14 =head1 SYNOPSIS
15
16  #include <openssl/evp.h>
17
18  EVP_MD_CTX *EVP_MD_CTX_new(void);
19  int EVP_MD_CTX_reset(EVP_MD_CTX *ctx);
20  void EVP_MD_CTX_free(EVP_MD_CTX *ctx);
21
22  int EVP_DigestInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl);
23  int EVP_DigestUpdate(EVP_MD_CTX *ctx, const void *d, size_t cnt);
24  int EVP_DigestFinal_ex(EVP_MD_CTX *ctx, unsigned char *md,
25         unsigned int *s);
26
27  int EVP_MD_CTX_copy_ex(EVP_MD_CTX *out,const EVP_MD_CTX *in);
28
29  int EVP_DigestInit(EVP_MD_CTX *ctx, const EVP_MD *type);
30  int EVP_DigestFinal(EVP_MD_CTX *ctx, unsigned char *md,
31         unsigned int *s);
32
33  int EVP_MD_CTX_copy(EVP_MD_CTX *out,EVP_MD_CTX *in);
34
35  #define EVP_MAX_MD_SIZE 64     /* SHA512 */
36
37  int EVP_MD_type(const EVP_MD *md);
38  int EVP_MD_pkey_type(const EVP_MD *md);        
39  int EVP_MD_size(const EVP_MD *md);
40  int EVP_MD_block_size(const EVP_MD *md);
41
42  const EVP_MD *EVP_MD_CTX_md(const EVP_MD_CTX *ctx);
43  int (*EVP_MD_CTX_update_fn(EVP_MD_CTX *ctx))(EVP_MD_CTX *ctx,
44                                               const void *data, size_t count);
45  void EVP_MD_CTX_set_update_fn(EVP_MD_CTX *ctx,
46                                int (*update) (EVP_MD_CTX *ctx,
47                                               const void *data, size_t count));
48  int EVP_MD_CTX_size(const EVP_MD *ctx);
49  int EVP_MD_CTX_block_size(const EVP_MD *ctx);
50  int EVP_MD_CTX_type(const EVP_MD *ctx);
51  EVP_PKEY_CTX *EVP_MD_CTX_pkey_ctx(const EVP_MD_CTX *ctx);
52  void *EVP_MD_CTX_md_data(const EVP_MD_CTX *ctx);
53
54  const EVP_MD *EVP_md_null(void);
55  const EVP_MD *EVP_md2(void);
56  const EVP_MD *EVP_md5(void);
57  const EVP_MD *EVP_sha1(void);
58  const EVP_MD *EVP_mdc2(void);
59  const EVP_MD *EVP_ripemd160(void);
60
61  const EVP_MD *EVP_sha224(void);
62  const EVP_MD *EVP_sha256(void);
63  const EVP_MD *EVP_sha384(void);
64  const EVP_MD *EVP_sha512(void);
65
66  const EVP_MD *EVP_get_digestbyname(const char *name);
67  const EVP_MD *EVP_get_digestbynid(int type);
68  const EVP_MD *EVP_get_digestbyobj(const ASN1_OBJECT *o);
69
70 =head1 DESCRIPTION
71
72 The EVP digest routines are a high level interface to message digests,
73 and should be used instead of the cipher-specific functions.
74
75 EVP_MD_CTX_new() allocates, initializes and returns a digest context.
76
77 EVP_MD_CTX_reset() resets the digest context B<ctx>.  This can be used
78 to reuse an already existing context.
79
80 EVP_MD_CTX_free() cleans up digest context B<ctx> and frees up the
81 space allocated to it.
82
83 EVP_DigestInit_ex() sets up digest context B<ctx> to use a digest
84 B<type> from ENGINE B<impl>. B<ctx> must be initialized before calling this
85 function. B<type> will typically be supplied by a function such as EVP_sha1().
86 If B<impl> is NULL then the default implementation of digest B<type> is used.
87
88 EVP_DigestUpdate() hashes B<cnt> bytes of data at B<d> into the
89 digest context B<ctx>. This function can be called several times on the
90 same B<ctx> to hash additional data.
91
92 EVP_DigestFinal_ex() retrieves the digest value from B<ctx> and places
93 it in B<md>. If the B<s> parameter is not NULL then the number of
94 bytes of data written (i.e. the length of the digest) will be written
95 to the integer at B<s>, at most B<EVP_MAX_MD_SIZE> bytes will be written.
96 After calling EVP_DigestFinal_ex() no additional calls to EVP_DigestUpdate()
97 can be made, but EVP_DigestInit_ex() can be called to initialize a new
98 digest operation.
99
100 EVP_MD_CTX_copy_ex() can be used to copy the message digest state from
101 B<in> to B<out>. This is useful if large amounts of data are to be
102 hashed which only differ in the last few bytes. B<out> must be initialized
103 before calling this function.
104
105 EVP_DigestInit() behaves in the same way as EVP_DigestInit_ex() except
106 the passed context B<ctx> does not have to be initialized, and it always
107 uses the default digest implementation.
108
109 EVP_DigestFinal() is similar to EVP_DigestFinal_ex() except the digest
110 context B<ctx> is automatically cleaned up.
111
112 EVP_MD_CTX_copy() is similar to EVP_MD_CTX_copy_ex() except the destination
113 B<out> does not have to be initialized.
114
115 EVP_MD_size() and EVP_MD_CTX_size() return the size of the message digest
116 when passed an B<EVP_MD> or an B<EVP_MD_CTX> structure, i.e. the size of the
117 hash.
118
119 EVP_MD_block_size() and EVP_MD_CTX_block_size() return the block size of the
120 message digest when passed an B<EVP_MD> or an B<EVP_MD_CTX> structure.
121
122 EVP_MD_type() and EVP_MD_CTX_type() return the NID of the OBJECT IDENTIFIER
123 representing the given message digest when passed an B<EVP_MD> structure.
124 For example EVP_MD_type(EVP_sha1()) returns B<NID_sha1>. This function is
125 normally used when setting ASN1 OIDs.
126
127 EVP_MD_CTX_md() returns the B<EVP_MD> structure corresponding to the passed
128 B<EVP_MD_CTX>.
129
130 EVP_MD_pkey_type() returns the NID of the public key signing algorithm associated
131 with this digest. For example EVP_sha1() is associated with RSA so this will
132 return B<NID_sha1WithRSAEncryption>. Since digests and signature algorithms
133 are no longer linked this function is only retained for compatibility
134 reasons.
135
136 EVP_md2(), EVP_md5(), EVP_sha1(), EVP_sha224(), EVP_sha256(),
137 EVP_sha384(), EVP_sha512(), EVP_mdc2() and EVP_ripemd160() return B<EVP_MD>
138 structures for the MD2, MD5, SHA1, SHA224, SHA256, SHA384, SHA512, MDC2
139 and RIPEMD160 digest algorithms respectively.
140
141 EVP_md_null() is a "null" message digest that does nothing: i.e. the hash it
142 returns is of zero length.
143
144 EVP_get_digestbyname(), EVP_get_digestbynid() and EVP_get_digestbyobj()
145 return an B<EVP_MD> structure when passed a digest name, a digest NID or
146 an ASN1_OBJECT structure respectively.
147
148 =head1 RETURN VALUES
149
150 EVP_DigestInit_ex(), EVP_DigestUpdate() and EVP_DigestFinal_ex() return 1 for
151 success and 0 for failure.
152
153 EVP_MD_CTX_copy_ex() returns 1 if successful or 0 for failure.
154
155 EVP_MD_type(), EVP_MD_pkey_type() and EVP_MD_type() return the NID of the
156 corresponding OBJECT IDENTIFIER or NID_undef if none exists.
157
158 EVP_MD_size(), EVP_MD_block_size(), EVP_MD_CTX_size() and
159 EVP_MD_CTX_block_size() return the digest or block size in bytes.
160
161 EVP_md_null(), EVP_md2(), EVP_md5(), EVP_sha1(),
162 EVP_mdc2() and EVP_ripemd160() return pointers to the
163 corresponding EVP_MD structures.
164
165 EVP_get_digestbyname(), EVP_get_digestbynid() and EVP_get_digestbyobj()
166 return either an B<EVP_MD> structure or NULL if an error occurs.
167
168 =head1 NOTES
169
170 The B<EVP> interface to message digests should almost always be used in
171 preference to the low level interfaces. This is because the code then becomes
172 transparent to the digest used and much more flexible.
173
174 New applications should use the SHA2 digest algorithms such as SHA256.
175 The other digest algorithms are still in common use.
176
177 For most applications the B<impl> parameter to EVP_DigestInit_ex() will be
178 set to NULL to use the default digest implementation.
179
180 The functions EVP_DigestInit(), EVP_DigestFinal() and EVP_MD_CTX_copy() are
181 obsolete but are retained to maintain compatibility with existing code. New
182 applications should use EVP_DigestInit_ex(), EVP_DigestFinal_ex() and
183 EVP_MD_CTX_copy_ex() because they can efficiently reuse a digest context
184 instead of initializing and cleaning it up on each call and allow non default
185 implementations of digests to be specified.
186
187 If digest contexts are not cleaned up after use
188 memory leaks will occur.
189
190 EVP_MD_CTX_size(), EVP_MD_CTX_block_size(), EVP_MD_CTX_type(),
191 EVP_get_digestbynid() and EVP_get_digestbyobj() are defined as
192 macros.
193
194
195 =head1 EXAMPLE
196
197 This example digests the data "Test Message\n" and "Hello World\n", using the
198 digest name passed on the command line.
199
200  #include <stdio.h>
201  #include <openssl/evp.h>
202
203  main(int argc, char *argv[])
204  {
205  EVP_MD_CTX *mdctx;
206  const EVP_MD *md;
207  char mess1[] = "Test Message\n";
208  char mess2[] = "Hello World\n";
209  unsigned char md_value[EVP_MAX_MD_SIZE];
210  int md_len, i;
211
212  if(!argv[1]) {
213         printf("Usage: mdtest digestname\n");
214         exit(1);
215  }
216
217  md = EVP_get_digestbyname(argv[1]);
218
219  if(!md) {
220         printf("Unknown message digest %s\n", argv[1]);
221         exit(1);
222  }
223
224  mdctx = EVP_MD_CTX_new();
225  EVP_DigestInit_ex(mdctx, md, NULL);
226  EVP_DigestUpdate(mdctx, mess1, strlen(mess1));
227  EVP_DigestUpdate(mdctx, mess2, strlen(mess2));
228  EVP_DigestFinal_ex(mdctx, md_value, &md_len);
229  EVP_MD_CTX_free(mdctx);
230
231  printf("Digest is: ");
232  for(i = 0; i < md_len; i++)
233         printf("%02x", md_value[i]);
234  printf("\n");
235
236  /* Call this once before exit. */
237  EVP_cleanup();
238  exit(0);
239  }
240
241 =head1 SEE ALSO
242
243 L<dgst(1)>,
244 L<evp(3)>
245
246 =head1 HISTORY
247
248 B<EVP_MD_CTX> became opaque in OpenSSL 1.1.  Consequently, stack
249 allocated B<EVP_MD_CTX>s are no longer supported.
250
251 EVP_MD_CTX_create() and EVP_MD_CTX_destroy() were renamed to
252 EVP_MD_CTX_new() and EVP_MD_CTX_free() in OpenSSL 1.1.
253
254 The link between digests and signing algorithms was fixed in OpenSSL 1.0 and
255 later, so now EVP_sha1() can be used with RSA and DSA. The legacy EVP_dss1()
256 was removed in OpenSSL 1.1.0
257
258 =cut