src/include/gnunet_crypto_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2001-2013 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 3, 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  * @defgroup crypto Cryptographic operations
  32  * @defgroup hash Hashing and operations on hashes
  33  */
  34
  35 #ifndef GNUNET_CRYPTO_LIB_H
  36 #define GNUNET_CRYPTO_LIB_H
  37
  38 #ifdef __cplusplus
  39 extern "C"
  40 {
  41 #if 0                           /* keep Emacsens' auto-indent happy */
  42 }
  43 #endif
  44 #endif
  45
  46 /**
  47  * @brief A 512-bit hashcode
  48  */
  49 struct GNUNET_HashCode;
  50
  51 /**
  52  * The identity of the host (wraps the signing key of the peer).
  53  */
  54 struct GNUNET_PeerIdentity;
  55
  56 #include "gnunet_common.h"
  57 #include "gnunet_scheduler_lib.h"
  58 #include <gcrypt.h>
  59
  60
  61 /**
  62  * @brief A 512-bit hashcode
  63  */
  64 struct GNUNET_HashCode
  65 {
  66   uint32_t bits[512 / 8 / sizeof (uint32_t)];   /* = 16 */
  67 };
  68
  69
  70 /**
  71  * Maximum length of an ECC signature.
  72  * Note: round up to multiple of 8 minus 2 for alignment.
  73  */
  74 #define GNUNET_CRYPTO_ECC_SIGNATURE_DATA_ENCODING_LENGTH 126
  75
  76
  77 /**
  78  * Desired quality level for random numbers.
  79  * @ingroup crypto
  80  */
  81 enum GNUNET_CRYPTO_Quality
  82 {
  83   /**
  84    * No good quality of the operation is needed (i.e.,
  85    * random numbers can be pseudo-random).
  86    * @ingroup crypto
  87    */
  88   GNUNET_CRYPTO_QUALITY_WEAK,
  89
  90   /**
  91    * High-quality operations are desired.
  92    * @ingroup crypto
  93    */
  94   GNUNET_CRYPTO_QUALITY_STRONG,
  95
  96   /**
  97    * Randomness for IVs etc. is required.
  98    * @ingroup crypto
  99    */
 100   GNUNET_CRYPTO_QUALITY_NONCE
 101 };
 102
 103
 104 /**
 105  * @brief length of the sessionkey in bytes (256 BIT sessionkey)
 106  */
 107 #define GNUNET_CRYPTO_AES_KEY_LENGTH (256/8)
 108
 109 /**
 110  * Length of a hash value
 111  */
 112 #define GNUNET_CRYPTO_HASH_LENGTH (512/8)
 113
 114 /**
 115  * How many characters (without 0-terminator) are our ASCII-encoded
 116  * public keys (ECDSA/EDDSA/ECDHE).
 117  */
 118 #define GNUNET_CRYPTO_PKEY_ASCII_LENGTH 52
 119
 120 /**
 121  * @brief 0-terminated ASCII encoding of a struct GNUNET_HashCode.
 122  */
 123 struct GNUNET_CRYPTO_HashAsciiEncoded
 124 {
 125   unsigned char encoding[104];
 126 };
 127
 128
 129 GNUNET_NETWORK_STRUCT_BEGIN
 130
 131
 132 /**
 133  * @brief header of what an ECC signature signs
 134  *        this must be followed by "size - 8" bytes of
 135  *        the actual signed data
 136  */
 137 struct GNUNET_CRYPTO_EccSignaturePurpose
 138 {
 139   /**
 140    * How many bytes does this signature sign?
 141    * (including this purpose header); in network
 142    * byte order (!).
 143    */
 144   uint32_t size GNUNET_PACKED;
 145
 146   /**
 147    * What does this signature vouch for?  This
 148    * must contain a GNUNET_SIGNATURE_PURPOSE_XXX
 149    * constant (from gnunet_signatures.h).  In
 150    * network byte order!
 151    */
 152   uint32_t purpose GNUNET_PACKED;
 153
 154 };
 155
 156
 157 /**
 158  * @brief an ECC signature using EdDSA.
 159  * See https://gnunet.org/ed25519
 160  */
 161 struct GNUNET_CRYPTO_EddsaSignature
 162 {
 163
 164   /**
 165    * R value.
 166    */
 167   unsigned char r[256 / 8];
 168
 169   /**
 170    * S value.
 171    */
 172   unsigned char s[256 / 8];
 173
 174 };
 175
 176
 177
 178 /**
 179  * @brief an ECC signature using ECDSA
 180  */
 181 struct GNUNET_CRYPTO_EcdsaSignature
 182 {
 183
 184   /**
 185    * R value.
 186    */
 187   unsigned char r[256 / 8];
 188
 189   /**
 190    * S value.
 191    */
 192   unsigned char s[256 / 8];
 193
 194 };
 195
 196
 197 /**
 198  * Public ECC key (always for Curve25519) encoded in a format suitable
 199  * for network transmission and EdDSA signatures.
 200  */
 201 struct GNUNET_CRYPTO_EddsaPublicKey
 202 {
 203   /**
 204    * Q consists of an x- and a y-value, each mod p (256 bits), given
 205    * here in affine coordinates and Ed25519 standard compact format.
 206    */
 207   unsigned char q_y[256 / 8];
 208
 209 };
 210
 211
 212 /**
 213  * Public ECC key (always for Curve25519) encoded in a format suitable
 214  * for network transmission and ECDSA signatures.
 215  */
 216 struct GNUNET_CRYPTO_EcdsaPublicKey
 217 {
 218   /**
 219    * Q consists of an x- and a y-value, each mod p (256 bits), given
 220    * here in affine coordinates and Ed25519 standard compact format.
 221    */
 222   unsigned char q_y[256 / 8];
 223
 224 };
 225
 226
 227 /**
 228  * The identity of the host (wraps the signing key of the peer).
 229  */
 230 struct GNUNET_PeerIdentity
 231 {
 232   struct GNUNET_CRYPTO_EddsaPublicKey public_key;
 233 };
 234
 235
 236 /**
 237  * Public ECC key (always for Curve25519) encoded in a format suitable
 238  * for network transmission and encryption (ECDH),
 239  * See http://cr.yp.to/ecdh.html
 240  */
 241 struct GNUNET_CRYPTO_EcdhePublicKey
 242 {
 243   /**
 244    * Q consists of an x- and a y-value, each mod p (256 bits), given
 245    * here in affine coordinates and Ed25519 standard compact format.
 246    */
 247   unsigned char q_y[256 / 8];
 248 };
 249
 250
 251 /**
 252  * Private ECC key encoded for transmission.  To be used only for ECDH
 253  * key exchange (ECDHE to be precise).
 254  */
 255 struct GNUNET_CRYPTO_EcdhePrivateKey
 256 {
 257   /**
 258    * d is a value mod n, where n has at most 256 bits.
 259    */
 260   unsigned char d[256 / 8];
 261
 262 };
 263
 264 /**
 265  * Private ECC key encoded for transmission.  To be used only for ECDSA
 266  * signatures.
 267  */
 268 struct GNUNET_CRYPTO_EcdsaPrivateKey
 269 {
 270   /**
 271    * d is a value mod n, where n has at most 256 bits.
 272    */
 273   unsigned char d[256 / 8];
 274
 275 };
 276
 277 /**
 278  * Private ECC key encoded for transmission.  To be used only for EdDSA
 279  * signatures.
 280  */
 281 struct GNUNET_CRYPTO_EddsaPrivateKey
 282 {
 283   /**
 284    * d is a value mod n, where n has at most 256 bits.
 285    */
 286   unsigned char d[256 / 8];
 287
 288 };
 289
 290
 291 /**
 292  * @brief type for session keys
 293  */
 294 struct GNUNET_CRYPTO_SymmetricSessionKey
 295 {
 296   /**
 297    * Actual key for AES.
 298    */
 299   unsigned char aes_key[GNUNET_CRYPTO_AES_KEY_LENGTH];
 300
 301   /**
 302    * Actual key for TwoFish.
 303    */
 304   unsigned char twofish_key[GNUNET_CRYPTO_AES_KEY_LENGTH];
 305
 306 };
 307
 308 GNUNET_NETWORK_STRUCT_END
 309
 310 /**
 311  * @brief IV for sym cipher
 312  *
 313  * NOTE: must be smaller (!) in size than the
 314  * `struct GNUNET_HashCode`.
 315  */
 316 struct GNUNET_CRYPTO_SymmetricInitializationVector
 317 {
 318   unsigned char aes_iv[GNUNET_CRYPTO_AES_KEY_LENGTH / 2];
 319
 320   unsigned char twofish_iv[GNUNET_CRYPTO_AES_KEY_LENGTH / 2];
 321 };
 322
 323
 324 /**
 325  * @brief type for (message) authentication keys
 326  */
 327 struct GNUNET_CRYPTO_AuthKey
 328 {
 329   unsigned char key[GNUNET_CRYPTO_HASH_LENGTH];
 330 };
 331
 332
 333 /**
 334  * Size of paillier plain texts and public keys.
 335  * Private keys and ciphertexts are twice this size.
 336  */
 337 #define GNUNET_CRYPTO_PAILLIER_BITS 2048
 338
 339
 340 /**
 341  * Paillier public key.
 342  */
 343 struct GNUNET_CRYPTO_PaillierPublicKey
 344 {
 345   /**
 346    * N value.
 347    */
 348   unsigned char n[GNUNET_CRYPTO_PAILLIER_BITS / 8];
 349 };
 350
 351
 352 /**
 353  * Paillier public key.
 354  */
 355 struct GNUNET_CRYPTO_PaillierPrivateKey
 356 {
 357   /**
 358    * Lambda-component of the private key.
 359    */
 360   unsigned char lambda[GNUNET_CRYPTO_PAILLIER_BITS / 8];
 361   /**
 362    * Mu-component of the private key.
 363    */
 364   unsigned char mu[GNUNET_CRYPTO_PAILLIER_BITS / 8];
 365 };
 366
 367
 368 /**
 369  * Paillier ciphertext.
 370  */
 371 struct GNUNET_CRYPTO_PaillierCiphertext
 372 {
 373   /**
 374    * Guaranteed minimum number of homomorphic operations with this ciphertext,
 375    * in network byte order (NBO).
 376    */
 377   int32_t remaining_ops GNUNET_PACKED;
 378
 379   /**
 380    * The bits of the ciphertext.
 381    */
 382   unsigned char bits[GNUNET_CRYPTO_PAILLIER_BITS * 2 / 8];
 383 };
 384
 385
 386 /* **************** Functions and Macros ************* */
 387
 388 /**
 389  * @ingroup crypto
 390  * Seed a weak random generator. Only #GNUNET_CRYPTO_QUALITY_WEAK-mode generator
 391  * can be seeded.
 392  *
 393  * @param seed the seed to use
 394  */
 395 void
 396 GNUNET_CRYPTO_seed_weak_random (int32_t seed);
 397
 398
 399 /**
 400  * Perform an incremental step in a CRC16 (for TCP/IP) calculation.
 401  *
 402  * @param sum current sum, initially 0
 403  * @param buf buffer to calculate CRC over (must be 16-bit aligned)
 404  * @param len number of bytes in @a buf, must be multiple of 2
 405  * @return updated crc sum (must be subjected to #GNUNET_CRYPTO_crc16_finish to get actual crc16)
 406  */
 407 uint32_t
 408 GNUNET_CRYPTO_crc16_step (uint32_t sum,
 409                           const void *buf,
 410                           size_t len);
 411
 412
 413 /**
 414  * Convert results from GNUNET_CRYPTO_crc16_step to final crc16.
 415  *
 416  * @param sum cummulative sum
 417  * @return crc16 value
 418  */
 419 uint16_t
 420 GNUNET_CRYPTO_crc16_finish (uint32_t sum);
 421
 422
 423 /**
 424  * @ingroup hash
 425  * Calculate the checksum of a buffer in one step.
 426  *
 427  * @param buf buffer to calculate CRC over (must be 16-bit aligned)
 428  * @param len number of bytes in @a buf, must be multiple of 2
 429  * @return crc16 value
 430  */
 431 uint16_t
 432 GNUNET_CRYPTO_crc16_n (const void *buf,
 433                        size_t len);
 434
 435
 436 /**
 437  * @ingroup hash
 438  * Compute the CRC32 checksum for the first len
 439  * bytes of the buffer.
 440  *
 441  * @param buf the data over which we're taking the CRC
 442  * @param len the length of the buffer @a buf in bytes
 443  * @return the resulting CRC32 checksum
 444  */
 445 int32_t
 446 GNUNET_CRYPTO_crc32_n (const void *buf,
 447                        size_t len);
 448
 449
 450 /**
 451  * @ingroup crypto
 452  * Fill block with a random values.
 453  *
 454  * @param mode desired quality of the random number
 455  * @param buffer the buffer to fill
 456  * @param length buffer length
 457  */
 458 void
 459 GNUNET_CRYPTO_random_block (enum GNUNET_CRYPTO_Quality mode,
 460                             void *buffer,
 461                             size_t length);
 462
 463 /**
 464  * @ingroup crypto
 465  * Produce a random value.
 466  *
 467  * @param mode desired quality of the random number
 468  * @param i the upper limit (exclusive) for the random number
 469  * @return a random value in the interval [0,@a i) (exclusive).
 470  */
 471 uint32_t
 472 GNUNET_CRYPTO_random_u32 (enum GNUNET_CRYPTO_Quality mode,
 473                           uint32_t i);
 474
 475
 476 /**
 477  * @ingroup crypto
 478  * Random on unsigned 64-bit values.
 479  *
 480  * @param mode desired quality of the random number
 481  * @param max value returned will be in range [0,@a max) (exclusive)
 482  * @return random 64-bit number
 483  */
 484 uint64_t
 485 GNUNET_CRYPTO_random_u64 (enum GNUNET_CRYPTO_Quality mode,
 486                           uint64_t max);
 487
 488
 489 /**
 490  * @ingroup crypto
 491  * Get an array with a random permutation of the
 492  * numbers 0...n-1.
 493  * @param mode #GNUNET_CRYPTO_QUALITY_STRONG if the strong (but expensive) PRNG should be used,
 494  *             #GNUNET_CRYPTO_QUALITY_WEAK or #GNUNET_CRYPTO_QUALITY_NONCE otherwise
 495  * @param n the size of the array
 496  * @return the permutation array (allocated from heap)
 497  */
 498 unsigned int *
 499 GNUNET_CRYPTO_random_permute (enum GNUNET_CRYPTO_Quality mode,
 500                               unsigned int n);
 501
 502
 503 /**
 504  * @ingroup crypto
 505  * Create a new random session key.
 506  *
 507  * @param key key to initialize
 508  */
 509 void
 510 GNUNET_CRYPTO_symmetric_create_session_key (struct GNUNET_CRYPTO_SymmetricSessionKey *key);
 511
 512
 513 /**
 514  * @ingroup crypto
 515  * Encrypt a block using a symmetric sessionkey.
 516  *
 517  * @param block the block to encrypt
 518  * @param size the size of the @a block
 519  * @param sessionkey the key used to encrypt
 520  * @param iv the initialization vector to use, use INITVALUE
 521  *        for streams.
 522  * @return the size of the encrypted block, -1 for errors
 523  */
 524 ssize_t
 525 GNUNET_CRYPTO_symmetric_encrypt (const void *block,
 526                                  size_t size,
 527                                  const struct GNUNET_CRYPTO_SymmetricSessionKey *sessionkey,
 528                                  const struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
 529                                  void *result);
 530
 531
 532 /**
 533  * @ingroup crypto
 534  * Decrypt a given block using a symmetric sessionkey.
 535  *
 536  * @param block the data to decrypt, encoded as returned by encrypt
 537  * @param size how big is the block?
 538  * @param sessionkey the key used to decrypt
 539  * @param iv the initialization vector to use
 540  * @param result address to store the result at
 541  * @return -1 on failure, size of decrypted block on success
 542  */
 543 ssize_t
 544 GNUNET_CRYPTO_symmetric_decrypt (const void *block,
 545                                  size_t size,
 546                                  const struct GNUNET_CRYPTO_SymmetricSessionKey *sessionkey,
 547                                  const struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
 548                                  void *result);
 549
 550
 551 /**
 552  * @ingroup crypto
 553  * @brief Derive an IV
 554  * @param iv initialization vector
 555  * @param skey session key
 556  * @param salt salt for the derivation
 557  * @param salt_len size of the @a salt
 558  * @param ... pairs of void * & size_t for context chunks, terminated by NULL
 559  */
 560 void
 561 GNUNET_CRYPTO_symmetric_derive_iv (struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
 562                                    const struct GNUNET_CRYPTO_SymmetricSessionKey *skey,
 563                                    const void *salt,
 564                                    size_t salt_len, ...);
 565
 566
 567 /**
 568  * @brief Derive an IV
 569  * @param iv initialization vector
 570  * @param skey session key
 571  * @param salt salt for the derivation
 572  * @param salt_len size of the @a salt
 573  * @param argp pairs of void * & size_t for context chunks, terminated by NULL
 574  */
 575 void
 576 GNUNET_CRYPTO_symmetric_derive_iv_v (struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
 577                                      const struct GNUNET_CRYPTO_SymmetricSessionKey *skey,
 578                                      const void *salt,
 579                                      size_t salt_len,
 580                                      va_list argp);
 581
 582
 583 /**
 584  * @ingroup hash
 585  * Convert hash to ASCII encoding.
 586  * @param block the hash code
 587  * @param result where to store the encoding (struct GNUNET_CRYPTO_HashAsciiEncoded can be
 588  *  safely cast to char*, a '\\0' termination is set).
 589  */
 590 void
 591 GNUNET_CRYPTO_hash_to_enc (const struct GNUNET_HashCode *block,
 592                            struct GNUNET_CRYPTO_HashAsciiEncoded *result);
 593
 594
 595 /**
 596  * @ingroup hash
 597  * Convert ASCII encoding back to a 'struct GNUNET_HashCode'
 598  *
 599  * @param enc the encoding
 600  * @param enclen number of characters in @a enc (without 0-terminator, which can be missing)
 601  * @param result where to store the hash code
 602  * @return #GNUNET_OK on success, #GNUNET_SYSERR if result has the wrong encoding
 603  */
 604 int
 605 GNUNET_CRYPTO_hash_from_string2 (const char *enc,
 606                                  size_t enclen,
 607                                  struct GNUNET_HashCode *result);
 608
 609
 610 /**
 611  * @ingroup hash
 612  * Convert ASCII encoding back to `struct GNUNET_HashCode`
 613  *
 614  * @param enc the encoding
 615  * @param result where to store the hash code
 616  * @return #GNUNET_OK on success, #GNUNET_SYSERR if result has the wrong encoding
 617  */
 618 #define GNUNET_CRYPTO_hash_from_string(enc, result) \
 619   GNUNET_CRYPTO_hash_from_string2 (enc, strlen(enc), result)
 620
 621
 622 /**
 623  * @ingroup hash
 624  *
 625  * Compute the distance between 2 hashcodes.  The
 626  * computation must be fast, not involve @a a[0] or @a a[4] (they're used
 627  * elsewhere), and be somewhat consistent. And of course, the result
 628  * should be a positive number.
 629  *
 630  * @param a some hash code
 631  * @param b some hash code
 632  * @return number between 0 and UINT32_MAX
 633  */
 634 uint32_t
 635 GNUNET_CRYPTO_hash_distance_u32 (const struct GNUNET_HashCode *a,
 636                                  const struct GNUNET_HashCode *b);
 637
 638
 639 /**
 640  * @ingroup hash
 641  * Compute hash of a given block.
 642  *
 643  * @param block the data to hash
 644  * @param size size of the @a block
 645  * @param ret pointer to where to write the hashcode
 646  */
 647 void
 648 GNUNET_CRYPTO_hash (const void *block,
 649                     size_t size,
 650                     struct GNUNET_HashCode *ret);
 651
 652
 653 /**
 654  * Context for cummulative hashing.
 655  */
 656 struct GNUNET_HashContext;
 657
 658
 659 /**
 660  * Start incremental hashing operation.
 661  *
 662  * @return context for incremental hash computation
 663  */
 664 struct GNUNET_HashContext *
 665 GNUNET_CRYPTO_hash_context_start (void);
 666
 667
 668 /**
 669  * Add data to be hashed.
 670  *
 671  * @param hc cummulative hash context
 672  * @param buf data to add
 673  * @param size number of bytes in @a buf
 674  */
 675 void
 676 GNUNET_CRYPTO_hash_context_read (struct GNUNET_HashContext *hc,
 677                                  const void *buf,
 678                                  size_t size);
 679
 680
 681 /**
 682  * Finish the hash computation.
 683  *
 684  * @param hc hash context to use, is freed in the process
 685  * @param r_hash where to write the latest / final hash code
 686  */
 687 void
 688 GNUNET_CRYPTO_hash_context_finish (struct GNUNET_HashContext *hc,
 689                                    struct GNUNET_HashCode *r_hash);
 690
 691
 692 /**
 693  * Abort hashing, do not bother calculating final result.
 694  *
 695  * @param hc hash context to destroy
 696  */
 697 void
 698 GNUNET_CRYPTO_hash_context_abort (struct GNUNET_HashContext *hc);
 699
 700
 701 /**
 702  * @ingroup hash
 703  * Calculate HMAC of a message (RFC 2104)
 704  *
 705  * @param key secret key
 706  * @param plaintext input plaintext
 707  * @param plaintext_len length of @a plaintext
 708  * @param hmac where to store the hmac
 709  */
 710 void
 711 GNUNET_CRYPTO_hmac (const struct GNUNET_CRYPTO_AuthKey *key,
 712                     const void *plaintext,
 713                     size_t plaintext_len,
 714                     struct GNUNET_HashCode *hmac);
 715
 716
 717 /**
 718  * Function called once the hash computation over the
 719  * specified file has completed.
 720  *
 721  * @param cls closure
 722  * @param res resulting hash, NULL on error
 723  */
 724 typedef void
 725 (*GNUNET_CRYPTO_HashCompletedCallback) (void *cls,
 726                                         const struct GNUNET_HashCode *res);
 727
 728
 729 /**
 730  * Handle to file hashing operation.
 731  */
 732 struct GNUNET_CRYPTO_FileHashContext;
 733
 734
 735 /**
 736  * @ingroup hash
 737  * Compute the hash of an entire file.
 738  *
 739  * @param priority scheduling priority to use
 740  * @param filename name of file to hash
 741  * @param blocksize number of bytes to process in one task
 742  * @param callback function to call upon completion
 743  * @param callback_cls closure for @a callback
 744  * @return NULL on (immediate) errror
 745  */
 746 struct GNUNET_CRYPTO_FileHashContext *
 747 GNUNET_CRYPTO_hash_file (enum GNUNET_SCHEDULER_Priority priority,
 748                          const char *filename,
 749                          size_t blocksize,
 750                          GNUNET_CRYPTO_HashCompletedCallback callback,
 751                          void *callback_cls);
 752
 753
 754 /**
 755  * Cancel a file hashing operation.
 756  *
 757  * @param fhc operation to cancel (callback must not yet have been invoked)
 758  */
 759 void
 760 GNUNET_CRYPTO_hash_file_cancel (struct GNUNET_CRYPTO_FileHashContext *fhc);
 761
 762
 763 /**
 764  * @ingroup hash
 765  * Create a random hash code.
 766  *
 767  * @param mode desired quality level
 768  * @param result hash code that is randomized
 769  */
 770 void
 771 GNUNET_CRYPTO_hash_create_random (enum GNUNET_CRYPTO_Quality mode,
 772                                   struct GNUNET_HashCode *result);
 773
 774
 775 /**
 776  * @ingroup hash
 777  * compute @a result = @a b - @a a
 778  *
 779  * @param a some hash code
 780  * @param b some hash code
 781  * @param result set to @a b - @a a
 782  */
 783 void
 784 GNUNET_CRYPTO_hash_difference (const struct GNUNET_HashCode *a,
 785                                const struct GNUNET_HashCode *b,
 786                                struct GNUNET_HashCode *result);
 787
 788
 789 /**
 790  * @ingroup hash
 791  * compute @a result = @a a + @a delta
 792  *
 793  * @param a some hash code
 794  * @param delta some hash code
 795  * @param result set to @a a + @a delta
 796  */
 797 void
 798 GNUNET_CRYPTO_hash_sum (const struct GNUNET_HashCode *a,
 799                         const struct GNUNET_HashCode *delta,
 800                         struct GNUNET_HashCode *result);
 801
 802
 803 /**
 804  * @ingroup hash
 805  * compute result = a ^ b
 806  *
 807  * @param a some hash code
 808  * @param b some hash code
 809  * @param result set to @a a ^ @a b
 810  */
 811 void
 812 GNUNET_CRYPTO_hash_xor (const struct GNUNET_HashCode *a,
 813                         const struct GNUNET_HashCode *b,
 814                         struct GNUNET_HashCode *result);
 815
 816
 817 /**
 818  * @ingroup hash
 819  * Convert a hashcode into a key.
 820  *
 821  * @param hc hash code that serves to generate the key
 822  * @param skey set to a valid session key
 823  * @param iv set to a valid initialization vector
 824  */
 825 void
 826 GNUNET_CRYPTO_hash_to_aes_key (const struct GNUNET_HashCode * hc,
 827                                struct GNUNET_CRYPTO_SymmetricSessionKey *skey,
 828                                struct GNUNET_CRYPTO_SymmetricInitializationVector *iv);
 829
 830
 831 /**
 832  * @ingroup hash
 833  * Obtain a bit from a hashcode.
 834  *
 835  * @param code the `struct GNUNET_HashCode` to index bit-wise
 836  * @param bit index into the hashcode, [0...159]
 837  * @return Bit \a bit from hashcode \a code, -1 for invalid index
 838  */
 839 int
 840 GNUNET_CRYPTO_hash_get_bit (const struct GNUNET_HashCode *code,
 841                             unsigned int bit);
 842
 843
 844 /**
 845  * @ingroup hash
 846  * Determine how many low order bits match in two
 847  * `struct GNUNET_HashCodes`.  i.e. - 010011 and 011111 share
 848  * the first two lowest order bits, and therefore the
 849  * return value is two (NOT XOR distance, nor how many
 850  * bits match absolutely!).
 851  *
 852  * @param first the first hashcode
 853  * @param second the hashcode to compare first to
 854  * @return the number of bits that match
 855  */
 856 unsigned int
 857 GNUNET_CRYPTO_hash_matching_bits (const struct GNUNET_HashCode *first,
 858                                   const struct GNUNET_HashCode *second);
 859
 860
 861 /**
 862  * @ingroup hash
 863  * Compare function for HashCodes, producing a total ordering
 864  * of all hashcodes.
 865  *
 866  * @param h1 some hash code
 867  * @param h2 some hash code
 868  * @return 1 if @a h1 > @a h2, -1 if @a h1 < @a h2 and 0 if @a h1 == @a h2.
 869  */
 870 int
 871 GNUNET_CRYPTO_hash_cmp (const struct GNUNET_HashCode *h1,
 872                         const struct GNUNET_HashCode *h2);
 873
 874
 875 /**
 876  * @ingroup hash
 877  * Find out which of the two GNUNET_CRYPTO_hash codes is closer to target
 878  * in the XOR metric (Kademlia).
 879  *
 880  * @param h1 some hash code
 881  * @param h2 some hash code
 882  * @param target some hash code
 883  * @return -1 if @a h1 is closer, 1 if @a h2 is closer and 0 if @a h1== @a h2.
 884  */
 885 int
 886 GNUNET_CRYPTO_hash_xorcmp (const struct GNUNET_HashCode *h1,
 887                            const struct GNUNET_HashCode *h2,
 888                            const struct GNUNET_HashCode *target);
 889
 890
 891 /**
 892  * @ingroup hash
 893  * @brief Derive an authentication key
 894  * @param key authentication key
 895  * @param rkey root key
 896  * @param salt salt
 897  * @param salt_len size of the salt
 898  * @param argp pair of void * & size_t for context chunks, terminated by NULL
 899  */
 900 void
 901 GNUNET_CRYPTO_hmac_derive_key_v (struct GNUNET_CRYPTO_AuthKey *key,
 902                                  const struct GNUNET_CRYPTO_SymmetricSessionKey *rkey,
 903                                  const void *salt, size_t salt_len,
 904                                  va_list argp);
 905
 906
 907 /**
 908  * @ingroup hash
 909  * @brief Derive an authentication key
 910  * @param key authentication key
 911  * @param rkey root key
 912  * @param salt salt
 913  * @param salt_len size of the salt
 914  * @param ... pair of void * & size_t for context chunks, terminated by NULL
 915  */
 916 void
 917 GNUNET_CRYPTO_hmac_derive_key (struct GNUNET_CRYPTO_AuthKey *key,
 918                                const struct GNUNET_CRYPTO_SymmetricSessionKey *rkey,
 919                                const void *salt, size_t salt_len,
 920                                ...);
 921
 922
 923 /**
 924  * @ingroup hash
 925  * @brief Derive key
 926  * @param result buffer for the derived key, allocated by caller
 927  * @param out_len desired length of the derived key
 928  * @param xtr_algo hash algorithm for the extraction phase, GCRY_MD_...
 929  * @param prf_algo hash algorithm for the expansion phase, GCRY_MD_...
 930  * @param xts salt
 931  * @param xts_len length of @a xts
 932  * @param skm source key material
 933  * @param skm_len length of @a skm
 934  * @param ... pair of void * & size_t for context chunks, terminated by NULL
 935  * @return #GNUNET_YES on success
 936  */
 937 int
 938 GNUNET_CRYPTO_hkdf (void *result,
 939                     size_t out_len,
 940                     int xtr_algo,
 941                     int prf_algo,
 942                     const void *xts,
 943                     size_t xts_len,
 944                     const void *skm,
 945                     size_t skm_len,
 946                     ...);
 947
 948
 949 /**
 950  * @ingroup hash
 951  * @brief Derive key
 952  * @param result buffer for the derived key, allocated by caller
 953  * @param out_len desired length of the derived key
 954  * @param xtr_algo hash algorithm for the extraction phase, GCRY_MD_...
 955  * @param prf_algo hash algorithm for the expansion phase, GCRY_MD_...
 956  * @param xts salt
 957  * @param xts_len length of @a xts
 958  * @param skm source key material
 959  * @param skm_len length of @a skm
 960  * @param argp va_list of void * & size_t pairs for context chunks
 961  * @return #GNUNET_YES on success
 962  */
 963 int
 964 GNUNET_CRYPTO_hkdf_v (void *result,
 965                       size_t out_len,
 966                       int xtr_algo,
 967                       int prf_algo,
 968                       const void *xts,
 969                       size_t xts_len,
 970                       const void *skm,
 971                       size_t skm_len,
 972                       va_list argp);
 973
 974
 975 /**
 976  * @brief Derive key
 977  * @param result buffer for the derived key, allocated by caller
 978  * @param out_len desired length of the derived key
 979  * @param xts salt
 980  * @param xts_len length of @a xts
 981  * @param skm source key material
 982  * @param skm_len length of @a skm
 983  * @param argp va_list of void * & size_t pairs for context chunks
 984  * @return #GNUNET_YES on success
 985  */
 986 int
 987 GNUNET_CRYPTO_kdf_v (void *result,
 988                      size_t out_len,
 989                      const void *xts,
 990                      size_t xts_len,
 991                      const void *skm,
 992                      size_t skm_len,
 993                      va_list argp);
 994
 995
 996 /**
 997  * @ingroup hash
 998  * @brief Derive key
 999  * @param result buffer for the derived key, allocated by caller
1000  * @param out_len desired length of the derived key
1001  * @param xts salt
1002  * @param xts_len length of @a xts
1003  * @param skm source key material
1004  * @param skm_len length of @a skm
1005  * @param ... void * & size_t pairs for context chunks
1006  * @return #GNUNET_YES on success
1007  */
1008 int
1009 GNUNET_CRYPTO_kdf (void *result,
1010                    size_t out_len,
1011                    const void *xts,
1012                    size_t xts_len,
1013                    const void *skm,
1014                    size_t skm_len,
1015                    ...);
1016
1017
1018 /**
1019  * @ingroup crypto
1020  * Extract the public key for the given private key.
1021  *
1022  * @param priv the private key
1023  * @param pub where to write the public key
1024  */
1025 void
1026 GNUNET_CRYPTO_ecdsa_key_get_public (const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv,
1027                                     struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
1028
1029 /**
1030  * @ingroup crypto
1031  * Extract the public key for the given private key.
1032  *
1033  * @param priv the private key
1034  * @param pub where to write the public key
1035  */
1036 void
1037 GNUNET_CRYPTO_eddsa_key_get_public (const struct GNUNET_CRYPTO_EddsaPrivateKey *priv,
1038                                     struct GNUNET_CRYPTO_EddsaPublicKey *pub);
1039
1040
1041
1042 /**
1043  * @ingroup crypto
1044  * Convert ECDSA public key to ECDHE public key.
1045  * Please be very careful when using this function, as mixing
1046  * cryptographic primitives is not always healthy.
1047  *
1048  * @param ecdsa ecdsa public key
1049  * @param ecdhe[OUT] ecdhe public key
1050  */
1051 void
1052 GNUNET_CRYPTO_ecdsa_public_to_ecdhe (const struct GNUNET_CRYPTO_EcdsaPublicKey *ecdsa,
1053                                      struct GNUNET_CRYPTO_EcdhePublicKey *ecdhe);
1054
1055
1056 /**
1057  * @ingroup crypto
1058  * Convert ECDSA private key to ECDHE private key.
1059  * Please be very careful when using this function, as mixing
1060  * cryptographic primitives is not always healthy.
1061  *
1062  * @param ecdsa ecdsa private key
1063  * @param ecdhe[OUT] ecdhe private key
1064  */
1065 void
1066 GNUNET_CRYPTO_ecdsa_private_to_ecdhe (const struct GNUNET_CRYPTO_EcdsaPrivateKey *ecdsa,
1067                                      struct GNUNET_CRYPTO_EcdhePrivateKey *ecdhe);
1068
1069
1070 /**
1071  * @ingroup crypto
1072  * Extract the public key for the given private key.
1073  *
1074  * @param priv the private key
1075  * @param pub where to write the public key
1076  */
1077 void
1078 GNUNET_CRYPTO_ecdhe_key_get_public (const struct GNUNET_CRYPTO_EcdhePrivateKey *priv,
1079                                     struct GNUNET_CRYPTO_EcdhePublicKey *pub);
1080
1081
1082 /**
1083  * Convert a public key to a string.
1084  *
1085  * @param pub key to convert
1086  * @return string representing @a pub
1087  */
1088 char *
1089 GNUNET_CRYPTO_ecdsa_public_key_to_string (const struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
1090
1091
1092 /**
1093  * Convert a public key to a string.
1094  *
1095  * @param pub key to convert
1096  * @return string representing @a pub
1097  */
1098 char *
1099 GNUNET_CRYPTO_eddsa_public_key_to_string (const struct GNUNET_CRYPTO_EddsaPublicKey *pub);
1100
1101
1102 /**
1103  * Convert a string representing a public key to a public key.
1104  *
1105  * @param enc encoded public key
1106  * @param enclen number of bytes in @a enc (without 0-terminator)
1107  * @param pub where to store the public key
1108  * @return #GNUNET_OK on success
1109  */
1110 int
1111 GNUNET_CRYPTO_ecdsa_public_key_from_string (const char *enc,
1112                                             size_t enclen,
1113                                             struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
1114
1115
1116 /**
1117  * Convert a string representing a private key to a private key.
1118  *
1119  * @param enc encoded public key
1120  * @param enclen number of bytes in @a enc (without 0-terminator)
1121  * @param priv where to store the private key
1122  * @return #GNUNET_OK on success
1123  */
1124 int
1125 GNUNET_CRYPTO_eddsa_private_key_from_string (const char *enc,
1126                                              size_t enclen,
1127                                              struct GNUNET_CRYPTO_EddsaPrivateKey *pub);
1128
1129
1130 /**
1131  * Convert a string representing a public key to a public key.
1132  *
1133  * @param enc encoded public key
1134  * @param enclen number of bytes in @a enc (without 0-terminator)
1135  * @param pub where to store the public key
1136  * @return #GNUNET_OK on success
1137  */
1138 int
1139 GNUNET_CRYPTO_eddsa_public_key_from_string (const char *enc,
1140                                             size_t enclen,
1141                                             struct GNUNET_CRYPTO_EddsaPublicKey *pub);
1142
1143
1144 /**
1145  * @ingroup crypto
1146  * Create a new private key by reading it from a file.  If the
1147  * files does not exist, create a new key and write it to the
1148  * file.  Caller must free return value.  Note that this function
1149  * can not guarantee that another process might not be trying
1150  * the same operation on the same file at the same time.
1151  * If the contents of the file
1152  * are invalid the old file is deleted and a fresh key is
1153  * created.
1154  *
1155  * @param filename name of file to use to store the key
1156  * @return new private key, NULL on error (for example,
1157  *   permission denied); free using #GNUNET_free
1158  */
1159 struct GNUNET_CRYPTO_EcdsaPrivateKey *
1160 GNUNET_CRYPTO_ecdsa_key_create_from_file (const char *filename);
1161
1162
1163 /**
1164  * @ingroup crypto
1165  * Create a new private key by reading it from a file.  If the
1166  * files does not exist, create a new key and write it to the
1167  * file.  Caller must free return value.  Note that this function
1168  * can not guarantee that another process might not be trying
1169  * the same operation on the same file at the same time.
1170  * If the contents of the file
1171  * are invalid the old file is deleted and a fresh key is
1172  * created.
1173  *
1174  * @param filename name of file to use to store the key
1175  * @return new private key, NULL on error (for example,
1176  *   permission denied); free using #GNUNET_free
1177  */
1178 struct GNUNET_CRYPTO_EddsaPrivateKey *
1179 GNUNET_CRYPTO_eddsa_key_create_from_file (const char *filename);
1180
1181
1182 /**
1183  * Forward declaration to simplify #include-structure.
1184  */
1185 struct GNUNET_CONFIGURATION_Handle;
1186
1187
1188 /**
1189  * @ingroup crypto
1190  * Create a new private key by reading our peer's key from
1191  * the file specified in the configuration.
1192  *
1193  * @param cfg the configuration to use
1194  * @return new private key, NULL on error (for example,
1195  *   permission denied); free using #GNUNET_free
1196  */
1197 struct GNUNET_CRYPTO_EddsaPrivateKey *
1198 GNUNET_CRYPTO_eddsa_key_create_from_configuration (const struct GNUNET_CONFIGURATION_Handle *cfg);
1199
1200
1201 /**
1202  * @ingroup crypto
1203  * Create a new private key. Caller must free return value.
1204  *
1205  * @return fresh private key; free using #GNUNET_free
1206  */
1207 struct GNUNET_CRYPTO_EcdsaPrivateKey *
1208 GNUNET_CRYPTO_ecdsa_key_create (void);
1209
1210
1211 /**
1212  * @ingroup crypto
1213  * Create a new private key. Caller must free return value.
1214  *
1215  * @return fresh private key; free using #GNUNET_free
1216  */
1217 struct GNUNET_CRYPTO_EddsaPrivateKey *
1218 GNUNET_CRYPTO_eddsa_key_create (void);
1219
1220
1221 /**
1222  * @ingroup crypto
1223  * Create a new private key. Caller must free return value.
1224  *
1225  * @return fresh private key; free using #GNUNET_free
1226  */
1227 struct GNUNET_CRYPTO_EcdhePrivateKey *
1228 GNUNET_CRYPTO_ecdhe_key_create (void);
1229
1230
1231 /**
1232  * @ingroup crypto
1233  * Clear memory that was used to store a private key.
1234  *
1235  * @param pk location of the key
1236  */
1237 void
1238 GNUNET_CRYPTO_eddsa_key_clear (struct GNUNET_CRYPTO_EddsaPrivateKey *pk);
1239
1240
1241 /**
1242  * @ingroup crypto
1243  * Clear memory that was used to store a private key.
1244  *
1245  * @param pk location of the key
1246  */
1247 void
1248 GNUNET_CRYPTO_ecdsa_key_clear (struct GNUNET_CRYPTO_EcdsaPrivateKey *pk);
1249
1250 /**
1251  * @ingroup crypto
1252  * Clear memory that was used to store a private key.
1253  *
1254  * @param pk location of the key
1255  */
1256 void
1257 GNUNET_CRYPTO_ecdhe_key_clear (struct GNUNET_CRYPTO_EcdhePrivateKey *pk);
1258
1259
1260 /**
1261  * @ingroup crypto
1262  * Get the shared private key we use for anonymous users.
1263  *
1264  * @return "anonymous" private key; do not free
1265  */
1266 const struct GNUNET_CRYPTO_EcdsaPrivateKey *
1267 GNUNET_CRYPTO_ecdsa_key_get_anonymous (void);
1268
1269
1270 /**
1271  * @ingroup crypto
1272  * Setup a hostkey file for a peer given the name of the
1273  * configuration file (!).  This function is used so that
1274  * at a later point code can be certain that reading a
1275  * hostkey is fast (for example in time-dependent testcases).
1276 *
1277  * @param cfg_name name of the configuration file to use
1278  */
1279 void
1280 GNUNET_CRYPTO_eddsa_setup_hostkey (const char *cfg_name);
1281
1282
1283 /**
1284  * @ingroup crypto
1285  * Retrieve the identity of the host's peer.
1286  *
1287  * @param cfg configuration to use
1288  * @param dst pointer to where to write the peer identity
1289  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the identity
1290  *         could not be retrieved
1291  */
1292 int
1293 GNUNET_CRYPTO_get_peer_identity (const struct GNUNET_CONFIGURATION_Handle *cfg,
1294                                  struct GNUNET_PeerIdentity *dst);
1295
1296
1297 /**
1298  * Compare two Peer Identities.
1299  *
1300  * @param first first peer identity
1301  * @param second second peer identity
1302  * @return bigger than 0 if first > second,
1303  *         0 if they are the same
1304  *         smaller than 0 if second > first
1305  */
1306 int
1307 GNUNET_CRYPTO_cmp_peer_identity (const struct GNUNET_PeerIdentity *first,
1308                                  const struct GNUNET_PeerIdentity *second);
1309
1310
1311 /**
1312  * @ingroup crypto
1313  * Derive key material from a public and a private ECC key.
1314  *
1315  * @param priv private key to use for the ECDH (x)
1316  * @param pub public key to use for the ECDH (yG)
1317  * @param key_material where to write the key material (xyG)
1318  * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
1319  */
1320 int
1321 GNUNET_CRYPTO_ecc_ecdh (const struct GNUNET_CRYPTO_EcdhePrivateKey *priv,
1322                         const struct GNUNET_CRYPTO_EcdhePublicKey *pub,
1323                         struct GNUNET_HashCode *key_material);
1324
1325
1326 /**
1327  * @ingroup crypto
1328  * EdDSA sign a given block.
1329  *
1330  * @param priv private key to use for the signing
1331  * @param purpose what to sign (size, purpose)
1332  * @param sig where to write the signature
1333  * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
1334  */
1335 int
1336 GNUNET_CRYPTO_eddsa_sign (const struct GNUNET_CRYPTO_EddsaPrivateKey *priv,
1337                           const struct GNUNET_CRYPTO_EccSignaturePurpose *purpose,
1338                           struct GNUNET_CRYPTO_EddsaSignature *sig);
1339
1340
1341 /**
1342  * @ingroup crypto
1343  * ECDSA Sign a given block.
1344  *
1345  * @param priv private key to use for the signing
1346  * @param purpose what to sign (size, purpose)
1347  * @param sig where to write the signature
1348  * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
1349  */
1350 int
1351 GNUNET_CRYPTO_ecdsa_sign (const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv,
1352                           const struct GNUNET_CRYPTO_EccSignaturePurpose *purpose,
1353                           struct GNUNET_CRYPTO_EcdsaSignature *sig);
1354
1355 /**
1356  * @ingroup crypto
1357  * Verify EdDSA signature.
1358  *
1359  * @param purpose what is the purpose that the signature should have?
1360  * @param validate block to validate (size, purpose, data)
1361  * @param sig signature that is being validated
1362  * @param pub public key of the signer
1363  * @returns #GNUNET_OK if ok, #GNUNET_SYSERR if invalid
1364  */
1365 int
1366 GNUNET_CRYPTO_eddsa_verify (uint32_t purpose,
1367                             const struct GNUNET_CRYPTO_EccSignaturePurpose *validate,
1368                             const struct GNUNET_CRYPTO_EddsaSignature *sig,
1369                             const struct GNUNET_CRYPTO_EddsaPublicKey *pub);
1370
1371
1372
1373 /**
1374  * @ingroup crypto
1375  * Verify ECDSA signature.
1376  *
1377  * @param purpose what is the purpose that the signature should have?
1378  * @param validate block to validate (size, purpose, data)
1379  * @param sig signature that is being validated
1380  * @param pub public key of the signer
1381  * @returns #GNUNET_OK if ok, #GNUNET_SYSERR if invalid
1382  */
1383 int
1384 GNUNET_CRYPTO_ecdsa_verify (uint32_t purpose,
1385                             const struct GNUNET_CRYPTO_EccSignaturePurpose *validate,
1386                             const struct GNUNET_CRYPTO_EcdsaSignature *sig,
1387                             const struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
1388
1389
1390 /**
1391  * @ingroup crypto
1392  * Derive a private key from a given private key and a label.
1393  * Essentially calculates a private key 'h = H(l,P) * d mod n'
1394  * where n is the size of the ECC group and P is the public
1395  * key associated with the private key 'd'.
1396  *
1397  * @param priv original private key
1398  * @param label label to use for key deriviation
1399  * @param context additional context to use for HKDF of 'h';
1400  *        typically the name of the subsystem/application
1401  * @return derived private key
1402  */
1403 struct GNUNET_CRYPTO_EcdsaPrivateKey *
1404 GNUNET_CRYPTO_ecdsa_private_key_derive (const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv,
1405                                         const char *label,
1406                                         const char *context);
1407
1408
1409 /**
1410  * @ingroup crypto
1411  * Derive a public key from a given public key and a label.
1412  * Essentially calculates a public key 'V = H(l,P) * P'.
1413  *
1414  * @param pub original public key
1415  * @param label label to use for key deriviation
1416  * @param context additional context to use for HKDF of 'h'.
1417  *        typically the name of the subsystem/application
1418  * @param result where to write the derived public key
1419  */
1420 void
1421 GNUNET_CRYPTO_ecdsa_public_key_derive (const struct GNUNET_CRYPTO_EcdsaPublicKey *pub,
1422                                        const char *label,
1423                                        const char *context,
1424                                        struct GNUNET_CRYPTO_EcdsaPublicKey *result);
1425
1426
1427 /**
1428  * Output the given MPI value to the given buffer in network
1429  * byte order.  The MPI @a val may not be negative.
1430  *
1431  * @param buf where to output to
1432  * @param size number of bytes in @a buf
1433  * @param val value to write to @a buf
1434  */
1435 void
1436 GNUNET_CRYPTO_mpi_print_unsigned (void *buf,
1437                                   size_t size,
1438                                   gcry_mpi_t val);
1439
1440
1441 /**
1442  * Convert data buffer into MPI value.
1443  * The buffer is interpreted as network
1444  * byte order, unsigned integer.
1445  *
1446  * @param result where to store MPI value (allocated)
1447  * @param data raw data (GCRYMPI_FMT_USG)
1448  * @param size number of bytes in @a data
1449  */
1450 void
1451 GNUNET_CRYPTO_mpi_scan_unsigned (gcry_mpi_t *result,
1452                                  const void *data,
1453                                  size_t size);
1454
1455
1456 /**
1457  * Create a freshly generated paillier public key.
1458  *
1459  * @param[out] public_key Where to store the public key?
1460  * @param[out] private_key Where to store the private key?
1461  */
1462 void
1463 GNUNET_CRYPTO_paillier_create (struct GNUNET_CRYPTO_PaillierPublicKey *public_key,
1464                                struct GNUNET_CRYPTO_PaillierPrivateKey *private_key);
1465
1466
1467 /**
1468  * Encrypt a plaintext with a paillier public key.
1469  *
1470  * @param public_key Public key to use.
1471  * @param m Plaintext to encrypt.
1472  * @param desired_ops How many homomorphic ops the caller intends to use
1473  * @param[out] ciphertext Encrytion of @a plaintext with @a public_key.
1474  * @return guaranteed number of supported homomorphic operations >= 1,
1475  *         or desired_ops, in case that is lower,
1476  *         or -1 if less than one homomorphic operation is possible
1477  */
1478 int
1479 GNUNET_CRYPTO_paillier_encrypt (const struct GNUNET_CRYPTO_PaillierPublicKey *public_key,
1480                                 const gcry_mpi_t m,
1481                                 int desired_ops,
1482                                 struct GNUNET_CRYPTO_PaillierCiphertext *ciphertext);
1483
1484
1485 /**
1486  * Decrypt a paillier ciphertext with a private key.
1487  *
1488  * @param private_key Private key to use for decryption.
1489  * @param public_key Public key to use for decryption.
1490  * @param ciphertext Ciphertext to decrypt.
1491  * @param[out] m Decryption of @a ciphertext with @private_key.
1492  */
1493 void
1494 GNUNET_CRYPTO_paillier_decrypt (const struct GNUNET_CRYPTO_PaillierPrivateKey *private_key,
1495                                 const struct GNUNET_CRYPTO_PaillierPublicKey *public_key,
1496                                 const struct GNUNET_CRYPTO_PaillierCiphertext *ciphertext,
1497                                 gcry_mpi_t m);
1498
1499
1500 /**
1501  * Compute a ciphertext that represents the sum of the plaintext in @a x1 and @a x2
1502  *
1503  * Note that this operation can only be done a finite number of times
1504  * before an overflow occurs.
1505  *
1506  * @param public_key Public key to use for encryption.
1507  * @param c1 Paillier cipher text.
1508  * @param c2 Paillier cipher text.
1509  * @param[out] result Result of the homomorphic operation.
1510  * @return #GNUNET_OK if the result could be computed,
1511  *         #GNUNET_SYSERR if no more homomorphic operations are remaining.
1512  */
1513 int
1514 GNUNET_CRYPTO_paillier_hom_add (const struct GNUNET_CRYPTO_PaillierPublicKey *public_key,
1515                                 const struct GNUNET_CRYPTO_PaillierCiphertext *c1,
1516                                 const struct GNUNET_CRYPTO_PaillierCiphertext *c2,
1517                                 struct GNUNET_CRYPTO_PaillierCiphertext *result);
1518
1519
1520 /**
1521  * Get the number of remaining supported homomorphic operations.
1522  *
1523  * @param c Paillier cipher text.
1524  * @return the number of remaining homomorphic operations
1525  */
1526 int
1527 GNUNET_CRYPTO_paillier_hom_get_remaining (const struct GNUNET_CRYPTO_PaillierCiphertext *c);
1528
1529
1530 /* ********* Chaum-style RSA-based blind signatures ******************* */
1531
1532
1533
1534
1535 /**
1536  * The private information of an RSA key pair.
1537  */
1538 struct GNUNET_CRYPTO_rsa_PrivateKey;
1539
1540 /**
1541  * The public information of an RSA key pair.
1542  */
1543 struct GNUNET_CRYPTO_rsa_PublicKey;
1544
1545 /**
1546  * Key used to blind a message
1547  */
1548 struct GNUNET_CRYPTO_rsa_BlindingKey;
1549
1550 /**
1551  * @brief an RSA signature
1552  */
1553 struct GNUNET_CRYPTO_rsa_Signature;
1554
1555
1556 /**
1557  * Create a new private key. Caller must free return value.
1558  *
1559  * @param len length of the key in bits (i.e. 2048)
1560  * @return fresh private key
1561  */
1562 struct GNUNET_CRYPTO_rsa_PrivateKey *
1563 GNUNET_CRYPTO_rsa_private_key_create (unsigned int len);
1564
1565
1566 /**
1567  * Free memory occupied by the private key.
1568  *
1569  * @param key pointer to the memory to free
1570  */
1571 void
1572 GNUNET_CRYPTO_rsa_private_key_free (struct GNUNET_CRYPTO_rsa_PrivateKey *key);
1573
1574
1575 /**
1576  * Encode the private key in a format suitable for
1577  * storing it into a file.
1578  *
1579  * @param key the private key
1580  * @param[out] buffer set to a buffer with the encoded key
1581  * @return size of memory allocatedin @a buffer
1582  */
1583 size_t
1584 GNUNET_CRYPTO_rsa_private_key_encode (const struct GNUNET_CRYPTO_rsa_PrivateKey *key,
1585                                       char **buffer);
1586
1587
1588 /**
1589  * Decode the private key from the data-format back
1590  * to the "normal", internal format.
1591  *
1592  * @param buf the buffer where the private key data is stored
1593  * @param len the length of the data in @a buf
1594  * @return NULL on error
1595  */
1596 struct GNUNET_CRYPTO_rsa_PrivateKey *
1597 GNUNET_CRYPTO_rsa_private_key_decode (const char *buf,
1598                                       size_t len);
1599
1600
1601 /**
1602  * Extract the public key of the given private key.
1603  *
1604  * @param priv the private key
1605  * @retur NULL on error, otherwise the public key
1606  */
1607 struct GNUNET_CRYPTO_rsa_PublicKey *
1608 GNUNET_CRYPTO_rsa_private_key_get_public (const struct GNUNET_CRYPTO_rsa_PrivateKey *priv);
1609
1610
1611 /**
1612  * Compute hash over the public key.
1613  *
1614  * @param key public key to hash
1615  * @param hc where to store the hash code
1616  */
1617 void
1618 GNUNET_CRYPTO_rsa_public_key_hash (const struct GNUNET_CRYPTO_rsa_PublicKey *key,
1619                                    struct GNUNET_HashCode *hc);
1620
1621
1622 /**
1623  * Free memory occupied by the public key.
1624  *
1625  * @param key pointer to the memory to free
1626  */
1627 void
1628 GNUNET_CRYPTO_rsa_public_key_free (struct GNUNET_CRYPTO_rsa_PublicKey *key);
1629
1630
1631 /**
1632  * Encode the public key in a format suitable for
1633  * storing it into a file.
1634  *
1635  * @param key the private key
1636  * @param[out] buffer set to a buffer with the encoded key
1637  * @return size of memory allocated in @a buffer
1638  */
1639 size_t
1640 GNUNET_CRYPTO_rsa_public_key_encode (const struct GNUNET_CRYPTO_rsa_PublicKey *key,
1641                                      char **buffer);
1642
1643
1644 /**
1645  * Decode the public key from the data-format back
1646  * to the "normal", internal format.
1647  *
1648  * @param buf the buffer where the public key data is stored
1649  * @param len the length of the data in @a buf
1650  * @return NULL on error
1651  */
1652 struct GNUNET_CRYPTO_rsa_PublicKey *
1653 GNUNET_CRYPTO_rsa_public_key_decode (const char *buf,
1654                                      size_t len);
1655
1656
1657 /**
1658  * Create a blinding key
1659  *
1660  * @param len length of the key in bits (i.e. 2048)
1661  * @return the newly created blinding key
1662  */
1663 struct GNUNET_CRYPTO_rsa_BlindingKey *
1664 GNUNET_CRYPTO_rsa_blinding_key_create (unsigned int len);
1665
1666
1667 /**
1668  * Compare the values of two blinding keys.
1669  *
1670  * @param b1 one key
1671  * @param b2 the other key
1672  * @return 0 if the two are equal
1673  */
1674 int
1675 GNUNET_CRYPTO_rsa_blinding_key_cmp (struct GNUNET_CRYPTO_rsa_BlindingKey *b1,
1676                                     struct GNUNET_CRYPTO_rsa_BlindingKey *b2);
1677
1678
1679 /**
1680  * Destroy a blinding key
1681  *
1682  * @param bkey the blinding key to destroy
1683  */
1684 void
1685 GNUNET_CRYPTO_rsa_blinding_key_free (struct GNUNET_CRYPTO_rsa_BlindingKey *bkey);
1686
1687
1688 /**
1689  * Encode the blinding key in a format suitable for
1690  * storing it into a file.
1691  *
1692  * @param bkey the blinding key
1693  * @param[out] buffer set to a buffer with the encoded key
1694  * @return size of memory allocated in @a buffer
1695  */
1696 size_t
1697 GNUNET_CRYPTO_rsa_blinding_key_encode (const struct GNUNET_CRYPTO_rsa_BlindingKey *bkey,
1698                                        char **buffer);
1699
1700
1701 /**
1702  * Decode the blinding key from the data-format back
1703  * to the "normal", internal format.
1704  *
1705  * @param buf the buffer where the public key data is stored
1706  * @param len the length of the data in @a buf
1707  * @return NULL on error
1708  */
1709 struct GNUNET_CRYPTO_rsa_BlindingKey *
1710 GNUNET_CRYPTO_rsa_blinding_key_decode (const char *buf,
1711                                        size_t len);
1712
1713
1714 /**
1715  * Blinds the given message with the given blinding key
1716  *
1717  * @param hash hash of the message to sign
1718  * @param bkey the blinding key
1719  * @param pkey the public key of the signer
1720  * @param[out] buffer set to a buffer with the blinded message to be signed
1721  * @return number of bytes stored in @a buffer
1722  */
1723 size_t
1724 GNUNET_CRYPTO_rsa_blind (const struct GNUNET_HashCode *hash,
1725                          struct GNUNET_CRYPTO_rsa_BlindingKey *bkey,
1726                          struct GNUNET_CRYPTO_rsa_PublicKey *pkey,
1727                          char **buffer);
1728
1729
1730 /**
1731  * Sign the given message.
1732  *
1733  * @param key private key to use for the signing
1734  * @param msg the (blinded) message to sign
1735  * @param msg_len number of bytes in @a msg to sign
1736  * @return NULL on error, signature on success
1737  */
1738 struct GNUNET_CRYPTO_rsa_Signature *
1739 GNUNET_CRYPTO_rsa_sign (const struct GNUNET_CRYPTO_rsa_PrivateKey *key,
1740                         const void *msg,
1741                         size_t msg_len);
1742
1743
1744 /**
1745  * Free memory occupied by signature.
1746  *
1747  * @param sig memory to freee
1748  */
1749 void
1750 GNUNET_CRYPTO_rsa_signature_free (struct GNUNET_CRYPTO_rsa_Signature *sig);
1751
1752
1753 /**
1754  * Encode the given signature in a format suitable for storing it into a file.
1755  *
1756  * @param sig the signature
1757  * @param[out] buffer set to a buffer with the encoded key
1758  * @return size of memory allocated in @a buffer
1759  */
1760 size_t
1761 GNUNET_CRYPTO_rsa_signature_encode (const struct GNUNET_CRYPTO_rsa_Signature *sig,
1762                                     char **buffer);
1763
1764
1765 /**
1766  * Decode the signature from the data-format back to the "normal", internal
1767  * format.
1768  *
1769  * @param buf the buffer where the public key data is stored
1770  * @param len the length of the data in @a buf
1771  * @return NULL on error
1772  */
1773 struct GNUNET_CRYPTO_rsa_Signature *
1774 GNUNET_CRYPTO_rsa_signature_decode (const char *buf,
1775                                     size_t len);
1776
1777
1778 /**
1779  * Unblind a blind-signed signature.  The signature should have been generated
1780  * with #GNUNET_CRYPTO_rsa_sign() using a hash that was blinded with
1781  * #GNUNET_CRYPTO_rsa_blind().
1782  *
1783  * @param sig the signature made on the blinded signature purpose
1784  * @param bkey the blinding key used to blind the signature purpose
1785  * @param pkey the public key of the signer
1786  * @return unblinded signature on success, NULL on error
1787  */
1788 struct GNUNET_CRYPTO_rsa_Signature *
1789 GNUNET_CRYPTO_rsa_unblind (struct GNUNET_CRYPTO_rsa_Signature *sig,
1790                            struct GNUNET_CRYPTO_rsa_BlindingKey *bkey,
1791                            struct GNUNET_CRYPTO_rsa_PublicKey *pkey);
1792
1793
1794 /**
1795  * Verify whether the given hash corresponds to the given signature and the
1796  * signature is valid with respect to the given public key.
1797  *
1798  * @param hash the message to verify to match the @a sig
1799  * @param sig signature that is being validated
1800  * @param public_key public key of the signer
1801  * @returns #GNUNET_OK if ok, #GNUNET_SYSERR if invalid
1802  */
1803 int
1804 GNUNET_CRYPTO_rsa_verify (const struct GNUNET_HashCode *hash,
1805                           const struct GNUNET_CRYPTO_rsa_Signature *sig,
1806                           const struct GNUNET_CRYPTO_rsa_PublicKey *public_key);
1807
1808
1809 #if 0                           /* keep Emacsens' auto-indent happy */
1810 {
1811 #endif
1812 #ifdef __cplusplus
1813 }
1814 #endif
1815
1816
1817 /* ifndef GNUNET_CRYPTO_LIB_H */
1818 #endif
1819 /* end of gnunet_crypto_lib.h */