GNUnet  0.11.x
Macros | Functions | Variables
gnunet-scrypt.c File Reference

tool to manipulate SCRYPT proofs of work. More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include <gcrypt.h>
Include dependency graph for gnunet-scrypt.c:

Go to the source code of this file.

Macros

#define ROUND_SIZE   10
 

Functions

static void shutdown_task (void *cls)
 Write our current proof to disk. More...
 
static unsigned int count_leading_zeroes (const struct GNUNET_HashCode *hash)
 Count the leading zeroes in hash. More...
 
static void find_proof (void *cls)
 Find our proof of work. More...
 
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. More...
 
int main (int argc, char *const *argv)
 Program to manipulate ECC key files. More...
 

Variables

static struct GNUNET_CRYPTO_PowSalt salt = { "gnunet-nse-proof" }
 Salt for PoW calcualations. More...
 
static unsigned long long nse_work_required
 Amount of work required (W-bit collisions) for NSE proofs, in collision-bits. More...
 
static struct GNUNET_TIME_Relative proof_find_delay
 Interval between proof find runs. More...
 
static struct GNUNET_CRYPTO_EddsaPublicKey pub
 
static uint64_t proof
 
static struct GNUNET_SCHEDULER_Taskproof_task
 
static const struct GNUNET_CONFIGURATION_Handlecfg
 
static char * pkfn
 
static char * pwfn
 

Detailed Description

tool to manipulate SCRYPT proofs of work.

Author
Bart Polot

Definition in file gnunet-scrypt.c.

Macro Definition Documentation

◆ ROUND_SIZE

#define ROUND_SIZE   10

Referenced by find_proof().

Function Documentation

◆ shutdown_task()

static void shutdown_task ( void *  cls)
static

Write our current proof to disk.

Parameters
clsclosure

Definition at line 65 of file gnunet-scrypt.c.

References GNUNET_DISK_fn_write(), GNUNET_DISK_PERM_USER_READ, GNUNET_DISK_PERM_USER_WRITE, GNUNET_ERROR_TYPE_WARNING, GNUNET_log_strerror_file, proof, and pwfn.

Referenced by find_proof(), and run().

66 {
67  (void) cls;
68  if (sizeof(proof) != GNUNET_DISK_fn_write (pwfn,
69  &proof,
70  sizeof(proof),
74 }
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
static char * pwfn
Definition: gnunet-scrypt.c:56
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...
Here is the call graph for this function:
Here is the caller graph for this function:

◆ count_leading_zeroes()

static unsigned int count_leading_zeroes ( const struct GNUNET_HashCode hash)
static

Count the leading zeroes in hash.

Parameters
hashto count leading zeros in
Returns
the number of leading zero bits.

Definition at line 84 of file gnunet-scrypt.c.

References GNUNET_CRYPTO_hash_get_bit_ltr().

Referenced by find_proof().

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 }
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
Here is the call graph for this function:
Here is the caller graph for this function:

◆ find_proof()

static void find_proof ( void *  cls)
static

Find our proof of work.

Parameters
clsclosure (unused)
tctask context

Definition at line 102 of file gnunet-scrypt.c.

References buf, count_leading_zeroes(), GNUNET_CRYPTO_pow_hash(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_INFO, GNUNET_log, GNUNET_memcpy, GNUNET_SCHEDULER_add_delayed_with_priority(), GNUNET_SCHEDULER_PRIORITY_IDLE, GNUNET_SCHEDULER_shutdown(), GNUNET_STRINGS_relative_time_to_string(), GNUNET_TIME_absolute_get(), GNUNET_TIME_absolute_get_duration(), GNUNET_TIME_relative_divide(), nse_work_required, proof, proof_find_delay, pub, ROUND_SIZE, and shutdown_task().

Referenced by run().

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));
128  buf,
129  sizeof(buf),
130  &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 }
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
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.
void GNUNET_SCHEDULER_shutdown(void)
Request the shutdown of a scheduler.
Definition: scheduler.c:531
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 unsigned long long nse_work_required
Amount of work required (W-bit collisions) for NSE proofs, in collision-bits.
Definition: gnunet-scrypt.c:39
static uint64_t proof
Definition: gnunet-scrypt.c:48
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 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.
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_ALIGN
gcc-ism to force alignment; we use this to align char-arrays that may then be cast to &#39;struct&#39;s...
static void shutdown_task(void *cls)
Write our current proof to disk.
Definition: gnunet-scrypt.c:65
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,...)
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
Time for relative time used by GNUnet, in microseconds.
Public ECC key (always for curve Ed25519) encoded in a format suitable for network transmission and E...
Here is the call graph for this function:
Here is the caller graph for this function:

◆ run()

static void run ( void *  cls,
char *const *  args,
const char *  cfgfile,
const struct GNUNET_CONFIGURATION_Handle config 
)
static

Main function that will be run by the scheduler.

