2 * Written by Peter Sylvester (peter.sylvester@edelweb.fr) for the EdelKey
3 * project and contributed to the OpenSSL project 2004.
5 /* ====================================================================
6 * Copyright (c) 2004 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
59 #include <openssl/opensslconf.h>
61 NON_EMPTY_TRANSLATION_UNIT
67 # include <openssl/conf.h>
68 # include <openssl/bio.h>
69 # include <openssl/err.h>
70 # include <openssl/txt_db.h>
71 # include <openssl/buffer.h>
72 # include <openssl/srp.h>
75 # define BASE_SECTION "srp"
76 # define CONFIG_FILE "openssl.cnf"
78 # define ENV_RANDFILE "RANDFILE"
80 # define ENV_DATABASE "srpvfile"
81 # define ENV_DEFAULT_SRP "default_srp"
83 static int get_index(CA_DB *db, char *id, char type)
89 if (type == DB_SRP_INDEX)
90 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
91 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
92 if (pp[DB_srptype][0] == DB_SRP_INDEX
93 && strcmp(id, pp[DB_srpid]) == 0)
96 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
97 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
99 if (pp[DB_srptype][0] != DB_SRP_INDEX
100 && strcmp(id, pp[DB_srpid]) == 0)
107 static void print_entry(CA_DB *db, int indx, int verbose, char *s)
109 if (indx >= 0 && verbose) {
111 char **pp = sk_OPENSSL_PSTRING_value(db->db->data, indx);
112 BIO_printf(bio_err, "%s \"%s\"\n", s, pp[DB_srpid]);
113 for (j = 0; j < DB_NUMBER; j++) {
114 BIO_printf(bio_err, " %d = \"%s\"\n", j, pp[j]);
119 static void print_index(CA_DB *db, int indexindex, int verbose)
121 print_entry(db, indexindex, verbose, "g N entry");
124 static void print_user(CA_DB *db, int userindex, int verbose)
127 char **pp = sk_OPENSSL_PSTRING_value(db->db->data, userindex);
129 if (pp[DB_srptype][0] != 'I') {
130 print_entry(db, userindex, verbose, "User entry");
131 print_entry(db, get_index(db, pp[DB_srpgN], 'I'), verbose,
138 static int update_index(CA_DB *db, char **row)
143 irow = app_malloc(sizeof(*irow) * (DB_NUMBER + 1), "row pointers");
144 for (i = 0; i < DB_NUMBER; i++) {
148 irow[DB_NUMBER] = NULL;
150 if (!TXT_DB_insert(db->db, irow)) {
151 BIO_printf(bio_err, "failed to update srpvfile\n");
152 BIO_printf(bio_err, "TXT_DB error number %ld\n", db->db->error);
159 static void lookup_fail(const char *name, const char *tag)
161 BIO_printf(bio_err, "variable lookup failed for %s::%s\n", name, tag);
164 static char *srp_verify_user(const char *user, const char *srp_verifier,
165 char *srp_usersalt, const char *g, const char *N,
166 const char *passin, int verbose)
170 char *verifier = NULL;
173 cb_tmp.prompt_info = user;
174 cb_tmp.password = passin;
176 if (password_callback(password, 1024, 0, &cb_tmp) > 0) {
179 "Validating\n user=\"%s\"\n srp_verifier=\"%s\"\n srp_usersalt=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",
180 user, srp_verifier, srp_usersalt, g, N);
181 BIO_printf(bio_err, "Pass %s\n", password);
183 OPENSSL_assert(srp_usersalt != NULL);
186 SRP_create_verifier(user, password, &srp_usersalt, &verifier, N,
188 BIO_printf(bio_err, "Internal error validating SRP verifier\n");
190 if (strcmp(verifier, srp_verifier))
192 OPENSSL_free(verifier);
198 static char *srp_create_user(char *user, char **srp_verifier,
199 char **srp_usersalt, char *g, char *N,
200 char *passout, int verbose)
206 cb_tmp.prompt_info = user;
207 cb_tmp.password = passout;
209 if (password_callback(password, 1024, 1, &cb_tmp) > 0) {
211 BIO_printf(bio_err, "Creating\n user=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",
215 SRP_create_verifier(user, password, &salt, srp_verifier, N,
217 BIO_printf(bio_err, "Internal error creating SRP verifier\n");
219 *srp_usersalt = salt;
221 BIO_printf(bio_err, "gNid=%s salt =\"%s\"\n verifier =\"%s\"\n", gNid,
222 salt, *srp_verifier);
228 typedef enum OPTION_choice {
229 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
230 OPT_VERBOSE, OPT_CONFIG, OPT_NAME, OPT_SRPVFILE, OPT_ADD,
231 OPT_DELETE, OPT_MODIFY, OPT_LIST, OPT_GN, OPT_USERINFO,
232 OPT_PASSIN, OPT_PASSOUT, OPT_ENGINE
235 OPTIONS srp_options[] = {
236 {"help", OPT_HELP, '-', "Display this summary"},
237 {"verbose", OPT_VERBOSE, '-', "Talk a lot while doing things"},
238 {"config", OPT_CONFIG, '<', "A config file"},
239 {"name", OPT_NAME, 's', "The particular srp definition to use"},
240 {"srpvfile", OPT_SRPVFILE, '<', "The srp verifier file name"},
241 {"add", OPT_ADD, '-', "Add a user and srp verifier"},
242 {"modify", OPT_MODIFY, '-',
243 "Modify the srp verifier of an existing user"},
244 {"delete", OPT_DELETE, '-', "Delete user from verifier file"},
245 {"list", OPT_LIST, '-', "List users"},
246 {"gn", OPT_GN, 's', "Set g and N values to be used for new verifier"},
247 {"userinfo", OPT_USERINFO, 's', "Additional info to be set for user"},
248 {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
249 {"passout", OPT_PASSOUT, 's', "Output file pass phrase source"},
250 # ifndef OPENSSL_NO_ENGINE
251 {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
256 int srp_main(int argc, char **argv)
260 int gNindex = -1, maxgN = -1, ret = 1, errors = 0, verbose = 0, i;
261 int doupdatedb = 0, mode = OPT_ERR;
262 char *user = NULL, *passinarg = NULL, *passoutarg = NULL;
263 char *passin = NULL, *passout = NULL, *gN = NULL, *userinfo = NULL;
264 char *randfile = NULL, *tofree = NULL, *section = NULL;
265 char **gNrow = NULL, *configfile = NULL;
266 char *srpvfile = NULL, **pp, *prog;
269 prog = opt_init(argc, argv, srp_options);
270 while ((o = opt_next()) != OPT_EOF) {
275 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
278 opt_help(srp_options);
285 configfile = opt_arg();
291 srpvfile = opt_arg();
297 if (mode != OPT_ERR) {
299 "%s: Only one of -add/delete-modify/-list\n",
309 userinfo = opt_arg();
312 passinarg = opt_arg();
315 passoutarg = opt_arg();
318 (void)setup_engine(opt_arg(), 0);
322 argc = opt_num_rest();
325 if (srpvfile && configfile) {
327 "-srpvfile and -configfile cannot be specified together.\n");
330 if (mode == OPT_ERR) {
332 "Exactly one of the options -add, -delete, -modify -list must be specified.\n");
335 if ((mode == OPT_DELETE || mode == OPT_MODIFY || mode == OPT_ADD)
338 "Need at least one user for options -add, -delete, -modify. \n");
341 if ((passin || passout) && argc != 1) {
343 "-passin, -passout arguments only valid with one user.\n");
347 if (!app_passwd(passinarg, passoutarg, &passin, &passout)) {
348 BIO_printf(bio_err, "Error getting passwords\n");
354 configfile = default_config_file;
357 BIO_printf(bio_err, "Using configuration from %s\n",
359 conf = app_load_config(configfile);
362 if (configfile != default_config_file && !app_load_modules(conf))
365 /* Lets get the config section we are using */
366 if (section == NULL) {
369 "trying to read " ENV_DEFAULT_SRP
370 " in " BASE_SECTION "\n");
372 section = NCONF_get_string(conf, BASE_SECTION, ENV_DEFAULT_SRP);
373 if (section == NULL) {
374 lookup_fail(BASE_SECTION, ENV_DEFAULT_SRP);
379 if (randfile == NULL && conf)
380 randfile = NCONF_get_string(conf, BASE_SECTION, "RANDFILE");
384 "trying to read " ENV_DATABASE " in section \"%s\"\n",
387 if ((srpvfile = NCONF_get_string(conf, section, ENV_DATABASE))
389 lookup_fail(section, ENV_DATABASE);
394 if (randfile == NULL)
397 app_RAND_load_file(randfile, 0);
400 BIO_printf(bio_err, "Trying to read SRP verifier file \"%s\"\n",
403 db = load_index(srpvfile, NULL);
407 /* Lets check some fields */
408 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
409 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
411 if (pp[DB_srptype][0] == DB_SRP_INDEX) {
413 if ((gNindex < 0) && (gN != NULL) && strcmp(gN, pp[DB_srpid]) == 0)
416 print_index(db, i, verbose > 1);
421 BIO_printf(bio_err, "Database initialised\n");
424 gNrow = sk_OPENSSL_PSTRING_value(db->db->data, gNindex);
425 print_entry(db, gNindex, verbose > 1, "Default g and N");
426 } else if (maxgN > 0 && !SRP_get_default_gN(gN)) {
427 BIO_printf(bio_err, "No g and N value for index \"%s\"\n", gN);
431 BIO_printf(bio_err, "Database has no g N information.\n");
436 BIO_printf(bio_err, "Starting user processing\n");
441 while (mode == OPT_LIST || user) {
445 BIO_printf(bio_err, "Processing user \"%s\"\n", user);
446 if ((userindex = get_index(db, user, 'U')) >= 0) {
447 print_user(db, userindex, (verbose > 0)
448 || mode == OPT_LIST);
451 if (mode == OPT_LIST) {
453 BIO_printf(bio_err, "List all users\n");
455 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
456 print_user(db, i, 1);
458 } else if (userindex < 0) {
460 "user \"%s\" does not exist, ignored. t\n", user);
463 } else if (mode == OPT_ADD) {
464 if (userindex >= 0) {
465 /* reactivation of a new user */
467 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
468 BIO_printf(bio_err, "user \"%s\" reactivated.\n", user);
469 row[DB_srptype][0] = 'V';
473 char *row[DB_NUMBER];
475 row[DB_srpverifier] = NULL;
476 row[DB_srpsalt] = NULL;
477 row[DB_srpinfo] = NULL;
480 srp_create_user(user, &(row[DB_srpverifier]),
482 gNrow ? gNrow[DB_srpsalt] : gN,
483 gNrow ? gNrow[DB_srpverifier] : NULL,
484 passout, verbose))) {
486 "Cannot create srp verifier for user \"%s\", operation abandoned .\n",
491 row[DB_srpid] = OPENSSL_strdup(user);
492 row[DB_srptype] = OPENSSL_strdup("v");
493 row[DB_srpgN] = OPENSSL_strdup(gNid);
495 if ((row[DB_srpid] == NULL)
496 || (row[DB_srpgN] == NULL)
497 || (row[DB_srptype] == NULL)
498 || (row[DB_srpverifier] == NULL)
499 || (row[DB_srpsalt] == NULL)
501 && ((row[DB_srpinfo] = OPENSSL_strdup(userinfo)) == NULL))
502 || !update_index(db, row)) {
503 OPENSSL_free(row[DB_srpid]);
504 OPENSSL_free(row[DB_srpgN]);
505 OPENSSL_free(row[DB_srpinfo]);
506 OPENSSL_free(row[DB_srptype]);
507 OPENSSL_free(row[DB_srpverifier]);
508 OPENSSL_free(row[DB_srpsalt]);
513 } else if (mode == OPT_MODIFY) {
516 "user \"%s\" does not exist, operation ignored.\n",
522 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
523 char type = row[DB_srptype][0];
526 "user \"%s\" already updated, operation ignored.\n",
532 if (row[DB_srptype][0] == 'V') {
537 "Verifying password for user \"%s\"\n",
540 get_index(db, row[DB_srpgN], DB_SRP_INDEX)) >= 0)
542 sk_OPENSSL_PSTRING_value(db->db->data,
546 (user, row[DB_srpverifier], row[DB_srpsalt],
547 irow ? irow[DB_srpsalt] : row[DB_srpgN],
548 irow ? irow[DB_srpverifier] : NULL, passin,
551 "Invalid password for user \"%s\", operation abandoned.\n",
558 BIO_printf(bio_err, "Password for user \"%s\" ok.\n",
563 srp_create_user(user, &(row[DB_srpverifier]),
565 gNrow ? gNrow[DB_srpsalt] : NULL,
566 gNrow ? gNrow[DB_srpverifier] : NULL,
567 passout, verbose))) {
569 "Cannot create srp verifier for user \"%s\", operation abandoned.\n",
575 row[DB_srptype][0] = 'v';
576 row[DB_srpgN] = OPENSSL_strdup(gNid);
578 if (row[DB_srpid] == NULL
579 || row[DB_srpgN] == NULL
580 || row[DB_srptype] == NULL
581 || row[DB_srpverifier] == NULL
582 || row[DB_srpsalt] == NULL
584 && ((row[DB_srpinfo] = OPENSSL_strdup(userinfo))
591 } else if (mode == OPT_DELETE) {
594 "user \"%s\" does not exist, operation ignored. t\n",
598 char **xpp = sk_OPENSSL_PSTRING_value(db->db->data, userindex);
600 BIO_printf(bio_err, "user \"%s\" revoked. t\n", user);
601 xpp[DB_srptype][0] = 'R';
613 BIO_printf(bio_err, "User procession done.\n");
616 /* Lets check some fields */
617 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
618 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
620 if (pp[DB_srptype][0] == 'v') {
621 pp[DB_srptype][0] = 'V';
622 print_user(db, i, verbose);
627 BIO_printf(bio_err, "Trying to update srpvfile.\n");
628 if (!save_index(srpvfile, "new", db))
632 BIO_printf(bio_err, "Temporary srpvfile created.\n");
633 if (!rotate_index(srpvfile, "new", "old"))
637 BIO_printf(bio_err, "srpvfile updated.\n");
644 BIO_printf(bio_err, "User errors %d.\n", errors);
647 BIO_printf(bio_err, "SRP terminating with code %d.\n", ret);
648 OPENSSL_free(tofree);
650 ERR_print_errors(bio_err);
652 app_RAND_write_file(randfile);