src/include/gnunet_crypto_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (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, const void *buf, size_t len);
 409
 410
 411 /**
 412  * Convert results from GNUNET_CRYPTO_crc16_step to final crc16.
 413  *
 414  * @param sum cummulative sum
 415  * @return crc16 value
 416  */
 417 uint16_t
 418 GNUNET_CRYPTO_crc16_finish (uint32_t sum);
 419
 420
 421 /**
 422  * @ingroup hash
 423  * Calculate the checksum of a buffer in one step.
 424  *
 425  * @param buf buffer to calculate CRC over (must be 16-bit aligned)
 426  * @param len number of bytes in @a buf, must be multiple of 2
 427  * @return crc16 value
 428  */
 429 uint16_t
 430 GNUNET_CRYPTO_crc16_n (const void *buf, size_t len);
 431
 432
 433 /**
 434  * @ingroup hash
 435  * Compute the CRC32 checksum for the first len
 436  * bytes of the buffer.
 437  *
 438  * @param buf the data over which we're taking the CRC
 439  * @param len the length of the buffer @a buf in bytes
 440  * @return the resulting CRC32 checksum
 441  */
 442 int32_t
 443 GNUNET_CRYPTO_crc32_n (const void *buf, size_t len);
 444
 445
 446 /**
 447  * @ingroup crypto
 448  * Fill block with a random values.
 449  *
 450  * @param mode desired quality of the random number
 451  * @param buffer the buffer to fill
 452  * @param length buffer length
 453  */
 454 void
 455 GNUNET_CRYPTO_random_block (enum GNUNET_CRYPTO_Quality mode, void *buffer, size_t length);
 456
 457 /**
 458  * @ingroup crypto
 459  * Produce a random value.
 460  *
 461  * @param mode desired quality of the random number
 462  * @param i the upper limit (exclusive) for the random number
 463  * @return a random value in the interval [0,@a i) (exclusive).
 464  */
 465 uint32_t
 466 GNUNET_CRYPTO_random_u32 (enum GNUNET_CRYPTO_Quality mode, uint32_t i);
 467
 468
 469 /**
 470  * @ingroup crypto
 471  * Random on unsigned 64-bit values.
 472  *
 473  * @param mode desired quality of the random number
 474  * @param max value returned will be in range [0,@a max) (exclusive)
 475  * @return random 64-bit number
 476  */
 477 uint64_t
 478 GNUNET_CRYPTO_random_u64 (enum GNUNET_CRYPTO_Quality mode, uint64_t max);
 479
 480
 481 /**
 482  * @ingroup crypto
 483  * Get an array with a random permutation of the
 484  * numbers 0...n-1.
 485  * @param mode #GNUNET_CRYPTO_QUALITY_STRONG if the strong (but expensive) PRNG should be used,
 486  *             #GNUNET_CRYPTO_QUALITY_WEAK or #GNUNET_CRYPTO_QUALITY_NONCE otherwise
 487  * @param n the size of the array
 488  * @return the permutation array (allocated from heap)
 489  */
 490 unsigned int *
 491 GNUNET_CRYPTO_random_permute (enum GNUNET_CRYPTO_Quality mode, unsigned int n);
 492
 493
 494 /**
 495  * @ingroup crypto
 496  * Create a new random session key.
 497  *
 498  * @param key key to initialize
 499  */
 500 void
 501 GNUNET_CRYPTO_symmetric_create_session_key (struct GNUNET_CRYPTO_SymmetricSessionKey *key);
 502
 503
 504 /**
 505  * @ingroup crypto
 506  * Encrypt a block using a symmetric sessionkey.
 507  *
 508  * @param block the block to encrypt
 509  * @param size the size of the @a block
 510  * @param sessionkey the key used to encrypt
 511  * @param iv the initialization vector to use, use INITVALUE
 512  *        for streams.
 513  * @return the size of the encrypted block, -1 for errors
 514  */
 515 ssize_t
 516 GNUNET_CRYPTO_symmetric_encrypt (const void *block, size_t size,
 517                                  const struct GNUNET_CRYPTO_SymmetricSessionKey *sessionkey,
 518                                  const struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
 519                                  void *result);
 520
 521
 522 /**
 523  * @ingroup crypto
 524  * Decrypt a given block using a symmetric sessionkey.
 525  *
 526  * @param block the data to decrypt, encoded as returned by encrypt
 527  * @param size how big is the block?
 528  * @param sessionkey the key used to decrypt
 529  * @param iv the initialization vector to use
 530  * @param result address to store the result at
 531  * @return -1 on failure, size of decrypted block on success
 532  */
 533 ssize_t
 534 GNUNET_CRYPTO_symmetric_decrypt (const void *block, size_t size,
 535                                  const struct GNUNET_CRYPTO_SymmetricSessionKey *sessionkey,
 536                                  const struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
 537                                  void *result);
 538
 539
 540 /**
 541  * @ingroup crypto
 542  * @brief Derive an IV
 543  * @param iv initialization vector
 544  * @param skey session key
 545  * @param salt salt for the derivation
 546  * @param salt_len size of the @a salt
 547  * @param ... pairs of void * & size_t for context chunks, terminated by NULL
 548  */
 549 void
 550 GNUNET_CRYPTO_symmetric_derive_iv (struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
 551                                    const struct GNUNET_CRYPTO_SymmetricSessionKey *skey,
 552                                    const void *salt,
 553                                    size_t salt_len, ...);
 554
 555
 556 /**
 557  * @brief Derive an IV
 558  * @param iv initialization vector
 559  * @param skey session key
 560  * @param salt salt for the derivation
 561  * @param salt_len size of the @a salt
 562  * @param argp pairs of void * & size_t for context chunks, terminated by NULL
 563  */
 564 void
 565 GNUNET_CRYPTO_symmetric_derive_iv_v (struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
 566                                      const struct GNUNET_CRYPTO_SymmetricSessionKey *skey,
 567                                      const void *salt,
 568                                      size_t salt_len,
 569                                      va_list argp);
 570
 571
 572 /**
 573  * @ingroup hash
 574  * Convert hash to ASCII encoding.
 575  * @param block the hash code
 576  * @param result where to store the encoding (struct GNUNET_CRYPTO_HashAsciiEncoded can be
 577  *  safely cast to char*, a '\\0' termination is set).
 578  */
 579 void
 580 GNUNET_CRYPTO_hash_to_enc (const struct GNUNET_HashCode * block,
 581                            struct GNUNET_CRYPTO_HashAsciiEncoded *result);
 582
 583
 584 /**
 585  * @ingroup hash
 586  * Convert ASCII encoding back to a 'struct GNUNET_HashCode'
 587  *
 588  * @param enc the encoding
 589  * @param enclen number of characters in @a enc (without 0-terminator, which can be missing)
 590  * @param result where to store the hash code
 591  * @return #GNUNET_OK on success, #GNUNET_SYSERR if result has the wrong encoding
 592  */
 593 int
 594 GNUNET_CRYPTO_hash_from_string2 (const char *enc, size_t enclen,
 595                                  struct GNUNET_HashCode *result);
 596
 597
 598 /**
 599  * @ingroup hash
 600  * Convert ASCII encoding back to `struct GNUNET_HashCode`
 601  *
 602  * @param enc the encoding
 603  * @param result where to store the hash code
 604  * @return #GNUNET_OK on success, #GNUNET_SYSERR if result has the wrong encoding
 605  */
 606 #define GNUNET_CRYPTO_hash_from_string(enc, result) \
 607   GNUNET_CRYPTO_hash_from_string2 (enc, strlen(enc), result)
 608
 609
 610 /**
 611  * @ingroup hash
 612  *
 613  * Compute the distance between 2 hashcodes.  The
 614  * computation must be fast, not involve @a a[0] or @a a[4] (they're used
 615  * elsewhere), and be somewhat consistent. And of course, the result
 616  * should be a positive number.
 617  *
 618  * @param a some hash code
 619  * @param b some hash code
 620  * @return number between 0 and UINT32_MAX
 621  */
 622 uint32_t
 623 GNUNET_CRYPTO_hash_distance_u32 (const struct GNUNET_HashCode *a,
 624                                  const struct GNUNET_HashCode *b);
 625
 626
 627 /**
 628  * @ingroup hash
 629  * Compute hash of a given block.
 630  *
 631  * @param block the data to hash
 632  * @param size size of the @a block
 633  * @param ret pointer to where to write the hashcode
 634  */
 635 void
 636 GNUNET_CRYPTO_hash (const void *block,
 637                     size_t size,
 638                     struct GNUNET_HashCode *ret);
 639
 640
 641 /**
 642  * Context for cummulative hashing.
 643  */
 644 struct GNUNET_HashContext;
 645
 646
 647 /**
 648  * Start incremental hashing operation.
 649  *
 650  * @return context for incremental hash computation
 651  */
 652 struct GNUNET_HashContext *
 653 GNUNET_CRYPTO_hash_context_start (void);
 654
 655
 656 /**
 657  * Add data to be hashed.
 658  *
 659  * @param hc cummulative hash context
 660  * @param buf data to add
 661  * @param size number of bytes in @a buf
 662  */
 663 void
 664 GNUNET_CRYPTO_hash_context_read (struct GNUNET_HashContext *hc,
 665                          const void *buf,
 666                          size_t size);
 667
 668
 669 /**
 670  * Finish the hash computation.
 671  *
 672  * @param hc hash context to use, is freed in the process
 673  * @param r_hash where to write the latest / final hash code
 674  */
 675 void
 676 GNUNET_CRYPTO_hash_context_finish (struct GNUNET_HashContext *hc,
 677                            struct GNUNET_HashCode *r_hash);
 678
 679
 680 /**
 681  * Abort hashing, do not bother calculating final result.
 682  *
 683  * @param hc hash context to destroy
 684  */
 685 void
 686 GNUNET_CRYPTO_hash_context_abort (struct GNUNET_HashContext *hc);
 687
 688
 689 /**
 690  * @ingroup hash
 691  * Calculate HMAC of a message (RFC 2104)
 692  *
 693  * @param key secret key
 694  * @param plaintext input plaintext
 695  * @param plaintext_len length of @a plaintext
 696  * @param hmac where to store the hmac
 697  */
 698 void
 699 GNUNET_CRYPTO_hmac (const struct GNUNET_CRYPTO_AuthKey *key,
 700                     const void *plaintext, size_t plaintext_len,
 701                     struct GNUNET_HashCode * hmac);
 702
 703
 704 /**
 705  * Function called once the hash computation over the
 706  * specified file has completed.
 707  *
 708  * @param cls closure
 709  * @param res resulting hash, NULL on error
 710  */
 711 typedef void (*GNUNET_CRYPTO_HashCompletedCallback) (void *cls,
 712                                                      const struct GNUNET_HashCode *res);
 713
 714
 715 /**
 716  * Handle to file hashing operation.
 717  */
 718 struct GNUNET_CRYPTO_FileHashContext;
 719
 720
 721 /**
 722  * @ingroup hash
 723  * Compute the hash of an entire file.
 724  *
 725  * @param priority scheduling priority to use
 726  * @param filename name of file to hash
 727  * @param blocksize number of bytes to process in one task
 728  * @param callback function to call upon completion
 729  * @param callback_cls closure for @a callback
 730  * @return NULL on (immediate) errror
 731  */
 732 struct GNUNET_CRYPTO_FileHashContext *
 733 GNUNET_CRYPTO_hash_file (enum GNUNET_SCHEDULER_Priority priority,
 734                          const char *filename, size_t blocksize,
 735                          GNUNET_CRYPTO_HashCompletedCallback callback,
 736                          void *callback_cls);
 737
 738
 739 /**
 740  * Cancel a file hashing operation.
 741  *
 742  * @param fhc operation to cancel (callback must not yet have been invoked)
 743  */
 744 void
 745 GNUNET_CRYPTO_hash_file_cancel (struct GNUNET_CRYPTO_FileHashContext *fhc);
 746
 747
 748 /**
 749  * @ingroup hash
 750  * Create a random hash code.
 751  *
 752  * @param mode desired quality level
 753  * @param result hash code that is randomized
 754  */
 755 void
 756 GNUNET_CRYPTO_hash_create_random (enum GNUNET_CRYPTO_Quality mode,
 757                                   struct GNUNET_HashCode *result);
 758
 759
 760 /**
 761  * @ingroup hash
 762  * compute @a result = @a b - @a a
 763  *
 764  * @param a some hash code
 765  * @param b some hash code
 766  * @param result set to @a b - @a a
 767  */
 768 void
 769 GNUNET_CRYPTO_hash_difference (const struct GNUNET_HashCode *a,
 770                                const struct GNUNET_HashCode *b,
 771                                struct GNUNET_HashCode *result);
 772
 773
 774 /**
 775  * @ingroup hash
 776  * compute @a result = @a a + @a delta
 777  *
 778  * @param a some hash code
 779  * @param delta some hash code
 780  * @param result set to @a a + @a delta
 781  */
 782 void
 783 GNUNET_CRYPTO_hash_sum (const struct GNUNET_HashCode *a,
 784                         const struct GNUNET_HashCode *delta,
 785                         struct GNUNET_HashCode *result);
 786
 787
 788 /**
 789  * @ingroup hash
 790  * compute result = a ^ b
 791  *
 792  * @param a some hash code
 793  * @param b some hash code
 794  * @param result set to @a a ^ @a b
 795  */
 796 void
 797 GNUNET_CRYPTO_hash_xor (const struct GNUNET_HashCode *a,
 798                         const struct GNUNET_HashCode *b,
 799                         struct GNUNET_HashCode *result);
 800
 801
 802 /**
 803  * @ingroup hash
 804  * Convert a hashcode into a key.
 805  *
 806  * @param hc hash code that serves to generate the key
 807  * @param skey set to a valid session key
 808  * @param iv set to a valid initialization vector
 809  */
 810 void
 811 GNUNET_CRYPTO_hash_to_aes_key (const struct GNUNET_HashCode * hc,
 812                                struct GNUNET_CRYPTO_SymmetricSessionKey *skey,
 813                                struct GNUNET_CRYPTO_SymmetricInitializationVector *iv);
 814
 815
 816 /**
 817  * @ingroup hash
 818  * Obtain a bit from a hashcode.
 819  *
 820  * @param code the `struct GNUNET_HashCode` to index bit-wise
 821  * @param bit index into the hashcode, [0...159]
 822  * @return Bit \a bit from hashcode \a code, -1 for invalid index
 823  */
 824 int
 825 GNUNET_CRYPTO_hash_get_bit (const struct GNUNET_HashCode *code,
 826                             unsigned int bit);
 827
 828
 829 /**
 830  * @ingroup hash
 831  * Determine how many low order bits match in two
 832  * `struct GNUNET_HashCodes`.  i.e. - 010011 and 011111 share
 833  * the first two lowest order bits, and therefore the
 834  * return value is two (NOT XOR distance, nor how many
 835  * bits match absolutely!).
 836  *
 837  * @param first the first hashcode
 838  * @param second the hashcode to compare first to
 839  * @return the number of bits that match
 840  */
 841 unsigned int
 842 GNUNET_CRYPTO_hash_matching_bits (const struct GNUNET_HashCode *first,
 843                                   const struct GNUNET_HashCode *second);
 844
 845
 846 /**
 847  * @ingroup hash
 848  * Compare function for HashCodes, producing a total ordering
 849  * of all hashcodes.
 850  *
 851  * @param h1 some hash code
 852  * @param h2 some hash code
 853  * @return 1 if @a h1 > @a h2, -1 if @a h1 < @a h2 and 0 if @a h1 == @a h2.
 854  */
 855 int
 856 GNUNET_CRYPTO_hash_cmp (const struct GNUNET_HashCode *h1,
 857                         const struct GNUNET_HashCode *h2);
 858
 859
 860 /**
 861  * @ingroup hash
 862  * Find out which of the two GNUNET_CRYPTO_hash codes is closer to target
 863  * in the XOR metric (Kademlia).
 864  *
 865  * @param h1 some hash code
 866  * @param h2 some hash code
 867  * @param target some hash code
 868  * @return -1 if @a h1 is closer, 1 if @a h2 is closer and 0 if @a h1== @a h2.
 869  */
 870 int
 871 GNUNET_CRYPTO_hash_xorcmp (const struct GNUNET_HashCode *h1,
 872                            const struct GNUNET_HashCode *h2,
 873                            const struct GNUNET_HashCode *target);
 874
 875
 876 /**
 877  * @ingroup hash
 878  * @brief Derive an authentication key
 879  * @param key authentication key
 880  * @param rkey root key
 881  * @param salt salt
 882  * @param salt_len size of the salt
 883  * @param argp pair of void * & size_t for context chunks, terminated by NULL
 884  */
 885 void
 886 GNUNET_CRYPTO_hmac_derive_key_v (struct GNUNET_CRYPTO_AuthKey *key,
 887                                  const struct GNUNET_CRYPTO_SymmetricSessionKey *rkey,
 888                                  const void *salt, size_t salt_len,
 889                                  va_list argp);
 890
 891
 892 /**
 893  * @ingroup hash
 894  * @brief Derive an authentication key
 895  * @param key authentication key
 896  * @param rkey root key
 897  * @param salt salt
 898  * @param salt_len size of the salt
 899  * @param ... pair of void * & size_t for context chunks, terminated by NULL
 900  */
 901 void
 902 GNUNET_CRYPTO_hmac_derive_key (struct GNUNET_CRYPTO_AuthKey *key,
 903                                const struct GNUNET_CRYPTO_SymmetricSessionKey *rkey,
 904                                const void *salt, size_t salt_len, ...);
 905
 906
 907 /**
 908  * @ingroup hash
 909  * @brief Derive key
 910  * @param result buffer for the derived key, allocated by caller
 911  * @param out_len desired length of the derived key
 912  * @param xtr_algo hash algorithm for the extraction phase, GCRY_MD_...
 913  * @param prf_algo hash algorithm for the expansion phase, GCRY_MD_...
 914  * @param xts salt
 915  * @param xts_len length of @a xts
 916  * @param skm source key material
 917  * @param skm_len length of @a skm
 918  * @param ... pair of void * & size_t for context chunks, terminated by NULL
 919  * @return #GNUNET_YES on success
 920  */
 921 int
 922 GNUNET_CRYPTO_hkdf (void *result, size_t out_len, int xtr_algo, int prf_algo,
 923                     const void *xts, size_t xts_len, const void *skm,
 924                     size_t skm_len, ...);
 925
 926
 927 /**
 928  * @ingroup hash
 929  * @brief Derive key
 930  * @param result buffer for the derived key, allocated by caller
 931  * @param out_len desired length of the derived key
 932  * @param xtr_algo hash algorithm for the extraction phase, GCRY_MD_...
 933  * @param prf_algo hash algorithm for the expansion phase, GCRY_MD_...
 934  * @param xts salt
 935  * @param xts_len length of @a xts
 936  * @param skm source key material
 937  * @param skm_len length of @a skm
 938  * @param argp va_list of void * & size_t pairs for context chunks
 939  * @return #GNUNET_YES on success
 940  */
 941 int
 942 GNUNET_CRYPTO_hkdf_v (void *result, size_t out_len, int xtr_algo, int prf_algo,
 943                       const void *xts, size_t xts_len, const void *skm,
 944                       size_t skm_len, va_list argp);
 945
 946
 947 /**
 948  * @brief Derive key
 949  * @param result buffer for the derived key, allocated by caller
 950  * @param out_len desired length of the derived key
 951  * @param xts salt
 952  * @param xts_len length of @a xts
 953  * @param skm source key material
 954  * @param skm_len length of @a skm
 955  * @param argp va_list of void * & size_t pairs for context chunks
 956  * @return #GNUNET_YES on success
 957  */
 958 int
 959 GNUNET_CRYPTO_kdf_v (void *result, size_t out_len, const void *xts,
 960                      size_t xts_len, const void *skm, size_t skm_len,
 961                      va_list argp);
 962
 963
 964 /**
 965  * @ingroup hash
 966  * @brief Derive key
 967  * @param result buffer for the derived key, allocated by caller
 968  * @param out_len desired length of the derived key
 969  * @param xts salt
 970  * @param xts_len length of @a xts
 971  * @param skm source key material
 972  * @param skm_len length of @a skm
 973  * @param ... void * & size_t pairs for context chunks
 974  * @return #GNUNET_YES on success
 975  */
 976 int
 977 GNUNET_CRYPTO_kdf (void *result, size_t out_len, const void *xts,
 978                    size_t xts_len, const void *skm, size_t skm_len, ...);
 979
 980
 981 /**
 982  * @ingroup crypto
 983  * Extract the public key for the given private key.
 984  *
 985  * @param priv the private key
 986  * @param pub where to write the public key
 987  */
 988 void
 989 GNUNET_CRYPTO_ecdsa_key_get_public (const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv,
 990                                     struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
 991
 992 /**
 993  * @ingroup crypto
 994  * Extract the public key for the given private key.
 995  *
 996  * @param priv the private key
 997  * @param pub where to write the public key
 998  */
 999 void
1000 GNUNET_CRYPTO_eddsa_key_get_public (const struct GNUNET_CRYPTO_EddsaPrivateKey *priv,
1001                                     struct GNUNET_CRYPTO_EddsaPublicKey *pub);
1002
1003
1004 /**
1005  * @ingroup crypto
1006  * Extract the public key for the given private key.
1007  *
1008  * @param priv the private key
1009  * @param pub where to write the public key
1010  */
1011 void
1012 GNUNET_CRYPTO_ecdhe_key_get_public (const struct GNUNET_CRYPTO_EcdhePrivateKey *priv,
1013                                     struct GNUNET_CRYPTO_EcdhePublicKey *pub);
1014
1015
1016 /**
1017  * Convert a public key to a string.
1018  *
1019  * @param pub key to convert
1020  * @return string representing @a pub
1021  */
1022 char *
1023 GNUNET_CRYPTO_ecdsa_public_key_to_string (const struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
1024
1025
1026 /**
1027  * Convert a public key to a string.
1028  *
1029  * @param pub key to convert
1030  * @return string representing @a pub
1031  */
1032 char *
1033 GNUNET_CRYPTO_eddsa_public_key_to_string (const struct GNUNET_CRYPTO_EddsaPublicKey *pub);
1034
1035
1036 /**
1037  * Convert a string representing a public key to a public key.
1038  *
1039  * @param enc encoded public key
1040  * @param enclen number of bytes in @a enc (without 0-terminator)
1041  * @param pub where to store the public key
1042  * @return #GNUNET_OK on success
1043  */
1044 int
1045 GNUNET_CRYPTO_ecdsa_public_key_from_string (const char *enc,
1046                                             size_t enclen,
1047                                             struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
1048
1049
1050 /**
1051  * Convert a string representing a public key to a public key.
1052  *
1053  * @param enc encoded public key
1054  * @param enclen number of bytes in @a enc (without 0-terminator)
1055  * @param pub where to store the public key
1056  * @return #GNUNET_OK on success
1057  */
1058 int
1059 GNUNET_CRYPTO_eddsa_public_key_from_string (const char *enc,
1060                                             size_t enclen,
1061                                             struct GNUNET_CRYPTO_EddsaPublicKey *pub);
1062
1063
1064 /**
1065  * @ingroup crypto
1066  * Create a new private key by reading it from a file.  If the
1067  * files does not exist, create a new key and write it to the
1068  * file.  Caller must free return value.  Note that this function
1069  * can not guarantee that another process might not be trying
1070  * the same operation on the same file at the same time.
1071  * If the contents of the file
1072  * are invalid the old file is deleted and a fresh key is
1073  * created.
1074  *
1075  * @param filename name of file to use to store the key
1076  * @return new private key, NULL on error (for example,
1077  *   permission denied); free using #GNUNET_free
1078  */
1079 struct GNUNET_CRYPTO_EcdsaPrivateKey *
1080 GNUNET_CRYPTO_ecdsa_key_create_from_file (const char *filename);
1081
1082
1083 /**
1084  * @ingroup crypto
1085  * Create a new private key by reading it from a file.  If the
1086  * files does not exist, create a new key and write it to the
1087  * file.  Caller must free return value.  Note that this function
1088  * can not guarantee that another process might not be trying
1089  * the same operation on the same file at the same time.
1090  * If the contents of the file
1091  * are invalid the old file is deleted and a fresh key is
1092  * created.
1093  *
1094  * @param filename name of file to use to store the key
1095  * @return new private key, NULL on error (for example,
1096  *   permission denied); free using #GNUNET_free
1097  */
1098 struct GNUNET_CRYPTO_EddsaPrivateKey *
1099 GNUNET_CRYPTO_eddsa_key_create_from_file (const char *filename);
1100
1101 struct GNUNET_CONFIGURATION_Handle;
1102
1103
1104 /**
1105  * @ingroup crypto
1106  * Create a new private key by reading our peer's key from
1107  * the file specified in the configuration.
1108  *
1109  * @param cfg the configuration to use
1110  * @return new private key, NULL on error (for example,
1111  *   permission denied); free using #GNUNET_free
1112  */
1113 struct GNUNET_CRYPTO_EddsaPrivateKey *
1114 GNUNET_CRYPTO_eddsa_key_create_from_configuration (const struct GNUNET_CONFIGURATION_Handle *cfg);
1115
1116
1117 /**
1118  * @ingroup crypto
1119  * Create a new private key. Caller must free return value.
1120  *
1121  * @return fresh private key; free using #GNUNET_free
1122  */
1123 struct GNUNET_CRYPTO_EcdsaPrivateKey *
1124 GNUNET_CRYPTO_ecdsa_key_create (void);
1125
1126
1127 /**
1128  * @ingroup crypto
1129  * Create a new private key. Caller must free return value.
1130  *
1131  * @return fresh private key; free using #GNUNET_free
1132  */
1133 struct GNUNET_CRYPTO_EddsaPrivateKey *
1134 GNUNET_CRYPTO_eddsa_key_create (void);
1135
1136
1137 /**
1138  * @ingroup crypto
1139  * Create a new private key. Caller must free return value.
1140  *
1141  * @return fresh private key; free using #GNUNET_free
1142  */
1143 struct GNUNET_CRYPTO_EcdhePrivateKey *
1144 GNUNET_CRYPTO_ecdhe_key_create (void);
1145
1146
1147 /**
1148  * @ingroup crypto
1149  * Clear memory that was used to store a private key.
1150  *
1151  * @param pk location of the key
1152  */
1153 void
1154 GNUNET_CRYPTO_eddsa_key_clear (struct GNUNET_CRYPTO_EddsaPrivateKey *pk);
1155
1156
1157 /**
1158  * @ingroup crypto
1159  * Clear memory that was used to store a private key.
1160  *
1161  * @param pk location of the key
1162  */
1163 void
1164 GNUNET_CRYPTO_ecdsa_key_clear (struct GNUNET_CRYPTO_EcdsaPrivateKey *pk);
1165
1166 /**
1167  * @ingroup crypto
1168  * Clear memory that was used to store a private key.
1169  *
1170  * @param pk location of the key
1171  */
1172 void
1173 GNUNET_CRYPTO_ecdhe_key_clear (struct GNUNET_CRYPTO_EcdhePrivateKey *pk);
1174
1175
1176 /**
1177  * @ingroup crypto
1178  * Get the shared private key we use for anonymous users.
1179  *
1180  * @return "anonymous" private key; do not free
1181  */
1182 const struct GNUNET_CRYPTO_EcdsaPrivateKey *
1183 GNUNET_CRYPTO_ecdsa_key_get_anonymous (void);
1184
1185
1186 /**
1187  * @ingroup crypto
1188  * Setup a hostkey file for a peer given the name of the
1189  * configuration file (!).  This function is used so that
1190  * at a later point code can be certain that reading a
1191  * hostkey is fast (for example in time-dependent testcases).
1192 *
1193  * @param cfg_name name of the configuration file to use
1194  */
1195 void
1196 GNUNET_CRYPTO_eddsa_setup_hostkey (const char *cfg_name);
1197
1198
1199 /**
1200  * @ingroup crypto
1201  * Retrieve the identity of the host's peer.
1202  *
1203  * @param cfg configuration to use
1204  * @param dst pointer to where to write the peer identity
1205  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the identity
1206  *         could not be retrieved
1207  */
1208 int
1209 GNUNET_CRYPTO_get_peer_identity (const struct GNUNET_CONFIGURATION_Handle *cfg,
1210                                  struct GNUNET_PeerIdentity *dst);
1211
1212
1213 /**
1214  * Compare two Peer Identities.
1215  *
1216  * @param first first peer identity
1217  * @param second second peer identity
1218  * @return bigger than 0 if first > second,
1219  *         0 if they are the same
1220  *         smaller than 0 if second > first
1221  */
1222 int
1223 GNUNET_CRYPTO_cmp_peer_identity (const struct GNUNET_PeerIdentity *first,
1224                                  const struct GNUNET_PeerIdentity *second);
1225
1226
1227 /**
1228  * @ingroup crypto
1229  * Derive key material from a public and a private ECC key.
1230  *
1231  * @param priv private key to use for the ECDH (x)
1232  * @param pub public key to use for the ECDH (yG)
1233  * @param key_material where to write the key material (xyG)
1234  * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
1235  */
1236 int
1237 GNUNET_CRYPTO_ecc_ecdh (const struct GNUNET_CRYPTO_EcdhePrivateKey *priv,
1238                         const struct GNUNET_CRYPTO_EcdhePublicKey *pub,
1239                         struct GNUNET_HashCode *key_material);
1240
1241
1242 /**
1243  * @ingroup crypto
1244  * EdDSA sign a given block.
1245  *
1246  * @param priv private key to use for the signing
1247  * @param purpose what to sign (size, purpose)
1248  * @param sig where to write the signature
1249  * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
1250  */
1251 int
1252 GNUNET_CRYPTO_eddsa_sign (const struct GNUNET_CRYPTO_EddsaPrivateKey *priv,
1253                           const struct GNUNET_CRYPTO_EccSignaturePurpose *purpose,
1254                           struct GNUNET_CRYPTO_EddsaSignature *sig);
1255
1256
1257 /**
1258  * @ingroup crypto
1259  * ECDSA Sign a given block.
1260  *
1261  * @param priv private key to use for the signing
1262  * @param purpose what to sign (size, purpose)
1263  * @param sig where to write the signature
1264  * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
1265  */
1266 int
1267 GNUNET_CRYPTO_ecdsa_sign (const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv,
1268                           const struct GNUNET_CRYPTO_EccSignaturePurpose *purpose,
1269                           struct GNUNET_CRYPTO_EcdsaSignature *sig);
1270
1271 /**
1272  * @ingroup crypto
1273  * Verify EdDSA signature.
1274  *
1275  * @param purpose what is the purpose that the signature should have?
1276  * @param validate block to validate (size, purpose, data)
1277  * @param sig signature that is being validated
1278  * @param pub public key of the signer
1279  * @returns #GNUNET_OK if ok, #GNUNET_SYSERR if invalid
1280  */
1281 int
1282 GNUNET_CRYPTO_eddsa_verify (uint32_t purpose,
1283                             const struct GNUNET_CRYPTO_EccSignaturePurpose *validate,
1284                             const struct GNUNET_CRYPTO_EddsaSignature *sig,
1285                             const struct GNUNET_CRYPTO_EddsaPublicKey *pub);
1286
1287
1288
1289 /**
1290  * @ingroup crypto
1291  * Verify ECDSA signature.
1292  *
1293  * @param purpose what is the purpose that the signature should have?
1294  * @param validate block to validate (size, purpose, data)
1295  * @param sig signature that is being validated
1296  * @param pub public key of the signer
1297  * @returns #GNUNET_OK if ok, #GNUNET_SYSERR if invalid
1298  */
1299 int
1300 GNUNET_CRYPTO_ecdsa_verify (uint32_t purpose,
1301                             const struct GNUNET_CRYPTO_EccSignaturePurpose *validate,
1302                             const struct GNUNET_CRYPTO_EcdsaSignature *sig,
1303                             const struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
1304
1305
1306 /**
1307  * @ingroup crypto
1308  * Derive a private key from a given private key and a label.
1309  * Essentially calculates a private key 'h = H(l,P) * d mod n'
1310  * where n is the size of the ECC group and P is the public
1311  * key associated with the private key 'd'.
1312  *
1313  * @param priv original private key
1314  * @param label label to use for key deriviation
1315  * @param context additional context to use for HKDF of 'h';
1316  *        typically the name of the subsystem/application
1317  * @return derived private key
1318  */
1319 struct GNUNET_CRYPTO_EcdsaPrivateKey *
1320 GNUNET_CRYPTO_ecdsa_private_key_derive (const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv,
1321                                         const char *label,
1322                                         const char *context);
1323
1324
1325 /**
1326  * @ingroup crypto
1327  * Derive a public key from a given public key and a label.
1328  * Essentially calculates a public key 'V = H(l,P) * P'.
1329  *
1330  * @param pub original public key
1331  * @param label label to use for key deriviation
1332  * @param context additional context to use for HKDF of 'h'.
1333  *        typically the name of the subsystem/application
1334  * @param result where to write the derived public key
1335  */
1336 void
1337 GNUNET_CRYPTO_ecdsa_public_key_derive (const struct GNUNET_CRYPTO_EcdsaPublicKey *pub,
1338                                        const char *label,
1339                                        const char *context,
1340                                        struct GNUNET_CRYPTO_EcdsaPublicKey *result);
1341
1342
1343 /**
1344  * Output the given MPI value to the given buffer in network
1345  * byte order.  The MPI @a val may not be negative.
1346  *
1347  * @param buf where to output to
1348  * @param size number of bytes in @a buf
1349  * @param val value to write to @a buf
1350  */
1351 void
1352 GNUNET_CRYPTO_mpi_print_unsigned (void *buf,
1353                                   size_t size,
1354                                   gcry_mpi_t val);
1355
1356
1357 /**
1358  * Convert data buffer into MPI value.
1359  * The buffer is interpreted as network
1360  * byte order, unsigned integer.
1361  *
1362  * @param result where to store MPI value (allocated)
1363  * @param data raw data (GCRYMPI_FMT_USG)
1364  * @param size number of bytes in @a data
1365  */
1366 void
1367 GNUNET_CRYPTO_mpi_scan_unsigned (gcry_mpi_t *result,
1368                                  const void *data,
1369                                  size_t size);
1370
1371
1372 /**
1373  * Create a freshly generated paillier public key.
1374  *
1375  * @param[out] public_key Where to store the public key?
1376  * @param[out] private_key Where to store the private key?
1377  */
1378 void
1379 GNUNET_CRYPTO_paillier_create (struct GNUNET_CRYPTO_PaillierPublicKey *public_key,
1380                                struct GNUNET_CRYPTO_PaillierPrivateKey *private_key);
1381
1382
1383 /**
1384  * Encrypt a plaintext with a paillier public key.
1385  *
1386  * @param public_key Public key to use.
1387  * @param m Plaintext to encrypt.
1388  * @param desired_ops How many homomorphic ops the caller intends to use
1389  * @param[out] ciphertext Encrytion of @a plaintext with @a public_key.
1390  * @return guaranteed number of supported homomorphic operations >= 1,
1391  *         or desired_ops, in case that is lower,
1392  *         or -1 if less than one homomorphic operation is possible
1393  */
1394 int
1395 GNUNET_CRYPTO_paillier_encrypt (const struct GNUNET_CRYPTO_PaillierPublicKey *public_key,
1396                                 const gcry_mpi_t m,
1397                                 int desired_ops,
1398                                 struct GNUNET_CRYPTO_PaillierCiphertext *ciphertext);
1399
1400
1401 /**
1402  * Decrypt a paillier ciphertext with a private key.
1403  *
1404  * @param private_key Private key to use for decryption.
1405  * @param public_key Public key to use for decryption.
1406  * @param ciphertext Ciphertext to decrypt.
1407  * @param[out] m Decryption of @a ciphertext with @private_key.
1408  */
1409 void
1410 GNUNET_CRYPTO_paillier_decrypt (const struct GNUNET_CRYPTO_PaillierPrivateKey *private_key,
1411                                 const struct GNUNET_CRYPTO_PaillierPublicKey *public_key,
1412                                 const struct GNUNET_CRYPTO_PaillierCiphertext *ciphertext,
1413                                 gcry_mpi_t m);
1414
1415
1416 /**
1417  * Compute a ciphertext that represents the sum of the plaintext in @a x1 and @a x2
1418  *
1419  * Note that this operation can only be done a finite number of times
1420  * before an overflow occurs.
1421  *
1422  * @param public_key Public key to use for encryption.
1423  * @param c1 Paillier cipher text.
1424  * @param c2 Paillier cipher text.
1425  * @param[out] result Result of the homomorphic operation.
1426  * @return #GNUNET_OK if the result could be computed,
1427  *         #GNUNET_SYSERR if no more homomorphic operations are remaining.
1428  */
1429 int
1430 GNUNET_CRYPTO_paillier_hom_add (const struct GNUNET_CRYPTO_PaillierPublicKey *public_key,
1431                                 const struct GNUNET_CRYPTO_PaillierCiphertext *c1,
1432                                 const struct GNUNET_CRYPTO_PaillierCiphertext *c2,
1433                                 struct GNUNET_CRYPTO_PaillierCiphertext *result);
1434
1435
1436 /**
1437  * Get the number of remaining supported homomorphic operations.
1438  *
1439  * @param c Paillier cipher text.
1440  * @return the number of remaining homomorphic operations
1441  */
1442 int
1443 GNUNET_CRYPTO_paillier_hom_get_remaining (const struct GNUNET_CRYPTO_PaillierCiphertext *c);
1444
1445
1446 /* ********* Chaum-style RSA-based blind signatures ******************* */
1447
1448
1449
1450
1451 /**
1452  * The private information of an RSA key pair.
1453  */
1454 struct GNUNET_CRYPTO_rsa_PrivateKey;
1455
1456 /**
1457  * The public information of an RSA key pair.
1458  */
1459 struct GNUNET_CRYPTO_rsa_PublicKey;
1460
1461 /**
1462  * Key used to blind a message
1463  */
1464 struct GNUNET_CRYPTO_rsa_BlindingKey;
1465
1466 /**
1467  * @brief an RSA signature
1468  */
1469 struct GNUNET_CRYPTO_rsa_Signature;
1470
1471
1472 /**
1473  * Create a new private key. Caller must free return value.
1474  *
1475  * @param len length of the key in bits (i.e. 2048)
1476  * @return fresh private key
1477  */
1478 struct GNUNET_CRYPTO_rsa_PrivateKey *
1479 GNUNET_CRYPTO_rsa_private_key_create (unsigned int len);
1480
1481
1482 /**
1483  * Free memory occupied by the private key.
1484  *
1485  * @param key pointer to the memory to free
1486  */
1487 void
1488 GNUNET_CRYPTO_rsa_private_key_free (struct GNUNET_CRYPTO_rsa_PrivateKey *key);
1489
1490
1491 /**
1492  * Encode the private key in a format suitable for
1493  * storing it into a file.
1494  *
1495  * @param key the private key
1496  * @param[out] buffer set to a buffer with the encoded key
1497  * @return size of memory allocatedin @a buffer
1498  */
1499 size_t
1500 GNUNET_CRYPTO_rsa_private_key_encode (const struct GNUNET_CRYPTO_rsa_PrivateKey *key,
1501                               char **buffer);
1502
1503
1504 /**
1505  * Decode the private key from the data-format back
1506  * to the "normal", internal format.
1507  *
1508  * @param buf the buffer where the private key data is stored
1509  * @param len the length of the data in @a buf
1510  * @return NULL on error
1511  */
1512 struct GNUNET_CRYPTO_rsa_PrivateKey *
1513 GNUNET_CRYPTO_rsa_private_key_decode (const char *buf,
1514                               size_t len);
1515
1516
1517 /**
1518  * Extract the public key of the given private key.
1519  *
1520  * @param priv the private key
1521  * @retur NULL on error, otherwise the public key
1522  */
1523 struct GNUNET_CRYPTO_rsa_PublicKey *
1524 GNUNET_CRYPTO_rsa_private_key_get_public (const struct GNUNET_CRYPTO_rsa_PrivateKey *priv);
1525
1526
1527 /**
1528  * Free memory occupied by the public key.
1529  *
1530  * @param key pointer to the memory to free
1531  */
1532 void
1533 GNUNET_CRYPTO_rsa_public_key_free (struct GNUNET_CRYPTO_rsa_PublicKey *key);
1534
1535
1536 /**
1537  * Encode the public key in a format suitable for
1538  * storing it into a file.
1539  *
1540  * @param key the private key
1541  * @param[out] buffer set to a buffer with the encoded key
1542  * @return size of memory allocated in @a buffer
1543  */
1544 size_t
1545 GNUNET_CRYPTO_rsa_public_key_encode (const struct GNUNET_CRYPTO_rsa_PublicKey *key,
1546                              char **buffer);
1547
1548
1549 /**
1550  * Decode the public key from the data-format back
1551  * to the "normal", internal format.
1552  *
1553  * @param buf the buffer where the public key data is stored
1554  * @param len the length of the data in @a buf
1555  * @return NULL on error
1556  */
1557 struct GNUNET_CRYPTO_rsa_PublicKey *
1558 GNUNET_CRYPTO_rsa_public_key_decode (const char *buf,
1559                              size_t len);
1560
1561
1562 /**
1563  * Create a blinding key
1564  *
1565  * @param len length of the key in bits (i.e. 2048)
1566  * @return the newly created blinding key
1567  */
1568 struct GNUNET_CRYPTO_rsa_BlindingKey *
1569 GNUNET_CRYPTO_rsa_blinding_key_create (unsigned int len);
1570
1571
1572 /**
1573  * Destroy a blinding key
1574  *
1575  * @param bkey the blinding key to destroy
1576  */
1577 void
1578 GNUNET_CRYPTO_rsa_blinding_key_free (struct GNUNET_CRYPTO_rsa_BlindingKey *bkey);
1579
1580
1581 /**
1582  * Encode the blinding key in a format suitable for
1583  * storing it into a file.
1584  *
1585  * @param bkey the blinding key
1586  * @param[out] buffer set to a buffer with the encoded key
1587  * @return size of memory allocated in @a buffer
1588  */
1589 size_t
1590 GNUNET_CRYPTO_rsa_blinding_key_encode (const struct GNUNET_CRYPTO_rsa_BlindingKey *bkey,
1591                                char **buffer);
1592
1593
1594 /**
1595  * Decode the blinding key from the data-format back
1596  * to the "normal", internal format.
1597  *
1598  * @param buf the buffer where the public key data is stored
1599  * @param len the length of the data in @a buf
1600  * @return NULL on error
1601  */
1602 struct GNUNET_CRYPTO_rsa_BlindingKey *
1603 GNUNET_CRYPTO_rsa_blinding_key_decode (const char *buf,
1604                                size_t len);
1605
1606
1607 /**
1608  * Blinds the given message with the given blinding key
1609  *
1610  * @param hash hash of the message to sign
1611  * @param bkey the blinding key
1612  * @param pkey the public key of the signer
1613  * @param[out] buffer set to a buffer with the blinded message to be signed
1614  * @return number of bytes stored in @a buffer
1615  */
1616 size_t
1617 GNUNET_CRYPTO_rsa_blind (const struct GNUNET_HashCode *hash,
1618                  struct GNUNET_CRYPTO_rsa_BlindingKey *bkey,
1619                  struct GNUNET_CRYPTO_rsa_PublicKey *pkey,
1620                  char **buffer);
1621
1622
1623 /**
1624  * Sign the given message.
1625  *
1626  * @param key private key to use for the signing
1627  * @param msg the (blinded) message to sign
1628  * @param msg_len number of bytes in @a msg to sign
1629  * @return NULL on error, signature on success
1630  */
1631 struct GNUNET_CRYPTO_rsa_Signature *
1632 GNUNET_CRYPTO_rsa_sign (const struct GNUNET_CRYPTO_rsa_PrivateKey *key,
1633                 const void *msg,
1634                 size_t msg_len);
1635
1636
1637 /**
1638  * Free memory occupied by signature.
1639  *
1640  * @param sig memory to freee
1641  */
1642 void
1643 GNUNET_CRYPTO_rsa_signature_free (struct GNUNET_CRYPTO_rsa_Signature *sig);
1644
1645
1646 /**
1647  * Encode the signature key in a format suitable for
1648  * storing it into a file.
1649  *
1650  * @param sig the signature
1651  * @param[out] buffer set to a buffer with the encoded key
1652  * @return size of memory allocated in @a buffer
1653  */
1654 size_t
1655 GNUNET_CRYPTO_rsa_signature_encode (const struct GNUNET_CRYPTO_rsa_Signature *sig,
1656                             char **buffer);
1657
1658
1659 /**
1660  * Decode the public key from the data-format back
1661  * to the "normal", internal format.
1662  *
1663  * @param buf the buffer where the public key data is stored
1664  * @param len the length of the data in @a buf
1665  * @return NULL on error
1666  */
1667 struct GNUNET_CRYPTO_rsa_Signature *
1668 GNUNET_CRYPTO_rsa_signature_decode (const char *buf,
1669                             size_t len);
1670
1671
1672 /**
1673  * Unblind a signature made on blinding signature purpose.  The signature
1674  * purpose should have been generated with #GNUNET_CRYPTO_rsa_sign() using
1675  * a message that was generated with #GNUNET_CRYPTO_rsa_blind().
1676  *
1677  * @param sig the signature made on the blinded signature purpose
1678  * @param bkey the blinding key used to blind the signature purpose
1679  * @param pkey the public key of the signer
1680  * @return unblinded signature on success, NULL on error
1681  */
1682 struct GNUNET_CRYPTO_rsa_Signature *
1683 GNUNET_CRYPTO_rsa_unblind (struct GNUNET_CRYPTO_rsa_Signature *sig,
1684                    struct GNUNET_CRYPTO_rsa_BlindingKey *bkey,
1685                    struct GNUNET_CRYPTO_rsa_PublicKey *pkey);
1686
1687
1688 /**
1689  * Verify signature with the given hash.
1690  *
1691  * @param hash the message to verify to match the @a sig
1692  * @param sig signature that is being validated
1693  * @param public_key public key of the signer
1694  * @returns #GNUNET_OK if ok, #GNUNET_SYSERR if invalid
1695  */
1696 int
1697 GNUNET_CRYPTO_rsa_verify (const struct GNUNET_HashCode *hash,
1698                   const struct GNUNET_CRYPTO_rsa_Signature *sig,
1699                   const struct GNUNET_CRYPTO_rsa_PublicKey *public_key);
1700
1701
1702 #if 0                           /* keep Emacsens' auto-indent happy */
1703 {
1704 #endif
1705 #ifdef __cplusplus
1706 }
1707 #endif
1708
1709
1710 /* ifndef GNUNET_CRYPTO_LIB_H */
1711 #endif
1712 /* end of gnunet_crypto_lib.h */