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   t = i = j = 0;
 287
 288   /* Save number of bits */
 289   t = sctx->count[0];
 290   bits[15] = t;
 291   t >>= 8;
 292   bits[14] = t;
 293   t >>= 8;
 294   bits[13] = t;
 295   t >>= 8;
 296   bits[12] = t;
 297   t = sctx->count[1];
 298   bits[11] = t;
 299   t >>= 8;
 300   bits[10] = t;
 301   t >>= 8;
 302   bits[9] = t;
 303   t >>= 8;
 304   bits[8] = t;
 305   t = sctx->count[2];
 306   bits[7] = t;
 307   t >>= 8;
 308   bits[6] = t;
 309   t >>= 8;
 310   bits[5] = t;
 311   t >>= 8;
 312   bits[4] = t;
 313   t = sctx->count[3];
 314   bits[3] = t;
 315   t >>= 8;
 316   bits[2] = t;
 317   t >>= 8;
 318   bits[1] = t;
 319   t >>= 8;
 320   bits[0] = t;
 321
 322   /* Pad out to 112 mod 128. */
 323   index = (sctx->count[0] >> 3) & 0x7f;
 324   pad_len = (index < 112) ? (112 - index) : ((128 + 112) - index);
 325   sha512_update (sctx, padding, pad_len);
 326
 327   /* Append length (before padding) */
 328   sha512_update (sctx, bits, 16);
 329
 330   /* Store state in digest */
 331   for (i = j = 0; i < 8; i++, j += 8)
 332     {
 333       t2 = sctx->state[i];
 334       hash[j + 7] = (char) t2 & 0xff;
 335       t2 >>= 8;
 336       hash[j + 6] = (char) t2 & 0xff;
 337       t2 >>= 8;
 338       hash[j + 5] = (char) t2 & 0xff;
 339       t2 >>= 8;
 340       hash[j + 4] = (char) t2 & 0xff;
 341       t2 >>= 8;
 342       hash[j + 3] = (char) t2 & 0xff;
 343       t2 >>= 8;
 344       hash[j + 2] = (char) t2 & 0xff;
 345       t2 >>= 8;
 346       hash[j + 1] = (char) t2 & 0xff;
 347       t2 >>= 8;
 348       hash[j] = (char) t2 & 0xff;
 349     }
 350
 351   /* Zeroize sensitive information. */
 352   memset (sctx, 0, sizeof (struct sha512_ctx));
 353 }
 354
 355 /**
 356  * Hash block of given size.
 357  *
 358  * @param block the data to GNUNET_CRYPTO_hash, length is given as a second argument
 359  * @param size the length of the data to GNUNET_CRYPTO_hash
 360  * @param ret pointer to where to write the hashcode
 361  */
 362 void
 363 GNUNET_CRYPTO_hash (const void *block, unsigned int size,
 364                     GNUNET_HashCode * ret)
 365 {
 366   struct sha512_ctx ctx;
 367
 368   sha512_init (&ctx);
 369   sha512_update (&ctx, block, size);
 370   sha512_final (&ctx, (unsigned char *) ret);
 371 }
 372
 373
 374 /**
 375  * Context used when hashing a file.
 376  */
 377 struct FileHashContext
 378 {
 379
 380   /**
 381    * Function to call upon completion.
 382    */
 383   GNUNET_CRYPTO_HashCompletedCallback callback;
 384
 385   /**
 386    * Closure for callback.
 387    */
 388   void *callback_cls;
 389
 390   /**
 391    * IO buffer.
 392    */
 393   unsigned char *buffer;
 394
 395   /**
 396    * Name of the file we are hashing.
 397    */
 398   char *filename;
 399
 400   /**
 401    * Cummulated hash.
 402    */
 403   struct sha512_ctx hctx;
 404
 405   /**
 406    * Blocksize.
 407    */
 408   size_t bsize;
 409
 410   /**
 411    * Size of the file.
 412    */
 413   uint64_t fsize;
 414
 415   /**
 416    * Current offset.
 417    */
 418   uint64_t offset;
 419
 420   /**
 421    * Run on shutdown?
 422    */
 423   int run_on_shutdown;
 424
 425   /**
 426    * File descriptor.
 427    */
 428   struct GNUNET_DISK_FileHandle *fh;
 429
 430 };
 431
 432
 433 /**
 434  * Report result of hash computation to callback
 435  * and free associated resources.
 436  */
 437 static void
 438 file_hash_finish (struct FileHashContext *fhc, const GNUNET_HashCode * res)
 439 {
 440   fhc->callback (fhc->callback_cls, res);
 441   GNUNET_free (fhc->filename);
 442   if (!GNUNET_DISK_handle_invalid (fhc->fh))
 443     GNUNET_break (GNUNET_OK == GNUNET_DISK_file_close (fhc->fh));
 444   GNUNET_free (fhc);            /* also frees fhc->buffer */
 445 }
 446
 447
 448 /**
 449  * File hashing task.
 450  *
 451  * @param cls closure
 452  * @param tc context
 453  */
 454 static void
 455 file_hash_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 456 {
 457   struct FileHashContext *fhc = cls;
 458   GNUNET_HashCode res;
 459   size_t delta;
 460
 461   GNUNET_assert (fhc->offset < fhc->fsize);
 462   delta = fhc->bsize;
 463   if (fhc->fsize - fhc->offset < delta)
 464     delta = fhc->fsize - fhc->offset;
 465   if (delta != GNUNET_DISK_file_read (fhc->fh, fhc->buffer, delta))
 466     {
 467       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
 468                                 "read", fhc->filename);
 469       file_hash_finish (fhc, NULL);
 470       return;
 471     }
 472   sha512_update (&fhc->hctx, fhc->buffer, delta);
 473   fhc->offset += delta;
 474   if (fhc->offset == fhc->fsize)
 475     {
 476       sha512_final (&fhc->hctx, (unsigned char *) &res);
 477       file_hash_finish (fhc, &res);
 478       return;
 479     }
 480   GNUNET_SCHEDULER_add_after (tc->sched,
 481                               fhc->run_on_shutdown,
 482                               GNUNET_SCHEDULER_PRIORITY_KEEP,
 483                               GNUNET_SCHEDULER_NO_TASK,
 484                               &file_hash_task, fhc);
 485 }
 486
 487
 488 /**
 489  * Compute the hash of an entire file.
 490  *
 491  * @param sched scheduler to use
 492  * @param priority scheduling priority to use
 493  * @param run_on_shutdown should we complete even on shutdown?
 494  * @param filename name of file to hash
 495  * @param blocksize number of bytes to process in one task
 496  * @param callback function to call upon completion
 497  * @param callback_cls closure for callback
 498  */
 499 void
 500 GNUNET_CRYPTO_hash_file (struct GNUNET_SCHEDULER_Handle *sched,
 501                          enum GNUNET_SCHEDULER_Priority priority,
 502                          int run_on_shutdown,
 503                          const char *filename,
 504                          size_t blocksize,
 505                          GNUNET_CRYPTO_HashCompletedCallback callback,
 506                          void *callback_cls)
 507 {
 508   struct FileHashContext *fhc;
 509
 510   GNUNET_assert (blocksize > 0);
 511   fhc = GNUNET_malloc (sizeof (struct FileHashContext) + blocksize);
 512   fhc->callback = callback;
 513   fhc->callback_cls = callback_cls;
 514   fhc->buffer = (unsigned char *) &fhc[1];
 515   fhc->filename = GNUNET_strdup (filename);
 516   fhc->fh = NULL;
 517   sha512_init (&fhc->hctx);
 518   fhc->bsize = blocksize;
 519   if (GNUNET_OK != GNUNET_DISK_file_size (filename, &fhc->fsize, GNUNET_NO))
 520     {
 521       file_hash_finish (fhc, NULL);
 522       return;
 523     }
 524   fhc->run_on_shutdown = run_on_shutdown;
 525   fhc->fh = GNUNET_DISK_file_open (filename,
 526       GNUNET_DISK_OPEN_READ);
 527   if (!fhc->fh)
 528     {
 529       file_hash_finish (fhc, NULL);
 530       return;
 531     }
 532   GNUNET_SCHEDULER_add_after (sched,
 533                               run_on_shutdown,
 534                               priority,
 535                               GNUNET_SCHEDULER_NO_TASK,
 536                               &file_hash_task, fhc);
 537 }
 538
 539
 540 /* ***************** binary-ASCII encoding *************** */
 541
 542 /**
 543  * 32 characters for encoding (GNUNET_CRYPTO_hash => 32 characters)
 544  */
 545 static char *encTable__ = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
 546
 547 static unsigned int
 548 getValue__ (unsigned char a)
 549 {
 550   if ((a >= '0') && (a <= '9'))
 551     return a - '0';
 552   if ((a >= 'A') && (a <= 'V'))
 553     return (a - 'A' + 10);
 554   return -1;
 555 }
 556
 557 /**
 558  * Convert GNUNET_CRYPTO_hash to ASCII encoding.  The ASCII encoding is rather
 559  * GNUnet specific.  It was chosen such that it only uses characters
 560  * in [0-9A-V], can be produced without complex arithmetics and uses a
 561  * small number of characters.  The GNUnet encoding uses 102
 562  * characters plus a null terminator.
 563  *
 564  * @param block the GNUNET_CRYPTO_hash code
 565  * @param result where to store the encoding (struct GNUNET_CRYPTO_HashAsciiEncoded can be
 566  *  safely cast to char*, a '\0' termination is set).
 567  */
 568 void
 569 GNUNET_CRYPTO_hash_to_enc (const GNUNET_HashCode * block,
 570                            struct GNUNET_CRYPTO_HashAsciiEncoded *result)
 571 {
 572   unsigned int wpos;
 573   unsigned int rpos;
 574   unsigned int bits;
 575   unsigned int vbit;
 576
 577   GNUNET_assert (block != NULL);
 578   GNUNET_assert (result != NULL);
 579   vbit = 0;
 580   wpos = 0;
 581   rpos = 0;
 582   bits = 0;
 583   while ((rpos < sizeof (GNUNET_HashCode)) || (vbit > 0))
 584     {
 585       if ((rpos < sizeof (GNUNET_HashCode)) && (vbit < 5))
 586         {
 587           bits = (bits << 8) | ((unsigned char *) block)[rpos++];       /* eat 8 more bits */
 588           vbit += 8;
 589         }
 590       if (vbit < 5)
 591         {
 592           bits <<= (5 - vbit);  /* zero-padding */
 593           GNUNET_assert (vbit == 2);    /* padding by 3: 512+3 mod 5 == 0 */
 594           vbit = 5;
 595         }
 596       GNUNET_assert (wpos <
 597                      sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1);
 598       result->encoding[wpos++] = encTable__[(bits >> (vbit - 5)) & 31];
 599       vbit -= 5;
 600     }
 601   GNUNET_assert (wpos == sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1);
 602   GNUNET_assert (vbit == 0);
 603   result->encoding[wpos] = '\0';
 604 }
 605
 606 /**
 607  * Convert ASCII encoding back to GNUNET_CRYPTO_hash
 608  *
 609  * @param enc the encoding
 610  * @param result where to store the GNUNET_CRYPTO_hash code
 611  * @return GNUNET_OK on success, GNUNET_SYSERR if result has the wrong encoding
 612  */
 613 int
 614 GNUNET_CRYPTO_hash_from_string (const char *enc, GNUNET_HashCode * result)
 615 {
 616   unsigned int rpos;
 617   unsigned int wpos;
 618   unsigned int bits;
 619   unsigned int vbit;
 620
 621   if (strlen (enc) != sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1)
 622     return GNUNET_SYSERR;
 623
 624   vbit = 2;                     /* padding! */
 625   wpos = sizeof (GNUNET_HashCode);
 626   rpos = sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1;
 627   bits = getValue__ (enc[--rpos]) >> 3;
 628   while (wpos > 0)
 629     {
 630       GNUNET_assert (rpos > 0);
 631       bits = (getValue__ (enc[--rpos]) << vbit) | bits;
 632       vbit += 5;
 633       if (vbit >= 8)
 634         {
 635           ((unsigned char *) result)[--wpos] = (unsigned char) bits;
 636           bits >>= 8;
 637           vbit -= 8;
 638         }
 639     }
 640   GNUNET_assert (rpos == 0);
 641   GNUNET_assert (vbit == 0);
 642   return GNUNET_OK;
 643 }
 644
 645 /**
 646  * Compute the distance between 2 hashcodes.  The computation must be
 647  * fast, not involve bits[0] or bits[4] (they're used elsewhere), and be
 648  * somewhat consistent. And of course, the result should be a positive
 649  * number.
 650  *
 651  * @returns a positive number which is a measure for
 652  *  hashcode proximity.
 653  */
 654 unsigned int
 655 GNUNET_CRYPTO_hash_distance_u32 (const GNUNET_HashCode * a,
 656                                  const GNUNET_HashCode * b)
 657 {
 658   unsigned int x1 = (a->bits[1] - b->bits[1]) >> 16;
 659   unsigned int x2 = (b->bits[1] - a->bits[1]) >> 16;
 660   return (x1 * x2);
 661 }
 662
 663 void
 664 GNUNET_CRYPTO_hash_create_random (GNUNET_HashCode * result)
 665 {
 666   int i;
 667   for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0;
 668        i--)
 669     result->bits[i] = rand ();
 670 }
 671
 672 void
 673 GNUNET_CRYPTO_hash_difference (const GNUNET_HashCode * a,
 674                                const GNUNET_HashCode * b,
 675                                GNUNET_HashCode * result)
 676 {
 677   int i;
 678   for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0;
 679        i--)
 680     result->bits[i] = b->bits[i] - a->bits[i];
 681 }
 682
 683 void
 684 GNUNET_CRYPTO_hash_sum (const GNUNET_HashCode * a,
 685                         const GNUNET_HashCode * delta,
 686                         GNUNET_HashCode * result)
 687 {
 688   int i;
 689   for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0;
 690        i--)
 691     result->bits[i] = delta->bits[i] + a->bits[i];
 692 }
 693
 694 void
 695 GNUNET_CRYPTO_hash_xor (const GNUNET_HashCode * a,
 696                         const GNUNET_HashCode * b, GNUNET_HashCode * result)
 697 {
 698   int i;
 699   for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0;
 700        i--)
 701     result->bits[i] = a->bits[i] ^ b->bits[i];
 702 }
 703
 704 /**
 705  * Convert a hashcode into a key.
 706  */
 707 void
 708 GNUNET_CRYPTO_hash_to_aes_key (const GNUNET_HashCode * hc,
 709                                struct GNUNET_CRYPTO_AesSessionKey *skey,
 710                                struct GNUNET_CRYPTO_AesInitializationVector
 711                                *iv)
 712 {
 713   GNUNET_assert (sizeof (GNUNET_HashCode) >=
 714                  GNUNET_CRYPTO_AES_KEY_LENGTH +
 715                  sizeof (struct GNUNET_CRYPTO_AesInitializationVector));
 716   memcpy (skey, hc, GNUNET_CRYPTO_AES_KEY_LENGTH);
 717   skey->crc32 =
 718     htonl (GNUNET_CRYPTO_crc32_n (skey, GNUNET_CRYPTO_AES_KEY_LENGTH));
 719   memcpy (iv, &((char *) hc)[GNUNET_CRYPTO_AES_KEY_LENGTH],
 720           sizeof (struct GNUNET_CRYPTO_AesInitializationVector));
 721 }
 722
 723 /**
 724  * Obtain a bit from a hashcode.
 725  * @param code the GNUNET_CRYPTO_hash to index bit-wise
 726  * @param bit index into the hashcode, [0...511]
 727  * @return Bit \a bit from hashcode \a code, -1 for invalid index
 728  */
 729 int
 730 GNUNET_CRYPTO_hash_get_bit (const GNUNET_HashCode * code, unsigned int bit)
 731 {
 732   GNUNET_assert (bit < 8 * sizeof (GNUNET_HashCode));
 733   return (((unsigned char *) code)[bit >> 3] & (1 << (bit & 7))) > 0;
 734 }
 735
 736 /**
 737  * Compare function for HashCodes, producing a total ordering
 738  * of all hashcodes.
 739  * @return 1 if h1 > h2, -1 if h1 < h2 and 0 if h1 == h2.
 740  */
 741 int
 742 GNUNET_CRYPTO_hash_cmp (const GNUNET_HashCode * h1,
 743                         const GNUNET_HashCode * h2)
 744 {
 745   unsigned int *i1;
 746   unsigned int *i2;
 747   int i;
 748
 749   i1 = (unsigned int *) h1;
 750   i2 = (unsigned int *) h2;
 751   for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0;
 752        i--)
 753     {
 754       if (i1[i] > i2[i])
 755         return 1;
 756       if (i1[i] < i2[i])
 757         return -1;
 758     }
 759   return 0;
 760 }
 761
 762 /**
 763  * Find out which of the two GNUNET_CRYPTO_hash codes is closer to target
 764  * in the XOR metric (Kademlia).
 765  * @return -1 if h1 is closer, 1 if h2 is closer and 0 if h1==h2.
 766  */
 767 int
 768 GNUNET_CRYPTO_hash_xorcmp (const GNUNET_HashCode * h1,
 769                            const GNUNET_HashCode * h2,
 770                            const GNUNET_HashCode * target)
 771 {
 772   int i;
 773   unsigned int d1;
 774   unsigned int d2;
 775
 776   for (i = sizeof (GNUNET_HashCode) / sizeof (unsigned int) - 1; i >= 0; i--)
 777     {
 778       d1 = ((unsigned int *) h1)[i] ^ ((unsigned int *) target)[i];
 779       d2 = ((unsigned int *) h2)[i] ^ ((unsigned int *) target)[i];
 780       if (d1 > d2)
 781         return 1;
 782       else if (d1 < d2)
 783         return -1;
 784     }
 785   return 0;
 786 }
 787
 788 /* end of hashing.c */