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 plaintext.
371 struct GNUNET_CRYPTO_PaillierPlaintext
374 * The bits of the plaintext.
376 unsigned char bits[GNUNET_CRYPTO_PAILLIER_BITS / 8];
381 * Paillier ciphertext.
383 struct GNUNET_CRYPTO_PaillierCiphertext
386 * guaranteed minimum number of homomorphic operations with this ciphertext
388 uint32_t remaining_ops GNUNET_PACKED;
391 * The bits of the ciphertext.
393 unsigned char bits[GNUNET_CRYPTO_PAILLIER_BITS * 2 / 8];
397 /* **************** Functions and Macros ************* */
401 * Seed a weak random generator. Only #GNUNET_CRYPTO_QUALITY_WEAK-mode generator
404 * @param seed the seed to use
407 GNUNET_CRYPTO_seed_weak_random (int32_t seed);
411 * Perform an incremental step in a CRC16 (for TCP/IP) calculation.
413 * @param sum current sum, initially 0
414 * @param buf buffer to calculate CRC over (must be 16-bit aligned)
415 * @param len number of bytes in @a buf, must be multiple of 2
416 * @return updated crc sum (must be subjected to #GNUNET_CRYPTO_crc16_finish to get actual crc16)
419 GNUNET_CRYPTO_crc16_step (uint32_t sum, const void *buf, size_t len);
423 * Convert results from GNUNET_CRYPTO_crc16_step to final crc16.
425 * @param sum cummulative sum
426 * @return crc16 value
429 GNUNET_CRYPTO_crc16_finish (uint32_t sum);
434 * Calculate the checksum of a buffer in one step.
436 * @param buf buffer to calculate CRC over (must be 16-bit aligned)
437 * @param len number of bytes in @a buf, must be multiple of 2
438 * @return crc16 value
441 GNUNET_CRYPTO_crc16_n (const void *buf, size_t len);
446 * Compute the CRC32 checksum for the first len
447 * bytes of the buffer.
449 * @param buf the data over which we're taking the CRC
450 * @param len the length of the buffer @a buf in bytes
451 * @return the resulting CRC32 checksum
454 GNUNET_CRYPTO_crc32_n (const void *buf, size_t len);
459 * Fill block with a random values.
461 * @param mode desired quality of the random number
462 * @param buffer the buffer to fill
463 * @param length buffer length
466 GNUNET_CRYPTO_random_block (enum GNUNET_CRYPTO_Quality mode, void *buffer, size_t length);
470 * Produce a random value.
472 * @param mode desired quality of the random number
473 * @param i the upper limit (exclusive) for the random number
474 * @return a random value in the interval [0,@a i) (exclusive).
477 GNUNET_CRYPTO_random_u32 (enum GNUNET_CRYPTO_Quality mode, uint32_t i);
482 * Random on unsigned 64-bit values.
484 * @param mode desired quality of the random number
485 * @param max value returned will be in range [0,@a max) (exclusive)
486 * @return random 64-bit number
489 GNUNET_CRYPTO_random_u64 (enum GNUNET_CRYPTO_Quality mode, uint64_t max);
494 * Get an array with a random permutation of the
496 * @param mode #GNUNET_CRYPTO_QUALITY_STRONG if the strong (but expensive) PRNG should be used,
497 * #GNUNET_CRYPTO_QUALITY_WEAK or #GNUNET_CRYPTO_QUALITY_NONCE otherwise
498 * @param n the size of the array
499 * @return the permutation array (allocated from heap)
502 GNUNET_CRYPTO_random_permute (enum GNUNET_CRYPTO_Quality mode, unsigned int n);
507 * Create a new random session key.
509 * @param key key to initialize
512 GNUNET_CRYPTO_symmetric_create_session_key (struct GNUNET_CRYPTO_SymmetricSessionKey *key);
517 * Encrypt a block using a symmetric sessionkey.
519 * @param block the block to encrypt
520 * @param size the size of the @a block
521 * @param sessionkey the key used to encrypt
522 * @param iv the initialization vector to use, use INITVALUE
524 * @return the size of the encrypted block, -1 for errors
527 GNUNET_CRYPTO_symmetric_encrypt (const void *block, size_t size,
528 const struct GNUNET_CRYPTO_SymmetricSessionKey *sessionkey,
529 const struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
535 * Decrypt a given block using a symmetric sessionkey.
537 * @param block the data to decrypt, encoded as returned by encrypt
538 * @param size how big is the block?
539 * @param sessionkey the key used to decrypt
540 * @param iv the initialization vector to use
541 * @param result address to store the result at
542 * @return -1 on failure, size of decrypted block on success
545 GNUNET_CRYPTO_symmetric_decrypt (const void *block, size_t size,
546 const struct GNUNET_CRYPTO_SymmetricSessionKey *sessionkey,
547 const struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
553 * @brief Derive an IV
554 * @param iv initialization vector
555 * @param skey session key
556 * @param salt salt for the derivation
557 * @param salt_len size of the @a salt
558 * @param ... pairs of void * & size_t for context chunks, terminated by NULL
561 GNUNET_CRYPTO_symmetric_derive_iv (struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
562 const struct GNUNET_CRYPTO_SymmetricSessionKey *skey,
564 size_t salt_len, ...);
568 * @brief Derive an IV
569 * @param iv initialization vector
570 * @param skey session key
571 * @param salt salt for the derivation
572 * @param salt_len size of the @a salt
573 * @param argp pairs of void * & size_t for context chunks, terminated by NULL
576 GNUNET_CRYPTO_symmetric_derive_iv_v (struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
577 const struct GNUNET_CRYPTO_SymmetricSessionKey *skey,
585 * Convert hash to ASCII encoding.
586 * @param block the hash code
587 * @param result where to store the encoding (struct GNUNET_CRYPTO_HashAsciiEncoded can be
588 * safely cast to char*, a '\\0' termination is set).
591 GNUNET_CRYPTO_hash_to_enc (const struct GNUNET_HashCode * block,
592 struct GNUNET_CRYPTO_HashAsciiEncoded *result);
597 * Convert ASCII encoding back to a 'struct GNUNET_HashCode'
599 * @param enc the encoding
600 * @param enclen number of characters in @a enc (without 0-terminator, which can be missing)
601 * @param result where to store the hash code
602 * @return #GNUNET_OK on success, #GNUNET_SYSERR if result has the wrong encoding
605 GNUNET_CRYPTO_hash_from_string2 (const char *enc, size_t enclen,
606 struct GNUNET_HashCode *result);
611 * Convert ASCII encoding back to `struct GNUNET_HashCode`
613 * @param enc the encoding
614 * @param result where to store the hash code
615 * @return #GNUNET_OK on success, #GNUNET_SYSERR if result has the wrong encoding
617 #define GNUNET_CRYPTO_hash_from_string(enc, result) \
618 GNUNET_CRYPTO_hash_from_string2 (enc, strlen(enc), result)
624 * Compute the distance between 2 hashcodes. The
625 * computation must be fast, not involve @a a[0] or @a a[4] (they're used
626 * elsewhere), and be somewhat consistent. And of course, the result
627 * should be a positive number.
629 * @param a some hash code
630 * @param b some hash code
631 * @return number between 0 and UINT32_MAX
634 GNUNET_CRYPTO_hash_distance_u32 (const struct GNUNET_HashCode *a,
635 const struct GNUNET_HashCode *b);
640 * Compute hash of a given block.
642 * @param block the data to hash
643 * @param size size of the @a block
644 * @param ret pointer to where to write the hashcode
647 GNUNET_CRYPTO_hash (const void *block, size_t size, struct GNUNET_HashCode * ret);
652 * Calculate HMAC of a message (RFC 2104)
654 * @param key secret key
655 * @param plaintext input plaintext
656 * @param plaintext_len length of @a plaintext
657 * @param hmac where to store the hmac
660 GNUNET_CRYPTO_hmac (const struct GNUNET_CRYPTO_AuthKey *key,
661 const void *plaintext, size_t plaintext_len,
662 struct GNUNET_HashCode * hmac);
666 * Function called once the hash computation over the
667 * specified file has completed.
670 * @param res resulting hash, NULL on error
672 typedef void (*GNUNET_CRYPTO_HashCompletedCallback) (void *cls,
673 const struct GNUNET_HashCode *res);
677 * Handle to file hashing operation.
679 struct GNUNET_CRYPTO_FileHashContext;
684 * Compute the hash of an entire file.
686 * @param priority scheduling priority to use
687 * @param filename name of file to hash
688 * @param blocksize number of bytes to process in one task
689 * @param callback function to call upon completion
690 * @param callback_cls closure for @a callback
691 * @return NULL on (immediate) errror
693 struct GNUNET_CRYPTO_FileHashContext *
694 GNUNET_CRYPTO_hash_file (enum GNUNET_SCHEDULER_Priority priority,
695 const char *filename, size_t blocksize,
696 GNUNET_CRYPTO_HashCompletedCallback callback,
701 * Cancel a file hashing operation.
703 * @param fhc operation to cancel (callback must not yet have been invoked)
706 GNUNET_CRYPTO_hash_file_cancel (struct GNUNET_CRYPTO_FileHashContext *fhc);
711 * Create a random hash code.
713 * @param mode desired quality level
714 * @param result hash code that is randomized
717 GNUNET_CRYPTO_hash_create_random (enum GNUNET_CRYPTO_Quality mode,
718 struct GNUNET_HashCode *result);
723 * compute @a result = @a b - @a a
725 * @param a some hash code
726 * @param b some hash code
727 * @param result set to @a b - @a a
730 GNUNET_CRYPTO_hash_difference (const struct GNUNET_HashCode *a,
731 const struct GNUNET_HashCode *b,
732 struct GNUNET_HashCode *result);
737 * compute @a result = @a a + @a delta
739 * @param a some hash code
740 * @param delta some hash code
741 * @param result set to @a a + @a delta
744 GNUNET_CRYPTO_hash_sum (const struct GNUNET_HashCode *a,
745 const struct GNUNET_HashCode *delta,
746 struct GNUNET_HashCode *result);
751 * compute result = a ^ b
753 * @param a some hash code
754 * @param b some hash code
755 * @param result set to @a a ^ @a b
758 GNUNET_CRYPTO_hash_xor (const struct GNUNET_HashCode * a, const struct GNUNET_HashCode * b,
759 struct GNUNET_HashCode * result);
764 * Convert a hashcode into a key.
766 * @param hc hash code that serves to generate the key
767 * @param skey set to a valid session key
768 * @param iv set to a valid initialization vector
771 GNUNET_CRYPTO_hash_to_aes_key (const struct GNUNET_HashCode * hc,
772 struct GNUNET_CRYPTO_SymmetricSessionKey *skey,
773 struct GNUNET_CRYPTO_SymmetricInitializationVector *iv);
778 * Obtain a bit from a hashcode.
780 * @param code the `struct GNUNET_HashCode` to index bit-wise
781 * @param bit index into the hashcode, [0...159]
782 * @return Bit \a bit from hashcode \a code, -1 for invalid index
785 GNUNET_CRYPTO_hash_get_bit (const struct GNUNET_HashCode *code,
791 * Determine how many low order bits match in two
792 * `struct GNUNET_HashCodes`. i.e. - 010011 and 011111 share
793 * the first two lowest order bits, and therefore the
794 * return value is two (NOT XOR distance, nor how many
795 * bits match absolutely!).
797 * @param first the first hashcode
798 * @param second the hashcode to compare first to
799 * @return the number of bits that match
802 GNUNET_CRYPTO_hash_matching_bits (const struct GNUNET_HashCode *first,
803 const struct GNUNET_HashCode *second);
808 * Compare function for HashCodes, producing a total ordering
811 * @param h1 some hash code
812 * @param h2 some hash code
813 * @return 1 if @a h1 > @a h2, -1 if @a h1 < @a h2 and 0 if @a h1 == @a h2.
816 GNUNET_CRYPTO_hash_cmp (const struct GNUNET_HashCode *h1,
817 const struct GNUNET_HashCode *h2);
822 * Find out which of the two GNUNET_CRYPTO_hash codes is closer to target
823 * in the XOR metric (Kademlia).
825 * @param h1 some hash code
826 * @param h2 some hash code
827 * @param target some hash code
828 * @return -1 if @a h1 is closer, 1 if @a h2 is closer and 0 if @a h1== @a h2.
831 GNUNET_CRYPTO_hash_xorcmp (const struct GNUNET_HashCode *h1,
832 const struct GNUNET_HashCode *h2,
833 const struct GNUNET_HashCode *target);
838 * @brief Derive an authentication key
839 * @param key authentication key
840 * @param rkey root key
842 * @param salt_len size of the salt
843 * @param argp pair of void * & size_t for context chunks, terminated by NULL
846 GNUNET_CRYPTO_hmac_derive_key_v (struct GNUNET_CRYPTO_AuthKey *key,
847 const struct GNUNET_CRYPTO_SymmetricSessionKey *rkey,
848 const void *salt, size_t salt_len,
854 * @brief Derive an authentication key
855 * @param key authentication key
856 * @param rkey root key
858 * @param salt_len size of the salt
859 * @param ... pair of void * & size_t for context chunks, terminated by NULL
862 GNUNET_CRYPTO_hmac_derive_key (struct GNUNET_CRYPTO_AuthKey *key,
863 const struct GNUNET_CRYPTO_SymmetricSessionKey *rkey,
864 const void *salt, size_t salt_len, ...);
870 * @param result buffer for the derived key, allocated by caller
871 * @param out_len desired length of the derived key
872 * @param xtr_algo hash algorithm for the extraction phase, GCRY_MD_...
873 * @param prf_algo hash algorithm for the expansion phase, GCRY_MD_...
875 * @param xts_len length of @a xts
876 * @param skm source key material
877 * @param skm_len length of @a skm
878 * @param ... pair of void * & size_t for context chunks, terminated by NULL
879 * @return #GNUNET_YES on success
882 GNUNET_CRYPTO_hkdf (void *result, size_t out_len, int xtr_algo, int prf_algo,
883 const void *xts, size_t xts_len, const void *skm,
884 size_t skm_len, ...);
890 * @param result buffer for the derived key, allocated by caller
891 * @param out_len desired length of the derived key
892 * @param xtr_algo hash algorithm for the extraction phase, GCRY_MD_...
893 * @param prf_algo hash algorithm for the expansion phase, GCRY_MD_...
895 * @param xts_len length of @a xts
896 * @param skm source key material
897 * @param skm_len length of @a skm
898 * @param argp va_list of void * & size_t pairs for context chunks
899 * @return #GNUNET_YES on success
902 GNUNET_CRYPTO_hkdf_v (void *result, size_t out_len, int xtr_algo, int prf_algo,
903 const void *xts, size_t xts_len, const void *skm,
904 size_t skm_len, va_list argp);
909 * @param result buffer for the derived key, allocated by caller
910 * @param out_len desired length of the derived key
912 * @param xts_len length of @a xts
913 * @param skm source key material
914 * @param skm_len length of @a skm
915 * @param argp va_list of void * & size_t pairs for context chunks
916 * @return #GNUNET_YES on success
919 GNUNET_CRYPTO_kdf_v (void *result, size_t out_len, const void *xts,
920 size_t xts_len, const void *skm, size_t skm_len,
927 * @param result buffer for the derived key, allocated by caller
928 * @param out_len desired length of the derived key
930 * @param xts_len length of @a xts
931 * @param skm source key material
932 * @param skm_len length of @a skm
933 * @param ... void * & size_t pairs for context chunks
934 * @return #GNUNET_YES on success
937 GNUNET_CRYPTO_kdf (void *result, size_t out_len, const void *xts,
938 size_t xts_len, const void *skm, size_t skm_len, ...);
943 * Extract the public key for the given private key.
945 * @param priv the private key
946 * @param pub where to write the public key
949 GNUNET_CRYPTO_ecdsa_key_get_public (const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv,
950 struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
954 * Extract the public key for the given private key.
956 * @param priv the private key
957 * @param pub where to write the public key
960 GNUNET_CRYPTO_eddsa_key_get_public (const struct GNUNET_CRYPTO_EddsaPrivateKey *priv,
961 struct GNUNET_CRYPTO_EddsaPublicKey *pub);
966 * Extract the public key for the given private key.
968 * @param priv the private key
969 * @param pub where to write the public key
972 GNUNET_CRYPTO_ecdhe_key_get_public (const struct GNUNET_CRYPTO_EcdhePrivateKey *priv,
973 struct GNUNET_CRYPTO_EcdhePublicKey *pub);
977 * Convert a public key to a string.
979 * @param pub key to convert
980 * @return string representing @a pub
983 GNUNET_CRYPTO_ecdsa_public_key_to_string (const struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
987 * Convert a public key to a string.
989 * @param pub key to convert
990 * @return string representing @a pub
993 GNUNET_CRYPTO_eddsa_public_key_to_string (const struct GNUNET_CRYPTO_EddsaPublicKey *pub);
997 * Convert a string representing a public key to a public key.
999 * @param enc encoded public key
1000 * @param enclen number of bytes in @a enc (without 0-terminator)
1001 * @param pub where to store the public key
1002 * @return #GNUNET_OK on success
1005 GNUNET_CRYPTO_ecdsa_public_key_from_string (const char *enc,
1007 struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
1011 * Convert a string representing a public key to a public key.
1013 * @param enc encoded public key
1014 * @param enclen number of bytes in @a enc (without 0-terminator)
1015 * @param pub where to store the public key
1016 * @return #GNUNET_OK on success
1019 GNUNET_CRYPTO_eddsa_public_key_from_string (const char *enc,
1021 struct GNUNET_CRYPTO_EddsaPublicKey *pub);
1026 * Create a new private key by reading it from a file. If the
1027 * files does not exist, create a new key and write it to the
1028 * file. Caller must free return value. Note that this function
1029 * can not guarantee that another process might not be trying
1030 * the same operation on the same file at the same time.
1031 * If the contents of the file
1032 * are invalid the old file is deleted and a fresh key is
1035 * @param filename name of file to use to store the key
1036 * @return new private key, NULL on error (for example,
1037 * permission denied); free using #GNUNET_free
1039 struct GNUNET_CRYPTO_EcdsaPrivateKey *
1040 GNUNET_CRYPTO_ecdsa_key_create_from_file (const char *filename);
1045 * Create a new private key by reading it from a file. If the
1046 * files does not exist, create a new key and write it to the
1047 * file. Caller must free return value. Note that this function
1048 * can not guarantee that another process might not be trying
1049 * the same operation on the same file at the same time.
1050 * If the contents of the file
1051 * are invalid the old file is deleted and a fresh key is
1054 * @param filename name of file to use to store the key
1055 * @return new private key, NULL on error (for example,
1056 * permission denied); free using #GNUNET_free
1058 struct GNUNET_CRYPTO_EddsaPrivateKey *
1059 GNUNET_CRYPTO_eddsa_key_create_from_file (const char *filename);
1064 * Create a new private key by reading our peer's key from
1065 * the file specified in the configuration.
1067 * @param cfg the configuration to use
1068 * @return new private key, NULL on error (for example,
1069 * permission denied); free using #GNUNET_free
1071 struct GNUNET_CRYPTO_EddsaPrivateKey *
1072 GNUNET_CRYPTO_eddsa_key_create_from_configuration (const struct GNUNET_CONFIGURATION_Handle *cfg);
1077 * Create a new private key. Caller must free return value.
1079 * @return fresh private key; free using #GNUNET_free
1081 struct GNUNET_CRYPTO_EcdsaPrivateKey *
1082 GNUNET_CRYPTO_ecdsa_key_create (void);
1087 * Create a new private key. Caller must free return value.
1089 * @return fresh private key; free using #GNUNET_free
1091 struct GNUNET_CRYPTO_EddsaPrivateKey *
1092 GNUNET_CRYPTO_eddsa_key_create (void);
1097 * Create a new private key. Caller must free return value.
1099 * @return fresh private key; free using #GNUNET_free
1101 struct GNUNET_CRYPTO_EcdhePrivateKey *
1102 GNUNET_CRYPTO_ecdhe_key_create (void);
1107 * Clear memory that was used to store a private key.
1109 * @param pk location of the key
1112 GNUNET_CRYPTO_eddsa_key_clear (struct GNUNET_CRYPTO_EddsaPrivateKey *pk);
1117 * Clear memory that was used to store a private key.
1119 * @param pk location of the key
1122 GNUNET_CRYPTO_ecdsa_key_clear (struct GNUNET_CRYPTO_EcdsaPrivateKey *pk);
1126 * Clear memory that was used to store a private key.
1128 * @param pk location of the key
1131 GNUNET_CRYPTO_ecdhe_key_clear (struct GNUNET_CRYPTO_EcdhePrivateKey *pk);
1136 * Get the shared private key we use for anonymous users.
1138 * @return "anonymous" private key; do not free
1140 const struct GNUNET_CRYPTO_EcdsaPrivateKey *
1141 GNUNET_CRYPTO_ecdsa_key_get_anonymous (void);
1146 * Setup a hostkey file for a peer given the name of the
1147 * configuration file (!). This function is used so that
1148 * at a later point code can be certain that reading a
1149 * hostkey is fast (for example in time-dependent testcases).
1151 * @param cfg_name name of the configuration file to use
1154 GNUNET_CRYPTO_eddsa_setup_hostkey (const char *cfg_name);
1159 * Retrieve the identity of the host's peer.
1161 * @param cfg configuration to use
1162 * @param dst pointer to where to write the peer identity
1163 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the identity
1164 * could not be retrieved
1167 GNUNET_CRYPTO_get_peer_identity (const struct GNUNET_CONFIGURATION_Handle *cfg,
1168 struct GNUNET_PeerIdentity *dst);
1171 * Compare two Peer Identities.
1173 * @param first first peer identity
1174 * @param second second peer identity
1175 * @return bigger than 0 if first > second,
1176 * 0 if they are the same
1177 * smaller than 0 if second > first
1180 GNUNET_CRYPTO_cmp_peer_identity (const struct GNUNET_PeerIdentity *first,
1181 const struct GNUNET_PeerIdentity *second);
1186 * Derive key material from a public and a private ECC key.
1188 * @param priv private key to use for the ECDH (x)
1189 * @param pub public key to use for the ECDH (yG)
1190 * @param key_material where to write the key material (xyG)
1191 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
1194 GNUNET_CRYPTO_ecc_ecdh (const struct GNUNET_CRYPTO_EcdhePrivateKey *priv,
1195 const struct GNUNET_CRYPTO_EcdhePublicKey *pub,
1196 struct GNUNET_HashCode *key_material);
1201 * EdDSA sign a given block.
1203 * @param priv private key to use for the signing
1204 * @param purpose what to sign (size, purpose)
1205 * @param sig where to write the signature
1206 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
1209 GNUNET_CRYPTO_eddsa_sign (const struct GNUNET_CRYPTO_EddsaPrivateKey *priv,
1210 const struct GNUNET_CRYPTO_EccSignaturePurpose *purpose,
1211 struct GNUNET_CRYPTO_EddsaSignature *sig);
1216 * ECDSA Sign a given block.
1218 * @param priv private key to use for the signing
1219 * @param purpose what to sign (size, purpose)
1220 * @param sig where to write the signature
1221 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
1224 GNUNET_CRYPTO_ecdsa_sign (const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv,
1225 const struct GNUNET_CRYPTO_EccSignaturePurpose *purpose,
1226 struct GNUNET_CRYPTO_EcdsaSignature *sig);
1230 * Verify EdDSA signature.
1232 * @param purpose what is the purpose that the signature should have?
1233 * @param validate block to validate (size, purpose, data)
1234 * @param sig signature that is being validated
1235 * @param pub public key of the signer
1236 * @returns #GNUNET_OK if ok, #GNUNET_SYSERR if invalid
1239 GNUNET_CRYPTO_eddsa_verify (uint32_t purpose,
1240 const struct GNUNET_CRYPTO_EccSignaturePurpose *validate,
1241 const struct GNUNET_CRYPTO_EddsaSignature *sig,
1242 const struct GNUNET_CRYPTO_EddsaPublicKey *pub);
1248 * Verify ECDSA signature.
1250 * @param purpose what is the purpose that the signature should have?
1251 * @param validate block to validate (size, purpose, data)
1252 * @param sig signature that is being validated
1253 * @param pub public key of the signer
1254 * @returns #GNUNET_OK if ok, #GNUNET_SYSERR if invalid
1257 GNUNET_CRYPTO_ecdsa_verify (uint32_t purpose,
1258 const struct GNUNET_CRYPTO_EccSignaturePurpose *validate,
1259 const struct GNUNET_CRYPTO_EcdsaSignature *sig,
1260 const struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
1265 * Derive a private key from a given private key and a label.
1266 * Essentially calculates a private key 'h = H(l,P) * d mod n'
1267 * where n is the size of the ECC group and P is the public
1268 * key associated with the private key 'd'.
1270 * @param priv original private key
1271 * @param label label to use for key deriviation
1272 * @param context additional context to use for HKDF of 'h';
1273 * typically the name of the subsystem/application
1274 * @return derived private key
1276 struct GNUNET_CRYPTO_EcdsaPrivateKey *
1277 GNUNET_CRYPTO_ecdsa_private_key_derive (const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv,
1279 const char *context);
1284 * Derive a public key from a given public key and a label.
1285 * Essentially calculates a public key 'V = H(l,P) * P'.
1287 * @param pub original public key
1288 * @param label label to use for key deriviation
1289 * @param context additional context to use for HKDF of 'h'.
1290 * typically the name of the subsystem/application
1291 * @param result where to write the derived public key
1294 GNUNET_CRYPTO_ecdsa_public_key_derive (const struct GNUNET_CRYPTO_EcdsaPublicKey *pub,
1296 const char *context,
1297 struct GNUNET_CRYPTO_EcdsaPublicKey *result);
1301 * Output the given MPI value to the given buffer in network
1302 * byte order. The MPI @a val may not be negative.
1304 * @param buf where to output to
1305 * @param size number of bytes in @a buf
1306 * @param val value to write to @a buf
1309 GNUNET_CRYPTO_mpi_print_unsigned (void *buf,
1315 * Convert data buffer into MPI value.
1316 * The buffer is interpreted as network
1317 * byte order, unsigned integer.
1319 * @param result where to store MPI value (allocated)
1320 * @param data raw data (GCRYMPI_FMT_USG)
1321 * @param size number of bytes in @a data
1324 GNUNET_CRYPTO_mpi_scan_unsigned (gcry_mpi_t *result,
1330 * Create a freshly generated paillier public key.
1332 * @param[out] public_key Where to store the public key?
1333 * @param[out] private_key Where to store the private key?
1336 GNUNET_CRYPTO_paillier_create (struct GNUNET_CRYPTO_PaillierPublicKey *public_key,
1337 struct GNUNET_CRYPTO_PaillierPrivateKey *private_key);
1341 * Encrypt a plaintext with a paillier public key.
1343 * @param public_key Public key to use.
1344 * @param m Plaintext to encrypt.
1345 * @param[out] ciphertext Encrytion of @a plaintext with @a public_key.
1346 * @return guaranteed number of supported homomorphic operations
1349 GNUNET_CRYPTO_paillier_encrypt (const struct GNUNET_CRYPTO_PaillierPublicKey *public_key,
1351 struct GNUNET_CRYPTO_PaillierCiphertext *ciphertext);
1355 * Decrypt a paillier ciphertext with a private key.
1357 * @param private_key Private key to use for decryption.
1358 * @param public_key Public key to use for decryption.
1359 * @param ciphertext Ciphertext to decrypt.
1360 * @param[out] m Decryption of @a ciphertext with @private_key.
1363 GNUNET_CRYPTO_paillier_decrypt (const struct GNUNET_CRYPTO_PaillierPrivateKey *private_key,
1364 const struct GNUNET_CRYPTO_PaillierPublicKey *public_key,
1365 const struct GNUNET_CRYPTO_PaillierCiphertext *ciphertext,
1370 * Compute a ciphertext that represents the sum of the plaintext in @a x1 and @a x2
1372 * Note that this operation can only be done a finite number of times
1373 * before an overflow occurs.
1375 * @param x1 Paillier cipher text.
1376 * @param x2 Paillier cipher text.
1377 * @param[out] result Result of the homomorphic operation.
1378 * @return #GNUNET_OK if the result could be computed,
1379 * #GNUNET_SYSERR if no more homomorphic operations are remaining.
1382 GNUNET_CRYPTO_paillier_hom_add (const struct GNUNET_CRYPTO_PaillierCiphertext *x1,
1383 const struct GNUNET_CRYPTO_PaillierCiphertext *x2,
1384 const struct GNUNET_CRYPTO_PaillierCiphertext *result);
1387 #if 0 /* keep Emacsens' auto-indent happy */
1395 /* ifndef GNUNET_CRYPTO_LIB_H */
1397 /* end of gnunet_crypto_lib.h */