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>
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)
118 int MAIN(int, char **);
120 static int get_index(CA_DB *db, char* id, char type)
124 if (id == NULL) return -1;
125 if (type == DB_SRP_INDEX)
126 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 && !strcmp(id,pp[DB_srpid]))
132 else 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 && !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)
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++)
152 BIO_printf(bio_err," %d = \"%s\"\n", j, pp[j]);
157 static void print_index(CA_DB *db, BIO *bio, int indexindex, int verbose)
159 print_entry(db, bio, indexindex, verbose, "g N entry") ;
162 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')
170 print_entry(db, bio, userindex, verbose, "User entry");
171 print_entry(db, bio, get_index(db, pp[DB_srpgN], 'I'), verbose, "g N entry");
177 static int update_index(CA_DB *db, BIO *bio, char **row)
182 if ((irow=(char **)OPENSSL_malloc(sizeof(char *)*(DB_NUMBER+1))) == NULL)
184 BIO_printf(bio_err,"Memory allocation failure\n");
188 for (i=0; i<DB_NUMBER; i++)
193 irow[DB_NUMBER]=NULL;
195 if (!TXT_DB_insert(db->db,irow))
197 BIO_printf(bio,"failed to update srpvfile\n");
198 BIO_printf(bio,"TXT_DB error number %ld\n",db->db->error);
205 static void lookup_fail(const char *name, const char *tag)
207 BIO_printf(bio_err,"variable lookup failed for %s::%s\n",name,tag);
211 static char *srp_verify_user(const char *user, const char *srp_verifier,
212 char *srp_usersalt, const char *g, const char *N,
213 const char *passin, BIO *bio, int verbose)
217 char *verifier = NULL;
220 cb_tmp.prompt_info = user;
221 cb_tmp.password = passin;
223 if (password_callback(password, 1024, 0, &cb_tmp) >0)
225 VERBOSE BIO_printf(bio,"Validating\n user=\"%s\"\n srp_verifier=\"%s\"\n srp_usersalt=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",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, &verifier,
232 BIO_printf(bio, "Internal error validating SRP verifier\n");
236 if (strcmp(verifier, srp_verifier))
238 OPENSSL_free(verifier);
244 static char *srp_create_user(char *user, char **srp_verifier,
245 char **srp_usersalt, char *g, char *N,
246 char *passout, BIO *bio, int verbose)
252 cb_tmp.prompt_info = user;
253 cb_tmp.password = passout;
255 if (password_callback(password,1024,1,&cb_tmp) >0)
257 VERBOSE BIO_printf(bio,"Creating\n user=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",user,g,N);
258 if (!(gNid =SRP_create_verifier(user, password, &salt, srp_verifier, N, g)))
260 BIO_printf(bio,"Internal error creating SRP verifier\n");
263 *srp_usersalt = salt;
264 VVERBOSE BIO_printf(bio,"gNid=%s salt =\"%s\"\n verifier =\"%s\"\n", gNid,salt, *srp_verifier);
270 int MAIN(int argc, char **argv)
278 char *passargin = NULL, *passargout = NULL;
279 char *passin = NULL, *passout = NULL;
282 char ** gNrow = NULL;
285 char * userinfo = NULL;
292 char *configfile=NULL;
299 #ifndef OPENSSL_NO_ENGINE
317 if ((bio_err=BIO_new(BIO_s_file())) != NULL)
318 BIO_set_fp(bio_err,stderr,BIO_NOCLOSE|BIO_FP_TEXT);
322 while (argc >= 1 && badops == 0)
324 if (strcmp(*argv,"-verbose") == 0)
326 else if (strcmp(*argv,"-config") == 0)
328 if (--argc < 1) goto bad;
329 configfile= *(++argv);
331 else if (strcmp(*argv,"-name") == 0)
333 if (--argc < 1) goto bad;
336 else if (strcmp(*argv,"-srpvfile") == 0)
338 if (--argc < 1) goto bad;
341 else if (strcmp(*argv,"-add") == 0)
343 else if (strcmp(*argv,"-delete") == 0)
345 else if (strcmp(*argv,"-modify") == 0)
347 else if (strcmp(*argv,"-list") == 0)
349 else if (strcmp(*argv,"-gn") == 0)
351 if (--argc < 1) goto bad;
354 else if (strcmp(*argv,"-userinfo") == 0)
356 if (--argc < 1) goto bad;
359 else if (strcmp(*argv,"-passin") == 0)
361 if (--argc < 1) goto bad;
362 passargin= *(++argv);
364 else if (strcmp(*argv,"-passout") == 0)
366 if (--argc < 1) goto bad;
367 passargout= *(++argv);
369 #ifndef OPENSSL_NO_ENGINE
370 else if (strcmp(*argv,"-engine") == 0)
372 if (--argc < 1) goto bad;
377 else if (**argv == '-')
380 BIO_printf(bio_err,"unknown option %s\n",*argv);
391 if (dbfile && configfile)
393 BIO_printf(bio_err,"-dbfile and -configfile cannot be specified together.\n");
396 if (add_user+delete_user+modify_user+list_user != 1)
398 BIO_printf(bio_err,"Exactly one of the options -add, -delete, -modify -list must be specified.\n");
401 if (delete_user+modify_user+delete_user== 1 && argc <= 0)
403 BIO_printf(bio_err,"Need at least one user for options -add, -delete, -modify. \n");
406 if ((passin || passout) && argc != 1 )
408 BIO_printf(bio_err,"-passin, -passout arguments only valid with one user.\n");
414 for (pp=srp_usage; (*pp != NULL); pp++)
415 BIO_printf(bio_err,"%s",*pp);
417 BIO_printf(bio_err," -rand file%cfile%c...\n", LIST_SEPARATOR_CHAR, LIST_SEPARATOR_CHAR);
418 BIO_printf(bio_err," load the file (or the files in the directory) into\n");
419 BIO_printf(bio_err," the random number generator\n");
423 ERR_load_crypto_strings();
425 #ifndef OPENSSL_NO_ENGINE
426 setup_engine(bio_err, engine, 0);
429 if(!app_passwd(bio_err, passargin, passargout, &passin, &passout))
431 BIO_printf(bio_err, "Error getting passwords\n");
439 /*****************************************************************/
441 if (configfile == NULL) configfile = getenv("OPENSSL_CONF");
442 if (configfile == NULL) configfile = getenv("SSLEAY_CONF");
443 if (configfile == NULL)
445 const char *s=X509_get_default_cert_area();
448 #ifdef OPENSSL_SYS_VMS
449 len = strlen(s)+sizeof(CONFIG_FILE);
450 tofree=OPENSSL_malloc(len);
453 len = strlen(s)+sizeof(CONFIG_FILE)+1;
454 tofree=OPENSSL_malloc(len);
455 BUF_strlcpy(tofree,s,len);
456 BUF_strlcat(tofree,"/",len);
458 BUF_strlcat(tofree,CONFIG_FILE,len);
462 VERBOSE BIO_printf(bio_err,"Using configuration from %s\n",configfile);
463 conf = NCONF_new(NULL);
464 if (NCONF_load(conf,configfile,&errorline) <= 0)
467 BIO_printf(bio_err,"error loading the config file '%s'\n",
470 BIO_printf(bio_err,"error on line %ld of config file '%s'\n"
471 ,errorline,configfile);
476 OPENSSL_free(tofree);
480 if (!load_config(bio_err, conf))
483 /* Lets get the config section we are using */
486 VERBOSE BIO_printf(bio_err,"trying to read " ENV_DEFAULT_SRP " in \" BASE_SECTION \"\n");
488 section=NCONF_get_string(conf,BASE_SECTION,ENV_DEFAULT_SRP);
491 lookup_fail(BASE_SECTION,ENV_DEFAULT_SRP);
496 if (randfile == NULL && conf)
497 randfile = NCONF_get_string(conf, BASE_SECTION, "RANDFILE");
500 VERBOSE BIO_printf(bio_err,"trying to read " ENV_DATABASE " in section \"%s\"\n",section);
502 if ((dbfile=NCONF_get_string(conf,section,ENV_DATABASE)) == NULL)
504 lookup_fail(section,ENV_DATABASE);
509 if (randfile == NULL)
512 app_RAND_load_file(randfile, bio_err, 0);
514 VERBOSE BIO_printf(bio_err,"Trying to read SRP verifier file \"%s\"\n",dbfile);
516 db = load_index(dbfile, &db_attr);
517 if (db == NULL) goto err;
519 /* Lets check some fields */
520 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++)
522 pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
524 if (pp[DB_srptype][0] == DB_SRP_INDEX)
527 if (gNindex < 0 && gN != NULL && !strcmp(gN, pp[DB_srpid]))
530 print_index(db, bio_err, i, verbose > 1);
534 VERBOSE BIO_printf(bio_err, "Database initialised\n");
538 gNrow = sk_OPENSSL_PSTRING_value(db->db->data,gNindex);
539 print_entry(db, bio_err, gNindex, verbose > 1, "Default g and N");
541 else if (maxgN > 0 && !SRP_get_default_gN(gN))
543 BIO_printf(bio_err, "No g and N value for index \"%s\"\n", gN);
548 VERBOSE BIO_printf(bio_err, "Database has no g N information.\n");
553 VVERBOSE BIO_printf(bio_err,"Starting user processing\n");
558 while (list_user || user)
562 VVERBOSE BIO_printf(bio_err, "Processing user \"%s\"\n", user);
563 if ((userindex = get_index(db, user, 'U')) >= 0)
565 print_user(db, bio_err, userindex, (verbose > 0) || list_user);
572 BIO_printf(bio_err,"List all users\n");
574 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++)
576 print_user(db,bio_err, i, 1);
580 else if (userindex < 0)
582 BIO_printf(bio_err, "user \"%s\" does not exist, ignored. t\n",
591 /* reactivation of a new user */
592 char **row = sk_OPENSSL_PSTRING_value(db->db->data, userindex);
593 BIO_printf(bio_err, "user \"%s\" reactivated.\n", user);
594 row[DB_srptype][0] = 'V';
600 char *row[DB_NUMBER] ; char *gNid;
601 row[DB_srpverifier] = NULL;
602 row[DB_srpsalt] = NULL;
603 row[DB_srpinfo] = NULL;
604 if (!(gNid = srp_create_user(user,&(row[DB_srpverifier]), &(row[DB_srpsalt]),gNrow?gNrow[DB_srpsalt]:gN,gNrow?gNrow[DB_srpverifier]:NULL, passout, bio_err,verbose)))
606 BIO_printf(bio_err, "Cannot create srp verifier for user \"%s\", operation abandoned .\n", user);
610 row[DB_srpid] = BUF_strdup(user);
611 row[DB_srptype] = BUF_strdup("v");
612 row[DB_srpgN] = BUF_strdup(gNid);
614 if (!row[DB_srpid] || !row[DB_srpgN] || !row[DB_srptype] || !row[DB_srpverifier] || !row[DB_srpsalt] ||
615 (userinfo && (!(row[DB_srpinfo] = BUF_strdup(userinfo)))) ||
616 !update_index(db, bio_err, row))
618 if (row[DB_srpid]) OPENSSL_free(row[DB_srpid]);
619 if (row[DB_srpgN]) OPENSSL_free(row[DB_srpgN]);
620 if (row[DB_srpinfo]) OPENSSL_free(row[DB_srpinfo]);
621 if (row[DB_srptype]) OPENSSL_free(row[DB_srptype]);
622 if (row[DB_srpverifier]) OPENSSL_free(row[DB_srpverifier]);
623 if (row[DB_srpsalt]) OPENSSL_free(row[DB_srpsalt]);
629 else if (modify_user)
633 BIO_printf(bio_err,"user \"%s\" does not exist, operation ignored.\n",user);
639 char **row = sk_OPENSSL_PSTRING_value(db->db->data, userindex);
640 char type = row[DB_srptype][0];
643 BIO_printf(bio_err,"user \"%s\" already updated, operation ignored.\n",user);
650 if (row[DB_srptype][0] == 'V')
654 VERBOSE BIO_printf(bio_err,"Verifying password for user \"%s\"\n",user);
655 if ( (user_gN = get_index(db, row[DB_srpgN], DB_SRP_INDEX)) >= 0)
656 irow = sk_OPENSSL_PSTRING_value(db->db->data, userindex);
658 if (!srp_verify_user(user, row[DB_srpverifier], row[DB_srpsalt], irow ? irow[DB_srpsalt] : row[DB_srpgN], irow ? irow[DB_srpverifier] : NULL, passin, bio_err, verbose))
660 BIO_printf(bio_err, "Invalid password for user \"%s\", operation abandoned.\n", user);
665 VERBOSE BIO_printf(bio_err,"Password for user \"%s\" ok.\n",user);
667 if (!(gNid=srp_create_user(user,&(row[DB_srpverifier]), &(row[DB_srpsalt]),gNrow?gNrow[DB_srpsalt]:NULL, gNrow?gNrow[DB_srpverifier]:NULL, passout, bio_err,verbose)))
669 BIO_printf(bio_err, "Cannot create srp verifier for user \"%s\", 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] || !row[DB_srpverifier] || !row[DB_srpsalt] ||
678 (userinfo && (!(row[DB_srpinfo] = BUF_strdup(userinfo)))))
685 else if (delete_user)
689 BIO_printf(bio_err, "user \"%s\" does not exist, operation ignored. t\n", user);
694 char **xpp = 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';
711 VERBOSE BIO_printf(bio_err,"User procession done.\n");
716 /* Lets check some fields */
717 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++)
719 pp = sk_OPENSSL_PSTRING_value(db->db->data,i);
721 if (pp[DB_srptype][0] == 'v')
723 pp[DB_srptype][0] = 'V';
724 print_user(db, bio_err, i, verbose);
728 VERBOSE BIO_printf(bio_err, "Trying to update srpvfile.\n");
729 if (!save_index(dbfile, "new", db)) goto err;
731 VERBOSE BIO_printf(bio_err, "Temporary srpvfile created.\n");
732 if (!rotate_index(dbfile, "new", "old")) goto err;
734 VERBOSE BIO_printf(bio_err, "srpvfile updated.\n");
740 VERBOSE BIO_printf(bio_err,"User errors %d.\n",errors);
742 VERBOSE BIO_printf(bio_err,"SRP terminating with code %d.\n",ret);
744 OPENSSL_free(tofree);
745 if (ret) ERR_print_errors(bio_err);
746 if (randfile) app_RAND_write_file(randfile, bio_err);
747 if (conf) NCONF_free(conf);
748 if (db) free_index(db);