1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.] */
56 
57 #ifndef OPENSSL_HEADER_DIGEST_H
58 #define OPENSSL_HEADER_DIGEST_H
59 
60 #include <openssl/base.h>
61 
62 #if defined(__cplusplus)
63 extern "C" {
64 #endif
65 
66 
67 // Digest functions.
68 //
69 // An EVP_MD abstracts the details of a specific hash function allowing code to
70 // deal with the concept of a "hash function" without needing to know exactly
71 // which hash function it is.
72 
73 
74 // Hash algorithms.
75 //
76 // The following functions return |EVP_MD| objects that implement the named hash
77 // function.
78 
79 OPENSSL_EXPORT const EVP_MD *EVP_md4(void);
80 OPENSSL_EXPORT const EVP_MD *EVP_md5(void);
81 OPENSSL_EXPORT const EVP_MD *EVP_sha1(void);
82 OPENSSL_EXPORT const EVP_MD *EVP_sha224(void);
83 OPENSSL_EXPORT const EVP_MD *EVP_sha256(void);
84 OPENSSL_EXPORT const EVP_MD *EVP_sha384(void);
85 OPENSSL_EXPORT const EVP_MD *EVP_sha512(void);
86 OPENSSL_EXPORT const EVP_MD *EVP_sha512_256(void);
87 OPENSSL_EXPORT const EVP_MD *EVP_blake2b256(void);
88 
89 // EVP_md5_sha1 is a TLS-specific |EVP_MD| which computes the concatenation of
90 // MD5 and SHA-1, as used in TLS 1.1 and below.
91 OPENSSL_EXPORT const EVP_MD *EVP_md5_sha1(void);
92 
93 // EVP_get_digestbynid returns an |EVP_MD| for the given NID, or NULL if no
94 // such digest is known.
95 OPENSSL_EXPORT const EVP_MD *EVP_get_digestbynid(int nid);
96 
97 // EVP_get_digestbyobj returns an |EVP_MD| for the given |ASN1_OBJECT|, or NULL
98 // if no such digest is known.
99 OPENSSL_EXPORT const EVP_MD *EVP_get_digestbyobj(const ASN1_OBJECT *obj);
100 
101 
102 // Digest contexts.
103 //
104 // An EVP_MD_CTX represents the state of a specific digest operation in
105 // progress.
106 
107 // EVP_MD_CTX_init initialises an, already allocated, |EVP_MD_CTX|. This is the
108 // same as setting the structure to zero.
109 OPENSSL_EXPORT void EVP_MD_CTX_init(EVP_MD_CTX *ctx);
110 
111 // EVP_MD_CTX_new allocates and initialises a fresh |EVP_MD_CTX| and returns
112 // it, or NULL on allocation failure. The caller must use |EVP_MD_CTX_free| to
113 // release the resulting object.
114 OPENSSL_EXPORT EVP_MD_CTX *EVP_MD_CTX_new(void);
115 
116 // EVP_MD_CTX_cleanup frees any resources owned by |ctx| and resets it to a
117 // freshly initialised state. It does not free |ctx| itself. It returns one.
118 OPENSSL_EXPORT int EVP_MD_CTX_cleanup(EVP_MD_CTX *ctx);
119 
120 // EVP_MD_CTX_free calls |EVP_MD_CTX_cleanup| and then frees |ctx| itself.
121 OPENSSL_EXPORT void EVP_MD_CTX_free(EVP_MD_CTX *ctx);
122 
123 // EVP_MD_CTX_copy_ex sets |out|, which must already be initialised, to be a
124 // copy of |in|. It returns one on success and zero on allocation failure.
125 OPENSSL_EXPORT int EVP_MD_CTX_copy_ex(EVP_MD_CTX *out, const EVP_MD_CTX *in);
126 
127 // EVP_MD_CTX_reset calls |EVP_MD_CTX_cleanup| followed by |EVP_MD_CTX_init|. It
128 // returns one.
129 OPENSSL_EXPORT int EVP_MD_CTX_reset(EVP_MD_CTX *ctx);
130 
131 
132 // Digest operations.
133 
134 // EVP_DigestInit_ex configures |ctx|, which must already have been
135 // initialised, for a fresh hashing operation using |type|. It returns one on
136 // success and zero on allocation failure.
137 OPENSSL_EXPORT int EVP_DigestInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type,
138                                      ENGINE *engine);
139 
140 // EVP_DigestInit acts like |EVP_DigestInit_ex| except that |ctx| is
141 // initialised before use.
142 OPENSSL_EXPORT int EVP_DigestInit(EVP_MD_CTX *ctx, const EVP_MD *type);
143 
144 // EVP_DigestUpdate hashes |len| bytes from |data| into the hashing operation
145 // in |ctx|. It returns one.
146 OPENSSL_EXPORT int EVP_DigestUpdate(EVP_MD_CTX *ctx, const void *data,
147                                     size_t len);
148 
149 // EVP_MAX_MD_SIZE is the largest digest size supported, in bytes.
150 // Functions that output a digest generally require the buffer have
151 // at least this much space.
152 #define EVP_MAX_MD_SIZE 64  // SHA-512 is the longest so far.
153 
154 // EVP_MAX_MD_BLOCK_SIZE is the largest digest block size supported, in
155 // bytes.
156 #define EVP_MAX_MD_BLOCK_SIZE 128  // SHA-512 is the longest so far.
157 
158 // EVP_DigestFinal_ex finishes the digest in |ctx| and writes the output to
159 // |md_out|. |EVP_MD_CTX_size| bytes are written, which is at most
160 // |EVP_MAX_MD_SIZE|. If |out_size| is not NULL then |*out_size| is set to the
161 // number of bytes written. It returns one. After this call, the hash cannot be
162 // updated or finished again until |EVP_DigestInit_ex| is called to start
163 // another hashing operation.
164 OPENSSL_EXPORT int EVP_DigestFinal_ex(EVP_MD_CTX *ctx, uint8_t *md_out,
165                                       unsigned int *out_size);
166 
167 // EVP_DigestFinal acts like |EVP_DigestFinal_ex| except that
168 // |EVP_MD_CTX_cleanup| is called on |ctx| before returning.
169 OPENSSL_EXPORT int EVP_DigestFinal(EVP_MD_CTX *ctx, uint8_t *md_out,
170                                    unsigned int *out_size);
171 
172 // EVP_Digest performs a complete hashing operation in one call. It hashes |len|
173 // bytes from |data| and writes the digest to |md_out|. |EVP_MD_CTX_size| bytes
174 // are written, which is at most |EVP_MAX_MD_SIZE|. If |out_size| is not NULL
175 // then |*out_size| is set to the number of bytes written. It returns one on
176 // success and zero otherwise.
177 OPENSSL_EXPORT int EVP_Digest(const void *data, size_t len, uint8_t *md_out,
178                               unsigned int *md_out_size, const EVP_MD *type,
179                               ENGINE *impl);
180 
181 
182 // Digest function accessors.
183 //
184 // These functions allow code to learn details about an abstract hash
185 // function.
186 
187 // EVP_MD_type returns a NID identifying |md|. (For example, |NID_sha256|.)
188 OPENSSL_EXPORT int EVP_MD_type(const EVP_MD *md);
189 
190 // EVP_MD_flags returns the flags for |md|, which is a set of |EVP_MD_FLAG_*|
191 // values, ORed together.
192 OPENSSL_EXPORT uint32_t EVP_MD_flags(const EVP_MD *md);
193 
194 // EVP_MD_size returns the digest size of |md|, in bytes.
195 OPENSSL_EXPORT size_t EVP_MD_size(const EVP_MD *md);
196 
197 // EVP_MD_block_size returns the native block-size of |md|, in bytes.
198 OPENSSL_EXPORT size_t EVP_MD_block_size(const EVP_MD *md);
199 
200 // EVP_MD_FLAG_PKEY_DIGEST indicates that the digest function is used with a
201 // specific public key in order to verify signatures. (For example,
202 // EVP_dss1.)
203 #define EVP_MD_FLAG_PKEY_DIGEST 1
204 
205 // EVP_MD_FLAG_DIGALGID_ABSENT indicates that the parameter type in an X.509
206 // DigestAlgorithmIdentifier representing this digest function should be
207 // undefined rather than NULL.
208 #define EVP_MD_FLAG_DIGALGID_ABSENT 2
209 
210 // EVP_MD_FLAG_XOF indicates that the digest is an extensible-output function
211 // (XOF). This flag is defined for compatibility and will never be set in any
212 // |EVP_MD| in BoringSSL.
213 #define EVP_MD_FLAG_XOF 4
214 
215 
216 // Digest operation accessors.
217 
218 // EVP_MD_CTX_md returns the underlying digest function, or NULL if one has not
219 // been set.
220 OPENSSL_EXPORT const EVP_MD *EVP_MD_CTX_md(const EVP_MD_CTX *ctx);
221 
222 // EVP_MD_CTX_size returns the digest size of |ctx|, in bytes. It
223 // will crash if a digest hasn't been set on |ctx|.
224 OPENSSL_EXPORT size_t EVP_MD_CTX_size(const EVP_MD_CTX *ctx);
225 
226 // EVP_MD_CTX_block_size returns the block size of the digest function used by
227 // |ctx|, in bytes. It will crash if a digest hasn't been set on |ctx|.
228 OPENSSL_EXPORT size_t EVP_MD_CTX_block_size(const EVP_MD_CTX *ctx);
229 
230 // EVP_MD_CTX_type returns a NID describing the digest function used by |ctx|.
231 // (For example, |NID_sha256|.) It will crash if a digest hasn't been set on
232 // |ctx|.
233 OPENSSL_EXPORT int EVP_MD_CTX_type(const EVP_MD_CTX *ctx);
234 
235 
236 // ASN.1 functions.
237 //
238 // These functions allow code to parse and serialize AlgorithmIdentifiers for
239 // hash functions.
240 
241 // EVP_parse_digest_algorithm parses an AlgorithmIdentifier structure containing
242 // a hash function OID (for example, 2.16.840.1.101.3.4.2.1 is SHA-256) and
243 // advances |cbs|. The parameters field may either be omitted or a NULL. It
244 // returns the digest function or NULL on error.
245 OPENSSL_EXPORT const EVP_MD *EVP_parse_digest_algorithm(CBS *cbs);
246 
247 // EVP_marshal_digest_algorithm marshals |md| as an AlgorithmIdentifier
248 // structure and appends the result to |cbb|. It returns one on success and zero
249 // on error.
250 OPENSSL_EXPORT int EVP_marshal_digest_algorithm(CBB *cbb, const EVP_MD *md);
251 
252 
253 // Deprecated functions.
254 
255 // EVP_MD_CTX_copy sets |out|, which must /not/ be initialised, to be a copy of
256 // |in|. It returns one on success and zero on error.
257 OPENSSL_EXPORT int EVP_MD_CTX_copy(EVP_MD_CTX *out, const EVP_MD_CTX *in);
258 
259 // EVP_add_digest does nothing and returns one. It exists only for
260 // compatibility with OpenSSL.
261 OPENSSL_EXPORT int EVP_add_digest(const EVP_MD *digest);
262 
263 // EVP_get_digestbyname returns an |EVP_MD| given a human readable name in
264 // |name|, or NULL if the name is unknown.
265 OPENSSL_EXPORT const EVP_MD *EVP_get_digestbyname(const char *);
266 
267 // EVP_dss1 returns the value of EVP_sha1(). This was provided by OpenSSL to
268 // specifiy the original DSA signatures, which were fixed to use SHA-1. Note,
269 // however, that attempting to sign or verify DSA signatures with the EVP
270 // interface will always fail.
271 OPENSSL_EXPORT const EVP_MD *EVP_dss1(void);
272 
273 // EVP_MD_CTX_create calls |EVP_MD_CTX_new|.
274 OPENSSL_EXPORT EVP_MD_CTX *EVP_MD_CTX_create(void);
275 
276 // EVP_MD_CTX_destroy calls |EVP_MD_CTX_free|.
277 OPENSSL_EXPORT void EVP_MD_CTX_destroy(EVP_MD_CTX *ctx);
278 
279 // EVP_DigestFinalXOF returns zero and adds an error to the error queue.
280 // BoringSSL does not support any XOF digests.
281 OPENSSL_EXPORT int EVP_DigestFinalXOF(EVP_MD_CTX *ctx, uint8_t *out,
282                                       size_t len);
283 
284 // EVP_MD_meth_get_flags calls |EVP_MD_flags|.
285 OPENSSL_EXPORT uint32_t EVP_MD_meth_get_flags(const EVP_MD *md);
286 
287 // EVP_MD_CTX_set_flags does nothing.
288 OPENSSL_EXPORT void EVP_MD_CTX_set_flags(EVP_MD_CTX *ctx, int flags);
289 
290 // EVP_MD_CTX_FLAG_NON_FIPS_ALLOW is meaningless. In OpenSSL it permits non-FIPS
291 // algorithms in FIPS mode. But BoringSSL FIPS mode doesn't prohibit algorithms
292 // (it's up the the caller to use the FIPS module in a fashion compliant with
293 // their needs). Thus this exists only to allow code to compile.
294 #define EVP_MD_CTX_FLAG_NON_FIPS_ALLOW 0
295 
296 
297 struct evp_md_pctx_ops;
298 
299 struct env_md_ctx_st {
300   // digest is the underlying digest function, or NULL if not set.
301   const EVP_MD *digest;
302   // md_data points to a block of memory that contains the hash-specific
303   // context.
304   void *md_data;
305 
306   // pctx is an opaque (at this layer) pointer to additional context that
307   // EVP_PKEY functions may store in this object.
308   EVP_PKEY_CTX *pctx;
309 
310   // pctx_ops, if not NULL, points to a vtable that contains functions to
311   // manipulate |pctx|.
312   const struct evp_md_pctx_ops *pctx_ops;
313 } /* EVP_MD_CTX */;
314 
315 
316 #if defined(__cplusplus)
317 }  // extern C
318 
319 #if !defined(BORINGSSL_NO_CXX)
320 extern "C++" {
321 
322 BSSL_NAMESPACE_BEGIN
323 
324 BORINGSSL_MAKE_DELETER(EVP_MD_CTX, EVP_MD_CTX_free)
325 
326 using ScopedEVP_MD_CTX =
327     internal::StackAllocated<EVP_MD_CTX, int, EVP_MD_CTX_init,
328                              EVP_MD_CTX_cleanup>;
329 
330 BSSL_NAMESPACE_END
331 
332 }  // extern C++
333 #endif
334 
335 #endif
336 
337 #define DIGEST_R_INPUT_NOT_INITIALIZED 100
338 #define DIGEST_R_DECODE_ERROR 101
339 #define DIGEST_R_UNKNOWN_HASH 102
340 
341 #endif  // OPENSSL_HEADER_DIGEST_H
342