towards PEERSTORE file plugin
[oweals/gnunet.git] / src / include / gnunet_crypto_lib.h
1 /*
2      This file is part of GNUnet.
3      (C) 2001-2013 Christian Grothoff (and other contributing authors)
4
5      GNUnet is free software; you can redistribute it and/or modify
6      it under the terms of the GNU General Public License as published
7      by the Free Software Foundation; either version 3, or (at your
8      option) any later version.
9
10      GNUnet is distributed in the hope that it will be useful, but
11      WITHOUT ANY WARRANTY; without even the implied warranty of
12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13      General Public License for more details.
14
15      You should have received a copy of the GNU General Public License
16      along with GNUnet; see the file COPYING.  If not, write to the
17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20
21 /**
22  * @file include/gnunet_crypto_lib.h
23  * @brief cryptographic primitives for GNUnet
24  *
25  * @author Christian Grothoff
26  * @author Krista Bennett
27  * @author Gerd Knorr <kraxel@bytesex.org>
28  * @author Ioana Patrascu
29  * @author Tzvetan Horozov
30  *
31  * @defgroup crypto Cryptographic operations
32  * @defgroup hash Hashing and operations on hashes
33  */
34
35 #ifndef GNUNET_CRYPTO_LIB_H
36 #define GNUNET_CRYPTO_LIB_H
37
38 #ifdef __cplusplus
39 extern "C"
40 {
41 #if 0                           /* keep Emacsens' auto-indent happy */
42 }
43 #endif
44 #endif
45
46 /**
47  * @brief A 512-bit hashcode
48  */
49 struct GNUNET_HashCode;
50
51 /**
52  * The identity of the host (wraps the signing key of the peer).
53  */
54 struct GNUNET_PeerIdentity;
55
56 #include "gnunet_common.h"
57 #include "gnunet_scheduler_lib.h"
58 #include <gcrypt.h>
59
60
61 /**
62  * @brief A 512-bit hashcode
63  */
64 struct GNUNET_HashCode
65 {
66   uint32_t bits[512 / 8 / sizeof (uint32_t)];   /* = 16 */
67 };
68
69
70 /**
71  * Maximum length of an ECC signature.
72  * Note: round up to multiple of 8 minus 2 for alignment.
73  */
74 #define GNUNET_CRYPTO_ECC_SIGNATURE_DATA_ENCODING_LENGTH 126
75
76
77 /**
78  * Desired quality level for random numbers.
79  * @ingroup crypto
80  */
81 enum GNUNET_CRYPTO_Quality
82 {
83   /**
84    * No good quality of the operation is needed (i.e.,
85    * random numbers can be pseudo-random).
86    * @ingroup crypto
87    */
88   GNUNET_CRYPTO_QUALITY_WEAK,
89
90   /**
91    * High-quality operations are desired.
92    * @ingroup crypto
93    */
94   GNUNET_CRYPTO_QUALITY_STRONG,
95
96   /**
97    * Randomness for IVs etc. is required.
98    * @ingroup crypto
99    */
100   GNUNET_CRYPTO_QUALITY_NONCE
101 };
102
103
104 /**
105  * @brief length of the sessionkey in bytes (256 BIT sessionkey)
106  */
107 #define GNUNET_CRYPTO_AES_KEY_LENGTH (256/8)
108
109 /**
110  * Length of a hash value
111  */
112 #define GNUNET_CRYPTO_HASH_LENGTH (512/8)
113
114 /**
115  * How many characters (without 0-terminator) are our ASCII-encoded
116  * public keys (ECDSA/EDDSA/ECDHE).
117  */
118 #define GNUNET_CRYPTO_PKEY_ASCII_LENGTH 52
119
120 /**
121  * @brief 0-terminated ASCII encoding of a struct GNUNET_HashCode.
122  */
123 struct GNUNET_CRYPTO_HashAsciiEncoded
124 {
125   unsigned char encoding[104];
126 };
127
128
129 GNUNET_NETWORK_STRUCT_BEGIN
130
131
132 /**
133  * @brief header of what an ECC signature signs
134  *        this must be followed by "size - 8" bytes of
135  *        the actual signed data
136  */
137 struct GNUNET_CRYPTO_EccSignaturePurpose
138 {
139   /**
140    * How many bytes does this signature sign?
141    * (including this purpose header); in network
142    * byte order (!).
143    */
144   uint32_t size GNUNET_PACKED;
145
146   /**
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!
151    */
152   uint32_t purpose GNUNET_PACKED;
153
154 };
155
156
157 /**
158  * @brief an ECC signature using EdDSA.
159  * See https://gnunet.org/ed25519
160  */
161 struct GNUNET_CRYPTO_EddsaSignature
162 {
163
164   /**
165    * R value.
166    */
167   unsigned char r[256 / 8];
168
169   /**
170    * S value.
171    */
172   unsigned char s[256 / 8];
173
174 };
175
176
177
178 /**
179  * @brief an ECC signature using ECDSA
180  */
181 struct GNUNET_CRYPTO_EcdsaSignature
182 {
183
184   /**
185    * R value.
186    */
187   unsigned char r[256 / 8];
188
189   /**
190    * S value.
191    */
192   unsigned char s[256 / 8];
193
194 };
195
196
197 /**
198  * Public ECC key (always for Curve25519) encoded in a format suitable
199  * for network transmission and EdDSA signatures.
200  */
201 struct GNUNET_CRYPTO_EddsaPublicKey
202 {
203   /**
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.
206    */
207   unsigned char q_y[256 / 8];
208
209 };
210
211
212 /**
213  * Public ECC key (always for Curve25519) encoded in a format suitable
214  * for network transmission and ECDSA signatures.
215  */
216 struct GNUNET_CRYPTO_EcdsaPublicKey
217 {
218   /**
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.
221    */
222   unsigned char q_y[256 / 8];
223
224 };
225
226
227 /**
228  * The identity of the host (wraps the signing key of the peer).
229  */
230 struct GNUNET_PeerIdentity
231 {
232   struct GNUNET_CRYPTO_EddsaPublicKey public_key;
233 };
234
235
236 /**
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
240  */
241 struct GNUNET_CRYPTO_EcdhePublicKey
242 {
243   /**
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.
246    */
247   unsigned char q_y[256 / 8];
248 };
249
250
251 /**
252  * Private ECC key encoded for transmission.  To be used only for ECDH
253  * key exchange (ECDHE to be precise).
254  */
255 struct GNUNET_CRYPTO_EcdhePrivateKey
256 {
257   /**
258    * d is a value mod n, where n has at most 256 bits.
259    */
260   unsigned char d[256 / 8];
261
262 };
263
264 /**
265  * Private ECC key encoded for transmission.  To be used only for ECDSA
266  * signatures.
267  */
268 struct GNUNET_CRYPTO_EcdsaPrivateKey
269 {
270   /**
271    * d is a value mod n, where n has at most 256 bits.
272    */
273   unsigned char d[256 / 8];
274
275 };
276
277 /**
278  * Private ECC key encoded for transmission.  To be used only for EdDSA
279  * signatures.
280  */
281 struct GNUNET_CRYPTO_EddsaPrivateKey
282 {
283   /**
284    * d is a value mod n, where n has at most 256 bits.
285    */
286   unsigned char d[256 / 8];
287
288 };
289
290
291 /**
292  * @brief type for session keys
293  */
294 struct GNUNET_CRYPTO_SymmetricSessionKey
295 {
296   /**
297    * Actual key for AES.
298    */
299   unsigned char aes_key[GNUNET_CRYPTO_AES_KEY_LENGTH];
300
301   /**
302    * Actual key for TwoFish.
303    */
304   unsigned char twofish_key[GNUNET_CRYPTO_AES_KEY_LENGTH];
305
306 };
307
308 GNUNET_NETWORK_STRUCT_END
309
310 /**
311  * @brief IV for sym cipher
312  *
313  * NOTE: must be smaller (!) in size than the
314  * `struct GNUNET_HashCode`.
315  */
316 struct GNUNET_CRYPTO_SymmetricInitializationVector
317 {
318   unsigned char aes_iv[GNUNET_CRYPTO_AES_KEY_LENGTH / 2];
319
320   unsigned char twofish_iv[GNUNET_CRYPTO_AES_KEY_LENGTH / 2];
321 };
322
323
324 /**
325  * @brief type for (message) authentication keys
326  */
327 struct GNUNET_CRYPTO_AuthKey
328 {
329   unsigned char key[GNUNET_CRYPTO_HASH_LENGTH];
330 };
331
332
333 /**
334  * Size of paillier plain texts and public keys.
335  * Private keys and ciphertexts are twice this size.
336  */
337 #define GNUNET_CRYPTO_PAILLIER_BITS 2048
338
339
340 /**
341  * Paillier public key.
342  */
343 struct GNUNET_CRYPTO_PaillierPublicKey
344 {
345   /**
346    * N value.
347    */
348   unsigned char n[GNUNET_CRYPTO_PAILLIER_BITS / 8];
349 };
350
351
352 /**
353  * Paillier public key.
354  */
355 struct GNUNET_CRYPTO_PaillierPrivateKey
356 {
357   /**
358    * Lambda-component of the private key.
359    */
360   unsigned char lambda[GNUNET_CRYPTO_PAILLIER_BITS / 8];
361   /**
362    * Mu-component of the private key.
363    */
364   unsigned char mu[GNUNET_CRYPTO_PAILLIER_BITS / 8];
365 };
366
367
368 /**
369  * Paillier ciphertext.
370  */
371 struct GNUNET_CRYPTO_PaillierCiphertext
372 {
373   /**
374    * guaranteed minimum number of homomorphic operations with this ciphertext
375    */
376   int32_t remaining_ops GNUNET_PACKED;
377   
378   /**
379    * The bits of the ciphertext.
380    */
381   unsigned char bits[GNUNET_CRYPTO_PAILLIER_BITS * 2 / 8];
382 };
383
384
385 /* **************** Functions and Macros ************* */
386
387 /**
388  * @ingroup crypto
389  * Seed a weak random generator. Only #GNUNET_CRYPTO_QUALITY_WEAK-mode generator
390  * can be seeded.
391  *
392  * @param seed the seed to use
393  */
394 void
395 GNUNET_CRYPTO_seed_weak_random (int32_t seed);
396
397
398 /**
399  * Perform an incremental step in a CRC16 (for TCP/IP) calculation.
400  *
401  * @param sum current sum, initially 0
402  * @param buf buffer to calculate CRC over (must be 16-bit aligned)
403  * @param len number of bytes in @a buf, must be multiple of 2
404  * @return updated crc sum (must be subjected to #GNUNET_CRYPTO_crc16_finish to get actual crc16)
405  */
406 uint32_t
407 GNUNET_CRYPTO_crc16_step (uint32_t sum, const void *buf, size_t len);
408
409
410 /**
411  * Convert results from GNUNET_CRYPTO_crc16_step to final crc16.
412  *
413  * @param sum cummulative sum
414  * @return crc16 value
415  */
416 uint16_t
417 GNUNET_CRYPTO_crc16_finish (uint32_t sum);
418
419
420 /**
421  * @ingroup hash
422  * Calculate the checksum of a buffer in one step.
423  *
424  * @param buf buffer to calculate CRC over (must be 16-bit aligned)
425  * @param len number of bytes in @a buf, must be multiple of 2
426  * @return crc16 value
427  */
428 uint16_t
429 GNUNET_CRYPTO_crc16_n (const void *buf, size_t len);
430
431
432 /**
433  * @ingroup hash
434  * Compute the CRC32 checksum for the first len
435  * bytes of the buffer.
436  *
437  * @param buf the data over which we're taking the CRC
438  * @param len the length of the buffer @a buf in bytes
439  * @return the resulting CRC32 checksum
440  */
441 int32_t
442 GNUNET_CRYPTO_crc32_n (const void *buf, size_t len);
443
444
445 /**
446  * @ingroup crypto
447  * Fill block with a random values.
448  *
449  * @param mode desired quality of the random number
450  * @param buffer the buffer to fill
451  * @param length buffer length
452  */
453 void
454 GNUNET_CRYPTO_random_block (enum GNUNET_CRYPTO_Quality mode, void *buffer, size_t length);
455
456 /**
457  * @ingroup crypto
458  * Produce a random value.
459  *
460  * @param mode desired quality of the random number
461  * @param i the upper limit (exclusive) for the random number
462  * @return a random value in the interval [0,@a i) (exclusive).
463  */
464 uint32_t
465 GNUNET_CRYPTO_random_u32 (enum GNUNET_CRYPTO_Quality mode, uint32_t i);
466
467
468 /**
469  * @ingroup crypto
470  * Random on unsigned 64-bit values.
471  *
472  * @param mode desired quality of the random number
473  * @param max value returned will be in range [0,@a max) (exclusive)
474  * @return random 64-bit number
475  */
476 uint64_t
477 GNUNET_CRYPTO_random_u64 (enum GNUNET_CRYPTO_Quality mode, uint64_t max);
478
479
480 /**
481  * @ingroup crypto
482  * Get an array with a random permutation of the
483  * numbers 0...n-1.
484  * @param mode #GNUNET_CRYPTO_QUALITY_STRONG if the strong (but expensive) PRNG should be used,
485  *             #GNUNET_CRYPTO_QUALITY_WEAK or #GNUNET_CRYPTO_QUALITY_NONCE otherwise
486  * @param n the size of the array
487  * @return the permutation array (allocated from heap)
488  */
489 unsigned int *
490 GNUNET_CRYPTO_random_permute (enum GNUNET_CRYPTO_Quality mode, unsigned int n);
491
492
493 /**
494  * @ingroup crypto
495  * Create a new random session key.
496  *
497  * @param key key to initialize
498  */
499 void
500 GNUNET_CRYPTO_symmetric_create_session_key (struct GNUNET_CRYPTO_SymmetricSessionKey *key);
501
502
503 /**
504  * @ingroup crypto
505  * Encrypt a block using a symmetric sessionkey.
506  *
507  * @param block the block to encrypt
508  * @param size the size of the @a block
509  * @param sessionkey the key used to encrypt
510  * @param iv the initialization vector to use, use INITVALUE
511  *        for streams.
512  * @return the size of the encrypted block, -1 for errors
513  */
514 ssize_t
515 GNUNET_CRYPTO_symmetric_encrypt (const void *block, size_t size,
516                                  const struct GNUNET_CRYPTO_SymmetricSessionKey *sessionkey,
517                                  const struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
518                                  void *result);
519
520
521 /**
522  * @ingroup crypto
523  * Decrypt a given block using a symmetric sessionkey.
524  *
525  * @param block the data to decrypt, encoded as returned by encrypt
526  * @param size how big is the block?
527  * @param sessionkey the key used to decrypt
528  * @param iv the initialization vector to use
529  * @param result address to store the result at
530  * @return -1 on failure, size of decrypted block on success
531  */
532 ssize_t
533 GNUNET_CRYPTO_symmetric_decrypt (const void *block, size_t size,
534                                  const struct GNUNET_CRYPTO_SymmetricSessionKey *sessionkey,
535                                  const struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
536                                  void *result);
537
538
539 /**
540  * @ingroup crypto
541  * @brief Derive an IV
542  * @param iv initialization vector
543  * @param skey session key
544  * @param salt salt for the derivation
545  * @param salt_len size of the @a salt
546  * @param ... pairs of void * & size_t for context chunks, terminated by NULL
547  */
548 void
549 GNUNET_CRYPTO_symmetric_derive_iv (struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
550                                    const struct GNUNET_CRYPTO_SymmetricSessionKey *skey,
551                                    const void *salt,
552                                    size_t salt_len, ...);
553
554
555 /**
556  * @brief Derive an IV
557  * @param iv initialization vector
558  * @param skey session key
559  * @param salt salt for the derivation
560  * @param salt_len size of the @a salt
561  * @param argp pairs of void * & size_t for context chunks, terminated by NULL
562  */
563 void
564 GNUNET_CRYPTO_symmetric_derive_iv_v (struct GNUNET_CRYPTO_SymmetricInitializationVector *iv,
565                                      const struct GNUNET_CRYPTO_SymmetricSessionKey *skey,
566                                      const void *salt,
567                                      size_t salt_len,
568                                      va_list argp);
569
570
571 /**
572  * @ingroup hash
573  * Convert hash to ASCII encoding.
574  * @param block the hash code
575  * @param result where to store the encoding (struct GNUNET_CRYPTO_HashAsciiEncoded can be
576  *  safely cast to char*, a '\\0' termination is set).
577  */
578 void
579 GNUNET_CRYPTO_hash_to_enc (const struct GNUNET_HashCode * block,
580                            struct GNUNET_CRYPTO_HashAsciiEncoded *result);
581
582
583 /**
584  * @ingroup hash
585  * Convert ASCII encoding back to a 'struct GNUNET_HashCode'
586  *
587  * @param enc the encoding
588  * @param enclen number of characters in @a enc (without 0-terminator, which can be missing)
589  * @param result where to store the hash code
590  * @return #GNUNET_OK on success, #GNUNET_SYSERR if result has the wrong encoding
591  */
592 int
593 GNUNET_CRYPTO_hash_from_string2 (const char *enc, size_t enclen,
594                                  struct GNUNET_HashCode *result);
595
596
597 /**
598  * @ingroup hash
599  * Convert ASCII encoding back to `struct GNUNET_HashCode`
600  *
601  * @param enc the encoding
602  * @param result where to store the hash code
603  * @return #GNUNET_OK on success, #GNUNET_SYSERR if result has the wrong encoding
604  */
605 #define GNUNET_CRYPTO_hash_from_string(enc, result) \
606   GNUNET_CRYPTO_hash_from_string2 (enc, strlen(enc), result)
607
608
609 /**
610  * @ingroup hash
611  *
612  * Compute the distance between 2 hashcodes.  The
613  * computation must be fast, not involve @a a[0] or @a a[4] (they're used
614  * elsewhere), and be somewhat consistent. And of course, the result
615  * should be a positive number.
616  *
617  * @param a some hash code
618  * @param b some hash code
619  * @return number between 0 and UINT32_MAX
620  */
621 uint32_t
622 GNUNET_CRYPTO_hash_distance_u32 (const struct GNUNET_HashCode *a,
623                                  const struct GNUNET_HashCode *b);
624
625
626 /**
627  * @ingroup hash
628  * Compute hash of a given block.
629  *
630  * @param block the data to hash
631  * @param size size of the @a block
632  * @param ret pointer to where to write the hashcode
633  */
634 void
635 GNUNET_CRYPTO_hash (const void *block, size_t size, struct GNUNET_HashCode * ret);
636
637
638 /**
639  * @ingroup hash
640  * Calculate HMAC of a message (RFC 2104)
641  *
642  * @param key secret key
643  * @param plaintext input plaintext
644  * @param plaintext_len length of @a plaintext
645  * @param hmac where to store the hmac
646  */
647 void
648 GNUNET_CRYPTO_hmac (const struct GNUNET_CRYPTO_AuthKey *key,
649                     const void *plaintext, size_t plaintext_len,
650                     struct GNUNET_HashCode * hmac);
651
652
653 /**
654  * Function called once the hash computation over the
655  * specified file has completed.
656  *
657  * @param cls closure
658  * @param res resulting hash, NULL on error
659  */
660 typedef void (*GNUNET_CRYPTO_HashCompletedCallback) (void *cls,
661                                                      const struct GNUNET_HashCode *res);
662
663
664 /**
665  * Handle to file hashing operation.
666  */
667 struct GNUNET_CRYPTO_FileHashContext;
668
669
670 /**
671  * @ingroup hash
672  * Compute the hash of an entire file.
673  *
674  * @param priority scheduling priority to use
675  * @param filename name of file to hash
676  * @param blocksize number of bytes to process in one task
677  * @param callback function to call upon completion
678  * @param callback_cls closure for @a callback
679  * @return NULL on (immediate) errror
680  */
681 struct GNUNET_CRYPTO_FileHashContext *
682 GNUNET_CRYPTO_hash_file (enum GNUNET_SCHEDULER_Priority priority,
683                          const char *filename, size_t blocksize,
684                          GNUNET_CRYPTO_HashCompletedCallback callback,
685                          void *callback_cls);
686
687
688 /**
689  * Cancel a file hashing operation.
690  *
691  * @param fhc operation to cancel (callback must not yet have been invoked)
692  */
693 void
694 GNUNET_CRYPTO_hash_file_cancel (struct GNUNET_CRYPTO_FileHashContext *fhc);
695
696
697 /**
698  * @ingroup hash
699  * Create a random hash code.
700  *
701  * @param mode desired quality level
702  * @param result hash code that is randomized
703  */
704 void
705 GNUNET_CRYPTO_hash_create_random (enum GNUNET_CRYPTO_Quality mode,
706                                   struct GNUNET_HashCode *result);
707
708
709 /**
710  * @ingroup hash
711  * compute @a result = @a b - @a a
712  *
713  * @param a some hash code
714  * @param b some hash code
715  * @param result set to @a b - @a a
716  */
717 void
718 GNUNET_CRYPTO_hash_difference (const struct GNUNET_HashCode *a,
719                                const struct GNUNET_HashCode *b,
720                                struct GNUNET_HashCode *result);
721
722
723 /**
724  * @ingroup hash
725  * compute @a result = @a a + @a delta
726  *
727  * @param a some hash code
728  * @param delta some hash code
729  * @param result set to @a a + @a delta
730  */
731 void
732 GNUNET_CRYPTO_hash_sum (const struct GNUNET_HashCode *a,
733                         const struct GNUNET_HashCode *delta,
734                         struct GNUNET_HashCode *result);
735
736
737 /**
738  * @ingroup hash
739  * compute result = a ^ b
740  *
741  * @param a some hash code
742  * @param b some hash code
743  * @param result set to @a a ^ @a b
744  */
745 void
746 GNUNET_CRYPTO_hash_xor (const struct GNUNET_HashCode * a, const struct GNUNET_HashCode * b,
747                         struct GNUNET_HashCode * result);
748
749
750 /**
751  * @ingroup hash
752  * Convert a hashcode into a key.
753  *
754  * @param hc hash code that serves to generate the key
755  * @param skey set to a valid session key
756  * @param iv set to a valid initialization vector
757  */
758 void
759 GNUNET_CRYPTO_hash_to_aes_key (const struct GNUNET_HashCode * hc,
760                                struct GNUNET_CRYPTO_SymmetricSessionKey *skey,
761                                struct GNUNET_CRYPTO_SymmetricInitializationVector *iv);
762
763
764 /**
765  * @ingroup hash
766  * Obtain a bit from a hashcode.
767  *
768  * @param code the `struct GNUNET_HashCode` to index bit-wise
769  * @param bit index into the hashcode, [0...159]
770  * @return Bit \a bit from hashcode \a code, -1 for invalid index
771  */
772 int
773 GNUNET_CRYPTO_hash_get_bit (const struct GNUNET_HashCode *code,
774                             unsigned int bit);
775
776
777 /**
778  * @ingroup hash
779  * Determine how many low order bits match in two
780  * `struct GNUNET_HashCodes`.  i.e. - 010011 and 011111 share
781  * the first two lowest order bits, and therefore the
782  * return value is two (NOT XOR distance, nor how many
783  * bits match absolutely!).
784  *
785  * @param first the first hashcode
786  * @param second the hashcode to compare first to
787  * @return the number of bits that match
788  */
789 unsigned int
790 GNUNET_CRYPTO_hash_matching_bits (const struct GNUNET_HashCode *first,
791                                   const struct GNUNET_HashCode *second);
792
793
794 /**
795  * @ingroup hash
796  * Compare function for HashCodes, producing a total ordering
797  * of all hashcodes.
798  *
799  * @param h1 some hash code
800  * @param h2 some hash code
801  * @return 1 if @a h1 > @a h2, -1 if @a h1 < @a h2 and 0 if @a h1 == @a h2.
802  */
803 int
804 GNUNET_CRYPTO_hash_cmp (const struct GNUNET_HashCode *h1,
805                         const struct GNUNET_HashCode *h2);
806
807
808 /**
809  * @ingroup hash
810  * Find out which of the two GNUNET_CRYPTO_hash codes is closer to target
811  * in the XOR metric (Kademlia).
812  *
813  * @param h1 some hash code
814  * @param h2 some hash code
815  * @param target some hash code
816  * @return -1 if @a h1 is closer, 1 if @a h2 is closer and 0 if @a h1== @a h2.
817  */
818 int
819 GNUNET_CRYPTO_hash_xorcmp (const struct GNUNET_HashCode *h1,
820                            const struct GNUNET_HashCode *h2,
821                            const struct GNUNET_HashCode *target);
822
823
824 /**
825  * @ingroup hash
826  * @brief Derive an authentication key
827  * @param key authentication key
828  * @param rkey root key
829  * @param salt salt
830  * @param salt_len size of the salt
831  * @param argp pair of void * & size_t for context chunks, terminated by NULL
832  */
833 void
834 GNUNET_CRYPTO_hmac_derive_key_v (struct GNUNET_CRYPTO_AuthKey *key,
835                                  const struct GNUNET_CRYPTO_SymmetricSessionKey *rkey,
836                                  const void *salt, size_t salt_len,
837                                  va_list argp);
838
839
840 /**
841  * @ingroup hash
842  * @brief Derive an authentication key
843  * @param key authentication key
844  * @param rkey root key
845  * @param salt salt
846  * @param salt_len size of the salt
847  * @param ... pair of void * & size_t for context chunks, terminated by NULL
848  */
849 void
850 GNUNET_CRYPTO_hmac_derive_key (struct GNUNET_CRYPTO_AuthKey *key,
851                                const struct GNUNET_CRYPTO_SymmetricSessionKey *rkey,
852                                const void *salt, size_t salt_len, ...);
853
854
855 /**
856  * @ingroup hash
857  * @brief Derive key
858  * @param result buffer for the derived key, allocated by caller
859  * @param out_len desired length of the derived key
860  * @param xtr_algo hash algorithm for the extraction phase, GCRY_MD_...
861  * @param prf_algo hash algorithm for the expansion phase, GCRY_MD_...
862  * @param xts salt
863  * @param xts_len length of @a xts
864  * @param skm source key material
865  * @param skm_len length of @a skm
866  * @param ... pair of void * & size_t for context chunks, terminated by NULL
867  * @return #GNUNET_YES on success
868  */
869 int
870 GNUNET_CRYPTO_hkdf (void *result, size_t out_len, int xtr_algo, int prf_algo,
871                     const void *xts, size_t xts_len, const void *skm,
872                     size_t skm_len, ...);
873
874
875 /**
876  * @ingroup hash
877  * @brief Derive key
878  * @param result buffer for the derived key, allocated by caller
879  * @param out_len desired length of the derived key
880  * @param xtr_algo hash algorithm for the extraction phase, GCRY_MD_...
881  * @param prf_algo hash algorithm for the expansion phase, GCRY_MD_...
882  * @param xts salt
883  * @param xts_len length of @a xts
884  * @param skm source key material
885  * @param skm_len length of @a skm
886  * @param argp va_list of void * & size_t pairs for context chunks
887  * @return #GNUNET_YES on success
888  */
889 int
890 GNUNET_CRYPTO_hkdf_v (void *result, size_t out_len, int xtr_algo, int prf_algo,
891                       const void *xts, size_t xts_len, const void *skm,
892                       size_t skm_len, va_list argp);
893
894
895 /**
896  * @brief Derive key
897  * @param result buffer for the derived key, allocated by caller
898  * @param out_len desired length of the derived key
899  * @param xts salt
900  * @param xts_len length of @a xts
901  * @param skm source key material
902  * @param skm_len length of @a skm
903  * @param argp va_list of void * & size_t pairs for context chunks
904  * @return #GNUNET_YES on success
905  */
906 int
907 GNUNET_CRYPTO_kdf_v (void *result, size_t out_len, const void *xts,
908                      size_t xts_len, const void *skm, size_t skm_len,
909                      va_list argp);
910
911
912 /**
913  * @ingroup hash
914  * @brief Derive key
915  * @param result buffer for the derived key, allocated by caller
916  * @param out_len desired length of the derived key
917  * @param xts salt
918  * @param xts_len length of @a xts
919  * @param skm source key material
920  * @param skm_len length of @a skm
921  * @param ... void * & size_t pairs for context chunks
922  * @return #GNUNET_YES on success
923  */
924 int
925 GNUNET_CRYPTO_kdf (void *result, size_t out_len, const void *xts,
926                    size_t xts_len, const void *skm, size_t skm_len, ...);
927
928
929 /**
930  * @ingroup crypto
931  * Extract the public key for the given private key.
932  *
933  * @param priv the private key
934  * @param pub where to write the public key
935  */
936 void
937 GNUNET_CRYPTO_ecdsa_key_get_public (const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv,
938                                     struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
939
940 /**
941  * @ingroup crypto
942  * Extract the public key for the given private key.
943  *
944  * @param priv the private key
945  * @param pub where to write the public key
946  */
947 void
948 GNUNET_CRYPTO_eddsa_key_get_public (const struct GNUNET_CRYPTO_EddsaPrivateKey *priv,
949                                     struct GNUNET_CRYPTO_EddsaPublicKey *pub);
950
951
952 /**
953  * @ingroup crypto
954  * Extract the public key for the given private key.
955  *
956  * @param priv the private key
957  * @param pub where to write the public key
958  */
959 void
960 GNUNET_CRYPTO_ecdhe_key_get_public (const struct GNUNET_CRYPTO_EcdhePrivateKey *priv,
961                                     struct GNUNET_CRYPTO_EcdhePublicKey *pub);
962
963
964 /**
965  * Convert a public key to a string.
966  *
967  * @param pub key to convert
968  * @return string representing @a pub
969  */
970 char *
971 GNUNET_CRYPTO_ecdsa_public_key_to_string (const struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
972
973
974 /**
975  * Convert a public key to a string.
976  *
977  * @param pub key to convert
978  * @return string representing @a pub
979  */
980 char *
981 GNUNET_CRYPTO_eddsa_public_key_to_string (const struct GNUNET_CRYPTO_EddsaPublicKey *pub);
982
983
984 /**
985  * Convert a string representing a public key to a public key.
986  *
987  * @param enc encoded public key
988  * @param enclen number of bytes in @a enc (without 0-terminator)
989  * @param pub where to store the public key
990  * @return #GNUNET_OK on success
991  */
992 int
993 GNUNET_CRYPTO_ecdsa_public_key_from_string (const char *enc,
994                                             size_t enclen,
995                                             struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
996
997
998 /**
999  * Convert a string representing a public key to a public key.
1000  *
1001  * @param enc encoded public key
1002  * @param enclen number of bytes in @a enc (without 0-terminator)
1003  * @param pub where to store the public key
1004  * @return #GNUNET_OK on success
1005  */
1006 int
1007 GNUNET_CRYPTO_eddsa_public_key_from_string (const char *enc,
1008                                             size_t enclen,
1009                                             struct GNUNET_CRYPTO_EddsaPublicKey *pub);
1010
1011
1012 /**
1013  * @ingroup crypto
1014  * Create a new private key by reading it from a file.  If the
1015  * files does not exist, create a new key and write it to the
1016  * file.  Caller must free return value.  Note that this function
1017  * can not guarantee that another process might not be trying
1018  * the same operation on the same file at the same time.
1019  * If the contents of the file
1020  * are invalid the old file is deleted and a fresh key is
1021  * created.
1022  *
1023  * @param filename name of file to use to store the key
1024  * @return new private key, NULL on error (for example,
1025  *   permission denied); free using #GNUNET_free
1026  */
1027 struct GNUNET_CRYPTO_EcdsaPrivateKey *
1028 GNUNET_CRYPTO_ecdsa_key_create_from_file (const char *filename);
1029
1030
1031 /**
1032  * @ingroup crypto
1033  * Create a new private key by reading it from a file.  If the
1034  * files does not exist, create a new key and write it to the
1035  * file.  Caller must free return value.  Note that this function
1036  * can not guarantee that another process might not be trying
1037  * the same operation on the same file at the same time.
1038  * If the contents of the file
1039  * are invalid the old file is deleted and a fresh key is
1040  * created.
1041  *
1042  * @param filename name of file to use to store the key
1043  * @return new private key, NULL on error (for example,
1044  *   permission denied); free using #GNUNET_free
1045  */
1046 struct GNUNET_CRYPTO_EddsaPrivateKey *
1047 GNUNET_CRYPTO_eddsa_key_create_from_file (const char *filename);
1048
1049 struct GNUNET_CONFIGURATION_Handle;
1050
1051
1052 /**
1053  * @ingroup crypto
1054  * Create a new private key by reading our peer's key from
1055  * the file specified in the configuration.
1056  *
1057  * @param cfg the configuration to use
1058  * @return new private key, NULL on error (for example,
1059  *   permission denied); free using #GNUNET_free
1060  */
1061 struct GNUNET_CRYPTO_EddsaPrivateKey *
1062 GNUNET_CRYPTO_eddsa_key_create_from_configuration (const struct GNUNET_CONFIGURATION_Handle *cfg);
1063
1064
1065 /**
1066  * @ingroup crypto
1067  * Create a new private key. Caller must free return value.
1068  *
1069  * @return fresh private key; free using #GNUNET_free
1070  */
1071 struct GNUNET_CRYPTO_EcdsaPrivateKey *
1072 GNUNET_CRYPTO_ecdsa_key_create (void);
1073
1074
1075 /**
1076  * @ingroup crypto
1077  * Create a new private key. Caller must free return value.
1078  *
1079  * @return fresh private key; free using #GNUNET_free
1080  */
1081 struct GNUNET_CRYPTO_EddsaPrivateKey *
1082 GNUNET_CRYPTO_eddsa_key_create (void);
1083
1084
1085 /**
1086  * @ingroup crypto
1087  * Create a new private key. Caller must free return value.
1088  *
1089  * @return fresh private key; free using #GNUNET_free
1090  */
1091 struct GNUNET_CRYPTO_EcdhePrivateKey *
1092 GNUNET_CRYPTO_ecdhe_key_create (void);
1093
1094
1095 /**
1096  * @ingroup crypto
1097  * Clear memory that was used to store a private key.
1098  *
1099  * @param pk location of the key
1100  */
1101 void
1102 GNUNET_CRYPTO_eddsa_key_clear (struct GNUNET_CRYPTO_EddsaPrivateKey *pk);
1103
1104
1105 /**
1106  * @ingroup crypto
1107  * Clear memory that was used to store a private key.
1108  *
1109  * @param pk location of the key
1110  */
1111 void
1112 GNUNET_CRYPTO_ecdsa_key_clear (struct GNUNET_CRYPTO_EcdsaPrivateKey *pk);
1113
1114 /**
1115  * @ingroup crypto
1116  * Clear memory that was used to store a private key.
1117  *
1118  * @param pk location of the key
1119  */
1120 void
1121 GNUNET_CRYPTO_ecdhe_key_clear (struct GNUNET_CRYPTO_EcdhePrivateKey *pk);
1122
1123
1124 /**
1125  * @ingroup crypto
1126  * Get the shared private key we use for anonymous users.
1127  *
1128  * @return "anonymous" private key; do not free
1129  */
1130 const struct GNUNET_CRYPTO_EcdsaPrivateKey *
1131 GNUNET_CRYPTO_ecdsa_key_get_anonymous (void);
1132
1133
1134 /**
1135  * @ingroup crypto
1136  * Setup a hostkey file for a peer given the name of the
1137  * configuration file (!).  This function is used so that
1138  * at a later point code can be certain that reading a
1139  * hostkey is fast (for example in time-dependent testcases).
1140 *
1141  * @param cfg_name name of the configuration file to use
1142  */
1143 void
1144 GNUNET_CRYPTO_eddsa_setup_hostkey (const char *cfg_name);
1145
1146
1147 /**
1148  * @ingroup crypto
1149  * Retrieve the identity of the host's peer.
1150  *
1151  * @param cfg configuration to use
1152  * @param dst pointer to where to write the peer identity
1153  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the identity
1154  *         could not be retrieved
1155  */
1156 int
1157 GNUNET_CRYPTO_get_peer_identity (const struct GNUNET_CONFIGURATION_Handle *cfg,
1158                                  struct GNUNET_PeerIdentity *dst);
1159
1160 /**
1161  * Compare two Peer Identities.
1162  *
1163  * @param first first peer identity
1164  * @param second second peer identity
1165  * @return bigger than 0 if first > second,
1166  *         0 if they are the same
1167  *         smaller than 0 if second > first
1168  */
1169 int
1170 GNUNET_CRYPTO_cmp_peer_identity (const struct GNUNET_PeerIdentity *first,
1171                                  const struct GNUNET_PeerIdentity *second);
1172
1173
1174 /**
1175  * @ingroup crypto
1176  * Derive key material from a public and a private ECC key.
1177  *
1178  * @param priv private key to use for the ECDH (x)
1179  * @param pub public key to use for the ECDH (yG)
1180  * @param key_material where to write the key material (xyG)
1181  * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
1182  */
1183 int
1184 GNUNET_CRYPTO_ecc_ecdh (const struct GNUNET_CRYPTO_EcdhePrivateKey *priv,
1185                         const struct GNUNET_CRYPTO_EcdhePublicKey *pub,
1186                         struct GNUNET_HashCode *key_material);
1187
1188
1189 /**
1190  * @ingroup crypto
1191  * EdDSA sign a given block.
1192  *
1193  * @param priv private key to use for the signing
1194  * @param purpose what to sign (size, purpose)
1195  * @param sig where to write the signature
1196  * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
1197  */
1198 int
1199 GNUNET_CRYPTO_eddsa_sign (const struct GNUNET_CRYPTO_EddsaPrivateKey *priv,
1200                           const struct GNUNET_CRYPTO_EccSignaturePurpose *purpose,
1201                           struct GNUNET_CRYPTO_EddsaSignature *sig);
1202
1203
1204 /**
1205  * @ingroup crypto
1206  * ECDSA Sign a given block.
1207  *
1208  * @param priv private key to use for the signing
1209  * @param purpose what to sign (size, purpose)
1210  * @param sig where to write the signature
1211  * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
1212  */
1213 int
1214 GNUNET_CRYPTO_ecdsa_sign (const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv,
1215                           const struct GNUNET_CRYPTO_EccSignaturePurpose *purpose,
1216                           struct GNUNET_CRYPTO_EcdsaSignature *sig);
1217
1218 /**
1219  * @ingroup crypto
1220  * Verify EdDSA signature.
1221  *
1222  * @param purpose what is the purpose that the signature should have?
1223  * @param validate block to validate (size, purpose, data)
1224  * @param sig signature that is being validated
1225  * @param pub public key of the signer
1226  * @returns #GNUNET_OK if ok, #GNUNET_SYSERR if invalid
1227  */
1228 int
1229 GNUNET_CRYPTO_eddsa_verify (uint32_t purpose,
1230                             const struct GNUNET_CRYPTO_EccSignaturePurpose *validate,
1231                             const struct GNUNET_CRYPTO_EddsaSignature *sig,
1232                             const struct GNUNET_CRYPTO_EddsaPublicKey *pub);
1233
1234
1235
1236 /**
1237  * @ingroup crypto
1238  * Verify ECDSA signature.
1239  *
1240  * @param purpose what is the purpose that the signature should have?
1241  * @param validate block to validate (size, purpose, data)
1242  * @param sig signature that is being validated
1243  * @param pub public key of the signer
1244  * @returns #GNUNET_OK if ok, #GNUNET_SYSERR if invalid
1245  */
1246 int
1247 GNUNET_CRYPTO_ecdsa_verify (uint32_t purpose,
1248                             const struct GNUNET_CRYPTO_EccSignaturePurpose *validate,
1249                             const struct GNUNET_CRYPTO_EcdsaSignature *sig,
1250                             const struct GNUNET_CRYPTO_EcdsaPublicKey *pub);
1251
1252
1253 /**
1254  * @ingroup crypto
1255  * Derive a private key from a given private key and a label.
1256  * Essentially calculates a private key 'h = H(l,P) * d mod n'
1257  * where n is the size of the ECC group and P is the public
1258  * key associated with the private key 'd'.
1259  *
1260  * @param priv original private key
1261  * @param label label to use for key deriviation
1262  * @param context additional context to use for HKDF of 'h';
1263  *        typically the name of the subsystem/application
1264  * @return derived private key
1265  */
1266 struct GNUNET_CRYPTO_EcdsaPrivateKey *
1267 GNUNET_CRYPTO_ecdsa_private_key_derive (const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv,
1268                                         const char *label,
1269                                         const char *context);
1270
1271
1272 /**
1273  * @ingroup crypto
1274  * Derive a public key from a given public key and a label.
1275  * Essentially calculates a public key 'V = H(l,P) * P'.
1276  *
1277  * @param pub original public key
1278  * @param label label to use for key deriviation
1279  * @param context additional context to use for HKDF of 'h'.
1280  *        typically the name of the subsystem/application
1281  * @param result where to write the derived public key
1282  */
1283 void
1284 GNUNET_CRYPTO_ecdsa_public_key_derive (const struct GNUNET_CRYPTO_EcdsaPublicKey *pub,
1285                                        const char *label,
1286                                        const char *context,
1287                                        struct GNUNET_CRYPTO_EcdsaPublicKey *result);
1288
1289
1290 /**
1291  * Output the given MPI value to the given buffer in network
1292  * byte order.  The MPI @a val may not be negative.
1293  *
1294  * @param buf where to output to
1295  * @param size number of bytes in @a buf
1296  * @param val value to write to @a buf
1297  */
1298 void
1299 GNUNET_CRYPTO_mpi_print_unsigned (void *buf,
1300                                   size_t size,
1301                                   gcry_mpi_t val);
1302
1303
1304 /**
1305  * Convert data buffer into MPI value.
1306  * The buffer is interpreted as network
1307  * byte order, unsigned integer.
1308  *
1309  * @param result where to store MPI value (allocated)
1310  * @param data raw data (GCRYMPI_FMT_USG)
1311  * @param size number of bytes in @a data
1312  */
1313 void
1314 GNUNET_CRYPTO_mpi_scan_unsigned (gcry_mpi_t *result,
1315                                  const void *data,
1316                                  size_t size);
1317
1318
1319 /**
1320  * Create a freshly generated paillier public key.
1321  *
1322  * @param[out] public_key Where to store the public key?
1323  * @param[out] private_key Where to store the private key?
1324  */
1325 void
1326 GNUNET_CRYPTO_paillier_create (struct GNUNET_CRYPTO_PaillierPublicKey *public_key,
1327                                struct GNUNET_CRYPTO_PaillierPrivateKey *private_key);
1328
1329
1330 /**
1331  * Encrypt a plaintext with a paillier public key.
1332  *
1333  * @param public_key Public key to use.
1334  * @param m Plaintext to encrypt.
1335  * @param desired_ops How many homomorphic ops the caller intends to use
1336  * @param[out] ciphertext Encrytion of @a plaintext with @a public_key.
1337  * @return guaranteed number of supported homomorphic operations >= 1, 
1338  *         or desired_ops, in case that is lower,
1339  *         or -1 if less than one homomorphic operation is possible
1340  */
1341 int
1342 GNUNET_CRYPTO_paillier_encrypt (const struct GNUNET_CRYPTO_PaillierPublicKey *public_key,
1343                                 const gcry_mpi_t m,
1344                                 int desired_ops,
1345                                 struct GNUNET_CRYPTO_PaillierCiphertext *ciphertext);
1346
1347
1348 /**
1349  * Decrypt a paillier ciphertext with a private key.
1350  *
1351  * @param private_key Private key to use for decryption.
1352  * @param public_key Public key to use for decryption.
1353  * @param ciphertext Ciphertext to decrypt.
1354  * @param[out] m Decryption of @a ciphertext with @private_key.
1355  */
1356 void
1357 GNUNET_CRYPTO_paillier_decrypt (const struct GNUNET_CRYPTO_PaillierPrivateKey *private_key,
1358                                 const struct GNUNET_CRYPTO_PaillierPublicKey *public_key,
1359                                 const struct GNUNET_CRYPTO_PaillierCiphertext *ciphertext,
1360                                 gcry_mpi_t m);
1361
1362
1363 /**
1364  * Compute a ciphertext that represents the sum of the plaintext in @a x1 and @a x2
1365  *
1366  * Note that this operation can only be done a finite number of times
1367  * before an overflow occurs.
1368  *
1369  * @param public_key Public key to use for encryption.
1370  * @param c1 Paillier cipher text.
1371  * @param c2 Paillier cipher text.
1372  * @param[out] result Result of the homomorphic operation.
1373  * @return #GNUNET_OK if the result could be computed,
1374  *         #GNUNET_SYSERR if no more homomorphic operations are remaining.
1375  */
1376 int
1377 GNUNET_CRYPTO_paillier_hom_add (const struct GNUNET_CRYPTO_PaillierPublicKey *public_key,
1378                                 const struct GNUNET_CRYPTO_PaillierCiphertext *c1,
1379                                 const struct GNUNET_CRYPTO_PaillierCiphertext *c2,
1380                                 struct GNUNET_CRYPTO_PaillierCiphertext *result);
1381
1382
1383 /**
1384  * Get the number of remaining supported homomorphic operations. 
1385  *
1386  * @param c Paillier cipher text.
1387  * @return the number of remaining homomorphic operations
1388  */
1389 int
1390 GNUNET_CRYPTO_paillier_hom_get_remaining (const struct GNUNET_CRYPTO_PaillierCiphertext *c);
1391
1392 #if 0                           /* keep Emacsens' auto-indent happy */
1393 {
1394 #endif
1395 #ifdef __cplusplus
1396 }
1397 #endif
1398
1399
1400 /* ifndef GNUNET_CRYPTO_LIB_H */
1401 #endif
1402 /* end of gnunet_crypto_lib.h */