src/util/crypto_hkdf.c

   1 /*
   2     Copyright (c) 2010 Nils Durner
   3
   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:
  10
  11     The above copyright notice and this permission notice shall be included in
  12     all copies or substantial portions of the Software.
  13
  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
  20     THE SOFTWARE.
  21 */
  22
  23 /**
  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
  27  * @todo remove GNUNET references
  28  * @author Nils Durner
  29  *
  30  * The following list of people have reviewed this code and considered
  31  * it correct on the date given (if you reviewed it, please
  32  * have your name added to the list):
  33  *
  34  * - Christian Grothoff (08.10.2010)
  35  * - Nathan Evans (08.10.2010)
  36  * - Matthias Wachs (08.10.2010)
  37  */
  38
  39 #define LOG(kind,...) GNUNET_log_from (kind, "util-crypto-hkdf", __VA_ARGS__)
  40
  41 /**
  42  * Set this to 0 if you compile this code outside of GNUnet.
  43  */
  44 #define GNUNET_BUILD 1
  45
  46 /**
  47  * Enable debugging.
  48  */
  49 #define DEBUG_HKDF 0
  50
  51
  52
  53 #if GNUNET_BUILD
  54 #include "platform.h"
  55 #include "gnunet_crypto_lib.h"
  56 #else
  57 #define GNUNET_NO 0
  58 #define GNUNET_YES 1
  59 #define GNUNET_SYSERR -1
  60 #include <stdlib.h>
  61 #endif
  62
  63 #include <gcrypt.h>
  64
  65
  66 /**
  67  * @brief Compute the HMAC
  68  * @todo use chunked buffers
  69  * @param mac gcrypt MAC handle
  70  * @param key HMAC key
  71  * @param key_len length of key
  72  * @param buf message to be processed
  73  * @param buf_len length of buf
  74  * @return HMAC, freed by caller via gcry_md_close/_reset
  75  */
  76 static const void *
  77 doHMAC (gcry_md_hd_t mac, const void *key, size_t key_len, const void *buf,
  78         size_t buf_len)
  79 {
  80   gcry_md_setkey (mac, key, key_len);
  81   gcry_md_write (mac, buf, buf_len);
  82
  83   return (const void *) gcry_md_read (mac, 0);
  84 }
  85
  86 /**
  87  * @brief Generate pseudo-random key
  88  * @param mac gcrypt HMAC handle
  89  * @param xts salt
  90  * @param xts_len length of the @a xts salt
  91  * @param skm source key material
  92  * @param skm_len length of @a skm
  93  * @param prk result buffer (allocated by caller; at least gcry_md_dlen() bytes)
  94  * @return #GNUNET_YES on success
  95  */
  96 static int
  97 getPRK (gcry_md_hd_t mac, const void *xts, size_t xts_len, const void *skm,
  98         size_t skm_len, void *prk)
  99 {
 100   const void *ret;
 101
 102   ret = doHMAC (mac, xts, xts_len, skm, skm_len);
 103   if (ret == NULL)
 104     return GNUNET_SYSERR;
 105   GNUNET_memcpy (prk, ret, gcry_md_get_algo_dlen (gcry_md_get_algo (mac)));
 106
 107   return GNUNET_YES;
 108 }
 109
 110
 111 #if DEBUG_HKDF
 112 static void
 113 dump (const char *src, const void *p, unsigned int l)
 114 {
 115   unsigned int i;
 116
 117   printf ("\n%s: ", src);
 118   for (i = 0; i < l; i++)
 119   {
 120     printf ("%2x", (int) ((const unsigned char *) p)[i]);
 121   }
 122   printf ("\n");
 123 }
 124 #endif
 125
 126
 127 /**
 128  * @brief Derive key
 129  * @param result buffer for the derived key, allocated by caller
 130  * @param out_len desired length of the derived key
 131  * @param xtr_algo hash algorithm for the extraction phase, GCRY_MD_...
 132  * @param prf_algo hash algorithm for the expansion phase, GCRY_MD_...
 133  * @param xts salt
 134  * @param xts_len length of @a xts
 135  * @param skm source key material
 136  * @param skm_len length of @a skm
 137  * @param argp va_list of void * & size_t pairs for context chunks
 138  * @return #GNUNET_YES on success
 139  */
 140 int
 141 GNUNET_CRYPTO_hkdf_v (void *result, size_t out_len, int xtr_algo, int prf_algo,
 142                       const void *xts, size_t xts_len, const void *skm,
 143                       size_t skm_len, va_list argp)
 144 {
 145   gcry_md_hd_t xtr;
 146   gcry_md_hd_t prf;
 147   const void *hc;
 148   unsigned long i;
 149   unsigned long t;
 150   unsigned long d;
 151   unsigned int k = gcry_md_get_algo_dlen (prf_algo);
 152   unsigned int xtr_len = gcry_md_get_algo_dlen (xtr_algo);
 153   char prk[xtr_len];
 154   int ret;
 155   size_t ctx_len;
 156   va_list args;
 157
 158   if (0 == k)
 159     return GNUNET_SYSERR;
 160   if (GPG_ERR_NO_ERROR !=
 161       gcry_md_open (&xtr, xtr_algo, GCRY_MD_FLAG_HMAC))
 162     return GNUNET_SYSERR;
 163   if (GPG_ERR_NO_ERROR !=
 164       gcry_md_open (&prf, prf_algo, GCRY_MD_FLAG_HMAC))
 165   {
 166     gcry_md_close (xtr);
 167     return GNUNET_SYSERR;
 168   }
 169   va_copy (args, argp);
 170
 171   ctx_len = 0;
 172   while (NULL != va_arg (args, void *))
 173          ctx_len += va_arg (args, size_t);
 174
 175   va_end (args);
 176
 177   memset (result, 0, out_len);
 178   if (getPRK (xtr, xts, xts_len, skm, skm_len, prk) != GNUNET_YES)
 179     goto hkdf_error;
 180 #if DEBUG_HKDF
 181   dump ("PRK", prk, xtr_len);
 182 #endif
 183
 184   t = out_len / k;
 185   d = out_len % k;
 186
 187   /* K(1) */
 188   {
 189     size_t plain_len = k + ctx_len + 1;
 190     char plain[plain_len];
 191     const void *ctx;
 192     char *dst;
 193
 194     dst = plain + k;
 195     va_copy (args, argp);
 196     while ((ctx = va_arg (args, void *)))
 197     {
 198       size_t len;
 199
 200       len = va_arg (args, size_t);
 201       GNUNET_memcpy (dst, ctx, len);
 202       dst += len;
 203     }
 204     va_end (args);
 205
 206     if (t > 0)
 207     {
 208       memset (plain + k + ctx_len, 1, 1);
 209 #if DEBUG_HKDF
 210       dump ("K(1)", plain, plain_len);
 211 #endif
 212       hc = doHMAC (prf, prk, xtr_len, &plain[k], ctx_len + 1);
 213       if (hc == NULL)
 214         goto hkdf_error;
 215       GNUNET_memcpy (result, hc, k);
 216       result += k;
 217     }
 218
 219     /* K(i+1) */
 220     for (i = 1; i < t; i++)
 221     {
 222       GNUNET_memcpy (plain, result - k, k);
 223       memset (plain + k + ctx_len, i + 1, 1);
 224       gcry_md_reset (prf);
 225 #if DEBUG_HKDF
 226       dump ("K(i+1)", plain, plain_len);
 227 #endif
 228       hc = doHMAC (prf, prk, xtr_len, plain, plain_len);
 229       if (hc == NULL)
 230         goto hkdf_error;
 231       GNUNET_memcpy (result, hc, k);
 232       result += k;
 233     }
 234
 235     /* K(t):d */
 236     if (d > 0)
 237     {
 238       if (t > 0)
 239       {
 240         GNUNET_memcpy (plain, result - k, k);
 241         i++;
 242       }
 243       memset (plain + k + ctx_len, i, 1);
 244       gcry_md_reset (prf);
 245 #if DEBUG_HKDF
 246       dump ("K(t):d", plain, plain_len);
 247 #endif
 248       if (t > 0)
 249         hc = doHMAC (prf, prk, xtr_len, plain, plain_len);
 250       else
 251         hc = doHMAC (prf, prk, xtr_len, plain + k, plain_len - k);
 252       if (hc == NULL)
 253         goto hkdf_error;
 254       GNUNET_memcpy (result, hc, d);
 255     }
 256 #if DEBUG_HKDF
 257     dump ("result", result - k, out_len);
 258 #endif
 259
 260     ret = GNUNET_YES;
 261     goto hkdf_ok;
 262   }
 263 hkdf_error:
 264   ret = GNUNET_SYSERR;
 265 hkdf_ok:
 266   gcry_md_close (xtr);
 267   gcry_md_close (prf);
 268   return ret;
 269 }
 270
 271
 272 /**
 273  * @brief Derive key
 274  * @param result buffer for the derived key, allocated by caller
 275  * @param out_len desired length of the derived key
 276  * @param xtr_algo hash algorithm for the extraction phase, GCRY_MD_...
 277  * @param prf_algo hash algorithm for the expansion phase, GCRY_MD_...
 278  * @param xts salt
 279  * @param xts_len length of @a xts
 280  * @param skm source key material
 281  * @param skm_len length of @a skm
 282  * @return #GNUNET_YES on success
 283  */
 284 int
 285 GNUNET_CRYPTO_hkdf (void *result, size_t out_len, int xtr_algo, int prf_algo,
 286                     const void *xts, size_t xts_len, const void *skm,
 287                     size_t skm_len, ...)
 288 {
 289   va_list argp;
 290   int ret;
 291
 292   va_start (argp, skm_len);
 293   ret =
 294       GNUNET_CRYPTO_hkdf_v (result, out_len, xtr_algo, prf_algo, xts, xts_len,
 295                             skm, skm_len, argp);
 296   va_end (argp);
 297
 298   return ret;
 299 }
 300
 301 /* end of crypto_hkdf.c */