src/include/gnunet_crypto_lib.h

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