src/kadmin/dbutil/kdb5_util.c

   1 /* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
   2 /* kadmin/dbutil/kdb5_util.c - Administer a KDC database */
   3 /*
   4  * (C) Copyright 1990,1991, 1996, 2008, 2009 by the Massachusetts Institute of Technology.
   5  * All Rights Reserved.
   6  *
   7  * Export of this software from the United States of America may
   8  *   require a specific license from the United States Government.
   9  *   It is the responsibility of any person or organization contemplating
  10  *   export to obtain such a license before exporting.
  11  *
  12  * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
  13  * distribute this software and its documentation for any purpose and
  14  * without fee is hereby granted, provided that the above copyright
  15  * notice appear in all copies and that both that copyright notice and
  16  * this permission notice appear in supporting documentation, and that
  17  * the name of M.I.T. not be used in advertising or publicity pertaining
  18  * to distribution of the software without specific, written prior
  19  * permission.  Furthermore if you modify this software you must label
  20  * your software as modified software and not distribute it in such a
  21  * fashion that it might be confused with the original M.I.T. software.
  22  * M.I.T. makes no representations about the suitability of
  23  * this software for any purpose.  It is provided "as is" without express
  24  * or implied warranty.
  25  */
  26 /*
  27  * Copyright (C) 1998 by the FundsXpress, INC.
  28  *
  29  * All rights reserved.
  30  *
  31  * Export of this software from the United States of America may require
  32  * a specific license from the United States Government.  It is the
  33  * responsibility of any person or organization contemplating export to
  34  * obtain such a license before exporting.
  35  *
  36  * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
  37  * distribute this software and its documentation for any purpose and
  38  * without fee is hereby granted, provided that the above copyright
  39  * notice appear in all copies and that both that copyright notice and
  40  * this permission notice appear in supporting documentation, and that
  41  * the name of FundsXpress. not be used in advertising or publicity pertaining
  42  * to distribution of the software without specific, written prior
  43  * permission.  FundsXpress makes no representations about the suitability of
  44  * this software for any purpose.  It is provided "as is" without express
  45  * or implied warranty.
  46  *
  47  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  48  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  49  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  50  */
  51 /*
  52  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
  53  * Use is subject to license terms.
  54  */
  55
  56 #include <k5-int.h>
  57 #include <kadm5/admin.h>
  58 #include <locale.h>
  59 #include <adm_proto.h>
  60 #include <time.h>
  61 #include "kdb5_util.h"
  62
  63 /*
  64  * XXX Ick, ick, ick.  These global variables shouldn't be global....
  65  */
  66 char *mkey_password = 0;
  67
  68 /*
  69  * I can't figure out any way for this not to be global, given how ss
  70  * works.
  71  */
  72
  73 int exit_status = 0;
  74 krb5_context util_context;
  75 kadm5_config_params global_params;
  76
  77 void usage()
  78 {
  79     fprintf(stderr,
  80             _("Usage: kdb5_util [-r realm] [-d dbname] "
  81               "[-k mkeytype] [-kv mkeyVNO]\n"
  82               "\t        [-M mkeyname] [-m] [-sf stashfilename] "
  83               "[-P password]\n"
  84               "\t        [-x db_args]* cmd [cmd_options]\n"
  85               "\tcreate  [-s]\n"
  86               "\tdestroy [-f]\n"
  87               "\tstash   [-f keyfile]\n"
  88               "\tdump    [-old|-ov|-b6|-b7|-r13|-r18] [-verbose]\n"
  89               "\t        [-mkey_convert] [-new_mkey_file mkey_file]\n"
  90               "\t        [-rev] [-recurse] [filename [princs...]]\n"
  91               "\tload    [-old|-ov|-b6|-b7|-r13|-r18] [-verbose] [-update] "
  92               "filename\n"
  93               "\tark     [-e etype_list] principal\n"
  94               "\tadd_mkey [-e etype] [-s]\n"
  95               "\tuse_mkey kvno [time]\n"
  96               "\tlist_mkeys\n"));
  97     /* avoid a string length compiler warning */
  98     fprintf(stderr,
  99             _("\tupdate_princ_encryption [-f] [-n] [-v] [princ-pattern]\n"
 100               "\tpurge_mkeys [-f] [-n] [-v]\n"
 101               "\ttabdump [-H] [-c] [-e] [-n] [-o outfile] dumptype\n"
 102               "\nwhere,\n\t[-x db_args]* - any number of database specific "
 103               "arguments.\n"
 104               "\t\t\tLook at each database documentation for supported "
 105               "arguments\n"));
 106     exit(1);
 107 }
 108
 109 krb5_keyblock master_keyblock;
 110 krb5_kvno   master_kvno; /* fetched */
 111 extern krb5_principal master_princ;
 112 char *mkey_fullname;
 113 krb5_db_entry *master_entry = NULL;
 114 int     valid_master_key = 0;
 115
 116 char *progname;
 117 krb5_boolean manual_mkey = FALSE;
 118 krb5_boolean dbactive = FALSE;
 119
 120 static int open_db_and_mkey(void);
 121
 122 static void add_random_key(int, char **);
 123
 124 typedef void (*cmd_func)(int, char **);
 125
 126 struct _cmd_table {
 127     char *name;
 128     cmd_func func;
 129     int opendb;
 130 } cmd_table[] = {
 131     {"create", kdb5_create, 0},
 132     {"destroy", kdb5_destroy, 1}, /* 1 opens the kdb */
 133     {"stash", kdb5_stash, 1},
 134     {"dump", dump_db, 1},
 135     {"load", load_db, 0},
 136     {"ark", add_random_key, 1},
 137     {"add_mkey", kdb5_add_mkey, 1},
 138     {"use_mkey", kdb5_use_mkey, 1},
 139     {"list_mkeys", kdb5_list_mkeys, 1},
 140     {"update_princ_encryption", kdb5_update_princ_encryption, 1},
 141     {"purge_mkeys", kdb5_purge_mkeys, 1},
 142     {"tabdump", tabdump, 1},
 143     {NULL, NULL, 0},
 144 };
 145
 146 static struct _cmd_table *cmd_lookup(name)
 147     char *name;
 148 {
 149     struct _cmd_table *cmd = cmd_table;
 150     while (cmd->name) {
 151         if (strcmp(cmd->name, name) == 0)
 152             return cmd;
 153         else
 154             cmd++;
 155     }
 156
 157     return NULL;
 158 }
 159
 160 #define ARG_VAL (--argc > 0 ? (koptarg = *(++argv)) : (char *)(usage(), NULL))
 161
 162 char **db5util_db_args = NULL;
 163 int    db5util_db_args_size = 0;
 164
 165 static void extended_com_err_fn (const char *myprog, errcode_t code,
 166                                  const char *fmt, va_list args)
 167 {
 168     const char *emsg;
 169     if (code) {
 170         emsg = krb5_get_error_message (util_context, code);
 171         fprintf (stderr, "%s: %s ", myprog, emsg);
 172         krb5_free_error_message (util_context, emsg);
 173     } else {
 174         fprintf (stderr, "%s: ", myprog);
 175     }
 176     vfprintf (stderr, fmt, args);
 177     fprintf (stderr, "\n");
 178 }
 179
 180 int add_db_arg(char *arg)
 181 {
 182     char **temp;
 183     db5util_db_args_size++;
 184     temp = realloc(db5util_db_args,
 185                    sizeof(char *) * (db5util_db_args_size + 1));
 186     if (temp == NULL)
 187         return 0;
 188     db5util_db_args = temp;
 189     db5util_db_args[db5util_db_args_size-1] = arg;
 190     db5util_db_args[db5util_db_args_size]   = NULL;
 191     return 1;
 192 }
 193
 194 int main(argc, argv)
 195     int argc;
 196     char *argv[];
 197 {
 198     struct _cmd_table *cmd = NULL;
 199     char *koptarg, **cmd_argv;
 200     char *db_name_tmp = NULL;
 201     int cmd_argc;
 202     krb5_error_code retval;
 203
 204     setlocale(LC_ALL, "");
 205     set_com_err_hook(extended_com_err_fn);
 206
 207     /*
 208      * Ensure that "progname" is set before calling com_err.
 209      */
 210     progname = (strrchr(argv[0], '/') ?
 211                 strrchr(argv[0], '/') + 1 : argv[0]);
 212
 213     retval = kadm5_init_krb5_context(&util_context);
 214     if (retval) {
 215         com_err (progname, retval, _("while initializing Kerberos code"));
 216         exit(1);
 217     }
 218
 219     cmd_argv = (char **) malloc(sizeof(char *)*argc);
 220     if (cmd_argv == NULL) {
 221         com_err(progname, ENOMEM, _("while creating sub-command arguments"));
 222         exit(1);
 223     }
 224     memset(cmd_argv, 0, sizeof(char *)*argc);
 225     cmd_argc = 1;
 226
 227     argv++; argc--;
 228     while (*argv) {
 229         if (strcmp(*argv, "-P") == 0 && ARG_VAL) {
 230             mkey_password = koptarg;
 231             manual_mkey = TRUE;
 232         } else if (strcmp(*argv, "-d") == 0 && ARG_VAL) {
 233             global_params.dbname = koptarg;
 234             global_params.mask |= KADM5_CONFIG_DBNAME;
 235
 236             if (asprintf(&db_name_tmp, "dbname=%s", global_params.dbname) < 0)
 237             {
 238                 com_err(progname, ENOMEM,
 239                         _("while parsing command arguments"));
 240                 exit(1);
 241             }
 242
 243             if (!add_db_arg(db_name_tmp)) {
 244                 com_err(progname, ENOMEM,
 245                         _("while parsing command arguments\n"));
 246                 exit(1);
 247             }
 248
 249         } else if (strcmp(*argv, "-x") == 0 && ARG_VAL) {
 250             if (!add_db_arg(koptarg)) {
 251                 com_err(progname, ENOMEM,
 252                         _("while parsing command arguments\n"));
 253                 exit(1);
 254             }
 255
 256         } else if (strcmp(*argv, "-r") == 0 && ARG_VAL) {
 257             global_params.realm = koptarg;
 258             global_params.mask |= KADM5_CONFIG_REALM;
 259             /* not sure this is really necessary */
 260             if ((retval = krb5_set_default_realm(util_context,
 261                                                  global_params.realm))) {
 262                 com_err(progname, retval,
 263                         _("while setting default realm name"));
 264                 exit(1);
 265             }
 266         } else if (strcmp(*argv, "-k") == 0 && ARG_VAL) {
 267             if (krb5_string_to_enctype(koptarg, &global_params.enctype)) {
 268                 com_err(progname, EINVAL, _(": %s is an invalid enctype"),
 269                         koptarg);
 270                 exit(1);
 271             } else
 272                 global_params.mask |= KADM5_CONFIG_ENCTYPE;
 273         } else if (strcmp(*argv, "-kv") == 0 && ARG_VAL) {
 274             global_params.kvno = (krb5_kvno) atoi(koptarg);
 275             if (global_params.kvno == IGNORE_VNO) {
 276                 com_err(progname, EINVAL, _(": %s is an invalid mkeyVNO"),
 277                         koptarg);
 278                 exit(1);
 279             } else
 280                 global_params.mask |= KADM5_CONFIG_KVNO;
 281         } else if (strcmp(*argv, "-M") == 0 && ARG_VAL) {
 282             global_params.mkey_name = koptarg;
 283             global_params.mask |= KADM5_CONFIG_MKEY_NAME;
 284         } else if (strcmp(*argv, "-sf") == 0 && ARG_VAL) {
 285             global_params.stash_file = koptarg;
 286             global_params.mask |= KADM5_CONFIG_STASH_FILE;
 287         } else if (strcmp(*argv, "-m") == 0) {
 288             manual_mkey = TRUE;
 289             global_params.mkey_from_kbd = 1;
 290             global_params.mask |= KADM5_CONFIG_MKEY_FROM_KBD;
 291         } else if (cmd_lookup(*argv) != NULL) {
 292             if (cmd_argv[0] == NULL)
 293                 cmd_argv[0] = *argv;
 294             else
 295                 usage();
 296         } else {
 297             cmd_argv[cmd_argc++] = *argv;
 298         }
 299         argv++; argc--;
 300     }
 301
 302     if (cmd_argv[0] == NULL)
 303         usage();
 304
 305     if( !util_context->default_realm )
 306     {
 307         char *temp = NULL;
 308         retval = krb5_get_default_realm(util_context, &temp);
 309         if( retval )
 310         {
 311             com_err(progname, retval, _("while getting default realm"));
 312             exit(1);
 313         }
 314         krb5_free_default_realm(util_context, temp);
 315     }
 316
 317     retval = kadm5_get_config_params(util_context, 1,
 318                                      &global_params, &global_params);
 319     if (retval) {
 320         com_err(progname, retval,
 321                 _("while retreiving configuration parameters"));
 322         exit(1);
 323     }
 324
 325     /*
 326      * Dump creates files which should not be world-readable.  It is
 327      * easiest to do a single umask call here.
 328      */
 329     (void) umask(077);
 330
 331     master_keyblock.enctype = global_params.enctype;
 332     if ((master_keyblock.enctype != ENCTYPE_UNKNOWN) &&
 333         (!krb5_c_valid_enctype(master_keyblock.enctype))) {
 334         com_err(progname, KRB5_PROG_KEYTYPE_NOSUPP,
 335                 "while setting up enctype %d", master_keyblock.enctype);
 336     }
 337
 338     cmd = cmd_lookup(cmd_argv[0]);
 339     if (cmd->opendb && open_db_and_mkey())
 340         return exit_status;
 341
 342     if (global_params.iprop_enabled == TRUE)
 343         ulog_set_role(util_context, IPROP_MASTER);
 344     else
 345         ulog_set_role(util_context, IPROP_NULL);
 346
 347     (*cmd->func)(cmd_argc, cmd_argv);
 348
 349     if( db_name_tmp )
 350         free( db_name_tmp );
 351
 352     if( db5util_db_args )
 353         free(db5util_db_args);
 354
 355     quit();
 356     kadm5_free_config_params(util_context, &global_params);
 357     krb5_free_context(util_context);
 358     free(cmd_argv);
 359     return exit_status;
 360 }
 361
 362 /*
 363  * open_db_and_mkey: Opens the KDC and policy database, and sets the
 364  * global master_* variables.  Sets dbactive to TRUE if the databases
 365  * are opened, and valid_master_key to 1 if the global master
 366  * variables are set properly.  Returns 0 on success, and 1 on
 367  * failure, but it is not considered a failure if the master key
 368  * cannot be fetched (the master key stash file may not exist when the
 369  * program is run).
 370  */
 371 static int open_db_and_mkey()
 372 {
 373     krb5_error_code retval;
 374     krb5_data scratch, pwd, seed;
 375
 376     dbactive = FALSE;
 377     valid_master_key = 0;
 378
 379     if ((retval = krb5_db_open(util_context, db5util_db_args,
 380                                KRB5_KDB_OPEN_RW | KRB5_KDB_SRV_TYPE_ADMIN))) {
 381         com_err(progname, retval, _("while initializing database"));
 382         exit_status++;
 383         return(1);
 384     }
 385
 386     /* assemble & parse the master key name */
 387
 388     if ((retval = krb5_db_setup_mkey_name(util_context,
 389                                           global_params.mkey_name,
 390                                           global_params.realm,
 391                                           &mkey_fullname, &master_princ))) {
 392         com_err(progname, retval, _("while setting up master key name"));
 393         exit_status++;
 394         return(1);
 395     }
 396     if ((retval = krb5_db_get_principal(util_context, master_princ, 0,
 397                                         &master_entry))) {
 398         com_err(progname, retval, _("while retrieving master entry"));
 399         exit_status++;
 400         (void) krb5_db_fini(util_context);
 401         return(1);
 402     }
 403
 404     if (global_params.mask & KADM5_CONFIG_KVNO)
 405         master_kvno = global_params.kvno; /* user specified */
 406     else
 407         master_kvno = IGNORE_VNO;
 408
 409     /* the databases are now open, and the master principal exists */
 410     dbactive = TRUE;
 411
 412     if (mkey_password) {
 413         pwd.data = mkey_password;
 414         pwd.length = strlen(mkey_password);
 415         retval = krb5_principal2salt(util_context, master_princ, &scratch);
 416         if (retval) {
 417             com_err(progname, retval, _("while calculated master key salt"));
 418             exit_status++;
 419             return(1);
 420         }
 421
 422         /* If no encryption type is set, use the default */
 423         if (master_keyblock.enctype == ENCTYPE_UNKNOWN)
 424             master_keyblock.enctype = DEFAULT_KDC_ENCTYPE;
 425         if (!krb5_c_valid_enctype(master_keyblock.enctype))
 426             com_err(progname, KRB5_PROG_KEYTYPE_NOSUPP,
 427                     "while setting up enctype %d",
 428                     master_keyblock.enctype);
 429
 430         retval = krb5_c_string_to_key(util_context, master_keyblock.enctype,
 431                                       &pwd, &scratch, &master_keyblock);
 432         if (retval) {
 433             com_err(progname, retval,
 434                     _("while transforming master key from password"));
 435             exit_status++;
 436             return(1);
 437         }
 438         free(scratch.data);
 439         mkey_password = 0;
 440
 441     } else {
 442         if ((retval = krb5_db_fetch_mkey(util_context, master_princ,
 443                                          master_keyblock.enctype,
 444                                          manual_mkey, FALSE,
 445                                          global_params.stash_file,
 446                                          &master_kvno,
 447                                          0, &master_keyblock))) {
 448             com_err(progname, retval, _("while reading master key"));
 449             com_err(progname, 0, _("Warning: proceeding without master key"));
 450             exit_status++;
 451             return(0);
 452         }
 453     }
 454
 455     if ((retval = krb5_db_fetch_mkey_list(util_context, master_princ,
 456                                           &master_keyblock))) {
 457         com_err(progname, retval, "while getting master key list");
 458         com_err(progname, 0, "Warning: proceeding without master key list");
 459         exit_status++;
 460         return(0);
 461     }
 462
 463     seed.length = master_keyblock.length;
 464     seed.data = (char *) master_keyblock.contents;
 465
 466     if ((retval = krb5_c_random_seed(util_context, &seed))) {
 467         com_err(progname, retval, _("while seeding random number generator"));
 468         exit_status++;
 469         memset(master_keyblock.contents, 0, master_keyblock.length);
 470         krb5_free_keyblock_contents(util_context, &master_keyblock);
 471         return(1);
 472     }
 473
 474     if (global_params.iprop_enabled) {
 475         if (ulog_map(util_context, global_params.iprop_logfile,
 476                      global_params.iprop_ulogsize)) {
 477             fprintf(stderr, _("%s: Could not map log\n"), progname);
 478             exit_status++;
 479             return(1);
 480         }
 481     }
 482
 483     valid_master_key = 1;
 484     dbactive = TRUE;
 485     return 0;
 486 }
 487
 488 #ifdef HAVE_GETCWD
 489 #undef getwd
 490 #endif
 491
 492 int
 493 quit()
 494 {
 495     krb5_error_code retval;
 496     static krb5_boolean finished = 0;
 497
 498     if (finished)
 499         return 0;
 500     ulog_fini(util_context);
 501     retval = krb5_db_fini(util_context);
 502     zapfree(master_keyblock.contents, master_keyblock.length);
 503     krb5_free_principal(util_context, master_princ);
 504     finished = TRUE;
 505     if (retval && retval != KRB5_KDB_DBNOTINITED) {
 506         com_err(progname, retval, _("while closing database"));
 507         exit_status++;
 508         return 1;
 509     }
 510     return 0;
 511 }
 512
 513 static void
 514 add_random_key(argc, argv)
 515     int argc;
 516     char **argv;
 517 {
 518     krb5_error_code ret;
 519     krb5_principal princ;
 520     krb5_db_entry *dbent;
 521     krb5_timestamp now;
 522
 523     krb5_key_salt_tuple *keysalts = NULL;
 524     krb5_int32 num_keysalts = 0;
 525
 526     int free_keysalts;
 527     char *me = progname;
 528     char *ks_str = NULL;
 529     char *pr_str;
 530     krb5_keyblock *tmp_mkey;
 531
 532     if (argc < 2)
 533         usage();
 534     for (argv++, argc--; *argv; argv++, argc--) {
 535         if (!strcmp(*argv, "-e")) {
 536             argv++; argc--;
 537             ks_str = *argv;
 538             continue;
 539         } else
 540             break;
 541     }
 542     if (argc < 1)
 543         usage();
 544     pr_str = *argv;
 545     ret = krb5_parse_name(util_context, pr_str, &princ);
 546     if (ret) {
 547         com_err(me, ret, _("while parsing principal name %s"), pr_str);
 548         exit_status++;
 549         return;
 550     }
 551     ret = krb5_db_get_principal(util_context, princ, 0, &dbent);
 552     if (ret) {
 553         com_err(me, ret, _("while fetching principal %s"), pr_str);
 554         exit_status++;
 555         return;
 556     }
 557     ret = krb5_string_to_keysalts(ks_str,
 558                                   NULL, NULL, 0,
 559                                   &keysalts,
 560                                   &num_keysalts);
 561     if (ret) {
 562         com_err(me, ret, _("while parsing keysalts %s"), ks_str);
 563         exit_status++;
 564         return;
 565     }
 566     if (!num_keysalts || keysalts == NULL) {
 567         num_keysalts = global_params.num_keysalts;
 568         keysalts = global_params.keysalts;
 569         free_keysalts = 0;
 570     } else
 571         free_keysalts = 1;
 572
 573     /* Find the mkey used to protect the existing keys */
 574     ret = krb5_dbe_find_mkey(util_context, dbent, &tmp_mkey);
 575     if (ret) {
 576         com_err(me, ret, _("while finding mkey"));
 577         krb5_db_free_principal(util_context, dbent);
 578         exit_status++;
 579         return;
 580     }
 581
 582     ret = krb5_dbe_ark(util_context, tmp_mkey, keysalts, num_keysalts, dbent);
 583     if (free_keysalts)
 584         free(keysalts);
 585     if (ret) {
 586         com_err(me, ret, "while randomizing principal %s", pr_str);
 587         krb5_db_free_principal(util_context, dbent);
 588         exit_status++;
 589         return;
 590     }
 591     dbent->attributes &= ~KRB5_KDB_REQUIRES_PWCHANGE;
 592     ret = krb5_timeofday(util_context, &now);
 593     if (ret) {
 594         com_err(me, ret, _("while getting time"));
 595         krb5_db_free_principal(util_context, dbent);
 596         exit_status++;
 597         return;
 598     }
 599     ret = krb5_dbe_update_last_pwd_change(util_context, dbent, now);
 600     if (ret) {
 601         com_err(me, ret, _("while setting changetime"));
 602         krb5_db_free_principal(util_context, dbent);
 603         exit_status++;
 604         return;
 605     }
 606     ret = krb5_db_put_principal(util_context, dbent);
 607     krb5_db_free_principal(util_context, dbent);
 608     if (ret) {
 609         com_err(me, ret, _("while saving principal %s"), pr_str);
 610         exit_status++;
 611         return;
 612     }
 613     printf(_("%s changed\n"), pr_str);
 614 }