2 This file is part of GNUnet.
3 Copyright (C) 2012, 2013 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file util/gnunet-ecc.c
23 * @brief tool to manipulate EDDSA key files
24 * @author Christian Grothoff
27 #include "gnunet_util_lib.h"
28 #include "gnunet_testing_lib.h"
32 * Number of characters a Base32-encoded public key requires.
34 #define KEY_STR_LEN sizeof(struct GNUNET_CRYPTO_EddsaPublicKey)*8/5+1
37 * Flag for listing public key.
42 * Flag for listing public key.
44 static unsigned int list_keys_count;
47 * Flag for printing public key.
49 static int print_public_key;
52 * Flag for printing public key in hex.
54 static int print_public_key_hex;
57 * Flag for printing the output of random example operations.
59 static int print_examples_flag;
62 * Option set to create a bunch of keys at once.
64 static unsigned int make_keys;
68 * Create a flat file with a large number of key pairs for testing.
70 * @param fn File name to store the keys.
71 * @param prefix Desired prefix for the public keys, NULL if any key is OK.
74 create_keys (const char *fn, const char *prefix)
77 struct GNUNET_CRYPTO_EddsaPrivateKey *pk;
78 struct GNUNET_CRYPTO_EddsaPublicKey target_pub;
79 static char vanity[KEY_STR_LEN + 1];
87 if (NULL == (f = fopen (fn, "w+")))
89 fprintf (stderr, _("Failed to open `%s': %s\n"), fn, STRERROR (errno));
94 strncpy (vanity, prefix, KEY_STR_LEN);
95 len = GNUNET_MIN (strlen (prefix), KEY_STR_LEN);
99 memset (&vanity[len], '0', KEY_STR_LEN - len);
100 vanity[KEY_STR_LEN] = '\0';
101 GNUNET_assert (GNUNET_OK ==
102 GNUNET_CRYPTO_eddsa_public_key_from_string (vanity,
108 * Documentation by example:
111 * n = 5/8 = 0 (bytes)
112 * rest = 5%8 = 5 (bits)
113 * mask = ~(2**(8 - 5) - 1) = ~(2**3 - 1) = ~(8 - 1) = ~b111 = b11111000
115 mask = ~ ((int)pow (2, 8 - rest) - 1);
116 target_byte = ((unsigned char *) &target_pub)[n] & mask;
120 /* Just so old (debian) versions of GCC calm down with the warnings. */
121 mask = target_byte = 0;
123 s = GNUNET_CRYPTO_eddsa_public_key_to_string (&target_pub);
125 _("Generating %u keys like %s, please wait"),
130 "\nattempt %s [%u, %X]\n",
138 _("Generating %u keys, please wait"),
140 /* Just so old (debian) versions of GCC calm down with the warnings. */
141 n = rest = target_byte = mask = 0;
144 while (0 < make_keys--)
146 fprintf (stderr, ".");
147 if (NULL == (pk = GNUNET_CRYPTO_eddsa_key_create ()))
154 struct GNUNET_CRYPTO_EddsaPublicKey newkey;
156 GNUNET_CRYPTO_eddsa_key_get_public (pk, &newkey);
157 if (0 != memcmp (&target_pub, &newkey, n))
164 unsigned char new_byte;
166 new_byte = ((unsigned char *) &newkey)[n] & mask;
167 if (target_byte != new_byte)
174 if (GNUNET_TESTING_HOSTKEYFILESIZE !=
176 GNUNET_TESTING_HOSTKEYFILESIZE, f))
179 _("\nFailed to write to `%s': %s\n"),
187 if (UINT_MAX == make_keys)
192 _("\nError, %u keys not generated\n"),
199 print_hex (const char *msg,
203 printf ("%s: ", msg);
204 for (size_t i = 0; i < size; i++)
206 printf ("%02hhx", ((const uint8_t *)buf)[i]);
213 print_examples_ecdh ()
215 struct GNUNET_CRYPTO_EcdhePrivateKey *dh_priv1;
216 struct GNUNET_CRYPTO_EcdhePublicKey *dh_pub1;
217 struct GNUNET_CRYPTO_EcdhePrivateKey *dh_priv2;
218 struct GNUNET_CRYPTO_EcdhePublicKey *dh_pub2;
219 struct GNUNET_HashCode hash;
222 dh_pub1 = GNUNET_new (struct GNUNET_CRYPTO_EcdhePublicKey);
223 dh_priv1 = GNUNET_CRYPTO_ecdhe_key_create ();
224 dh_pub2 = GNUNET_new (struct GNUNET_CRYPTO_EcdhePublicKey);
225 dh_priv2 = GNUNET_CRYPTO_ecdhe_key_create ();
226 GNUNET_CRYPTO_ecdhe_key_get_public (dh_priv1, dh_pub1);
227 GNUNET_CRYPTO_ecdhe_key_get_public (dh_priv2, dh_pub2);
229 GNUNET_assert (NULL != GNUNET_STRINGS_data_to_string (dh_priv1, 32, buf, 128));
230 printf ("ECDHE key 1:\n");
231 printf ("private: %s\n", buf);
232 print_hex ("private(hex)", dh_priv1, sizeof *dh_priv1);
233 GNUNET_assert (NULL != GNUNET_STRINGS_data_to_string (dh_pub1, 32, buf, 128));
234 printf ("public: %s\n", buf);
235 print_hex ("public(hex)", dh_pub1, sizeof *dh_pub1);
237 GNUNET_assert (NULL != GNUNET_STRINGS_data_to_string (dh_priv2, 32, buf, 128));
238 printf ("ECDHE key 2:\n");
239 printf ("private: %s\n", buf);
240 print_hex ("private(hex)", dh_priv2, sizeof *dh_priv2);
241 GNUNET_assert (NULL != GNUNET_STRINGS_data_to_string (dh_pub2, 32, buf, 128));
242 printf ("public: %s\n", buf);
243 print_hex ("public(hex)", dh_pub2, sizeof *dh_pub2);
245 GNUNET_assert (GNUNET_OK == GNUNET_CRYPTO_ecc_ecdh (dh_priv1, dh_pub2, &hash));
246 GNUNET_assert (NULL != GNUNET_STRINGS_data_to_string (&hash, 64, buf, 128));
247 printf ("ECDH shared secret: %s\n", buf);
249 GNUNET_free (dh_priv1);
250 GNUNET_free (dh_priv2);
251 GNUNET_free (dh_pub1);
252 GNUNET_free (dh_pub2);
257 * Print some random example operations to stdout.
262 print_examples_ecdh ();
263 // print_examples_ecdsa ();
264 // print_examples_eddsa ();
269 print_key (const char *filename)
271 struct GNUNET_DISK_FileHandle *fd;
272 struct GNUNET_CRYPTO_EddsaPrivateKey private_key;
273 struct GNUNET_CRYPTO_EddsaPublicKey public_key;
277 unsigned int total_hostkeys;
280 if (GNUNET_YES != GNUNET_DISK_file_test (filename))
283 _("Hostkeys file `%s' not found\n"),
288 /* Check hostkey file size, read entire thing into memory */
289 if (GNUNET_OK != GNUNET_DISK_file_size (filename, &fs, GNUNET_YES, GNUNET_YES))
294 _("Hostkeys file `%s' is empty\n"),
296 return; /* File is empty */
298 if (0 != (fs % GNUNET_TESTING_HOSTKEYFILESIZE))
301 _("Incorrect hostkey file format: %s\n"),
305 fd = GNUNET_DISK_file_open (filename, GNUNET_DISK_OPEN_READ,
306 GNUNET_DISK_PERM_NONE);
309 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "open", filename);
312 hostkeys_data = GNUNET_malloc (fs);
313 if (fs != GNUNET_DISK_file_read (fd, hostkeys_data, fs))
316 _("Could not read hostkey file: %s\n"),
318 GNUNET_free (hostkeys_data);
319 GNUNET_DISK_file_close (fd);
322 GNUNET_DISK_file_close (fd);
324 if (NULL == hostkeys_data)
326 total_hostkeys = fs / GNUNET_TESTING_HOSTKEYFILESIZE;
327 for (c = 0; (c < total_hostkeys) && (c < list_keys_count); c++)
329 GNUNET_memcpy (&private_key,
330 hostkeys_data + (c * GNUNET_TESTING_HOSTKEYFILESIZE),
331 GNUNET_TESTING_HOSTKEYFILESIZE);
332 GNUNET_CRYPTO_eddsa_key_get_public (&private_key, &public_key);
333 hostkey_str = GNUNET_CRYPTO_eddsa_public_key_to_string (&public_key);
334 if (NULL != hostkey_str)
336 fprintf (stderr, "%4u: %s\n", c, hostkey_str);
337 GNUNET_free (hostkey_str);
340 fprintf (stderr, "%4u: %s\n", c, "invalid");
342 GNUNET_free (hostkeys_data);
347 * Main function that will be run by the scheduler.
350 * @param args remaining command-line arguments
351 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
352 * @param cfg configuration
355 run (void *cls, char *const *args, const char *cfgfile,
356 const struct GNUNET_CONFIGURATION_Handle *cfg)
358 if (print_examples_flag)
367 _("No hostkey file specified on command line\n"));
377 create_keys (args[0], args[1]);
380 if (print_public_key || print_public_key_hex)
383 struct GNUNET_DISK_FileHandle *keyfile;
384 struct GNUNET_CRYPTO_EddsaPrivateKey pk;
385 struct GNUNET_CRYPTO_EddsaPublicKey pub;
387 keyfile = GNUNET_DISK_file_open (args[0], GNUNET_DISK_OPEN_READ,
388 GNUNET_DISK_PERM_NONE);
391 while (sizeof (pk) == GNUNET_DISK_file_read (keyfile, &pk, sizeof (pk)))
393 GNUNET_CRYPTO_eddsa_key_get_public (&pk, &pub);
394 if (print_public_key_hex)
396 print_hex ("HEX:", &pub, sizeof (pub));
400 str = GNUNET_CRYPTO_eddsa_public_key_to_string (&pub);
401 FPRINTF (stdout, "%s\n", str);
405 GNUNET_DISK_file_close (keyfile);
412 * Program to manipulate ECC key files.
414 * @param argc number of arguments from the command line
415 * @param argv command line arguments
416 * @return 0 ok, 1 on error
422 struct GNUNET_GETOPT_CommandLineOption options[] = {
423 GNUNET_GETOPT_option_flag ('i',
425 gettext_noop ("list keys included in a file (for testing)"),
427 GNUNET_GETOPT_option_uint ('e',
430 gettext_noop ("number of keys to list included in a file (for testing)"),
432 GNUNET_GETOPT_option_uint ('g',
435 gettext_noop ("create COUNT public-private key pairs (for testing)"),
437 GNUNET_GETOPT_option_flag ('p',
439 gettext_noop ("print the public key in ASCII format"),
441 GNUNET_GETOPT_option_flag ('x',
443 gettext_noop ("print the public key in HEX format"),
444 &print_public_key_hex),
445 GNUNET_GETOPT_option_flag ('E',
447 gettext_noop ("print examples of ECC operations (used for compatibility testing)"),
448 &print_examples_flag),
449 GNUNET_GETOPT_OPTION_END
453 list_keys_count = UINT32_MAX;
455 GNUNET_STRINGS_get_utf8_args (argc, argv,
460 GNUNET_PROGRAM_run (argc,
462 "gnunet-ecc [OPTIONS] keyfile [VANITY_PREFIX]",
463 gettext_noop ("Manipulate GNUnet private ECC key files"),
467 GNUNET_free ((void*) argv);
471 /* end of gnunet-ecc.c */