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