aboutsummaryrefslogtreecommitdiff
path: root/src/io/cli.c
blob: efebfbc3d647df6e8e910d724d4dff11ae4685d7 (plain)
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
/*
 * ecgen, tool for generating Elliptic curve domain parameters
 * Copyright (C) 2017 J08nY
 */
#include "cli.h"
#include <string.h>

char doc[] =
    "ecgen, tool for generating Elliptic curve domain parameters.\v(C) 2017 "
    "Eastern Seaboard Phishing Authority";
char args_doc[] = "bits";

enum opt_keys {
	OPT_DATADIR = 'd',
	OPT_COUNT = 'c',
	OPT_PRIME = 'p',
	OPT_COFACTOR = 'k',
	OPT_RANDOM = 'r',
	OPT_SEED = 's',
	OPT_INVALID = 'i',
	OPT_ORDER = 'n',
	OPT_KOBLITZ = 'K',
	OPT_UNIQUE = 'u',
	OPT_FORMAT = 't',
	OPT_OUTPUT = 'o',
	OPT_INPUT = 'f',
	OPT_APPEND = 'a',
	OPT_VERBOSE = 'v',
	OPT_FP = 1,
	OPT_F2M,
	OPT_POINTS
};

// clang-format off
struct argp_option 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 options:",                                                                  2},
	{"random",   OPT_RANDOM,   0,        0,                 "Generate a random curve (using Random approach).",                                     2},
	{"prime",    OPT_PRIME,    0,        0,                 "Generate a curve with prime order.",                                                   2},
	{"cofactor", OPT_COFACTOR, "BOUND",  0,                 "Generate a curve with cofactor up to BOUND.",                                          2},
	{"seed",     OPT_SEED,     "SEED", OPTION_ARG_OPTIONAL, "Generate a curve from SEED (ANSI X9.62 verifiable procedure).",                        2},
	{"invalid",  OPT_INVALID,  0,        0,                 "Generate a set of invalid curves, for a given curve (using Invalid curve algorithm).", 2},
	{"order",    OPT_ORDER,    "ORDER",  0,                 "Generate a curve with given order (using Complex Multiplication).",                    2},
	{"koblitz",  OPT_KOBLITZ,  0,        0,                 "Generate a Koblitz curve (a = 0).",                                                    2},
	{"unique",   OPT_UNIQUE,   0,        0,                 "Generate a curve with only one generator.",                                            2},
	{"points",   OPT_POINTS,   "TYPE",   0,                 "Generate points of given type (random/prime).",                                        2},
	{"count",    OPT_COUNT,    "COUNT",  0,                 "Generate multiple curves.",                                                            2},
	{0,          0,            0,        0,                 "Input/Output options:",                                                                3},
	{"format",   OPT_FORMAT,   "FORMAT", 0,                 "Format to output in. One of [csv,json], default is json.",                             3},
	{"input",    OPT_INPUT,    "FILE",   0,                 "Input from file.",                                                                     3},
	{"output",   OPT_OUTPUT,   "FILE",   0,                 "Output into file. Overwrites any existing file!",                                      3},
	{"append",   OPT_APPEND,   0,        0,                 "Append to output file (don't overwrite).",                                             3},
	{"verbose",  OPT_VERBOSE,  "FILE", OPTION_ARG_OPTIONAL, "Verbose logging (to stdout or file).",                                                 3},
	{0,          0,            0,        0,                 "Other:",                                                                               4},
	{"data-dir", OPT_DATADIR,  "DIR",    0,                 "PARI/GP data directory (containing seadata package).",                                 4},
	{0}
};
// clang-format on

error_t cli_parse(int key, char *arg, struct argp_state *state) {
	struct config_t *cfg = state->input;

	switch (key) {
		case OPT_DATADIR:
			cfg->datadir = arg;
			break;
		case OPT_COUNT:
			if (arg) {
				cfg->count = strtol(arg, NULL, 10);
			}
			break;
		case OPT_FORMAT:
			if (arg) {
				if (!strcmp(arg, "csv")) {
					cfg->format = FORMAT_CSV;
				} else if (!strcmp(arg, "json")) {
					cfg->format = FORMAT_JSON;
				} else {
					argp_failure(state, 1, 0,
					             "Invalid format specified. One of [csv, json] "
					             "is valid.");
				}
			} else {
				argp_failure(
				    state, 1, 0,
				    "You have to specify a format with the format option.");
			}
			break;
		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->debug = arg;
			}
			break;
		case OPT_RANDOM:
			cfg->random = true;
			break;
		case OPT_PRIME:
			cfg->prime = true;
			break;
		case OPT_COFACTOR:
			cfg->cofactor = true;
			if (arg) {
				cfg->cofactor_bound = strtol(arg, NULL, 10);
			}
		case OPT_INVALID:
			cfg->invalid = true;
			break;
		case OPT_ORDER:
			cfg->cm = true;
			if (arg) {
				cfg->order = arg;
			}
			break;
		case OPT_KOBLITZ:
			cfg->koblitz = true;
			break;
		case OPT_UNIQUE:
			cfg->unique = true;
			break;
		case OPT_POINTS:
			if (arg) {
				if (strstr(arg, "random")) {
					long pts = strtol(arg, NULL, 10);
					cfg->points.type = POINTS_RANDOM;
					cfg->points.amount = (size_t)pts;
				} else if (strstr(arg, "prime")) {
					cfg->points.type = POINTS_PRIME;
				} else {
					argp_failure(state, 1, 0, "Unknow point type");
				}
			} else {
				argp_failure(state, 1, 0,
				             "You have to specify what points you want.");
			}
			break;
		case OPT_SEED:
			cfg->from_seed = true;
			if (arg) {
				// ANSI X9.62 specifies seed as at least 160 bits in length.
				if (strlen(arg) < 20) {
					argp_failure(
					    state, 1, 0,
					    "SEED must be at least 160 bits (20 characters).");
				}
				cfg->seed = arg;
			}
			break;
		case OPT_FP:
			cfg->field = FIELD_PRIME;
			cfg->prime_field = true;
			break;
		case OPT_F2M:
			cfg->field = FIELD_BINARY;
			cfg->binary_field = true;
			break;
		case ARGP_KEY_ARG:
			if (state->arg_num >= 1) {
				argp_usage(state);
			}

			cfg->bits = strtol(arg, NULL, 10);
			break;
		case ARGP_KEY_END:
			// validate all option states here.
			// Only one field
			if (!cfg->prime_field && !cfg->binary_field) {
				argp_failure(state, 1, 0,
				             "Specify field type, prime or binary, with --fp / "
				             "--f2m (but not both).");
			}
			// Invalid is not prime or seed by definition.
			if (cfg->invalid &&
			    (cfg->prime || cfg->from_seed || cfg->cofactor)) {
				// not seed, not prime
				argp_failure(state, 1, 0,
				             "Invalid curve generation can not generate curves "
				             "from seed, exhaustive or prime order.");
			}
			if (cfg->cm && (cfg->prime || cfg->from_seed || cfg->invalid ||
			                cfg->cofactor)) {
				argp_failure(state, 1, 0,
				             "Fixed order curve generation can not generate "
				             "curves from seed, or invalid curves. Prime order "
				             "also doesn't make sense if the given one isn't "
				             "prime.");
			}
			// default values
			if (!cfg->count) {
				cfg->count = 1;
			}
			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;
}