1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
|
/*
* ecgen, tool for generating Elliptic curve domain parameters
* Copyright (C) 2017-2018 J08nY
*/
#include "cli.h"
#include <regex.h>
#include <string.h>
#include "exhaustive/ansi.h"
#include "exhaustive/brainpool.h"
char cli_doc[] =
"ecgen, tool for generating Elliptic curve domain parameters.\v(C) "
"2017-2018,2021,2023 J08nY";
char cli_args_doc[] = "bits";
enum opt_keys {
OPT_DATADIR = 'd',
OPT_COUNT = 'c',
OPT_PRIME = 'p',
OPT_COFACTOR = 'k',
OPT_SMOOTH = 'B',
OPT_RANDOM = 'r',
OPT_ANSI = 's',
OPT_BRAINPOOL = 'b',
OPT_INVALID = 'i',
OPT_ORDER = 'n',
OPT_KOBLITZ = 'K',
OPT_UNIQUE = 'u',
OPT_OUTPUT = 'o',
OPT_INPUT = 'f',
OPT_APPEND = 'a',
OPT_VERBOSE = 'v',
OPT_MEMORY = 'm',
OPT_FP = 1,
OPT_F2M,
OPT_POINTS,
OPT_THREADS,
OPT_TSTACK,
OPT_TIMEOUT,
OPT_ANOMALOUS,
OPT_HEXCHECK,
OPT_METADATA,
OPT_SUPERSINGULAR,
OPT_NUMS,
OPT_BRAINPOOL_RFC,
OPT_TWIST,
};
// clang-format off
struct argp_option cli_options[] = {
{0, 0, 0, 0, "Field specification:", 1},
{"fp", OPT_FP, 0, 0, "Prime field.", 1},
{"f2m", OPT_F2M, 0, 0, "Binary field.", 1},
{0, 0, 0, 0, "Generation methods:", 2},
{"order", OPT_ORDER, "ORDER", 0, "Generate a curve with given order (using Complex Multiplication).", 2},
{"supersingular", OPT_SUPERSINGULAR, 0, 0, "Generate a supersingular curve.", 2},
{"anomalous", OPT_ANOMALOUS, 0, 0, "Generate an anomalous curve (of trace one, with field order equal to curve order).", 2},
{"ansi", OPT_ANSI, "SEED", OPTION_ARG_OPTIONAL, "Generate a curve from SEED (ANSI X9.62 verifiable procedure).", 2},
{"brainpool", OPT_BRAINPOOL, "SEED", OPTION_ARG_OPTIONAL, "Generate a curve from SEED (Brainpool procedure).", 2},
{"brainpool-rfc", OPT_BRAINPOOL_RFC, "SEED", OPTION_ARG_OPTIONAL, "Generate a curve from SEED (Brainpool procedure, as per RFC 5639).", 2},
{"nums", OPT_NUMS, 0, 0, "Generate a curve using the NUMS procedure.", 2},
{"invalid", OPT_INVALID, "RANGE", OPTION_ARG_OPTIONAL, "Generate a set of invalid curves, for a given curve (using Invalid curve algorithm).", 2},
{"twist", OPT_TWIST, 0, 0, "Generate a twist of a given curve.", 2},
{0, 0, 0, 0, "Generation options:", 3},
{"random", OPT_RANDOM, "WHAT", OPTION_ARG_OPTIONAL, "Generate a random curve (using Random approach). "
"Optionally, only generate random parameters WHAT (seed,field,a,b,equation).", 3},
{"prime", OPT_PRIME, 0, 0, "Generate a curve with prime order.", 3},
{"cofactor", OPT_COFACTOR, "VALUE", 0, "Generate a curve with cofactor of VALUE.", 3},
{"smooth", OPT_SMOOTH, "BOUND", 0, "Generate a smooth order curve with bit-lengths of factors bounded by BOUND.", 3},
{"koblitz", OPT_KOBLITZ, "A", OPTION_ARG_OPTIONAL, "Generate a Koblitz curve (a in {0, 1}, b = 1).", 3},
{"unique", OPT_UNIQUE, 0, 0, "Generate a curve with only one generator.", 3},
{"hex-check", OPT_HEXCHECK, "HEX", 0, "Check a generated curve param hex expansion for the HEX string.", 3},
{"points", OPT_POINTS, "TYPE", 0, "Generate points of given type (random/prime/all/nonprime/none).", 3},
{"count", OPT_COUNT, "COUNT", 0, "Generate multiple curves.", 3},
{"metadata", OPT_METADATA, 0, 0, "Compute curve metadata "
"(j-invariant, discriminant, trace of Frobenius, embedding degree, CM discriminant).", 3},
{0, 0, 0, 0, "Input/Output options:", 4},
{"input", OPT_INPUT, "FILE", 0, "Input from file.", 4},
{"output", OPT_OUTPUT, "FILE", 0, "Output into file. Overwrites any existing file!", 4},
{"append", OPT_APPEND, 0, 0, "Append to output file (don't overwrite).", 4},
{"verbose", OPT_VERBOSE, "FILE", OPTION_ARG_OPTIONAL, "Verbose logging (to stdout or file).", 4},
{0, 0, 0, 0, "Other:", 5},
{"data-dir", OPT_DATADIR, "DIR", 0, "Set PARI/GP data directory (containing seadata package).", 5},
{"memory", OPT_MEMORY, "SIZE", 0, "Use PARI stack of SIZE (can have suffix k/m/g).", 5},
{"threads", OPT_THREADS, "NUM", 0, "Use NUM threads.", 5},
{"thread-stack", OPT_TSTACK, "SIZE", 0, "Use PARI stack of SIZE (per thread, can have suffix k/m/g).", 5},
{"timeout", OPT_TIMEOUT, "TIME", 0, "Timeout computation of a curve parameter after TIME (can have suffix s/m/h/d).", 5},
{0}
};
// clang-format on
static regex_t re_cm_order;
bool cli_init() {
int error = regcomp(
&re_cm_order,
"((0[xX][0-9a-fA-F]+)|([0-9]+))(,((0[xX][0-9a-fA-F]+)|([0-9]+)))*",
REG_EXTENDED);
if (error) {
size_t length = regerror(error, &re_cm_order, NULL, 0);
char msg[length + 1];
regerror(error, &re_cm_order, msg, length + 1);
fprintf(stderr, "Error compiling regex: %s\n", msg);
return false;
}
return true;
}
static unsigned long cli_parse_memory(const char *str,
struct argp_state *state) {
char *suffix = NULL;
unsigned long read = strtoul(str, &suffix, 10);
if (suffix == str) {
argp_failure(state, 1, 0, "Wrong memory value.");
}
if (suffix) {
if (*suffix == 'k' || *suffix == 'K') {
read *= 1000;
} else if (*suffix == 'm' || *suffix == 'M') {
read *= 1000000;
} else if (*suffix == 'g' || *suffix == 'G') {
read *= 1000000000;
}
}
return read;
}
static unsigned long cli_parse_time(const char *str, struct argp_state *state) {
char *suffix = NULL;
unsigned long read = strtoul(str, &suffix, 10);
if (suffix == str) {
argp_failure(state, 1, 0, "Wrong time value.");
}
if (suffix) {
if (*suffix == 'm' || *suffix == 'M') {
read *= 60;
} else if (*suffix == 'h' || *suffix == 'H') {
read *= 3600;
} else if (*suffix == 'd' || *suffix == 'D') {
read *= 86400;
}
}
return read;
}
static void cli_end(struct argp_state *state) {
// validate all option states here.
// Only one field
if (cfg->field == 0 || cfg->field == (FIELD_PRIME | FIELD_BINARY)) {
argp_failure(state, 1, 0,
"Specify field type, prime or binary, with --fp / "
"--f2m (but not both).");
}
// Only one of prime, cofactor, smooth
if (cfg->prime + cfg->smooth + cfg->cofactor > 1) {
argp_failure(state, 1, 0, "Can only choose one of prime-order, cofactor value or smoothness bound.");
}
// Only one gen method
switch (cfg->method) {
case METHOD_DEFAULT:
case METHOD_CM:
case METHOD_ANOMALOUS:
case METHOD_SEED:
case METHOD_INVALID:
case METHOD_TWIST:
case METHOD_SUPERSINGULAR:
break;
default:
printf("%u\n", cfg->method);
argp_failure(state, 1, 0,
"Only one generation method can be specified.");
break;
}
if (cfg->method == METHOD_SEED && (cfg->seed_algo == SEED_BRAINPOOL || cfg->seed_algo == SEED_BRAINPOOL_RFC) &&
cfg->field == FIELD_BINARY) {
argp_failure(state, 1, 0,
"Brainpool algorithm only creates prime field curves.");
}
if (cfg->method == METHOD_SEED && cfg->seed_algo == SEED_NUMS &&
cfg->field == FIELD_BINARY) {
argp_failure(state, 1, 0,
"NUMS algorithm only creates prime field curves.");
}
if (cfg->method == METHOD_CM && cfg->field == FIELD_BINARY) {
argp_failure(state, 1, 0,
"Complex multiplication only creates prime field curves.");
}
if (cfg->method == METHOD_SUPERSINGULAR && cfg->field == FIELD_BINARY) {
argp_failure(state, 1, 0,
"Can only generate supersingular curves over prime fields "
"currently.");
}
// default values
if (!cfg->count) {
cfg->count = 1;
}
if (!cfg->memory) {
cfg->memory = 1000000000;
}
if (!cfg->threads) {
cfg->threads = 1;
}
if (!cfg->thread_memory) {
cfg->thread_memory = cfg->bits * 2000000;
}
cfg->format = FORMAT_JSON;
}
error_t cli_parse(int key, char *arg, struct argp_state *state) {
switch (key) {
/* Field options */
case OPT_FP:
cfg->field |= FIELD_PRIME;
break;
case OPT_F2M:
cfg->field |= FIELD_BINARY;
break;
/* Generation method */
case OPT_INVALID:
cfg->method |= METHOD_INVALID;
if (arg) {
size_t span = strspn(arg, "0123456789-");
if (span != strlen(arg)) {
argp_failure(state, 1, 0, "Invalid range %s", arg);
}
cfg->invalid_primes = arg;
}
break;
case OPT_ORDER:
cfg->method |= METHOD_CM;
if (arg) {
int error = regexec(&re_cm_order, arg, 0, NULL, 0);
if (error != 0) {
argp_failure(state, 1, 0, "Invalid order %s", arg);
}
cfg->cm_order = arg;
}
break;
case OPT_ANOMALOUS:
cfg->method |= METHOD_ANOMALOUS;
break;
case OPT_SUPERSINGULAR:
cfg->method |= METHOD_SUPERSINGULAR;
break;
case OPT_ANSI:
cfg->method |= METHOD_SEED;
cfg->seed_algo = SEED_ANSI;
if (arg) {
if (!ansi_seed_valid(arg)) {
argp_failure(
state, 1, 0,
"SEED must be at least 160 bits (40 characters).");
}
cfg->seed = arg;
}
break;
case OPT_BRAINPOOL:
cfg->method |= METHOD_SEED;
cfg->seed_algo = SEED_BRAINPOOL;
if (arg) {
if (!brainpool_seed_valid(arg)) {
argp_failure(
state, 1, 0,
"SEED must be exactly 160 bits (40 hex characters).");
}
cfg->seed = arg;
}
break;
case OPT_NUMS:
cfg->method |= METHOD_SEED;
cfg->seed_algo = SEED_NUMS;
break;
case OPT_BRAINPOOL_RFC:
cfg->method |= METHOD_SEED;
cfg->seed_algo = SEED_BRAINPOOL_RFC;
if (arg) {
if (!brainpool_seed_valid(arg)) {
argp_failure(
state, 1, 0,
"SEED must be exactly 160 bits (40 hex characters).");
}
cfg->seed = arg;
}
break;
case OPT_TWIST:
cfg->method |= METHOD_TWIST;
break;
/* Generation options */
case OPT_COUNT:
cfg->count = strtoul(arg, NULL, 10);
break;
case OPT_RANDOM:
if (arg) {
char *token = strtok(arg, ",");
while (token) {
if (strcmp(token, "seed") == 0) {
cfg->random |= RANDOM_SEED;
} else if (strcmp(token, "field") == 0) {
cfg->random |= RANDOM_FIELD;
} else if (strcmp(token, "a") == 0) {
cfg->random |= RANDOM_A;
} else if (strcmp(token, "b") == 0) {
cfg->random |= RANDOM_B;
} else if (strcmp(token, "equation") == 0) {
cfg->random |= RANDOM_EQUATION;
} else {
argp_failure(state, 1, 0, "Wrong value for random = %s",
token);
}
token = strtok(NULL, ",");
}
} else {
cfg->random = RANDOM_ALL;
}
break;
case OPT_PRIME:
cfg->prime = true;
break;
case OPT_SMOOTH:
cfg->smooth = true;
cfg->smooth_value = strtol(arg, NULL, 10);
break;
case OPT_COFACTOR:
cfg->cofactor = true;
cfg->cofactor_value = strtol(arg, NULL, 10);
break;
case OPT_KOBLITZ:
cfg->koblitz = true;
if (arg) {
cfg->koblitz_value = strtol(arg, NULL, 10);
if (cfg->koblitz_value != 0 && cfg->koblitz_value != 1) {
argp_failure(state, 1, 0, "Wrong value for a = %li",
cfg->koblitz_value);
}
}
break;
case OPT_UNIQUE:
cfg->unique = true;
break;
case OPT_HEXCHECK: {
char *str_start = arg;
if (strlen(arg) > 2) {
if (arg[0] == '0' && (arg[1] == 'x' || arg[1] == 'X')) {
str_start = arg + 2;
}
}
char *p = str_start;
while (*p != 0) {
char c = *p++;
if (!isxdigit(c)) {
argp_failure(
state, 1, 0,
"Hex check argument contains non hex char '%c'", c);
}
}
cfg->hex_check = str_start;
break;
}
case OPT_METADATA:
cfg->metadata = true;
break;
case OPT_POINTS: {
char *num_end;
long amount = strtol(arg, &num_end, 10);
cfg->points.amount = (size_t)amount;
if (strstr(num_end, "random") == num_end) {
cfg->points.type = POINTS_RANDOM;
} else if (strstr(num_end, "prime") == num_end) {
cfg->points.type = POINTS_PRIME;
} else if (strstr(num_end, "all") == num_end) {
cfg->points.type = POINTS_ALL;
} else if (strstr(num_end, "nonprime") == num_end) {
cfg->points.type = POINTS_NONPRIME;
} else if (strstr(num_end, "none") == num_end) {
cfg->points.type = POINTS_NONE;
} else {
argp_failure(state, 1, 0, "Unknown point type. %s", num_end);
}
break;
}
/* IO options */
case OPT_INPUT:
cfg->input = arg;
break;
case OPT_OUTPUT:
cfg->output = arg;
break;
case OPT_APPEND:
cfg->append = true;
break;
case OPT_VERBOSE:
cfg->verbose++;
if (arg) {
cfg->verbose_log = arg;
}
break;
/* Misc options */
case OPT_DATADIR:
cfg->datadir = arg;
break;
case OPT_MEMORY:
cfg->memory = cli_parse_memory(arg, state);
break;
case OPT_TSTACK:
cfg->thread_memory = cli_parse_memory(arg, state);
break;
case OPT_TIMEOUT:
cfg->timeout = cli_parse_time(arg, state);
break;
case OPT_THREADS:
if (!strcmp(arg, "auto") || !strcmp(arg, "AUTO")) {
long nprocs = sysconf(_SC_NPROCESSORS_ONLN);
if (nprocs > 0) {
cfg->threads = (unsigned long)nprocs;
}
} else {
cfg->threads = strtoul(arg, NULL, 10);
if (!cfg->threads) {
argp_failure(state, 1, 0,
"Invalid number of threads specified.");
}
}
break;
/* Args */
case ARGP_KEY_ARG:
if (state->arg_num >= 1) {
argp_usage(state);
}
char *bits_end = NULL;
cfg->bits = strtoul(arg, &bits_end, 10);
if (*bits_end != '\0') {
argp_failure(state, 1, 0, "Invalid bit size specified.");
}
cfg->hex_digits =
2 * (cfg->bits / 8 + (cfg->bits % 8 != 0 ? 1 : 0));
break;
case ARGP_KEY_END:
cli_end(state);
break;
case ARGP_KEY_NO_ARGS:
argp_usage(state);
break;
default:
return ARGP_ERR_UNKNOWN;
}
return 0;
}
char *cli_filter(int key, const char *text, void *input) {
return (char *)text;
}
void cli_quit() { regfree(&re_cm_order); }
|
