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 
29 
33 static struct GNUNET_CRYPTO_PowSalt salt = { "gnunet-nse-proof" };
34 
35 
39 static unsigned long long nse_work_required;
40 
45 
47 
48 static uint64_t proof;
49 
51 
52 static const struct GNUNET_CONFIGURATION_Handle *cfg;
53 
54 static char *pkfn;
55 
56 static char *pwfn;
57 
58 
64 static void
65 shutdown_task (void *cls)
66 {
67  (void) cls;
68  if (sizeof(proof) != GNUNET_DISK_fn_write (pwfn,
69  &proof,
70  sizeof(proof),
74 }
75 
76 
83 static unsigned int
85 {
86  unsigned int hash_count;
87 
88  hash_count = 0;
89  while (0 == GNUNET_CRYPTO_hash_get_bit_ltr (hash, hash_count))
90  hash_count++;
91  return hash_count;
92 }
93 
94 
101 static void
102 find_proof (void *cls)
103 {
104 #define ROUND_SIZE 10
105  uint64_t counter;
106  char buf[sizeof(struct GNUNET_CRYPTO_EddsaPublicKey)
107  + sizeof(uint64_t)] GNUNET_ALIGN;
108  struct GNUNET_HashCode result;
109  unsigned int i;
110  struct GNUNET_TIME_Absolute timestamp;
111  struct GNUNET_TIME_Relative elapsed;
112 
113  (void) cls;
115  "Got Proof of Work %llu\n",
116  (unsigned long long) proof);
117  proof_task = NULL;
118  GNUNET_memcpy (&buf[sizeof(uint64_t)],
119  &pub,
120  sizeof(struct GNUNET_CRYPTO_EddsaPublicKey));
121  i = 0;
122  counter = proof;
123  timestamp = GNUNET_TIME_absolute_get ();
124  while ((counter != UINT64_MAX) && (i < ROUND_SIZE))
125  {
126  GNUNET_memcpy (buf, &counter, sizeof(uint64_t));
127  GNUNET_CRYPTO_pow_hash (&salt,
128  buf,
129  sizeof(buf),
130  &result);
131  if (nse_work_required <= count_leading_zeroes (&result))
132  {
133  proof = counter;
134  fprintf (stdout,
135  "Proof of work found: %llu!\n",
136  (unsigned long long) proof);
138  return;
139  }
140  counter++;
141  i++;
142  }
143  elapsed = GNUNET_TIME_absolute_get_duration (timestamp);
144  elapsed = GNUNET_TIME_relative_divide (elapsed, ROUND_SIZE);
146  "Current: %llu [%s/proof]\n",
147  (unsigned long long) counter,
149  if (proof / (100 * ROUND_SIZE) < counter / (100 * ROUND_SIZE))
150  {
152  "Testing proofs currently at %llu\n",
153  (unsigned long long) counter);
154  /* remember progress every 100 rounds */
155  proof = counter;
156  shutdown_task (NULL);
157  }
158  else
159  {
160  proof = counter;
161  }
162  proof_task =
165  &find_proof,
166  NULL);
167 }
168 
169 
178 static void
179 run (void *cls,
180  char *const *args,
181  const char *cfgfile,
182  const struct GNUNET_CONFIGURATION_Handle *config)
183 {
185  char *pids;
186 
187  (void) cls;
188  (void) args;
189  (void) cfgfile;
190  cfg = config;
191  /* load proof of work */
192  if (NULL == pwfn)
193  {
195  "NSE",
196  "PROOFFILE",
197  &pwfn))
198  {
201  return;
202  }
203  }
204  GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Proof of Work file: %s\n", pwfn);
206  (sizeof(proof) != GNUNET_DISK_fn_read (pwfn, &proof, sizeof(proof))))
207  proof = 0;
208 
209  /* load private key */
210  if (NULL == pkfn)
211  {
213  "PEER",
214  "PRIVATE_KEY",
215  &pkfn))
216  {
218  "PEER",
219  "PRIVATE_KEY");
220  return;
221  }
222  }
223  GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Private Key file: %s\n", pkfn);
224  if (GNUNET_SYSERR ==
226  GNUNET_YES,
227  &pk))
228  {
229  fprintf (stderr, _ ("Loading hostkey from `%s' failed.\n"), pkfn);
230  GNUNET_free (pkfn);
231  return;
232  }
233  GNUNET_free (pkfn);
235  &pub);
237  GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Peer ID: %s\n", pids);
238  GNUNET_free (pids);
239 
240  /* get target bit amount */
241  if (0 == nse_work_required)
242  {
244  "NSE",
245  "WORKBITS",
247  {
250  return;
251  }
252  if (nse_work_required >= sizeof(struct GNUNET_HashCode) * 8)
253  {
255  "NSE",
256  "WORKBITS",
257  _ ("Value is too large.\n"));
259  return;
260  }
261  else if (0 == nse_work_required)
262  {
264  return;
265  }
266  }
268 
270  "Delay between tries: %s\n",
272  proof_task =
274  &find_proof,
275  NULL);
277 }
278 
279 
287 int
288 main (int argc, char *const *argv)
289 {
290  struct GNUNET_GETOPT_CommandLineOption options[] =
292  'b',
293  "bits",
294  "BITS",
295  gettext_noop ("number of bits to require for the proof of work"),
298  'k',
299  "keyfile",
300  "FILE",
301  gettext_noop ("file with private key, otherwise default is used"),
302  &pkfn),
304  'o',
305  "outfile",
306  "FILE",
307  gettext_noop ("file with proof of work, otherwise default is used"),
308  &pwfn),
310  "timeout",
311  "TIME",
312  gettext_noop (
313  "time to wait between calculations"),
316  int ret;
317 
318  if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
319  return 2;
320 
321  ret =
322  (GNUNET_OK ==
323  GNUNET_PROGRAM_run (argc,
324  argv,
325  "gnunet-scrypt [OPTIONS] prooffile",
326  gettext_noop ("Manipulate GNUnet proof of work files"),
327  options,
328  &run,
329  NULL))
330  ? 0
331  : 1;
332  GNUNET_free_nz ((void *) argv);
333  GNUNET_free (pwfn);
334  return ret;
335 }
336 
337 
338 /* 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
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:1199
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:1331
int GNUNET_STRINGS_get_utf8_args(int argc, char *const *argv, int *u8argc, char *const **u8argv)
Returns utf-8 encoded arguments.
Definition: strings.c:1458
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
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:531
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:879
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_OPTION_END
Definition: 002.c:13
#define _(String)
GNU gettext support macro.
Definition: platform.h:184
static char * pkfn
Definition: gnunet-scrypt.c:54
static char * pwfn
Definition: gnunet-scrypt.c:56
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:50
static unsigned int count_leading_zeroes(const struct GNUNET_HashCode *hash)
Count the leading zeroes in hash.
Definition: gnunet-scrypt.c:84
static const struct GNUNET_CONFIGURATION_Handle * cfg
Definition: gnunet-scrypt.c:52
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:1223
static unsigned long long nse_work_required
Amount of work required (W-bit collisions) for NSE proofs, in collision-bits.
Definition: gnunet-scrypt.c:39
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:48
#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:265
static struct GNUNET_TIME_Relative proof_find_delay
Interval between proof find runs.
Definition: gnunet-scrypt.c:44
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:702
static char buf[2048]
static const struct GNUNET_CONFIGURATION_Handle * config
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.
void GNUNET_CRYPTO_pow_hash(const struct GNUNET_CRYPTO_PowSalt *salt, const void *buf, size_t buf_len, struct GNUNET_HashCode *result)
Calculate the &#39;proof-of-work&#39; hash (an expensive hash).
Definition: crypto_pow.c:41
#define GNUNET_free_nz(ptr)
Wrapper around free.
int GNUNET_CRYPTO_eddsa_key_from_file(const char *filename, int do_create, struct GNUNET_CRYPTO_EddsaPrivateKey *pkey)
Create a new private key by reading it from a file.
Value for a salt for GNUNET_CRYPTO_pow_hash().
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:193
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:65
configuration data
Definition: configuration.c:84
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:46
#define GNUNET_log(kind,...)
Entry in list of pending tasks.
Definition: scheduler.c:134
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
int GNUNET_CRYPTO_hash_get_bit_ltr(const struct GNUNET_HashCode *code, unsigned int bit)
Obtain a bit from a hashcode.
Definition: crypto_hash.c:252
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 ROUND_SIZE
static struct GNUNET_CRYPTO_PowSalt salt
Salt for PoW calcualations.
Definition: gnunet-scrypt.c:33
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...