2 This file is part of GNUnet.
3 (C) 2001-2013 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file include/gnunet_crypto_lib.h
23 * @brief cryptographic primitives for GNUnet
25 * @author Christian Grothoff
26 * @author Krista Bennett
27 * @author Gerd Knorr <kraxel@bytesex.org>
28 * @author Ioana Patrascu
29 * @author Tzvetan Horozov
31 * @defgroup crypto Cryptographic operations
32 * @defgroup hash Hashing and operations on hashes
35 #ifndef GNUNET_CRYPTO_LIB_H
36 #define GNUNET_CRYPTO_LIB_H
41 #if 0 /* keep Emacsens' auto-indent happy */
47 * @brief A 512-bit hashcode
49 struct GNUNET_HashCode;
52 * The identity of the host (wraps the signing key of the peer).
54 struct GNUNET_PeerIdentity;
56 #include "gnunet_common.h"
57 #include "gnunet_scheduler_lib.h"
62 * @brief A 512-bit hashcode
64 struct GNUNET_HashCode
66 uint32_t bits[512 / 8 / sizeof (uint32_t)]; /* = 16 */
71 * Maximum length of an ECC signature.
72 * Note: round up to multiple of 8 minus 2 for alignment.
74 #define GNUNET_CRYPTO_ECC_SIGNATURE_DATA_ENCODING_LENGTH 126
78 * Desired quality level for random numbers.
81 enum GNUNET_CRYPTO_Quality
84 * No good quality of the operation is needed (i.e.,
85 * random numbers can be pseudo-random).
88 GNUNET_CRYPTO_QUALITY_WEAK,
91 * High-quality operations are desired.
94 GNUNET_CRYPTO_QUALITY_STRONG,
97 * Randomness for IVs etc. is required.
100 GNUNET_CRYPTO_QUALITY_NONCE
105 * @brief length of the sessionkey in bytes (256 BIT sessionkey)
107 #define GNUNET_CRYPTO_AES_KEY_LENGTH (256/8)
110 * Length of a hash value
112 #define GNUNET_CRYPTO_HASH_LENGTH (512/8)
115 * How many characters (without 0-terminator) are our ASCII-encoded
116 * public keys (ECDSA/EDDSA/ECDHE).
118 #define GNUNET_CRYPTO_PKEY_ASCII_LENGTH 52
121 * @brief 0-terminated ASCII encoding of a struct GNUNET_HashCode.
123 struct GNUNET_CRYPTO_HashAsciiEncoded
125 unsigned char encoding[104];
129 GNUNET_NETWORK_STRUCT_BEGIN
133 * @brief header of what an ECC signature signs
134 * this must be followed by "size - 8" bytes of
135 * the actual signed data
137 struct GNUNET_CRYPTO_EccSignaturePurpose
140 * How many bytes does this signature sign?
141 * (including this purpose header); in network
144 uint32_t size GNUNET_PACKED;
147 * What does this signature vouch for? This
148 * must contain a GNUNET_SIGNATURE_PURPOSE_XXX
149 * constant (from gnunet_signatures.h). In
150 * network byte order!
152 uint32_t purpose GNUNET_PACKED;
158 * @brief an ECC signature using EdDSA.
159 * See https://gnunet.org/ed25519
161 struct GNUNET_CRYPTO_EddsaSignature
167 unsigned char r[256 / 8];
172 unsigned char s[256 / 8];
179 * @brief an ECC signature using ECDSA
181 struct GNUNET_CRYPTO_EcdsaSignature
187 unsigned char r[256 / 8];
192 unsigned char s[256 / 8];
198 * Public ECC key (always for Curve25519) encoded in a format suitable
199 * for network transmission and EdDSA signatures.
201 struct GNUNET_CRYPTO_EddsaPublicKey
204 * Q consists of an x- and a y-value, each mod p (256 bits), given
205 * here in affine coordinates and Ed25519 standard compact format.
207 unsigned char q_y[256 / 8];
213 * Public ECC key (always for Curve25519) encoded in a format suitable
214 * for network transmission and ECDSA signatures.
216 struct GNUNET_CRYPTO_EcdsaPublicKey
219 * Q consists of an x- and a y-value, each mod p (256 bits), given
220 * here in affine coordinates and Ed25519 standard compact format.
222 unsigned char q_y[256 / 8];
228 * The identity of the host (wraps the signing key of the peer).
230 struct GNUNET_PeerIdentity
232 struct GNUNET_CRYPTO_EddsaPublicKey public_key;
237 * Public ECC key (always for Curve25519) encoded in a format suitable
238 * for network transmission and encryption (ECDH),
239 * See http://cr.yp.to/ecdh.html
241 struct GNUNET_CRYPTO_EcdhePublicKey
244 * Q consists of an x- and a y-value, each mod p (256 bits), given
245 * here in affine coordinates and Ed25519 standard compact format.
247 unsigned char q_y[256 / 8];
252 * Private ECC key encoded for transmission. To be used only for ECDH
253 * key exchange (ECDHE to be precise).
255 struct GNUNET_CRYPTO_EcdhePrivateKey
258 * d is a value mod n, where n has at most 256 bits.
260 unsigned char d[256 / 8];
265 * Private ECC key encoded for transmission. To be used only for ECDSA
268 struct GNUNET_CRYPTO_EcdsaPrivateKey
271 * d is a value mod n, where n has at most 256 bits.
273 unsigned char d[256 / 8];
278 * Private ECC key encoded for transmission. To be used only for EdDSA
281 struct GNUNET_CRYPTO_EddsaPrivateKey
284 * d is a value mod n, where n has at most 256 bits.
286 unsigned char d[256 / 8];
292 * @brief type for session keys
294 struct GNUNET_CRYPTO_SymmetricSessionKey
297 * Actual key for AES.
299 unsigned char aes_key[GNUNET_CRYPTO_AES_KEY_LENGTH];
302 * Actual key for TwoFish.
304 unsigned char twofish_key[GNUNET_CRYPTO_AES_KEY_LENGTH];
308 GNUNET_NETWORK_STRUCT_END
311 * @brief IV for sym cipher
313 * NOTE: must be smaller (!) in size than the
314 * `struct GNUNET_HashCode`.
316 struct GNUNET_CRYPTO_SymmetricInitializationVector
318 unsigned char aes_iv[GNUNET_CRYPTO_AES_KEY_LENGTH / 2];
320 unsigned char twofish_iv[GNUNET_CRYPTO_AES_KEY_LENGTH / 2];
325 * @brief type for (message) authentication keys
327 struct GNUNET_CRYPTO_AuthKey
329 unsigned char key[GNUNET_CRYPTO_HASH_LENGTH];
334 * Size of paillier plain texts and public keys.
335 * Private keys and ciphertexts are twice this size.
337 #define GNUNET_CRYPTO_PAILLIER_BITS 2048
341 * Paillier public key.
343 struct GNUNET_CRYPTO_PaillierPublicKey
348 unsigned char n[GNUNET_CRYPTO_PAILLIER_BITS / 8];
353 * Paillier public key.
355 struct GNUNET_CRYPTO_PaillierPrivateKey
358 * Lambda-component of the private key.
360 unsigned char lambda[GNUNET_CRYPTO_PAILLIER_BITS / 8];
362 * Mu-component of the private key.
364 unsigned char mu[GNUNET_CRYPTO_PAILLIER_BITS / 8];
369 * Paillier ciphertext.
371 struct GNUNET_CRYPTO_PaillierCiphertext
374 * Guaranteed minimum number of homomorphic operations with this ciphertext,
375 * in network byte order (NBO).
377 int32_t remaining_ops GNUNET_PACKED;
380 * The bits of the ciphertext.
382 unsigned char bits[GNUNET_CRYPTO_PAILLIER_BITS * 2 / 8];
386 /* **************** Functions and Macros ************* */
390 * Seed a weak random generator. Only #GNUNET_CRYPTO_QUALITY_WEAK-mode generator
393 * @param seed the seed to use
396 GNUNET_CRYPTO_seed_weak_random (int32_t seed);
400 * Perform an incremental step in a CRC16 (for TCP/IP) calculation.
402 * @param sum current sum, initially 0
403 * @param buf buffer to calculate CRC over (must be 16-bit aligned)
404 * @param len number of bytes in @a buf, must be multiple of 2
405 * @return updated crc sum (must be subjected to #GNUNET_CRYPTO_crc16_finish to get actual crc16)
408 GNUNET_CRYPTO_crc16_step (uint32_t sum, const void *buf, size_t len);
412 * Convert results from GNUNET_CRYPTO_crc16_step to final crc16.
414 * @param sum cummulative sum
415 * @return crc16 value
418 GNUNET_CRYPTO_crc16_finish (uint32_t sum);
423 * Calculate the checksum of a buffer in one step.
425 * @param buf buffer to calculate CRC over (must be 16-bit aligned)
426 * @param len number of bytes in @a buf, must be multiple of 2
427 * @return crc16 value
430 GNUNET_CRYPTO_crc16_n (const void *buf, size_t len);
435 * Compute the CRC32 checksum for the first len
436 * bytes of the buffer.
438 * @param buf the data over which we're taking the CRC
439 * @param len the length of the buffer @a buf in bytes
440 * @return the resulting CRC32 checksum
443 GNUNET_CRYPTO_crc32_n (const void *buf, size_t len);
448 * Fill block with a random values.
450 * @param mode desired quality of the random number
451 * @param buffer the buffer to fill
452 * @param length buffer length
455 GNUNET_CRYPTO_random_block (enum GNUNET_CRYPTO_Quality mode, void *buffer, size_t length);
459 * Produce a random value.
461 * @param mode desired quality of the random number
462 * @param i the upper limit (exclusive) for the random number
463 * @return a random value in the interval [0,@a i) (exclusive).
466 GNUNET_CRYPTO_random_u32 (enum GNUNET_CRYPTO_Quality mode, uint32_t i);
471 * Random on unsigned 64-bit values.
473 * @param mode desired quality of the random number
474 * @param max value returned will be in range [0,@a max) (exclusive)
475 * @return random 64-bit number
478 GNUNET_CRYPTO_random_u64 (enum GNUNET_CRYPTO_Quality mode, uint64_t max);
483 * Get an array with a random permutation of the
485 * @param mode #GNUNET_CRYPTO_QUALITY_STRONG if the strong (but expensive) PRNG should be used,
486 * #GNUNET_CRYPTO_QUALITY_WEAK or #GNUNET_CRYPTO_QUALITY_NONCE otherwise
487 * @param n the size of the array
488 * @return the permutation array (allocated from heap)
491 GNUNET_CRYPTO_random_permute (enum GNUNET_CRYPTO_Quality mode, unsigned int n);
496 * Create a new random session key.
498 * @param key key to initialize
501 GNUNET_CRYPTO_symmetric_create_session_key (struct GNUNET_CRYPTO_SymmetricSessionKey *key);
506 * Encrypt a block using a symmetric sessionkey.
508 * @param block the block to encrypt
509 * @param size the size of the @a block
510 * @param sessionkey the key used to encrypt
511 * @param iv the initialization vector to use, use INITVALUE
513 * @return the size of the encrypted block, -1 for errors
516 GNUNET_CRYPTO_symmetric_encrypt (const void *block, size_t size,
517 const struct GNUNET_CRYPTO_SymmetricSessionKey *sessionkey,
518 const struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
524 * Decrypt a given block using a symmetric sessionkey.
526 * @param block the data to decrypt, encoded as returned by encrypt
527 * @param size how big is the block?
528 * @param sessionkey the key used to decrypt
529 * @param iv the initialization vector to use
530 * @param result address to store the result at
531 * @return -1 on failure, size of decrypted block on success
534 GNUNET_CRYPTO_symmetric_decrypt (const void *block, size_t size,
535 const struct GNUNET_CRYPTO_SymmetricSessionKey *sessionkey,
536 const struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
542 * @brief Derive an IV
543 * @param iv initialization vector
544 * @param skey session key
545 * @param salt salt for the derivation
546 * @param salt_len size of the @a salt
547 * @param ... pairs of void * & size_t for context chunks, terminated by NULL
550 GNUNET_CRYPTO_symmetric_derive_iv (struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
551 const struct GNUNET_CRYPTO_SymmetricSessionKey *skey,
553 size_t salt_len, ...);
557 * @brief Derive an IV
558 * @param iv initialization vector
559 * @param skey session key
560 * @param salt salt for the derivation
561 * @param salt_len size of the @a salt
562 * @param argp pairs of void * & size_t for context chunks, terminated by NULL
565 GNUNET_CRYPTO_symmetric_derive_iv_v (struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
566 const struct GNUNET_CRYPTO_SymmetricSessionKey *skey,
574 * Convert hash to ASCII encoding.
575 * @param block the hash code
576 * @param result where to store the encoding (struct GNUNET_CRYPTO_HashAsciiEncoded can be
577 * safely cast to char*, a '\\0' termination is set).
580 GNUNET_CRYPTO_hash_to_enc (const struct GNUNET_HashCode * block,
581 struct GNUNET_CRYPTO_HashAsciiEncoded *result);
586 * Convert ASCII encoding back to a 'struct GNUNET_HashCode'
588 * @param enc the encoding
589 * @param enclen number of characters in @a enc (without 0-terminator, which can be missing)
590 * @param result where to store the hash code
591 * @return #GNUNET_OK on success, #GNUNET_SYSERR if result has the wrong encoding
594 GNUNET_CRYPTO_hash_from_string2 (const char *enc, size_t enclen,
595 struct GNUNET_HashCode *result);
600 * Convert ASCII encoding back to `struct GNUNET_HashCode`
602 * @param enc the encoding
603 * @param result where to store the hash code
604 * @return #GNUNET_OK on success, #GNUNET_SYSERR if result has the wrong encoding
606 #define GNUNET_CRYPTO_hash_from_string(enc, result) \
607 GNUNET_CRYPTO_hash_from_string2 (enc, strlen(enc), result)
613 * Compute the distance between 2 hashcodes. The
614 * computation must be fast, not involve @a a[0] or @a a[4] (they're used
615 * elsewhere), and be somewhat consistent. And of course, the result
616 * should be a positive number.
618 * @param a some hash code
619 * @param b some hash code
620 * @return number between 0 and UINT32_MAX
623 GNUNET_CRYPTO_hash_distance_u32 (const struct GNUNET_HashCode *a,
624 const struct GNUNET_HashCode *b);
629 * Compute hash of a given block.
631 * @param block the data to hash
632 * @param size size of the @a block
633 * @param ret pointer to where to write the hashcode
636 GNUNET_CRYPTO_hash (const void *block, size_t size, struct GNUNET_HashCode * ret);
641 * Calculate HMAC of a message (RFC 2104)
643 * @param key secret key
644 * @param plaintext input plaintext
645 * @param plaintext_len length of @a plaintext
646 * @param hmac where to store the hmac
649 GNUNET_CRYPTO_hmac (const struct GNUNET_CRYPTO_AuthKey *key,
650 const void *plaintext, size_t plaintext_len,
651 struct GNUNET_HashCode * hmac);
655 * Function called once the hash computation over the
656 * specified file has completed.
659 * @param res resulting hash, NULL on error
661 typedef void (*GNUNET_CRYPTO_HashCompletedCallback) (void *cls,
662 const struct GNUNET_HashCode *res);
666 * Handle to file hashing operation.
668 struct GNUNET_CRYPTO_FileHashContext;
673 * Compute the hash of an entire file.
675 * @param priority scheduling priority to use
676 * @param filename name of file to hash
677 * @param blocksize number of bytes to process in one task
678 * @param callback function to call upon completion
679 * @param callback_cls closure for @a callback
680 * @return NULL on (immediate) errror
682 struct GNUNET_CRYPTO_FileHashContext *
683 GNUNET_CRYPTO_hash_file (enum GNUNET_SCHEDULER_Priority priority,
684 const char *filename, size_t blocksize,
685 GNUNET_CRYPTO_HashCompletedCallback callback,
690 * Cancel a file hashing operation.
692 * @param fhc operation to cancel (callback must not yet have been invoked)
695 GNUNET_CRYPTO_hash_file_cancel (struct GNUNET_CRYPTO_FileHashContext *fhc);
700 * Create a random hash code.
702 * @param mode desired quality level
703 * @param result hash code that is randomized
706 GNUNET_CRYPTO_hash_create_random (enum GNUNET_CRYPTO_Quality mode,
707 struct GNUNET_HashCode *result);
712 * compute @a result = @a b - @a a
714 * @param a some hash code
715 * @param b some hash code
716 * @param result set to @a b - @a a
719 GNUNET_CRYPTO_hash_difference (const struct GNUNET_HashCode *a,
720 const struct GNUNET_HashCode *b,
721 struct GNUNET_HashCode *result);
726 * compute @a result = @a a + @a delta
728 * @param a some hash code
729 * @param delta some hash code
730 * @param result set to @a a + @a delta
733 GNUNET_CRYPTO_hash_sum (const struct GNUNET_HashCode *a,
734 const struct GNUNET_HashCode *delta,
735 struct GNUNET_HashCode *result);
740 * compute result = a ^ b
742 * @param a some hash code
743 * @param b some hash code
744 * @param result set to @a a ^ @a b
747 GNUNET_CRYPTO_hash_xor (const struct GNUNET_HashCode *a,
748 const struct GNUNET_HashCode *b,
749 struct GNUNET_HashCode *result);
754 * Convert a hashcode into a key.
756 * @param hc hash code that serves to generate the key
757 * @param skey set to a valid session key
758 * @param iv set to a valid initialization vector
761 GNUNET_CRYPTO_hash_to_aes_key (const struct GNUNET_HashCode * hc,
762 struct GNUNET_CRYPTO_SymmetricSessionKey *skey,
763 struct GNUNET_CRYPTO_SymmetricInitializationVector *iv);
768 * Obtain a bit from a hashcode.
770 * @param code the `struct GNUNET_HashCode` to index bit-wise
771 * @param bit index into the hashcode, [0...159]
772 * @return Bit \a bit from hashcode \a code, -1 for invalid index
775 GNUNET_CRYPTO_hash_get_bit (const struct GNUNET_HashCode *code,
781 * Determine how many low order bits match in two
782 * `struct GNUNET_HashCodes`. i.e. - 010011 and 011111 share
783 * the first two lowest order bits, and therefore the
784 * return value is two (NOT XOR distance, nor how many
785 * bits match absolutely!).
787 * @param first the first hashcode
788 * @param second the hashcode to compare first to
789 * @return the number of bits that match
792 GNUNET_CRYPTO_hash_matching_bits (const struct GNUNET_HashCode *first,
793 const struct GNUNET_HashCode *second);
798 * Compare function for HashCodes, producing a total ordering
801 * @param h1 some hash code
802 * @param h2 some hash code
803 * @return 1 if @a h1 > @a h2, -1 if @a h1 < @a h2 and 0 if @a h1 == @a h2.
806 GNUNET_CRYPTO_hash_cmp (const struct GNUNET_HashCode *h1,
807 const struct GNUNET_HashCode *h2);
812 * Find out which of the two GNUNET_CRYPTO_hash codes is closer to target
813 * in the XOR metric (Kademlia).
815 * @param h1 some hash code
816 * @param h2 some hash code
817 * @param target some hash code
818 * @return -1 if @a h1 is closer, 1 if @a h2 is closer and 0 if @a h1== @a h2.
821 GNUNET_CRYPTO_hash_xorcmp (const struct GNUNET_HashCode *h1,
822 const struct GNUNET_HashCode *h2,
823 const struct GNUNET_HashCode *target);
828 * @brief Derive an authentication key
829 * @param key authentication key
830 * @param rkey root key
832 * @param salt_len size of the salt
833 * @param argp pair of void * & size_t for context chunks, terminated by NULL
836 GNUNET_CRYPTO_hmac_derive_key_v (struct GNUNET_CRYPTO_AuthKey *key,
837 const struct GNUNET_CRYPTO_SymmetricSessionKey *rkey,
838 const void *salt, size_t salt_len,
844 * @brief Derive an authentication key
845 * @param key authentication key
846 * @param rkey root key
848 * @param salt_len size of the salt
849 * @param ... pair of void * & size_t for context chunks, terminated by NULL
852 GNUNET_CRYPTO_hmac_derive_key (struct GNUNET_CRYPTO_AuthKey *key,
853 const struct GNUNET_CRYPTO_SymmetricSessionKey *rkey,
854 const void *salt, size_t salt_len, ...);
860 * @param result buffer for the derived key, allocated by caller
861 * @param out_len desired length of the derived key
862 * @param xtr_algo hash algorithm for the extraction phase, GCRY_MD_...
863 * @param prf_algo hash algorithm for the expansion phase, GCRY_MD_...
865 * @param xts_len length of @a xts
866 * @param skm source key material
867 * @param skm_len length of @a skm
868 * @param ... pair of void * & size_t for context chunks, terminated by NULL
869 * @return #GNUNET_YES on success
872 GNUNET_CRYPTO_hkdf (void *result, size_t out_len, int xtr_algo, int prf_algo,
873 const void *xts, size_t xts_len, const void *skm,
874 size_t skm_len, ...);
880 * @param result buffer for the derived key, allocated by caller
881 * @param out_len desired length of the derived key
882 * @param xtr_algo hash algorithm for the extraction phase, GCRY_MD_...
883 * @param prf_algo hash algorithm for the expansion phase, GCRY_MD_...
885 * @param xts_len length of @a xts
886 * @param skm source key material
887 * @param skm_len length of @a skm
888 * @param argp va_list of void * & size_t pairs for context chunks
889 * @return #GNUNET_YES on success
892 GNUNET_CRYPTO_hkdf_v (void *result, size_t out_len, int xtr_algo, int prf_algo,
893 const void *xts, size_t xts_len, const void *skm,
894 size_t skm_len, va_list argp);
899 * @param result buffer for the derived key, allocated by caller
900 * @param out_len desired length of the derived key
902 * @param xts_len length of @a xts
903 * @param skm source key material
904 * @param skm_len length of @a skm
905 * @param argp va_list of void * & size_t pairs for context chunks
906 * @return #GNUNET_YES on success
909 GNUNET_CRYPTO_kdf_v (void *result, size_t out_len, const void *xts,
910 size_t xts_len, const void *skm, size_t skm_len,
917 * @param result buffer for the derived key, allocated by caller
918 * @param out_len desired length of the derived key
920 * @param xts_len length of @a xts
921 * @param skm source key material
922 * @param skm_len length of @a skm
923 * @param ... void * & size_t pairs for context chunks
924 * @return #GNUNET_YES on success
927 GNUNET_CRYPTO_kdf (void *result, size_t out_len, const void *xts,
928 size_t xts_len, const void *skm, size_t skm_len, ...);
933 * Extract the public key for the given private key.
935 * @param priv the private key
936 * @param pub where to write the public key
939 GNUNET_CRYPTO_ecdsa_key_get_public (const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv,
940 struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
944 * Extract the public key for the given private key.
946 * @param priv the private key
947 * @param pub where to write the public key
950 GNUNET_CRYPTO_eddsa_key_get_public (const struct GNUNET_CRYPTO_EddsaPrivateKey *priv,
951 struct GNUNET_CRYPTO_EddsaPublicKey *pub);
956 * Extract the public key for the given private key.
958 * @param priv the private key
959 * @param pub where to write the public key
962 GNUNET_CRYPTO_ecdhe_key_get_public (const struct GNUNET_CRYPTO_EcdhePrivateKey *priv,
963 struct GNUNET_CRYPTO_EcdhePublicKey *pub);
967 * Convert a public key to a string.
969 * @param pub key to convert
970 * @return string representing @a pub
973 GNUNET_CRYPTO_ecdsa_public_key_to_string (const struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
977 * Convert a public key to a string.
979 * @param pub key to convert
980 * @return string representing @a pub
983 GNUNET_CRYPTO_eddsa_public_key_to_string (const struct GNUNET_CRYPTO_EddsaPublicKey *pub);
987 * Convert a string representing a public key to a public key.
989 * @param enc encoded public key
990 * @param enclen number of bytes in @a enc (without 0-terminator)
991 * @param pub where to store the public key
992 * @return #GNUNET_OK on success
995 GNUNET_CRYPTO_ecdsa_public_key_from_string (const char *enc,
997 struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
1001 * Convert a string representing a public key to a public key.
1003 * @param enc encoded public key
1004 * @param enclen number of bytes in @a enc (without 0-terminator)
1005 * @param pub where to store the public key
1006 * @return #GNUNET_OK on success
1009 GNUNET_CRYPTO_eddsa_public_key_from_string (const char *enc,
1011 struct GNUNET_CRYPTO_EddsaPublicKey *pub);
1016 * Create a new private key by reading it from a file. If the
1017 * files does not exist, create a new key and write it to the
1018 * file. Caller must free return value. Note that this function
1019 * can not guarantee that another process might not be trying
1020 * the same operation on the same file at the same time.
1021 * If the contents of the file
1022 * are invalid the old file is deleted and a fresh key is
1025 * @param filename name of file to use to store the key
1026 * @return new private key, NULL on error (for example,
1027 * permission denied); free using #GNUNET_free
1029 struct GNUNET_CRYPTO_EcdsaPrivateKey *
1030 GNUNET_CRYPTO_ecdsa_key_create_from_file (const char *filename);
1035 * Create a new private key by reading it from a file. If the
1036 * files does not exist, create a new key and write it to the
1037 * file. Caller must free return value. Note that this function
1038 * can not guarantee that another process might not be trying
1039 * the same operation on the same file at the same time.
1040 * If the contents of the file
1041 * are invalid the old file is deleted and a fresh key is
1044 * @param filename name of file to use to store the key
1045 * @return new private key, NULL on error (for example,
1046 * permission denied); free using #GNUNET_free
1048 struct GNUNET_CRYPTO_EddsaPrivateKey *
1049 GNUNET_CRYPTO_eddsa_key_create_from_file (const char *filename);
1051 struct GNUNET_CONFIGURATION_Handle;
1056 * Create a new private key by reading our peer's key from
1057 * the file specified in the configuration.
1059 * @param cfg the configuration to use
1060 * @return new private key, NULL on error (for example,
1061 * permission denied); free using #GNUNET_free
1063 struct GNUNET_CRYPTO_EddsaPrivateKey *
1064 GNUNET_CRYPTO_eddsa_key_create_from_configuration (const struct GNUNET_CONFIGURATION_Handle *cfg);
1069 * Create a new private key. Caller must free return value.
1071 * @return fresh private key; free using #GNUNET_free
1073 struct GNUNET_CRYPTO_EcdsaPrivateKey *
1074 GNUNET_CRYPTO_ecdsa_key_create (void);
1079 * Create a new private key. Caller must free return value.
1081 * @return fresh private key; free using #GNUNET_free
1083 struct GNUNET_CRYPTO_EddsaPrivateKey *
1084 GNUNET_CRYPTO_eddsa_key_create (void);
1089 * Create a new private key. Caller must free return value.
1091 * @return fresh private key; free using #GNUNET_free
1093 struct GNUNET_CRYPTO_EcdhePrivateKey *
1094 GNUNET_CRYPTO_ecdhe_key_create (void);
1099 * Clear memory that was used to store a private key.
1101 * @param pk location of the key
1104 GNUNET_CRYPTO_eddsa_key_clear (struct GNUNET_CRYPTO_EddsaPrivateKey *pk);
1109 * Clear memory that was used to store a private key.
1111 * @param pk location of the key
1114 GNUNET_CRYPTO_ecdsa_key_clear (struct GNUNET_CRYPTO_EcdsaPrivateKey *pk);
1118 * Clear memory that was used to store a private key.
1120 * @param pk location of the key
1123 GNUNET_CRYPTO_ecdhe_key_clear (struct GNUNET_CRYPTO_EcdhePrivateKey *pk);
1128 * Get the shared private key we use for anonymous users.
1130 * @return "anonymous" private key; do not free
1132 const struct GNUNET_CRYPTO_EcdsaPrivateKey *
1133 GNUNET_CRYPTO_ecdsa_key_get_anonymous (void);
1138 * Setup a hostkey file for a peer given the name of the
1139 * configuration file (!). This function is used so that
1140 * at a later point code can be certain that reading a
1141 * hostkey is fast (for example in time-dependent testcases).
1143 * @param cfg_name name of the configuration file to use
1146 GNUNET_CRYPTO_eddsa_setup_hostkey (const char *cfg_name);
1151 * Retrieve the identity of the host's peer.
1153 * @param cfg configuration to use
1154 * @param dst pointer to where to write the peer identity
1155 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the identity
1156 * could not be retrieved
1159 GNUNET_CRYPTO_get_peer_identity (const struct GNUNET_CONFIGURATION_Handle *cfg,
1160 struct GNUNET_PeerIdentity *dst);
1164 * Compare two Peer Identities.
1166 * @param first first peer identity
1167 * @param second second peer identity
1168 * @return bigger than 0 if first > second,
1169 * 0 if they are the same
1170 * smaller than 0 if second > first
1173 GNUNET_CRYPTO_cmp_peer_identity (const struct GNUNET_PeerIdentity *first,
1174 const struct GNUNET_PeerIdentity *second);
1179 * Derive key material from a public and a private ECC key.
1181 * @param priv private key to use for the ECDH (x)
1182 * @param pub public key to use for the ECDH (yG)
1183 * @param key_material where to write the key material (xyG)
1184 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
1187 GNUNET_CRYPTO_ecc_ecdh (const struct GNUNET_CRYPTO_EcdhePrivateKey *priv,
1188 const struct GNUNET_CRYPTO_EcdhePublicKey *pub,
1189 struct GNUNET_HashCode *key_material);
1194 * EdDSA sign a given block.
1196 * @param priv private key to use for the signing
1197 * @param purpose what to sign (size, purpose)
1198 * @param sig where to write the signature
1199 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
1202 GNUNET_CRYPTO_eddsa_sign (const struct GNUNET_CRYPTO_EddsaPrivateKey *priv,
1203 const struct GNUNET_CRYPTO_EccSignaturePurpose *purpose,
1204 struct GNUNET_CRYPTO_EddsaSignature *sig);
1209 * ECDSA Sign a given block.
1211 * @param priv private key to use for the signing
1212 * @param purpose what to sign (size, purpose)
1213 * @param sig where to write the signature
1214 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
1217 GNUNET_CRYPTO_ecdsa_sign (const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv,
1218 const struct GNUNET_CRYPTO_EccSignaturePurpose *purpose,
1219 struct GNUNET_CRYPTO_EcdsaSignature *sig);
1223 * Verify EdDSA signature.
1225 * @param purpose what is the purpose that the signature should have?
1226 * @param validate block to validate (size, purpose, data)
1227 * @param sig signature that is being validated
1228 * @param pub public key of the signer
1229 * @returns #GNUNET_OK if ok, #GNUNET_SYSERR if invalid
1232 GNUNET_CRYPTO_eddsa_verify (uint32_t purpose,
1233 const struct GNUNET_CRYPTO_EccSignaturePurpose *validate,
1234 const struct GNUNET_CRYPTO_EddsaSignature *sig,
1235 const struct GNUNET_CRYPTO_EddsaPublicKey *pub);
1241 * Verify ECDSA signature.
1243 * @param purpose what is the purpose that the signature should have?
1244 * @param validate block to validate (size, purpose, data)
1245 * @param sig signature that is being validated
1246 * @param pub public key of the signer
1247 * @returns #GNUNET_OK if ok, #GNUNET_SYSERR if invalid
1250 GNUNET_CRYPTO_ecdsa_verify (uint32_t purpose,
1251 const struct GNUNET_CRYPTO_EccSignaturePurpose *validate,
1252 const struct GNUNET_CRYPTO_EcdsaSignature *sig,
1253 const struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
1258 * Derive a private key from a given private key and a label.
1259 * Essentially calculates a private key 'h = H(l,P) * d mod n'
1260 * where n is the size of the ECC group and P is the public
1261 * key associated with the private key 'd'.
1263 * @param priv original private key
1264 * @param label label to use for key deriviation
1265 * @param context additional context to use for HKDF of 'h';
1266 * typically the name of the subsystem/application
1267 * @return derived private key
1269 struct GNUNET_CRYPTO_EcdsaPrivateKey *
1270 GNUNET_CRYPTO_ecdsa_private_key_derive (const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv,
1272 const char *context);
1277 * Derive a public key from a given public key and a label.
1278 * Essentially calculates a public key 'V = H(l,P) * P'.
1280 * @param pub original public key
1281 * @param label label to use for key deriviation
1282 * @param context additional context to use for HKDF of 'h'.
1283 * typically the name of the subsystem/application
1284 * @param result where to write the derived public key
1287 GNUNET_CRYPTO_ecdsa_public_key_derive (const struct GNUNET_CRYPTO_EcdsaPublicKey *pub,
1289 const char *context,
1290 struct GNUNET_CRYPTO_EcdsaPublicKey *result);
1294 * Output the given MPI value to the given buffer in network
1295 * byte order. The MPI @a val may not be negative.
1297 * @param buf where to output to
1298 * @param size number of bytes in @a buf
1299 * @param val value to write to @a buf
1302 GNUNET_CRYPTO_mpi_print_unsigned (void *buf,
1308 * Convert data buffer into MPI value.
1309 * The buffer is interpreted as network
1310 * byte order, unsigned integer.
1312 * @param result where to store MPI value (allocated)
1313 * @param data raw data (GCRYMPI_FMT_USG)
1314 * @param size number of bytes in @a data
1317 GNUNET_CRYPTO_mpi_scan_unsigned (gcry_mpi_t *result,
1323 * Create a freshly generated paillier public key.
1325 * @param[out] public_key Where to store the public key?
1326 * @param[out] private_key Where to store the private key?
1329 GNUNET_CRYPTO_paillier_create (struct GNUNET_CRYPTO_PaillierPublicKey *public_key,
1330 struct GNUNET_CRYPTO_PaillierPrivateKey *private_key);
1334 * Encrypt a plaintext with a paillier public key.
1336 * @param public_key Public key to use.
1337 * @param m Plaintext to encrypt.
1338 * @param desired_ops How many homomorphic ops the caller intends to use
1339 * @param[out] ciphertext Encrytion of @a plaintext with @a public_key.
1340 * @return guaranteed number of supported homomorphic operations >= 1,
1341 * or desired_ops, in case that is lower,
1342 * or -1 if less than one homomorphic operation is possible
1345 GNUNET_CRYPTO_paillier_encrypt (const struct GNUNET_CRYPTO_PaillierPublicKey *public_key,
1348 struct GNUNET_CRYPTO_PaillierCiphertext *ciphertext);
1352 * Decrypt a paillier ciphertext with a private key.
1354 * @param private_key Private key to use for decryption.
1355 * @param public_key Public key to use for decryption.
1356 * @param ciphertext Ciphertext to decrypt.
1357 * @param[out] m Decryption of @a ciphertext with @private_key.
1360 GNUNET_CRYPTO_paillier_decrypt (const struct GNUNET_CRYPTO_PaillierPrivateKey *private_key,
1361 const struct GNUNET_CRYPTO_PaillierPublicKey *public_key,
1362 const struct GNUNET_CRYPTO_PaillierCiphertext *ciphertext,
1367 * Compute a ciphertext that represents the sum of the plaintext in @a x1 and @a x2
1369 * Note that this operation can only be done a finite number of times
1370 * before an overflow occurs.
1372 * @param public_key Public key to use for encryption.
1373 * @param c1 Paillier cipher text.
1374 * @param c2 Paillier cipher text.
1375 * @param[out] result Result of the homomorphic operation.
1376 * @return #GNUNET_OK if the result could be computed,
1377 * #GNUNET_SYSERR if no more homomorphic operations are remaining.
1380 GNUNET_CRYPTO_paillier_hom_add (const struct GNUNET_CRYPTO_PaillierPublicKey *public_key,
1381 const struct GNUNET_CRYPTO_PaillierCiphertext *c1,
1382 const struct GNUNET_CRYPTO_PaillierCiphertext *c2,
1383 struct GNUNET_CRYPTO_PaillierCiphertext *result);
1387 * Get the number of remaining supported homomorphic operations.
1389 * @param c Paillier cipher text.
1390 * @return the number of remaining homomorphic operations
1393 GNUNET_CRYPTO_paillier_hom_get_remaining (const struct GNUNET_CRYPTO_PaillierCiphertext *c);
1396 /* ********* Chaum-style RSA-based blind signatures ******************* */
1402 * The private information of an RSA key pair.
1404 struct GNUNET_CRYPTO_rsa_PrivateKey;
1407 * The public information of an RSA key pair.
1409 struct GNUNET_CRYPTO_rsa_PublicKey;
1412 * Key used to blind a message
1414 struct GNUNET_CRYPTO_rsa_BlindingKey;
1417 * @brief an RSA signature
1419 struct GNUNET_CRYPTO_rsa_Signature;
1423 * Create a new private key. Caller must free return value.
1425 * @param len length of the key in bits (i.e. 2048)
1426 * @return fresh private key
1428 struct GNUNET_CRYPTO_rsa_PrivateKey *
1429 GNUNET_CRYPTO_rsa_private_key_create (unsigned int len);
1433 * Free memory occupied by the private key.
1435 * @param key pointer to the memory to free
1438 GNUNET_CRYPTO_rsa_private_key_free (struct GNUNET_CRYPTO_rsa_PrivateKey *key);
1442 * Encode the private key in a format suitable for
1443 * storing it into a file.
1445 * @param key the private key
1446 * @param[out] buffer set to a buffer with the encoded key
1447 * @return size of memory allocatedin @a buffer
1450 GNUNET_CRYPTO_rsa_private_key_encode (const struct GNUNET_CRYPTO_rsa_PrivateKey *key,
1455 * Decode the private key from the data-format back
1456 * to the "normal", internal format.
1458 * @param buf the buffer where the private key data is stored
1459 * @param len the length of the data in @a buf
1460 * @return NULL on error
1462 struct GNUNET_CRYPTO_rsa_PrivateKey *
1463 GNUNET_CRYPTO_rsa_private_key_decode (const char *buf,
1468 * Extract the public key of the given private key.
1470 * @param priv the private key
1471 * @retur NULL on error, otherwise the public key
1473 struct GNUNET_CRYPTO_rsa_PublicKey *
1474 GNUNET_CRYPTO_rsa_private_key_get_public (const struct GNUNET_CRYPTO_rsa_PrivateKey *priv);
1478 * Free memory occupied by the public key.
1480 * @param key pointer to the memory to free
1483 GNUNET_CRYPTO_rsa_public_key_free (struct GNUNET_CRYPTO_rsa_PublicKey *key);
1487 * Encode the public key in a format suitable for
1488 * storing it into a file.
1490 * @param key the private key
1491 * @param[out] buffer set to a buffer with the encoded key
1492 * @return size of memory allocated in @a buffer
1495 GNUNET_CRYPTO_rsa_public_key_encode (const struct GNUNET_CRYPTO_rsa_PublicKey *key,
1500 * Decode the public key from the data-format back
1501 * to the "normal", internal format.
1503 * @param buf the buffer where the public key data is stored
1504 * @param len the length of the data in @a buf
1505 * @return NULL on error
1507 struct GNUNET_CRYPTO_rsa_PublicKey *
1508 GNUNET_CRYPTO_rsa_public_key_decode (const char *buf,
1513 * Create a blinding key
1515 * @param len length of the key in bits (i.e. 2048)
1516 * @return the newly created blinding key
1518 struct GNUNET_CRYPTO_rsa_BlindingKey *
1519 GNUNET_CRYPTO_rsa_blinding_key_create (unsigned int len);
1523 * Destroy a blinding key
1525 * @param bkey the blinding key to destroy
1528 GNUNET_CRYPTO_rsa_blinding_key_free (struct GNUNET_CRYPTO_rsa_BlindingKey *bkey);
1532 * Encode the blinding key in a format suitable for
1533 * storing it into a file.
1535 * @param bkey the blinding key
1536 * @param[out] buffer set to a buffer with the encoded key
1537 * @return size of memory allocated in @a buffer
1540 GNUNET_CRYPTO_rsa_blinding_key_encode (const struct GNUNET_CRYPTO_rsa_BlindingKey *bkey,
1545 * Decode the blinding key from the data-format back
1546 * to the "normal", internal format.
1548 * @param buf the buffer where the public key data is stored
1549 * @param len the length of the data in @a buf
1550 * @return NULL on error
1552 struct GNUNET_CRYPTO_rsa_BlindingKey *
1553 GNUNET_CRYPTO_rsa_blinding_key_decode (const char *buf,
1558 * Blinds the given message with the given blinding key
1560 * @param hash hash of the message to sign
1561 * @param bkey the blinding key
1562 * @param pkey the public key of the signer
1563 * @param[out] buffer set to a buffer with the blinded message to be signed
1564 * @return number of bytes stored in @a buffer
1567 GNUNET_CRYPTO_rsa_blind (const struct GNUNET_HashCode *hash,
1568 struct GNUNET_CRYPTO_rsa_BlindingKey *bkey,
1569 struct GNUNET_CRYPTO_rsa_PublicKey *pkey,
1574 * Sign the given message.
1576 * @param key private key to use for the signing
1577 * @param msg the (blinded) message to sign
1578 * @param msg_len number of bytes in @a msg to sign
1579 * @return NULL on error, signature on success
1581 struct GNUNET_CRYPTO_rsa_Signature *
1582 GNUNET_CRYPTO_rsa_sign (const struct GNUNET_CRYPTO_rsa_PrivateKey *key,
1588 * Free memory occupied by signature.
1590 * @param sig memory to freee
1593 GNUNET_CRYPTO_rsa_signature_free (struct GNUNET_CRYPTO_rsa_Signature *sig);
1597 * Encode the signature key in a format suitable for
1598 * storing it into a file.
1600 * @param sig the signature
1601 * @param[out] buffer set to a buffer with the encoded key
1602 * @return size of memory allocated in @a buffer
1605 GNUNET_CRYPTO_rsa_signature_encode (const struct GNUNET_CRYPTO_rsa_Signature *sig,
1610 * Decode the public key from the data-format back
1611 * to the "normal", internal format.
1613 * @param buf the buffer where the public key data is stored
1614 * @param len the length of the data in @a buf
1615 * @return NULL on error
1617 struct GNUNET_CRYPTO_rsa_Signature *
1618 GNUNET_CRYPTO_rsa_signature_decode (const char *buf,
1623 * Unblind a signature made on blinding signature purpose. The signature
1624 * purpose should have been generated with #GNUNET_CRYPTO_rsa_sign() using
1625 * a message that was generated with #GNUNET_CRYPTO_rsa_blind().
1627 * @param sig the signature made on the blinded signature purpose
1628 * @param bkey the blinding key used to blind the signature purpose
1629 * @param pkey the public key of the signer
1630 * @return unblinded signature on success, NULL on error
1632 struct GNUNET_CRYPTO_rsa_Signature *
1633 GNUNET_CRYPTO_rsa_unblind (struct GNUNET_CRYPTO_rsa_Signature *sig,
1634 struct GNUNET_CRYPTO_rsa_BlindingKey *bkey,
1635 struct GNUNET_CRYPTO_rsa_PublicKey *pkey);
1639 * Verify signature with the given hash.
1641 * @param hash the message to verify to match the @a sig
1642 * @param sig signature that is being validated
1643 * @param public_key public key of the signer
1644 * @returns #GNUNET_OK if ok, #GNUNET_SYSERR if invalid
1647 GNUNET_CRYPTO_rsa_verify (const struct GNUNET_HashCode *hash,
1648 const struct GNUNET_CRYPTO_rsa_Signature *sig,
1649 const struct GNUNET_CRYPTO_rsa_PublicKey *public_key);
1652 #if 0 /* keep Emacsens' auto-indent happy */
1660 /* ifndef GNUNET_CRYPTO_LIB_H */
1662 /* end of gnunet_crypto_lib.h */