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