OpenSSL  1.0.1c
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
hmac.h
Go to the documentation of this file.
1 /* crypto/hmac/hmac.h */
2 /* Copyright (C) 1995-1998 Eric Young ([email protected])
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young ([email protected]).
7  * The implementation was written so as to conform with Netscapes SSL.
8  *
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to. The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson ([email protected]).
15  *
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  *
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  * notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  * notice, this list of conditions and the following disclaimer in the
30  * documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  * must display the following acknowledgement:
33  * "This product includes cryptographic software written by
34  * Eric Young ([email protected])"
35  * The word 'cryptographic' can be left out if the rouines from the library
36  * being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from
38  * the apps directory (application code) you must include an acknowledgement:
39  * "This product includes software written by Tim Hudson ([email protected])"
40  *
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  *
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed. i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 #ifndef HEADER_HMAC_H
59 #define HEADER_HMAC_H
60 
61 #include <openssl/opensslconf.h>
62 
63 #ifdef OPENSSL_NO_HMAC
64 #error HMAC is disabled.
65 #endif
66 
67 #include <openssl/evp.h>
68 
69 #define HMAC_MAX_MD_CBLOCK 128 /* largest known is SHA512 */
70 
71 #ifdef __cplusplus
72 extern "C" {
73 #endif
74 
75 typedef struct hmac_ctx_st
76  {
77  const EVP_MD *md;
81  unsigned int key_length;
82  unsigned char key[HMAC_MAX_MD_CBLOCK];
83  } HMAC_CTX;
84 
85 #define HMAC_size(e) (EVP_MD_size((e)->md))
86 
87 
88 void HMAC_CTX_init(HMAC_CTX *ctx);
89 void HMAC_CTX_cleanup(HMAC_CTX *ctx);
90 
91 #define HMAC_cleanup(ctx) HMAC_CTX_cleanup(ctx) /* deprecated */
92 
93 int HMAC_Init(HMAC_CTX *ctx, const void *key, int len,
94  const EVP_MD *md); /* deprecated */
95 int HMAC_Init_ex(HMAC_CTX *ctx, const void *key, int len,
96  const EVP_MD *md, ENGINE *impl);
97 int HMAC_Update(HMAC_CTX *ctx, const unsigned char *data, size_t len);
98 int HMAC_Final(HMAC_CTX *ctx, unsigned char *md, unsigned int *len);
99 unsigned char *HMAC(const EVP_MD *evp_md, const void *key, int key_len,
100  const unsigned char *d, size_t n, unsigned char *md,
101  unsigned int *md_len);
102 int HMAC_CTX_copy(HMAC_CTX *dctx, HMAC_CTX *sctx);
103 
104 void HMAC_CTX_set_flags(HMAC_CTX *ctx, unsigned long flags);
105 
106 #ifdef __cplusplus
107 }
108 #endif
109 
110 #endif