2 * Copyright 2004-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 #include <openssl/opensslconf.h>
12 NON_EMPTY_TRANSLATION_UNIT
18 # include <openssl/conf.h>
19 # include <openssl/bio.h>
20 # include <openssl/err.h>
21 # include <openssl/txt_db.h>
22 # include <openssl/buffer.h>
23 # include <openssl/srp.h>
26 # define BASE_SECTION "srp"
27 # define CONFIG_FILE "openssl.cnf"
29 # define ENV_RANDFILE "RANDFILE"
31 # define ENV_DATABASE "srpvfile"
32 # define ENV_DEFAULT_SRP "default_srp"
34 static int get_index(CA_DB *db, char *id, char type)
40 if (type == DB_SRP_INDEX)
41 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
42 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
43 if (pp[DB_srptype][0] == DB_SRP_INDEX
44 && strcmp(id, pp[DB_srpid]) == 0)
47 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
48 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
50 if (pp[DB_srptype][0] != DB_SRP_INDEX
51 && strcmp(id, pp[DB_srpid]) == 0)
58 static void print_entry(CA_DB *db, int indx, int verbose, char *s)
60 if (indx >= 0 && verbose) {
62 char **pp = sk_OPENSSL_PSTRING_value(db->db->data, indx);
63 BIO_printf(bio_err, "%s \"%s\"\n", s, pp[DB_srpid]);
64 for (j = 0; j < DB_NUMBER; j++) {
65 BIO_printf(bio_err, " %d = \"%s\"\n", j, pp[j]);
70 static void print_index(CA_DB *db, int indexindex, int verbose)
72 print_entry(db, indexindex, verbose, "g N entry");
75 static void print_user(CA_DB *db, int userindex, int verbose)
78 char **pp = sk_OPENSSL_PSTRING_value(db->db->data, userindex);
80 if (pp[DB_srptype][0] != 'I') {
81 print_entry(db, userindex, verbose, "User entry");
82 print_entry(db, get_index(db, pp[DB_srpgN], 'I'), verbose,
89 static int update_index(CA_DB *db, char **row)
94 irow = app_malloc(sizeof(*irow) * (DB_NUMBER + 1), "row pointers");
95 for (i = 0; i < DB_NUMBER; i++) {
99 irow[DB_NUMBER] = NULL;
101 if (!TXT_DB_insert(db->db, irow)) {
102 BIO_printf(bio_err, "failed to update srpvfile\n");
103 BIO_printf(bio_err, "TXT_DB error number %ld\n", db->db->error);
110 static void lookup_fail(const char *name, const char *tag)
112 BIO_printf(bio_err, "variable lookup failed for %s::%s\n", name, tag);
115 static char *srp_verify_user(const char *user, const char *srp_verifier,
116 char *srp_usersalt, const char *g, const char *N,
117 const char *passin, int verbose)
121 char *verifier = NULL;
124 cb_tmp.prompt_info = user;
125 cb_tmp.password = passin;
127 if (password_callback(password, 1024, 0, &cb_tmp) > 0) {
130 "Validating\n user=\"%s\"\n srp_verifier=\"%s\"\n srp_usersalt=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",
131 user, srp_verifier, srp_usersalt, g, N);
132 BIO_printf(bio_err, "Pass %s\n", password);
134 OPENSSL_assert(srp_usersalt != NULL);
137 SRP_create_verifier(user, password, &srp_usersalt, &verifier, N,
139 BIO_printf(bio_err, "Internal error validating SRP verifier\n");
141 if (strcmp(verifier, srp_verifier))
143 OPENSSL_free(verifier);
149 static char *srp_create_user(char *user, char **srp_verifier,
150 char **srp_usersalt, char *g, char *N,
151 char *passout, int verbose)
157 cb_tmp.prompt_info = user;
158 cb_tmp.password = passout;
160 if (password_callback(password, 1024, 1, &cb_tmp) > 0) {
162 BIO_printf(bio_err, "Creating\n user=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",
166 SRP_create_verifier(user, password, &salt, srp_verifier, N,
168 BIO_printf(bio_err, "Internal error creating SRP verifier\n");
170 *srp_usersalt = salt;
172 BIO_printf(bio_err, "gNid=%s salt =\"%s\"\n verifier =\"%s\"\n", gNid,
173 salt, *srp_verifier);
179 typedef enum OPTION_choice {
180 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
181 OPT_VERBOSE, OPT_CONFIG, OPT_NAME, OPT_SRPVFILE, OPT_ADD,
182 OPT_DELETE, OPT_MODIFY, OPT_LIST, OPT_GN, OPT_USERINFO,
183 OPT_PASSIN, OPT_PASSOUT, OPT_ENGINE
186 OPTIONS srp_options[] = {
187 {"help", OPT_HELP, '-', "Display this summary"},
188 {"verbose", OPT_VERBOSE, '-', "Talk a lot while doing things"},
189 {"config", OPT_CONFIG, '<', "A config file"},
190 {"name", OPT_NAME, 's', "The particular srp definition to use"},
191 {"srpvfile", OPT_SRPVFILE, '<', "The srp verifier file name"},
192 {"add", OPT_ADD, '-', "Add a user and srp verifier"},
193 {"modify", OPT_MODIFY, '-',
194 "Modify the srp verifier of an existing user"},
195 {"delete", OPT_DELETE, '-', "Delete user from verifier file"},
196 {"list", OPT_LIST, '-', "List users"},
197 {"gn", OPT_GN, 's', "Set g and N values to be used for new verifier"},
198 {"userinfo", OPT_USERINFO, 's', "Additional info to be set for user"},
199 {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
200 {"passout", OPT_PASSOUT, 's', "Output file pass phrase source"},
201 # ifndef OPENSSL_NO_ENGINE
202 {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
207 int srp_main(int argc, char **argv)
211 int gNindex = -1, maxgN = -1, ret = 1, errors = 0, verbose = 0, i;
212 int doupdatedb = 0, mode = OPT_ERR;
213 char *user = NULL, *passinarg = NULL, *passoutarg = NULL;
214 char *passin = NULL, *passout = NULL, *gN = NULL, *userinfo = NULL;
215 char *randfile = NULL, *section = NULL;
216 char **gNrow = NULL, *configfile = NULL;
217 char *srpvfile = NULL, **pp, *prog;
220 prog = opt_init(argc, argv, srp_options);
221 while ((o = opt_next()) != OPT_EOF) {
226 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
229 opt_help(srp_options);
236 configfile = opt_arg();
242 srpvfile = opt_arg();
248 if (mode != OPT_ERR) {
250 "%s: Only one of -add/delete-modify/-list\n",
260 userinfo = opt_arg();
263 passinarg = opt_arg();
266 passoutarg = opt_arg();
269 (void)setup_engine(opt_arg(), 0);
273 argc = opt_num_rest();
276 if (srpvfile && configfile) {
278 "-srpvfile and -configfile cannot be specified together.\n");
281 if (mode == OPT_ERR) {
283 "Exactly one of the options -add, -delete, -modify -list must be specified.\n");
286 if ((mode == OPT_DELETE || mode == OPT_MODIFY || mode == OPT_ADD)
289 "Need at least one user for options -add, -delete, -modify. \n");
292 if ((passin || passout) && argc != 1) {
294 "-passin, -passout arguments only valid with one user.\n");
298 if (!app_passwd(passinarg, passoutarg, &passin, &passout)) {
299 BIO_printf(bio_err, "Error getting passwords\n");
305 configfile = default_config_file;
308 BIO_printf(bio_err, "Using configuration from %s\n",
310 conf = app_load_config(configfile);
313 if (configfile != default_config_file && !app_load_modules(conf))
316 /* Lets get the config section we are using */
317 if (section == NULL) {
320 "trying to read " ENV_DEFAULT_SRP
321 " in " BASE_SECTION "\n");
323 section = NCONF_get_string(conf, BASE_SECTION, ENV_DEFAULT_SRP);
324 if (section == NULL) {
325 lookup_fail(BASE_SECTION, ENV_DEFAULT_SRP);
330 if (randfile == NULL && conf)
331 randfile = NCONF_get_string(conf, BASE_SECTION, "RANDFILE");
335 "trying to read " ENV_DATABASE " in section \"%s\"\n",
338 if ((srpvfile = NCONF_get_string(conf, section, ENV_DATABASE))
340 lookup_fail(section, ENV_DATABASE);
345 if (randfile == NULL)
348 app_RAND_load_file(randfile, 0);
351 BIO_printf(bio_err, "Trying to read SRP verifier file \"%s\"\n",
354 db = load_index(srpvfile, NULL);
358 /* Lets check some fields */
359 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
360 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
362 if (pp[DB_srptype][0] == DB_SRP_INDEX) {
364 if ((gNindex < 0) && (gN != NULL) && strcmp(gN, pp[DB_srpid]) == 0)
367 print_index(db, i, verbose > 1);
372 BIO_printf(bio_err, "Database initialised\n");
375 gNrow = sk_OPENSSL_PSTRING_value(db->db->data, gNindex);
376 print_entry(db, gNindex, verbose > 1, "Default g and N");
377 } else if (maxgN > 0 && !SRP_get_default_gN(gN)) {
378 BIO_printf(bio_err, "No g and N value for index \"%s\"\n", gN);
382 BIO_printf(bio_err, "Database has no g N information.\n");
387 BIO_printf(bio_err, "Starting user processing\n");
392 while (mode == OPT_LIST || user) {
396 BIO_printf(bio_err, "Processing user \"%s\"\n", user);
397 if ((userindex = get_index(db, user, 'U')) >= 0) {
398 print_user(db, userindex, (verbose > 0)
399 || mode == OPT_LIST);
402 if (mode == OPT_LIST) {
404 BIO_printf(bio_err, "List all users\n");
406 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
407 print_user(db, i, 1);
409 } else if (userindex < 0) {
411 "user \"%s\" does not exist, ignored. t\n", user);
414 } else if (mode == OPT_ADD) {
415 if (userindex >= 0) {
416 /* reactivation of a new user */
418 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
419 BIO_printf(bio_err, "user \"%s\" reactivated.\n", user);
420 row[DB_srptype][0] = 'V';
424 char *row[DB_NUMBER];
426 row[DB_srpverifier] = NULL;
427 row[DB_srpsalt] = NULL;
428 row[DB_srpinfo] = NULL;
431 srp_create_user(user, &(row[DB_srpverifier]),
433 gNrow ? gNrow[DB_srpsalt] : gN,
434 gNrow ? gNrow[DB_srpverifier] : NULL,
435 passout, verbose))) {
437 "Cannot create srp verifier for user \"%s\", operation abandoned .\n",
442 row[DB_srpid] = OPENSSL_strdup(user);
443 row[DB_srptype] = OPENSSL_strdup("v");
444 row[DB_srpgN] = OPENSSL_strdup(gNid);
446 if ((row[DB_srpid] == NULL)
447 || (row[DB_srpgN] == NULL)
448 || (row[DB_srptype] == NULL)
449 || (row[DB_srpverifier] == NULL)
450 || (row[DB_srpsalt] == NULL)
452 && ((row[DB_srpinfo] = OPENSSL_strdup(userinfo)) == NULL))
453 || !update_index(db, row)) {
454 OPENSSL_free(row[DB_srpid]);
455 OPENSSL_free(row[DB_srpgN]);
456 OPENSSL_free(row[DB_srpinfo]);
457 OPENSSL_free(row[DB_srptype]);
458 OPENSSL_free(row[DB_srpverifier]);
459 OPENSSL_free(row[DB_srpsalt]);
464 } else if (mode == OPT_MODIFY) {
467 "user \"%s\" does not exist, operation ignored.\n",
473 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
474 char type = row[DB_srptype][0];
477 "user \"%s\" already updated, operation ignored.\n",
483 if (row[DB_srptype][0] == 'V') {
488 "Verifying password for user \"%s\"\n",
491 get_index(db, row[DB_srpgN], DB_SRP_INDEX)) >= 0)
493 sk_OPENSSL_PSTRING_value(db->db->data,
497 (user, row[DB_srpverifier], row[DB_srpsalt],
498 irow ? irow[DB_srpsalt] : row[DB_srpgN],
499 irow ? irow[DB_srpverifier] : NULL, passin,
502 "Invalid password for user \"%s\", operation abandoned.\n",
509 BIO_printf(bio_err, "Password for user \"%s\" ok.\n",
514 srp_create_user(user, &(row[DB_srpverifier]),
516 gNrow ? gNrow[DB_srpsalt] : NULL,
517 gNrow ? gNrow[DB_srpverifier] : NULL,
518 passout, verbose))) {
520 "Cannot create srp verifier for user \"%s\", operation abandoned.\n",
526 row[DB_srptype][0] = 'v';
527 row[DB_srpgN] = OPENSSL_strdup(gNid);
529 if (row[DB_srpid] == NULL
530 || row[DB_srpgN] == NULL
531 || row[DB_srptype] == NULL
532 || row[DB_srpverifier] == NULL
533 || row[DB_srpsalt] == NULL
535 && ((row[DB_srpinfo] = OPENSSL_strdup(userinfo))
542 } else if (mode == OPT_DELETE) {
545 "user \"%s\" does not exist, operation ignored. t\n",
549 char **xpp = sk_OPENSSL_PSTRING_value(db->db->data, userindex);
551 BIO_printf(bio_err, "user \"%s\" revoked. t\n", user);
552 xpp[DB_srptype][0] = 'R';
564 BIO_printf(bio_err, "User procession done.\n");
567 /* Lets check some fields */
568 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
569 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
571 if (pp[DB_srptype][0] == 'v') {
572 pp[DB_srptype][0] = 'V';
573 print_user(db, i, verbose);
578 BIO_printf(bio_err, "Trying to update srpvfile.\n");
579 if (!save_index(srpvfile, "new", db))
583 BIO_printf(bio_err, "Temporary srpvfile created.\n");
584 if (!rotate_index(srpvfile, "new", "old"))
588 BIO_printf(bio_err, "srpvfile updated.\n");
595 BIO_printf(bio_err, "User errors %d.\n", errors);
598 BIO_printf(bio_err, "SRP terminating with code %d.\n", ret);
600 OPENSSL_free(passin);
601 OPENSSL_free(passout);
603 ERR_print_errors(bio_err);
605 app_RAND_write_file(randfile);