apps/srp.c

   1 /*
   2  * Copyright 2004-2016 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <openssl/opensslconf.h>
  11 #ifdef OPENSSL_NO_SRP
  12 NON_EMPTY_TRANSLATION_UNIT
  13 #else
  14
  15 # include <stdio.h>
  16 # include <stdlib.h>
  17 # include <string.h>
  18 # include <openssl/conf.h>
  19 # include <openssl/bio.h>
  20 # include <openssl/err.h>
  21 # include <openssl/txt_db.h>
  22 # include <openssl/buffer.h>
  23 # include <openssl/srp.h>
  24 # include "apps.h"
  25
  26 # define BASE_SECTION    "srp"
  27 # define CONFIG_FILE "openssl.cnf"
  28
  29 # define ENV_RANDFILE            "RANDFILE"
  30
  31 # define ENV_DATABASE            "srpvfile"
  32 # define ENV_DEFAULT_SRP         "default_srp"
  33
  34 static int get_index(CA_DB *db, char *id, char type)
  35 {
  36     char **pp;
  37     int i;
  38     if (id == NULL)
  39         return -1;
  40     if (type == DB_SRP_INDEX)
  41         for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
  42             pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
  43             if (pp[DB_srptype][0] == DB_SRP_INDEX
  44                 && strcmp(id, pp[DB_srpid]) == 0)
  45                 return i;
  46     } else
  47         for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
  48             pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
  49
  50             if (pp[DB_srptype][0] != DB_SRP_INDEX
  51                 && strcmp(id, pp[DB_srpid]) == 0)
  52                 return i;
  53         }
  54
  55     return -1;
  56 }
  57
  58 static void print_entry(CA_DB *db, int indx, int verbose, char *s)
  59 {
  60     if (indx >= 0 && verbose) {
  61         int j;
  62         char **pp = sk_OPENSSL_PSTRING_value(db->db->data, indx);
  63         BIO_printf(bio_err, "%s \"%s\"\n", s, pp[DB_srpid]);
  64         for (j = 0; j < DB_NUMBER; j++) {
  65             BIO_printf(bio_err, "  %d = \"%s\"\n", j, pp[j]);
  66         }
  67     }
  68 }
  69
  70 static void print_index(CA_DB *db, int indexindex, int verbose)
  71 {
  72     print_entry(db, indexindex, verbose, "g N entry");
  73 }
  74
  75 static void print_user(CA_DB *db, int userindex, int verbose)
  76 {
  77     if (verbose > 0) {
  78         char **pp = sk_OPENSSL_PSTRING_value(db->db->data, userindex);
  79
  80         if (pp[DB_srptype][0] != 'I') {
  81             print_entry(db, userindex, verbose, "User entry");
  82             print_entry(db, get_index(db, pp[DB_srpgN], 'I'), verbose,
  83                         "g N entry");
  84         }
  85
  86     }
  87 }
  88
  89 static int update_index(CA_DB *db, char **row)
  90 {
  91     char **irow;
  92     int i;
  93
  94     irow = app_malloc(sizeof(*irow) * (DB_NUMBER + 1), "row pointers");
  95     for (i = 0; i < DB_NUMBER; i++)
  96         irow[i] = row[i];
  97     irow[DB_NUMBER] = NULL;
  98
  99     if (!TXT_DB_insert(db->db, irow)) {
 100         BIO_printf(bio_err, "failed to update srpvfile\n");
 101         BIO_printf(bio_err, "TXT_DB error number %ld\n", db->db->error);
 102         OPENSSL_free(irow);
 103         return 0;
 104     }
 105     return 1;
 106 }
 107
 108 static char *lookup_conf(const CONF *conf, const char *section, const char *tag)
 109 {
 110     char *entry = NCONF_get_string(conf, section, tag);
 111     if (entry == NULL)
 112         BIO_printf(bio_err, "variable lookup failed for %s::%s\n", section, tag);
 113     return entry;
 114 }
 115
 116 static char *srp_verify_user(const char *user, const char *srp_verifier,
 117                              char *srp_usersalt, const char *g, const char *N,
 118                              const char *passin, int verbose)
 119 {
 120     char password[1024];
 121     PW_CB_DATA cb_tmp;
 122     char *verifier = NULL;
 123     char *gNid = NULL;
 124
 125     cb_tmp.prompt_info = user;
 126     cb_tmp.password = passin;
 127
 128     if (password_callback(password, sizeof(password), 0, &cb_tmp) > 0) {
 129         if (verbose)
 130             BIO_printf(bio_err,
 131                        "Validating\n   user=\"%s\"\n srp_verifier=\"%s\"\n srp_usersalt=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",
 132                        user, srp_verifier, srp_usersalt, g, N);
 133         BIO_printf(bio_err, "Pass %s\n", password);
 134
 135         OPENSSL_assert(srp_usersalt != NULL);
 136         if (!
 137             (gNid =
 138              SRP_create_verifier(user, password, &srp_usersalt, &verifier, N,
 139                                  g))) {
 140             BIO_printf(bio_err, "Internal error validating SRP verifier\n");
 141         } else {
 142             if (strcmp(verifier, srp_verifier))
 143                 gNid = NULL;
 144             OPENSSL_free(verifier);
 145         }
 146     }
 147     return gNid;
 148 }
 149
 150 static char *srp_create_user(char *user, char **srp_verifier,
 151                              char **srp_usersalt, char *g, char *N,
 152                              char *passout, int verbose)
 153 {
 154     char password[1024];
 155     PW_CB_DATA cb_tmp;
 156     char *gNid = NULL;
 157     char *salt = NULL;
 158     cb_tmp.prompt_info = user;
 159     cb_tmp.password = passout;
 160
 161     if (password_callback(password, sizeof(password), 1, &cb_tmp) > 0) {
 162         if (verbose)
 163             BIO_printf(bio_err, "Creating\n user=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",
 164                        user, g, N);
 165         if (!
 166             (gNid =
 167              SRP_create_verifier(user, password, &salt, srp_verifier, N,
 168                                  g))) {
 169             BIO_printf(bio_err, "Internal error creating SRP verifier\n");
 170         } else
 171             *srp_usersalt = salt;
 172         if (verbose > 1)
 173             BIO_printf(bio_err, "gNid=%s salt =\"%s\"\n verifier =\"%s\"\n", gNid,
 174                        salt, *srp_verifier);
 175
 176     }
 177     return gNid;
 178 }
 179
 180 typedef enum OPTION_choice {
 181     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
 182     OPT_VERBOSE, OPT_CONFIG, OPT_NAME, OPT_SRPVFILE, OPT_ADD,
 183     OPT_DELETE, OPT_MODIFY, OPT_LIST, OPT_GN, OPT_USERINFO,
 184     OPT_PASSIN, OPT_PASSOUT, OPT_ENGINE
 185 } OPTION_CHOICE;
 186
 187 const OPTIONS srp_options[] = {
 188     {"help", OPT_HELP, '-', "Display this summary"},
 189     {"verbose", OPT_VERBOSE, '-', "Talk a lot while doing things"},
 190     {"config", OPT_CONFIG, '<', "A config file"},
 191     {"name", OPT_NAME, 's', "The particular srp definition to use"},
 192     {"srpvfile", OPT_SRPVFILE, '<', "The srp verifier file name"},
 193     {"add", OPT_ADD, '-', "Add a user and srp verifier"},
 194     {"modify", OPT_MODIFY, '-',
 195      "Modify the srp verifier of an existing user"},
 196     {"delete", OPT_DELETE, '-', "Delete user from verifier file"},
 197     {"list", OPT_LIST, '-', "List users"},
 198     {"gn", OPT_GN, 's', "Set g and N values to be used for new verifier"},
 199     {"userinfo", OPT_USERINFO, 's', "Additional info to be set for user"},
 200     {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
 201     {"passout", OPT_PASSOUT, 's', "Output file pass phrase source"},
 202 # ifndef OPENSSL_NO_ENGINE
 203     {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
 204 # endif
 205     {NULL}
 206 };
 207
 208 int srp_main(int argc, char **argv)
 209 {
 210     ENGINE *e = NULL;
 211     CA_DB *db = NULL;
 212     CONF *conf = NULL;
 213     int gNindex = -1, maxgN = -1, ret = 1, errors = 0, verbose = 0, i;
 214     int doupdatedb = 0, mode = OPT_ERR;
 215     char *user = NULL, *passinarg = NULL, *passoutarg = NULL;
 216     char *passin = NULL, *passout = NULL, *gN = NULL, *userinfo = NULL;
 217     char *randfile = NULL, *section = NULL;
 218     char **gNrow = NULL, *configfile = NULL;
 219     char *srpvfile = NULL, **pp, *prog;
 220     OPTION_CHOICE o;
 221
 222     prog = opt_init(argc, argv, srp_options);
 223     while ((o = opt_next()) != OPT_EOF) {
 224         switch (o) {
 225         case OPT_EOF:
 226         case OPT_ERR:
 227  opthelp:
 228             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
 229             goto end;
 230         case OPT_HELP:
 231             opt_help(srp_options);
 232             ret = 0;
 233             goto end;
 234         case OPT_VERBOSE:
 235             verbose++;
 236             break;
 237         case OPT_CONFIG:
 238             configfile = opt_arg();
 239             break;
 240         case OPT_NAME:
 241             section = opt_arg();
 242             break;
 243         case OPT_SRPVFILE:
 244             srpvfile = opt_arg();
 245             break;
 246         case OPT_ADD:
 247         case OPT_DELETE:
 248         case OPT_MODIFY:
 249         case OPT_LIST:
 250             if (mode != OPT_ERR) {
 251                 BIO_printf(bio_err,
 252                            "%s: Only one of -add/delete-modify/-list\n",
 253                            prog);
 254                 goto opthelp;
 255             }
 256             mode = o;
 257             break;
 258         case OPT_GN:
 259             gN = opt_arg();
 260             break;
 261         case OPT_USERINFO:
 262             userinfo = opt_arg();
 263             break;
 264         case OPT_PASSIN:
 265             passinarg = opt_arg();
 266             break;
 267         case OPT_PASSOUT:
 268             passoutarg = opt_arg();
 269             break;
 270         case OPT_ENGINE:
 271             e = setup_engine(opt_arg(), 0);
 272             break;
 273         }
 274     }
 275     argc = opt_num_rest();
 276     argv = opt_rest();
 277
 278     if (srpvfile && configfile) {
 279         BIO_printf(bio_err,
 280                    "-srpvfile and -configfile cannot be specified together.\n");
 281         goto end;
 282     }
 283     if (mode == OPT_ERR) {
 284         BIO_printf(bio_err,
 285                    "Exactly one of the options -add, -delete, -modify -list must be specified.\n");
 286         goto opthelp;
 287     }
 288     if ((mode == OPT_DELETE || mode == OPT_MODIFY || mode == OPT_ADD)
 289         && argc < 1) {
 290         BIO_printf(bio_err,
 291                    "Need at least one user for options -add, -delete, -modify. \n");
 292         goto opthelp;
 293     }
 294     if ((passin || passout) && argc != 1) {
 295         BIO_printf(bio_err,
 296                    "-passin, -passout arguments only valid with one user.\n");
 297         goto opthelp;
 298     }
 299
 300     if (!app_passwd(passinarg, passoutarg, &passin, &passout)) {
 301         BIO_printf(bio_err, "Error getting passwords\n");
 302         goto end;
 303     }
 304
 305     if (!srpvfile) {
 306         if (!configfile)
 307             configfile = default_config_file;
 308
 309         if (verbose)
 310             BIO_printf(bio_err, "Using configuration from %s\n",
 311                        configfile);
 312         conf = app_load_config(configfile);
 313         if (conf == NULL)
 314             goto end;
 315         if (configfile != default_config_file && !app_load_modules(conf))
 316             goto end;
 317
 318         /* Lets get the config section we are using */
 319         if (section == NULL) {
 320             if (verbose)
 321                 BIO_printf(bio_err,
 322                            "trying to read " ENV_DEFAULT_SRP
 323                            " in " BASE_SECTION "\n");
 324
 325             section = lookup_conf(conf, BASE_SECTION, ENV_DEFAULT_SRP);
 326             if (section == NULL)
 327                 goto end;
 328         }
 329
 330         if (randfile == NULL)
 331             randfile = NCONF_get_string(conf, BASE_SECTION, "RANDFILE");
 332
 333         if (verbose)
 334             BIO_printf(bio_err,
 335                        "trying to read " ENV_DATABASE " in section \"%s\"\n",
 336                        section);
 337
 338         srpvfile = lookup_conf(conf, section, ENV_DATABASE);
 339         if (srpvfile == NULL)
 340             goto end;
 341     }
 342     if (randfile == NULL)
 343         ERR_clear_error();
 344     else
 345         app_RAND_load_file(randfile, 0);
 346
 347     if (verbose)
 348         BIO_printf(bio_err, "Trying to read SRP verifier file \"%s\"\n",
 349                    srpvfile);
 350
 351     db = load_index(srpvfile, NULL);
 352     if (db == NULL)
 353         goto end;
 354
 355     /* Lets check some fields */
 356     for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
 357         pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
 358
 359         if (pp[DB_srptype][0] == DB_SRP_INDEX) {
 360             maxgN = i;
 361             if ((gNindex < 0) && (gN != NULL) && strcmp(gN, pp[DB_srpid]) == 0)
 362                 gNindex = i;
 363
 364             print_index(db, i, verbose > 1);
 365         }
 366     }
 367
 368     if (verbose)
 369         BIO_printf(bio_err, "Database initialised\n");
 370
 371     if (gNindex >= 0) {
 372         gNrow = sk_OPENSSL_PSTRING_value(db->db->data, gNindex);
 373         print_entry(db, gNindex, verbose > 1, "Default g and N");
 374     } else if (maxgN > 0 && !SRP_get_default_gN(gN)) {
 375         BIO_printf(bio_err, "No g and N value for index \"%s\"\n", gN);
 376         goto end;
 377     } else {
 378         if (verbose)
 379             BIO_printf(bio_err, "Database has no g N information.\n");
 380         gNrow = NULL;
 381     }
 382
 383     if (verbose > 1)
 384         BIO_printf(bio_err, "Starting user processing\n");
 385
 386     if (argc > 0)
 387         user = *(argv++);
 388
 389     while (mode == OPT_LIST || user) {
 390         int userindex = -1;
 391
 392         if (user != NULL && verbose > 1)
 393             BIO_printf(bio_err, "Processing user \"%s\"\n", user);
 394         if ((userindex = get_index(db, user, 'U')) >= 0) {
 395             print_user(db, userindex, (verbose > 0) || mode == OPT_LIST);
 396         }
 397
 398         if (mode == OPT_LIST) {
 399             if (user == NULL) {
 400                 BIO_printf(bio_err, "List all users\n");
 401
 402                 for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
 403                     print_user(db, i, 1);
 404                 }
 405             } else if (userindex < 0) {
 406                 BIO_printf(bio_err,
 407                            "user \"%s\" does not exist, ignored. t\n", user);
 408                 errors++;
 409             }
 410         } else if (mode == OPT_ADD) {
 411             if (userindex >= 0) {
 412                 /* reactivation of a new user */
 413                 char **row =
 414                     sk_OPENSSL_PSTRING_value(db->db->data, userindex);
 415                 BIO_printf(bio_err, "user \"%s\" reactivated.\n", user);
 416                 row[DB_srptype][0] = 'V';
 417
 418                 doupdatedb = 1;
 419             } else {
 420                 char *row[DB_NUMBER];
 421                 char *gNid;
 422                 row[DB_srpverifier] = NULL;
 423                 row[DB_srpsalt] = NULL;
 424                 row[DB_srpinfo] = NULL;
 425                 if (!
 426                     (gNid =
 427                      srp_create_user(user, &(row[DB_srpverifier]),
 428                                      &(row[DB_srpsalt]),
 429                                      gNrow ? gNrow[DB_srpsalt] : gN,
 430                                      gNrow ? gNrow[DB_srpverifier] : NULL,
 431                                      passout, verbose))) {
 432                     BIO_printf(bio_err,
 433                                "Cannot create srp verifier for user \"%s\", operation abandoned .\n",
 434                                user);
 435                     errors++;
 436                     goto end;
 437                 }
 438                 row[DB_srpid] = OPENSSL_strdup(user);
 439                 row[DB_srptype] = OPENSSL_strdup("v");
 440                 row[DB_srpgN] = OPENSSL_strdup(gNid);
 441
 442                 if ((row[DB_srpid] == NULL)
 443                     || (row[DB_srpgN] == NULL)
 444                     || (row[DB_srptype] == NULL)
 445                     || (row[DB_srpverifier] == NULL)
 446                     || (row[DB_srpsalt] == NULL)
 447                     || (userinfo
 448                         && ((row[DB_srpinfo] = OPENSSL_strdup(userinfo)) == NULL))
 449                     || !update_index(db, row)) {
 450                     OPENSSL_free(row[DB_srpid]);
 451                     OPENSSL_free(row[DB_srpgN]);
 452                     OPENSSL_free(row[DB_srpinfo]);
 453                     OPENSSL_free(row[DB_srptype]);
 454                     OPENSSL_free(row[DB_srpverifier]);
 455                     OPENSSL_free(row[DB_srpsalt]);
 456                     goto end;
 457                 }
 458                 doupdatedb = 1;
 459             }
 460         } else if (mode == OPT_MODIFY) {
 461             if (userindex < 0) {
 462                 BIO_printf(bio_err,
 463                            "user \"%s\" does not exist, operation ignored.\n",
 464                            user);
 465                 errors++;
 466             } else {
 467
 468                 char **row =
 469                     sk_OPENSSL_PSTRING_value(db->db->data, userindex);
 470                 char type = row[DB_srptype][0];
 471                 if (type == 'v') {
 472                     BIO_printf(bio_err,
 473                                "user \"%s\" already updated, operation ignored.\n",
 474                                user);
 475                     errors++;
 476                 } else {
 477                     char *gNid;
 478
 479                     if (row[DB_srptype][0] == 'V') {
 480                         int user_gN;
 481                         char **irow = NULL;
 482                         if (verbose)
 483                             BIO_printf(bio_err,
 484                                        "Verifying password for user \"%s\"\n",
 485                                        user);
 486                         if ((user_gN =
 487                              get_index(db, row[DB_srpgN], DB_SRP_INDEX)) >= 0)
 488                             irow =
 489                                 sk_OPENSSL_PSTRING_value(db->db->data,
 490                                                          userindex);
 491
 492                         if (!srp_verify_user
 493                             (user, row[DB_srpverifier], row[DB_srpsalt],
 494                              irow ? irow[DB_srpsalt] : row[DB_srpgN],
 495                              irow ? irow[DB_srpverifier] : NULL, passin,
 496                              verbose)) {
 497                             BIO_printf(bio_err,
 498                                        "Invalid password for user \"%s\", operation abandoned.\n",
 499                                        user);
 500                             errors++;
 501                             goto end;
 502                         }
 503                     }
 504                     if (verbose)
 505                         BIO_printf(bio_err, "Password for user \"%s\" ok.\n",
 506                                    user);
 507
 508                     if (!
 509                         (gNid =
 510                          srp_create_user(user, &(row[DB_srpverifier]),
 511                                          &(row[DB_srpsalt]),
 512                                          gNrow ? gNrow[DB_srpsalt] : NULL,
 513                                          gNrow ? gNrow[DB_srpverifier] : NULL,
 514                                          passout, verbose))) {
 515                         BIO_printf(bio_err,
 516                                    "Cannot create srp verifier for user \"%s\", operation abandoned.\n",
 517                                    user);
 518                         errors++;
 519                         goto end;
 520                     }
 521
 522                     row[DB_srptype][0] = 'v';
 523                     row[DB_srpgN] = OPENSSL_strdup(gNid);
 524
 525                     if (row[DB_srpid] == NULL
 526                         || row[DB_srpgN] == NULL
 527                         || row[DB_srptype] == NULL
 528                         || row[DB_srpverifier] == NULL
 529                         || row[DB_srpsalt] == NULL
 530                         || (userinfo
 531                             && ((row[DB_srpinfo] = OPENSSL_strdup(userinfo))
 532                                 == NULL)))
 533                         goto end;
 534
 535                     doupdatedb = 1;
 536                 }
 537             }
 538         } else if (mode == OPT_DELETE) {
 539             if (userindex < 0) {
 540                 BIO_printf(bio_err,
 541                            "user \"%s\" does not exist, operation ignored. t\n",
 542                            user);
 543                 errors++;
 544             } else {
 545                 char **xpp = sk_OPENSSL_PSTRING_value(db->db->data, userindex);
 546
 547                 BIO_printf(bio_err, "user \"%s\" revoked. t\n", user);
 548                 xpp[DB_srptype][0] = 'R';
 549                 doupdatedb = 1;
 550             }
 551         }
 552         if (--argc > 0)
 553             user = *(argv++);
 554         else {
 555             user = NULL;
 556         }
 557     }
 558
 559     if (verbose)
 560         BIO_printf(bio_err, "User procession done.\n");
 561
 562     if (doupdatedb) {
 563         /* Lets check some fields */
 564         for (i = 0; i < sk_OPENSSL_PSTRING_num(db->db->data); i++) {
 565             pp = sk_OPENSSL_PSTRING_value(db->db->data, i);
 566
 567             if (pp[DB_srptype][0] == 'v') {
 568                 pp[DB_srptype][0] = 'V';
 569                 print_user(db, i, verbose);
 570             }
 571         }
 572
 573         if (verbose)
 574             BIO_printf(bio_err, "Trying to update srpvfile.\n");
 575         if (!save_index(srpvfile, "new", db))
 576             goto end;
 577
 578         if (verbose)
 579             BIO_printf(bio_err, "Temporary srpvfile created.\n");
 580         if (!rotate_index(srpvfile, "new", "old"))
 581             goto end;
 582
 583         if (verbose)
 584             BIO_printf(bio_err, "srpvfile updated.\n");
 585     }
 586
 587     ret = (errors != 0);
 588  end:
 589     if (errors != 0)
 590         if (verbose)
 591             BIO_printf(bio_err, "User errors %d.\n", errors);
 592
 593     if (verbose)
 594         BIO_printf(bio_err, "SRP terminating with code %d.\n", ret);
 595
 596     OPENSSL_free(passin);
 597     OPENSSL_free(passout);
 598     if (ret)
 599         ERR_print_errors(bio_err);
 600     if (randfile)
 601         app_RAND_write_file(randfile);
 602     NCONF_free(conf);
 603     free_index(db);
 604     release_engine(e);
 605     return (ret);
 606 }
 607 #endif