2 Copyright (c) 2010 Nils Durner
4 Permission is hereby granted, free of charge, to any person obtaining a copy
5 of this software and associated documentation files (the "Software"), to deal
6 in the Software without restriction, including without limitation the rights
7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 copies of the Software, and to permit persons to whom the Software is
9 furnished to do so, subject to the following conditions:
11 The above copyright notice and this permission notice shall be included in
12 all copies or substantial portions of the Software.
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * @file src/util/crypto_hkdf.c
25 * @brief Hash-based KDF as defined in RFC 5869
26 * @see http://www.rfc-editor.org/rfc/rfc5869.txt
33 #include "gnunet_crypto_lib.h"
35 #define DEBUG_HKDF GNUNET_NO
38 * @brief Compute the HMAC
39 * @param mac gcrypt MAC handle
41 * @param key_len length of key
42 * @param buf message to be processed
43 * @param buf_len length of buf
44 * @return HMAC, freed by caller via gcry_md_close/_reset
47 doHMAC (gcry_md_hd_t mac, const void *key, const size_t key_len,
48 const void *buf, const size_t buf_len)
50 gcry_md_setkey (mac, key, key_len);
51 gcry_md_write (mac, buf, buf_len);
53 return (void *) gcry_md_read (mac, 0);
57 * @brief Generate pseudo-random key
58 * @param mac gcrypt HMAC handle
60 * @param xts_len length of the salt
61 * @param skm source key material
62 * @param skm_len length of skm
63 * @param prk result buffer (allocated by caller; at least gcry_md_dlen() bytes)
64 * @return GNUNET_YES on success
67 getPRK (gcry_md_hd_t mac, const void *xts, const unsigned long long xts_len,
68 const void *skm, const unsigned long long skm_len, void *prk)
72 ret = doHMAC (mac, xts, xts_len, skm, skm_len);
75 memcpy (prk, ret, gcry_md_get_algo_dlen (gcry_md_get_algo (mac)));
81 static void dump(char *src, void *p, unsigned int l)
85 printf("\n%s: ", src);
86 for (i = 0; i < l; i++)
88 printf("%2x", (int) ((unsigned char *) p)[i]);
96 * @param result buffer for the derived key, allocated by caller
97 * @param out_len desired length of the derived key
98 * @param xtr_algo hash algorithm for the extraction phase, GCRY_MD_...
99 * @param prf_algo hash algorithm for the expansion phase, GCRY_MD_...
101 * @param xts_len length of xts
102 * @param skm source key material
103 * @param skm_len length of skm
104 * @param argp va_list of void * & size_t pairs for context chunks
105 * @return GNUNET_YES on success
108 GNUNET_CRYPTO_hkdf_v (void *result, const unsigned long long out_len,
109 int xtr_algo, int prf_algo, const void *xts, const size_t xts_len,
110 const void *skm, const size_t skm_len, va_list argp)
112 void *prk, *hc, *plain;
113 unsigned long long plain_len;
114 unsigned long i, t, d;
115 unsigned int k, xtr_len;
117 gcry_md_hd_t xtr, prf;
122 xtr_len = gcry_md_get_algo_dlen (xtr_algo);
123 k = gcry_md_get_algo_dlen (prf_algo);
124 gcry_md_open(&xtr, xtr_algo, GCRY_MD_FLAG_HMAC);
125 gcry_md_open(&prf, prf_algo, GCRY_MD_FLAG_HMAC);
127 if (out_len > (2 ^ 32 * k) || !xtr_algo || !prf_algo)
128 return GNUNET_SYSERR;
130 va_copy (args, argp);
131 for (ctx_len = 0; va_arg (args, void *);)
132 ctx_len += va_arg (args, size_t);
135 prk = GNUNET_malloc (xtr_len);
137 memset (result, 0, out_len);
139 if (getPRK (xtr, xts, xts_len, skm, skm_len, prk)
143 dump("PRK", prk, xtr_len);
150 plain_len = k + ctx_len + 1;
151 plain = GNUNET_malloc (plain_len);
157 va_copy (args, argp);
158 while ((ctx = va_arg (args, void *)))
162 len = va_arg (args, size_t);
163 memcpy (dst, ctx, len);
171 dump("K(1)", plain, plain_len);
173 hc = doHMAC (prf, prk, xtr_len, plain, ctx_len + 1);
176 memcpy (result, hc, k);
185 va_copy (args, argp);
186 while ((ctx = va_arg (args, void *)))
190 len = va_arg (args, size_t);
191 memcpy (dst, ctx, len);
198 for (i = 1; i < t; i++)
200 memcpy (plain, result - k, k);
201 memset (plain + k + ctx_len, i + 1, 1);
204 dump("K(i+1)", plain, plain_len);
206 hc = doHMAC (prf, prk, xtr_len, plain, plain_len);
209 memcpy (result, hc, k);
217 memcpy (plain, result - k, k);
218 memset (plain + k + ctx_len, i + 1, 1);
221 dump("K(t):d", plain, plain_len);
223 hc = doHMAC (prf, prk, xtr_len, plain, plain_len);
226 memcpy (result, hc, d);
229 dump("result", result - k, out_len);
239 GNUNET_free_non_null (plain);
248 * @param result buffer for the derived key, allocated by caller
249 * @param out_len desired length of the derived key
250 * @param xtr_algo hash algorithm for the extraction phase, GCRY_MD_...
251 * @param prf_algo hash algorithm for the expansion phase, GCRY_MD_...
253 * @param xts_len length of xts
254 * @param skm source key material
255 * @param skm_len length of skm
256 * @param ctx context info
257 * @param ctx_len length of ctx
258 * @return GNUNET_YES on success
261 GNUNET_CRYPTO_hkdf (void *result, const unsigned long long out_len,
262 int xtr_algo, int prf_algo, const void *xts, const size_t xts_len,
263 const void *skm, const size_t skm_len, ...)
268 va_start(argp, skm_len);
269 ret = GNUNET_CRYPTO_hkdf_v (result, out_len, xtr_algo, prf_algo, xts,
270 xts_len, skm, skm_len, argp);
276 /* end of crypto_hkdf.c */