2 * Copyright 2004-2018 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2004, EdelKey Project. All Rights Reserved.
5 * Licensed under the Apache License 2.0 (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or at
8 * https://www.openssl.org/source/license.html
10 * Originally written by Christophe Renou and Peter Sylvester,
11 * for the EdelKey project.
14 #include <openssl/opensslconf.h>
16 NON_EMPTY_TRANSLATION_UNIT
22 # include <openssl/conf.h>
23 # include <openssl/bio.h>
24 # include <openssl/err.h>
25 # include <openssl/txt_db.h>
26 # include <openssl/buffer.h>
27 # include <openssl/srp.h>
31 # define BASE_SECTION "srp"
32 # define CONFIG_FILE "openssl.cnf"
35 # define ENV_DATABASE "srpvfile"
36 # define ENV_DEFAULT_SRP "default_srp"
38 static int get_index(CA_DB *db, char *id, char type)
44 if (type == DB_SRP_INDEX) {
45 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
46 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
47 if (pp[DB_srptype][0] == DB_SRP_INDEX
48 && strcmp(id, pp[DB_srpid]) == 0)
52 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
53 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
55 if (pp[DB_srptype][0] != DB_SRP_INDEX
56 && strcmp(id, pp[DB_srpid]) == 0)
64 static void print_entry(CA_DB *db, int indx, int verbose, char *s)
66 if (indx >= 0 && verbose) {
68 char **pp = sk_OPENSSL_PSTRING_value(db->db->data, indx);
69 BIO_printf(bio_err, "%s \"%s\"\n", s, pp[DB_srpid]);
70 for (j = 0; j < DB_NUMBER; j++) {
71 BIO_printf(bio_err, " %d = \"%s\"\n", j, pp[j]);
76 static void print_index(CA_DB *db, int indexindex, int verbose)
78 print_entry(db, indexindex, verbose, "g N entry");
81 static void print_user(CA_DB *db, int userindex, int verbose)
84 char **pp = sk_OPENSSL_PSTRING_value(db->db->data, userindex);
86 if (pp[DB_srptype][0] != 'I') {
87 print_entry(db, userindex, verbose, "User entry");
88 print_entry(db, get_index(db, pp[DB_srpgN], 'I'), verbose,
95 static int update_index(CA_DB *db, char **row)
100 irow = app_malloc(sizeof(*irow) * (DB_NUMBER + 1), "row pointers");
101 for (i = 0; i < DB_NUMBER; i++)
103 irow[DB_NUMBER] = NULL;
105 if (!TXT_DB_insert(db->db, irow)) {
106 BIO_printf(bio_err, "failed to update srpvfile\n");
107 BIO_printf(bio_err, "TXT_DB error number %ld\n", db->db->error);
114 static char *lookup_conf(const CONF *conf, const char *section, const char *tag)
116 char *entry = NCONF_get_string(conf, section, tag);
118 BIO_printf(bio_err, "variable lookup failed for %s::%s\n", section, tag);
122 static char *srp_verify_user(const char *user, const char *srp_verifier,
123 char *srp_usersalt, const char *g, const char *N,
124 const char *passin, int verbose)
128 char *verifier = NULL;
132 cb_tmp.prompt_info = user;
133 cb_tmp.password = passin;
135 len = password_callback(password, sizeof(password)-1, 0, &cb_tmp);
140 "Validating\n user=\"%s\"\n srp_verifier=\"%s\"\n srp_usersalt=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",
141 user, srp_verifier, srp_usersalt, g, N);
143 BIO_printf(bio_err, "Pass %s\n", password);
145 OPENSSL_assert(srp_usersalt != NULL);
146 if ((gNid = SRP_create_verifier(user, password, &srp_usersalt,
147 &verifier, N, g)) == NULL) {
148 BIO_printf(bio_err, "Internal error validating SRP verifier\n");
150 if (strcmp(verifier, srp_verifier))
152 OPENSSL_free(verifier);
154 OPENSSL_cleanse(password, len);
159 static char *srp_create_user(char *user, char **srp_verifier,
160 char **srp_usersalt, char *g, char *N,
161 char *passout, int verbose)
168 cb_tmp.prompt_info = user;
169 cb_tmp.password = passout;
171 len = password_callback(password, sizeof(password)-1, 1, &cb_tmp);
175 BIO_printf(bio_err, "Creating\n user=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",
177 if ((gNid = SRP_create_verifier(user, password, &salt,
178 srp_verifier, N, g)) == NULL) {
179 BIO_printf(bio_err, "Internal error creating SRP verifier\n");
181 *srp_usersalt = salt;
183 OPENSSL_cleanse(password, len);
185 BIO_printf(bio_err, "gNid=%s salt =\"%s\"\n verifier =\"%s\"\n",
186 gNid, salt, *srp_verifier);
192 typedef enum OPTION_choice {
193 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
194 OPT_VERBOSE, OPT_CONFIG, OPT_NAME, OPT_SRPVFILE, OPT_ADD,
195 OPT_DELETE, OPT_MODIFY, OPT_LIST, OPT_GN, OPT_USERINFO,
196 OPT_PASSIN, OPT_PASSOUT, OPT_ENGINE, OPT_R_ENUM
199 const OPTIONS srp_options[] = {
200 OPT_SECTION("General"),
201 {"help", OPT_HELP, '-', "Display this summary"},
202 {"verbose", OPT_VERBOSE, '-', "Talk a lot while doing things"},
203 {"config", OPT_CONFIG, '<', "A config file"},
204 {"name", OPT_NAME, 's', "The particular srp definition to use"},
205 # ifndef OPENSSL_NO_ENGINE
206 {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
209 OPT_SECTION("Action"),
210 {"add", OPT_ADD, '-', "Add a user and srp verifier"},
211 {"modify", OPT_MODIFY, '-', "Modify the srp verifier of an existing user"},
212 {"delete", OPT_DELETE, '-', "Delete user from verifier file"},
213 {"list", OPT_LIST, '-', "List users"},
215 OPT_SECTION("Configuration"),
216 {"srpvfile", OPT_SRPVFILE, '<', "The srp verifier file name"},
217 {"gn", OPT_GN, 's', "Set g and N values to be used for new verifier"},
218 {"userinfo", OPT_USERINFO, 's', "Additional info to be set for user"},
219 {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
220 {"passout", OPT_PASSOUT, 's', "Output file pass phrase source"},
226 int srp_main(int argc, char **argv)
231 int gNindex = -1, maxgN = -1, ret = 1, errors = 0, verbose = 0, i;
232 int doupdatedb = 0, mode = OPT_ERR;
233 char *user = NULL, *passinarg = NULL, *passoutarg = NULL;
234 char *passin = NULL, *passout = NULL, *gN = NULL, *userinfo = NULL;
235 char *section = NULL;
236 char **gNrow = NULL, *configfile = NULL;
237 char *srpvfile = NULL, **pp, *prog;
240 prog = opt_init(argc, argv, srp_options);
241 while ((o = opt_next()) != OPT_EOF) {
246 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
249 opt_help(srp_options);
256 configfile = opt_arg();
262 srpvfile = opt_arg();
268 if (mode != OPT_ERR) {
270 "%s: Only one of -add/-delete/-modify/-list\n",
280 userinfo = opt_arg();
283 passinarg = opt_arg();
286 passoutarg = opt_arg();
289 e = setup_engine(opt_arg(), 0);
297 argc = opt_num_rest();
300 if (srpvfile != NULL && configfile != NULL) {
302 "-srpvfile and -configfile cannot be specified together.\n");
305 if (mode == OPT_ERR) {
307 "Exactly one of the options -add, -delete, -modify -list must be specified.\n");
310 if (mode == OPT_DELETE || mode == OPT_MODIFY || mode == OPT_ADD) {
312 BIO_printf(bio_err, "Need at least one user.\n");
317 if ((passinarg != NULL || passoutarg != NULL) && argc != 1) {
319 "-passin, -passout arguments only valid with one user.\n");
323 if (!app_passwd(passinarg, passoutarg, &passin, &passout)) {
324 BIO_printf(bio_err, "Error getting passwords\n");
328 if (srpvfile == NULL) {
329 if (configfile == NULL)
330 configfile = default_config_file;
333 BIO_printf(bio_err, "Using configuration from %s\n",
335 conf = app_load_config(configfile);
338 if (configfile != default_config_file && !app_load_modules(conf))
341 /* Lets get the config section we are using */
342 if (section == NULL) {
345 "trying to read " ENV_DEFAULT_SRP
346 " in " BASE_SECTION "\n");
348 section = lookup_conf(conf, BASE_SECTION, ENV_DEFAULT_SRP);
353 app_RAND_load_conf(conf, BASE_SECTION);
357 "trying to read " ENV_DATABASE " in section \"%s\"\n",
360 srpvfile = lookup_conf(conf, section, ENV_DATABASE);
361 if (srpvfile == NULL)
366 BIO_printf(bio_err, "Trying to read SRP verifier file \"%s\"\n",
369 db = load_index(srpvfile, NULL);
373 /* Lets check some fields */
374 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
375 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
377 if (pp[DB_srptype][0] == DB_SRP_INDEX) {
379 if ((gNindex < 0) && (gN != NULL) && strcmp(gN, pp[DB_srpid]) == 0)
382 print_index(db, i, verbose > 1);
387 BIO_printf(bio_err, "Database initialised\n");
390 gNrow = sk_OPENSSL_PSTRING_value(db->db->data, gNindex);
391 print_entry(db, gNindex, verbose > 1, "Default g and N");
392 } else if (maxgN > 0 && !SRP_get_default_gN(gN)) {
393 BIO_printf(bio_err, "No g and N value for index \"%s\"\n", gN);
397 BIO_printf(bio_err, "Database has no g N information.\n");
402 BIO_printf(bio_err, "Starting user processing\n");
404 while (mode == OPT_LIST || user != NULL) {
407 if (user != NULL && verbose > 1)
408 BIO_printf(bio_err, "Processing user \"%s\"\n", user);
409 if ((userindex = get_index(db, user, 'U')) >= 0)
410 print_user(db, userindex, (verbose > 0) || mode == OPT_LIST);
412 if (mode == OPT_LIST) {
414 BIO_printf(bio_err, "List all users\n");
416 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++)
417 print_user(db, i, 1);
418 } else if (userindex < 0) {
420 "user \"%s\" does not exist, ignored. t\n", user);
423 } else if (mode == OPT_ADD) {
424 if (userindex >= 0) {
425 /* reactivation of a new user */
427 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
428 BIO_printf(bio_err, "user \"%s\" reactivated.\n", user);
429 row[DB_srptype][0] = 'V';
433 char *row[DB_NUMBER];
435 row[DB_srpverifier] = NULL;
436 row[DB_srpsalt] = NULL;
437 row[DB_srpinfo] = NULL;
440 srp_create_user(user, &(row[DB_srpverifier]),
442 gNrow ? gNrow[DB_srpsalt] : gN,
443 gNrow ? gNrow[DB_srpverifier] : NULL,
444 passout, verbose))) {
446 "Cannot create srp verifier for user \"%s\", operation abandoned .\n",
451 row[DB_srpid] = OPENSSL_strdup(user);
452 row[DB_srptype] = OPENSSL_strdup("v");
453 row[DB_srpgN] = OPENSSL_strdup(gNid);
455 if ((row[DB_srpid] == NULL)
456 || (row[DB_srpgN] == NULL)
457 || (row[DB_srptype] == NULL)
458 || (row[DB_srpverifier] == NULL)
459 || (row[DB_srpsalt] == NULL)
461 && ((row[DB_srpinfo] = OPENSSL_strdup(userinfo)) == NULL))
462 || !update_index(db, row)) {
463 OPENSSL_free(row[DB_srpid]);
464 OPENSSL_free(row[DB_srpgN]);
465 OPENSSL_free(row[DB_srpinfo]);
466 OPENSSL_free(row[DB_srptype]);
467 OPENSSL_free(row[DB_srpverifier]);
468 OPENSSL_free(row[DB_srpsalt]);
473 } else if (mode == OPT_MODIFY) {
476 "user \"%s\" does not exist, operation ignored.\n",
482 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
483 char type = row[DB_srptype][0];
486 "user \"%s\" already updated, operation ignored.\n",
492 if (row[DB_srptype][0] == 'V') {
497 "Verifying password for user \"%s\"\n",
500 get_index(db, row[DB_srpgN], DB_SRP_INDEX)) >= 0)
502 sk_OPENSSL_PSTRING_value(db->db->data,
506 (user, row[DB_srpverifier], row[DB_srpsalt],
507 irow ? irow[DB_srpsalt] : row[DB_srpgN],
508 irow ? irow[DB_srpverifier] : NULL, passin,
511 "Invalid password for user \"%s\", operation abandoned.\n",
518 BIO_printf(bio_err, "Password for user \"%s\" ok.\n",
523 srp_create_user(user, &(row[DB_srpverifier]),
525 gNrow ? gNrow[DB_srpsalt] : NULL,
526 gNrow ? gNrow[DB_srpverifier] : NULL,
527 passout, verbose))) {
529 "Cannot create srp verifier for user \"%s\", operation abandoned.\n",
535 row[DB_srptype][0] = 'v';
536 row[DB_srpgN] = OPENSSL_strdup(gNid);
538 if (row[DB_srpid] == NULL
539 || row[DB_srpgN] == NULL
540 || row[DB_srptype] == NULL
541 || row[DB_srpverifier] == NULL
542 || row[DB_srpsalt] == NULL
544 && ((row[DB_srpinfo] = OPENSSL_strdup(userinfo))
551 } else if (mode == OPT_DELETE) {
554 "user \"%s\" does not exist, operation ignored. t\n",
558 char **xpp = sk_OPENSSL_PSTRING_value(db->db->data, userindex);
560 BIO_printf(bio_err, "user \"%s\" revoked. t\n", user);
561 xpp[DB_srptype][0] = 'R';
567 /* no more processing in any mode if no users left */
573 BIO_printf(bio_err, "User procession done.\n");
576 /* Lets check some fields */
577 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
578 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
580 if (pp[DB_srptype][0] == 'v') {
581 pp[DB_srptype][0] = 'V';
582 print_user(db, i, verbose);
587 BIO_printf(bio_err, "Trying to update srpvfile.\n");
588 if (!save_index(srpvfile, "new", db))
592 BIO_printf(bio_err, "Temporary srpvfile created.\n");
593 if (!rotate_index(srpvfile, "new", "old"))
597 BIO_printf(bio_err, "srpvfile updated.\n");
604 BIO_printf(bio_err, "User errors %d.\n", errors);
607 BIO_printf(bio_err, "SRP terminating with code %d.\n", ret);
609 OPENSSL_free(passin);
610 OPENSSL_free(passout);
612 ERR_print_errors(bio_err);