lib/gc-pbkdf2-sha1.c

   1 /* gc-pbkdf2-sha1.c --- Password-Based Key Derivation Function a'la PKCS#5
   2    Copyright (C) 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2, or (at your option)
   7    any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software Foundation,
  16    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  17
  18 /* Written by Simon Josefsson.  The comments in this file are taken
  19    from RFC 2898.  */
  20
  21 #include <config.h>
  22
  23 #include "gc.h"
  24
  25 #include <stdlib.h>
  26 #include <string.h>
  27
  28 /*
  29  * 5.2 PBKDF2
  30  *
  31  *  PBKDF2 applies a pseudorandom function (see Appendix B.1 for an
  32  *  example) to derive keys. The length of the derived key is essentially
  33  *  unbounded. (However, the maximum effective search space for the
  34  *  derived key may be limited by the structure of the underlying
  35  *  pseudorandom function. See Appendix B.1 for further discussion.)
  36  *  PBKDF2 is recommended for new applications.
  37  *
  38  *  PBKDF2 (P, S, c, dkLen)
  39  *
  40  *  Options:        PRF        underlying pseudorandom function (hLen
  41  *                             denotes the length in octets of the
  42  *                             pseudorandom function output)
  43  *
  44  *  Input:          P          password, an octet string (ASCII or UTF-8)
  45  *                  S          salt, an octet string
  46  *                  c          iteration count, a positive integer
  47  *                  dkLen      intended length in octets of the derived
  48  *                             key, a positive integer, at most
  49  *                             (2^32 - 1) * hLen
  50  *
  51  *  Output:         DK         derived key, a dkLen-octet string
  52  */
  53
  54 Gc_rc
  55 gc_pbkdf2_sha1 (const char *P, size_t Plen,
  56                 const char *S, size_t Slen,
  57                 unsigned int c,
  58                 char *DK, size_t dkLen)
  59 {
  60   unsigned int hLen = 20;
  61   char U[20];
  62   char T[20];
  63   unsigned int u;
  64   unsigned int l;
  65   unsigned int r;
  66   unsigned int i;
  67   unsigned int k;
  68   int rc;
  69   char *tmp;
  70   size_t tmplen = Slen + 4;
  71
  72   if (c == 0)
  73     return GC_PKCS5_INVALID_ITERATION_COUNT;
  74
  75   if (dkLen == 0)
  76     return GC_PKCS5_INVALID_DERIVED_KEY_LENGTH;
  77
  78   /*
  79    *
  80    *  Steps:
  81    *
  82    *     1. If dkLen > (2^32 - 1) * hLen, output "derived key too long" and
  83    *        stop.
  84    */
  85
  86   if (dkLen > 4294967295U)
  87     return GC_PKCS5_DERIVED_KEY_TOO_LONG;
  88
  89   /*
  90    *     2. Let l be the number of hLen-octet blocks in the derived key,
  91    *        rounding up, and let r be the number of octets in the last
  92    *        block:
  93    *
  94    *                  l = CEIL (dkLen / hLen) ,
  95    *                  r = dkLen - (l - 1) * hLen .
  96    *
  97    *        Here, CEIL (x) is the "ceiling" function, i.e. the smallest
  98    *        integer greater than, or equal to, x.
  99    */
 100
 101   l = ((dkLen - 1) / hLen) + 1;
 102   r = dkLen - (l - 1) * hLen;
 103
 104   /*
 105    *     3. For each block of the derived key apply the function F defined
 106    *        below to the password P, the salt S, the iteration count c, and
 107    *        the block index to compute the block:
 108    *
 109    *                  T_1 = F (P, S, c, 1) ,
 110    *                  T_2 = F (P, S, c, 2) ,
 111    *                  ...
 112    *                  T_l = F (P, S, c, l) ,
 113    *
 114    *        where the function F is defined as the exclusive-or sum of the
 115    *        first c iterates of the underlying pseudorandom function PRF
 116    *        applied to the password P and the concatenation of the salt S
 117    *        and the block index i:
 118    *
 119    *                  F (P, S, c, i) = U_1 \xor U_2 \xor ... \xor U_c
 120    *
 121    *        where
 122    *
 123    *                  U_1 = PRF (P, S || INT (i)) ,
 124    *                  U_2 = PRF (P, U_1) ,
 125    *                  ...
 126    *                  U_c = PRF (P, U_{c-1}) .
 127    *
 128    *        Here, INT (i) is a four-octet encoding of the integer i, most
 129    *        significant octet first.
 130    *
 131    *     4. Concatenate the blocks and extract the first dkLen octets to
 132    *        produce a derived key DK:
 133    *
 134    *                  DK = T_1 || T_2 ||  ...  || T_l<0..r-1>
 135    *
 136    *     5. Output the derived key DK.
 137    *
 138    *  Note. The construction of the function F follows a "belt-and-
 139    *  suspenders" approach. The iterates U_i are computed recursively to
 140    *  remove a degree of parallelism from an opponent; they are exclusive-
 141    *  ored together to reduce concerns about the recursion degenerating
 142    *  into a small set of values.
 143    *
 144    */
 145
 146   tmp = malloc (tmplen);
 147   if (tmp == NULL)
 148     return GC_MALLOC_ERROR;
 149
 150   memcpy (tmp, S, Slen);
 151
 152   for (i = 1; i <= l; i++)
 153     {
 154       memset (T, 0, hLen);
 155
 156       for (u = 1; u <= c; u++)
 157         {
 158           if (u == 1)
 159             {
 160               tmp[Slen + 0] = (i & 0xff000000) >> 24;
 161               tmp[Slen + 1] = (i & 0x00ff0000) >> 16;
 162               tmp[Slen + 2] = (i & 0x0000ff00) >> 8;
 163               tmp[Slen + 3] = (i & 0x000000ff) >> 0;
 164
 165               rc = gc_hmac_sha1 (P, Plen, tmp, tmplen, U);
 166             }
 167           else
 168             rc = gc_hmac_sha1 (P, Plen, U, hLen, U);
 169
 170           if (rc != GC_OK)
 171             {
 172               free (tmp);
 173               return rc;
 174             }
 175
 176           for (k = 0; k < hLen; k++)
 177             T[k] ^= U[k];
 178         }
 179
 180       memcpy (DK + (i - 1) * hLen, T, i == l ? r : hLen);
 181     }
 182
 183   free (tmp);
 184
 185   return GC_OK;
 186 }