GNUnet  0.11.x
gnunet-scrypt.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2014 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  */
25 #include "platform.h"
26 #include "gnunet_util_lib.h"
27 #include <gcrypt.h>
28 
32 static unsigned long long nse_work_required;
33 
38 
40 
41 static uint64_t proof;
42 
44 
45 static const struct GNUNET_CONFIGURATION_Handle *cfg;
46 
47 static char *pkfn;
48 
49 static char *pwfn;
50 
51 
57 static void
58 shutdown_task (void *cls)
59 {
60  (void) cls;
61  if (sizeof(proof) != GNUNET_DISK_fn_write (pwfn,
62  &proof,
63  sizeof(proof),
67 }
68 
69 
77 static void
78 pow_hash (const void *buf, size_t buf_len, struct GNUNET_HashCode *result)
79 {
80  GNUNET_break (
81  0 == gcry_kdf_derive (buf,
82  buf_len,
83  GCRY_KDF_SCRYPT,
84  1 /* subalgo */,
85  "gnunet-proof-of-work",
86  strlen ("gnunet-proof-of-work"),
87  2 /* iterations; keep cost of individual op small */,
88  sizeof(struct GNUNET_HashCode),
89  result));
90 }
91 
92 
99 static unsigned int
101 {
102  unsigned int hash_count;
103 
104  hash_count = 0;
105  while (0 == GNUNET_CRYPTO_hash_get_bit (hash, hash_count))
106  hash_count++;
107  return hash_count;
108 }
109 
110 
117 static void
118 find_proof (void *cls)
119 {
120 #define ROUND_SIZE 10
121  uint64_t counter;
122  char buf[sizeof(struct GNUNET_CRYPTO_EddsaPublicKey)
123  + sizeof(uint64_t)] GNUNET_ALIGN;
124  struct GNUNET_HashCode result;
125  unsigned int i;
126  struct GNUNET_TIME_Absolute timestamp;
127  struct GNUNET_TIME_Relative elapsed;
128 
129  (void) cls;
131  "Got Proof of Work %llu\n",
132  (unsigned long long) proof);
133  proof_task = NULL;
134  GNUNET_memcpy (&buf[sizeof(uint64_t)],
135  &pub,
136  sizeof(struct GNUNET_CRYPTO_EddsaPublicKey));
137  i = 0;
138  counter = proof;
139  timestamp = GNUNET_TIME_absolute_get ();
140  while ((counter != UINT64_MAX) && (i < ROUND_SIZE))
141  {
142  GNUNET_memcpy (buf, &counter, sizeof(uint64_t));
143  pow_hash (buf, sizeof(buf), &result);
144  if (nse_work_required <= count_leading_zeroes (&result))
145  {
146  proof = counter;
147  fprintf (stdout,
148  "Proof of work found: %llu!\n",
149  (unsigned long long) proof);
151  return;
152  }
153  counter++;
154  i++;
155  }
156  elapsed = GNUNET_TIME_absolute_get_duration (timestamp);
157  elapsed = GNUNET_TIME_relative_divide (elapsed, ROUND_SIZE);
159  "Current: %llu [%s/proof]\n",
160  (unsigned long long) counter,
162  if (proof / (100 * ROUND_SIZE) < counter / (100 * ROUND_SIZE))
163  {
165  "Testing proofs currently at %llu\n",
166  (unsigned long long) counter);
167  /* remember progress every 100 rounds */
168  proof = counter;
169  shutdown_task (NULL);
170  }
171  else
172  {
173  proof = counter;
174  }
175  proof_task =
178  &find_proof,
179  NULL);
180 }
181 
182 
191 static void
192 run (void *cls,
193  char *const *args,
194  const char *cfgfile,
195  const struct GNUNET_CONFIGURATION_Handle *config)
196 {
198  char *pids;
199 
200  (void) cls;
201  (void) args;
202  (void) cfgfile;
203  cfg = config;
204  /* load proof of work */
205  if (NULL == pwfn)
206  {
208  "NSE",
209  "PROOFFILE",
210  &pwfn))
211  {
214  return;
215  }
216  }
217  GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Proof of Work file: %s\n", pwfn);
219  (sizeof(proof) != GNUNET_DISK_fn_read (pwfn, &proof, sizeof(proof))))
220  proof = 0;
221 
222  /* load private key */
223  if (NULL == pkfn)
224  {
226  "PEER",
227  "PRIVATE_KEY",
228  &pkfn))
229  {
231  "PEER",
232  "PRIVATE_KEY");
233  return;
234  }
235  }
236  GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Private Key file: %s\n", pkfn);
237  if (NULL == (pk = GNUNET_CRYPTO_eddsa_key_create_from_file (pkfn)))
238  {
239  fprintf (stderr, _ ("Loading hostkey from `%s' failed.\n"), pkfn);
240  GNUNET_free (pkfn);
241  return;
242  }
243  GNUNET_free (pkfn);
245  GNUNET_free (pk);
247  GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Peer ID: %s\n", pids);
248  GNUNET_free (pids);
249 
250  /* get target bit amount */
251  if (0 == nse_work_required)
252  {
254  "NSE",
255  "WORKBITS",
257  {
260  return;
261  }
262  if (nse_work_required >= sizeof(struct GNUNET_HashCode) * 8)
263  {
265  "NSE",
266  "WORKBITS",
267  _ ("Value is too large.\n"));
269  return;
270  }
271  else if (0 == nse_work_required)
272  {
274  return;
275  }
276  }
278 
280  "Delay between tries: %s\n",
282  proof_task =
284  &find_proof,
285  NULL);
287 }
288 
289 
297 int
298 main (int argc, char *const *argv)
299 {
300  struct GNUNET_GETOPT_CommandLineOption options[] =
302  'b',
303  "bits",
304  "BITS",
305  gettext_noop ("number of bits to require for the proof of work"),
308  'k',
309  "keyfile",
310  "FILE",
311  gettext_noop ("file with private key, otherwise default is used"),
312  &pkfn),
314  'o',
315  "outfile",
316  "FILE",
317  gettext_noop ("file with proof of work, otherwise default is used"),
318  &pwfn),
320  "timeout",
321  "TIME",
322  gettext_noop (
323  "time to wait between calculations"),
326  int ret;
327 
328  if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
329  return 2;
330 
331  ret =
332  (GNUNET_OK ==
333  GNUNET_PROGRAM_run (argc,
334  argv,
335  "gnunet-scrypt [OPTIONS] prooffile",
336  gettext_noop ("Manipulate GNUnet proof of work files"),
337  options,
338  &run,
339  NULL))
340  ? 0
341  : 1;
342  GNUNET_free ((void *) argv);
344  return ret;
345 }
346 
347 
348 /* end of gnunet-scrypt.c */
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_relative_time(char shortName, const char *name, const char *argumentHelp, const char *description, struct GNUNET_TIME_Relative *val)
Allow user to specify a struct GNUNET_TIME_Relative (using human-readable "fancy" time)...
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
static struct GNUNET_CRYPTO_EddsaPrivateKey * pk
Private key of this peer.
int GNUNET_CONFIGURATION_get_value_number(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long *number)
Get a configuration value that should be a number.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed_with_priority(struct GNUNET_TIME_Relative delay, enum GNUNET_SCHEDULER_Priority priority, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1183
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_shutdown(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run on shutdown, that is when a CTRL-C signal is received, or when GNUNET_SCHEDULER_shutdown() is being invoked.
Definition: scheduler.c:1300
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
static void find_proof(void *cls)
Find our proof of work.
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
#define GNUNET_free_non_null(ptr)
Free the memory pointed to by ptr if ptr is not NULL.
Definition of a command line option.
void GNUNET_log_config_invalid(enum GNUNET_ErrorType kind, const char *section, const char *option, const char *required)
Log error message about invalid configuration option value.
void GNUNET_SCHEDULER_shutdown(void)
Request the shutdown of a scheduler.
Definition: scheduler.c:526
ssize_t GNUNET_DISK_fn_write(const char *fn, const void *buffer, size_t n, enum GNUNET_DISK_AccessPermissions mode)
Write a buffer to a file.
Definition: disk.c:880
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_OPTION_END
Definition: 002.c:13
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
static char * pkfn
Definition: gnunet-scrypt.c:47
static char * pwfn
Definition: gnunet-scrypt.c:49
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_filename(char shortName, const char *name, const char *argumentHelp, const char *description, char **str)
Allow user to specify a filename (automatically path expanded).
static struct GNUNET_SCHEDULER_Task * proof_task
Definition: gnunet-scrypt.c:43
static unsigned int count_leading_zeroes(const struct GNUNET_HashCode *hash)
Count the leading zeroes in hash.
static const struct GNUNET_CONFIGURATION_Handle * cfg
Definition: gnunet-scrypt.c:45
static void pow_hash(const void *buf, size_t buf_len, struct GNUNET_HashCode *result)
Calculate the &#39;proof-of-work&#39; hash (an expensive hash).
Definition: gnunet-scrypt.c:78
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_with_priority(enum GNUNET_SCHEDULER_Priority prio, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified priority.
Definition: scheduler.c:1207
static unsigned long long nse_work_required
Amount of work required (W-bit collisions) for NSE proofs, in collision-bits.
Definition: gnunet-scrypt.c:32
void GNUNET_log_config_missing(enum GNUNET_ErrorType kind, const char *section, const char *option)
Log error message about missing configuration option.
static uint64_t proof
Definition: gnunet-scrypt.c:41
#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 void run(void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *config)
Main function that will be run by the scheduler.
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 struct GNUNET_TIME_Relative proof_find_delay
Interval between proof find runs.
Definition: gnunet-scrypt.c:37
const char * GNUNET_STRINGS_relative_time_to_string(struct GNUNET_TIME_Relative delta, int do_round)
Give relative time in human-readable fancy format.
Definition: strings.c:687
static char buf[2048]
static const struct GNUNET_CONFIGURATION_Handle * config
static int result
Global testing status.
A 512-bit hashcode.
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:118
Run when otherwise idle.
int GNUNET_CRYPTO_hash_get_bit(const struct GNUNET_HashCode *code, unsigned int bit)
Obtain a bit from a hashcode.
Definition: crypto_hash.c:251
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_ulong(char shortName, const char *name, const char *argumentHelp, const char *description, unsigned long long *val)
Allow user to specify an unsigned long long.
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
Private ECC key encoded for transmission.
int main(int argc, char *const *argv)
Program to manipulate ECC key files.
static void shutdown_task(void *cls)
Write our current proof to disk.
Definition: gnunet-scrypt.c:58
configuration data
Definition: configuration.c:85
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_duration(struct GNUNET_TIME_Absolute whence)
Get the duration of an operation as the difference of the current time and the given start time "henc...
Definition: time.c:375
static struct GNUNET_CRYPTO_EddsaPublicKey pub
Definition: gnunet-scrypt.c:39
#define GNUNET_log(kind,...)
Entry in list of pending tasks.
Definition: scheduler.c:134
struct GNUNET_CRYPTO_EddsaPrivateKey * GNUNET_CRYPTO_eddsa_key_create_from_file(const char *filename)
Create a new private key by reading it from a file.
int GNUNET_CONFIGURATION_get_value_filename(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be the name of a file or directory.
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
struct GNUNET_TIME_Relative GNUNET_TIME_relative_divide(struct GNUNET_TIME_Relative rel, unsigned long long factor)
Divide relative time by a given factor.
Definition: time.c:527
Time for absolute times used by GNUnet, in microseconds.
#define GNUNET_YES
Definition: gnunet_common.h:77
#define ROUND_SIZE
ssize_t GNUNET_DISK_fn_read(const char *fn, void *result, size_t len)
Read the contents of a binary file into a buffer.
Definition: disk.c:794
#define GNUNET_free(ptr)
Wrapper around free.
Time for relative time used by GNUnet, in microseconds.
#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...