2 This file is part of GNUnet.
3 (C) 2001, 2002, 2003, 2004, 2005, 2006, 2009 Christian Grothoff (and other contributing authors)
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.
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.
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.
20 SHA-512 code by Jean-Luc Cooke <jlcooke@certainkey.com>
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>
28 * @file util/crypto_hash.c
29 * @brief SHA-512 GNUNET_CRYPTO_hash related functions
30 * @author Christian Grothoff
34 #include "gnunet_common.h"
35 #include "gnunet_crypto_lib.h"
36 #include "gnunet_disk_lib.h"
41 * Hash block of given size.
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
48 GNUNET_CRYPTO_hash (const void *block, size_t size, GNUNET_HashCode * ret)
50 gcry_md_hash_buffer (GCRY_MD_SHA512, ret, block, size);
55 * Context used when hashing a file.
57 struct GNUNET_CRYPTO_FileHashContext
61 * Function to call upon completion.
63 GNUNET_CRYPTO_HashCompletedCallback callback;
66 * Closure for callback.
73 unsigned char *buffer;
76 * Name of the file we are hashing.
83 struct GNUNET_DISK_FileHandle *fh;
101 * Current task for hashing.
103 GNUNET_SCHEDULER_TaskIdentifier task;
114 * Report result of hash computation to callback
115 * and free associated resources.
118 file_hash_finish (struct GNUNET_CRYPTO_FileHashContext *fhc,
119 const GNUNET_HashCode * res)
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 */
137 file_hash_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
139 struct GNUNET_CRYPTO_FileHashContext *fhc = cls;
140 GNUNET_HashCode *res;
143 fhc->task = GNUNET_SCHEDULER_NO_TASK;
144 GNUNET_assert (fhc->offset <= fhc->fsize);
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))
150 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "read", fhc->filename);
151 file_hash_finish (fhc, NULL);
154 gcry_md_write (fhc->md, fhc->buffer, delta);
155 fhc->offset += delta;
156 if (fhc->offset == fhc->fsize)
158 res = (GNUNET_HashCode *) gcry_md_read (fhc->md, GCRY_MD_SHA512);
159 file_hash_finish (fhc, res);
162 fhc->task = GNUNET_SCHEDULER_add_now (&file_hash_task, fhc);
167 * Compute the hash of an entire file.
169 * @param priority scheduling priority to use
170 * @param filename name of file to hash
171 * @param blocksize number of bytes to process in one task
172 * @param callback function to call upon completion
173 * @param callback_cls closure for callback
174 * @return NULL on (immediate) errror
176 struct GNUNET_CRYPTO_FileHashContext *
177 GNUNET_CRYPTO_hash_file (enum GNUNET_SCHEDULER_Priority priority,
178 const char *filename, size_t blocksize,
179 GNUNET_CRYPTO_HashCompletedCallback callback,
182 struct GNUNET_CRYPTO_FileHashContext *fhc;
184 GNUNET_assert (blocksize > 0);
186 GNUNET_malloc (sizeof (struct GNUNET_CRYPTO_FileHashContext) + blocksize);
187 fhc->callback = callback;
188 fhc->callback_cls = callback_cls;
189 fhc->buffer = (unsigned char *) &fhc[1];
190 fhc->filename = GNUNET_strdup (filename);
191 if (GPG_ERR_NO_ERROR != gcry_md_open (&fhc->md, GCRY_MD_SHA512, 0))
197 fhc->bsize = blocksize;
198 if (GNUNET_OK != GNUNET_DISK_file_size (filename, &fhc->fsize, GNUNET_NO))
200 GNUNET_free (fhc->filename);
205 GNUNET_DISK_file_open (filename, GNUNET_DISK_OPEN_READ,
206 GNUNET_DISK_PERM_NONE);
209 GNUNET_free (fhc->filename);
214 GNUNET_SCHEDULER_add_with_priority (priority, &file_hash_task, fhc);
220 * Cancel a file hashing operation.
222 * @param fhc operation to cancel (callback must not yet have been invoked)
225 GNUNET_CRYPTO_hash_file_cancel (struct GNUNET_CRYPTO_FileHashContext *fhc)
227 GNUNET_SCHEDULER_cancel (fhc->task);
228 GNUNET_free (fhc->filename);
229 GNUNET_break (GNUNET_OK == GNUNET_DISK_file_close (fhc->fh));
235 /* ***************** binary-ASCII encoding *************** */
238 getValue__ (unsigned char a)
240 if ((a >= '0') && (a <= '9'))
242 if ((a >= 'A') && (a <= 'V'))
243 return (a - 'A' + 10);
248 * Convert GNUNET_CRYPTO_hash to ASCII encoding. The ASCII encoding is rather
249 * GNUnet specific. It was chosen such that it only uses characters
250 * in [0-9A-V], can be produced without complex arithmetics and uses a
251 * small number of characters. The GNUnet encoding uses 103
252 * characters plus a null terminator.
254 * @param block the hash code
255 * @param result where to store the encoding (struct GNUNET_CRYPTO_HashAsciiEncoded can be
256 * safely cast to char*, a '\\0' termination is set).
259 GNUNET_CRYPTO_hash_to_enc (const GNUNET_HashCode * block,
260 struct GNUNET_CRYPTO_HashAsciiEncoded *result)
263 * 32 characters for encoding (GNUNET_CRYPTO_hash => 32 characters)
265 static char *encTable__ = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
271 GNUNET_assert (block != NULL);
272 GNUNET_assert (result != NULL);
277 while ((rpos < sizeof (GNUNET_HashCode)) || (vbit > 0))
279 if ((rpos < sizeof (GNUNET_HashCode)) && (vbit < 5))
281 bits = (bits << 8) | ((unsigned char *) block)[rpos++]; /* eat 8 more bits */
286 bits <<= (5 - vbit); /* zero-padding */
287 GNUNET_assert (vbit == 2); /* padding by 3: 512+3 mod 5 == 0 */
290 GNUNET_assert (wpos < sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1);
291 result->encoding[wpos++] = encTable__[(bits >> (vbit - 5)) & 31];
294 GNUNET_assert (wpos == sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1);
295 GNUNET_assert (vbit == 0);
296 result->encoding[wpos] = '\0';
300 * Convert ASCII encoding back to GNUNET_CRYPTO_hash
302 * @param enc the encoding
303 * @param result where to store the GNUNET_CRYPTO_hash code
304 * @return GNUNET_OK on success, GNUNET_SYSERR if result has the wrong encoding
307 GNUNET_CRYPTO_hash_from_string (const char *enc, GNUNET_HashCode * result)
314 if (strlen (enc) != sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1)
315 return GNUNET_SYSERR;
317 vbit = 2; /* padding! */
318 wpos = sizeof (GNUNET_HashCode);
319 rpos = sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1;
320 bits = getValue__ (enc[--rpos]) >> 3;
323 GNUNET_assert (rpos > 0);
324 bits = (getValue__ (enc[--rpos]) << vbit) | bits;
328 ((unsigned char *) result)[--wpos] = (unsigned char) bits;
333 GNUNET_assert (rpos == 0);
334 GNUNET_assert (vbit == 0);
339 * Compute the distance between 2 hashcodes. The computation must be
340 * fast, not involve bits[0] or bits[4] (they're used elsewhere), and be
341 * somewhat consistent. And of course, the result should be a positive
344 * @param a some hash code
345 * @param b some hash code
346 * @return a positive number which is a measure for
347 * hashcode proximity.
350 GNUNET_CRYPTO_hash_distance_u32 (const GNUNET_HashCode * a,
351 const GNUNET_HashCode * b)
353 unsigned int x1 = (a->bits[1] - b->bits[1]) >> 16;
354 unsigned int x2 = (b->bits[1] - a->bits[1]) >> 16;
360 GNUNET_CRYPTO_hash_create_random (enum GNUNET_CRYPTO_Quality mode,
361 GNUNET_HashCode * result)
365 for (i = (sizeof (GNUNET_HashCode) / sizeof (uint32_t)) - 1; i >= 0; i--)
366 result->bits[i] = GNUNET_CRYPTO_random_u32 (mode, UINT32_MAX);
370 GNUNET_CRYPTO_hash_difference (const GNUNET_HashCode * a,
371 const GNUNET_HashCode * b,
372 GNUNET_HashCode * result)
376 for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0; i--)
377 result->bits[i] = b->bits[i] - a->bits[i];
381 GNUNET_CRYPTO_hash_sum (const GNUNET_HashCode * a,
382 const GNUNET_HashCode * delta, GNUNET_HashCode * result)
386 for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0; i--)
387 result->bits[i] = delta->bits[i] + a->bits[i];
392 GNUNET_CRYPTO_hash_xor (const GNUNET_HashCode * a, const GNUNET_HashCode * b,
393 GNUNET_HashCode * result)
397 for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0; i--)
398 result->bits[i] = a->bits[i] ^ b->bits[i];
403 * Convert a hashcode into a key.
406 GNUNET_CRYPTO_hash_to_aes_key (const GNUNET_HashCode * hc,
407 struct GNUNET_CRYPTO_AesSessionKey *skey,
408 struct GNUNET_CRYPTO_AesInitializationVector *iv)
410 GNUNET_assert (sizeof (GNUNET_HashCode) >=
411 GNUNET_CRYPTO_AES_KEY_LENGTH +
412 sizeof (struct GNUNET_CRYPTO_AesInitializationVector));
413 memcpy (skey, hc, GNUNET_CRYPTO_AES_KEY_LENGTH);
415 htonl (GNUNET_CRYPTO_crc32_n (skey, GNUNET_CRYPTO_AES_KEY_LENGTH));
416 memcpy (iv, &((char *) hc)[GNUNET_CRYPTO_AES_KEY_LENGTH],
417 sizeof (struct GNUNET_CRYPTO_AesInitializationVector));
422 * Obtain a bit from a hashcode.
423 * @param code the GNUNET_CRYPTO_hash to index bit-wise
424 * @param bit index into the hashcode, [0...511]
425 * @return Bit \a bit from hashcode \a code, -1 for invalid index
428 GNUNET_CRYPTO_hash_get_bit (const GNUNET_HashCode * code, unsigned int bit)
430 GNUNET_assert (bit < 8 * sizeof (GNUNET_HashCode));
431 return (((unsigned char *) code)[bit >> 3] & (1 << (bit & 7))) > 0;
435 * Determine how many low order bits match in two
436 * GNUNET_HashCodes. i.e. - 010011 and 011111 share
437 * the first two lowest order bits, and therefore the
438 * return value is two (NOT XOR distance, nor how many
439 * bits match absolutely!).
441 * @param first the first hashcode
442 * @param second the hashcode to compare first to
444 * @return the number of bits that match
447 GNUNET_CRYPTO_hash_matching_bits (const GNUNET_HashCode * first,
448 const GNUNET_HashCode * second)
452 for (i = 0; i < sizeof (GNUNET_HashCode) * 8; i++)
453 if (GNUNET_CRYPTO_hash_get_bit (first, i) !=
454 GNUNET_CRYPTO_hash_get_bit (second, i))
456 return sizeof (GNUNET_HashCode) * 8;
461 * Compare function for HashCodes, producing a total ordering
463 * @return 1 if h1 > h2, -1 if h1 < h2 and 0 if h1 == h2.
466 GNUNET_CRYPTO_hash_cmp (const GNUNET_HashCode * h1, const GNUNET_HashCode * h2)
472 i1 = (unsigned int *) h1;
473 i2 = (unsigned int *) h2;
474 for (i = (sizeof (GNUNET_HashCode) / sizeof (unsigned int)) - 1; i >= 0; i--)
486 * Find out which of the two GNUNET_CRYPTO_hash codes is closer to target
487 * in the XOR metric (Kademlia).
488 * @return -1 if h1 is closer, 1 if h2 is closer and 0 if h1==h2.
491 GNUNET_CRYPTO_hash_xorcmp (const GNUNET_HashCode * h1,
492 const GNUNET_HashCode * h2,
493 const GNUNET_HashCode * target)
499 for (i = sizeof (GNUNET_HashCode) / sizeof (unsigned int) - 1; i >= 0; i--)
501 d1 = ((unsigned int *) h1)[i] ^ ((unsigned int *) target)[i];
502 d2 = ((unsigned int *) h2)[i] ^ ((unsigned int *) target)[i];
513 * @brief Derive an authentication key
514 * @param key authentication key
515 * @param rkey root key
517 * @param salt_len size of the salt
518 * @param ... pair of void * & size_t for context chunks, terminated by NULL
521 GNUNET_CRYPTO_hmac_derive_key (struct GNUNET_CRYPTO_AuthKey *key,
522 const struct GNUNET_CRYPTO_AesSessionKey *rkey,
523 const void *salt, size_t salt_len, ...)
527 va_start (argp, salt_len);
528 GNUNET_CRYPTO_hmac_derive_key_v (key, rkey, salt, salt_len, argp);
534 * @brief Derive an authentication key
535 * @param key authentication key
536 * @param rkey root key
538 * @param salt_len size of the salt
539 * @param argp pair of void * & size_t for context chunks, terminated by NULL
542 GNUNET_CRYPTO_hmac_derive_key_v (struct GNUNET_CRYPTO_AuthKey *key,
543 const struct GNUNET_CRYPTO_AesSessionKey *rkey,
544 const void *salt, size_t salt_len,
547 GNUNET_CRYPTO_kdf_v (key->key, sizeof (key->key), salt, salt_len, rkey->key,
548 sizeof (rkey->key), argp);
553 * Calculate HMAC of a message (RFC 2104)
555 * @param key secret key
556 * @param plaintext input plaintext
557 * @param plaintext_len length of plaintext
558 * @param hmac where to store the hmac
561 GNUNET_CRYPTO_hmac (const struct GNUNET_CRYPTO_AuthKey *key,
562 const void *plaintext, size_t plaintext_len,
563 GNUNET_HashCode * hmac)
566 const unsigned char *mc;
568 GNUNET_assert (GPG_ERR_NO_ERROR ==
569 gcry_md_open (&md, GCRY_MD_SHA512, GCRY_MD_FLAG_HMAC));
570 gcry_md_setkey (md, key->key, sizeof (key->key));
571 gcry_md_write (md, plaintext, plaintext_len);
572 mc = gcry_md_read (md, GCRY_MD_SHA512);
574 memcpy (hmac->bits, mc, sizeof (hmac->bits));
579 /* end of crypto_hash.c */