src/third_party/boringssl/src/include/openssl/digest.h

   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
  87 /* EVP_get_digestbynid returns an |EVP_MD| for the given NID, or NULL if no
  88  * such digest is known. */
  89 OPENSSL_EXPORT const EVP_MD *EVP_get_digestbynid(int nid);
  90
  91 /* EVP_get_digestbyobj returns an |EVP_MD| for the given |ASN1_OBJECT|, or NULL
  92  * if no such digest is known. */
  93 OPENSSL_EXPORT const EVP_MD *EVP_get_digestbyobj(const ASN1_OBJECT *obj);
  94
  95
  96 /* Digest contexts.
  97  *
  98  * An EVP_MD_CTX represents the state of a specific digest operation in
  99  * progress. */
 100
 101 /* EVP_MD_CTX_init initialises an, already allocated, |EVP_MD_CTX|. */
 102 OPENSSL_EXPORT void EVP_MD_CTX_init(EVP_MD_CTX *ctx);
 103
 104 /* EVP_MD_CTX_create allocates and initialises a fresh |EVP_MD_CTX| and returns
 105  * it, or NULL on allocation failure. */
 106 OPENSSL_EXPORT EVP_MD_CTX *EVP_MD_CTX_create(void);
 107
 108 /* EVP_MD_CTX_cleanup frees any resources owned by |ctx| and resets it to a
 109  * freshly initialised state. It does not free |ctx| itself. It returns one. */
 110 OPENSSL_EXPORT int EVP_MD_CTX_cleanup(EVP_MD_CTX *ctx);
 111
 112 /* EVP_MD_CTX_destroy calls |EVP_MD_CTX_cleanup| and then frees |ctx| itself. */
 113 OPENSSL_EXPORT void EVP_MD_CTX_destroy(EVP_MD_CTX *ctx);
 114
 115 /* EVP_MD_CTX_copy_ex sets |out|, which must already be initialised, to be a
 116  * copy of |in|. It returns one on success and zero on error. */
 117 OPENSSL_EXPORT int EVP_MD_CTX_copy_ex(EVP_MD_CTX *out, const EVP_MD_CTX *in);
 118
 119
 120 /* Digest operations. */
 121
 122 /* EVP_DigestInit_ex configures |ctx|, which must already have been
 123  * initialised, for a fresh hashing operation using |type|. It returns one on
 124  * success and zero otherwise. */
 125 OPENSSL_EXPORT int EVP_DigestInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type,
 126                                      ENGINE *engine);
 127
 128 /* EVP_DigestInit acts like |EVP_DigestInit_ex| except that |ctx| is
 129  * initialised before use. */
 130 OPENSSL_EXPORT int EVP_DigestInit(EVP_MD_CTX *ctx, const EVP_MD *type);
 131
 132 /* EVP_DigestUpdate hashes |len| bytes from |data| into the hashing operation
 133  * in |ctx|. It returns one on success and zero otherwise. */
 134 OPENSSL_EXPORT int EVP_DigestUpdate(EVP_MD_CTX *ctx, const void *data,
 135                                     size_t len);
 136
 137 /* EVP_MAX_MD_SIZE is the largest digest size supported. Functions that output
 138  * a digest generally require the buffer have at least this much space. */
 139 #define EVP_MAX_MD_SIZE 64 /* SHA-512 is the longest so far. */
 140
 141 /* EVP_DigestFinal_ex finishes the digest in |ctx| and writes the output to
 142  * |md_out|. At most |EVP_MAX_MD_SIZE| bytes are written. If |out_size| is not
 143  * NULL then |*out_size| is set to the number of bytes written. It returns one
 144  * on success and zero otherwise. After this call, the hash cannot be updated
 145  * or finished again until |EVP_DigestFinal_ex| is called to start another
 146  * hashing operation. */
 147 OPENSSL_EXPORT int EVP_DigestFinal_ex(EVP_MD_CTX *ctx, uint8_t *md_out,
 148                                       unsigned int *out_size);
 149
 150 /* EVP_DigestFinal acts like |EVP_DigestFinal_ex| except that
 151  * |EVP_MD_CTX_cleanup| is called on |ctx| before returning. */
 152 OPENSSL_EXPORT int EVP_DigestFinal(EVP_MD_CTX *ctx, uint8_t *md_out,
 153                                    unsigned int *out_size);
 154
 155 /* EVP_Digest performs a complete hashing operation in one call. It hashes
 156  * |len| bytes from |data| and writes the digest to |md_out|. At most
 157  * |EVP_MAX_MD_SIZE| bytes are written. If |out_size| is not NULL then
 158  * |*out_size| is set to the number of bytes written. It returns one on success
 159  * and zero otherwise. */
 160 OPENSSL_EXPORT int EVP_Digest(const void *data, size_t len, uint8_t *md_out,
 161                               unsigned int *md_out_size, const EVP_MD *type,
 162                               ENGINE *impl);
 163
 164
 165 /* Digest function accessors.
 166  *
 167  * These functions allow code to learn details about an abstract hash
 168  * function. */
 169
 170 /* EVP_MD_type returns a NID identifing |md|. (For example, |NID_md5|.) */
 171 OPENSSL_EXPORT int EVP_MD_type(const EVP_MD *md);
 172
 173 /* EVP_MD_name returns the short name for |md| or NULL if no name is known. */
 174 OPENSSL_EXPORT const char *EVP_MD_name(const EVP_MD *md);
 175
 176 /* EVP_MD_flags returns the flags for |md|, which is a set of |EVP_MD_FLAG_*|
 177  * values, ORed together. */
 178 OPENSSL_EXPORT uint32_t EVP_MD_flags(const EVP_MD *md);
 179
 180 /* EVP_MD_size returns the digest size of |md|, in bytes. */
 181 OPENSSL_EXPORT size_t EVP_MD_size(const EVP_MD *md);
 182
 183 /* EVP_MD_block_size returns the native block-size of |md|. */
 184 OPENSSL_EXPORT size_t EVP_MD_block_size(const EVP_MD *md);
 185
 186 /* EVP_MD_FLAG_PKEY_DIGEST indicates the the digest function is used with a
 187  * specific public key in order to verify signatures. (For example,
 188  * EVP_dss1.) */
 189 #define EVP_MD_FLAG_PKEY_DIGEST 1
 190
 191 /* EVP_MD_FLAG_DIGALGID_ABSENT indicates that the parameter type in an X.509
 192  * DigestAlgorithmIdentifier representing this digest function should be
 193  * undefined rather than NULL. */
 194 #define EVP_MD_FLAG_DIGALGID_ABSENT 2
 195
 196
 197 /* Deprecated functions. */
 198
 199 /* EVP_MD_CTX_copy sets |out|, which must /not/ be initialised, to be a copy of
 200  * |in|. It returns one on success and zero on error. */
 201 OPENSSL_EXPORT int EVP_MD_CTX_copy(EVP_MD_CTX *out, const EVP_MD_CTX *in);
 202
 203 /* EVP_add_digest does nothing and returns one. It exists only for
 204  * compatibility with OpenSSL. */
 205 OPENSSL_EXPORT int EVP_add_digest(const EVP_MD *digest);
 206
 207
 208 /* Digest operation accessors. */
 209
 210 /* EVP_MD_CTX_md returns the underlying digest function, or NULL if one has not
 211  * been set. */
 212 OPENSSL_EXPORT const EVP_MD *EVP_MD_CTX_md(const EVP_MD_CTX *ctx);
 213
 214 /* EVP_MD_CTX_size returns the digest size of |ctx|. It will crash if a digest
 215  * hasn't been set on |ctx|. */
 216 OPENSSL_EXPORT unsigned EVP_MD_CTX_size(const EVP_MD_CTX *ctx);
 217
 218 /* EVP_MD_CTX_block_size returns the block size of the digest function used by
 219  * |ctx|. It will crash if a digest hasn't been set on |ctx|. */
 220 OPENSSL_EXPORT unsigned EVP_MD_CTX_block_size(const EVP_MD_CTX *ctx);
 221
 222 /* EVP_MD_CTX_type returns a NID describing the digest function used by |ctx|.
 223  * (For example, |NID_md5|.) It will crash if a digest hasn't been set on
 224  * |ctx|. */
 225 OPENSSL_EXPORT int EVP_MD_CTX_type(const EVP_MD_CTX *ctx);
 226
 227 /* EVP_MD_CTX_set_flags ORs |flags| into the flags member of |ctx|. */
 228 OPENSSL_EXPORT void EVP_MD_CTX_set_flags(EVP_MD_CTX *ctx, uint32_t flags);
 229
 230 /* EVP_MD_CTX_clear_flags clears any bits from the flags member of |ctx| that
 231  * are set in |flags|. */
 232 OPENSSL_EXPORT void EVP_MD_CTX_clear_flags(EVP_MD_CTX *ctx, uint32_t flags);
 233
 234 /* EVP_MD_CTX_test_flags returns the AND of |flags| and the flags member of
 235  * |ctx|. */
 236 OPENSSL_EXPORT uint32_t
 237     EVP_MD_CTX_test_flags(const EVP_MD_CTX *ctx, uint32_t flags);
 238
 239
 240 struct evp_md_pctx_ops;
 241
 242 struct env_md_ctx_st {
 243   /* digest is the underlying digest function, or NULL if not set. */
 244   const EVP_MD *digest;
 245   /* flags is the OR of a number of |EVP_MD_CTX_FLAG_*| values. */
 246   uint32_t flags;
 247   /* md_data points to a block of memory that contains the hash-specific
 248    * context. */
 249   void *md_data;
 250   /* update is usually copied from |digest->update| but can differ in some
 251    * cases, i.e. HMAC. */
 252   int (*update)(EVP_MD_CTX *ctx, const void *data, size_t count);
 253
 254   /* pctx is an opaque (at this layer) pointer to additional context that
 255    * EVP_PKEY functions may store in this object. */
 256   EVP_PKEY_CTX *pctx;
 257
 258   /* pctx_ops, if not NULL, points to a vtable that contains functions to
 259    * manipulate |pctx|. */
 260   const struct evp_md_pctx_ops *pctx_ops;
 261 } /* EVP_MD_CTX */;
 262
 263 /* EVP_MD_CTX_FLAG_NO_INIT causes the |EVP_MD|'s |init| function not to be
 264  * called, the |update| member not to be copied from the |EVP_MD| in
 265  * |EVP_DigestInit_ex| and for |md_data| not to be initialised. */
 266 #define EVP_MD_CTX_FLAG_NO_INIT 1
 267
 268
 269 #if defined(__cplusplus)
 270 }  /* extern C */
 271 #endif
 272
 273 #define DIGEST_F_EVP_DigestInit_ex 100
 274 #define DIGEST_F_EVP_MD_CTX_copy_ex 101
 275 #define DIGEST_R_INPUT_NOT_INITIALIZED 100
 276
 277 #endif  /* OPENSSL_HEADER_DIGEST_H */