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