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"
82 extern int EF_PROTECT_FREE;
83 extern int EF_PROTECT_BELOW;
84 extern int EF_ALIGNMENT;
87 static int get_index(CA_DB *db, char *id, char type)
93 if (type == DB_SRP_INDEX)
94 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
95 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
96 if (pp[DB_srptype][0] == DB_SRP_INDEX
97 && !strcmp(id, pp[DB_srpid]))
100 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
101 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
103 if (pp[DB_srptype][0] != DB_SRP_INDEX
104 && !strcmp(id, pp[DB_srpid]))
111 static void print_entry(CA_DB *db, BIO *bio, int indx, int verbose, char *s)
113 if (indx >= 0 && verbose) {
115 char **pp = sk_OPENSSL_PSTRING_value(db->db->data, indx);
116 BIO_printf(bio, "%s \"%s\"\n", s, pp[DB_srpid]);
117 for (j = 0; j < DB_NUMBER; j++) {
118 BIO_printf(bio_err, " %d = \"%s\"\n", j, pp[j]);
123 static void print_index(CA_DB *db, BIO *bio, int indexindex, int verbose)
125 print_entry(db, bio, indexindex, verbose, "g N entry");
128 static void print_user(CA_DB *db, BIO *bio, int userindex, int verbose)
131 char **pp = sk_OPENSSL_PSTRING_value(db->db->data, userindex);
133 if (pp[DB_srptype][0] != 'I') {
134 print_entry(db, bio, userindex, verbose, "User entry");
135 print_entry(db, bio, get_index(db, pp[DB_srpgN], 'I'), verbose,
142 static int update_index(CA_DB *db, BIO *bio, char **row)
148 (char **)OPENSSL_malloc(sizeof(char *) * (DB_NUMBER + 1))) == NULL) {
149 BIO_printf(bio_err, "Memory allocation failure\n");
153 for (i = 0; i < DB_NUMBER; i++) {
157 irow[DB_NUMBER] = NULL;
159 if (!TXT_DB_insert(db->db, irow)) {
160 BIO_printf(bio, "failed to update srpvfile\n");
161 BIO_printf(bio, "TXT_DB error number %ld\n", db->db->error);
168 static void lookup_fail(const char *name, const char *tag)
170 BIO_printf(bio_err, "variable lookup failed for %s::%s\n", name, tag);
173 static char *srp_verify_user(const char *user, const char *srp_verifier,
174 char *srp_usersalt, const char *g, const char *N,
175 const char *passin, BIO *bio, int verbose)
179 char *verifier = NULL;
182 cb_tmp.prompt_info = user;
183 cb_tmp.password = passin;
185 if (password_callback(password, 1024, 0, &cb_tmp) > 0) {
188 "Validating\n user=\"%s\"\n srp_verifier=\"%s\"\n srp_usersalt=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",
189 user, srp_verifier, srp_usersalt, g, N);
190 BIO_printf(bio, "Pass %s\n", password);
192 OPENSSL_assert(srp_usersalt != NULL);
195 SRP_create_verifier(user, password, &srp_usersalt, &verifier, N,
197 BIO_printf(bio, "Internal error validating SRP verifier\n");
199 if (strcmp(verifier, srp_verifier))
201 OPENSSL_free(verifier);
207 static char *srp_create_user(char *user, char **srp_verifier,
208 char **srp_usersalt, char *g, char *N,
209 char *passout, BIO *bio, int verbose)
215 cb_tmp.prompt_info = user;
216 cb_tmp.password = passout;
218 if (password_callback(password, 1024, 1, &cb_tmp) > 0) {
220 BIO_printf(bio, "Creating\n user=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",
224 SRP_create_verifier(user, password, &salt, srp_verifier, N,
226 BIO_printf(bio, "Internal error creating SRP verifier\n");
228 *srp_usersalt = salt;
230 BIO_printf(bio, "gNid=%s salt =\"%s\"\n verifier =\"%s\"\n", gNid,
231 salt, *srp_verifier);
237 typedef enum OPTION_choice {
238 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
239 OPT_VERBOSE, OPT_CONFIG, OPT_NAME, OPT_SRPVFILE, OPT_ADD,
240 OPT_DELETE, OPT_MODIFY, OPT_LIST, OPT_GN, OPT_USERINFO,
241 OPT_PASSIN, OPT_PASSOUT, OPT_ENGINE
244 OPTIONS srp_options[] = {
245 {"help", OPT_HELP, '-', "Display this summary"},
246 {"verbose", OPT_VERBOSE, '-', "Talk a lot while doing things"},
247 {"config", OPT_CONFIG, '<', "A config file"},
248 {"name", OPT_NAME, 's', "The particular srp definition to use"},
249 {"srpvfile", OPT_SRPVFILE, '<', "The srp verifier file name"},
250 {"add", OPT_ADD, '-', "Add a user and srp verifier"},
251 {"modify", OPT_MODIFY, '-',
252 "Modify the srp verifier of an existing user"},
253 {"delete", OPT_DELETE, '-', "Delete user from verifier file"},
254 {"list", OPT_LIST, '-', "List users"},
255 {"gn", OPT_GN, 's', "Set g and N values to be used for new verifier"},
256 {"userinfo", OPT_USERINFO, 's', "Additional info to be set for user"},
257 {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
258 {"passout", OPT_PASSOUT, 's', "Output file pass phrase source"},
259 # ifndef OPENSSL_NO_ENGINE
260 {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
265 int srp_main(int argc, char **argv)
270 int gNindex = -1, maxgN = -1, ret = 1, errors = 0, verbose =
271 0, i, doupdatedb = 0;
273 char *user = NULL, *passinarg = NULL, *passoutarg = NULL;
274 char *passin = NULL, *passout = NULL, *gN = NULL, *userinfo = NULL;
275 char *randfile = NULL, *tofree = NULL, *section = NULL;
276 char **gNrow = NULL, *configfile = NULL, *dbfile = NULL, **pp, *prog;
282 EF_PROTECT_BELOW = 1;
286 prog = opt_init(argc, argv, srp_options);
287 while ((o = opt_next()) != OPT_EOF) {
292 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
295 opt_help(srp_options);
302 configfile = opt_arg();
314 if (mode != OPT_ERR) {
316 "%s: Only one of -add/delete-modify/-list\n",
326 userinfo = opt_arg();
329 passinarg = opt_arg();
332 passoutarg = opt_arg();
335 (void)setup_engine(opt_arg(), 0);
339 argc = opt_num_rest();
342 if (dbfile && configfile) {
344 "-dbfile and -configfile cannot be specified together.\n");
347 if (mode == OPT_ERR) {
349 "Exactly one of the options -add, -delete, -modify -list must be specified.\n");
352 if ((mode == OPT_DELETE || mode == OPT_MODIFY || OPT_ADD) && argc < 1) {
354 "Need at least one user for options -add, -delete, -modify. \n");
357 if ((passin || passout) && argc != 1) {
359 "-passin, -passout arguments only valid with one user.\n");
363 if (!app_passwd(passinarg, passoutarg, &passin, &passout)) {
364 BIO_printf(bio_err, "Error getting passwords\n");
370 /*****************************************************************/
372 if (configfile == NULL)
373 configfile = getenv("OPENSSL_CONF");
374 if (configfile == NULL)
375 configfile = getenv("SSLEAY_CONF");
376 if (configfile == NULL) {
377 const char *s = X509_get_default_cert_area();
380 # ifdef OPENSSL_SYS_VMS
381 len = strlen(s) + sizeof(CONFIG_FILE);
382 tofree = OPENSSL_malloc(len);
384 BIO_printf(bio_err, "Out of memory\n");
389 len = strlen(s) + sizeof(CONFIG_FILE) + 1;
390 tofree = OPENSSL_malloc(len);
392 BIO_printf(bio_err, "Out of memory\n");
395 BUF_strlcpy(tofree, s, len);
396 BUF_strlcat(tofree, "/", len);
398 BUF_strlcat(tofree, CONFIG_FILE, len);
403 BIO_printf(bio_err, "Using configuration from %s\n", configfile);
404 conf = NCONF_new(NULL);
405 if (NCONF_load(conf, configfile, &errorline) <= 0) {
407 BIO_printf(bio_err, "error loading the config file '%s'\n",
410 BIO_printf(bio_err, "error on line %ld of config file '%s'\n",
411 errorline, configfile);
415 OPENSSL_free(tofree);
419 /* Lets get the config section we are using */
420 if (section == NULL) {
423 "trying to read " ENV_DEFAULT_SRP
424 " in \" BASE_SECTION \"\n");
426 section = NCONF_get_string(conf, BASE_SECTION, ENV_DEFAULT_SRP);
427 if (section == NULL) {
428 lookup_fail(BASE_SECTION, ENV_DEFAULT_SRP);
433 if (randfile == NULL && conf)
434 randfile = NCONF_get_string(conf, BASE_SECTION, "RANDFILE");
438 "trying to read " ENV_DATABASE " in section \"%s\"\n",
441 if ((dbfile = NCONF_get_string(conf, section, ENV_DATABASE)) == NULL) {
442 lookup_fail(section, ENV_DATABASE);
447 if (randfile == NULL)
450 app_RAND_load_file(randfile, 0);
453 BIO_printf(bio_err, "Trying to read SRP verifier file \"%s\"\n",
456 db = load_index(dbfile, &db_attr);
460 /* Lets check some fields */
461 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
462 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
464 if (pp[DB_srptype][0] == DB_SRP_INDEX) {
466 if (gNindex < 0 && gN != NULL && !strcmp(gN, pp[DB_srpid]))
469 print_index(db, bio_err, i, verbose > 1);
474 BIO_printf(bio_err, "Database initialised\n");
477 gNrow = sk_OPENSSL_PSTRING_value(db->db->data, gNindex);
478 print_entry(db, bio_err, gNindex, verbose > 1, "Default g and N");
479 } else if (maxgN > 0 && !SRP_get_default_gN(gN)) {
480 BIO_printf(bio_err, "No g and N value for index \"%s\"\n", gN);
484 BIO_printf(bio_err, "Database has no g N information.\n");
489 BIO_printf(bio_err, "Starting user processing\n");
494 while (mode == OPT_LIST || user) {
498 BIO_printf(bio_err, "Processing user \"%s\"\n", user);
499 if ((userindex = get_index(db, user, 'U')) >= 0) {
500 print_user(db, bio_err, userindex, (verbose > 0)
501 || mode == OPT_LIST);
504 if (mode == OPT_LIST) {
506 BIO_printf(bio_err, "List all users\n");
508 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
509 print_user(db, bio_err, i, 1);
511 } else if (userindex < 0) {
513 "user \"%s\" does not exist, ignored. t\n", user);
516 } else if (mode == OPT_ADD) {
517 if (userindex >= 0) {
518 /* reactivation of a new user */
520 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
521 BIO_printf(bio_err, "user \"%s\" reactivated.\n", user);
522 row[DB_srptype][0] = 'V';
526 char *row[DB_NUMBER];
528 row[DB_srpverifier] = NULL;
529 row[DB_srpsalt] = NULL;
530 row[DB_srpinfo] = NULL;
533 srp_create_user(user, &(row[DB_srpverifier]),
535 gNrow ? gNrow[DB_srpsalt] : gN,
536 gNrow ? gNrow[DB_srpverifier] : NULL,
537 passout, bio_err, verbose))) {
539 "Cannot create srp verifier for user \"%s\", operation abandoned .\n",
544 row[DB_srpid] = BUF_strdup(user);
545 row[DB_srptype] = BUF_strdup("v");
546 row[DB_srpgN] = BUF_strdup(gNid);
548 if (!row[DB_srpid] || !row[DB_srpgN] || !row[DB_srptype]
549 || !row[DB_srpverifier] || !row[DB_srpsalt] || (userinfo
556 || !update_index(db, bio_err, row)) {
558 OPENSSL_free(row[DB_srpid]);
560 OPENSSL_free(row[DB_srpgN]);
562 OPENSSL_free(row[DB_srpinfo]);
564 OPENSSL_free(row[DB_srptype]);
565 if (row[DB_srpverifier])
566 OPENSSL_free(row[DB_srpverifier]);
568 OPENSSL_free(row[DB_srpsalt]);
573 } else if (mode == OPT_MODIFY) {
576 "user \"%s\" does not exist, operation ignored.\n",
582 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
583 char type = row[DB_srptype][0];
586 "user \"%s\" already updated, operation ignored.\n",
592 if (row[DB_srptype][0] == 'V') {
597 "Verifying password for user \"%s\"\n",
600 get_index(db, row[DB_srpgN], DB_SRP_INDEX)) >= 0)
602 sk_OPENSSL_PSTRING_value(db->db->data,
606 (user, row[DB_srpverifier], row[DB_srpsalt],
607 irow ? irow[DB_srpsalt] : row[DB_srpgN],
608 irow ? irow[DB_srpverifier] : NULL, passin,
611 "Invalid password for user \"%s\", operation abandoned.\n",
618 BIO_printf(bio_err, "Password for user \"%s\" ok.\n",
623 srp_create_user(user, &(row[DB_srpverifier]),
625 gNrow ? gNrow[DB_srpsalt] : NULL,
626 gNrow ? gNrow[DB_srpverifier] : NULL,
627 passout, bio_err, verbose))) {
629 "Cannot create srp verifier for user \"%s\", operation abandoned.\n",
635 row[DB_srptype][0] = 'v';
636 row[DB_srpgN] = BUF_strdup(gNid);
638 if (!row[DB_srpid] || !row[DB_srpgN] || !row[DB_srptype]
639 || !row[DB_srpverifier] || !row[DB_srpsalt]
641 && (!(row[DB_srpinfo] = BUF_strdup(userinfo)))))
647 } else if (mode == OPT_DELETE) {
650 "user \"%s\" does not exist, operation ignored. t\n",
655 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
656 BIO_printf(bio_err, "user \"%s\" revoked. t\n", user);
658 xpp[DB_srptype][0] = 'R';
671 BIO_printf(bio_err, "User procession done.\n");
674 /* Lets check some fields */
675 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
676 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
678 if (pp[DB_srptype][0] == 'v') {
679 pp[DB_srptype][0] = 'V';
680 print_user(db, bio_err, i, verbose);
685 BIO_printf(bio_err, "Trying to update srpvfile.\n");
686 if (!save_index(dbfile, "new", db))
690 BIO_printf(bio_err, "Temporary srpvfile created.\n");
691 if (!rotate_index(dbfile, "new", "old"))
695 BIO_printf(bio_err, "srpvfile updated.\n");
702 BIO_printf(bio_err, "User errors %d.\n", errors);
705 BIO_printf(bio_err, "SRP terminating with code %d.\n", ret);
707 OPENSSL_free(tofree);
709 ERR_print_errors(bio_err);
711 app_RAND_write_file(randfile);