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).
58 #include <openssl/opensslconf.h>
60 #ifndef OPENSSL_NO_SRP
64 # include <openssl/conf.h>
65 # include <openssl/bio.h>
66 # include <openssl/err.h>
67 # include <openssl/txt_db.h>
68 # include <openssl/buffer.h>
69 # include <openssl/srp.h>
73 # define BASE_SECTION "srp"
74 # define CONFIG_FILE "openssl.cnf"
76 # define ENV_RANDFILE "RANDFILE"
78 # define ENV_DATABASE "srpvfile"
79 # define ENV_DEFAULT_SRP "default_srp"
81 static int get_index(CA_DB *db, char *id, char type)
87 if (type == DB_SRP_INDEX)
88 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
89 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
90 if (pp[DB_srptype][0] == DB_SRP_INDEX
91 && !strcmp(id, pp[DB_srpid]))
94 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
95 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
97 if (pp[DB_srptype][0] != DB_SRP_INDEX
98 && !strcmp(id, pp[DB_srpid]))
105 static void print_entry(CA_DB *db, int indx, int verbose, char *s)
107 if (indx >= 0 && verbose) {
109 char **pp = sk_OPENSSL_PSTRING_value(db->db->data, indx);
110 BIO_printf(bio_err, "%s \"%s\"\n", s, pp[DB_srpid]);
111 for (j = 0; j < DB_NUMBER; j++) {
112 BIO_printf(bio_err, " %d = \"%s\"\n", j, pp[j]);
117 static void print_index(CA_DB *db, int indexindex, int verbose)
119 print_entry(db, indexindex, verbose, "g N entry");
122 static void print_user(CA_DB *db, int userindex, int verbose)
125 char **pp = sk_OPENSSL_PSTRING_value(db->db->data, userindex);
127 if (pp[DB_srptype][0] != 'I') {
128 print_entry(db, userindex, verbose, "User entry");
129 print_entry(db, get_index(db, pp[DB_srpgN], 'I'), verbose,
136 static int update_index(CA_DB *db, char **row)
141 irow = app_malloc(sizeof(*irow) * (DB_NUMBER + 1), "row pointers");
142 for (i = 0; i < DB_NUMBER; i++) {
146 irow[DB_NUMBER] = NULL;
148 if (!TXT_DB_insert(db->db, irow)) {
149 BIO_printf(bio_err, "failed to update srpvfile\n");
150 BIO_printf(bio_err, "TXT_DB error number %ld\n", db->db->error);
157 static void lookup_fail(const char *name, const char *tag)
159 BIO_printf(bio_err, "variable lookup failed for %s::%s\n", name, tag);
162 static char *srp_verify_user(const char *user, const char *srp_verifier,
163 char *srp_usersalt, const char *g, const char *N,
164 const char *passin, int verbose)
168 char *verifier = NULL;
171 cb_tmp.prompt_info = user;
172 cb_tmp.password = passin;
174 if (password_callback(password, 1024, 0, &cb_tmp) > 0) {
177 "Validating\n user=\"%s\"\n srp_verifier=\"%s\"\n srp_usersalt=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",
178 user, srp_verifier, srp_usersalt, g, N);
179 BIO_printf(bio_err, "Pass %s\n", password);
181 OPENSSL_assert(srp_usersalt != NULL);
184 SRP_create_verifier(user, password, &srp_usersalt, &verifier, N,
186 BIO_printf(bio_err, "Internal error validating SRP verifier\n");
188 if (strcmp(verifier, srp_verifier))
190 OPENSSL_free(verifier);
196 static char *srp_create_user(char *user, char **srp_verifier,
197 char **srp_usersalt, char *g, char *N,
198 char *passout, int verbose)
204 cb_tmp.prompt_info = user;
205 cb_tmp.password = passout;
207 if (password_callback(password, 1024, 1, &cb_tmp) > 0) {
209 BIO_printf(bio_err, "Creating\n user=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",
213 SRP_create_verifier(user, password, &salt, srp_verifier, N,
215 BIO_printf(bio_err, "Internal error creating SRP verifier\n");
217 *srp_usersalt = salt;
219 BIO_printf(bio_err, "gNid=%s salt =\"%s\"\n verifier =\"%s\"\n", gNid,
220 salt, *srp_verifier);
226 typedef enum OPTION_choice {
227 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
228 OPT_VERBOSE, OPT_CONFIG, OPT_NAME, OPT_SRPVFILE, OPT_ADD,
229 OPT_DELETE, OPT_MODIFY, OPT_LIST, OPT_GN, OPT_USERINFO,
230 OPT_PASSIN, OPT_PASSOUT, OPT_ENGINE
233 OPTIONS srp_options[] = {
234 {"help", OPT_HELP, '-', "Display this summary"},
235 {"verbose", OPT_VERBOSE, '-', "Talk a lot while doing things"},
236 {"config", OPT_CONFIG, '<', "A config file"},
237 {"name", OPT_NAME, 's', "The particular srp definition to use"},
238 {"srpvfile", OPT_SRPVFILE, '<', "The srp verifier file name"},
239 {"add", OPT_ADD, '-', "Add a user and srp verifier"},
240 {"modify", OPT_MODIFY, '-',
241 "Modify the srp verifier of an existing user"},
242 {"delete", OPT_DELETE, '-', "Delete user from verifier file"},
243 {"list", OPT_LIST, '-', "List users"},
244 {"gn", OPT_GN, 's', "Set g and N values to be used for new verifier"},
245 {"userinfo", OPT_USERINFO, 's', "Additional info to be set for user"},
246 {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
247 {"passout", OPT_PASSOUT, 's', "Output file pass phrase source"},
248 # ifndef OPENSSL_NO_ENGINE
249 {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
254 int srp_main(int argc, char **argv)
259 int gNindex = -1, maxgN = -1, ret = 1, errors = 0, verbose =
260 0, i, doupdatedb = 0;
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, *dbfile = 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();
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 (dbfile && configfile) {
327 "-dbfile 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 /*****************************************************************/
356 if (configfile == NULL)
357 configfile = getenv("OPENSSL_CONF");
358 if (configfile == NULL)
359 configfile = getenv("SSLEAY_CONF");
360 if (configfile == NULL) {
361 const char *s = X509_get_default_cert_area();
362 size_t len = strlen(s) + 1 + sizeof(CONFIG_FILE);
364 tofree = app_malloc(len, "config filename space");
365 # ifdef OPENSSL_SYS_VMS
368 BUF_strlcpy(tofree, s, len);
369 BUF_strlcat(tofree, "/", len);
371 BUF_strlcat(tofree, CONFIG_FILE, len);
376 BIO_printf(bio_err, "Using configuration from %s\n", configfile);
377 conf = NCONF_new(NULL);
378 if (NCONF_load(conf, configfile, &errorline) <= 0) {
380 BIO_printf(bio_err, "error loading the config file '%s'\n",
383 BIO_printf(bio_err, "error on line %ld of config file '%s'\n",
384 errorline, configfile);
387 OPENSSL_free(tofree);
390 /* Lets get the config section we are using */
391 if (section == NULL) {
394 "trying to read " ENV_DEFAULT_SRP
395 " in \" BASE_SECTION \"\n");
397 section = NCONF_get_string(conf, BASE_SECTION, ENV_DEFAULT_SRP);
398 if (section == NULL) {
399 lookup_fail(BASE_SECTION, ENV_DEFAULT_SRP);
404 if (randfile == NULL && conf)
405 randfile = NCONF_get_string(conf, BASE_SECTION, "RANDFILE");
409 "trying to read " ENV_DATABASE " in section \"%s\"\n",
412 if ((dbfile = NCONF_get_string(conf, section, ENV_DATABASE)) == NULL) {
413 lookup_fail(section, ENV_DATABASE);
418 if (randfile == NULL)
421 app_RAND_load_file(randfile, 0);
424 BIO_printf(bio_err, "Trying to read SRP verifier file \"%s\"\n",
427 db = load_index(dbfile, &db_attr);
431 /* Lets check some fields */
432 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
433 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
435 if (pp[DB_srptype][0] == DB_SRP_INDEX) {
437 if (gNindex < 0 && gN != NULL && !strcmp(gN, pp[DB_srpid]))
440 print_index(db, i, verbose > 1);
445 BIO_printf(bio_err, "Database initialised\n");
448 gNrow = sk_OPENSSL_PSTRING_value(db->db->data, gNindex);
449 print_entry(db, gNindex, verbose > 1, "Default g and N");
450 } else if (maxgN > 0 && !SRP_get_default_gN(gN)) {
451 BIO_printf(bio_err, "No g and N value for index \"%s\"\n", gN);
455 BIO_printf(bio_err, "Database has no g N information.\n");
460 BIO_printf(bio_err, "Starting user processing\n");
465 while (mode == OPT_LIST || user) {
469 BIO_printf(bio_err, "Processing user \"%s\"\n", user);
470 if ((userindex = get_index(db, user, 'U')) >= 0) {
471 print_user(db, userindex, (verbose > 0)
472 || mode == OPT_LIST);
475 if (mode == OPT_LIST) {
477 BIO_printf(bio_err, "List all users\n");
479 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
480 print_user(db, i, 1);
482 } else if (userindex < 0) {
484 "user \"%s\" does not exist, ignored. t\n", user);
487 } else if (mode == OPT_ADD) {
488 if (userindex >= 0) {
489 /* reactivation of a new user */
491 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
492 BIO_printf(bio_err, "user \"%s\" reactivated.\n", user);
493 row[DB_srptype][0] = 'V';
497 char *row[DB_NUMBER];
499 row[DB_srpverifier] = NULL;
500 row[DB_srpsalt] = NULL;
501 row[DB_srpinfo] = NULL;
504 srp_create_user(user, &(row[DB_srpverifier]),
506 gNrow ? gNrow[DB_srpsalt] : gN,
507 gNrow ? gNrow[DB_srpverifier] : NULL,
508 passout, verbose))) {
510 "Cannot create srp verifier for user \"%s\", operation abandoned .\n",
515 row[DB_srpid] = BUF_strdup(user);
516 row[DB_srptype] = BUF_strdup("v");
517 row[DB_srpgN] = BUF_strdup(gNid);
519 if (!row[DB_srpid] || !row[DB_srpgN] || !row[DB_srptype]
520 || !row[DB_srpverifier] || !row[DB_srpsalt]
522 (!(row [DB_srpinfo] = BUF_strdup (userinfo))))
523 || !update_index(db, row)) {
524 OPENSSL_free(row[DB_srpid]);
525 OPENSSL_free(row[DB_srpgN]);
526 OPENSSL_free(row[DB_srpinfo]);
527 OPENSSL_free(row[DB_srptype]);
528 OPENSSL_free(row[DB_srpverifier]);
529 OPENSSL_free(row[DB_srpsalt]);
534 } else if (mode == OPT_MODIFY) {
537 "user \"%s\" does not exist, operation ignored.\n",
543 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
544 char type = row[DB_srptype][0];
547 "user \"%s\" already updated, operation ignored.\n",
553 if (row[DB_srptype][0] == 'V') {
558 "Verifying password for user \"%s\"\n",
561 get_index(db, row[DB_srpgN], DB_SRP_INDEX)) >= 0)
563 sk_OPENSSL_PSTRING_value(db->db->data,
567 (user, row[DB_srpverifier], row[DB_srpsalt],
568 irow ? irow[DB_srpsalt] : row[DB_srpgN],
569 irow ? irow[DB_srpverifier] : NULL, passin,
572 "Invalid password for user \"%s\", operation abandoned.\n",
579 BIO_printf(bio_err, "Password for user \"%s\" ok.\n",
584 srp_create_user(user, &(row[DB_srpverifier]),
586 gNrow ? gNrow[DB_srpsalt] : NULL,
587 gNrow ? gNrow[DB_srpverifier] : NULL,
588 passout, verbose))) {
590 "Cannot create srp verifier for user \"%s\", operation abandoned.\n",
596 row[DB_srptype][0] = 'v';
597 row[DB_srpgN] = BUF_strdup(gNid);
599 if (!row[DB_srpid] || !row[DB_srpgN] || !row[DB_srptype]
600 || !row[DB_srpverifier] || !row[DB_srpsalt]
602 && (!(row[DB_srpinfo] = BUF_strdup(userinfo)))))
608 } else if (mode == OPT_DELETE) {
611 "user \"%s\" does not exist, operation ignored. t\n",
616 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
617 BIO_printf(bio_err, "user \"%s\" revoked. t\n", user);
619 xpp[DB_srptype][0] = 'R';
632 BIO_printf(bio_err, "User procession done.\n");
635 /* Lets check some fields */
636 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
637 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
639 if (pp[DB_srptype][0] == 'v') {
640 pp[DB_srptype][0] = 'V';
641 print_user(db, i, verbose);
646 BIO_printf(bio_err, "Trying to update srpvfile.\n");
647 if (!save_index(dbfile, "new", db))
651 BIO_printf(bio_err, "Temporary srpvfile created.\n");
652 if (!rotate_index(dbfile, "new", "old"))
656 BIO_printf(bio_err, "srpvfile updated.\n");
663 BIO_printf(bio_err, "User errors %d.\n", errors);
666 BIO_printf(bio_err, "SRP terminating with code %d.\n", ret);
667 OPENSSL_free(tofree);
669 ERR_print_errors(bio_err);
671 app_RAND_write_file(randfile);