GNUnet  0.11.x
gnunet-ecc.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2012, 2013 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your 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  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
20 
26 #include "platform.h"
27 #include "gnunet_util_lib.h"
28 #include "gnunet_testing_lib.h"
29 #include <gcrypt.h>
30 
34 #define KEY_STR_LEN sizeof(struct GNUNET_CRYPTO_EddsaPublicKey) * 8 / 5 + 1
35 
39 static int list_keys;
40 
44 static unsigned int list_keys_count;
45 
49 static int print_public_key;
50 
54 static int print_private_key;
55 
60 
65 
69 static unsigned int make_keys;
70 
71 
78 static void
79 create_keys (const char *fn, const char *prefix)
80 {
81  FILE *f;
83  struct GNUNET_CRYPTO_EddsaPublicKey target_pub;
84  static char vanity[KEY_STR_LEN + 1];
85  size_t len;
86  size_t n;
87  size_t rest;
88  unsigned char mask;
89  unsigned target_byte;
90  char *s;
91 
92  if (NULL == (f = fopen (fn, "w+")))
93  {
94  fprintf (stderr, _ ("Failed to open `%s': %s\n"), fn, strerror (errno));
95  return;
96  }
97  if (NULL != prefix)
98  {
99  len = GNUNET_strlcpy (vanity, prefix, sizeof(vanity));
100  n = len * 5 / 8;
101  rest = len * 5 % 8;
102 
103  memset (&vanity[len], '0', KEY_STR_LEN - len);
104  vanity[KEY_STR_LEN] = '\0';
107  KEY_STR_LEN,
108  &target_pub));
109  if (0 != rest)
110  {mask = ~((int) pow (2, 8 - rest) - 1);
119  target_byte = ((unsigned char *) &target_pub)[n] & mask;
120  }
121  else
122  {
123  /* Just so old (debian) versions of GCC calm down with the warnings. */
124  mask = target_byte = 0;
125  }
127  fprintf (stderr,
128  _ ("Generating %u keys like %s, please wait"),
129  make_keys,
130  s);
131  GNUNET_free (s);
132  fprintf (stderr, "\nattempt %s [%u, %X]\n", vanity, (unsigned int) n, mask);
133  }
134  else
135  {
136  fprintf (stderr, _ ("Generating %u keys, please wait"), make_keys);
137  /* Just so old (debian) versions of GCC calm down with the warnings. */
138  n = rest = target_byte = mask = 0;
139  }
140 
141  while (0 < make_keys--)
142  {
143  fprintf (stderr, ".");
144  if (NULL == (pk = GNUNET_CRYPTO_eddsa_key_create ()))
145  {
146  GNUNET_break (0);
147  break;
148  }
149  if (NULL != prefix)
150  {
151  struct GNUNET_CRYPTO_EddsaPublicKey newkey;
152 
154  if (0 != memcmp (&target_pub, &newkey, n))
155  {
156  make_keys++;
157  continue;
158  }
159  if (0 != rest)
160  {
161  unsigned char new_byte;
162 
163  new_byte = ((unsigned char *) &newkey)[n] & mask;
164  if (target_byte != new_byte)
165  {
166  make_keys++;
167  continue;
168  }
169  }
170  }
172  fwrite (pk, 1, GNUNET_TESTING_HOSTKEYFILESIZE, f))
173  {
174  fprintf (stderr,
175  _ ("\nFailed to write to `%s': %s\n"),
176  fn,
177  strerror (errno));
178  GNUNET_free (pk);
179  break;
180  }
181  GNUNET_free (pk);
182  }
183  if (UINT_MAX == make_keys)
184  fprintf (stderr, _ ("\nFinished!\n"));
185  else
186  fprintf (stderr, _ ("\nError, %u keys not generated\n"), make_keys);
187  fclose (f);
188 }
189 
190 
191 static void
192 print_hex (const char *msg, const void *buf, size_t size)
193 {
194  printf ("%s: ", msg);
195  for (size_t i = 0; i < size; i++)
196  {
197  printf ("%02hhx", ((const uint8_t *) buf)[i]);
198  }
199  printf ("\n");
200 }
201 
202 
203 static void
205 {
206  struct GNUNET_CRYPTO_EcdhePrivateKey *dh_priv1;
207  struct GNUNET_CRYPTO_EcdhePublicKey *dh_pub1;
208  struct GNUNET_CRYPTO_EcdhePrivateKey *dh_priv2;
209  struct GNUNET_CRYPTO_EcdhePublicKey *dh_pub2;
210  struct GNUNET_HashCode hash;
211  char buf[128];
212 
213  dh_pub1 = GNUNET_new (struct GNUNET_CRYPTO_EcdhePublicKey);
214  dh_priv1 = GNUNET_CRYPTO_ecdhe_key_create ();
215  dh_pub2 = GNUNET_new (struct GNUNET_CRYPTO_EcdhePublicKey);
216  dh_priv2 = GNUNET_CRYPTO_ecdhe_key_create ();
217  GNUNET_CRYPTO_ecdhe_key_get_public (dh_priv1, dh_pub1);
218  GNUNET_CRYPTO_ecdhe_key_get_public (dh_priv2, dh_pub2);
219 
220  GNUNET_assert (NULL !=
221  GNUNET_STRINGS_data_to_string (dh_priv1, 32, buf, 128));
222  printf ("ECDHE key 1:\n");
223  printf ("private: %s\n", buf);
224  print_hex ("private(hex)", dh_priv1, sizeof *dh_priv1);
225  GNUNET_assert (NULL != GNUNET_STRINGS_data_to_string (dh_pub1, 32, buf, 128));
226  printf ("public: %s\n", buf);
227  print_hex ("public(hex)", dh_pub1, sizeof *dh_pub1);
228 
229  GNUNET_assert (NULL !=
230  GNUNET_STRINGS_data_to_string (dh_priv2, 32, buf, 128));
231  printf ("ECDHE key 2:\n");
232  printf ("private: %s\n", buf);
233  print_hex ("private(hex)", dh_priv2, sizeof *dh_priv2);
234  GNUNET_assert (NULL != GNUNET_STRINGS_data_to_string (dh_pub2, 32, buf, 128));
235  printf ("public: %s\n", buf);
236  print_hex ("public(hex)", dh_pub2, sizeof *dh_pub2);
237 
239  GNUNET_CRYPTO_ecc_ecdh (dh_priv1, dh_pub2, &hash));
240  GNUNET_assert (NULL != GNUNET_STRINGS_data_to_string (&hash, 64, buf, 128));
241  printf ("ECDH shared secret: %s\n", buf);
242 
243  GNUNET_free (dh_priv1);
244  GNUNET_free (dh_priv2);
245  GNUNET_free (dh_pub1);
246  GNUNET_free (dh_pub2);
247 }
248 
249 
253 static void
255 {
257  // print_examples_ecdsa ();
258  // print_examples_eddsa ();
259 }
260 
261 
262 static void
263 print_key (const char *filename)
264 {
265  struct GNUNET_DISK_FileHandle *fd;
266  struct GNUNET_CRYPTO_EddsaPrivateKey private_key;
267  struct GNUNET_CRYPTO_EddsaPublicKey public_key;
268  char *hostkeys_data;
269  char *hostkey_str;
270  uint64_t fs;
271  unsigned int total_hostkeys;
272  unsigned int c;
273  ssize_t sret;
274 
275  if (GNUNET_YES != GNUNET_DISK_file_test (filename))
276  {
277  fprintf (stderr, _ ("Hostkeys file `%s' not found\n"), filename);
278  return;
279  }
280 
281  /* Check hostkey file size, read entire thing into memory */
282  if (GNUNET_OK !=
283  GNUNET_DISK_file_size (filename, &fs, GNUNET_YES, GNUNET_YES))
284  fs = 0;
285  if (0 == fs)
286  {
287  fprintf (stderr, _ ("Hostkeys file `%s' is empty\n"), filename);
288  return; /* File is empty */
289  }
290  if (0 != (fs % GNUNET_TESTING_HOSTKEYFILESIZE))
291  {
292  fprintf (stderr, _ ("Incorrect hostkey file format: %s\n"), filename);
293  return;
294  }
295  fd = GNUNET_DISK_file_open (filename,
298  if (NULL == fd)
299  {
301  return;
302  }
303  hostkeys_data = GNUNET_malloc (fs);
304  sret = GNUNET_DISK_file_read (fd, hostkeys_data, fs);
305  if ((sret < 0) || (fs != (size_t) sret))
306  {
307  fprintf (stderr, _ ("Could not read hostkey file: %s\n"), filename);
308  GNUNET_free (hostkeys_data);
310  return;
311  }
313 
314  if (NULL == hostkeys_data)
315  return;
316  total_hostkeys = fs / GNUNET_TESTING_HOSTKEYFILESIZE;
317  for (c = 0; (c < total_hostkeys) && (c < list_keys_count); c++)
318  {
319  GNUNET_memcpy (&private_key,
320  hostkeys_data + (c * GNUNET_TESTING_HOSTKEYFILESIZE),
321  GNUNET_TESTING_HOSTKEYFILESIZE);
322  GNUNET_CRYPTO_eddsa_key_get_public (&private_key, &public_key);
323  hostkey_str = GNUNET_CRYPTO_eddsa_public_key_to_string (&public_key);
324  if (NULL != hostkey_str)
325  {
326  fprintf (stderr, "%4u: %s\n", c, hostkey_str);
327  GNUNET_free (hostkey_str);
328  }
329  else
330  fprintf (stderr, "%4u: %s\n", c, "invalid");
331  }
332  GNUNET_free (hostkeys_data);
333 }
334 
335 
344 static void
345 run (void *cls,
346  char *const *args,
347  const char *cfgfile,
348  const struct GNUNET_CONFIGURATION_Handle *cfg)
349 {
350  (void) cls;
351  (void) cfgfile;
352  (void) cfg;
353 
355  {
356  print_examples ();
357  return;
358  }
359  if (NULL == args[0])
360  {
361  fprintf (stderr, "%s", _ ("No hostkey file specified on command line\n"));
362  return;
363  }
364  if (list_keys)
365  {
366  print_key (args[0]);
367  return;
368  }
369  if (make_keys > 0)
370  {
371  create_keys (args[0], args[1]);
372  return;
373  }
375  {
376  char *str;
377  struct GNUNET_DISK_FileHandle *keyfile;
379  struct GNUNET_CRYPTO_EddsaPublicKey pub;
380 
381  keyfile = GNUNET_DISK_file_open (args[0],
384  if (NULL == keyfile)
385  return;
386  while (sizeof(pk) == GNUNET_DISK_file_read (keyfile, &pk, sizeof(pk)))
387  {
390  {
391  print_hex ("HEX:", &pub, sizeof(pub));
392  }
393  else if (print_public_key)
394  {
396  fprintf (stdout, "%s\n", str);
397  GNUNET_free (str);
398  }
399  else if (print_private_key)
400  {
402  fprintf (stdout, "%s\n", str);
403  GNUNET_free (str);
404  }
405  }
406  GNUNET_DISK_file_close (keyfile);
407  }
408 }
409 
410 
418 int
419 main (int argc, char *const *argv)
420 {
421  struct GNUNET_GETOPT_CommandLineOption options[] =
423  "iterate",
424  gettext_noop (
425  "list keys included in a file (for testing)"),
426  &list_keys),
428  'e',
429  "end=",
430  "COUNT",
431  gettext_noop ("number of keys to list included in a file (for testing)"),
432  &list_keys_count),
434  'g',
435  "generate-keys",
436  "COUNT",
437  gettext_noop ("create COUNT public-private key pairs (for testing)"),
438  &make_keys),
440  "print-public-key",
441  gettext_noop (
442  "print the public key in ASCII format"),
445  "print-private-key",
446  gettext_noop (
447  "print the private key in ASCII format"),
450  "print-hex",
451  gettext_noop (
452  "print the public key in HEX format"),
455  'E',
456  "examples",
457  gettext_noop (
458  "print examples of ECC operations (used for compatibility testing)"),
461  int ret;
462 
463  list_keys_count = UINT32_MAX;
464  if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
465  return 2;
466 
467  ret = (GNUNET_OK ==
468  GNUNET_PROGRAM_run (argc,
469  argv,
470  "gnunet-ecc [OPTIONS] keyfile [VANITY_PREFIX]",
471  gettext_noop (
472  "Manipulate GNUnet private ECC key files"),
473  options,
474  &run,
475  NULL))
476  ? 0
477  : 1;
478  GNUNET_free ((void *) argv);
479  return ret;
480 }
481 
482 
483 /* end of gnunet-ecc.c */
int main(int argc, char *const *argv)
Program to manipulate ECC key files.
Definition: gnunet-ecc.c:419
int GNUNET_DISK_file_test(const char *fil)
Check that fil corresponds to a filename (of a file that exists and that is not a directory)...
Definition: disk.c:544
Open the file for reading.
static struct GNUNET_CRYPTO_EddsaPrivateKey * pk
Private key of this peer.
static int list_keys
Flag for listing public key.
Definition: gnunet-ecc.c:39
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
int GNUNET_DISK_file_close(struct GNUNET_DISK_FileHandle *h)
Close an open file.
Definition: disk.c:1345
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
ssize_t GNUNET_DISK_file_read(const struct GNUNET_DISK_FileHandle *h, void *result, size_t len)
Read the contents of a binary file into a buffer.
Definition: disk.c:732
int GNUNET_STRINGS_get_utf8_args(int argc, char *const *argv, int *u8argc, char *const **u8argv)
Returns utf-8 encoded arguments.
Definition: strings.c:1438
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
Nobody is allowed to do anything to the file.
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
int GNUNET_CRYPTO_ecc_ecdh(const struct GNUNET_CRYPTO_EcdhePrivateKey *priv, const struct GNUNET_CRYPTO_EcdhePublicKey *pub, struct GNUNET_HashCode *key_material)
Derive key material from a public and a private ECC key.
Definition: crypto_ecc.c:1183
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
struct GNUNET_CRYPTO_EcdhePrivateKey * GNUNET_CRYPTO_ecdhe_key_create(void)
Create a new private key.
Definition: crypto_ecc.c:608
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
#define GNUNET_new(type)
Allocate a struct or union of the given type.
Definition of a command line option.
#define GNUNET_TESTING_HOSTKEYFILESIZE
Size of each hostkey in the hostkey file (in BYTES).
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
static void print_hex(const char *msg, const void *buf, size_t size)
Definition: gnunet-ecc.c:192
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_OPTION_END
Definition: 002.c:13
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
static void print_examples_ecdh()
Definition: gnunet-ecc.c:204
static void * hostkeys_data
The hostkeys data.
struct GNUNET_CRYPTO_EddsaPrivateKey * GNUNET_CRYPTO_eddsa_key_create(void)
Create a new private key.
Definition: crypto_ecc.c:744
static unsigned int make_keys
Option set to create a bunch of keys at once.
Definition: gnunet-ecc.c:69
#define GNUNET_log_strerror_file(level, cmd, filename)
Log an error message at log-level &#39;level&#39; that indicates a failure of the command &#39;cmd&#39; with the mess...
static char * fn
Filename of the unique file.
char * GNUNET_CRYPTO_eddsa_public_key_to_string(const struct GNUNET_CRYPTO_EddsaPublicKey *pub)
Convert a public key to a string.
Definition: crypto_ecc.c:365
static char buf[2048]
static char * filename
static void print_key(const char *filename)
Definition: gnunet-ecc.c:263
static void print_examples()
Print some random example operations to stdout.
Definition: gnunet-ecc.c:254
static void run(void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
Main function that will be run by the scheduler.
Definition: gnunet-ecc.c:345
#define KEY_STR_LEN
Number of characters a Base32-encoded public key requires.
Definition: gnunet-ecc.c:34
A 512-bit hashcode.
Private ECC key encoded for transmission.
static unsigned int size
Size of the "table".
Definition: peer.c:67
void GNUNET_CRYPTO_ecdhe_key_get_public(const struct GNUNET_CRYPTO_EcdhePrivateKey *priv, struct GNUNET_CRYPTO_EcdhePublicKey *pub)
Extract the public key for the given private key.
Definition: crypto_ecc.c:301
static unsigned int list_keys_count
Flag for listing public key.
Definition: gnunet-ecc.c:44
static int print_public_key_hex
Flag for printing public key in hex.
Definition: gnunet-ecc.c:59
static struct GNUNET_FS_Handle * fs
Handle to FS service.
Definition: gnunet-fs.c:36
int GNUNET_DISK_file_size(const char *filename, uint64_t *size, int include_symbolic_links, int single_file_mode)
Get the size of the file (or directory) of the given file (in bytes).
Definition: disk.c:257
void GNUNET_CRYPTO_eddsa_key_get_public(const struct GNUNET_CRYPTO_EddsaPrivateKey *priv, struct GNUNET_CRYPTO_EddsaPublicKey *pub)
Extract the public key for the given private key.
Definition: crypto_ecc.c:270
static int print_public_key
Flag for printing public key.
Definition: gnunet-ecc.c:49
Private ECC key encoded for transmission.
int GNUNET_CRYPTO_eddsa_public_key_from_string(const char *enc, size_t enclen, struct GNUNET_CRYPTO_EddsaPublicKey *pub)
Convert a string representing a public key to a public key.
Definition: crypto_ecc.c:499
static int print_private_key
Flag for printing private key.
Definition: gnunet-ecc.c:54
configuration data
Definition: configuration.c:85
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_flag(char shortName, const char *name, const char *description, int *val)
Allow user to specify a flag (which internally means setting an integer to 1/GNUNET_YES/GNUNET_OK.
Public ECC key (always for Curve25519) encoded in a format suitable for network transmission and encr...
char * GNUNET_CRYPTO_eddsa_private_key_to_string(const struct GNUNET_CRYPTO_EddsaPrivateKey *priv)
Convert a private key to a string.
Definition: crypto_ecc.c:398
int GNUNET_PROGRAM_run(int argc, char *const *argv, const char *binaryName, const char *binaryHelp, const struct GNUNET_GETOPT_CommandLineOption *options, GNUNET_PROGRAM_Main task, void *task_cls)
Run a standard GNUnet command startup sequence (initialize loggers and configuration, parse options).
Definition: program.c:367
static int print_examples_flag
Flag for printing the output of random example operations.
Definition: gnunet-ecc.c:64
#define GNUNET_YES
Definition: gnunet_common.h:77
int fd
File handle on Unix-like systems.
static void create_keys(const char *fn, const char *prefix)
Create a flat file with a large number of key pairs for testing.
Definition: gnunet-ecc.c:79
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_uint(char shortName, const char *name, const char *argumentHelp, const char *description, unsigned int *val)
Allow user to specify an unsigned int.
struct GNUNET_DISK_FileHandle * GNUNET_DISK_file_open(const char *fn, enum GNUNET_DISK_OpenFlags flags, enum GNUNET_DISK_AccessPermissions perm)
Open a file.
Definition: disk.c:1268
size_t GNUNET_strlcpy(char *dst, const char *src, size_t n)
Like strlcpy but portable.
Definition: strings.c:219
Handle used to access files (and pipes).
#define GNUNET_malloc(size)
Wrapper around malloc.
char * GNUNET_STRINGS_data_to_string(const void *data, size_t size, char *out, size_t out_size)
Convert binary data to ASCII encoding using CrockfordBase32.
Definition: strings.c:856
#define GNUNET_free(ptr)
Wrapper around free.
uint16_t len
length of data (which is always a uint32_t, but presumably this can be used to specify that fewer byt...
#define gettext_noop(String)
Definition: gettext.h:69
Public ECC key (always for curve Ed25519) encoded in a format suitable for network transmission and E...