3 * Written by Peter Sylvester (peter.sylvester@edelweb.fr) for the EdelKey
4 * project and contributed to the OpenSSL project 2004.
6 /* ====================================================================
7 * Copyright (c) 2004 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * licensing@OpenSSL.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
59 #include <openssl/opensslconf.h>
61 #ifndef OPENSSL_NO_SRP
65 # include <openssl/conf.h>
66 # include <openssl/bio.h>
67 # include <openssl/err.h>
68 # include <openssl/txt_db.h>
69 # include <openssl/buffer.h>
70 # include <openssl/srp.h>
75 # define PROG srp_main
77 # define BASE_SECTION "srp"
78 # define CONFIG_FILE "openssl.cnf"
80 # define ENV_RANDFILE "RANDFILE"
82 # define ENV_DATABASE "srpvfile"
83 # define ENV_DEFAULT_SRP "default_srp"
85 static char *srp_usage[] = {
86 "usage: srp [args] [user] \n",
88 " -verbose Talk alot while doing things\n",
89 " -config file A config file\n",
90 " -name arg The particular srp definition to use\n",
91 " -srpvfile arg The srp verifier file name\n",
92 " -add add an user and srp verifier\n",
93 " -modify modify the srp verifier of an existing user\n",
94 " -delete delete user from verifier file\n",
96 " -gn arg g and N values to be used for new verifier\n",
97 " -userinfo arg additional info to be set for user\n",
98 " -passin arg input file pass phrase source\n",
99 " -passout arg output file pass phrase source\n",
100 # ifndef OPENSSL_NO_ENGINE
101 " -engine e - use engine e, possibly a hardware device.\n",
107 extern int EF_PROTECT_FREE;
108 extern int EF_PROTECT_BELOW;
109 extern int EF_ALIGNMENT;
112 static CONF *conf = NULL;
113 static char *section = NULL;
115 # define VERBOSE if (verbose)
116 # define VVERBOSE if (verbose>1)
118 int MAIN(int, char **);
120 static int get_index(CA_DB *db, char *id, char type)
126 if (type == DB_SRP_INDEX)
127 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
128 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
129 if (pp[DB_srptype][0] == DB_SRP_INDEX
130 && !strcmp(id, pp[DB_srpid]))
133 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
134 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
136 if (pp[DB_srptype][0] != DB_SRP_INDEX
137 && !strcmp(id, pp[DB_srpid]))
144 static void print_entry(CA_DB *db, BIO *bio, int indx, int verbose, char *s)
146 if (indx >= 0 && verbose) {
148 char **pp = sk_OPENSSL_PSTRING_value(db->db->data, indx);
149 BIO_printf(bio, "%s \"%s\"\n", s, pp[DB_srpid]);
150 for (j = 0; j < DB_NUMBER; j++) {
151 BIO_printf(bio_err, " %d = \"%s\"\n", j, pp[j]);
156 static void print_index(CA_DB *db, BIO *bio, int indexindex, int verbose)
158 print_entry(db, bio, indexindex, verbose, "g N entry");
161 static void print_user(CA_DB *db, BIO *bio, int userindex, int verbose)
164 char **pp = sk_OPENSSL_PSTRING_value(db->db->data, userindex);
166 if (pp[DB_srptype][0] != 'I') {
167 print_entry(db, bio, userindex, verbose, "User entry");
168 print_entry(db, bio, get_index(db, pp[DB_srpgN], 'I'), verbose,
175 static int update_index(CA_DB *db, BIO *bio, char **row)
181 (char **)OPENSSL_malloc(sizeof(char *) * (DB_NUMBER + 1))) == NULL) {
182 BIO_printf(bio_err, "Memory allocation failure\n");
186 for (i = 0; i < DB_NUMBER; i++)
188 irow[DB_NUMBER] = NULL;
190 if (!TXT_DB_insert(db->db, irow)) {
191 BIO_printf(bio, "failed to update srpvfile\n");
192 BIO_printf(bio, "TXT_DB error number %ld\n", db->db->error);
199 static void lookup_fail(const char *name, char *tag)
201 BIO_printf(bio_err, "variable lookup failed for %s::%s\n", name, tag);
204 static char *srp_verify_user(const char *user, const char *srp_verifier,
205 char *srp_usersalt, const char *g, const char *N,
206 const char *passin, BIO *bio, int verbose)
210 char *verifier = NULL;
213 cb_tmp.prompt_info = user;
214 cb_tmp.password = passin;
216 if (password_callback(password, 1024, 0, &cb_tmp) > 0) {
217 VERBOSE BIO_printf(bio,
218 "Validating\n user=\"%s\"\n srp_verifier=\"%s\"\n srp_usersalt=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",
219 user, srp_verifier, srp_usersalt, g, N);
220 BIO_printf(bio, "Pass %s\n", password);
224 SRP_create_verifier(user, password, &srp_usersalt, &verifier, N,
226 BIO_printf(bio, "Internal error validating SRP verifier\n");
228 if (strcmp(verifier, srp_verifier))
230 OPENSSL_free(verifier);
236 static char *srp_create_user(char *user, char **srp_verifier,
237 char **srp_usersalt, char *g, char *N,
238 char *passout, BIO *bio, int verbose)
244 cb_tmp.prompt_info = user;
245 cb_tmp.password = passout;
247 if (password_callback(password, 1024, 1, &cb_tmp) > 0) {
248 VERBOSE BIO_printf(bio,
249 "Creating\n user=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",
253 SRP_create_verifier(user, password, &salt, srp_verifier, N,
255 BIO_printf(bio, "Internal error creating SRP verifier\n");
257 *srp_usersalt = salt;
258 VVERBOSE BIO_printf(bio, "gNid=%s salt =\"%s\"\n verifier =\"%s\"\n",
259 gNid, salt, *srp_verifier);
265 int MAIN(int argc, char **argv)
273 char *passargin = NULL, *passargout = NULL;
274 char *passin = NULL, *passout = NULL;
280 char *userinfo = NULL;
287 char *configfile = NULL;
293 char *randfile = NULL;
301 EF_PROTECT_BELOW = 1;
311 if ((bio_err = BIO_new(BIO_s_file())) != NULL)
312 BIO_set_fp(bio_err, stderr, BIO_NOCLOSE | BIO_FP_TEXT);
316 while (argc >= 1 && badops == 0) {
317 if (strcmp(*argv, "-verbose") == 0)
319 else if (strcmp(*argv, "-config") == 0) {
322 configfile = *(++argv);
323 } else if (strcmp(*argv, "-name") == 0) {
327 } else if (strcmp(*argv, "-srpvfile") == 0) {
331 } else if (strcmp(*argv, "-add") == 0)
333 else if (strcmp(*argv, "-delete") == 0)
335 else if (strcmp(*argv, "-modify") == 0)
337 else if (strcmp(*argv, "-list") == 0)
339 else if (strcmp(*argv, "-gn") == 0) {
343 } else if (strcmp(*argv, "-userinfo") == 0) {
346 userinfo = *(++argv);
347 } else if (strcmp(*argv, "-passin") == 0) {
350 passargin = *(++argv);
351 } else if (strcmp(*argv, "-passout") == 0) {
354 passargout = *(++argv);
356 # ifndef OPENSSL_NO_ENGINE
357 else if (strcmp(*argv, "-engine") == 0) {
364 else if (**argv == '-') {
366 BIO_printf(bio_err, "unknown option %s\n", *argv);
376 if (dbfile && configfile) {
378 "-dbfile and -configfile cannot be specified together.\n");
381 if (add_user + delete_user + modify_user + list_user != 1) {
383 "Exactly one of the options -add, -delete, -modify -list must be specified.\n");
386 if (delete_user + modify_user + delete_user == 1 && argc <= 0) {
388 "Need at least one user for options -add, -delete, -modify. \n");
391 if ((passin || passout) && argc != 1) {
393 "-passin, -passout arguments only valid with one user.\n");
398 for (pp = srp_usage; (*pp != NULL); pp++)
399 BIO_printf(bio_err, "%s", *pp);
401 BIO_printf(bio_err, " -rand file%cfile%c...\n", LIST_SEPARATOR_CHAR,
402 LIST_SEPARATOR_CHAR);
404 " load the file (or the files in the directory) into\n");
405 BIO_printf(bio_err, " the random number generator\n");
409 ERR_load_crypto_strings();
411 e = setup_engine(bio_err, engine, 0);
413 if (!app_passwd(bio_err, passargin, passargout, &passin, &passout)) {
414 BIO_printf(bio_err, "Error getting passwords\n");
420 /*****************************************************************/
422 if (configfile == NULL)
423 configfile = getenv("OPENSSL_CONF");
424 if (configfile == NULL)
425 configfile = getenv("SSLEAY_CONF");
426 if (configfile == NULL) {
427 const char *s = X509_get_default_cert_area();
430 # ifdef OPENSSL_SYS_VMS
431 len = strlen(s) + sizeof(CONFIG_FILE);
432 tofree = OPENSSL_malloc(len);
434 BIO_printf(bio_err, "Out of memory\n");
439 len = strlen(s) + sizeof(CONFIG_FILE) + 1;
440 tofree = OPENSSL_malloc(len);
442 BIO_printf(bio_err, "Out of memory\n");
445 BUF_strlcpy(tofree, s, len);
446 BUF_strlcat(tofree, "/", len);
448 BUF_strlcat(tofree, CONFIG_FILE, len);
452 VERBOSE BIO_printf(bio_err, "Using configuration from %s\n",
454 conf = NCONF_new(NULL);
455 if (NCONF_load(conf, configfile, &errorline) <= 0) {
457 BIO_printf(bio_err, "error loading the config file '%s'\n",
460 BIO_printf(bio_err, "error on line %ld of config file '%s'\n",
461 errorline, configfile);
465 OPENSSL_free(tofree);
469 if (!load_config(bio_err, conf))
472 /* Lets get the config section we are using */
473 if (section == NULL) {
474 VERBOSE BIO_printf(bio_err,
475 "trying to read " ENV_DEFAULT_SRP
476 " in \" BASE_SECTION \"\n");
478 section = NCONF_get_string(conf, BASE_SECTION, ENV_DEFAULT_SRP);
479 if (section == NULL) {
480 lookup_fail(BASE_SECTION, ENV_DEFAULT_SRP);
485 if (randfile == NULL && conf)
486 randfile = NCONF_get_string(conf, BASE_SECTION, "RANDFILE");
488 VERBOSE BIO_printf(bio_err,
489 "trying to read " ENV_DATABASE
490 " in section \"%s\"\n", section);
492 if ((dbfile = NCONF_get_string(conf, section, ENV_DATABASE)) == NULL) {
493 lookup_fail(section, ENV_DATABASE);
498 if (randfile == NULL)
501 app_RAND_load_file(randfile, bio_err, 0);
503 VERBOSE BIO_printf(bio_err, "Trying to read SRP verifier file \"%s\"\n",
506 db = load_index(dbfile, &db_attr);
510 /* Lets check some fields */
511 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
512 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
514 if (pp[DB_srptype][0] == DB_SRP_INDEX) {
516 if (gNindex < 0 && gN != NULL && !strcmp(gN, pp[DB_srpid]))
519 print_index(db, bio_err, i, verbose > 1);
523 VERBOSE BIO_printf(bio_err, "Database initialised\n");
526 gNrow = sk_OPENSSL_PSTRING_value(db->db->data, gNindex);
527 print_entry(db, bio_err, gNindex, verbose > 1, "Default g and N");
528 } else if (maxgN > 0 && !SRP_get_default_gN(gN)) {
529 BIO_printf(bio_err, "No g and N value for index \"%s\"\n", gN);
532 VERBOSE BIO_printf(bio_err, "Database has no g N information.\n");
536 VVERBOSE BIO_printf(bio_err, "Starting user processing\n");
541 while (list_user || user) {
544 VVERBOSE BIO_printf(bio_err, "Processing user \"%s\"\n", user);
545 if ((userindex = get_index(db, user, 'U')) >= 0) {
546 print_user(db, bio_err, userindex, (verbose > 0) || list_user);
551 BIO_printf(bio_err, "List all users\n");
553 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
554 print_user(db, bio_err, i, 1);
557 } else if (userindex < 0) {
559 "user \"%s\" does not exist, ignored. t\n", user);
562 } else if (add_user) {
563 if (userindex >= 0) {
564 /* reactivation of a new user */
566 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
567 BIO_printf(bio_err, "user \"%s\" reactivated.\n", user);
568 row[DB_srptype][0] = 'V';
572 char *row[DB_NUMBER];
574 row[DB_srpverifier] = NULL;
575 row[DB_srpsalt] = NULL;
576 row[DB_srpinfo] = NULL;
579 srp_create_user(user, &(row[DB_srpverifier]),
581 gNrow ? gNrow[DB_srpsalt] : gN,
582 gNrow ? gNrow[DB_srpverifier] : NULL,
583 passout, bio_err, verbose))) {
585 "Cannot create srp verifier for user \"%s\", operation abandoned .\n",
590 row[DB_srpid] = BUF_strdup(user);
591 row[DB_srptype] = BUF_strdup("v");
592 row[DB_srpgN] = BUF_strdup(gNid);
594 if (!row[DB_srpid] || !row[DB_srpgN] || !row[DB_srptype]
595 || !row[DB_srpverifier] || !row[DB_srpsalt] || (userinfo
602 || !update_index(db, bio_err, row)) {
604 OPENSSL_free(row[DB_srpid]);
606 OPENSSL_free(row[DB_srpgN]);
608 OPENSSL_free(row[DB_srpinfo]);
610 OPENSSL_free(row[DB_srptype]);
611 if (row[DB_srpverifier])
612 OPENSSL_free(row[DB_srpverifier]);
614 OPENSSL_free(row[DB_srpsalt]);
619 } else if (modify_user) {
622 "user \"%s\" does not exist, operation ignored.\n",
628 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
629 char type = row[DB_srptype][0];
632 "user \"%s\" already updated, operation ignored.\n",
638 if (row[DB_srptype][0] == 'V') {
641 VERBOSE BIO_printf(bio_err,
642 "Verifying password for user \"%s\"\n",
645 get_index(db, row[DB_srpgN], DB_SRP_INDEX)) >= 0)
647 (char **)sk_OPENSSL_PSTRING_value(db->
652 (user, row[DB_srpverifier], row[DB_srpsalt],
653 irow ? irow[DB_srpsalt] : row[DB_srpgN],
654 irow ? irow[DB_srpverifier] : NULL, passin,
657 "Invalid password for user \"%s\", operation abandoned.\n",
663 VERBOSE BIO_printf(bio_err,
664 "Password for user \"%s\" ok.\n",
669 srp_create_user(user, &(row[DB_srpverifier]),
671 gNrow ? gNrow[DB_srpsalt] : NULL,
672 gNrow ? gNrow[DB_srpverifier] : NULL,
673 passout, bio_err, verbose))) {
675 "Cannot create srp verifier for user \"%s\", operation abandoned.\n",
681 row[DB_srptype][0] = 'v';
682 row[DB_srpgN] = BUF_strdup(gNid);
684 if (!row[DB_srpid] || !row[DB_srpgN] || !row[DB_srptype]
685 || !row[DB_srpverifier] || !row[DB_srpsalt]
687 && (!(row[DB_srpinfo] = BUF_strdup(userinfo)))))
693 } else if (delete_user) {
696 "user \"%s\" does not exist, operation ignored. t\n",
701 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
702 BIO_printf(bio_err, "user \"%s\" revoked. t\n", user);
704 xpp[DB_srptype][0] = 'R';
717 VERBOSE BIO_printf(bio_err, "User procession done.\n");
720 /* Lets check some fields */
721 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
722 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
724 if (pp[DB_srptype][0] == 'v') {
725 pp[DB_srptype][0] = 'V';
726 print_user(db, bio_err, i, verbose);
730 VERBOSE BIO_printf(bio_err, "Trying to update srpvfile.\n");
731 if (!save_index(dbfile, "new", db))
734 VERBOSE BIO_printf(bio_err, "Temporary srpvfile created.\n");
735 if (!rotate_index(dbfile, "new", "old"))
738 VERBOSE BIO_printf(bio_err, "srpvfile updated.\n");
744 VERBOSE BIO_printf(bio_err, "User errors %d.\n", errors);
746 VERBOSE BIO_printf(bio_err, "SRP terminating with code %d.\n", ret);
748 OPENSSL_free(tofree);
750 ERR_print_errors(bio_err);
752 app_RAND_write_file(randfile, bio_err);
765 static void *dummy = &dummy;