xref: /curl/lib/curl_hmac.h (revision ad1c49bc)
1 #ifndef HEADER_CURL_HMAC_H
2 #define HEADER_CURL_HMAC_H
3 /***************************************************************************
4  *                                  _   _ ____  _
5  *  Project                     ___| | | |  _ \| |
6  *                             / __| | | | |_) | |
7  *                            | (__| |_| |  _ <| |___
8  *                             \___|\___/|_| \_\_____|
9  *
10  * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
11  *
12  * This software is licensed as described in the file COPYING, which
13  * you should have received as part of this distribution. The terms
14  * are also available at https://curl.se/docs/copyright.html.
15  *
16  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17  * copies of the Software, and permit persons to whom the Software is
18  * furnished to do so, under the terms of the COPYING file.
19  *
20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21  * KIND, either express or implied.
22  *
23  * SPDX-License-Identifier: curl
24  *
25  ***************************************************************************/
26 
27 #if (defined(USE_CURL_NTLM_CORE) && !defined(USE_WINDOWS_SSPI))         \
28   || !defined(CURL_DISABLE_AWS) || !defined(CURL_DISABLE_DIGEST_AUTH)   \
29   || defined(USE_LIBSSH2)
30 
31 #include <curl/curl.h>
32 
33 #define HMAC_MD5_LENGTH 16
34 
35 typedef CURLcode (*HMAC_hinit)(void *context);
36 typedef void    (*HMAC_hupdate)(void *context,
37                                 const unsigned char *data,
38                                 unsigned int len);
39 typedef void    (*HMAC_hfinal)(unsigned char *result, void *context);
40 
41 /* Per-hash function HMAC parameters. */
42 struct HMAC_params {
43   HMAC_hinit       hinit;     /* Initialize context procedure. */
44   HMAC_hupdate     hupdate;   /* Update context with data. */
45   HMAC_hfinal      hfinal;    /* Get final result procedure. */
46   unsigned int     ctxtsize;  /* Context structure size. */
47   unsigned int     maxkeylen; /* Maximum key length (bytes). */
48   unsigned int     resultlen; /* Result length (bytes). */
49 };
50 
51 
52 /* HMAC computation context. */
53 struct HMAC_context {
54   const struct HMAC_params *hash; /* Hash function definition. */
55   void *hashctxt1;         /* Hash function context 1. */
56   void *hashctxt2;         /* Hash function context 2. */
57 };
58 
59 
60 /* Prototypes. */
61 struct HMAC_context *Curl_HMAC_init(const struct HMAC_params *hashparams,
62                                     const unsigned char *key,
63                                     unsigned int keylen);
64 int Curl_HMAC_update(struct HMAC_context *context,
65                      const unsigned char *data,
66                      unsigned int len);
67 int Curl_HMAC_final(struct HMAC_context *context, unsigned char *result);
68 
69 CURLcode Curl_hmacit(const struct HMAC_params *hashparams,
70                      const unsigned char *key, const size_t keylen,
71                      const unsigned char *data, const size_t datalen,
72                      unsigned char *output);
73 
74 #endif
75 
76 #endif /* HEADER_CURL_HMAC_H */
77