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]))
134 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
135 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
137 if (pp[DB_srptype][0] != DB_SRP_INDEX
138 && !strcmp(id, pp[DB_srpid]))
146 static void print_entry(CA_DB *db, BIO *bio, int indx, int verbose, char *s)
148 if (indx >= 0 && verbose) {
150 char **pp = sk_OPENSSL_PSTRING_value(db->db->data, indx);
151 BIO_printf(bio, "%s \"%s\"\n", s, pp[DB_srpid]);
152 for (j = 0; j < DB_NUMBER; j++) {
153 BIO_printf(bio_err, " %d = \"%s\"\n", j, pp[j]);
158 static void print_index(CA_DB *db, BIO *bio, int indexindex, int verbose)
160 print_entry(db, bio, indexindex, verbose, "g N entry");
163 static void print_user(CA_DB *db, BIO *bio, int userindex, int verbose)
166 char **pp = sk_OPENSSL_PSTRING_value(db->db->data, userindex);
168 if (pp[DB_srptype][0] != 'I') {
169 print_entry(db, bio, userindex, verbose, "User entry");
170 print_entry(db, bio, get_index(db, pp[DB_srpgN], 'I'), verbose,
177 static int update_index(CA_DB *db, BIO *bio, char **row)
182 irow = (char **)OPENSSL_malloc(sizeof(char *) * (DB_NUMBER + 1));
184 BIO_printf(bio_err, "Memory allocation failure\n");
188 for (i = 0; i < DB_NUMBER; i++)
190 irow[DB_NUMBER] = NULL;
192 if (!TXT_DB_insert(db->db, irow)) {
193 BIO_printf(bio, "failed to update srpvfile\n");
194 BIO_printf(bio, "TXT_DB error number %ld\n", db->db->error);
201 static void lookup_fail(const char *name, char *tag)
203 BIO_printf(bio_err, "variable lookup failed for %s::%s\n", name, tag);
206 static char *srp_verify_user(const char *user, const char *srp_verifier,
207 char *srp_usersalt, const char *g, const char *N,
208 const char *passin, BIO *bio, int verbose)
212 char *verifier = NULL;
216 cb_tmp.prompt_info = user;
217 cb_tmp.password = passin;
219 len = password_callback(password, sizeof(password)-1, 0, &cb_tmp);
222 VERBOSE BIO_printf(bio,
223 "Validating\n user=\"%s\"\n srp_verifier=\"%s\"\n srp_usersalt=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",
224 user, srp_verifier, srp_usersalt, g, N);
225 VVERBOSE BIO_printf(bio, "Pass %s\n", password);
227 if (!(gNid = SRP_create_verifier(user, password, &srp_usersalt,
229 BIO_printf(bio, "Internal error validating SRP verifier\n");
231 if (strcmp(verifier, srp_verifier))
233 OPENSSL_free(verifier);
235 OPENSSL_cleanse(password, len);
240 static char *srp_create_user(char *user, char **srp_verifier,
241 char **srp_usersalt, char *g, char *N,
242 char *passout, BIO *bio, int verbose)
249 cb_tmp.prompt_info = user;
250 cb_tmp.password = passout;
252 len = password_callback(password, sizeof(password)-1, 1, &cb_tmp);
255 VERBOSE BIO_printf(bio,
256 "Creating\n user=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",
258 if (!(gNid = SRP_create_verifier(user, password, &salt,
259 srp_verifier, N, g))) {
260 BIO_printf(bio, "Internal error creating SRP verifier\n");
262 *srp_usersalt = salt;
264 OPENSSL_cleanse(password, len);
265 VVERBOSE BIO_printf(bio, "gNid=%s salt =\"%s\"\n verifier =\"%s\"\n",
266 gNid, salt, *srp_verifier);
272 int MAIN(int argc, char **argv)
280 char *passargin = NULL, *passargout = NULL;
281 char *passin = NULL, *passout = NULL;
287 char *userinfo = NULL;
294 char *configfile = NULL;
300 char *randfile = NULL;
308 EF_PROTECT_BELOW = 1;
318 if ((bio_err = BIO_new(BIO_s_file())) != NULL)
319 BIO_set_fp(bio_err, stderr, BIO_NOCLOSE | BIO_FP_TEXT);
323 while (argc >= 1 && badops == 0) {
324 if (strcmp(*argv, "-verbose") == 0) {
326 } else if (strcmp(*argv, "-config") == 0) {
329 configfile = *(++argv);
330 } else if (strcmp(*argv, "-name") == 0) {
334 } else if (strcmp(*argv, "-srpvfile") == 0) {
338 } else if (strcmp(*argv, "-add") == 0) {
340 } else if (strcmp(*argv, "-delete") == 0) {
342 } else if (strcmp(*argv, "-modify") == 0) {
344 } else if (strcmp(*argv, "-list") == 0) {
346 } else if (strcmp(*argv, "-gn") == 0) {
350 } else if (strcmp(*argv, "-userinfo") == 0) {
353 userinfo = *(++argv);
354 } else if (strcmp(*argv, "-passin") == 0) {
357 passargin = *(++argv);
358 } else if (strcmp(*argv, "-passout") == 0) {
361 passargout = *(++argv);
363 # ifndef OPENSSL_NO_ENGINE
364 else if (strcmp(*argv, "-engine") == 0) {
371 else if (**argv == '-') {
373 BIO_printf(bio_err, "unknown option %s\n", *argv);
384 if (dbfile && configfile) {
386 "-dbfile and -configfile cannot be specified together.\n");
389 if (add_user + delete_user + modify_user + list_user != 1) {
391 "Exactly one of the options -add, -delete, -modify -list must be specified.\n");
394 if (delete_user + modify_user + delete_user == 1 && argc <= 0) {
396 "Need at least one user for options -add, -delete, -modify. \n");
399 if ((passargin || passargout) && argc != 1) {
401 "-passin, -passout arguments only valid with one user.\n");
406 for (pp = srp_usage; (*pp != NULL); pp++)
407 BIO_printf(bio_err, "%s", *pp);
409 BIO_printf(bio_err, " -rand file%cfile%c...\n", LIST_SEPARATOR_CHAR,
410 LIST_SEPARATOR_CHAR);
412 " load the file (or the files in the directory) into\n");
413 BIO_printf(bio_err, " the random number generator\n");
417 ERR_load_crypto_strings();
419 e = setup_engine(bio_err, engine, 0);
421 if (!app_passwd(bio_err, passargin, passargout, &passin, &passout)) {
422 BIO_printf(bio_err, "Error getting passwords\n");
428 /*****************************************************************/
430 if (configfile == NULL)
431 configfile = getenv("OPENSSL_CONF");
432 if (configfile == NULL)
433 configfile = getenv("SSLEAY_CONF");
434 if (configfile == NULL) {
435 const char *s = X509_get_default_cert_area();
438 # ifdef OPENSSL_SYS_VMS
439 len = strlen(s) + sizeof(CONFIG_FILE);
440 tofree = OPENSSL_malloc(len);
442 BIO_printf(bio_err, "Out of memory\n");
447 len = strlen(s) + sizeof(CONFIG_FILE) + 1;
448 tofree = OPENSSL_malloc(len);
450 BIO_printf(bio_err, "Out of memory\n");
453 BUF_strlcpy(tofree, s, len);
454 BUF_strlcat(tofree, "/", len);
456 BUF_strlcat(tofree, CONFIG_FILE, len);
460 VERBOSE BIO_printf(bio_err, "Using configuration from %s\n",
462 conf = NCONF_new(NULL);
463 if (NCONF_load(conf, configfile, &errorline) <= 0) {
465 BIO_printf(bio_err, "error loading the config file '%s'\n",
468 BIO_printf(bio_err, "error on line %ld of config file '%s'\n",
469 errorline, configfile);
473 OPENSSL_free(tofree);
477 if (!load_config(bio_err, conf))
480 /* Lets get the config section we are using */
481 if (section == NULL) {
482 VERBOSE BIO_printf(bio_err,
483 "trying to read " ENV_DEFAULT_SRP
484 " in \" BASE_SECTION \"\n");
486 section = NCONF_get_string(conf, BASE_SECTION, ENV_DEFAULT_SRP);
487 if (section == NULL) {
488 lookup_fail(BASE_SECTION, ENV_DEFAULT_SRP);
493 if (randfile == NULL && conf)
494 randfile = NCONF_get_string(conf, BASE_SECTION, "RANDFILE");
496 VERBOSE BIO_printf(bio_err,
497 "trying to read " ENV_DATABASE
498 " in section \"%s\"\n", section);
500 if ((dbfile = NCONF_get_string(conf, section, ENV_DATABASE)) == NULL) {
501 lookup_fail(section, ENV_DATABASE);
506 if (randfile == NULL)
509 app_RAND_load_file(randfile, bio_err, 0);
511 VERBOSE BIO_printf(bio_err, "Trying to read SRP verifier file \"%s\"\n",
514 db = load_index(dbfile, &db_attr);
518 /* Lets check some fields */
519 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
520 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
522 if (pp[DB_srptype][0] == DB_SRP_INDEX) {
524 if (gNindex < 0 && gN != NULL && !strcmp(gN, pp[DB_srpid]))
527 print_index(db, bio_err, i, verbose > 1);
531 VERBOSE BIO_printf(bio_err, "Database initialised\n");
534 gNrow = sk_OPENSSL_PSTRING_value(db->db->data, gNindex);
535 print_entry(db, bio_err, gNindex, verbose > 1, "Default g and N");
536 } else if (maxgN > 0 && !SRP_get_default_gN(gN)) {
537 BIO_printf(bio_err, "No g and N value for index \"%s\"\n", gN);
540 VERBOSE BIO_printf(bio_err, "Database has no g N information.\n");
544 VVERBOSE BIO_printf(bio_err, "Starting user processing\n");
549 while (list_user || user) {
552 VVERBOSE BIO_printf(bio_err, "Processing user \"%s\"\n", user);
553 if ((userindex = get_index(db, user, 'U')) >= 0) {
554 print_user(db, bio_err, userindex, (verbose > 0) || list_user);
559 BIO_printf(bio_err, "List all users\n");
561 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
562 print_user(db, bio_err, i, 1);
565 } else if (userindex < 0) {
567 "user \"%s\" does not exist, ignored. t\n", user);
570 } else if (add_user) {
571 if (userindex >= 0) {
572 /* reactivation of a new user */
574 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
575 BIO_printf(bio_err, "user \"%s\" reactivated.\n", user);
576 row[DB_srptype][0] = 'V';
580 char *row[DB_NUMBER];
582 row[DB_srpverifier] = NULL;
583 row[DB_srpsalt] = NULL;
584 row[DB_srpinfo] = NULL;
587 srp_create_user(user, &(row[DB_srpverifier]),
589 gNrow ? gNrow[DB_srpsalt] : gN,
590 gNrow ? gNrow[DB_srpverifier] : NULL,
591 passout, bio_err, verbose))) {
593 "Cannot create srp verifier for user \"%s\", operation abandoned .\n",
598 row[DB_srpid] = BUF_strdup(user);
599 row[DB_srptype] = BUF_strdup("v");
600 row[DB_srpgN] = BUF_strdup(gNid);
602 if (!row[DB_srpid] || !row[DB_srpgN] || !row[DB_srptype]
603 || !row[DB_srpverifier] || !row[DB_srpsalt] || (userinfo
610 || !update_index(db, bio_err, row)) {
612 OPENSSL_free(row[DB_srpid]);
614 OPENSSL_free(row[DB_srpgN]);
616 OPENSSL_free(row[DB_srpinfo]);
618 OPENSSL_free(row[DB_srptype]);
619 if (row[DB_srpverifier])
620 OPENSSL_free(row[DB_srpverifier]);
622 OPENSSL_free(row[DB_srpsalt]);
627 } else if (modify_user) {
630 "user \"%s\" does not exist, operation ignored.\n",
636 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
637 char type = row[DB_srptype][0];
640 "user \"%s\" already updated, operation ignored.\n",
646 if (row[DB_srptype][0] == 'V') {
649 VERBOSE BIO_printf(bio_err,
650 "Verifying password for user \"%s\"\n",
653 get_index(db, row[DB_srpgN], DB_SRP_INDEX)) >= 0)
655 (char **)sk_OPENSSL_PSTRING_value(db->
660 (user, row[DB_srpverifier], row[DB_srpsalt],
661 irow ? irow[DB_srpsalt] : row[DB_srpgN],
662 irow ? irow[DB_srpverifier] : NULL, passin,
665 "Invalid password for user \"%s\", operation abandoned.\n",
671 VERBOSE BIO_printf(bio_err,
672 "Password for user \"%s\" ok.\n",
677 srp_create_user(user, &(row[DB_srpverifier]),
679 gNrow ? gNrow[DB_srpsalt] : NULL,
680 gNrow ? gNrow[DB_srpverifier] : NULL,
681 passout, bio_err, verbose))) {
683 "Cannot create srp verifier for user \"%s\", operation abandoned.\n",
689 row[DB_srptype][0] = 'v';
690 row[DB_srpgN] = BUF_strdup(gNid);
692 if (!row[DB_srpid] || !row[DB_srpgN] || !row[DB_srptype]
693 || !row[DB_srpverifier] || !row[DB_srpsalt]
695 && (!(row[DB_srpinfo] = BUF_strdup(userinfo)))))
701 } else if (delete_user) {
704 "user \"%s\" does not exist, operation ignored. t\n",
709 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
710 BIO_printf(bio_err, "user \"%s\" revoked. t\n", user);
712 xpp[DB_srptype][0] = 'R';
725 VERBOSE BIO_printf(bio_err, "User procession done.\n");
728 /* Lets check some fields */
729 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
730 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
732 if (pp[DB_srptype][0] == 'v') {
733 pp[DB_srptype][0] = 'V';
734 print_user(db, bio_err, i, verbose);
738 VERBOSE BIO_printf(bio_err, "Trying to update srpvfile.\n");
739 if (!save_index(dbfile, "new", db))
742 VERBOSE BIO_printf(bio_err, "Temporary srpvfile created.\n");
743 if (!rotate_index(dbfile, "new", "old"))
746 VERBOSE BIO_printf(bio_err, "srpvfile updated.\n");
752 VERBOSE BIO_printf(bio_err, "User errors %d.\n", errors);
754 VERBOSE BIO_printf(bio_err, "SRP terminating with code %d.\n", ret);
756 OPENSSL_free(tofree);
758 ERR_print_errors(bio_err);
760 app_RAND_write_file(randfile, bio_err);
773 static void *dummy = &dummy;