2 /* Written by Peter Sylvester (peter.sylvester@edelweb.fr)
3 * for the EdelKey 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>
74 # define PROG srp_main
76 # define BASE_SECTION "srp"
77 # define CONFIG_FILE "openssl.cnf"
79 # define ENV_RANDFILE "RANDFILE"
81 # define ENV_DATABASE "srpvfile"
82 # define ENV_DEFAULT_SRP "default_srp"
84 static char *srp_usage[] = {
85 "usage: srp [args] [user] \n",
87 " -verbose Talk a lot while doing things\n",
88 " -config file A config file\n",
89 " -name arg The particular srp definition to use\n",
90 " -srpvfile arg The srp verifier file name\n",
91 " -add add an user and srp verifier\n",
92 " -modify modify the srp verifier of an existing user\n",
93 " -delete delete user from verifier file\n",
95 " -gn arg g and N values to be used for new verifier\n",
96 " -userinfo arg additional info to be set for user\n",
97 " -passin arg input file pass phrase source\n",
98 " -passout arg output file pass phrase source\n",
99 # ifndef OPENSSL_NO_ENGINE
100 " -engine e - use engine e, possibly a hardware device.\n",
106 extern int EF_PROTECT_FREE;
107 extern int EF_PROTECT_BELOW;
108 extern int EF_ALIGNMENT;
111 static CONF *conf = NULL;
112 static char *section = NULL;
114 # define VERBOSE if (verbose)
115 # define VVERBOSE if (verbose>1)
117 int MAIN(int, char **);
119 static int get_index(CA_DB *db, char *id, char type)
125 if (type == DB_SRP_INDEX)
126 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
127 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
128 if (pp[DB_srptype][0] == DB_SRP_INDEX
129 && !strcmp(id, pp[DB_srpid]))
132 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
133 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
135 if (pp[DB_srptype][0] != DB_SRP_INDEX
136 && !strcmp(id, pp[DB_srpid]))
143 static void print_entry(CA_DB *db, BIO *bio, int indx, int verbose, char *s)
145 if (indx >= 0 && verbose) {
147 char **pp = sk_OPENSSL_PSTRING_value(db->db->data, indx);
148 BIO_printf(bio, "%s \"%s\"\n", s, pp[DB_srpid]);
149 for (j = 0; j < DB_NUMBER; j++) {
150 BIO_printf(bio_err, " %d = \"%s\"\n", j, pp[j]);
155 static void print_index(CA_DB *db, BIO *bio, int indexindex, int verbose)
157 print_entry(db, bio, indexindex, verbose, "g N entry");
160 static void print_user(CA_DB *db, BIO *bio, int userindex, int verbose)
163 char **pp = sk_OPENSSL_PSTRING_value(db->db->data, userindex);
165 if (pp[DB_srptype][0] != 'I') {
166 print_entry(db, bio, userindex, verbose, "User entry");
167 print_entry(db, bio, get_index(db, pp[DB_srpgN], 'I'), verbose,
174 static int update_index(CA_DB *db, BIO *bio, char **row)
180 (char **)OPENSSL_malloc(sizeof(char *) * (DB_NUMBER + 1))) == NULL) {
181 BIO_printf(bio_err, "Memory allocation failure\n");
185 for (i = 0; i < DB_NUMBER; i++) {
189 irow[DB_NUMBER] = NULL;
191 if (!TXT_DB_insert(db->db, irow)) {
192 BIO_printf(bio, "failed to update srpvfile\n");
193 BIO_printf(bio, "TXT_DB error number %ld\n", db->db->error);
200 static void lookup_fail(const char *name, const char *tag)
202 BIO_printf(bio_err, "variable lookup failed for %s::%s\n", name, tag);
205 static char *srp_verify_user(const char *user, const char *srp_verifier,
206 char *srp_usersalt, const char *g, const char *N,
207 const char *passin, BIO *bio, int verbose)
211 char *verifier = NULL;
214 cb_tmp.prompt_info = user;
215 cb_tmp.password = passin;
217 if (password_callback(password, 1024, 0, &cb_tmp) > 0) {
218 VERBOSE BIO_printf(bio,
221 " srp_verifier=\"%s\"\n"
222 " srp_usersalt=\"%s\"\n"
223 " g=\"%s\"\n N=\"%s\"\n",
224 user, srp_verifier, srp_usersalt, g, N);
225 BIO_printf(bio, "Pass %s\n", password);
227 OPENSSL_assert(srp_usersalt != NULL);
228 if (!(gNid = SRP_create_verifier(user, password, &srp_usersalt,
230 BIO_printf(bio, "Internal error validating SRP verifier\n");
232 if (strcmp(verifier, srp_verifier))
234 OPENSSL_free(verifier);
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)
248 cb_tmp.prompt_info = user;
249 cb_tmp.password = passout;
251 if (password_callback(password, 1024, 1, &cb_tmp) > 0) {
252 VERBOSE BIO_printf(bio,
255 " g=\"%s\"\n" " N=\"%s\"\n", user, g, N);
256 if (!(gNid = SRP_create_verifier(user, password, &salt,
257 srp_verifier, N, g))) {
258 BIO_printf(bio, "Internal error creating SRP verifier\n");
260 *srp_usersalt = salt;
261 VVERBOSE BIO_printf(bio, "gNid=%s salt =\"%s\"\n verifier =\"%s\"\n",
262 gNid, salt, *srp_verifier);
268 int MAIN(int argc, char **argv)
276 char *passargin = NULL, *passargout = NULL;
277 char *passin = NULL, *passout = NULL;
283 char *userinfo = NULL;
290 char *configfile = NULL;
296 char *randfile = NULL;
297 # ifndef OPENSSL_NO_ENGINE
305 EF_PROTECT_BELOW = 1;
315 if ((bio_err = BIO_new(BIO_s_file())) != NULL)
316 BIO_set_fp(bio_err, stderr, BIO_NOCLOSE | BIO_FP_TEXT);
320 while (argc >= 1 && badops == 0) {
321 if (strcmp(*argv, "-verbose") == 0)
323 else if (strcmp(*argv, "-config") == 0) {
326 configfile = *(++argv);
327 } else if (strcmp(*argv, "-name") == 0) {
331 } else if (strcmp(*argv, "-srpvfile") == 0) {
335 } else if (strcmp(*argv, "-add") == 0)
337 else if (strcmp(*argv, "-delete") == 0)
339 else if (strcmp(*argv, "-modify") == 0)
341 else if (strcmp(*argv, "-list") == 0)
343 else if (strcmp(*argv, "-gn") == 0) {
347 } else if (strcmp(*argv, "-userinfo") == 0) {
350 userinfo = *(++argv);
351 } else if (strcmp(*argv, "-passin") == 0) {
354 passargin = *(++argv);
355 } else if (strcmp(*argv, "-passout") == 0) {
358 passargout = *(++argv);
360 # ifndef OPENSSL_NO_ENGINE
361 else if (strcmp(*argv, "-engine") == 0) {
368 else if (**argv == '-') {
370 BIO_printf(bio_err, "unknown option %s\n", *argv);
380 if (dbfile && configfile) {
382 "-dbfile and -configfile cannot be specified together.\n");
385 if (add_user + delete_user + modify_user + list_user != 1) {
386 BIO_printf(bio_err, "Exactly one of the options "
387 "-add, -delete, -modify -list must be specified.\n");
390 if (delete_user + modify_user + delete_user == 1 && argc <= 0) {
391 BIO_printf(bio_err, "Need at least one user for options "
392 "-add, -delete, -modify. \n");
395 if ((passin || passout) && argc != 1) {
397 "-passin, -passout arguments only valid with one user.\n");
402 for (pp = srp_usage; (*pp != NULL); pp++)
403 BIO_printf(bio_err, "%s", *pp);
405 BIO_printf(bio_err, " -rand file%cfile%c...\n", LIST_SEPARATOR_CHAR,
406 LIST_SEPARATOR_CHAR);
408 " load the file (or the files in the directory) into\n");
409 BIO_printf(bio_err, " the random number generator\n");
413 ERR_load_crypto_strings();
415 # ifndef OPENSSL_NO_ENGINE
416 setup_engine(bio_err, engine, 0);
419 if (!app_passwd(bio_err, passargin, passargout, &passin, &passout)) {
420 BIO_printf(bio_err, "Error getting passwords\n");
426 /*****************************************************************/
428 if (configfile == NULL)
429 configfile = getenv("OPENSSL_CONF");
430 if (configfile == NULL)
431 configfile = getenv("SSLEAY_CONF");
432 if (configfile == NULL) {
433 const char *s = X509_get_default_cert_area();
436 # ifdef OPENSSL_SYS_VMS
437 len = strlen(s) + sizeof(CONFIG_FILE);
438 tofree = OPENSSL_malloc(len);
441 len = strlen(s) + sizeof(CONFIG_FILE) + 1;
442 tofree = OPENSSL_malloc(len);
443 BUF_strlcpy(tofree, s, len);
444 BUF_strlcat(tofree, "/", len);
446 BUF_strlcat(tofree, CONFIG_FILE, len);
450 VERBOSE BIO_printf(bio_err, "Using configuration from %s\n",
452 conf = NCONF_new(NULL);
453 if (NCONF_load(conf, configfile, &errorline) <= 0) {
455 BIO_printf(bio_err, "error loading the config file '%s'\n",
458 BIO_printf(bio_err, "error on line %ld of config file '%s'\n",
459 errorline, configfile);
463 OPENSSL_free(tofree);
467 if (!load_config(bio_err, conf))
470 /* Lets get the config section we are using */
471 if (section == NULL) {
472 VERBOSE BIO_printf(bio_err,
473 "trying to read " ENV_DEFAULT_SRP
474 " in \" BASE_SECTION \"\n");
476 section = NCONF_get_string(conf, BASE_SECTION, ENV_DEFAULT_SRP);
477 if (section == NULL) {
478 lookup_fail(BASE_SECTION, ENV_DEFAULT_SRP);
483 if (randfile == NULL && conf)
484 randfile = NCONF_get_string(conf, BASE_SECTION, "RANDFILE");
486 VERBOSE BIO_printf(bio_err,
487 "trying to read " ENV_DATABASE
488 " in section \"%s\"\n", section);
490 if ((dbfile = NCONF_get_string(conf, section, ENV_DATABASE)) == NULL) {
491 lookup_fail(section, ENV_DATABASE);
496 if (randfile == NULL)
499 app_RAND_load_file(randfile, bio_err, 0);
501 VERBOSE BIO_printf(bio_err, "Trying to read SRP verifier file \"%s\"\n",
504 db = load_index(dbfile, &db_attr);
508 /* Lets check some fields */
509 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
510 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
512 if (pp[DB_srptype][0] == DB_SRP_INDEX) {
514 if (gNindex < 0 && gN != NULL && !strcmp(gN, pp[DB_srpid]))
517 print_index(db, bio_err, i, verbose > 1);
521 VERBOSE BIO_printf(bio_err, "Database initialised\n");
524 gNrow = sk_OPENSSL_PSTRING_value(db->db->data, gNindex);
525 print_entry(db, bio_err, gNindex, verbose > 1, "Default g and N");
526 } else if (maxgN > 0 && !SRP_get_default_gN(gN)) {
527 BIO_printf(bio_err, "No g and N value for index \"%s\"\n", gN);
530 VERBOSE BIO_printf(bio_err, "Database has no g N information.\n");
534 VVERBOSE BIO_printf(bio_err, "Starting user processing\n");
539 while (list_user || user) {
542 VVERBOSE BIO_printf(bio_err, "Processing user \"%s\"\n", user);
543 if ((userindex = get_index(db, user, 'U')) >= 0) {
544 print_user(db, bio_err, userindex, (verbose > 0) || list_user);
549 BIO_printf(bio_err, "List all users\n");
551 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
552 print_user(db, bio_err, i, 1);
555 } else if (userindex < 0) {
557 "user \"%s\" does not exist, ignored. t\n", user);
560 } else if (add_user) {
561 if (userindex >= 0) {
562 /* reactivation of a new user */
564 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
565 BIO_printf(bio_err, "user \"%s\" reactivated.\n", user);
566 row[DB_srptype][0] = 'V';
570 char *row[DB_NUMBER];
572 row[DB_srpverifier] = NULL;
573 row[DB_srpsalt] = NULL;
574 row[DB_srpinfo] = NULL;
575 if (!(gNid = srp_create_user(user, &(row[DB_srpverifier]),
577 gNrow ? gNrow[DB_srpsalt] : gN,
578 gNrow ? gNrow[DB_srpverifier] :
579 NULL, passout, bio_err,
582 "Cannot create srp verifier for user \"%s\","
583 " operation abandoned .\n", user);
587 row[DB_srpid] = BUF_strdup(user);
588 row[DB_srptype] = BUF_strdup("v");
589 row[DB_srpgN] = BUF_strdup(gNid);
591 if (!row[DB_srpid] || !row[DB_srpgN] || !row[DB_srptype]
592 || !row[DB_srpverifier] || !row[DB_srpsalt]
594 && (!(row[DB_srpinfo] = BUF_strdup(userinfo))))
595 || !update_index(db, bio_err, row)) {
597 OPENSSL_free(row[DB_srpid]);
599 OPENSSL_free(row[DB_srpgN]);
601 OPENSSL_free(row[DB_srpinfo]);
603 OPENSSL_free(row[DB_srptype]);
604 if (row[DB_srpverifier])
605 OPENSSL_free(row[DB_srpverifier]);
607 OPENSSL_free(row[DB_srpsalt]);
612 } else if (modify_user) {
615 "user \"%s\" does not exist, operation ignored.\n",
621 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
622 char type = row[DB_srptype][0];
625 "user \"%s\" already updated, operation ignored.\n",
631 if (row[DB_srptype][0] == 'V') {
634 VERBOSE BIO_printf(bio_err,
635 "Verifying password for user \"%s\"\n",
638 get_index(db, row[DB_srpgN], DB_SRP_INDEX)) >= 0)
640 sk_OPENSSL_PSTRING_value(db->db->data,
644 (user, row[DB_srpverifier], row[DB_srpsalt],
645 irow ? irow[DB_srpsalt] : row[DB_srpgN],
646 irow ? irow[DB_srpverifier] : NULL, passin,
649 "Invalid password for user \"%s\", operation abandoned.\n",
655 VERBOSE BIO_printf(bio_err,
656 "Password for user \"%s\" ok.\n",
659 if (!(gNid = srp_create_user(user, &(row[DB_srpverifier]),
661 gNrow ? gNrow[DB_srpsalt] :
663 gNrow ? gNrow[DB_srpverifier]
664 : NULL, passout, bio_err,
667 "Cannot create srp verifier for user \"%s\","
668 " operation abandoned.\n", user);
673 row[DB_srptype][0] = 'v';
674 row[DB_srpgN] = BUF_strdup(gNid);
676 if (!row[DB_srpid] || !row[DB_srpgN] || !row[DB_srptype]
677 || !row[DB_srpverifier] || !row[DB_srpsalt]
679 && (!(row[DB_srpinfo] = BUF_strdup(userinfo)))))
685 } else if (delete_user) {
688 "user \"%s\" does not exist, operation ignored. t\n",
693 sk_OPENSSL_PSTRING_value(db->db->data, userindex);
694 BIO_printf(bio_err, "user \"%s\" revoked. t\n", user);
696 xpp[DB_srptype][0] = 'R';
709 VERBOSE BIO_printf(bio_err, "User procession done.\n");
712 /* Lets check some fields */
713 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
714 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
716 if (pp[DB_srptype][0] == 'v') {
717 pp[DB_srptype][0] = 'V';
718 print_user(db, bio_err, i, verbose);
722 VERBOSE BIO_printf(bio_err, "Trying to update srpvfile.\n");
723 if (!save_index(dbfile, "new", db))
726 VERBOSE BIO_printf(bio_err, "Temporary srpvfile created.\n");
727 if (!rotate_index(dbfile, "new", "old"))
730 VERBOSE BIO_printf(bio_err, "srpvfile updated.\n");
736 VERBOSE BIO_printf(bio_err, "User errors %d.\n", errors);
738 VERBOSE BIO_printf(bio_err, "SRP terminating with code %d.\n", ret);
740 OPENSSL_free(tofree);
742 ERR_print_errors(bio_err);
744 app_RAND_write_file(randfile, bio_err);