| 1 |
/* Copyright (C) 1995-1998 Eric Young ([email protected]) |
| 2 |
* All rights reserved. |
| 3 |
* |
| 4 |
* This package is an SSL implementation written |
| 5 |
* by Eric Young ([email protected]). |
| 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 ([email protected]). |
| 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 ([email protected])" |
| 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 ([email protected])" |
| 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_HMAC_H |
| 58 |
#define OPENSSL_HEADER_HMAC_H |
| 59 |
|
| 60 |
#include <openssl/base.h> |
| 61 |
|
| 62 |
#include <openssl/digest.h> |
| 63 |
|
| 64 |
#if defined(__cplusplus) |
| 65 |
extern "C" { |
| 66 |
#endif |
| 67 |
|
| 68 |
|
| 69 |
/* HMAC contains functions for constructing PRFs from Merkle–Damgård hash |
| 70 |
* functions using HMAC. */ |
| 71 |
|
| 72 |
|
| 73 |
/* One-shot operation. */ |
| 74 |
|
| 75 |
/* HMAC calculates the HMAC of |data_len| bytes of |data|, using the given key |
| 76 |
* and hash function, and writes the result to |out|. On entry, |out| must |
| 77 |
* contain |EVP_MAX_MD_SIZE| bytes of space. The actual length of the result is |
| 78 |
* written to |*out_len|. It returns |out| or NULL on error. */ |
| 79 |
OPENSSL_EXPORT uint8_t *HMAC(const EVP_MD *evp_md, const void *key, |
| 80 |
size_t key_len, const uint8_t *data, |
| 81 |
size_t data_len, uint8_t *out, |
| 82 |
unsigned int *out_len); |
| 83 |
|
| 84 |
|
| 85 |
/* Incremental operation. */ |
| 86 |
|
| 87 |
/* HMAC_CTX_init initialises |ctx| for use in an HMAC operation. It's assumed |
| 88 |
* that HMAC_CTX objects will be allocated on the stack thus no allocation |
| 89 |
* function is provided. If needed, allocate |sizeof(HMAC_CTX)| and call |
| 90 |
* |HMAC_CTX_init| on it. */ |
| 91 |
OPENSSL_EXPORT void HMAC_CTX_init(HMAC_CTX *ctx); |
| 92 |
|
| 93 |
/* HMAC_CTX_cleanup frees data owned by |ctx|. */ |
| 94 |
OPENSSL_EXPORT void HMAC_CTX_cleanup(HMAC_CTX *ctx); |
| 95 |
|
| 96 |
/* HMAC_Init_ex sets up an initialised |HMAC_CTX| to use |md| as the hash |
| 97 |
* function and |key| as the key. For a non-initial call, |md| may be NULL, in |
| 98 |
* which case the previous hash function will be used. If the hash function has |
| 99 |
* not changed and |key| is NULL, |ctx| reuses the previous key. It returns one |
| 100 |
* on success or zero otherwise. |
| 101 |
* |
| 102 |
* WARNING: NULL and empty keys are ambiguous on non-initial calls. Passing NULL |
| 103 |
* |key| but repeating the previous |md| reuses the previous key rather than the |
| 104 |
* empty key. */ |
| 105 |
OPENSSL_EXPORT int HMAC_Init_ex(HMAC_CTX *ctx, const void *key, size_t key_len, |
| 106 |
const EVP_MD *md, ENGINE *impl); |
| 107 |
|
| 108 |
/* HMAC_Update hashes |data_len| bytes from |data| into the current HMAC |
| 109 |
* operation in |ctx|. It returns one. */ |
| 110 |
OPENSSL_EXPORT int HMAC_Update(HMAC_CTX *ctx, const uint8_t *data, |
| 111 |
size_t data_len); |
| 112 |
|
| 113 |
/* HMAC_Final completes the HMAC operation in |ctx| and writes the result to |
| 114 |
* |out| and the sets |*out_len| to the length of the result. On entry, |out| |
| 115 |
* must contain at least |EVP_MAX_MD_SIZE| bytes of space. It returns one on |
| 116 |
* success or zero on error. */ |
| 117 |
OPENSSL_EXPORT int HMAC_Final(HMAC_CTX *ctx, uint8_t *out, |
| 118 |
unsigned int *out_len); |
| 119 |
|
| 120 |
|
| 121 |
/* Utility functions. */ |
| 122 |
|
| 123 |
/* HMAC_size returns the size, in bytes, of the HMAC that will be produced by |
| 124 |
* |ctx|. On entry, |ctx| must have been setup with |HMAC_Init_ex|. */ |
| 125 |
OPENSSL_EXPORT size_t HMAC_size(const HMAC_CTX *ctx); |
| 126 |
|
| 127 |
/* HMAC_CTX_copy_ex sets |dest| equal to |src|. On entry, |dest| must have been |
| 128 |
* initialised by calling |HMAC_CTX_init|. It returns one on success and zero |
| 129 |
* on error. */ |
| 130 |
OPENSSL_EXPORT int HMAC_CTX_copy_ex(HMAC_CTX *dest, const HMAC_CTX *src); |
| 131 |
|
| 132 |
|
| 133 |
/* Deprecated functions. */ |
| 134 |
|
| 135 |
OPENSSL_EXPORT int HMAC_Init(HMAC_CTX *ctx, const void *key, int key_len, |
| 136 |
const EVP_MD *md); |
| 137 |
|
| 138 |
/* HMAC_CTX_copy calls |HMAC_CTX_init| on |dest| and then sets it equal to |
| 139 |
* |src|. On entry, |dest| must /not/ be initialised for an operation with |
| 140 |
* |HMAC_Init_ex|. It returns one on success and zero on error. */ |
| 141 |
OPENSSL_EXPORT int HMAC_CTX_copy(HMAC_CTX *dest, const HMAC_CTX *src); |
| 142 |
|
| 143 |
|
| 144 |
/* Private functions */ |
| 145 |
|
| 146 |
struct hmac_ctx_st { |
| 147 |
const EVP_MD *md; |
| 148 |
EVP_MD_CTX md_ctx; |
| 149 |
EVP_MD_CTX i_ctx; |
| 150 |
EVP_MD_CTX o_ctx; |
| 151 |
} /* HMAC_CTX */; |
| 152 |
|
| 153 |
|
| 154 |
#if defined(__cplusplus) |
| 155 |
} /* extern C */ |
| 156 |
#endif |
| 157 |
|
| 158 |
#endif /* OPENSSL_HEADER_HMAC_H */ |