source4/heimdal/lib/hdb/keys.c

   1
   2 /*
   3  * Copyright (c) 1997 - 2011 Kungliga Tekniska Högskolan
   4  * (Royal Institute of Technology, Stockholm, Sweden).
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  *
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * 3. Neither the name of the Institute nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  */
  34
  35 #include "hdb_locl.h"
  36
  37 /*
  38  * free all the memory used by (len, keys)
  39  */
  40
  41 void
  42 hdb_free_keys(krb5_context context, int len, Key *keys)
  43 {
  44     size_t i;
  45
  46     for (i = 0; i < len; i++) {
  47         free(keys[i].mkvno);
  48         keys[i].mkvno = NULL;
  49         if (keys[i].salt != NULL) {
  50             free_Salt(keys[i].salt);
  51             free(keys[i].salt);
  52             keys[i].salt = NULL;
  53         }
  54         krb5_free_keyblock_contents(context, &keys[i].key);
  55     }
  56     free (keys);
  57 }
  58
  59 /*
  60  * for each entry in `default_keys' try to parse it as a sequence
  61  * of etype:salttype:salt, syntax of this if something like:
  62  * [(des|des3|etype):](pw-salt|afs3)[:string], if etype is omitted it
  63  *      means all etypes, and if string is omitted is means the default
  64  * string (for that principal). Additional special values:
  65  *      v5 == pw-salt, and
  66  *      v4 == des:pw-salt:
  67  *      afs or afs3 == des:afs3-salt
  68  */
  69
  70 static const krb5_enctype des_etypes[] = {
  71     KRB5_ENCTYPE_DES_CBC_MD5,
  72     KRB5_ENCTYPE_DES_CBC_MD4,
  73     KRB5_ENCTYPE_DES_CBC_CRC
  74 };
  75
  76 static const krb5_enctype all_etypes[] = {
  77     KRB5_ENCTYPE_AES256_CTS_HMAC_SHA1_96,
  78     KRB5_ENCTYPE_ARCFOUR_HMAC_MD5,
  79     KRB5_ENCTYPE_DES3_CBC_SHA1
  80 };
  81
  82 static krb5_error_code
  83 parse_key_set(krb5_context context, const char *key,
  84               krb5_enctype **ret_enctypes, size_t *ret_num_enctypes,
  85               krb5_salt *salt, krb5_principal principal)
  86 {
  87     const char *p;
  88     char buf[3][256];
  89     int num_buf = 0;
  90     int i, num_enctypes = 0;
  91     krb5_enctype e;
  92     const krb5_enctype *enctypes = NULL;
  93     krb5_error_code ret;
  94
  95     p = key;
  96
  97     *ret_enctypes = NULL;
  98     *ret_num_enctypes = 0;
  99
 100     /* split p in a list of :-separated strings */
 101     for(num_buf = 0; num_buf < 3; num_buf++)
 102         if(strsep_copy(&p, ":", buf[num_buf], sizeof(buf[num_buf])) == -1)
 103             break;
 104
 105     salt->saltvalue.data = NULL;
 106     salt->saltvalue.length = 0;
 107
 108     for(i = 0; i < num_buf; i++) {
 109         if(enctypes == NULL && num_buf > 1) {
 110             /* this might be a etype specifier */
 111             /* XXX there should be a string_to_etypes handling
 112                special cases like `des' and `all' */
 113             if(strcmp(buf[i], "des") == 0) {
 114                 enctypes = des_etypes;
 115                 num_enctypes = sizeof(des_etypes)/sizeof(des_etypes[0]);
 116             } else if(strcmp(buf[i], "des3") == 0) {
 117                 e = KRB5_ENCTYPE_DES3_CBC_SHA1;
 118                 enctypes = &e;
 119                 num_enctypes = 1;
 120             } else {
 121                 ret = krb5_string_to_enctype(context, buf[i], &e);
 122                 if (ret == 0) {
 123                     enctypes = &e;
 124                     num_enctypes = 1;
 125                 } else
 126                     return ret;
 127             }
 128             continue;
 129         }
 130         if(salt->salttype == 0) {
 131             /* interpret string as a salt specifier, if no etype
 132                is set, this sets default values */
 133             /* XXX should perhaps use string_to_salttype, but that
 134                interface sucks */
 135             if(strcmp(buf[i], "pw-salt") == 0) {
 136                 if(enctypes == NULL) {
 137                     enctypes = all_etypes;
 138                     num_enctypes = sizeof(all_etypes)/sizeof(all_etypes[0]);
 139                 }
 140                 salt->salttype = KRB5_PW_SALT;
 141             } else if(strcmp(buf[i], "afs3-salt") == 0) {
 142                 if(enctypes == NULL) {
 143                     enctypes = des_etypes;
 144                     num_enctypes = sizeof(des_etypes)/sizeof(des_etypes[0]);
 145                 }
 146                 salt->salttype = KRB5_AFS3_SALT;
 147             }
 148             continue;
 149         }
 150
 151         {
 152             /* if there is a final string, use it as the string to
 153                salt with, this is mostly useful with null salt for
 154                v4 compat, and a cell name for afs compat */
 155             salt->saltvalue.data = strdup(buf[i]);
 156             if (salt->saltvalue.data == NULL) {
 157                 krb5_set_error_message(context, ENOMEM, "malloc: out of memory");
 158                 return ENOMEM;
 159             }
 160             salt->saltvalue.length = strlen(buf[i]);
 161         }
 162     }
 163
 164     if(enctypes == NULL || salt->salttype == 0) {
 165         krb5_set_error_message(context, EINVAL, "bad value for default_keys `%s'", key);
 166         return EINVAL;
 167     }
 168
 169     /* if no salt was specified make up default salt */
 170     if(salt->saltvalue.data == NULL) {
 171         if(salt->salttype == KRB5_PW_SALT)
 172             ret = krb5_get_pw_salt(context, principal, salt);
 173         else if(salt->salttype == KRB5_AFS3_SALT) {
 174             krb5_const_realm realm = krb5_principal_get_realm(context, principal);
 175             salt->saltvalue.data = strdup(realm);
 176             if(salt->saltvalue.data == NULL) {
 177                 krb5_set_error_message(context, ENOMEM,
 178                                        "out of memory while "
 179                                        "parsing salt specifiers");
 180                 return ENOMEM;
 181             }
 182             strlwr(salt->saltvalue.data);
 183             salt->saltvalue.length = strlen(realm);
 184         }
 185     }
 186
 187     *ret_enctypes = malloc(sizeof(enctypes[0]) * num_enctypes);
 188     if (*ret_enctypes == NULL) {
 189         krb5_free_salt(context, *salt);
 190         krb5_set_error_message(context, ENOMEM, "malloc: out of memory");
 191         return ENOMEM;
 192     }
 193     memcpy(*ret_enctypes, enctypes, sizeof(enctypes[0]) * num_enctypes);
 194     *ret_num_enctypes = num_enctypes;
 195
 196     return 0;
 197 }
 198
 199
 200 /**
 201  * This function adds an HDB entry's current keyset to the entry's key
 202  * history.  The current keyset is left alone; the caller is responsible
 203  * for freeing it.
 204  *
 205  * @param context   Context
 206  * @param entry     HDB entry
 207  */
 208 krb5_error_code
 209 hdb_add_current_keys_to_history(krb5_context context, hdb_entry *entry)
 210 {
 211     krb5_boolean replace = FALSE;
 212     krb5_error_code ret;
 213     HDB_extension *ext;
 214     hdb_keyset newkey;
 215     time_t newtime;
 216
 217
 218     ext = hdb_find_extension(entry, choice_HDB_extension_data_hist_keys);
 219     if (ext == NULL) {
 220         replace = TRUE;
 221         ext = calloc(1, sizeof (*ext));
 222         if (ext == NULL)
 223             return krb5_enomem(context);
 224
 225         ext->data.element = choice_HDB_extension_data_hist_keys;
 226     }
 227
 228     /*
 229      * Copy in newest old keyset
 230      */
 231
 232     ret = hdb_entry_get_pw_change_time(entry, &newtime);
 233     if (ret)
 234         goto out;
 235
 236     memset(&newkey, 0, sizeof(newkey));
 237     newkey.keys = entry->keys;
 238     newkey.kvno = entry->kvno;
 239     newkey.set_time = &newtime;
 240
 241     ret = add_HDB_Ext_KeySet(&ext->data.u.hist_keys, &newkey);
 242     if (ret)
 243         goto out;
 244
 245     if (replace) {
 246         /* hdb_replace_extension() deep-copies ext; what a waste */
 247         ret = hdb_replace_extension(context, entry, ext);
 248         if (ret)
 249             goto out;
 250     }
 251
 252  out:
 253     if (replace && ext) {
 254         free_HDB_extension(ext);
 255         free(ext);
 256     }
 257     return ret;
 258 }
 259
 260
 261 static krb5_error_code
 262 add_enctype_to_key_set(Key **key_set, size_t *nkeyset,
 263                        krb5_enctype enctype, krb5_salt *salt)
 264 {
 265     krb5_error_code ret;
 266     Key key, *tmp;
 267
 268     memset(&key, 0, sizeof(key));
 269
 270     tmp = realloc(*key_set, (*nkeyset + 1) * sizeof((*key_set)[0]));
 271     if (tmp == NULL)
 272         return ENOMEM;
 273
 274     *key_set = tmp;
 275
 276     key.key.keytype = enctype;
 277     key.key.keyvalue.length = 0;
 278     key.key.keyvalue.data = NULL;
 279
 280     if (salt) {
 281         key.salt = calloc(1, sizeof(*key.salt));
 282         if (key.salt == NULL) {
 283             free_Key(&key);
 284             return ENOMEM;
 285         }
 286
 287         key.salt->type = salt->salttype;
 288         krb5_data_zero (&key.salt->salt);
 289
 290         ret = krb5_data_copy(&key.salt->salt,
 291                              salt->saltvalue.data,
 292                              salt->saltvalue.length);
 293         if (ret) {
 294             free_Key(&key);
 295             return ret;
 296         }
 297     } else
 298         key.salt = NULL;
 299
 300     (*key_set)[*nkeyset] = key;
 301
 302     *nkeyset += 1;
 303
 304     return 0;
 305 }
 306
 307
 308 static
 309 krb5_error_code
 310 ks_tuple2str(krb5_context context, int n_ks_tuple,
 311              krb5_key_salt_tuple *ks_tuple, char ***ks_tuple_strs)
 312 {
 313         size_t i;
 314         char **ksnames;
 315         char *ename, *sname;
 316         krb5_error_code rc = KRB5_PROG_ETYPE_NOSUPP;
 317
 318         *ks_tuple_strs = NULL;
 319         if (n_ks_tuple < 1)
 320                 return 0;
 321
 322         if ((ksnames = calloc(n_ks_tuple, sizeof (*ksnames))) == NULL)
 323                 return (errno);
 324
 325         for (i = 0; i < n_ks_tuple; i++) {
 326             if (krb5_enctype_to_string(context, ks_tuple[i].ks_enctype, &ename))
 327                 goto out;
 328             if (krb5_salttype_to_string(context, ks_tuple[i].ks_enctype,
 329                                         ks_tuple[i].ks_salttype, &sname))
 330                 goto out;
 331
 332             if (asprintf(&ksnames[i], "%s:%s", ename, sname) == -1) {
 333                     rc = errno;
 334                     free(ename);
 335                     free(sname);
 336                     goto out;
 337             }
 338             free(ename);
 339             free(sname);
 340         }
 341
 342         *ks_tuple_strs = ksnames;
 343         rc = 0;
 344
 345 out:
 346         for (i = 0; i < n_ks_tuple; i++)
 347                 free(ksnames[i]);
 348         free(ksnames);
 349         return (rc);
 350 }
 351
 352 /*
 353  * Generate the `key_set' from the [kadmin]default_keys statement. If
 354  * `no_salt' is set, salt is not important (and will not be set) since
 355  * it's random keys that is going to be created.
 356  */
 357
 358 krb5_error_code
 359 hdb_generate_key_set(krb5_context context, krb5_principal principal,
 360                      int n_ks_tuple, krb5_key_salt_tuple *ks_tuple,
 361                      Key **ret_key_set, size_t *nkeyset, int no_salt)
 362 {
 363     char **ktypes = NULL;
 364     char **kp;
 365     krb5_error_code ret;
 366     Key *k, *key_set;
 367     size_t i, j;
 368     char **ks_tuple_strs;
 369     static const char *default_keytypes[] = {
 370         "aes256-cts-hmac-sha1-96:pw-salt",
 371         "des3-cbc-sha1:pw-salt",
 372         "arcfour-hmac-md5:pw-salt",
 373         NULL
 374     };
 375
 376     if ((ret = ks_tuple2str(context, n_ks_tuple, ks_tuple, &ks_tuple_strs)))
 377             return ret;
 378
 379     if (ks_tuple_strs == NULL)
 380         ktypes = krb5_config_get_strings(context, NULL, "kadmin",
 381                                          "default_keys", NULL);
 382     if (ktypes == NULL)
 383         ktypes = (char **)(intptr_t)default_keytypes;
 384
 385     *ret_key_set = key_set = NULL;
 386     *nkeyset = 0;
 387
 388     for(kp = ktypes; kp && *kp; kp++) {
 389         const char *p;
 390         krb5_salt salt;
 391         krb5_enctype *enctypes;
 392         size_t num_enctypes;
 393
 394         p = *kp;
 395         /* check alias */
 396         if(strcmp(p, "v5") == 0)
 397             p = "pw-salt";
 398         else if(strcmp(p, "v4") == 0)
 399             p = "des:pw-salt:";
 400         else if(strcmp(p, "afs") == 0 || strcmp(p, "afs3") == 0)
 401             p = "des:afs3-salt";
 402         else if (strcmp(p, "arcfour-hmac-md5") == 0)
 403             p = "arcfour-hmac-md5:pw-salt";
 404
 405         memset(&salt, 0, sizeof(salt));
 406
 407         ret = parse_key_set(context, p,
 408                             &enctypes, &num_enctypes, &salt, principal);
 409         if (ret) {
 410             krb5_warn(context, ret, "bad value for default_keys `%s'", *kp);
 411             ret = 0;
 412             continue;
 413         }
 414
 415         for (i = 0; i < num_enctypes; i++) {
 416             /* find duplicates */
 417             for (j = 0; j < *nkeyset; j++) {
 418
 419                 k = &key_set[j];
 420
 421                 if (k->key.keytype == enctypes[i]) {
 422                     if (no_salt)
 423                         break;
 424                     if (k->salt == NULL && salt.salttype == KRB5_PW_SALT)
 425                         break;
 426                     if (k->salt->type == salt.salttype &&
 427                         k->salt->salt.length == salt.saltvalue.length &&
 428                         memcmp(k->salt->salt.data, salt.saltvalue.data,
 429                                salt.saltvalue.length) == 0)
 430                         break;
 431                 }
 432             }
 433             /* not a duplicate, lets add it */
 434             if (j == *nkeyset) {
 435                 ret = add_enctype_to_key_set(&key_set, nkeyset, enctypes[i],
 436                                              no_salt ? NULL : &salt);
 437                 if (ret) {
 438                     free(enctypes);
 439                     krb5_free_salt(context, salt);
 440                     goto out;
 441                 }
 442             }
 443         }
 444         free(enctypes);
 445         krb5_free_salt(context, salt);
 446     }
 447
 448     *ret_key_set = key_set;
 449
 450  out:
 451     if (ktypes != (char **)(intptr_t)default_keytypes)
 452         krb5_config_free_strings(ktypes);
 453
 454     if (ret) {
 455         krb5_warn(context, ret,
 456                   "failed to parse the [kadmin]default_keys values");
 457
 458         for (i = 0; i < *nkeyset; i++)
 459             free_Key(&key_set[i]);
 460         free(key_set);
 461     } else if (*nkeyset == 0) {
 462         krb5_warnx(context,
 463                    "failed to parse any of the [kadmin]default_keys values");
 464         ret = EINVAL; /* XXX */
 465     }
 466
 467     return ret;
 468 }
 469
 470
 471 krb5_error_code
 472 hdb_generate_key_set_password(krb5_context context,
 473                               krb5_principal principal,
 474                               const char *password,
 475                               Key **keys, size_t *num_keys)
 476 {
 477     krb5_error_code ret;
 478     size_t i;
 479
 480     ret = hdb_generate_key_set(context, principal, 0, NULL,
 481                                 keys, num_keys, 0);
 482     if (ret)
 483         return ret;
 484
 485     for (i = 0; i < (*num_keys); i++) {
 486         krb5_salt salt;
 487
 488         salt.salttype = (*keys)[i].salt->type;
 489         salt.saltvalue.length = (*keys)[i].salt->salt.length;
 490         salt.saltvalue.data = (*keys)[i].salt->salt.data;
 491
 492         ret = krb5_string_to_key_salt (context,
 493                                        (*keys)[i].key.keytype,
 494                                        password,
 495                                        salt,
 496                                        &(*keys)[i].key);
 497
 498         if(ret)
 499             break;
 500     }
 501
 502     if(ret) {
 503         hdb_free_keys (context, *num_keys, *keys);
 504         return ret;
 505     }
 506     return ret;
 507 }