Add EVP_DigestFinalXOF, interface to extendable-output functions, XOFs.
[openssl.git] / doc / man3 / 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_MD_CTX_ctrl, EVP_DigestInit_ex, EVP_DigestInit, EVP_DigestUpdate,
7 EVP_DigestFinal_ex, EVP_DigestFinalXOF, EVP_DigestFinal,
8 EVP_MD_CTX_copy, EVP_MD_type, EVP_MD_pkey_type, EVP_MD_size,
9 EVP_MD_block_size, EVP_MD_CTX_md, EVP_MD_CTX_size,
10 EVP_MD_CTX_block_size, EVP_MD_CTX_type, EVP_md_null, EVP_md2, EVP_md5, EVP_sha1,
11 EVP_sha224, EVP_sha256, EVP_sha384, EVP_sha512, EVP_sha3_224, EVP_sha3_256,
12 EVP_sha3_384, EVP_sha3_512, EVP_mdc2, EVP_ripemd160, EVP_blake2b512,
13 EVP_blake2s256, EVP_get_digestbyname, EVP_get_digestbynid,
14 EVP_get_digestbyobj - EVP digest routines
15
16 =head1 SYNOPSIS
17
18  #include <openssl/evp.h>
19
20  EVP_MD_CTX *EVP_MD_CTX_new(void);
21  int EVP_MD_CTX_reset(EVP_MD_CTX *ctx);
22  void EVP_MD_CTX_free(EVP_MD_CTX *ctx);
23  void EVP_MD_CTX_ctrl(EVP_MD_CTX *ctx, int cmd, int p1, void* p2);
24
25  int EVP_DigestInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl);
26  int EVP_DigestUpdate(EVP_MD_CTX *ctx, const void *d, size_t cnt);
27  int EVP_DigestFinal_ex(EVP_MD_CTX *ctx, unsigned char *md, unsigned int *s);
28  int EVP_DigestFinalXOF(EVP_MD_CTX *ctx, unsigned char *md, size_t len);
29
30  int EVP_MD_CTX_copy_ex(EVP_MD_CTX *out, const EVP_MD_CTX *in);
31
32  int EVP_DigestInit(EVP_MD_CTX *ctx, const EVP_MD *type);
33  int EVP_DigestFinal(EVP_MD_CTX *ctx, unsigned char *md, unsigned int *s);
34
35  int EVP_MD_CTX_copy(EVP_MD_CTX *out, EVP_MD_CTX *in);
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_size(const EVP_MD *ctx);
44  int EVP_MD_CTX_block_size(const EVP_MD *ctx);
45  int EVP_MD_CTX_type(const EVP_MD *ctx);
46
47  const EVP_MD *EVP_md_null(void);
48  const EVP_MD *EVP_md2(void);
49  const EVP_MD *EVP_md5(void);
50  const EVP_MD *EVP_sha1(void);
51  const EVP_MD *EVP_mdc2(void);
52  const EVP_MD *EVP_ripemd160(void);
53  const EVP_MD *EVP_blake2b512(void);
54  const EVP_MD *EVP_blake2s256(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_sha3_224(void);
62  const EVP_MD *EVP_sha3_256(void);
63  const EVP_MD *EVP_sha3_384(void);
64  const EVP_MD *EVP_sha3_512(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_MD_CTX_ctrl() performs digest-specific control actions on context B<ctx>.
84
85 EVP_DigestInit_ex() sets up digest context B<ctx> to use a digest
86 B<type> from ENGINE B<impl>. B<ctx> must be initialized before calling this
87 function. B<type> will typically be supplied by a function such as EVP_sha1().
88 If B<impl> is NULL then the default implementation of digest B<type> is used.
89
90 EVP_DigestUpdate() hashes B<cnt> bytes of data at B<d> into the
91 digest context B<ctx>. This function can be called several times on the
92 same B<ctx> to hash additional data.
93
94 EVP_DigestFinal_ex() retrieves the digest value from B<ctx> and places
95 it in B<md>. If the B<s> parameter is not NULL then the number of
96 bytes of data written (i.e. the length of the digest) will be written
97 to the integer at B<s>, at most B<EVP_MAX_MD_SIZE> bytes will be written.
98 After calling EVP_DigestFinal_ex() no additional calls to EVP_DigestUpdate()
99 can be made, but EVP_DigestInit_ex() can be called to initialize a new
100 digest operation.
101
102 EVP_DigestFinalXOF() interfaces to extendable-output functions, XOFs,
103 such as SHAKE128 and SHAKE256. It retrieves the digest value from
104 B<ctx> and places it in B<len>-sized <B>md. After calling this function
105 no additional calls to EVP_DigestUpdate() can be made, but
106 EVP_DigestInit_ex() can be called to initialize a new operation.
107
108 EVP_MD_CTX_copy_ex() can be used to copy the message digest state from
109 B<in> to B<out>. This is useful if large amounts of data are to be
110 hashed which only differ in the last few bytes. B<out> must be initialized
111 before calling this function.
112
113 EVP_DigestInit() behaves in the same way as EVP_DigestInit_ex() except
114 the passed context B<ctx> does not have to be initialized, and it always
115 uses the default digest implementation.
116
117 EVP_DigestFinal() is similar to EVP_DigestFinal_ex() except the digest
118 context B<ctx> is automatically cleaned up.
119
120 EVP_MD_CTX_copy() is similar to EVP_MD_CTX_copy_ex() except the destination
121 B<out> does not have to be initialized.
122
123 EVP_MD_size() and EVP_MD_CTX_size() return the size of the message digest
124 when passed an B<EVP_MD> or an B<EVP_MD_CTX> structure, i.e. the size of the
125 hash.
126
127 EVP_MD_block_size() and EVP_MD_CTX_block_size() return the block size of the
128 message digest when passed an B<EVP_MD> or an B<EVP_MD_CTX> structure.
129
130 EVP_MD_type() and EVP_MD_CTX_type() return the NID of the OBJECT IDENTIFIER
131 representing the given message digest when passed an B<EVP_MD> structure.
132 For example EVP_MD_type(EVP_sha1()) returns B<NID_sha1>. This function is
133 normally used when setting ASN1 OIDs.
134
135 EVP_MD_CTX_md() returns the B<EVP_MD> structure corresponding to the passed
136 B<EVP_MD_CTX>.
137
138 EVP_MD_pkey_type() returns the NID of the public key signing algorithm associated
139 with this digest. For example EVP_sha1() is associated with RSA so this will
140 return B<NID_sha1WithRSAEncryption>. Since digests and signature algorithms
141 are no longer linked this function is only retained for compatibility
142 reasons.
143
144 EVP_md2(), EVP_md5(), EVP_sha1(), EVP_sha224(), EVP_sha256(),
145 EVP_sha384(), EVP_sha512(), EVP_sha3_224(), EVP_sha3_256(),
146 EVP_sha3_384(), EVP_sha3_512(), EVP_mdc2(), EVP_ripemd160(),
147 EVP_blake2b512(), and EVP_blake2s256() return B<EVP_MD> structures for
148 the MD2, MD5, SHA1, SHA224, SHA256, SHA384, SHA512, SHA3-224, SHA3-256,
149 SHA3-384, SHA3-512, MDC2, RIPEMD160, BLAKE2b-512, and BLAKE2s-256 digest
150 algorithms respectively.
151
152 EVP_md_null() is a "null" message digest that does nothing: i.e. the hash it
153 returns is of zero length.
154
155 EVP_get_digestbyname(), EVP_get_digestbynid() and EVP_get_digestbyobj()
156 return an B<EVP_MD> structure when passed a digest name, a digest NID or
157 an ASN1_OBJECT structure respectively.
158
159 =head1 RETURN VALUES
160
161 EVP_DigestInit_ex(), EVP_DigestUpdate() and EVP_DigestFinal_ex() return 1 for
162 success and 0 for failure.
163
164 EVP_MD_CTX_ctrl() returns 1 if successful or 0 for failure.
165
166 EVP_MD_CTX_copy_ex() returns 1 if successful or 0 for failure.
167
168 EVP_MD_type(), EVP_MD_pkey_type() and EVP_MD_type() return the NID of the
169 corresponding OBJECT IDENTIFIER or NID_undef if none exists.
170
171 EVP_MD_size(), EVP_MD_block_size(), EVP_MD_CTX_size() and
172 EVP_MD_CTX_block_size() return the digest or block size in bytes.
173
174 EVP_md_null(), EVP_md2(), EVP_md5(), EVP_sha1(),
175 EVP_mdc2(), EVP_ripemd160(), EVP_blake2b512(), and EVP_blake2s256() return
176 pointers to the corresponding EVP_MD structures.
177
178 EVP_get_digestbyname(), EVP_get_digestbynid() and EVP_get_digestbyobj()
179 return either an B<EVP_MD> structure or NULL if an error occurs.
180
181 =head1 NOTES
182
183 The B<EVP> interface to message digests should almost always be used in
184 preference to the low level interfaces. This is because the code then becomes
185 transparent to the digest used and much more flexible.
186
187 New applications should use the SHA2 digest algorithms such as SHA256.
188 The other digest algorithms are still in common use.
189
190 For most applications the B<impl> parameter to EVP_DigestInit_ex() will be
191 set to NULL to use the default digest implementation.
192
193 The functions EVP_DigestInit(), EVP_DigestFinal() and EVP_MD_CTX_copy() are
194 obsolete but are retained to maintain compatibility with existing code. New
195 applications should use EVP_DigestInit_ex(), EVP_DigestFinal_ex() and
196 EVP_MD_CTX_copy_ex() because they can efficiently reuse a digest context
197 instead of initializing and cleaning it up on each call and allow non default
198 implementations of digests to be specified.
199
200 If digest contexts are not cleaned up after use
201 memory leaks will occur.
202
203 EVP_MD_CTX_size(), EVP_MD_CTX_block_size(), EVP_MD_CTX_type(),
204 EVP_get_digestbynid() and EVP_get_digestbyobj() are defined as
205 macros.
206
207 EVP_MD_CTX_ctrl() sends commands to message digests for additional configuration
208 or control.
209
210 =head1 EXAMPLE
211
212 This example digests the data "Test Message\n" and "Hello World\n", using the
213 digest name passed on the command line.
214
215  #include <stdio.h>
216  #include <openssl/evp.h>
217
218  main(int argc, char *argv[])
219  {
220      EVP_MD_CTX *mdctx;
221      const EVP_MD *md;
222      char mess1[] = "Test Message\n";
223      char mess2[] = "Hello World\n";
224      unsigned char md_value[EVP_MAX_MD_SIZE];
225      int md_len, i;
226
227      if (argv[1] == NULL) {
228          printf("Usage: mdtest digestname\n");
229          exit(1);
230      }
231
232      md = EVP_get_digestbyname(argv[1]);
233      if (md == NULL) {
234          printf("Unknown message digest %s\n", argv[1]);
235          exit(1);
236      }
237
238      mdctx = EVP_MD_CTX_new();
239      EVP_DigestInit_ex(mdctx, md, NULL);
240      EVP_DigestUpdate(mdctx, mess1, strlen(mess1));
241      EVP_DigestUpdate(mdctx, mess2, strlen(mess2));
242      EVP_DigestFinal_ex(mdctx, md_value, &md_len);
243      EVP_MD_CTX_free(mdctx);
244
245      printf("Digest is: ");
246      for (i = 0; i < md_len; i++)
247          printf("%02x", md_value[i]);
248      printf("\n");
249
250      exit(0);
251  }
252
253 =head1 SEE ALSO
254
255 L<dgst(1)>,
256 L<evp(7)>
257
258 =head1 HISTORY
259
260 EVP_MD_CTX_create() and EVP_MD_CTX_destroy() were renamed to
261 EVP_MD_CTX_new() and EVP_MD_CTX_free() in OpenSSL 1.1.0.
262
263 The link between digests and signing algorithms was fixed in OpenSSL 1.0 and
264 later, so now EVP_sha1() can be used with RSA and DSA.
265
266 EVP_dss1() was removed in OpenSSL 1.1.0
267
268 =head1 COPYRIGHT
269
270 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
271
272 Licensed under the OpenSSL license (the "License").  You may not use
273 this file except in compliance with the License.  You can obtain a copy
274 in the file LICENSE in the source distribution or at
275 L<https://www.openssl.org/source/license.html>.
276
277 =cut