apps/srp.c

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