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