src/util/crypto_hash.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2004, 2005, 2006, 2009 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 2, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19
  20      SHA-512 code by Jean-Luc Cooke <jlcooke@certainkey.com>
  21
  22      Copyright (c) Jean-Luc Cooke <jlcooke@certainkey.com>
  23      Copyright (c) Andrew McDonald <andrew@mcdonald.org.uk>
  24      Copyright (c) 2003 Kyle McMartin <kyle@debian.org>
  25 */
  26
  27 /**
  28  * @file util/crypto_hash.c
  29  * @brief SHA-512 GNUNET_CRYPTO_hash related functions
  30  * @author Christian Grothoff
  31  */
  32
  33 #include "platform.h"
  34 #include "gnunet_common.h"
  35 #include "gnunet_crypto_lib.h"
  36 #include "gnunet_disk_lib.h"
  37 #include <gcrypt.h>
  38
  39
  40 /**
  41  * Hash block of given size.
  42  *
  43  * @param block the data to GNUNET_CRYPTO_hash, length is given as a second argument
  44  * @param size the length of the data to GNUNET_CRYPTO_hash
  45  * @param ret pointer to where to write the hashcode
  46  */
  47 void
  48 GNUNET_CRYPTO_hash (const void *block, size_t size, GNUNET_HashCode * ret)
  49 {
  50   gcry_md_hash_buffer (GCRY_MD_SHA512, ret, block, size);
  51 }
  52
  53
  54 /**
  55  * Context used when hashing a file.
  56  */
  57 struct GNUNET_CRYPTO_FileHashContext
  58 {
  59
  60   /**
  61    * Function to call upon completion.
  62    */
  63   GNUNET_CRYPTO_HashCompletedCallback callback;
  64
  65   /**
  66    * Closure for callback.
  67    */
  68   void *callback_cls;
  69
  70   /**
  71    * IO buffer.
  72    */
  73   unsigned char *buffer;
  74
  75   /**
  76    * Name of the file we are hashing.
  77    */
  78   char *filename;
  79
  80   /**
  81    * File descriptor.
  82    */
  83   struct GNUNET_DISK_FileHandle *fh;
  84
  85   /**
  86    * Cummulated hash.
  87    */
  88   gcry_md_hd_t md;
  89
  90   /**
  91    * Size of the file.
  92    */
  93   uint64_t fsize;
  94
  95   /**
  96    * Current offset.
  97    */
  98   uint64_t offset;
  99
 100   /**
 101    * Current task for hashing.
 102    */
 103   GNUNET_SCHEDULER_TaskIdentifier task;
 104
 105   /**
 106    * Blocksize.
 107    */
 108   size_t bsize;
 109
 110 };
 111
 112
 113 /**
 114  * Report result of hash computation to callback
 115  * and free associated resources.
 116  */
 117 static void
 118 file_hash_finish (struct GNUNET_CRYPTO_FileHashContext *fhc,
 119                   const GNUNET_HashCode * res)
 120 {
 121   fhc->callback (fhc->callback_cls, res);
 122   GNUNET_free (fhc->filename);
 123   if (!GNUNET_DISK_handle_invalid (fhc->fh))
 124     GNUNET_break (GNUNET_OK == GNUNET_DISK_file_close (fhc->fh));
 125   gcry_md_close (fhc->md);
 126   GNUNET_free (fhc);            /* also frees fhc->buffer */
 127 }
 128
 129
 130 /**
 131  * File hashing task.
 132  *
 133  * @param cls closure
 134  * @param tc context
 135  */
 136 static void
 137 file_hash_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 138 {
 139   struct GNUNET_CRYPTO_FileHashContext *fhc = cls;
 140   GNUNET_HashCode *res;
 141   size_t delta;
 142
 143   fhc->task = GNUNET_SCHEDULER_NO_TASK;
 144   GNUNET_assert (fhc->offset < fhc->fsize);
 145   delta = fhc->bsize;
 146   if (fhc->fsize - fhc->offset < delta)
 147     delta = fhc->fsize - fhc->offset;
 148   if (delta != GNUNET_DISK_file_read (fhc->fh, fhc->buffer, delta))
 149     {
 150       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
 151                                 "read", fhc->filename);
 152       file_hash_finish (fhc, NULL);
 153       return;
 154     }
 155   gcry_md_write (fhc->md, fhc->buffer, delta);
 156   fhc->offset += delta;
 157   if (fhc->offset == fhc->fsize)
 158     {
 159       res = (GNUNET_HashCode *) gcry_md_read (fhc->md, GCRY_MD_SHA512);
 160       file_hash_finish (fhc, res);
 161       return;
 162     }
 163   fhc->task
 164     = GNUNET_SCHEDULER_add_after (GNUNET_SCHEDULER_NO_TASK,
 165                                   &file_hash_task, fhc);
 166 }
 167
 168
 169 /**
 170  * Compute the hash of an entire file.
 171  *
 172  * @param priority scheduling priority to use
 173  * @param filename name of file to hash
 174  * @param blocksize number of bytes to process in one task
 175  * @param callback function to call upon completion
 176  * @param callback_cls closure for callback
 177  * @return NULL on (immediate) errror
 178  */
 179 struct GNUNET_CRYPTO_FileHashContext *
 180 GNUNET_CRYPTO_hash_file (enum GNUNET_SCHEDULER_Priority priority,
 181                          const char *filename,
 182                          size_t blocksize,
 183                          GNUNET_CRYPTO_HashCompletedCallback callback,
 184                          void *callback_cls)
 185 {
 186   struct GNUNET_CRYPTO_FileHashContext *fhc;
 187
 188   GNUNET_assert (blocksize > 0);
 189   fhc = GNUNET_malloc (sizeof (struct GNUNET_CRYPTO_FileHashContext) + blocksize);
 190   fhc->callback = callback;
 191   fhc->callback_cls = callback_cls;
 192   fhc->buffer = (unsigned char *) &fhc[1];
 193   fhc->filename = GNUNET_strdup (filename);
 194   if (GPG_ERR_NO_ERROR != gcry_md_open (&fhc->md, GCRY_MD_SHA512, 0))
 195     {
 196       GNUNET_break (0);
 197       GNUNET_free (fhc);
 198       return NULL;
 199     }
 200   fhc->bsize = blocksize;
 201   if (GNUNET_OK != GNUNET_DISK_file_size (filename, &fhc->fsize, GNUNET_NO))
 202     {
 203       GNUNET_free (fhc->filename);
 204       GNUNET_free (fhc);
 205       return NULL;
 206     }
 207   fhc->fh = GNUNET_DISK_file_open (filename,
 208                                    GNUNET_DISK_OPEN_READ,
 209                                    GNUNET_DISK_PERM_NONE);
 210   if (!fhc->fh)
 211     {
 212       GNUNET_free (fhc->filename);
 213       GNUNET_free (fhc);
 214       return NULL;
 215     }
 216   fhc->task
 217     = GNUNET_SCHEDULER_add_with_priority (priority,
 218                                           &file_hash_task, fhc);
 219   return fhc;
 220 }
 221
 222
 223 /**
 224  * Cancel a file hashing operation.
 225  *
 226  * @param fhc operation to cancel (callback must not yet have been invoked)
 227  */
 228 void
 229 GNUNET_CRYPTO_hash_file_cancel (struct GNUNET_CRYPTO_FileHashContext *fhc)
 230 {
 231   GNUNET_SCHEDULER_cancel (fhc->task);
 232   GNUNET_free (fhc->filename);
 233   GNUNET_break (GNUNET_OK == GNUNET_DISK_file_close (fhc->fh));
 234   GNUNET_free (fhc);
 235 }
 236
 237
 238
 239 /* ***************** binary-ASCII encoding *************** */
 240
 241 static unsigned int
 242 getValue__ (unsigned char a)
 243 {
 244   if ((a >= '0') && (a <= '9'))
 245     return a - '0';
 246   if ((a >= 'A') && (a <= 'V'))
 247     return (a - 'A' + 10);
 248   return -1;
 249 }
 250
 251 /**
 252  * Convert GNUNET_CRYPTO_hash to ASCII encoding.  The ASCII encoding is rather
 253  * GNUnet specific.  It was chosen such that it only uses characters
 254  * in [0-9A-V], can be produced without complex arithmetics and uses a
 255  * small number of characters.  The GNUnet encoding uses 102
 256  * characters plus a null terminator.
 257  *
 258  * @param block the hash code
 259  * @param result where to store the encoding (struct GNUNET_CRYPTO_HashAsciiEncoded can be
 260  *  safely cast to char*, a '\\0' termination is set).
 261  */
 262 void
 263 GNUNET_CRYPTO_hash_to_enc (const GNUNET_HashCode * block,
 264                            struct GNUNET_CRYPTO_HashAsciiEncoded *result)
 265 {
 266   /**
 267    * 32 characters for encoding (GNUNET_CRYPTO_hash => 32 characters)
 268    */
 269   static char *encTable__ = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
 270   unsigned int wpos;
 271   unsigned int rpos;
 272   unsigned int bits;
 273   unsigned int vbit;
 274
 275   GNUNET_assert (block != NULL);
 276   GNUNET_assert (result != NULL);
 277   vbit = 0;
 278   wpos = 0;
 279   rpos = 0;
 280   bits = 0;
 281   while ((rpos < sizeof (GNUNET_HashCode)) || (vbit > 0))
 282     {
 283       if ((rpos < sizeof (GNUNET_HashCode)) && (vbit < 5))
 284         {
 285           bits = (bits << 8) | ((unsigned char *) block)[rpos++];       /* eat 8 more bits */
 286           vbit += 8;
 287         }
 288       if (vbit < 5)
 289         {
 290           bits <<= (5 - vbit);  /* zero-padding */
 291           GNUNET_assert (vbit == 2);    /* padding by 3: 512+3 mod 5 == 0 */
 292           vbit = 5;
 293         }
 294       GNUNET_assert (wpos <
 295                      sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1);
 296       result->encoding[wpos++] = encTable__[(bits >> (vbit - 5)) & 31];
 297       vbit -= 5;
 298     }
 299   GNUNET_assert (wpos == sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1);
 300   GNUNET_assert (vbit == 0);
 301   result->encoding[wpos] = '\0';
 302 }
 303
 304 /**
 305  * Convert ASCII encoding back to GNUNET_CRYPTO_hash
 306  *
 307  * @param enc the encoding
 308  * @param result where to store the GNUNET_CRYPTO_hash code
 309  * @return GNUNET_OK on success, GNUNET_SYSERR if result has the wrong encoding
 310  */
 311 int
 312 GNUNET_CRYPTO_hash_from_string (const char *enc, GNUNET_HashCode * result)
 313 {
 314   unsigned int rpos;
 315   unsigned int wpos;
 316   unsigned int bits;
 317   unsigned int vbit;
 318
 319   if (strlen (enc) != sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1)
 320     return GNUNET_SYSERR;
 321
 322   vbit = 2;                     /* padding! */
 323   wpos = sizeof (GNUNET_HashCode);
 324   rpos = sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1;
 325   bits = getValue__ (enc[--rpos]) >> 3;
 326   while (wpos > 0)
 327     {
 328       GNUNET_assert (rpos > 0);
 329       bits = (getValue__ (enc[--rpos]) << vbit) | bits;
 330       vbit += 5;
 331       if (vbit >= 8)
 332         {
 333           ((unsigned char *) result)[--wpos] = (unsigned char) bits;
 334           bits >>= 8;
 335           vbit -= 8;
 336         }
 337     }
 338   GNUNET_assert (rpos == 0);
 339   GNUNET_assert (vbit == 0);
 340   return GNUNET_OK;
 341 }
 342
 343 /**
 344  * Compute the distance between 2 hashcodes.  The computation must be
 345  * fast, not involve bits[0] or bits[4] (they're used elsewhere), and be
 346  * somewhat consistent. And of course, the result should be a positive
 347  * number.
 348  *
 349  * @param a some hash code
 350  * @param b some hash code
 351  * @return a positive number which is a measure for
 352  *  hashcode proximity.
 353  */
 354 unsigned int
 355 GNUNET_CRYPTO_hash_distance_u32 (const GNUNET_HashCode * a,
 356                                  const GNUNET_HashCode * b)
 357 {
 358   unsigned int x1 = (a->bits[1] - b->bits[1]) >> 16;
 359   unsigned int x2 = (b->bits[1] - a->bits[1]) >> 16;
 360   return (x1 * x2);
 361 }
 362
 363 void
 364 GNUNET_CRYPTO_hash_create_random (enum GNUNET_CRYPTO_Quality mode,
 365                                   GNUNET_HashCode * result)
 366 {
 367   int i;
 368   for (i = (sizeof (GNUNET_HashCode) / sizeof (uint32_t)) - 1; i >= 0; i--)
 369     result->bits[i] = GNUNET_CRYPTO_random_u32 (mode, UINT32_MAX);
 370 }
 371
 372 void
 373 GNUNET_CRYPTO_hash_difference (const GNUNET_HashCode * a,
 374                                const GNUNET_HashCode * b,
 375                                GNUNET_HashCode * result)
 376 {
 377   int i;
 378   for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0;
 379        i--)
 380     result->bits[i] = b->bits[i] - a->bits[i];
 381 }
 382
 383 void
 384 GNUNET_CRYPTO_hash_sum (const GNUNET_HashCode * a,
 385                         const GNUNET_HashCode * delta,
 386                         GNUNET_HashCode * result)
 387 {
 388   int i;
 389   for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0;
 390        i--)
 391     result->bits[i] = delta->bits[i] + a->bits[i];
 392 }
 393
 394
 395 void
 396 GNUNET_CRYPTO_hash_xor (const GNUNET_HashCode * a,
 397                         const GNUNET_HashCode * b,
 398                         GNUNET_HashCode * result)
 399 {
 400   int i;
 401   for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0;
 402        i--)
 403     result->bits[i] = a->bits[i] ^ b->bits[i];
 404 }
 405
 406
 407 /**
 408  * Convert a hashcode into a key.
 409  */
 410 void
 411 GNUNET_CRYPTO_hash_to_aes_key (const GNUNET_HashCode * hc,
 412                                struct GNUNET_CRYPTO_AesSessionKey *skey,
 413                                struct GNUNET_CRYPTO_AesInitializationVector
 414                                *iv)
 415 {
 416   GNUNET_assert (sizeof (GNUNET_HashCode) >=
 417                  GNUNET_CRYPTO_AES_KEY_LENGTH +
 418                  sizeof (struct GNUNET_CRYPTO_AesInitializationVector));
 419   memcpy (skey, hc, GNUNET_CRYPTO_AES_KEY_LENGTH);
 420   skey->crc32 =
 421     htonl (GNUNET_CRYPTO_crc32_n (skey, GNUNET_CRYPTO_AES_KEY_LENGTH));
 422   memcpy (iv, &((char *) hc)[GNUNET_CRYPTO_AES_KEY_LENGTH],
 423           sizeof (struct GNUNET_CRYPTO_AesInitializationVector));
 424 }
 425
 426
 427 /**
 428  * Obtain a bit from a hashcode.
 429  * @param code the GNUNET_CRYPTO_hash to index bit-wise
 430  * @param bit index into the hashcode, [0...511]
 431  * @return Bit \a bit from hashcode \a code, -1 for invalid index
 432  */
 433 int
 434 GNUNET_CRYPTO_hash_get_bit (const GNUNET_HashCode * code,
 435                             unsigned int bit)
 436 {
 437   GNUNET_assert (bit < 8 * sizeof (GNUNET_HashCode));
 438   return (((unsigned char *) code)[bit >> 3] & (1 << (bit & 7))) > 0;
 439 }
 440
 441 /**
 442  * Determine how many low order bits match in two
 443  * GNUNET_HashCodes.  i.e. - 010011 and 011111 share
 444  * the first two lowest order bits, and therefore the
 445  * return value is two (NOT XOR distance, nor how many
 446  * bits match absolutely!).
 447  *
 448  * @param first the first hashcode
 449  * @param second the hashcode to compare first to
 450  *
 451  * @return the number of bits that match
 452  */
 453 unsigned int
 454 GNUNET_CRYPTO_hash_matching_bits(const GNUNET_HashCode *first,
 455                                  const GNUNET_HashCode *second)
 456 {
 457   unsigned int i;
 458
 459   for (i = 0; i < sizeof (GNUNET_HashCode) * 8; i++)
 460     if (GNUNET_CRYPTO_hash_get_bit (first, i) != GNUNET_CRYPTO_hash_get_bit (second, i))
 461       return i;
 462   return sizeof (GNUNET_HashCode) * 8;
 463 }
 464
 465
 466 /**
 467  * Compare function for HashCodes, producing a total ordering
 468  * of all hashcodes.
 469  * @return 1 if h1 > h2, -1 if h1 < h2 and 0 if h1 == h2.
 470  */
 471 int
 472 GNUNET_CRYPTO_hash_cmp (const GNUNET_HashCode * h1,
 473                         const GNUNET_HashCode * h2)
 474 {
 475   unsigned int *i1;
 476   unsigned int *i2;
 477   int i;
 478
 479   i1 = (unsigned int *) h1;
 480   i2 = (unsigned int *) h2;
 481   for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0;
 482        i--)
 483     {
 484       if (i1[i] > i2[i])
 485         return 1;
 486       if (i1[i] < i2[i])
 487         return -1;
 488     }
 489   return 0;
 490 }
 491
 492
 493 /**
 494  * Find out which of the two GNUNET_CRYPTO_hash codes is closer to target
 495  * in the XOR metric (Kademlia).
 496  * @return -1 if h1 is closer, 1 if h2 is closer and 0 if h1==h2.
 497  */
 498 int
 499 GNUNET_CRYPTO_hash_xorcmp (const GNUNET_HashCode * h1,
 500                            const GNUNET_HashCode * h2,
 501                            const GNUNET_HashCode * target)
 502 {
 503   int i;
 504   unsigned int d1;
 505   unsigned int d2;
 506
 507   for (i = sizeof (GNUNET_HashCode) / sizeof (unsigned int) - 1; i >= 0; i--)
 508     {
 509       d1 = ((unsigned int *) h1)[i] ^ ((unsigned int *) target)[i];
 510       d2 = ((unsigned int *) h2)[i] ^ ((unsigned int *) target)[i];
 511       if (d1 > d2)
 512         return 1;
 513       else if (d1 < d2)
 514         return -1;
 515     }
 516   return 0;
 517 }
 518
 519
 520 /**
 521  * @brief Derive an authentication key
 522  * @param key authentication key
 523  * @param rkey root key
 524  * @param salt salt
 525  * @param salt_len size of the salt
 526  * @param ... pair of void * & size_t for context chunks, terminated by NULL
 527  */
 528 void
 529 GNUNET_CRYPTO_hmac_derive_key(struct GNUNET_CRYPTO_AuthKey *key,
 530                               const struct GNUNET_CRYPTO_AesSessionKey *rkey,
 531                               const void *salt,
 532                               size_t salt_len,
 533                               ...)
 534 {
 535   va_list argp;
 536
 537   va_start (argp, salt_len);
 538   GNUNET_CRYPTO_hmac_derive_key_v (key, rkey, salt, salt_len, argp);
 539   va_end (argp);
 540 }
 541
 542
 543 /**
 544  * @brief Derive an authentication key
 545  * @param key authentication key
 546  * @param rkey root key
 547  * @param salt salt
 548  * @param salt_len size of the salt
 549  * @param argp pair of void * & size_t for context chunks, terminated by NULL
 550  */
 551 void
 552 GNUNET_CRYPTO_hmac_derive_key_v(struct GNUNET_CRYPTO_AuthKey *key,
 553                                 const struct GNUNET_CRYPTO_AesSessionKey *rkey,
 554                                 const void *salt,
 555                                 size_t salt_len,
 556                                 va_list argp)
 557 {
 558   GNUNET_CRYPTO_kdf_v (key->key,
 559                        sizeof(key->key),
 560                        salt, salt_len,
 561                        rkey->key,
 562                        sizeof(rkey->key),
 563                        argp);
 564 }
 565
 566
 567 /**
 568  * Calculate HMAC of a message (RFC 2104)
 569  *
 570  * @param key secret key
 571  * @param plaintext input plaintext
 572  * @param plaintext_len length of plaintext
 573  * @param hmac where to store the hmac
 574  */
 575 void
 576 GNUNET_CRYPTO_hmac (const struct GNUNET_CRYPTO_AuthKey *key,
 577                     const void *plaintext,
 578                     size_t plaintext_len,
 579                     GNUNET_HashCode *hmac)
 580 {
 581   gcry_md_hd_t md;
 582   const unsigned char *mc;
 583
 584   GNUNET_assert (GPG_ERR_NO_ERROR == gcry_md_open (&md,
 585                                                    GCRY_MD_SHA512,
 586                                                    GCRY_MD_FLAG_HMAC));
 587   gcry_md_setkey (md, key->key, sizeof(key->key));
 588   gcry_md_write (md, plaintext, plaintext_len);
 589   mc = gcry_md_read (md, GCRY_MD_SHA512);
 590   if (mc != NULL)
 591     memcpy (hmac->bits, mc, sizeof(hmac->bits));
 592   gcry_md_close (md);
 593 }
 594
 595
 596 /* end of crypto_hash.c */