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_now (&file_hash_task, fhc);
 165 }
 166
 167
 168 /**
 169  * Compute the hash of an entire file.
 170  *
 171  * @param priority scheduling priority to use
 172  * @param filename name of file to hash
 173  * @param blocksize number of bytes to process in one task
 174  * @param callback function to call upon completion
 175  * @param callback_cls closure for callback
 176  * @return NULL on (immediate) errror
 177  */
 178 struct GNUNET_CRYPTO_FileHashContext *
 179 GNUNET_CRYPTO_hash_file (enum GNUNET_SCHEDULER_Priority priority,
 180                          const char *filename,
 181                          size_t blocksize,
 182                          GNUNET_CRYPTO_HashCompletedCallback callback,
 183                          void *callback_cls)
 184 {
 185   struct GNUNET_CRYPTO_FileHashContext *fhc;
 186
 187   GNUNET_assert (blocksize > 0);
 188   fhc = GNUNET_malloc (sizeof (struct GNUNET_CRYPTO_FileHashContext) + blocksize);
 189   fhc->callback = callback;
 190   fhc->callback_cls = callback_cls;
 191   fhc->buffer = (unsigned char *) &fhc[1];
 192   fhc->filename = GNUNET_strdup (filename);
 193   if (GPG_ERR_NO_ERROR != gcry_md_open (&fhc->md, GCRY_MD_SHA512, 0))
 194     {
 195       GNUNET_break (0);
 196       GNUNET_free (fhc);
 197       return NULL;
 198     }
 199   fhc->bsize = blocksize;
 200   if (GNUNET_OK != GNUNET_DISK_file_size (filename, &fhc->fsize, GNUNET_NO))
 201     {
 202       GNUNET_free (fhc->filename);
 203       GNUNET_free (fhc);
 204       return NULL;
 205     }
 206   fhc->fh = GNUNET_DISK_file_open (filename,
 207                                    GNUNET_DISK_OPEN_READ,
 208                                    GNUNET_DISK_PERM_NONE);
 209   if (!fhc->fh)
 210     {
 211       GNUNET_free (fhc->filename);
 212       GNUNET_free (fhc);
 213       return NULL;
 214     }
 215   fhc->task
 216     = GNUNET_SCHEDULER_add_with_priority (priority,
 217                                           &file_hash_task, fhc);
 218   return fhc;
 219 }
 220
 221
 222 /**
 223  * Cancel a file hashing operation.
 224  *
 225  * @param fhc operation to cancel (callback must not yet have been invoked)
 226  */
 227 void
 228 GNUNET_CRYPTO_hash_file_cancel (struct GNUNET_CRYPTO_FileHashContext *fhc)
 229 {
 230   GNUNET_SCHEDULER_cancel (fhc->task);
 231   GNUNET_free (fhc->filename);
 232   GNUNET_break (GNUNET_OK == GNUNET_DISK_file_close (fhc->fh));
 233   GNUNET_free (fhc);
 234 }
 235
 236
 237
 238 /* ***************** binary-ASCII encoding *************** */
 239
 240 static unsigned int
 241 getValue__ (unsigned char a)
 242 {
 243   if ((a >= '0') && (a <= '9'))
 244     return a - '0';
 245   if ((a >= 'A') && (a <= 'V'))
 246     return (a - 'A' + 10);
 247   return -1;
 248 }
 249
 250 /**
 251  * Convert GNUNET_CRYPTO_hash to ASCII encoding.  The ASCII encoding is rather
 252  * GNUnet specific.  It was chosen such that it only uses characters
 253  * in [0-9A-V], can be produced without complex arithmetics and uses a
 254  * small number of characters.  The GNUnet encoding uses 103
 255  * characters plus a null terminator.
 256  *
 257  * @param block the hash code
 258  * @param result where to store the encoding (struct GNUNET_CRYPTO_HashAsciiEncoded can be
 259  *  safely cast to char*, a '\\0' termination is set).
 260  */
 261 void
 262 GNUNET_CRYPTO_hash_to_enc (const GNUNET_HashCode * block,
 263                            struct GNUNET_CRYPTO_HashAsciiEncoded *result)
 264 {
 265   /**
 266    * 32 characters for encoding (GNUNET_CRYPTO_hash => 32 characters)
 267    */
 268   static char *encTable__ = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
 269   unsigned int wpos;
 270   unsigned int rpos;
 271   unsigned int bits;
 272   unsigned int vbit;
 273
 274   GNUNET_assert (block != NULL);
 275   GNUNET_assert (result != NULL);
 276   vbit = 0;
 277   wpos = 0;
 278   rpos = 0;
 279   bits = 0;
 280   while ((rpos < sizeof (GNUNET_HashCode)) || (vbit > 0))
 281     {
 282       if ((rpos < sizeof (GNUNET_HashCode)) && (vbit < 5))
 283         {
 284           bits = (bits << 8) | ((unsigned char *) block)[rpos++];       /* eat 8 more bits */
 285           vbit += 8;
 286         }
 287       if (vbit < 5)
 288         {
 289           bits <<= (5 - vbit);  /* zero-padding */
 290           GNUNET_assert (vbit == 2);    /* padding by 3: 512+3 mod 5 == 0 */
 291           vbit = 5;
 292         }
 293       GNUNET_assert (wpos <
 294                      sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1);
 295       result->encoding[wpos++] = encTable__[(bits >> (vbit - 5)) & 31];
 296       vbit -= 5;
 297     }
 298   GNUNET_assert (wpos == sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1);
 299   GNUNET_assert (vbit == 0);
 300   result->encoding[wpos] = '\0';
 301 }
 302
 303 /**
 304  * Convert ASCII encoding back to GNUNET_CRYPTO_hash
 305  *
 306  * @param enc the encoding
 307  * @param result where to store the GNUNET_CRYPTO_hash code
 308  * @return GNUNET_OK on success, GNUNET_SYSERR if result has the wrong encoding
 309  */
 310 int
 311 GNUNET_CRYPTO_hash_from_string (const char *enc, GNUNET_HashCode * result)
 312 {
 313   unsigned int rpos;
 314   unsigned int wpos;
 315   unsigned int bits;
 316   unsigned int vbit;
 317
 318   if (strlen (enc) != sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1)
 319     return GNUNET_SYSERR;
 320
 321   vbit = 2;                     /* padding! */
 322   wpos = sizeof (GNUNET_HashCode);
 323   rpos = sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1;
 324   bits = getValue__ (enc[--rpos]) >> 3;
 325   while (wpos > 0)
 326     {
 327       GNUNET_assert (rpos > 0);
 328       bits = (getValue__ (enc[--rpos]) << vbit) | bits;
 329       vbit += 5;
 330       if (vbit >= 8)
 331         {
 332           ((unsigned char *) result)[--wpos] = (unsigned char) bits;
 333           bits >>= 8;
 334           vbit -= 8;
 335         }
 336     }
 337   GNUNET_assert (rpos == 0);
 338   GNUNET_assert (vbit == 0);
 339   return GNUNET_OK;
 340 }
 341
 342 /**
 343  * Compute the distance between 2 hashcodes.  The computation must be
 344  * fast, not involve bits[0] or bits[4] (they're used elsewhere), and be
 345  * somewhat consistent. And of course, the result should be a positive
 346  * number.
 347  *
 348  * @param a some hash code
 349  * @param b some hash code
 350  * @return a positive number which is a measure for
 351  *  hashcode proximity.
 352  */
 353 unsigned int
 354 GNUNET_CRYPTO_hash_distance_u32 (const GNUNET_HashCode * a,
 355                                  const GNUNET_HashCode * b)
 356 {
 357   unsigned int x1 = (a->bits[1] - b->bits[1]) >> 16;
 358   unsigned int x2 = (b->bits[1] - a->bits[1]) >> 16;
 359   return (x1 * x2);
 360 }
 361
 362 void
 363 GNUNET_CRYPTO_hash_create_random (enum GNUNET_CRYPTO_Quality mode,
 364                                   GNUNET_HashCode * result)
 365 {
 366   int i;
 367   for (i = (sizeof (GNUNET_HashCode) / sizeof (uint32_t)) - 1; i >= 0; i--)
 368     result->bits[i] = GNUNET_CRYPTO_random_u32 (mode, UINT32_MAX);
 369 }
 370
 371 void
 372 GNUNET_CRYPTO_hash_difference (const GNUNET_HashCode * a,
 373                                const GNUNET_HashCode * b,
 374                                GNUNET_HashCode * result)
 375 {
 376   int i;
 377   for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0;
 378        i--)
 379     result->bits[i] = b->bits[i] - a->bits[i];
 380 }
 381
 382 void
 383 GNUNET_CRYPTO_hash_sum (const GNUNET_HashCode * a,
 384                         const GNUNET_HashCode * delta,
 385                         GNUNET_HashCode * result)
 386 {
 387   int i;
 388   for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0;
 389        i--)
 390     result->bits[i] = delta->bits[i] + a->bits[i];
 391 }
 392
 393
 394 void
 395 GNUNET_CRYPTO_hash_xor (const GNUNET_HashCode * a,
 396                         const GNUNET_HashCode * b,
 397                         GNUNET_HashCode * result)
 398 {
 399   int i;
 400   for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0;
 401        i--)
 402     result->bits[i] = a->bits[i] ^ b->bits[i];
 403 }
 404
 405
 406 /**
 407  * Convert a hashcode into a key.
 408  */
 409 void
 410 GNUNET_CRYPTO_hash_to_aes_key (const GNUNET_HashCode * hc,
 411                                struct GNUNET_CRYPTO_AesSessionKey *skey,
 412                                struct GNUNET_CRYPTO_AesInitializationVector
 413                                *iv)
 414 {
 415   GNUNET_assert (sizeof (GNUNET_HashCode) >=
 416                  GNUNET_CRYPTO_AES_KEY_LENGTH +
 417                  sizeof (struct GNUNET_CRYPTO_AesInitializationVector));
 418   memcpy (skey, hc, GNUNET_CRYPTO_AES_KEY_LENGTH);
 419   skey->crc32 =
 420     htonl (GNUNET_CRYPTO_crc32_n (skey, GNUNET_CRYPTO_AES_KEY_LENGTH));
 421   memcpy (iv, &((char *) hc)[GNUNET_CRYPTO_AES_KEY_LENGTH],
 422           sizeof (struct GNUNET_CRYPTO_AesInitializationVector));
 423 }
 424
 425
 426 /**
 427  * Obtain a bit from a hashcode.
 428  * @param code the GNUNET_CRYPTO_hash to index bit-wise
 429  * @param bit index into the hashcode, [0...511]
 430  * @return Bit \a bit from hashcode \a code, -1 for invalid index
 431  */
 432 int
 433 GNUNET_CRYPTO_hash_get_bit (const GNUNET_HashCode * code,
 434                             unsigned int bit)
 435 {
 436   GNUNET_assert (bit < 8 * sizeof (GNUNET_HashCode));
 437   return (((unsigned char *) code)[bit >> 3] & (1 << (bit & 7))) > 0;
 438 }
 439
 440 /**
 441  * Determine how many low order bits match in two
 442  * GNUNET_HashCodes.  i.e. - 010011 and 011111 share
 443  * the first two lowest order bits, and therefore the
 444  * return value is two (NOT XOR distance, nor how many
 445  * bits match absolutely!).
 446  *
 447  * @param first the first hashcode
 448  * @param second the hashcode to compare first to
 449  *
 450  * @return the number of bits that match
 451  */
 452 unsigned int
 453 GNUNET_CRYPTO_hash_matching_bits(const GNUNET_HashCode *first,
 454                                  const GNUNET_HashCode *second)
 455 {
 456   unsigned int i;
 457
 458   for (i = 0; i < sizeof (GNUNET_HashCode) * 8; i++)
 459     if (GNUNET_CRYPTO_hash_get_bit (first, i) != GNUNET_CRYPTO_hash_get_bit (second, i))
 460       return i;
 461   return sizeof (GNUNET_HashCode) * 8;
 462 }
 463
 464
 465 /**
 466  * Compare function for HashCodes, producing a total ordering
 467  * of all hashcodes.
 468  * @return 1 if h1 > h2, -1 if h1 < h2 and 0 if h1 == h2.
 469  */
 470 int
 471 GNUNET_CRYPTO_hash_cmp (const GNUNET_HashCode * h1,
 472                         const GNUNET_HashCode * h2)
 473 {
 474   unsigned int *i1;
 475   unsigned int *i2;
 476   int i;
 477
 478   i1 = (unsigned int *) h1;
 479   i2 = (unsigned int *) h2;
 480   for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0;
 481        i--)
 482     {
 483       if (i1[i] > i2[i])
 484         return 1;
 485       if (i1[i] < i2[i])
 486         return -1;
 487     }
 488   return 0;
 489 }
 490
 491
 492 /**
 493  * Find out which of the two GNUNET_CRYPTO_hash codes is closer to target
 494  * in the XOR metric (Kademlia).
 495  * @return -1 if h1 is closer, 1 if h2 is closer and 0 if h1==h2.
 496  */
 497 int
 498 GNUNET_CRYPTO_hash_xorcmp (const GNUNET_HashCode * h1,
 499                            const GNUNET_HashCode * h2,
 500                            const GNUNET_HashCode * target)
 501 {
 502   int i;
 503   unsigned int d1;
 504   unsigned int d2;
 505
 506   for (i = sizeof (GNUNET_HashCode) / sizeof (unsigned int) - 1; i >= 0; i--)
 507     {
 508       d1 = ((unsigned int *) h1)[i] ^ ((unsigned int *) target)[i];
 509       d2 = ((unsigned int *) h2)[i] ^ ((unsigned int *) target)[i];
 510       if (d1 > d2)
 511         return 1;
 512       else if (d1 < d2)
 513         return -1;
 514     }
 515   return 0;
 516 }
 517
 518
 519 /**
 520  * @brief Derive an authentication key
 521  * @param key authentication key
 522  * @param rkey root key
 523  * @param salt salt
 524  * @param salt_len size of the salt
 525  * @param ... pair of void * & size_t for context chunks, terminated by NULL
 526  */
 527 void
 528 GNUNET_CRYPTO_hmac_derive_key(struct GNUNET_CRYPTO_AuthKey *key,
 529                               const struct GNUNET_CRYPTO_AesSessionKey *rkey,
 530                               const void *salt,
 531                               size_t salt_len,
 532                               ...)
 533 {
 534   va_list argp;
 535
 536   va_start (argp, salt_len);
 537   GNUNET_CRYPTO_hmac_derive_key_v (key, rkey, salt, salt_len, argp);
 538   va_end (argp);
 539 }
 540
 541
 542 /**
 543  * @brief Derive an authentication key
 544  * @param key authentication key
 545  * @param rkey root key
 546  * @param salt salt
 547  * @param salt_len size of the salt
 548  * @param argp pair of void * & size_t for context chunks, terminated by NULL
 549  */
 550 void
 551 GNUNET_CRYPTO_hmac_derive_key_v(struct GNUNET_CRYPTO_AuthKey *key,
 552                                 const struct GNUNET_CRYPTO_AesSessionKey *rkey,
 553                                 const void *salt,
 554                                 size_t salt_len,
 555                                 va_list argp)
 556 {
 557   GNUNET_CRYPTO_kdf_v (key->key,
 558                        sizeof(key->key),
 559                        salt, salt_len,
 560                        rkey->key,
 561                        sizeof(rkey->key),
 562                        argp);
 563 }
 564
 565
 566 /**
 567  * Calculate HMAC of a message (RFC 2104)
 568  *
 569  * @param key secret key
 570  * @param plaintext input plaintext
 571  * @param plaintext_len length of plaintext
 572  * @param hmac where to store the hmac
 573  */
 574 void
 575 GNUNET_CRYPTO_hmac (const struct GNUNET_CRYPTO_AuthKey *key,
 576                     const void *plaintext,
 577                     size_t plaintext_len,
 578                     GNUNET_HashCode *hmac)
 579 {
 580   gcry_md_hd_t md;
 581   const unsigned char *mc;
 582
 583   GNUNET_assert (GPG_ERR_NO_ERROR == gcry_md_open (&md,
 584                                                    GCRY_MD_SHA512,
 585                                                    GCRY_MD_FLAG_HMAC));
 586   gcry_md_setkey (md, key->key, sizeof(key->key));
 587   gcry_md_write (md, plaintext, plaintext_len);
 588   mc = gcry_md_read (md, GCRY_MD_SHA512);
 589   if (mc != NULL)
 590     memcpy (hmac->bits, mc, sizeof(hmac->bits));
 591   gcry_md_close (md);
 592 }
 593
 594
 595 /* end of crypto_hash.c */