Parameters
clsclosure
argsremaining command-line arguments
cfgfilename of the configuration file used (for saving, can be NULL!)
cfgconfiguration

Definition at line 179 of file gnunet-scrypt.c.

References _, config, find_proof(), GNUNET_CONFIGURATION_get_value_filename(), GNUNET_CONFIGURATION_get_value_number(), GNUNET_CRYPTO_eddsa_key_from_file(), GNUNET_CRYPTO_eddsa_key_get_public(), GNUNET_CRYPTO_eddsa_public_key_to_string(), GNUNET_DISK_file_test(), GNUNET_DISK_fn_read(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_INFO, GNUNET_free, GNUNET_log, GNUNET_log_config_invalid(), GNUNET_log_config_missing(), GNUNET_OK, GNUNET_SCHEDULER_add_shutdown(), GNUNET_SCHEDULER_add_with_priority(), GNUNET_SCHEDULER_PRIORITY_IDLE, GNUNET_SCHEDULER_shutdown(), GNUNET_STRINGS_relative_time_to_string(), GNUNET_SYSERR, GNUNET_YES, nse_work_required, pkfn, proof, proof_find_delay, pub, pwfn, and shutdown_task().

Referenced by main().

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 }
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_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
struct GNUNET_CRYPTO_EcdsaPrivateKey pk
Private key from command line option, or NULL.
static void find_proof(void *cls)
Find our proof of work.
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
#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
static struct GNUNET_SCHEDULER_Task * proof_task
Definition: gnunet-scrypt.c:50
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
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 const struct GNUNET_CONFIGURATION_Handle * config
A 512-bit hashcode.
Run when otherwise idle.
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.
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.
static void shutdown_task(void *cls)
Write our current proof to disk.
Definition: gnunet-scrypt.c:65
static struct GNUNET_CRYPTO_EddsaPublicKey pub
Definition: gnunet-scrypt.c:46
#define GNUNET_log(kind,...)
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.
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.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ main()

int main ( int  argc,
char *const *  argv 
)

Program to manipulate ECC key files.

Parameters
argcnumber of arguments from the command line
argvcommand line arguments
Returns
0 ok, 1 on error

Definition at line 288 of file gnunet-scrypt.c.

References gettext_noop, GNUNET_free, GNUNET_free_nz, GNUNET_GETOPT_OPTION_END, GNUNET_GETOPT_option_filename(), GNUNET_GETOPT_option_relative_time(), GNUNET_GETOPT_option_ulong(), GNUNET_OK, GNUNET_PROGRAM_run(), GNUNET_STRINGS_get_utf8_args(), nse_work_required, pkfn, proof_find_delay, pwfn, ret, and run().

289 {
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 }
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)...
struct GNUNET_GETOPT_CommandLineOption options[]
Definition: 002.c:5
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 int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
Definition of a command line option.
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_OPTION_END
Definition: 002.c:13
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 unsigned long long nse_work_required
Amount of work required (W-bit collisions) for NSE proofs, in collision-bits.
Definition: gnunet-scrypt.c:39
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.
static struct GNUNET_TIME_Relative proof_find_delay
Interval between proof find runs.
Definition: gnunet-scrypt.c:44
#define GNUNET_free_nz(ptr)
Wrapper around free.
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.
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
#define GNUNET_free(ptr)
Wrapper around free.
#define gettext_noop(String)
Definition: gettext.h:69
Here is the call graph for this function:

Variable Documentation

◆ salt

struct GNUNET_CRYPTO_PowSalt salt = { "gnunet-nse-proof" }
static

Salt for PoW calcualations.

Definition at line 33 of file gnunet-scrypt.c.

◆ nse_work_required

unsigned long long nse_work_required
static

Amount of work required (W-bit collisions) for NSE proofs, in collision-bits.

Definition at line 39 of file gnunet-scrypt.c.

Referenced by find_proof(), main(), and run().

◆ proof_find_delay

struct GNUNET_TIME_Relative proof_find_delay
static

Interval between proof find runs.

Definition at line 44 of file gnunet-scrypt.c.

Referenced by find_proof(), main(), and run().

◆ pub

struct GNUNET_CRYPTO_EddsaPublicKey pub
static

◆ proof

uint64_t proof
static

Definition at line 48 of file gnunet-scrypt.c.

Referenced by automaton_create_proofs(), find_proof(), run(), shutdown_task(), and write_proof().

◆ proof_task

struct GNUNET_SCHEDULER_Task* proof_task
static

Definition at line 50 of file gnunet-scrypt.c.

◆ cfg

const struct GNUNET_CONFIGURATION_Handle* cfg
static

Definition at line 52 of file gnunet-scrypt.c.

◆ pkfn

char* pkfn
static

Definition at line 54 of file gnunet-scrypt.c.

Referenced by main(), and run().

◆ pwfn

char* pwfn
static

Definition at line 56 of file gnunet-scrypt.c.

Referenced by main(), run(), and shutdown_task().