src/include/gnunet_crypto_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 2, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file include/gnunet_crypto_lib.h
  23  * @brief cryptographic primitives for GNUnet
  24  *
  25  * @author Christian Grothoff
  26  * @author Krista Bennett
  27  * @author Gerd Knorr <kraxel@bytesex.org>
  28  * @author Ioana Patrascu
  29  * @author Tzvetan Horozov
  30  */
  31
  32 #ifndef GNUNET_CRYPTO_LIB_H
  33 #define GNUNET_CRYPTO_LIB_H
  34
  35 #ifdef __cplusplus
  36 extern "C"
  37 {
  38 #if 0                           /* keep Emacsens' auto-indent happy */
  39 }
  40 #endif
  41 #endif
  42
  43 #include "gnunet_common.h"
  44 #include "gnunet_scheduler_lib.h"
  45
  46 /**
  47  * Desired quality level for cryptographic operations.
  48  */
  49 enum GNUNET_CRYPTO_Quality
  50 {
  51   /**
  52    * No good quality of the operation is needed (i.e.,
  53    * random numbers can be pseudo-random).
  54    */
  55   GNUNET_CRYPTO_QUALITY_WEAK,
  56
  57   /**
  58    * High-quality operations are desired.
  59    */
  60   GNUNET_CRYPTO_QUALITY_STRONG
  61 };
  62
  63
  64 /**
  65  * @brief length of the sessionkey in bytes (256 BIT sessionkey)
  66  */
  67 #define GNUNET_CRYPTO_AES_KEY_LENGTH (256/8)
  68
  69
  70 /**
  71  * @brief Length of RSA encrypted data (2048 bit)
  72  *
  73  * We currently do not handle encryption of data
  74  * that can not be done in a single call to the
  75  * RSA methods (read: large chunks of data).
  76  * We should never need that, as we can use
  77  * the GNUNET_CRYPTO_hash for larger pieces of data for signing,
  78  * and for encryption, we only need to encode sessionkeys!
  79  */
  80 #define GNUNET_CRYPTO_RSA_DATA_ENCODING_LENGTH 256
  81
  82
  83 /**
  84  * Length of an RSA KEY (d,e,len), 2048 bit (=256 octests) key d, 2 byte e
  85  */
  86 #define GNUNET_CRYPTO_RSA_KEY_LENGTH 258
  87
  88
  89 /**
  90  * The private information of an RSA key pair.
  91  */
  92 struct GNUNET_CRYPTO_RsaPrivateKey;
  93
  94
  95 /**
  96  * @brief 0-terminated ASCII encoding of a GNUNET_HashCode.
  97  */
  98 struct GNUNET_CRYPTO_HashAsciiEncoded
  99 {
 100   unsigned char encoding[104];
 101 };
 102
 103
 104
 105 /**
 106  * @brief an RSA signature
 107  */
 108 struct GNUNET_CRYPTO_RsaSignature
 109 {
 110   unsigned char sig[GNUNET_CRYPTO_RSA_DATA_ENCODING_LENGTH];
 111 };
 112
 113
 114 /**
 115  * @brief header of what an RSA signature signs
 116  *        this must be followed by "size - 8" bytes of
 117  *        the actual signed data
 118  */
 119 struct GNUNET_CRYPTO_RsaSignaturePurpose
 120 {
 121   /**
 122    * How many bytes does this signature sign?
 123    * (including this purpose header); in network
 124    * byte order (!).
 125    */
 126   uint32_t size GNUNET_PACKED;
 127
 128   /**
 129    * What does this signature vouch for?  This
 130    * must contain a GNUNET_SIGNATURE_PURPOSE_XXX
 131    * constant (from gnunet_signatures.h).  In
 132    * network byte order!
 133    */
 134   uint32_t purpose GNUNET_PACKED;
 135
 136 };
 137
 138
 139 /**
 140  * @brief A public key.
 141  */
 142 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
 143 {
 144   /**
 145    * In big-endian, must be GNUNET_CRYPTO_RSA_KEY_LENGTH+4
 146    */
 147   uint16_t len GNUNET_PACKED;
 148
 149   /**
 150    * Size of n in key; in big-endian!
 151    */
 152   uint16_t sizen GNUNET_PACKED;
 153
 154   /**
 155    * The key itself, contains n followed by e.
 156    */
 157   unsigned char key[GNUNET_CRYPTO_RSA_KEY_LENGTH];
 158
 159   /**
 160    * Padding (must be 0)
 161    */
 162   uint16_t padding GNUNET_PACKED;
 163 };
 164
 165
 166 /**
 167  * RSA Encrypted data.
 168  */
 169 struct GNUNET_CRYPTO_RsaEncryptedData
 170 {
 171   unsigned char encoding[GNUNET_CRYPTO_RSA_DATA_ENCODING_LENGTH];
 172 };
 173
 174
 175 /**
 176  * @brief type for session keys
 177  */
 178 struct GNUNET_CRYPTO_AesSessionKey
 179 {
 180   /**
 181    * Actual key.
 182    */
 183   unsigned char key[GNUNET_CRYPTO_AES_KEY_LENGTH];
 184
 185   /**
 186    * checksum!
 187    */
 188   uint32_t crc32 GNUNET_PACKED;
 189 };
 190
 191
 192 /**
 193  * @brief IV for sym cipher
 194  *
 195  * NOTE: must be smaller (!) in size than the
 196  * GNUNET_HashCode.
 197  */
 198 struct GNUNET_CRYPTO_AesInitializationVector
 199 {
 200   unsigned char iv[GNUNET_CRYPTO_AES_KEY_LENGTH / 2];
 201 };
 202
 203
 204 /* **************** Functions and Macros ************* */
 205
 206
 207 /**
 208  * Compute the CRC32 checksum for the first len
 209  * bytes of the buffer.
 210  *
 211  * @param buf the data over which we're taking the CRC
 212  * @param len the length of the buffer in bytes
 213  * @return the resulting CRC32 checksum
 214  */
 215 int32_t GNUNET_CRYPTO_crc32_n (const void *buf,
 216                                size_t len);
 217
 218
 219 /**
 220  * Produce a random value.
 221  *
 222  * @param mode desired quality of the random number
 223  * @param i the upper limit (exclusive) for the random number
 224  * @return a random value in the interval [0,i) (exclusive).
 225  */
 226 uint32_t GNUNET_CRYPTO_random_u32 (enum GNUNET_CRYPTO_Quality mode,
 227                                    uint32_t i);
 228
 229
 230 /**
 231  * Random on unsigned 64-bit values.
 232  *
 233  * @param mode desired quality of the random number
 234  * @param max value returned will be in range [0,max) (exclusive)
 235  * @return random 64-bit number
 236  */
 237 uint64_t GNUNET_CRYPTO_random_u64 (enum GNUNET_CRYPTO_Quality mode,
 238                                    uint64_t max);
 239
 240
 241 /**
 242  * Get an array with a random permutation of the
 243  * numbers 0...n-1.
 244  * @param mode GNUNET_CRYPTO_QUALITY_STRONG if the strong (but expensive) PRNG should be used, GNUNET_CRYPTO_QUALITY_WEAK otherwise
 245  * @param n the size of the array
 246  * @return the permutation array (allocated from heap)
 247  */
 248 unsigned int *GNUNET_CRYPTO_random_permute (enum GNUNET_CRYPTO_Quality mode,
 249                                             unsigned int n);
 250
 251
 252 /**
 253  * Create a new Session key.
 254  *
 255  * @param key key to initialize
 256  */
 257 void GNUNET_CRYPTO_aes_create_session_key (struct GNUNET_CRYPTO_AesSessionKey
 258                                            *key);
 259
 260
 261 /**
 262  * Check that a new session key is well-formed.
 263  *
 264  * @param key key to check
 265  * @return GNUNET_OK if the key is valid
 266  */
 267 int GNUNET_CRYPTO_aes_check_session_key (const struct
 268                                          GNUNET_CRYPTO_AesSessionKey *key);
 269
 270
 271 /**
 272  * Encrypt a block with the public key of another
 273  * host that uses the same cyper.
 274  *
 275  * @param block the block to encrypt
 276  * @param len the size of the block
 277  * @param sessionkey the key used to encrypt
 278  * @param iv the initialization vector to use, use INITVALUE
 279  *        for streams.
 280  * @return the size of the encrypted block, -1 for errors
 281  */
 282 ssize_t GNUNET_CRYPTO_aes_encrypt (const void *block,
 283                                    size_t len,
 284                                    const struct GNUNET_CRYPTO_AesSessionKey
 285                                    *sessionkey,
 286                                    const struct
 287                                    GNUNET_CRYPTO_AesInitializationVector *iv,
 288                                    void *result);
 289
 290
 291 /**
 292  * Decrypt a given block with the sessionkey.
 293  *
 294  * @param block the data to decrypt, encoded as returned by encrypt
 295  * @param size how big is the block?
 296  * @param sessionkey the key used to decrypt
 297  * @param iv the initialization vector to use
 298  * @param result address to store the result at
 299  * @return -1 on failure, size of decrypted block on success
 300  */
 301 ssize_t GNUNET_CRYPTO_aes_decrypt (const void *block,
 302                                    size_t size,
 303                                    const struct GNUNET_CRYPTO_AesSessionKey *sessionkey,
 304                                    const struct GNUNET_CRYPTO_AesInitializationVector *iv,
 305                                    void *result);
 306
 307
 308 /**
 309  * Convert hash to ASCII encoding.
 310  * @param block the hash code
 311  * @param result where to store the encoding (struct GNUNET_CRYPTO_HashAsciiEncoded can be
 312  *  safely cast to char*, a '\\0' termination is set).
 313  */
 314 void GNUNET_CRYPTO_hash_to_enc (const GNUNET_HashCode * block,
 315                                 struct GNUNET_CRYPTO_HashAsciiEncoded
 316                                 *result);
 317
 318
 319 /**
 320  * Convert ASCII encoding back to GNUNET_CRYPTO_hash
 321  * @param enc the encoding
 322  * @param result where to store the GNUNET_CRYPTO_hash code
 323  * @return GNUNET_OK on success, GNUNET_SYSERR if result has the wrong encoding
 324  */
 325 int GNUNET_CRYPTO_hash_from_string (const char *enc,
 326                                     GNUNET_HashCode * result);
 327
 328
 329 /**
 330  * Compute the distance between 2 hashcodes.
 331  * The computation must be fast, not involve
 332  * a.a or a.e (they're used elsewhere), and
 333  * be somewhat consistent. And of course, the
 334  * result should be a positive number.
 335  *
 336  * @param a some hash code
 337  * @param b some hash code
 338  * @return number between 0 and 65536
 339  */
 340 uint32_t GNUNET_CRYPTO_hash_distance_u32 (const GNUNET_HashCode * a,
 341                                           const GNUNET_HashCode * b);
 342
 343
 344 /**
 345  * Compute hash of a given block.
 346  *
 347  * @param block the data to hash
 348  * @param size size of the block
 349  * @param ret pointer to where to write the hashcode
 350  */
 351 void GNUNET_CRYPTO_hash (const void *block,
 352                          size_t size,
 353                          GNUNET_HashCode * ret);
 354
 355
 356 /**
 357  * Function called once the hash computation over the
 358  * specified file has completed.
 359  *
 360  * @param cls closure
 361  * @param res resulting hash, NULL on error
 362  */
 363 typedef void (*GNUNET_CRYPTO_HashCompletedCallback) (void *cls,
 364                                                      const GNUNET_HashCode *
 365                                                      res);
 366
 367
 368 /**
 369  * Compute the hash of an entire file.
 370  *
 371  * @param sched scheduler to use
 372  * @param priority scheduling priority to use
 373  * @param run_on_shutdown should we complete even on shutdown?
 374  * @param filename name of file to hash
 375  * @param blocksize number of bytes to process in one task
 376  * @param callback function to call upon completion
 377  * @param callback_cls closure for callback
 378  */
 379 void GNUNET_CRYPTO_hash_file (struct GNUNET_SCHEDULER_Handle *sched,
 380                               enum GNUNET_SCHEDULER_Priority priority,
 381                               int run_on_shutdown,
 382                               const char *filename,
 383                               size_t blocksize,
 384                               GNUNET_CRYPTO_HashCompletedCallback callback,
 385                               void *callback_cls);
 386
 387
 388 /**
 389  * Create a random hash code.
 390  *
 391  * @param mode desired quality level
 392  * @param result hash code that is randomized
 393  */
 394 void GNUNET_CRYPTO_hash_create_random (enum GNUNET_CRYPTO_Quality mode,
 395                                        GNUNET_HashCode * result);
 396
 397
 398 /**
 399  * compute result(delta) = b - a
 400  *
 401  * @param a some hash code
 402  * @param b some hash code
 403  * @param result set to b - a
 404  */
 405 void GNUNET_CRYPTO_hash_difference (const GNUNET_HashCode * a,
 406                                     const GNUNET_HashCode * b,
 407                                     GNUNET_HashCode * result);
 408
 409
 410 /**
 411  * compute result(b) = a + delta
 412  *
 413  * @param a some hash code
 414  * @param delta some hash code
 415  * @param result set to a + delta
 416  */
 417 void GNUNET_CRYPTO_hash_sum (const GNUNET_HashCode * a,
 418                              const GNUNET_HashCode * delta,
 419                              GNUNET_HashCode * result);
 420
 421
 422 /**
 423  * compute result = a ^ b
 424  *
 425  * @param a some hash code
 426  * @param b some hash code
 427  * @param result set to a ^ b
 428  */
 429 void GNUNET_CRYPTO_hash_xor (const GNUNET_HashCode * a,
 430                              const GNUNET_HashCode * b,
 431                              GNUNET_HashCode * result);
 432
 433
 434 /**
 435  * Convert a hashcode into a key.
 436  *
 437  * @param hc hash code that serves to generate the key
 438  * @param skey set to a valid session key
 439  * @param iv set to a valid initialization vector
 440  */
 441 void GNUNET_CRYPTO_hash_to_aes_key (const GNUNET_HashCode * hc,
 442                                     struct GNUNET_CRYPTO_AesSessionKey *skey,
 443                                     struct
 444                                     GNUNET_CRYPTO_AesInitializationVector
 445                                     *iv);
 446
 447
 448 /**
 449  * Obtain a bit from a hashcode.
 450  *
 451  * @param code the GNUNET_CRYPTO_hash to index bit-wise
 452  * @param bit index into the hashcode, [0...159]
 453  * @return Bit \a bit from hashcode \a code, -1 for invalid index
 454  */
 455 int GNUNET_CRYPTO_hash_get_bit (const GNUNET_HashCode * code,
 456                                 unsigned int bit);
 457
 458
 459 /**
 460  * Compare function for HashCodes, producing a total ordering
 461  * of all hashcodes.
 462  *
 463  * @param h1 some hash code
 464  * @param h2 some hash code
 465  * @return 1 if h1 > h2, -1 if h1 < h2 and 0 if h1 == h2.
 466  */
 467 int GNUNET_CRYPTO_hash_cmp (const GNUNET_HashCode * h1,
 468                             const GNUNET_HashCode * h2);
 469
 470
 471 /**
 472  * Find out which of the two GNUNET_CRYPTO_hash codes is closer to target
 473  * in the XOR metric (Kademlia).
 474  *
 475  * @param h1 some hash code
 476  * @param h2 some hash code
 477  * @param target some hash code
 478  * @return -1 if h1 is closer, 1 if h2 is closer and 0 if h1==h2.
 479  */
 480 int GNUNET_CRYPTO_hash_xorcmp (const GNUNET_HashCode * h1,
 481                                const GNUNET_HashCode * h2,
 482                                const GNUNET_HashCode * target);
 483
 484
 485 /**
 486  * Create a new private key. Caller must free return value.
 487  *
 488  * @return fresh private key
 489  */
 490 struct GNUNET_CRYPTO_RsaPrivateKey *GNUNET_CRYPTO_rsa_key_create (void);
 491
 492
 493 /**
 494  * Create a new private key by reading it from a file.  If the
 495  * files does not exist, create a new key and write it to the
 496  * file.  Caller must free return value. Note that this function
 497  * can not guarantee that another process might not be trying
 498  * the same operation on the same file at the same time.  The
 499  * caller must somehow know that the file either already exists
 500  * with a valid key OR be sure that no other process is calling
 501  * this function at the same time.  If the contents of the file
 502  * are invalid the old file is deleted and a fresh key is
 503  * created.
 504  *
 505  * @param filename name of file to use for storage
 506  * @return new private key, NULL on error (for example,
 507  *   permission denied)
 508  */
 509 struct GNUNET_CRYPTO_RsaPrivateKey
 510   *GNUNET_CRYPTO_rsa_key_create_from_file (const char *filename);
 511
 512
 513 /**
 514  * Deterministically (!) create a private key using only the
 515  * given HashCode as input to the PRNG.
 516  *
 517  * @param hc "random" input to PRNG
 518  * @return some private key purely dependent on input
 519  */
 520 struct GNUNET_CRYPTO_RsaPrivateKey
 521   *GNUNET_CRYPTO_rsa_key_create_from_hash (const GNUNET_HashCode * hc);
 522
 523
 524 /**
 525  * Free memory occupied by the private key.
 526  * @param hostkey pointer to the memory to free
 527  */
 528 void GNUNET_CRYPTO_rsa_key_free (struct GNUNET_CRYPTO_RsaPrivateKey *hostkey);
 529
 530
 531 /**
 532  * Extract the public key of the host.
 533  *
 534  * @param priv the private key
 535  * @param pub where to write the public key
 536  */
 537 void GNUNET_CRYPTO_rsa_key_get_public (const struct
 538                                        GNUNET_CRYPTO_RsaPrivateKey *priv,
 539                                        struct
 540                                        GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
 541                                        *pub);
 542
 543
 544 /**
 545  * Encrypt a block with the public key of another host that uses the
 546  * same cyper.
 547  *
 548  * @param block the block to encrypt
 549  * @param size the size of block
 550  * @param publicKey the encoded public key used to encrypt
 551  * @param target where to store the encrypted block
 552  * @return GNUNET_SYSERR on error, GNUNET_OK if ok
 553  */
 554 int GNUNET_CRYPTO_rsa_encrypt (const void *block,
 555                                size_t size,
 556                                const struct
 557                                GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
 558                                *publicKey,
 559                                struct GNUNET_CRYPTO_RsaEncryptedData *target);
 560
 561
 562 /**
 563  * Decrypt a given block with the hostkey.
 564  *
 565  * @param key the key to use
 566  * @param block the data to decrypt, encoded as returned by encrypt, not consumed
 567  * @param result pointer to a location where the result can be stored
 568  * @param max how many bytes of a result are expected? Must be exact.
 569  * @return the size of the decrypted block (that is, size) or -1 on error
 570  */
 571 ssize_t GNUNET_CRYPTO_rsa_decrypt (const struct GNUNET_CRYPTO_RsaPrivateKey *key,
 572                                    const struct GNUNET_CRYPTO_RsaEncryptedData
 573                                    *block,
 574                                    void *result,
 575                                    size_t max);
 576
 577
 578 /**
 579  * Sign a given block.
 580  *
 581  * @param key private key to use for the signing
 582  * @param purpose what to sign (size, purpose)
 583  * @param sig where to write the signature
 584  * @return GNUNET_SYSERR on error, GNUNET_OK on success
 585  */
 586 int GNUNET_CRYPTO_rsa_sign (const struct GNUNET_CRYPTO_RsaPrivateKey *key,
 587                             const struct GNUNET_CRYPTO_RsaSignaturePurpose
 588                             *purpose,
 589                             struct GNUNET_CRYPTO_RsaSignature *sig);
 590
 591
 592 /**
 593  * Verify signature.  Note that the caller MUST have already
 594  * checked that "validate->size" bytes are actually available.
 595  *
 596  * @param purpose what is the purpose that validate should have?
 597  * @param validate block to validate (size, purpose, data)
 598  * @param sig signature that is being validated
 599  * @param publicKey public key of the signer
 600  * @return GNUNET_OK if ok, GNUNET_SYSERR if invalid
 601  */
 602 int GNUNET_CRYPTO_rsa_verify (uint32_t purpose,
 603                               const struct GNUNET_CRYPTO_RsaSignaturePurpose
 604                               *validate,
 605                               const struct GNUNET_CRYPTO_RsaSignature *sig,
 606                               const struct
 607                               GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
 608                               *publicKey);
 609
 610
 611
 612 /**
 613  * This function should only be called in testcases
 614  * where strong entropy gathering is not desired
 615  * (for example, for hostkey generation).
 616  */
 617 void GNUNET_CRYPTO_random_disable_entropy_gathering (void);
 618
 619 #if 0                           /* keep Emacsens' auto-indent happy */
 620 {
 621 #endif
 622 #ifdef __cplusplus
 623 }
 624 #endif
 625
 626
 627 /* ifndef GNUNET_CRYPTO_LIB_H */
 628 #endif
 629 /* end of gnunet_crypto_lib.h */