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 a lot 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++) {
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, const 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;
215 cb_tmp.prompt_info = user;
216 cb_tmp.password = passin;
218 if (password_callback(password, 1024, 0, &cb_tmp) > 0) {
219 VERBOSE BIO_printf(bio,
222 " srp_verifier=\"%s\"\n"
223 " srp_usersalt=\"%s\"\n"
224 " g=\"%s\"\n N=\"%s\"\n",
225 user, srp_verifier, srp_usersalt, g, N);
226 BIO_printf(bio, "Pass %s\n", password);
228 OPENSSL_assert(srp_usersalt != NULL);
229 if (!(gNid = SRP_create_verifier(user, password, &srp_usersalt,
231 BIO_printf(bio, "Internal error validating SRP verifier\n");
233 if (strcmp(verifier, srp_verifier))
235 OPENSSL_free(verifier);
241 static char *srp_create_user(char *user, char **srp_verifier,
242 char **srp_usersalt, char *g, char *N,
243 char *passout, BIO *bio, int verbose)
249 cb_tmp.prompt_info = user;
250 cb_tmp.password = passout;
252 if (password_callback(password, 1024, 1, &cb_tmp) > 0) {
253 VERBOSE BIO_printf(bio,
256 " g=\"%s\"\n" " N=\"%s\"\n", user, g, N);
257 if (!(gNid = SRP_create_verifier(user, password, &salt,
258 srp_verifier, N, g))) {
259 BIO_printf(bio, "Internal error creating SRP verifier\n");
261 *srp_usersalt = salt;
262 VVERBOSE BIO_printf(bio, "gNid=%s salt =\"%s\"\n verifier =\"%s\"\n",
263 gNid, salt, *srp_verifier);
269 int MAIN(int argc, char **argv)
277 char *passargin = NULL, *passargout = NULL;
278 char *passin = NULL, *passout = NULL;
284 char *userinfo = NULL;
291 char *configfile = NULL;
297 char *randfile = NULL;
298 # ifndef OPENSSL_NO_ENGINE
306 EF_PROTECT_BELOW = 1;
316 if ((bio_err = BIO_new(BIO_s_file())) != NULL)
317 BIO_set_fp(bio_err, stderr, BIO_NOCLOSE | BIO_FP_TEXT);
321 while (argc >= 1 && badops == 0) {
322 if (strcmp(*argv, "-verbose") == 0)
324 else if (strcmp(*argv, "-config") == 0) {
327 configfile = *(++argv);
328 } else if (strcmp(*argv, "-name") == 0) {
332 } else if (strcmp(*argv, "-srpvfile") == 0) {
336 } else if (strcmp(*argv, "-add") == 0)
338 else if (strcmp(*argv, "-delete") == 0)
340 else if (strcmp(*argv, "-modify") == 0)
342 else if (strcmp(*argv, "-list") == 0)
344 else if (strcmp(*argv, "-gn") == 0) {
348 } else if (strcmp(*argv, "-userinfo") == 0) {
351 userinfo = *(++argv);
352 } else if (strcmp(*argv, "-passin") == 0) {
355 passargin = *(++argv);
356 } else if (strcmp(*argv, "-passout") == 0) {
359 passargout = *(++argv);
361 # ifndef OPENSSL_NO_ENGINE
362 else if (strcmp(*argv, "-engine") == 0) {
369 else if (**argv == '-') {
371 BIO_printf(bio_err, "unknown option %s\n", *argv);
381 if (dbfile && configfile) {
383 "-dbfile and -configfile cannot be specified together.\n");
386 if (add_user + delete_user + modify_user + list_user != 1) {
387 BIO_printf(bio_err, "Exactly one of the options "
388 "-add, -delete, -modify -list must be specified.\n");
391 if (delete_user + modify_user + delete_user == 1 && argc <= 0) {
392 BIO_printf(bio_err, "Need at least one user for options "
393 "-add, -delete, -modify. \n");
396 if ((passin || passout) && argc != 1) {
398 "-passin, -passout arguments only valid with one user.\n");
403 for (pp = srp_usage; (*pp != NULL); pp++)
404 BIO_printf(bio_err, "%s", *pp);
406 BIO_printf(bio_err, " -rand file%cfile%c...\n", LIST_SEPARATOR_CHAR,
407 LIST_SEPARATOR_CHAR);
409 " load the file (or the files in the directory) into\n");
410 BIO_printf(bio_err, " the random number generator\n");
414 ERR_load_crypto_strings();
416 # ifndef OPENSSL_NO_ENGINE
417 setup_engine(bio_err, engine, 0);
420 if (!app_passwd(bio_err, passargin, passargout, &passin, &passout)) {
421 BIO_printf(bio_err, "Error getting passwords\n");
427 /*****************************************************************/
429 if (configfile == NULL)
430 configfile = getenv("OPENSSL_CONF");
431 if (configfile == NULL)
432 configfile = getenv("SSLEAY_CONF");
433 if (configfile == NULL) {
434 const char *s = X509_get_default_cert_area();
437 # ifdef OPENSSL_SYS_VMS
438 len = strlen(s) + sizeof(CONFIG_FILE);
439 tofree = OPENSSL_malloc(len);
442 len = strlen(s) + sizeof(CONFIG_FILE) + 1;
443 tofree = OPENSSL_malloc(len);
444 BUF_strlcpy(tofree, s, len);
445 BUF_strlcat(tofree, "/", len);
447 BUF_strlcat(tofree, CONFIG_FILE, len);
451 VERBOSE BIO_printf(bio_err, "Using configuration from %s\n",
453 conf = NCONF_new(NULL);
454 if (NCONF_load(conf, configfile, &errorline) <= 0) {
456 BIO_printf(bio_err, "error loading the config file '%s'\n",
459 BIO_printf(bio_err, "error on line %ld of config file '%s'\n",
460 errorline, configfile);
464 OPENSSL_free(tofree);
468 if (!load_config(bio_err, conf))
471 /* Lets get the config section we are using */
472 if (section == NULL) {
473 VERBOSE BIO_printf(bio_err,
474 "trying to read " ENV_DEFAULT_SRP
475 " in \" BASE_SECTION \"\n");
477 section = NCONF_get_string(conf, BASE_SECTION, ENV_DEFAULT_SRP);
478 if (section == NULL) {
479 lookup_fail(BASE_SECTION, ENV_DEFAULT_SRP);
484 if (randfile == NULL && conf)
485 randfile = NCONF_get_string(conf, BASE_SECTION, "RANDFILE");
487 VERBOSE BIO_printf(bio_err,
488 "trying to read " ENV_DATABASE
489 " in section \"%s\"\n", section);
491 if ((dbfile = NCONF_get_string(conf, section, ENV_DATABASE)) == NULL) {
492 lookup_fail(section, ENV_DATABASE);
497 if (randfile == NULL)
500 app_RAND_load_file(randfile, bio_err, 0);
502 VERBOSE BIO_printf(bio_err, "Trying to read SRP verifier file \"%s\"\n",
505 db = load_index(dbfile, &db_attr);
509 /* Lets check some fields */
510 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
511 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
513 if (pp[DB_srptype][0] == DB_SRP_INDEX) {
515 if (gNindex < 0 && gN != NULL && !strcmp(gN, pp[DB_srpid]))
518 print_index(db, bio_err, i, verbose > 1);
522 VERBOSE BIO_printf(bio_err, "Database initialised\n");
525 gNrow = sk_OPENSSL_PSTRING_value(db->db->data, gNindex);
526 print_entry(db, bio_err, gNindex, verbose > 1, "Default g and N");
527 } else if (maxgN > 0 && !SRP_get_default_gN(gN)) {
528 BIO_printf(bio_err, "No g and N value for index \"%s\"\n", gN);
531 VERBOSE BIO_printf(bio_err, "Database has no g N information.\n");
535 VVERBOSE BIO_printf(bio_err, "Starting user processing\n");
540 while (list_user || user) {
543 VVERBOSE BIO_printf(bio_err, "Processing user \"%s\"\n", user);
544 if ((userindex = get_index(db, user, 'U')) >= 0) {
545 print_user(db, bio_err, userindex, (verbose > 0) || list_user);
550 BIO_printf(bio_err, "List all users\n");
552 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
553 print_user(db, bio_err, i, 1);
556 } else if (userindex < 0) {
558 "user \"%s\" does not exist, ignored. t\n", user);
561 } else if (add_user) {
562 if (userindex >= 0) {
563 /* reactivation of a new user */
565 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
566 BIO_printf(bio_err, "user \"%s\" reactivated.\n", user);
567 row[DB_srptype][0] = 'V';
571 char *row[DB_NUMBER];
573 row[DB_srpverifier] = NULL;
574 row[DB_srpsalt] = NULL;
575 row[DB_srpinfo] = NULL;
576 if (!(gNid = srp_create_user(user, &(row[DB_srpverifier]),
578 gNrow ? gNrow[DB_srpsalt] : gN,
579 gNrow ? gNrow[DB_srpverifier] :
580 NULL, passout, bio_err,
583 "Cannot create srp verifier for user \"%s\","
584 " operation abandoned .\n", user);
588 row[DB_srpid] = BUF_strdup(user);
589 row[DB_srptype] = BUF_strdup("v");
590 row[DB_srpgN] = BUF_strdup(gNid);
592 if (!row[DB_srpid] || !row[DB_srpgN] || !row[DB_srptype]
593 || !row[DB_srpverifier] || !row[DB_srpsalt]
595 && (!(row[DB_srpinfo] = BUF_strdup(userinfo))))
596 || !update_index(db, bio_err, row)) {
598 OPENSSL_free(row[DB_srpid]);
600 OPENSSL_free(row[DB_srpgN]);
602 OPENSSL_free(row[DB_srpinfo]);
604 OPENSSL_free(row[DB_srptype]);
605 if (row[DB_srpverifier])
606 OPENSSL_free(row[DB_srpverifier]);
608 OPENSSL_free(row[DB_srpsalt]);
613 } else if (modify_user) {
616 "user \"%s\" does not exist, operation ignored.\n",
622 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
623 char type = row[DB_srptype][0];
626 "user \"%s\" already updated, operation ignored.\n",
632 if (row[DB_srptype][0] == 'V') {
635 VERBOSE BIO_printf(bio_err,
636 "Verifying password for user \"%s\"\n",
639 get_index(db, row[DB_srpgN], DB_SRP_INDEX)) >= 0)
641 sk_OPENSSL_PSTRING_value(db->db->data,
645 (user, row[DB_srpverifier], row[DB_srpsalt],
646 irow ? irow[DB_srpsalt] : row[DB_srpgN],
647 irow ? irow[DB_srpverifier] : NULL, passin,
650 "Invalid password for user \"%s\", operation abandoned.\n",
656 VERBOSE BIO_printf(bio_err,
657 "Password for user \"%s\" ok.\n",
660 if (!(gNid = srp_create_user(user, &(row[DB_srpverifier]),
662 gNrow ? gNrow[DB_srpsalt] :
664 gNrow ? gNrow[DB_srpverifier]
665 : NULL, passout, bio_err,
668 "Cannot create srp verifier for user \"%s\","
669 " operation abandoned.\n", user);
674 row[DB_srptype][0] = 'v';
675 row[DB_srpgN] = BUF_strdup(gNid);
677 if (!row[DB_srpid] || !row[DB_srpgN] || !row[DB_srptype]
678 || !row[DB_srpverifier] || !row[DB_srpsalt]
680 && (!(row[DB_srpinfo] = BUF_strdup(userinfo)))))
686 } else if (delete_user) {
689 "user \"%s\" does not exist, operation ignored. t\n",
694 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
695 BIO_printf(bio_err, "user \"%s\" revoked. t\n", user);
697 xpp[DB_srptype][0] = 'R';
710 VERBOSE BIO_printf(bio_err, "User procession done.\n");
713 /* Lets check some fields */
714 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
715 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
717 if (pp[DB_srptype][0] == 'v') {
718 pp[DB_srptype][0] = 'V';
719 print_user(db, bio_err, i, verbose);
723 VERBOSE BIO_printf(bio_err, "Trying to update srpvfile.\n");
724 if (!save_index(dbfile, "new", db))
727 VERBOSE BIO_printf(bio_err, "Temporary srpvfile created.\n");
728 if (!rotate_index(dbfile, "new", "old"))
731 VERBOSE BIO_printf(bio_err, "srpvfile updated.\n");
737 VERBOSE BIO_printf(bio_err, "User errors %d.\n", errors);
739 VERBOSE BIO_printf(bio_err, "SRP terminating with code %d.\n", ret);
741 OPENSSL_free(tofree);
743 ERR_print_errors(bio_err);
745 app_RAND_write_file(randfile, bio_err);