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
  38 #define SHA512_DIGEST_SIZE 64
  39 #define SHA512_HMAC_BLOCK_SIZE 128
  40
  41 struct sha512_ctx
  42 {
  43   unsigned long long state[8];
  44   unsigned int count[4];
  45   unsigned char buf[128];
  46 };
  47
  48 static unsigned long long
  49 Ch (unsigned long long x, unsigned long long y, unsigned long long z)
  50 {
  51   return z ^ (x & (y ^ z));
  52 }
  53
  54 static unsigned long long
  55 Maj (unsigned long long x, unsigned long long y, unsigned long long z)
  56 {
  57   return (x & y) | (z & (x | y));
  58 }
  59
  60 static unsigned long long
  61 RORu64 (unsigned long long x, unsigned long long y)
  62 {
  63   return (x >> y) | (x << (64 - y));
  64 }
  65
  66 const unsigned long long sha512_K[80] = {
  67   0x428a2f98d728ae22ULL, 0x7137449123ef65cdULL, 0xb5c0fbcfec4d3b2fULL,
  68   0xe9b5dba58189dbbcULL, 0x3956c25bf348b538ULL, 0x59f111f1b605d019ULL,
  69   0x923f82a4af194f9bULL, 0xab1c5ed5da6d8118ULL, 0xd807aa98a3030242ULL,
  70   0x12835b0145706fbeULL, 0x243185be4ee4b28cULL, 0x550c7dc3d5ffb4e2ULL,
  71   0x72be5d74f27b896fULL, 0x80deb1fe3b1696b1ULL, 0x9bdc06a725c71235ULL,
  72   0xc19bf174cf692694ULL, 0xe49b69c19ef14ad2ULL, 0xefbe4786384f25e3ULL,
  73   0x0fc19dc68b8cd5b5ULL, 0x240ca1cc77ac9c65ULL, 0x2de92c6f592b0275ULL,
  74   0x4a7484aa6ea6e483ULL, 0x5cb0a9dcbd41fbd4ULL, 0x76f988da831153b5ULL,
  75   0x983e5152ee66dfabULL, 0xa831c66d2db43210ULL, 0xb00327c898fb213fULL,
  76   0xbf597fc7beef0ee4ULL, 0xc6e00bf33da88fc2ULL, 0xd5a79147930aa725ULL,
  77   0x06ca6351e003826fULL, 0x142929670a0e6e70ULL, 0x27b70a8546d22ffcULL,
  78   0x2e1b21385c26c926ULL, 0x4d2c6dfc5ac42aedULL, 0x53380d139d95b3dfULL,
  79   0x650a73548baf63deULL, 0x766a0abb3c77b2a8ULL, 0x81c2c92e47edaee6ULL,
  80   0x92722c851482353bULL, 0xa2bfe8a14cf10364ULL, 0xa81a664bbc423001ULL,
  81   0xc24b8b70d0f89791ULL, 0xc76c51a30654be30ULL, 0xd192e819d6ef5218ULL,
  82   0xd69906245565a910ULL, 0xf40e35855771202aULL, 0x106aa07032bbd1b8ULL,
  83   0x19a4c116b8d2d0c8ULL, 0x1e376c085141ab53ULL, 0x2748774cdf8eeb99ULL,
  84   0x34b0bcb5e19b48a8ULL, 0x391c0cb3c5c95a63ULL, 0x4ed8aa4ae3418acbULL,
  85   0x5b9cca4f7763e373ULL, 0x682e6ff3d6b2b8a3ULL, 0x748f82ee5defb2fcULL,
  86   0x78a5636f43172f60ULL, 0x84c87814a1f0ab72ULL, 0x8cc702081a6439ecULL,
  87   0x90befffa23631e28ULL, 0xa4506cebde82bde9ULL, 0xbef9a3f7b2c67915ULL,
  88   0xc67178f2e372532bULL, 0xca273eceea26619cULL, 0xd186b8c721c0c207ULL,
  89   0xeada7dd6cde0eb1eULL, 0xf57d4f7fee6ed178ULL, 0x06f067aa72176fbaULL,
  90   0x0a637dc5a2c898a6ULL, 0x113f9804bef90daeULL, 0x1b710b35131c471bULL,
  91   0x28db77f523047d84ULL, 0x32caab7b40c72493ULL, 0x3c9ebe0a15c9bebcULL,
  92   0x431d67c49c100d4cULL, 0x4cc5d4becb3e42b6ULL, 0x597f299cfc657e2aULL,
  93   0x5fcb6fab3ad6faecULL, 0x6c44198c4a475817ULL,
  94 };
  95
  96 #define e0(x)       (RORu64(x,28) ^ RORu64(x,34) ^ RORu64(x,39))
  97 #define e1(x)       (RORu64(x,14) ^ RORu64(x,18) ^ RORu64(x,41))
  98 #define s0(x)       (RORu64(x, 1) ^ RORu64(x, 8) ^ (x >> 7))
  99 #define s1(x)       (RORu64(x,19) ^ RORu64(x,61) ^ (x >> 6))
 100
 101 /* H* initial state for SHA-512 */
 102 #define H0         0x6a09e667f3bcc908ULL
 103 #define H1         0xbb67ae8584caa73bULL
 104 #define H2         0x3c6ef372fe94f82bULL
 105 #define H3         0xa54ff53a5f1d36f1ULL
 106 #define H4         0x510e527fade682d1ULL
 107 #define H5         0x9b05688c2b3e6c1fULL
 108 #define H6         0x1f83d9abfb41bd6bULL
 109 #define H7         0x5be0cd19137e2179ULL
 110
 111 /* H'* initial state for SHA-384 */
 112 #define HP0 0xcbbb9d5dc1059ed8ULL
 113 #define HP1 0x629a292a367cd507ULL
 114 #define HP2 0x9159015a3070dd17ULL
 115 #define HP3 0x152fecd8f70e5939ULL
 116 #define HP4 0x67332667ffc00b31ULL
 117 #define HP5 0x8eb44a8768581511ULL
 118 #define HP6 0xdb0c2e0d64f98fa7ULL
 119 #define HP7 0x47b5481dbefa4fa4ULL
 120
 121 #define LOAD_OP(t1, I, W, input) \
 122   t1  = input[(8*I)  ] & 0xff;\
 123   t1 <<= 8;\
 124   t1 |= input[(8*I)+1] & 0xff;\
 125   t1 <<= 8;\
 126   t1 |= input[(8*I)+2] & 0xff;\
 127   t1 <<= 8;\
 128   t1 |= input[(8*I)+3] & 0xff;\
 129   t1 <<= 8;\
 130   t1 |= input[(8*I)+4] & 0xff;\
 131   t1 <<= 8;\
 132   t1 |= input[(8*I)+5] & 0xff;\
 133   t1 <<= 8;\
 134   t1 |= input[(8*I)+6] & 0xff;\
 135   t1 <<= 8;\
 136   t1 |= input[(8*I)+7] & 0xff;\
 137   W[I] = t1;
 138
 139
 140 #define BLEND_OP(I, W) \
 141   W[I] = s1(W[I-2]) + W[I-7] + s0(W[I-15]) + W[I-16];
 142
 143 static void
 144 sha512_transform (unsigned long long *state, const unsigned char *input)
 145 {
 146   unsigned long long a, b, c, d, e, f, g, h, t1, t2;
 147   unsigned long long W[80];
 148   unsigned long long t0;
 149   int i;
 150
 151   /* load the input */
 152   for (i = 0; i < 16; i++)
 153     {
 154       LOAD_OP (t0, i, W, input);
 155     }
 156
 157   for (i = 16; i < 80; i++)
 158     {
 159       BLEND_OP (i, W);
 160     }
 161
 162   /* load the state into our registers */
 163   a = state[0];
 164   b = state[1];
 165   c = state[2];
 166   d = state[3];
 167   e = state[4];
 168   f = state[5];
 169   g = state[6];
 170   h = state[7];
 171
 172   /* now iterate */
 173   for (i = 0; i < 80; i += 8)
 174     {
 175       t1 = h + e1 (e) + Ch (e, f, g) + sha512_K[i] + W[i];
 176       t2 = e0 (a) + Maj (a, b, c);
 177       d += t1;
 178       h = t1 + t2;
 179       t1 = g + e1 (d) + Ch (d, e, f) + sha512_K[i + 1] + W[i + 1];
 180       t2 = e0 (h) + Maj (h, a, b);
 181       c += t1;
 182       g = t1 + t2;
 183       t1 = f + e1 (c) + Ch (c, d, e) + sha512_K[i + 2] + W[i + 2];
 184       t2 = e0 (g) + Maj (g, h, a);
 185       b += t1;
 186       f = t1 + t2;
 187       t1 = e + e1 (b) + Ch (b, c, d) + sha512_K[i + 3] + W[i + 3];
 188       t2 = e0 (f) + Maj (f, g, h);
 189       a += t1;
 190       e = t1 + t2;
 191       t1 = d + e1 (a) + Ch (a, b, c) + sha512_K[i + 4] + W[i + 4];
 192       t2 = e0 (e) + Maj (e, f, g);
 193       h += t1;
 194       d = t1 + t2;
 195       t1 = c + e1 (h) + Ch (h, a, b) + sha512_K[i + 5] + W[i + 5];
 196       t2 = e0 (d) + Maj (d, e, f);
 197       g += t1;
 198       c = t1 + t2;
 199       t1 = b + e1 (g) + Ch (g, h, a) + sha512_K[i + 6] + W[i + 6];
 200       t2 = e0 (c) + Maj (c, d, e);
 201       f += t1;
 202       b = t1 + t2;
 203       t1 = a + e1 (f) + Ch (f, g, h) + sha512_K[i + 7] + W[i + 7];
 204       t2 = e0 (b) + Maj (b, c, d);
 205       e += t1;
 206       a = t1 + t2;
 207     }
 208
 209   state[0] += a;
 210   state[1] += b;
 211   state[2] += c;
 212   state[3] += d;
 213   state[4] += e;
 214   state[5] += f;
 215   state[6] += g;
 216   state[7] += h;
 217 }
 218
 219 static void
 220 sha512_init (struct sha512_ctx *sctx)
 221 {
 222   sctx->state[0] = H0;
 223   sctx->state[1] = H1;
 224   sctx->state[2] = H2;
 225   sctx->state[3] = H3;
 226   sctx->state[4] = H4;
 227   sctx->state[5] = H5;
 228   sctx->state[6] = H6;
 229   sctx->state[7] = H7;
 230   sctx->count[0] = sctx->count[1] = sctx->count[2] = sctx->count[3] = 0;
 231   memset (sctx->buf, 0, sizeof (sctx->buf));
 232 }
 233
 234 static void
 235 sha512_update (struct sha512_ctx *sctx,
 236                const unsigned char *data, unsigned int len)
 237 {
 238   unsigned int i, index, part_len;
 239
 240   /* Compute number of bytes mod 128 */
 241   index = (unsigned int) ((sctx->count[0] >> 3) & 0x7F);
 242
 243   /* Update number of bits */
 244   if ((sctx->count[0] += (len << 3)) < (len << 3))
 245     {
 246       if ((sctx->count[1] += 1) < 1)
 247         if ((sctx->count[2] += 1) < 1)
 248           sctx->count[3]++;
 249       sctx->count[1] += (len >> 29);
 250     }
 251
 252   part_len = 128 - index;
 253
 254   /* Transform as many times as possible. */
 255   if (len >= part_len)
 256     {
 257       memcpy (&sctx->buf[index], data, part_len);
 258       sha512_transform (sctx->state, sctx->buf);
 259
 260       for (i = part_len; i + 127 < len; i += 128)
 261         sha512_transform (sctx->state, &data[i]);
 262
 263       index = 0;
 264     }
 265   else
 266     {
 267       i = 0;
 268     }
 269
 270   /* Buffer remaining input */
 271   memcpy (&sctx->buf[index], &data[i], len - i);
 272 }
 273
 274 static void
 275 sha512_final (struct sha512_ctx *sctx, unsigned char *hash)
 276 {
 277   static unsigned char padding[128] = { 0x80, };
 278
 279   unsigned int t;
 280   unsigned char bits[128];
 281   unsigned int index;
 282   unsigned int pad_len;
 283   unsigned long long t2;
 284   int i, j;
 285
 286   /* Save number of bits */
 287   t = sctx->count[0];
 288   bits[15] = t;
 289   t >>= 8;
 290   bits[14] = t;
 291   t >>= 8;
 292   bits[13] = t;
 293   t >>= 8;
 294   bits[12] = t;
 295   t = sctx->count[1];
 296   bits[11] = t;
 297   t >>= 8;
 298   bits[10] = t;
 299   t >>= 8;
 300   bits[9] = t;
 301   t >>= 8;
 302   bits[8] = t;
 303   t = sctx->count[2];
 304   bits[7] = t;
 305   t >>= 8;
 306   bits[6] = t;
 307   t >>= 8;
 308   bits[5] = t;
 309   t >>= 8;
 310   bits[4] = t;
 311   t = sctx->count[3];
 312   bits[3] = t;
 313   t >>= 8;
 314   bits[2] = t;
 315   t >>= 8;
 316   bits[1] = t;
 317   t >>= 8;
 318   bits[0] = t;
 319
 320   /* Pad out to 112 mod 128. */
 321   index = (sctx->count[0] >> 3) & 0x7f;
 322   pad_len = (index < 112) ? (112 - index) : ((128 + 112) - index);
 323   sha512_update (sctx, padding, pad_len);
 324
 325   /* Append length (before padding) */
 326   sha512_update (sctx, bits, 16);
 327
 328   /* Store state in digest */
 329   for (i = j = 0; i < 8; i++, j += 8)
 330     {
 331       t2 = sctx->state[i];
 332       hash[j + 7] = (char) t2 & 0xff;
 333       t2 >>= 8;
 334       hash[j + 6] = (char) t2 & 0xff;
 335       t2 >>= 8;
 336       hash[j + 5] = (char) t2 & 0xff;
 337       t2 >>= 8;
 338       hash[j + 4] = (char) t2 & 0xff;
 339       t2 >>= 8;
 340       hash[j + 3] = (char) t2 & 0xff;
 341       t2 >>= 8;
 342       hash[j + 2] = (char) t2 & 0xff;
 343       t2 >>= 8;
 344       hash[j + 1] = (char) t2 & 0xff;
 345       t2 >>= 8;
 346       hash[j] = (char) t2 & 0xff;
 347     }
 348
 349   /* Zeroize sensitive information. */
 350   memset (sctx, 0, sizeof (struct sha512_ctx));
 351 }
 352
 353
 354 /**
 355  * Hash block of given size.
 356  *
 357  * @param block the data to GNUNET_CRYPTO_hash, length is given as a second argument
 358  * @param size the length of the data to GNUNET_CRYPTO_hash
 359  * @param ret pointer to where to write the hashcode
 360  */
 361 void
 362 GNUNET_CRYPTO_hash (const void *block, unsigned int size,
 363                     GNUNET_HashCode * ret)
 364 {
 365   struct sha512_ctx ctx;
 366
 367   sha512_init (&ctx);
 368   sha512_update (&ctx, block, size);
 369   sha512_final (&ctx, (unsigned char *) ret);
 370 }
 371
 372
 373 /**
 374  * Context used when hashing a file.
 375  */
 376 struct FileHashContext
 377 {
 378
 379   /**
 380    * Function to call upon completion.
 381    */
 382   GNUNET_CRYPTO_HashCompletedCallback callback;
 383
 384   /**
 385    * Closure for callback.
 386    */
 387   void *callback_cls;
 388
 389   /**
 390    * IO buffer.
 391    */
 392   unsigned char *buffer;
 393
 394   /**
 395    * Name of the file we are hashing.
 396    */
 397   char *filename;
 398
 399   /**
 400    * Cummulated hash.
 401    */
 402   struct sha512_ctx hctx;
 403
 404   /**
 405    * Blocksize.
 406    */
 407   size_t bsize;
 408
 409   /**
 410    * Size of the file.
 411    */
 412   uint64_t fsize;
 413
 414   /**
 415    * Current offset.
 416    */
 417   uint64_t offset;
 418
 419   /**
 420    * Run on shutdown?
 421    */
 422   int run_on_shutdown;
 423
 424   /**
 425    * File descriptor.
 426    */
 427   struct GNUNET_DISK_FileHandle *fh;
 428
 429 };
 430
 431
 432 /**
 433  * Report result of hash computation to callback
 434  * and free associated resources.
 435  */
 436 static void
 437 file_hash_finish (struct FileHashContext *fhc, const GNUNET_HashCode * res)
 438 {
 439   fhc->callback (fhc->callback_cls, res);
 440   GNUNET_free (fhc->filename);
 441   if (!GNUNET_DISK_handle_invalid (fhc->fh))
 442     GNUNET_break (GNUNET_OK == GNUNET_DISK_file_close (fhc->fh));
 443   GNUNET_free (fhc);            /* also frees fhc->buffer */
 444 }
 445
 446
 447 /**
 448  * File hashing task.
 449  *
 450  * @param cls closure
 451  * @param tc context
 452  */
 453 static void
 454 file_hash_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 455 {
 456   struct FileHashContext *fhc = cls;
 457   GNUNET_HashCode res;
 458   size_t delta;
 459
 460   GNUNET_assert (fhc->offset < fhc->fsize);
 461   delta = fhc->bsize;
 462   if (fhc->fsize - fhc->offset < delta)
 463     delta = fhc->fsize - fhc->offset;
 464   if (delta != GNUNET_DISK_file_read (fhc->fh, fhc->buffer, delta))
 465     {
 466       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
 467                                 "read", fhc->filename);
 468       file_hash_finish (fhc, NULL);
 469       return;
 470     }
 471   sha512_update (&fhc->hctx, fhc->buffer, delta);
 472   fhc->offset += delta;
 473   if (fhc->offset == fhc->fsize)
 474     {
 475       sha512_final (&fhc->hctx, (unsigned char *) &res);
 476       file_hash_finish (fhc, &res);
 477       return;
 478     }
 479   GNUNET_SCHEDULER_add_after (tc->sched,
 480                               fhc->run_on_shutdown,
 481                               GNUNET_SCHEDULER_PRIORITY_KEEP,
 482                               GNUNET_SCHEDULER_NO_TASK,
 483                               &file_hash_task, fhc);
 484 }
 485
 486
 487 /**
 488  * Compute the hash of an entire file.
 489  *
 490  * @param sched scheduler to use
 491  * @param priority scheduling priority to use
 492  * @param run_on_shutdown should we complete even on shutdown?
 493  * @param filename name of file to hash
 494  * @param blocksize number of bytes to process in one task
 495  * @param callback function to call upon completion
 496  * @param callback_cls closure for callback
 497  */
 498 void
 499 GNUNET_CRYPTO_hash_file (struct GNUNET_SCHEDULER_Handle *sched,
 500                          enum GNUNET_SCHEDULER_Priority priority,
 501                          int run_on_shutdown,
 502                          const char *filename,
 503                          size_t blocksize,
 504                          GNUNET_CRYPTO_HashCompletedCallback callback,
 505                          void *callback_cls)
 506 {
 507   struct FileHashContext *fhc;
 508
 509   GNUNET_assert (blocksize > 0);
 510   fhc = GNUNET_malloc (sizeof (struct FileHashContext) + blocksize);
 511   fhc->callback = callback;
 512   fhc->callback_cls = callback_cls;
 513   fhc->buffer = (unsigned char *) &fhc[1];
 514   fhc->filename = GNUNET_strdup (filename);
 515   fhc->fh = NULL;
 516   sha512_init (&fhc->hctx);
 517   fhc->bsize = blocksize;
 518   if (GNUNET_OK != GNUNET_DISK_file_size (filename, &fhc->fsize, GNUNET_NO))
 519     {
 520       file_hash_finish (fhc, NULL);
 521       return;
 522     }
 523   fhc->run_on_shutdown = run_on_shutdown;
 524   fhc->fh = GNUNET_DISK_file_open (filename,
 525       GNUNET_DISK_OPEN_READ);
 526   if (!fhc->fh)
 527     {
 528       file_hash_finish (fhc, NULL);
 529       return;
 530     }
 531   GNUNET_SCHEDULER_add_after (sched,
 532                               run_on_shutdown,
 533                               priority,
 534                               GNUNET_SCHEDULER_NO_TASK,
 535                               &file_hash_task, fhc);
 536 }
 537
 538
 539 /* ***************** binary-ASCII encoding *************** */
 540
 541 /**
 542  * 32 characters for encoding (GNUNET_CRYPTO_hash => 32 characters)
 543  */
 544 static char *encTable__ = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
 545
 546 static unsigned int
 547 getValue__ (unsigned char a)
 548 {
 549   if ((a >= '0') && (a <= '9'))
 550     return a - '0';
 551   if ((a >= 'A') && (a <= 'V'))
 552     return (a - 'A' + 10);
 553   return -1;
 554 }
 555
 556 /**
 557  * Convert GNUNET_CRYPTO_hash to ASCII encoding.  The ASCII encoding is rather
 558  * GNUnet specific.  It was chosen such that it only uses characters
 559  * in [0-9A-V], can be produced without complex arithmetics and uses a
 560  * small number of characters.  The GNUnet encoding uses 102
 561  * characters plus a null terminator.
 562  *
 563  * @param block the GNUNET_CRYPTO_hash code
 564  * @param result where to store the encoding (struct GNUNET_CRYPTO_HashAsciiEncoded can be
 565  *  safely cast to char*, a '\0' termination is set).
 566  */
 567 void
 568 GNUNET_CRYPTO_hash_to_enc (const GNUNET_HashCode * block,
 569                            struct GNUNET_CRYPTO_HashAsciiEncoded *result)
 570 {
 571   unsigned int wpos;
 572   unsigned int rpos;
 573   unsigned int bits;
 574   unsigned int vbit;
 575
 576   GNUNET_assert (block != NULL);
 577   GNUNET_assert (result != NULL);
 578   vbit = 0;
 579   wpos = 0;
 580   rpos = 0;
 581   bits = 0;
 582   while ((rpos < sizeof (GNUNET_HashCode)) || (vbit > 0))
 583     {
 584       if ((rpos < sizeof (GNUNET_HashCode)) && (vbit < 5))
 585         {
 586           bits = (bits << 8) | ((unsigned char *) block)[rpos++];       /* eat 8 more bits */
 587           vbit += 8;
 588         }
 589       if (vbit < 5)
 590         {
 591           bits <<= (5 - vbit);  /* zero-padding */
 592           GNUNET_assert (vbit == 2);    /* padding by 3: 512+3 mod 5 == 0 */
 593           vbit = 5;
 594         }
 595       GNUNET_assert (wpos <
 596                      sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1);
 597       result->encoding[wpos++] = encTable__[(bits >> (vbit - 5)) & 31];
 598       vbit -= 5;
 599     }
 600   GNUNET_assert (wpos == sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1);
 601   GNUNET_assert (vbit == 0);
 602   result->encoding[wpos] = '\0';
 603 }
 604
 605 /**
 606  * Convert ASCII encoding back to GNUNET_CRYPTO_hash
 607  *
 608  * @param enc the encoding
 609  * @param result where to store the GNUNET_CRYPTO_hash code
 610  * @return GNUNET_OK on success, GNUNET_SYSERR if result has the wrong encoding
 611  */
 612 int
 613 GNUNET_CRYPTO_hash_from_string (const char *enc, GNUNET_HashCode * result)
 614 {
 615   unsigned int rpos;
 616   unsigned int wpos;
 617   unsigned int bits;
 618   unsigned int vbit;
 619
 620   if (strlen (enc) != sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1)
 621     return GNUNET_SYSERR;
 622
 623   vbit = 2;                     /* padding! */
 624   wpos = sizeof (GNUNET_HashCode);
 625   rpos = sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1;
 626   bits = getValue__ (enc[--rpos]) >> 3;
 627   while (wpos > 0)
 628     {
 629       GNUNET_assert (rpos > 0);
 630       bits = (getValue__ (enc[--rpos]) << vbit) | bits;
 631       vbit += 5;
 632       if (vbit >= 8)
 633         {
 634           ((unsigned char *) result)[--wpos] = (unsigned char) bits;
 635           bits >>= 8;
 636           vbit -= 8;
 637         }
 638     }
 639   GNUNET_assert (rpos == 0);
 640   GNUNET_assert (vbit == 0);
 641   return GNUNET_OK;
 642 }
 643
 644 /**
 645  * Compute the distance between 2 hashcodes.  The computation must be
 646  * fast, not involve bits[0] or bits[4] (they're used elsewhere), and be
 647  * somewhat consistent. And of course, the result should be a positive
 648  * number.
 649  *
 650  * @returns a positive number which is a measure for
 651  *  hashcode proximity.
 652  */
 653 unsigned int
 654 GNUNET_CRYPTO_hash_distance_u32 (const GNUNET_HashCode * a,
 655                                  const GNUNET_HashCode * b)
 656 {
 657   unsigned int x1 = (a->bits[1] - b->bits[1]) >> 16;
 658   unsigned int x2 = (b->bits[1] - a->bits[1]) >> 16;
 659   return (x1 * x2);
 660 }
 661
 662 void
 663 GNUNET_CRYPTO_hash_create_random (GNUNET_HashCode * result)
 664 {
 665   int i;
 666   for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0;
 667        i--)
 668     result->bits[i] = rand ();
 669 }
 670
 671 void
 672 GNUNET_CRYPTO_hash_difference (const GNUNET_HashCode * a,
 673                                const GNUNET_HashCode * b,
 674                                GNUNET_HashCode * result)
 675 {
 676   int i;
 677   for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0;
 678        i--)
 679     result->bits[i] = b->bits[i] - a->bits[i];
 680 }
 681
 682 void
 683 GNUNET_CRYPTO_hash_sum (const GNUNET_HashCode * a,
 684                         const GNUNET_HashCode * delta,
 685                         GNUNET_HashCode * result)
 686 {
 687   int i;
 688   for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0;
 689        i--)
 690     result->bits[i] = delta->bits[i] + a->bits[i];
 691 }
 692
 693 void
 694 GNUNET_CRYPTO_hash_xor (const GNUNET_HashCode * a,
 695                         const GNUNET_HashCode * b, GNUNET_HashCode * result)
 696 {
 697   int i;
 698   for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0;
 699        i--)
 700     result->bits[i] = a->bits[i] ^ b->bits[i];
 701 }
 702
 703 /**
 704  * Convert a hashcode into a key.
 705  */
 706 void
 707 GNUNET_CRYPTO_hash_to_aes_key (const GNUNET_HashCode * hc,
 708                                struct GNUNET_CRYPTO_AesSessionKey *skey,
 709                                struct GNUNET_CRYPTO_AesInitializationVector
 710                                *iv)
 711 {
 712   GNUNET_assert (sizeof (GNUNET_HashCode) >=
 713                  GNUNET_CRYPTO_AES_KEY_LENGTH +
 714                  sizeof (struct GNUNET_CRYPTO_AesInitializationVector));
 715   memcpy (skey, hc, GNUNET_CRYPTO_AES_KEY_LENGTH);
 716   skey->crc32 =
 717     htonl (GNUNET_CRYPTO_crc32_n (skey, GNUNET_CRYPTO_AES_KEY_LENGTH));
 718   memcpy (iv, &((char *) hc)[GNUNET_CRYPTO_AES_KEY_LENGTH],
 719           sizeof (struct GNUNET_CRYPTO_AesInitializationVector));
 720 }
 721
 722 /**
 723  * Obtain a bit from a hashcode.
 724  * @param code the GNUNET_CRYPTO_hash to index bit-wise
 725  * @param bit index into the hashcode, [0...511]
 726  * @return Bit \a bit from hashcode \a code, -1 for invalid index
 727  */
 728 int
 729 GNUNET_CRYPTO_hash_get_bit (const GNUNET_HashCode * code, unsigned int bit)
 730 {
 731   GNUNET_assert (bit < 8 * sizeof (GNUNET_HashCode));
 732   return (((unsigned char *) code)[bit >> 3] & (1 << (bit & 7))) > 0;
 733 }
 734
 735 /**
 736  * Compare function for HashCodes, producing a total ordering
 737  * of all hashcodes.
 738  * @return 1 if h1 > h2, -1 if h1 < h2 and 0 if h1 == h2.
 739  */
 740 int
 741 GNUNET_CRYPTO_hash_cmp (const GNUNET_HashCode * h1,
 742                         const GNUNET_HashCode * h2)
 743 {
 744   unsigned int *i1;
 745   unsigned int *i2;
 746   int i;
 747
 748   i1 = (unsigned int *) h1;
 749   i2 = (unsigned int *) h2;
 750   for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0;
 751        i--)
 752     {
 753       if (i1[i] > i2[i])
 754         return 1;
 755       if (i1[i] < i2[i])
 756         return -1;
 757     }
 758   return 0;
 759 }
 760
 761 /**
 762  * Find out which of the two GNUNET_CRYPTO_hash codes is closer to target
 763  * in the XOR metric (Kademlia).
 764  * @return -1 if h1 is closer, 1 if h2 is closer and 0 if h1==h2.
 765  */
 766 int
 767 GNUNET_CRYPTO_hash_xorcmp (const GNUNET_HashCode * h1,
 768                            const GNUNET_HashCode * h2,
 769                            const GNUNET_HashCode * target)
 770 {
 771   int i;
 772   unsigned int d1;
 773   unsigned int d2;
 774
 775   for (i = sizeof (GNUNET_HashCode) / sizeof (unsigned int) - 1; i >= 0; i--)
 776     {
 777       d1 = ((unsigned int *) h1)[i] ^ ((unsigned int *) target)[i];
 778       d2 = ((unsigned int *) h2)[i] ^ ((unsigned int *) target)[i];
 779       if (d1 > d2)
 780         return 1;
 781       else if (d1 < d2)
 782         return -1;
 783     }
 784   return 0;
 785 }
 786
 787 /* end of hashing.c */