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"
61 * @brief A 512-bit hashcode
63 struct GNUNET_HashCode
65 uint32_t bits[512 / 8 / sizeof (uint32_t)]; /* = 16 */
70 * Maximum length of an ECC signature.
71 * Note: round up to multiple of 8 minus 2 for alignment.
73 #define GNUNET_CRYPTO_ECC_SIGNATURE_DATA_ENCODING_LENGTH 126
77 * Desired quality level for random numbers.
80 enum GNUNET_CRYPTO_Quality
83 * No good quality of the operation is needed (i.e.,
84 * random numbers can be pseudo-random).
87 GNUNET_CRYPTO_QUALITY_WEAK,
90 * High-quality operations are desired.
93 GNUNET_CRYPTO_QUALITY_STRONG,
96 * Randomness for IVs etc. is required.
99 GNUNET_CRYPTO_QUALITY_NONCE
104 * @brief length of the sessionkey in bytes (256 BIT sessionkey)
106 #define GNUNET_CRYPTO_AES_KEY_LENGTH (256/8)
109 * Length of a hash value
111 #define GNUNET_CRYPTO_HASH_LENGTH (512/8)
114 * @brief 0-terminated ASCII encoding of a struct GNUNET_HashCode.
116 struct GNUNET_CRYPTO_HashAsciiEncoded
118 unsigned char encoding[104];
122 GNUNET_NETWORK_STRUCT_BEGIN
126 * @brief header of what an ECC signature signs
127 * this must be followed by "size - 8" bytes of
128 * the actual signed data
130 struct GNUNET_CRYPTO_EccSignaturePurpose
133 * How many bytes does this signature sign?
134 * (including this purpose header); in network
137 uint32_t size GNUNET_PACKED;
140 * What does this signature vouch for? This
141 * must contain a GNUNET_SIGNATURE_PURPOSE_XXX
142 * constant (from gnunet_signatures.h). In
143 * network byte order!
145 uint32_t purpose GNUNET_PACKED;
151 * @brief an ECC signature
153 struct GNUNET_CRYPTO_EccSignature
159 unsigned char r[256 / 8];
164 unsigned char s[256 / 8];
170 * Public ECC key (always for NIST P-521) encoded in a format suitable
171 * for network transmission and signatures (ECDSA/EdDSA).
173 struct GNUNET_CRYPTO_EccPublicSignKey
176 * Q consists of an x- and a y-value, each mod p (256 bits),
177 * given here in affine coordinates.
179 * FIXME: this coordinate will be removed in the future (compressed point!).
181 unsigned char q_x[256 / 8];
184 * Q consists of an x- and a y-value, each mod p (256 bits),
185 * given here in affine coordinates.
187 unsigned char q_y[256 / 8];
193 * The identity of the host (wraps the signing key of the peer).
195 struct GNUNET_PeerIdentity
197 struct GNUNET_CRYPTO_EccPublicSignKey public_key;
202 * Public ECC key (always for NIST P-521) encoded in a format suitable
203 * for network transmission and encryption (ECDH).
205 struct GNUNET_CRYPTO_EccPublicEncryptKey
208 * Q consists of an x- and a y-value, each mod p (256 bits),
209 * given here in affine coordinates.
211 unsigned char q_x[256 / 8];
214 * Q consists of an x- and a y-value, each mod p (256 bits),
215 * given here in affine coordinates.
217 * FIXME: this coordinate will be removed in the future (compressed point!).
219 unsigned char q_y[256 / 8];
225 * Private ECC key encoded for transmission.
227 struct GNUNET_CRYPTO_EccPrivateKey
230 * d is a value mod n, where n has at most 256 bits.
232 unsigned char d[256 / 8];
238 * @brief type for session keys
240 struct GNUNET_CRYPTO_SymmetricSessionKey
243 * Actual key for AES.
245 unsigned char aes_key[GNUNET_CRYPTO_AES_KEY_LENGTH];
248 * Actual key for TwoFish.
250 unsigned char twofish_key[GNUNET_CRYPTO_AES_KEY_LENGTH];
254 GNUNET_NETWORK_STRUCT_END
257 * @brief IV for sym cipher
259 * NOTE: must be smaller (!) in size than the
260 * `struct GNUNET_HashCode`.
262 struct GNUNET_CRYPTO_SymmetricInitializationVector
264 unsigned char aes_iv[GNUNET_CRYPTO_AES_KEY_LENGTH / 2];
266 unsigned char twofish_iv[GNUNET_CRYPTO_AES_KEY_LENGTH / 2];
271 * @brief type for (message) authentication keys
273 struct GNUNET_CRYPTO_AuthKey
275 unsigned char key[GNUNET_CRYPTO_HASH_LENGTH];
279 /* **************** Functions and Macros ************* */
283 * Seed a weak random generator. Only #GNUNET_CRYPTO_QUALITY_WEAK-mode generator
286 * @param seed the seed to use
289 GNUNET_CRYPTO_seed_weak_random (int32_t seed);
293 * Perform an incremental step in a CRC16 (for TCP/IP) calculation.
295 * @param sum current sum, initially 0
296 * @param buf buffer to calculate CRC over (must be 16-bit aligned)
297 * @param len number of bytes in @a buf, must be multiple of 2
298 * @return updated crc sum (must be subjected to #GNUNET_CRYPTO_crc16_finish to get actual crc16)
301 GNUNET_CRYPTO_crc16_step (uint32_t sum, const void *buf, size_t len);
305 * Convert results from GNUNET_CRYPTO_crc16_step to final crc16.
307 * @param sum cummulative sum
308 * @return crc16 value
311 GNUNET_CRYPTO_crc16_finish (uint32_t sum);
316 * Calculate the checksum of a buffer in one step.
318 * @param buf buffer to calculate CRC over (must be 16-bit aligned)
319 * @param len number of bytes in @a buf, must be multiple of 2
320 * @return crc16 value
323 GNUNET_CRYPTO_crc16_n (const void *buf, size_t len);
328 * Compute the CRC32 checksum for the first len
329 * bytes of the buffer.
331 * @param buf the data over which we're taking the CRC
332 * @param len the length of the buffer @a buf in bytes
333 * @return the resulting CRC32 checksum
336 GNUNET_CRYPTO_crc32_n (const void *buf, size_t len);
341 * Produce a random value.
343 * @param mode desired quality of the random number
344 * @param i the upper limit (exclusive) for the random number
345 * @return a random value in the interval [0,@a i) (exclusive).
348 GNUNET_CRYPTO_random_u32 (enum GNUNET_CRYPTO_Quality mode, uint32_t i);
353 * Random on unsigned 64-bit values.
355 * @param mode desired quality of the random number
356 * @param max value returned will be in range [0,@a max) (exclusive)
357 * @return random 64-bit number
360 GNUNET_CRYPTO_random_u64 (enum GNUNET_CRYPTO_Quality mode, uint64_t max);
365 * Get an array with a random permutation of the
367 * @param mode #GNUNET_CRYPTO_QUALITY_STRONG if the strong (but expensive) PRNG should be used,
368 * #GNUNET_CRYPTO_QUALITY_WEAK or #GNUNET_CRYPTO_QUALITY_NONCE otherwise
369 * @param n the size of the array
370 * @return the permutation array (allocated from heap)
373 GNUNET_CRYPTO_random_permute (enum GNUNET_CRYPTO_Quality mode, unsigned int n);
378 * Create a new random session key.
380 * @param key key to initialize
383 GNUNET_CRYPTO_symmetric_create_session_key (struct GNUNET_CRYPTO_SymmetricSessionKey *key);
388 * Encrypt a block using a symmetric sessionkey.
390 * @param block the block to encrypt
391 * @param len the size of the block
392 * @param sessionkey the key used to encrypt
393 * @param iv the initialization vector to use, use INITVALUE
395 * @return the size of the encrypted block, -1 for errors
398 GNUNET_CRYPTO_symmetric_encrypt (const void *block, size_t len,
399 const struct GNUNET_CRYPTO_SymmetricSessionKey *sessionkey,
400 const struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
406 * Decrypt a given block using a symmetric sessionkey.
408 * @param block the data to decrypt, encoded as returned by encrypt
409 * @param size how big is the block?
410 * @param sessionkey the key used to decrypt
411 * @param iv the initialization vector to use
412 * @param result address to store the result at
413 * @return -1 on failure, size of decrypted block on success
416 GNUNET_CRYPTO_symmetric_decrypt (const void *block, size_t size,
417 const struct GNUNET_CRYPTO_SymmetricSessionKey *sessionkey,
418 const struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
424 * @brief Derive an IV
425 * @param iv initialization vector
426 * @param skey session key
427 * @param salt salt for the derivation
428 * @param salt_len size of the @a salt
429 * @param ... pairs of void * & size_t for context chunks, terminated by NULL
432 GNUNET_CRYPTO_symmetric_derive_iv (struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
433 const struct GNUNET_CRYPTO_SymmetricSessionKey *skey,
435 size_t salt_len, ...);
439 * @brief Derive an IV
440 * @param iv initialization vector
441 * @param skey session key
442 * @param salt salt for the derivation
443 * @param salt_len size of the @a salt
444 * @param argp pairs of void * & size_t for context chunks, terminated by NULL
447 GNUNET_CRYPTO_symmetric_derive_iv_v (struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
448 const struct GNUNET_CRYPTO_SymmetricSessionKey *skey,
456 * Convert hash to ASCII encoding.
457 * @param block the hash code
458 * @param result where to store the encoding (struct GNUNET_CRYPTO_HashAsciiEncoded can be
459 * safely cast to char*, a '\\0' termination is set).
462 GNUNET_CRYPTO_hash_to_enc (const struct GNUNET_HashCode * block,
463 struct GNUNET_CRYPTO_HashAsciiEncoded *result);
468 * Convert ASCII encoding back to a 'struct GNUNET_HashCode'
470 * @param enc the encoding
471 * @param enclen number of characters in @a enc (without 0-terminator, which can be missing)
472 * @param result where to store the hash code
473 * @return #GNUNET_OK on success, #GNUNET_SYSERR if result has the wrong encoding
476 GNUNET_CRYPTO_hash_from_string2 (const char *enc, size_t enclen,
477 struct GNUNET_HashCode *result);
482 * Convert ASCII encoding back to `struct GNUNET_HashCode`
484 * @param enc the encoding
485 * @param result where to store the hash code
486 * @return #GNUNET_OK on success, #GNUNET_SYSERR if result has the wrong encoding
488 #define GNUNET_CRYPTO_hash_from_string(enc, result) \
489 GNUNET_CRYPTO_hash_from_string2 (enc, strlen(enc), result)
495 * Compute the distance between 2 hashcodes. The
496 * computation must be fast, not involve @a a[0] or @a a[4] (they're used
497 * elsewhere), and be somewhat consistent. And of course, the result
498 * should be a positive number.
500 * @param a some hash code
501 * @param b some hash code
502 * @return number between 0 and UINT32_MAX
505 GNUNET_CRYPTO_hash_distance_u32 (const struct GNUNET_HashCode *a,
506 const struct GNUNET_HashCode *b);
511 * Compute hash of a given block.
513 * @param block the data to hash
514 * @param size size of the @a block
515 * @param ret pointer to where to write the hashcode
518 GNUNET_CRYPTO_hash (const void *block, size_t size, struct GNUNET_HashCode * ret);
523 * Calculate HMAC of a message (RFC 2104)
525 * @param key secret key
526 * @param plaintext input plaintext
527 * @param plaintext_len length of @a plaintext
528 * @param hmac where to store the hmac
531 GNUNET_CRYPTO_hmac (const struct GNUNET_CRYPTO_AuthKey *key,
532 const void *plaintext, size_t plaintext_len,
533 struct GNUNET_HashCode * hmac);
537 * Function called once the hash computation over the
538 * specified file has completed.
541 * @param res resulting hash, NULL on error
543 typedef void (*GNUNET_CRYPTO_HashCompletedCallback) (void *cls,
544 const struct GNUNET_HashCode *res);
548 * Handle to file hashing operation.
550 struct GNUNET_CRYPTO_FileHashContext;
555 * Compute the hash of an entire file.
557 * @param priority scheduling priority to use
558 * @param filename name of file to hash
559 * @param blocksize number of bytes to process in one task
560 * @param callback function to call upon completion
561 * @param callback_cls closure for @a callback
562 * @return NULL on (immediate) errror
564 struct GNUNET_CRYPTO_FileHashContext *
565 GNUNET_CRYPTO_hash_file (enum GNUNET_SCHEDULER_Priority priority,
566 const char *filename, size_t blocksize,
567 GNUNET_CRYPTO_HashCompletedCallback callback,
572 * Cancel a file hashing operation.
574 * @param fhc operation to cancel (callback must not yet have been invoked)
577 GNUNET_CRYPTO_hash_file_cancel (struct GNUNET_CRYPTO_FileHashContext *fhc);
582 * Create a random hash code.
584 * @param mode desired quality level
585 * @param result hash code that is randomized
588 GNUNET_CRYPTO_hash_create_random (enum GNUNET_CRYPTO_Quality mode,
589 struct GNUNET_HashCode *result);
594 * compute @a result = @a b - @a a
596 * @param a some hash code
597 * @param b some hash code
598 * @param result set to @a b - @a a
601 GNUNET_CRYPTO_hash_difference (const struct GNUNET_HashCode *a,
602 const struct GNUNET_HashCode *b,
603 struct GNUNET_HashCode *result);
608 * compute @a result = @a a + @a delta
610 * @param a some hash code
611 * @param delta some hash code
612 * @param result set to @a a + @a delta
615 GNUNET_CRYPTO_hash_sum (const struct GNUNET_HashCode *a,
616 const struct GNUNET_HashCode *delta,
617 struct GNUNET_HashCode *result);
622 * compute result = a ^ b
624 * @param a some hash code
625 * @param b some hash code
626 * @param result set to @a a ^ @a b
629 GNUNET_CRYPTO_hash_xor (const struct GNUNET_HashCode * a, const struct GNUNET_HashCode * b,
630 struct GNUNET_HashCode * result);
635 * Convert a hashcode into a key.
637 * @param hc hash code that serves to generate the key
638 * @param skey set to a valid session key
639 * @param iv set to a valid initialization vector
642 GNUNET_CRYPTO_hash_to_aes_key (const struct GNUNET_HashCode * hc,
643 struct GNUNET_CRYPTO_SymmetricSessionKey *skey,
644 struct GNUNET_CRYPTO_SymmetricInitializationVector *iv);
649 * Obtain a bit from a hashcode.
651 * @param code the `struct GNUNET_HashCode` to index bit-wise
652 * @param bit index into the hashcode, [0...159]
653 * @return Bit \a bit from hashcode \a code, -1 for invalid index
656 GNUNET_CRYPTO_hash_get_bit (const struct GNUNET_HashCode *code,
662 * Determine how many low order bits match in two
663 * `struct GNUNET_HashCodes`. i.e. - 010011 and 011111 share
664 * the first two lowest order bits, and therefore the
665 * return value is two (NOT XOR distance, nor how many
666 * bits match absolutely!).
668 * @param first the first hashcode
669 * @param second the hashcode to compare first to
670 * @return the number of bits that match
673 GNUNET_CRYPTO_hash_matching_bits (const struct GNUNET_HashCode *first,
674 const struct GNUNET_HashCode *second);
679 * Compare function for HashCodes, producing a total ordering
682 * @param h1 some hash code
683 * @param h2 some hash code
684 * @return 1 if @a h1 > @a h2, -1 if @a h1 < @a h2 and 0 if @a h1 == @a h2.
687 GNUNET_CRYPTO_hash_cmp (const struct GNUNET_HashCode *h1,
688 const struct GNUNET_HashCode *h2);
693 * Find out which of the two GNUNET_CRYPTO_hash codes is closer to target
694 * in the XOR metric (Kademlia).
696 * @param h1 some hash code
697 * @param h2 some hash code
698 * @param target some hash code
699 * @return -1 if @a h1 is closer, 1 if @a h2 is closer and 0 if @a h1== @a h2.
702 GNUNET_CRYPTO_hash_xorcmp (const struct GNUNET_HashCode *h1,
703 const struct GNUNET_HashCode *h2,
704 const struct GNUNET_HashCode *target);
709 * @brief Derive an authentication key
710 * @param key authentication key
711 * @param rkey root key
713 * @param salt_len size of the salt
714 * @param argp pair of void * & size_t for context chunks, terminated by NULL
717 GNUNET_CRYPTO_hmac_derive_key_v (struct GNUNET_CRYPTO_AuthKey *key,
718 const struct GNUNET_CRYPTO_SymmetricSessionKey *rkey,
719 const void *salt, size_t salt_len,
725 * @brief Derive an authentication key
726 * @param key authentication key
727 * @param rkey root key
729 * @param salt_len size of the salt
730 * @param ... pair of void * & size_t for context chunks, terminated by NULL
733 GNUNET_CRYPTO_hmac_derive_key (struct GNUNET_CRYPTO_AuthKey *key,
734 const struct GNUNET_CRYPTO_SymmetricSessionKey *rkey,
735 const void *salt, size_t salt_len, ...);
741 * @param result buffer for the derived key, allocated by caller
742 * @param out_len desired length of the derived key
743 * @param xtr_algo hash algorithm for the extraction phase, GCRY_MD_...
744 * @param prf_algo hash algorithm for the expansion phase, GCRY_MD_...
746 * @param xts_len length of xts
747 * @param skm source key material
748 * @param skm_len length of skm
749 * @param ... pair of void * & size_t for context chunks, terminated by NULL
750 * @return GNUNET_YES on success
753 GNUNET_CRYPTO_hkdf (void *result, size_t out_len, int xtr_algo, int prf_algo,
754 const void *xts, size_t xts_len, const void *skm,
755 size_t skm_len, ...);
761 * @param result buffer for the derived key, allocated by caller
762 * @param out_len desired length of the derived key
763 * @param xtr_algo hash algorithm for the extraction phase, GCRY_MD_...
764 * @param prf_algo hash algorithm for the expansion phase, GCRY_MD_...
766 * @param xts_len length of xts
767 * @param skm source key material
768 * @param skm_len length of skm
769 * @param argp va_list of void * & size_t pairs for context chunks
770 * @return GNUNET_YES on success
773 GNUNET_CRYPTO_hkdf_v (void *result, size_t out_len, int xtr_algo, int prf_algo,
774 const void *xts, size_t xts_len, const void *skm,
775 size_t skm_len, va_list argp);
780 * @param result buffer for the derived key, allocated by caller
781 * @param out_len desired length of the derived key
783 * @param xts_len length of xts
784 * @param skm source key material
785 * @param skm_len length of skm
786 * @param argp va_list of void * & size_t pairs for context chunks
787 * @return GNUNET_YES on success
790 GNUNET_CRYPTO_kdf_v (void *result, size_t out_len, const void *xts,
791 size_t xts_len, const void *skm, size_t skm_len,
798 * @param result buffer for the derived key, allocated by caller
799 * @param out_len desired length of the derived key
801 * @param xts_len length of xts
802 * @param skm source key material
803 * @param skm_len length of skm
804 * @param ... void * & size_t pairs for context chunks
805 * @return #GNUNET_YES on success
808 GNUNET_CRYPTO_kdf (void *result, size_t out_len, const void *xts,
809 size_t xts_len, const void *skm, size_t skm_len, ...);
813 * Function called upon completion of 'GNUNET_CRYPTO_ecc_key_create_async'.
816 * @param pk NULL on error, otherwise the private key (which must be free'd by the callee)
817 * @param emsg NULL on success, otherwise an error message
819 typedef void (*GNUNET_CRYPTO_EccKeyCallback)(void *cls,
820 struct GNUNET_CRYPTO_EccPrivateKey *pk,
826 * Extract the public key for the given private key.
828 * @param priv the private key
829 * @param pub where to write the public key
832 GNUNET_CRYPTO_ecc_key_get_public_for_signature (const struct GNUNET_CRYPTO_EccPrivateKey *priv,
833 struct GNUNET_CRYPTO_EccPublicSignKey *pub);
839 * Extract the public key for the given private key.
841 * @param priv the private key
842 * @param pub where to write the public key
845 GNUNET_CRYPTO_ecc_key_get_public_for_encryption (const struct GNUNET_CRYPTO_EccPrivateKey *priv,
846 struct GNUNET_CRYPTO_EccPublicEncryptKey *pub);
850 * Convert a public key to a string.
852 * @param pub key to convert
853 * @return string representing @a pub
856 GNUNET_CRYPTO_ecc_public_sign_key_to_string (const struct GNUNET_CRYPTO_EccPublicSignKey *pub);
860 * Convert a string representing a public key to a public key.
862 * @param enc encoded public key
863 * @param enclen number of bytes in @a enc (without 0-terminator)
864 * @param pub where to store the public key
865 * @return #GNUNET_OK on success
868 GNUNET_CRYPTO_ecc_public_sign_key_from_string (const char *enc,
870 struct GNUNET_CRYPTO_EccPublicSignKey *pub);
875 * Convert a public key to a string.
877 * @param pub key to convert
878 * @return string representing @a pub
881 GNUNET_CRYPTO_ecc_public_encrypt_key_to_string (const struct GNUNET_CRYPTO_EccPublicEncryptKey *pub);
885 * Convert a string representing a public key to a public key.
887 * @param enc encoded public key
888 * @param enclen number of bytes in @a enc (without 0-terminator)
889 * @param pub where to store the public key
890 * @return #GNUNET_OK on success
893 GNUNET_CRYPTO_ecc_public_encrypt_key_from_string (const char *enc,
895 struct GNUNET_CRYPTO_EccPublicEncryptKey *pub);
900 * Create a new private key by reading it from a file. If the
901 * files does not exist, create a new key and write it to the
902 * file. Caller must free return value. Note that this function
903 * can not guarantee that another process might not be trying
904 * the same operation on the same file at the same time.
905 * If the contents of the file
906 * are invalid the old file is deleted and a fresh key is
909 * @param filename name of file to use to store the key
910 * @return new private key, NULL on error (for example,
911 * permission denied); free using #GNUNET_free
913 struct GNUNET_CRYPTO_EccPrivateKey *
914 GNUNET_CRYPTO_ecc_key_create_from_file (const char *filename);
919 * Create a new private key by reading our peer's key from
920 * the file specified in the configuration.
922 * @param cfg the configuration to use
923 * @return new private key, NULL on error (for example,
924 * permission denied); free using #GNUNET_free
926 struct GNUNET_CRYPTO_EccPrivateKey *
927 GNUNET_CRYPTO_ecc_key_create_from_configuration (const struct GNUNET_CONFIGURATION_Handle *cfg);
932 * Create a new private key. Caller must free return value.
934 * @return fresh private key; free using #GNUNET_free
936 struct GNUNET_CRYPTO_EccPrivateKey *
937 GNUNET_CRYPTO_ecc_key_create (void);
942 * Clear memory that was used to store a private key.
944 * @param pk location of the key
947 GNUNET_CRYPTO_ecc_key_clear (struct GNUNET_CRYPTO_EccPrivateKey *pk);
952 * Get the shared private key we use for anonymous users.
954 * @return "anonymous" private key; do not free
956 const struct GNUNET_CRYPTO_EccPrivateKey *
957 GNUNET_CRYPTO_ecc_key_get_anonymous (void);
962 * Setup a hostkey file for a peer given the name of the
963 * configuration file (!). This function is used so that
964 * at a later point code can be certain that reading a
965 * hostkey is fast (for example in time-dependent testcases).
967 * @param cfg_name name of the configuration file to use
970 GNUNET_CRYPTO_ecc_setup_hostkey (const char *cfg_name);
975 * Retrieve the identity of the host's peer.
977 * @param cfg configuration to use
978 * @param dst pointer to where to write the peer identity
979 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the identity
980 * could not be retrieved
983 GNUNET_CRYPTO_get_peer_identity (const struct GNUNET_CONFIGURATION_Handle *cfg,
984 struct GNUNET_PeerIdentity *dst);
989 * Derive key material from a public and a private ECC key.
991 * @param priv private key to use for the ECDH (x)
992 * @param pub public key to use for the ECDY (yG)
993 * @param key_material where to write the key material (xyG)
994 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
997 GNUNET_CRYPTO_ecc_ecdh (const struct GNUNET_CRYPTO_EccPrivateKey *priv,
998 const struct GNUNET_CRYPTO_EccPublicEncryptKey *pub,
999 struct GNUNET_HashCode *key_material);
1004 * Sign a given block.
1006 * @param priv private key to use for the signing
1007 * @param purpose what to sign (size, purpose)
1008 * @param sig where to write the signature
1009 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
1012 GNUNET_CRYPTO_ecc_sign (const struct GNUNET_CRYPTO_EccPrivateKey *priv,
1013 const struct GNUNET_CRYPTO_EccSignaturePurpose *purpose,
1014 struct GNUNET_CRYPTO_EccSignature *sig);
1021 * @param purpose what is the purpose that the signature should have?
1022 * @param validate block to validate (size, purpose, data)
1023 * @param sig signature that is being validated
1024 * @param pub public key of the signer
1025 * @returns #GNUNET_OK if ok, #GNUNET_SYSERR if invalid
1028 GNUNET_CRYPTO_ecc_verify (uint32_t purpose,
1029 const struct GNUNET_CRYPTO_EccSignaturePurpose *validate,
1030 const struct GNUNET_CRYPTO_EccSignature *sig,
1031 const struct GNUNET_CRYPTO_EccPublicSignKey *pub);
1036 * Derive a private key from a given private key and a label.
1037 * Essentially calculates a private key 'h = H(l,P) * d mod n'
1038 * where n is the size of the ECC group and P is the public
1039 * key associated with the private key 'd'.
1041 * @param priv original private key
1042 * @param label label to use for key deriviation
1043 * @param context additional context to use for HKDF of 'h';
1044 * typically the name of the subsystem/application
1045 * @return derived private key
1047 struct GNUNET_CRYPTO_EccPrivateKey *
1048 GNUNET_CRYPTO_ecc_key_derive (const struct GNUNET_CRYPTO_EccPrivateKey *priv,
1050 const char *context);
1055 * Derive a public key from a given public key and a label.
1056 * Essentially calculates a public key 'V = H(l,P) * P'.
1058 * @param pub original public key
1059 * @param label label to use for key deriviation
1060 * @param context additional context to use for HKDF of 'h'.
1061 * typically the name of the subsystem/application
1062 * @param result where to write the derived public key
1065 GNUNET_CRYPTO_ecc_public_key_derive (const struct GNUNET_CRYPTO_EccPublicSignKey *pub,
1067 const char *context,
1068 struct GNUNET_CRYPTO_EccPublicSignKey *result);
1071 #if 0 /* keep Emacsens' auto-indent happy */
1079 /* ifndef GNUNET_CRYPTO_LIB_H */
1081 /* end of gnunet_crypto_lib.h */