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