src/include/gnunet_crypto_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007 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
  21 /**
  22  * @file include/gnunet_crypto_lib.h
  23  * @brief cryptographic primitives for GNUnet
  24  *
  25  * @author Christian Grothoff
  26  * @author Krista Bennett
  27  * @author Gerd Knorr <kraxel@bytesex.org>
  28  * @author Ioana Patrascu
  29  * @author Tzvetan Horozov
  30  */
  31
  32 #ifndef GNUNET_CRYPTO_LIB_H
  33 #define GNUNET_CRYPTO_LIB_H
  34
  35 #ifdef __cplusplus
  36 extern "C"
  37 {
  38 #if 0                           /* keep Emacsens' auto-indent happy */
  39 }
  40 #endif
  41 #endif
  42
  43 #include "gnunet_common.h"
  44 #include "gnunet_scheduler_lib.h"
  45
  46 /**
  47  * Desired quality level for cryptographic operations.
  48  */
  49 enum GNUNET_CRYPTO_Quality
  50 {
  51   /**
  52    * No good quality of the operation is needed (i.e.,
  53    * random numbers can be pseudo-random).
  54    */
  55   GNUNET_CRYPTO_QUALITY_WEAK,
  56
  57   /**
  58    * High-quality operations are desired.
  59    */
  60   GNUNET_CRYPTO_QUALITY_STRONG,
  61
  62   /**
  63    * Randomness for IVs etc. is required.
  64    */
  65   GNUNET_CRYPTO_QUALITY_NONCE
  66 };
  67
  68
  69 /**
  70  * @brief length of the sessionkey in bytes (256 BIT sessionkey)
  71  */
  72 #define GNUNET_CRYPTO_AES_KEY_LENGTH (256/8)
  73
  74
  75 /**
  76  * @brief Length of RSA encrypted data (2048 bit)
  77  *
  78  * We currently do not handle encryption of data
  79  * that can not be done in a single call to the
  80  * RSA methods (read: large chunks of data).
  81  * We should never need that, as we can use
  82  * the GNUNET_CRYPTO_hash for larger pieces of data for signing,
  83  * and for encryption, we only need to encode sessionkeys!
  84  */
  85 #define GNUNET_CRYPTO_RSA_DATA_ENCODING_LENGTH 256
  86
  87
  88 /**
  89  * Length of an RSA KEY (d,e,len), 2048 bit (=256 octests) key d, 2 byte e
  90  */
  91 #define GNUNET_CRYPTO_RSA_KEY_LENGTH 258
  92
  93
  94 /**
  95  * Length of a hash value
  96  */
  97 #define GNUNET_CRYPTO_HASH_LENGTH 512/8
  98
  99 /**
 100  * The private information of an RSA key pair.
 101  */
 102 struct GNUNET_CRYPTO_RsaPrivateKey;
 103
 104
 105 /**
 106  * @brief 0-terminated ASCII encoding of a GNUNET_HashCode.
 107  */
 108 struct GNUNET_CRYPTO_HashAsciiEncoded
 109 {
 110   unsigned char encoding[104];
 111 };
 112
 113
 114
 115 /**
 116  * @brief an RSA signature
 117  */
 118 struct GNUNET_CRYPTO_RsaSignature
 119 {
 120   unsigned char sig[GNUNET_CRYPTO_RSA_DATA_ENCODING_LENGTH];
 121 };
 122
 123
 124 GNUNET_NETWORK_STRUCT_BEGIN
 125
 126 /**
 127  * @brief header of what an RSA signature signs
 128  *        this must be followed by "size - 8" bytes of
 129  *        the actual signed data
 130  */
 131 struct GNUNET_CRYPTO_RsaSignaturePurpose
 132 {
 133   /**
 134    * How many bytes does this signature sign?
 135    * (including this purpose header); in network
 136    * byte order (!).
 137    */
 138   uint32_t size GNUNET_PACKED;
 139
 140   /**
 141    * What does this signature vouch for?  This
 142    * must contain a GNUNET_SIGNATURE_PURPOSE_XXX
 143    * constant (from gnunet_signatures.h).  In
 144    * network byte order!
 145    */
 146   uint32_t purpose GNUNET_PACKED;
 147
 148 };
 149
 150
 151 /**
 152  * @brief A public key.
 153  */
 154 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
 155 {
 156   /**
 157    * In big-endian, must be GNUNET_CRYPTO_RSA_KEY_LENGTH+4
 158    */
 159   uint16_t len GNUNET_PACKED;
 160
 161   /**
 162    * Size of n in key; in big-endian!
 163    */
 164   uint16_t sizen GNUNET_PACKED;
 165
 166   /**
 167    * The key itself, contains n followed by e.
 168    */
 169   unsigned char key[GNUNET_CRYPTO_RSA_KEY_LENGTH];
 170
 171   /**
 172    * Padding (must be 0)
 173    */
 174   uint16_t padding GNUNET_PACKED;
 175 };
 176
 177
 178 /**
 179  * RSA Encrypted data.
 180  */
 181 struct GNUNET_CRYPTO_RsaEncryptedData
 182 {
 183   unsigned char encoding[GNUNET_CRYPTO_RSA_DATA_ENCODING_LENGTH];
 184 };
 185
 186
 187 /**
 188  * @brief type for session keys
 189  */
 190 struct GNUNET_CRYPTO_AesSessionKey
 191 {
 192   /**
 193    * Actual key.
 194    */
 195   unsigned char key[GNUNET_CRYPTO_AES_KEY_LENGTH];
 196
 197   /**
 198    * checksum!
 199    */
 200   uint32_t crc32 GNUNET_PACKED;
 201 };
 202 GNUNET_NETWORK_STRUCT_END
 203
 204 /**
 205  * @brief IV for sym cipher
 206  *
 207  * NOTE: must be smaller (!) in size than the
 208  * GNUNET_HashCode.
 209  */
 210 struct GNUNET_CRYPTO_AesInitializationVector
 211 {
 212   unsigned char iv[GNUNET_CRYPTO_AES_KEY_LENGTH / 2];
 213 };
 214
 215
 216 /**
 217  * @brief type for (message) authentication keys
 218  */
 219 struct GNUNET_CRYPTO_AuthKey
 220 {
 221   unsigned char key[GNUNET_CRYPTO_HASH_LENGTH];
 222 };
 223
 224
 225 /* **************** Functions and Macros ************* */
 226
 227 /**
 228  * Seed a weak random generator. Only GNUNET_CRYPTO_QUALITY_WEAK-mode generator
 229  * can be seeded.
 230  *
 231  * @param seed the seed to use
 232  */
 233 void
 234 GNUNET_CRYPTO_seed_weak_random (int32_t seed);
 235
 236
 237 /**
 238  * Perform an incremental step in a CRC16 (for TCP/IP) calculation.
 239  *
 240  * @param sum current sum, initially 0
 241  * @param buf buffer to calculate CRC over (must be 16-bit aligned)
 242  * @param len number of bytes in hdr, must be multiple of 2
 243  * @return updated crc sum (must be subjected to GNUNET_CRYPTO_crc16_finish to get actual crc16)
 244  */
 245 uint32_t
 246 GNUNET_CRYPTO_crc16_step (uint32_t sum, const void *buf, size_t len);
 247
 248
 249 /**
 250  * Convert results from GNUNET_CRYPTO_crc16_step to final crc16.
 251  *
 252  * @param sum cummulative sum
 253  * @return crc16 value
 254  */
 255 uint16_t
 256 GNUNET_CRYPTO_crc16_finish (uint32_t sum);
 257
 258
 259 /**
 260  * Calculate the checksum of a buffer in one step.
 261  *
 262  * @param buf buffer to  calculate CRC over (must be 16-bit aligned)
 263  * @param len number of bytes in hdr, must be multiple of 2
 264  * @return crc16 value
 265  */
 266 uint16_t
 267 GNUNET_CRYPTO_crc16_n (const void *buf, size_t len);
 268
 269
 270 /**
 271  * Compute the CRC32 checksum for the first len
 272  * bytes of the buffer.
 273  *
 274  * @param buf the data over which we're taking the CRC
 275  * @param len the length of the buffer in bytes
 276  * @return the resulting CRC32 checksum
 277  */
 278 int32_t
 279 GNUNET_CRYPTO_crc32_n (const void *buf, size_t len);
 280
 281
 282 /**
 283  * Produce a random value.
 284  *
 285  * @param mode desired quality of the random number
 286  * @param i the upper limit (exclusive) for the random number
 287  * @return a random value in the interval [0,i) (exclusive).
 288  */
 289 uint32_t
 290 GNUNET_CRYPTO_random_u32 (enum GNUNET_CRYPTO_Quality mode, uint32_t i);
 291
 292
 293 /**
 294  * Random on unsigned 64-bit values.
 295  *
 296  * @param mode desired quality of the random number
 297  * @param max value returned will be in range [0,max) (exclusive)
 298  * @return random 64-bit number
 299  */
 300 uint64_t
 301 GNUNET_CRYPTO_random_u64 (enum GNUNET_CRYPTO_Quality mode, uint64_t max);
 302
 303
 304 /**
 305  * Get an array with a random permutation of the
 306  * numbers 0...n-1.
 307  * @param mode GNUNET_CRYPTO_QUALITY_STRONG if the strong (but expensive) PRNG should be used, GNUNET_CRYPTO_QUALITY_WEAK otherwise
 308  * @param n the size of the array
 309  * @return the permutation array (allocated from heap)
 310  */
 311 unsigned int *
 312 GNUNET_CRYPTO_random_permute (enum GNUNET_CRYPTO_Quality mode, unsigned int n);
 313
 314
 315 /**
 316  * Create a new Session key.
 317  *
 318  * @param key key to initialize
 319  */
 320 void
 321 GNUNET_CRYPTO_aes_create_session_key (struct GNUNET_CRYPTO_AesSessionKey *key);
 322
 323 /**
 324  * Check that a new session key is well-formed.
 325  *
 326  * @param key key to check
 327  * @return GNUNET_OK if the key is valid
 328  */
 329 int
 330 GNUNET_CRYPTO_aes_check_session_key (const struct GNUNET_CRYPTO_AesSessionKey
 331                                      *key);
 332
 333
 334 /**
 335  * Encrypt a block with the public key of another
 336  * host that uses the same cyper.
 337  *
 338  * @param block the block to encrypt
 339  * @param len the size of the block
 340  * @param sessionkey the key used to encrypt
 341  * @param iv the initialization vector to use, use INITVALUE
 342  *        for streams.
 343  * @return the size of the encrypted block, -1 for errors
 344  */
 345 ssize_t
 346 GNUNET_CRYPTO_aes_encrypt (const void *block, size_t len,
 347                            const struct GNUNET_CRYPTO_AesSessionKey *sessionkey,
 348                            const struct GNUNET_CRYPTO_AesInitializationVector
 349                            *iv, void *result);
 350
 351
 352 /**
 353  * Decrypt a given block with the sessionkey.
 354  *
 355  * @param block the data to decrypt, encoded as returned by encrypt
 356  * @param size how big is the block?
 357  * @param sessionkey the key used to decrypt
 358  * @param iv the initialization vector to use
 359  * @param result address to store the result at
 360  * @return -1 on failure, size of decrypted block on success
 361  */
 362 ssize_t
 363 GNUNET_CRYPTO_aes_decrypt (const void *block, size_t size,
 364                            const struct GNUNET_CRYPTO_AesSessionKey *sessionkey,
 365                            const struct GNUNET_CRYPTO_AesInitializationVector
 366                            *iv, void *result);
 367
 368
 369 /**
 370  * @brief Derive an IV
 371  * @param iv initialization vector
 372  * @param skey session key
 373  * @param salt salt for the derivation
 374  * @param salt_len size of the salt
 375  * @param ... pairs of void * & size_t for context chunks, terminated by NULL
 376  */
 377 void
 378 GNUNET_CRYPTO_aes_derive_iv (struct GNUNET_CRYPTO_AesInitializationVector *iv,
 379                              const struct GNUNET_CRYPTO_AesSessionKey *skey,
 380                              const void *salt, size_t salt_len, ...);
 381
 382
 383 /**
 384  * @brief Derive an IV
 385  * @param iv initialization vector
 386  * @param skey session key
 387  * @param salt salt for the derivation
 388  * @param salt_len size of the salt
 389  * @param argp pairs of void * & size_t for context chunks, terminated by NULL
 390  */
 391 void
 392 GNUNET_CRYPTO_aes_derive_iv_v (struct GNUNET_CRYPTO_AesInitializationVector *iv,
 393                                const struct GNUNET_CRYPTO_AesSessionKey *skey,
 394                                const void *salt, size_t salt_len, va_list argp);
 395
 396
 397 /**
 398  * Convert hash to ASCII encoding.
 399  * @param block the hash code
 400  * @param result where to store the encoding (struct GNUNET_CRYPTO_HashAsciiEncoded can be
 401  *  safely cast to char*, a '\\0' termination is set).
 402  */
 403 void
 404 GNUNET_CRYPTO_hash_to_enc (const GNUNET_HashCode * block,
 405                            struct GNUNET_CRYPTO_HashAsciiEncoded *result);
 406
 407
 408 /**
 409  * Convert ASCII encoding back to GNUNET_CRYPTO_hash
 410  *
 411  * @param enc the encoding
 412  * @param enclen number of characters in 'enc' (without 0-terminator, which can be missing)
 413  * @param result where to store the GNUNET_CRYPTO_hash code
 414  * @return GNUNET_OK on success, GNUNET_SYSERR if result has the wrong encoding
 415  */
 416 int
 417 GNUNET_CRYPTO_hash_from_string2 (const char *enc, size_t enclen,
 418                                  GNUNET_HashCode * result);
 419
 420
 421 /**
 422  * Convert ASCII encoding back to GNUNET_CRYPTO_hash
 423  * @param enc the encoding
 424  * @param result where to store the GNUNET_CRYPTO_hash code
 425  * @return GNUNET_OK on success, GNUNET_SYSERR if result has the wrong encoding
 426  */
 427 #define GNUNET_CRYPTO_hash_from_string(enc, result) \
 428   GNUNET_CRYPTO_hash_from_string2 (enc, strlen(enc), result)
 429
 430
 431 /**
 432  * Compute the distance between 2 hashcodes.
 433  * The computation must be fast, not involve
 434  * a.a or a.e (they're used elsewhere), and
 435  * be somewhat consistent. And of course, the
 436  * result should be a positive number.
 437  *
 438  * @param a some hash code
 439  * @param b some hash code
 440  * @return number between 0 and UINT32_MAX
 441  */
 442 uint32_t
 443 GNUNET_CRYPTO_hash_distance_u32 (const GNUNET_HashCode * a,
 444                                  const GNUNET_HashCode * b);
 445
 446
 447 /**
 448  * Compute hash of a given block.
 449  *
 450  * @param block the data to hash
 451  * @param size size of the block
 452  * @param ret pointer to where to write the hashcode
 453  */
 454 void
 455 GNUNET_CRYPTO_hash (const void *block, size_t size, GNUNET_HashCode * ret);
 456
 457
 458 /**
 459  * Calculate HMAC of a message (RFC 2104)
 460  *
 461  * @param key secret key
 462  * @param plaintext input plaintext
 463  * @param plaintext_len length of plaintext
 464  * @param hmac where to store the hmac
 465  */
 466 void
 467 GNUNET_CRYPTO_hmac (const struct GNUNET_CRYPTO_AuthKey *key,
 468                     const void *plaintext, size_t plaintext_len,
 469                     GNUNET_HashCode * hmac);
 470
 471
 472 /**
 473  * Function called once the hash computation over the
 474  * specified file has completed.
 475  *
 476  * @param cls closure
 477  * @param res resulting hash, NULL on error
 478  */
 479 typedef void (*GNUNET_CRYPTO_HashCompletedCallback) (void *cls,
 480                                                      const GNUNET_HashCode *
 481                                                      res);
 482
 483
 484 /**
 485  * Handle to file hashing operation.
 486  */
 487 struct GNUNET_CRYPTO_FileHashContext;
 488
 489 /**
 490  * Compute the hash of an entire file.
 491  *
 492  * @param priority scheduling priority to use
 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  * @return NULL on (immediate) errror
 498  */
 499 struct GNUNET_CRYPTO_FileHashContext *
 500 GNUNET_CRYPTO_hash_file (enum GNUNET_SCHEDULER_Priority priority,
 501                          const char *filename, size_t blocksize,
 502                          GNUNET_CRYPTO_HashCompletedCallback callback,
 503                          void *callback_cls);
 504
 505
 506 /**
 507  * Cancel a file hashing operation.
 508  *
 509  * @param fhc operation to cancel (callback must not yet have been invoked)
 510  */
 511 void
 512 GNUNET_CRYPTO_hash_file_cancel (struct GNUNET_CRYPTO_FileHashContext *fhc);
 513
 514
 515 /**
 516  * Create a random hash code.
 517  *
 518  * @param mode desired quality level
 519  * @param result hash code that is randomized
 520  */
 521 void
 522 GNUNET_CRYPTO_hash_create_random (enum GNUNET_CRYPTO_Quality mode,
 523                                   GNUNET_HashCode * result);
 524
 525
 526 /**
 527  * compute result(delta) = b - a
 528  *
 529  * @param a some hash code
 530  * @param b some hash code
 531  * @param result set to b - a
 532  */
 533 void
 534 GNUNET_CRYPTO_hash_difference (const GNUNET_HashCode * a,
 535                                const GNUNET_HashCode * b,
 536                                GNUNET_HashCode * result);
 537
 538
 539 /**
 540  * compute result(b) = a + delta
 541  *
 542  * @param a some hash code
 543  * @param delta some hash code
 544  * @param result set to a + delta
 545  */
 546 void
 547 GNUNET_CRYPTO_hash_sum (const GNUNET_HashCode * a,
 548                         const GNUNET_HashCode * delta,
 549                         GNUNET_HashCode * result);
 550
 551
 552 /**
 553  * compute result = a ^ b
 554  *
 555  * @param a some hash code
 556  * @param b some hash code
 557  * @param result set to a ^ b
 558  */
 559 void
 560 GNUNET_CRYPTO_hash_xor (const GNUNET_HashCode * a, const GNUNET_HashCode * b,
 561                         GNUNET_HashCode * result);
 562
 563
 564 /**
 565  * Convert a hashcode into a key.
 566  *
 567  * @param hc hash code that serves to generate the key
 568  * @param skey set to a valid session key
 569  * @param iv set to a valid initialization vector
 570  */
 571 void
 572 GNUNET_CRYPTO_hash_to_aes_key (const GNUNET_HashCode * hc,
 573                                struct GNUNET_CRYPTO_AesSessionKey *skey,
 574                                struct GNUNET_CRYPTO_AesInitializationVector
 575                                *iv);
 576
 577
 578 /**
 579  * Obtain a bit from a hashcode.
 580  *
 581  * @param code the GNUNET_CRYPTO_hash to index bit-wise
 582  * @param bit index into the hashcode, [0...159]
 583  * @return Bit \a bit from hashcode \a code, -1 for invalid index
 584  */
 585 int
 586 GNUNET_CRYPTO_hash_get_bit (const GNUNET_HashCode * code, unsigned int bit);
 587
 588 /**
 589  * Determine how many low order bits match in two
 590  * GNUNET_HashCodes.  i.e. - 010011 and 011111 share
 591  * the first two lowest order bits, and therefore the
 592  * return value is two (NOT XOR distance, nor how many
 593  * bits match absolutely!).
 594  *
 595  * @param first the first hashcode
 596  * @param second the hashcode to compare first to
 597  *
 598  * @return the number of bits that match
 599  */
 600 unsigned int
 601 GNUNET_CRYPTO_hash_matching_bits (const GNUNET_HashCode * first,
 602                                   const GNUNET_HashCode * second);
 603
 604
 605 /**
 606  * Compare function for HashCodes, producing a total ordering
 607  * of all hashcodes.
 608  *
 609  * @param h1 some hash code
 610  * @param h2 some hash code
 611  * @return 1 if h1 > h2, -1 if h1 < h2 and 0 if h1 == h2.
 612  */
 613 int
 614 GNUNET_CRYPTO_hash_cmp (const GNUNET_HashCode * h1, const GNUNET_HashCode * h2);
 615
 616
 617 /**
 618  * Find out which of the two GNUNET_CRYPTO_hash codes is closer to target
 619  * in the XOR metric (Kademlia).
 620  *
 621  * @param h1 some hash code
 622  * @param h2 some hash code
 623  * @param target some hash code
 624  * @return -1 if h1 is closer, 1 if h2 is closer and 0 if h1==h2.
 625  */
 626 int
 627 GNUNET_CRYPTO_hash_xorcmp (const GNUNET_HashCode * h1,
 628                            const GNUNET_HashCode * h2,
 629                            const GNUNET_HashCode * target);
 630
 631
 632 /**
 633  * @brief Derive an authentication key
 634  * @param key authentication key
 635  * @param rkey root key
 636  * @param salt salt
 637  * @param salt_len size of the salt
 638  * @param argp pair of void * & size_t for context chunks, terminated by NULL
 639  */
 640 void
 641 GNUNET_CRYPTO_hmac_derive_key_v (struct GNUNET_CRYPTO_AuthKey *key,
 642                                  const struct GNUNET_CRYPTO_AesSessionKey *rkey,
 643                                  const void *salt, size_t salt_len,
 644                                  va_list argp);
 645
 646
 647 /**
 648  * @brief Derive an authentication key
 649  * @param key authentication key
 650  * @param rkey root key
 651  * @param salt salt
 652  * @param salt_len size of the salt
 653  * @param ... pair of void * & size_t for context chunks, terminated by NULL
 654  */
 655 void
 656 GNUNET_CRYPTO_hmac_derive_key (struct GNUNET_CRYPTO_AuthKey *key,
 657                                const struct GNUNET_CRYPTO_AesSessionKey *rkey,
 658                                const void *salt, size_t salt_len, ...);
 659
 660 /**
 661  * @brief Derive key
 662  * @param result buffer for the derived key, allocated by caller
 663  * @param out_len desired length of the derived key
 664  * @param xtr_algo hash algorithm for the extraction phase, GCRY_MD_...
 665  * @param prf_algo hash algorithm for the expansion phase, GCRY_MD_...
 666  * @param xts salt
 667  * @param xts_len length of xts
 668  * @param skm source key material
 669  * @param skm_len length of skm
 670  * @return GNUNET_YES on success
 671  */
 672 int
 673 GNUNET_CRYPTO_hkdf (void *result, size_t out_len, int xtr_algo, int prf_algo,
 674                     const void *xts, size_t xts_len, const void *skm,
 675                     size_t skm_len, ...);
 676
 677
 678 /**
 679  * @brief Derive key
 680  * @param result buffer for the derived key, allocated by caller
 681  * @param out_len desired length of the derived key
 682  * @param xtr_algo hash algorithm for the extraction phase, GCRY_MD_...
 683  * @param prf_algo hash algorithm for the expansion phase, GCRY_MD_...
 684  * @param xts salt
 685  * @param xts_len length of xts
 686  * @param skm source key material
 687  * @param skm_len length of skm
 688  * @param argp va_list of void * & size_t pairs for context chunks
 689  * @return GNUNET_YES on success
 690  */
 691 int
 692 GNUNET_CRYPTO_hkdf_v (void *result, size_t out_len, int xtr_algo, int prf_algo,
 693                       const void *xts, size_t xts_len, const void *skm,
 694                       size_t skm_len, va_list argp);
 695
 696
 697 /**
 698  * @brief Derive key
 699  * @param result buffer for the derived key, allocated by caller
 700  * @param out_len desired length of the derived key
 701  * @param xts salt
 702  * @param xts_len length of xts
 703  * @param skm source key material
 704  * @param skm_len length of skm
 705  * @param argp va_list of void * & size_t pairs for context chunks
 706  * @return GNUNET_YES on success
 707  */
 708 int
 709 GNUNET_CRYPTO_kdf_v (void *result, size_t out_len, const void *xts,
 710                      size_t xts_len, const void *skm, size_t skm_len,
 711                      va_list argp);
 712
 713
 714 /**
 715  * @brief Derive key
 716  * @param result buffer for the derived key, allocated by caller
 717  * @param out_len desired length of the derived key
 718  * @param xts salt
 719  * @param xts_len length of xts
 720  * @param skm source key material
 721  * @param skm_len length of skm
 722  * @param ... void * & size_t pairs for context chunks
 723  * @return GNUNET_YES on success
 724  */
 725 int
 726 GNUNET_CRYPTO_kdf (void *result, size_t out_len, const void *xts,
 727                    size_t xts_len, const void *skm, size_t skm_len, ...);
 728
 729
 730 /**
 731  * Create a new private key. Caller must free return value.
 732  *
 733  * @return fresh private key
 734  */
 735 struct GNUNET_CRYPTO_RsaPrivateKey *
 736 GNUNET_CRYPTO_rsa_key_create (void);
 737
 738 /**
 739  * Decode the private key from the data-format back
 740  * to the "normal", internal format.
 741  *
 742  * @param buf the buffer where the private key data is stored
 743  * @param len the length of the data in 'buffer'
 744  */
 745 struct GNUNET_CRYPTO_RsaPrivateKey *
 746 GNUNET_CRYPTO_rsa_decode_key (const char *buf, uint16_t len);
 747
 748 /**
 749  * Create a new private key by reading it from a file.  If the
 750  * files does not exist, create a new key and write it to the
 751  * file.  Caller must free return value. Note that this function
 752  * can not guarantee that another process might not be trying
 753  * the same operation on the same file at the same time.
 754  * If the contents of the file
 755  * are invalid the old file is deleted and a fresh key is
 756  * created.
 757  *
 758  * @param filename name of file to use for storage
 759  * @return new private key, NULL on error (for example,
 760  *   permission denied)
 761  */
 762 struct GNUNET_CRYPTO_RsaPrivateKey *
 763 GNUNET_CRYPTO_rsa_key_create_from_file (const char *filename);
 764
 765
 766 /**
 767  * Setup a hostkey file for a peer given the name of the
 768  * configuration file (!).  This function is used so that
 769  * at a later point code can be certain that reading a
 770  * hostkey is fast (for example in time-dependent testcases).
 771  *
 772  * @param cfg_name name of the configuration file to use
 773  */
 774 void
 775 GNUNET_CRYPTO_setup_hostkey (const char *cfg_name);
 776
 777
 778 /**
 779  * Deterministically (!) create a private key using only the
 780  * given HashCode as input to the PRNG.
 781  *
 782  * @param hc "random" input to PRNG
 783  * @return some private key purely dependent on input
 784  */
 785 struct GNUNET_CRYPTO_RsaPrivateKey *
 786 GNUNET_CRYPTO_rsa_key_create_from_hash (const GNUNET_HashCode * hc);
 787
 788
 789 /**
 790  * Free memory occupied by the private key.
 791  * @param hostkey pointer to the memory to free
 792  */
 793 void
 794 GNUNET_CRYPTO_rsa_key_free (struct GNUNET_CRYPTO_RsaPrivateKey *hostkey);
 795
 796
 797 /**
 798  * Extract the public key of the host.
 799  *
 800  * @param priv the private key
 801  * @param pub where to write the public key
 802  */
 803 void
 804 GNUNET_CRYPTO_rsa_key_get_public (const struct GNUNET_CRYPTO_RsaPrivateKey
 805                                   *priv,
 806                                   struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
 807                                   *pub);
 808
 809
 810 /**
 811  * Encrypt a block with the public key of another host that uses the
 812  * same cyper.
 813  *
 814  * @param block the block to encrypt
 815  * @param size the size of block
 816  * @param publicKey the encoded public key used to encrypt
 817  * @param target where to store the encrypted block
 818  * @return GNUNET_SYSERR on error, GNUNET_OK if ok
 819  */
 820 int
 821 GNUNET_CRYPTO_rsa_encrypt (const void *block, size_t size,
 822                            const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
 823                            *publicKey,
 824                            struct GNUNET_CRYPTO_RsaEncryptedData *target);
 825
 826
 827 /**
 828  * Decrypt a given block with the hostkey.
 829  *
 830  * @param key the key to use
 831  * @param block the data to decrypt, encoded as returned by encrypt, not consumed
 832  * @param result pointer to a location where the result can be stored
 833  * @param max how many bytes of a result are expected? Must be exact.
 834  * @return the size of the decrypted block (that is, size) or -1 on error
 835  */
 836 ssize_t
 837 GNUNET_CRYPTO_rsa_decrypt (const struct GNUNET_CRYPTO_RsaPrivateKey *key,
 838                            const struct GNUNET_CRYPTO_RsaEncryptedData *block,
 839                            void *result, size_t max);
 840
 841
 842 /**
 843  * Sign a given block.
 844  *
 845  * @param key private key to use for the signing
 846  * @param purpose what to sign (size, purpose)
 847  * @param sig where to write the signature
 848  * @return GNUNET_SYSERR on error, GNUNET_OK on success
 849  */
 850 int
 851 GNUNET_CRYPTO_rsa_sign (const struct GNUNET_CRYPTO_RsaPrivateKey *key,
 852                         const struct GNUNET_CRYPTO_RsaSignaturePurpose *purpose,
 853                         struct GNUNET_CRYPTO_RsaSignature *sig);
 854
 855
 856 /**
 857  * Verify signature.  Note that the caller MUST have already
 858  * checked that "validate->size" bytes are actually available.
 859  *
 860  * @param purpose what is the purpose that validate should have?
 861  * @param validate block to validate (size, purpose, data)
 862  * @param sig signature that is being validated
 863  * @param publicKey public key of the signer
 864  * @return GNUNET_OK if ok, GNUNET_SYSERR if invalid
 865  */
 866 int
 867 GNUNET_CRYPTO_rsa_verify (uint32_t purpose,
 868                           const struct GNUNET_CRYPTO_RsaSignaturePurpose
 869                           *validate,
 870                           const struct GNUNET_CRYPTO_RsaSignature *sig,
 871                           const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
 872                           *publicKey);
 873
 874
 875
 876 /**
 877  * This function should only be called in testcases
 878  * where strong entropy gathering is not desired
 879  * (for example, for hostkey generation).
 880  */
 881 void
 882 GNUNET_CRYPTO_random_disable_entropy_gathering (void);
 883
 884 #if 0                           /* keep Emacsens' auto-indent happy */
 885 {
 886 #endif
 887 #ifdef __cplusplus
 888 }
 889 #endif
 890
 891
 892 /* ifndef GNUNET_CRYPTO_LIB_H */
 893 #endif
 894 /* end of gnunet_crypto_lib.h */