xref: /third_party/curl/lib/curl_hmac.h (revision 13498266) 
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
35typedef CURLcode (* HMAC_hinit_func)(void *context);
36typedef void    (* HMAC_hupdate_func)(void *context,
37                                      const unsigned char *data,
38                                      unsigned int len);
39typedef void    (* HMAC_hfinal_func)(unsigned char *result, void *context);
40
41
42/* Per-hash function HMAC parameters. */
43struct HMAC_params {
44  HMAC_hinit_func
45  hmac_hinit;     /* Initialize context procedure. */
46  HMAC_hupdate_func     hmac_hupdate;   /* Update context with data. */
47  HMAC_hfinal_func      hmac_hfinal;    /* Get final result procedure. */
48  unsigned int          hmac_ctxtsize;  /* Context structure size. */
49  unsigned int          hmac_maxkeylen; /* Maximum key length (bytes). */
50  unsigned int          hmac_resultlen; /* Result length (bytes). */
51};
52
53
54/* HMAC computation context. */
55struct HMAC_context {
56  const struct HMAC_params *hmac_hash; /* Hash function definition. */
57  void *hmac_hashctxt1;         /* Hash function context 1. */
58  void *hmac_hashctxt2;         /* Hash function context 2. */
59};
60
61
62/* Prototypes. */
63struct HMAC_context *Curl_HMAC_init(const struct HMAC_params *hashparams,
64                                    const unsigned char *key,
65                                    unsigned int keylen);
66int Curl_HMAC_update(struct HMAC_context *context,
67                     const unsigned char *data,
68                     unsigned int len);
69int Curl_HMAC_final(struct HMAC_context *context, unsigned char *result);
70
71CURLcode Curl_hmacit(const struct HMAC_params *hashparams,
72                     const unsigned char *key, const size_t keylen,
73                     const unsigned char *data, const size_t datalen,
74                     unsigned char *output);
75
76#endif
77
78#endif /* HEADER_CURL_HMAC_H */
79