source/heimdal/lib/hdb/keys.c

   1 /*
   2  * Copyright (c) 1997 - 2001, 2003 - 2004 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the Institute nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 #include "hdb_locl.h"
  35
  36 RCSID("$Id: keys.c 23316 2008-06-23 04:32:32Z lha $");
  37
  38 /*
  39  * free all the memory used by (len, keys)
  40  */
  41
  42 void
  43 hdb_free_keys (krb5_context context, int len, Key *keys)
  44 {
  45     int i;
  46
  47     for (i = 0; i < len; i++) {
  48         free(keys[i].mkvno);
  49         keys[i].mkvno = NULL;
  50         if (keys[i].salt != NULL) {
  51             free_Salt(keys[i].salt);
  52             free(keys[i].salt);
  53             keys[i].salt = NULL;
  54         }
  55         krb5_free_keyblock_contents(context, &keys[i].key);
  56     }
  57     free (keys);
  58 }
  59
  60 /*
  61  * for each entry in `default_keys' try to parse it as a sequence
  62  * of etype:salttype:salt, syntax of this if something like:
  63  * [(des|des3|etype):](pw-salt|afs3)[:string], if etype is omitted it
  64  *      means all etypes, and if string is omitted is means the default
  65  * string (for that principal). Additional special values:
  66  *      v5 == pw-salt, and
  67  *      v4 == des:pw-salt:
  68  *      afs or afs3 == des:afs3-salt
  69  */
  70
  71 /* the 3 DES types must be first */
  72 static const krb5_enctype all_etypes[] = {
  73     ETYPE_DES_CBC_MD5,
  74     ETYPE_DES_CBC_MD4,
  75     ETYPE_DES_CBC_CRC,
  76     ETYPE_AES256_CTS_HMAC_SHA1_96,
  77     ETYPE_ARCFOUR_HMAC_MD5,
  78     ETYPE_DES3_CBC_SHA1
  79 };
  80
  81 static krb5_error_code
  82 parse_key_set(krb5_context context, const char *key,
  83               krb5_enctype **ret_enctypes, size_t *ret_num_enctypes,
  84               krb5_salt *salt, krb5_principal principal)
  85 {
  86     const char *p;
  87     char buf[3][256];
  88     int num_buf = 0;
  89     int i, num_enctypes = 0;
  90     krb5_enctype e;
  91     const krb5_enctype *enctypes = NULL;
  92     krb5_error_code ret;
  93
  94     p = key;
  95
  96     *ret_enctypes = NULL;
  97     *ret_num_enctypes = 0;
  98
  99     /* split p in a list of :-separated strings */
 100     for(num_buf = 0; num_buf < 3; num_buf++)
 101         if(strsep_copy(&p, ":", buf[num_buf], sizeof(buf[num_buf])) == -1)
 102             break;
 103
 104     salt->saltvalue.data = NULL;
 105     salt->saltvalue.length = 0;
 106
 107     for(i = 0; i < num_buf; i++) {
 108         if(enctypes == NULL && num_buf > 1) {
 109             /* this might be a etype specifier */
 110             /* XXX there should be a string_to_etypes handling
 111                special cases like `des' and `all' */
 112             if(strcmp(buf[i], "des") == 0) {
 113                 enctypes = all_etypes;
 114                 num_enctypes = 3;
 115             } else if(strcmp(buf[i], "des3") == 0) {
 116                 e = ETYPE_DES3_CBC_SHA1;
 117                 enctypes = &e;
 118                 num_enctypes = 1;
 119             } else {
 120                 ret = krb5_string_to_enctype(context, buf[i], &e);
 121                 if (ret == 0) {
 122                     enctypes = &e;
 123                     num_enctypes = 1;
 124                 } else
 125                     return ret;
 126             }
 127             continue;
 128         }
 129         if(salt->salttype == 0) {
 130             /* interpret string as a salt specifier, if no etype
 131                is set, this sets default values */
 132             /* XXX should perhaps use string_to_salttype, but that
 133                interface sucks */
 134             if(strcmp(buf[i], "pw-salt") == 0) {
 135                 if(enctypes == NULL) {
 136                     enctypes = all_etypes;
 137                     num_enctypes = sizeof(all_etypes)/sizeof(all_etypes[0]);
 138                 }
 139                 salt->salttype = KRB5_PW_SALT;
 140             } else if(strcmp(buf[i], "afs3-salt") == 0) {
 141                 if(enctypes == NULL) {
 142                     enctypes = all_etypes;
 143                     num_enctypes = 3;
 144                 }
 145                 salt->salttype = KRB5_AFS3_SALT;
 146             }
 147             continue;
 148         }
 149
 150         {
 151             /* if there is a final string, use it as the string to
 152                salt with, this is mostly useful with null salt for
 153                v4 compat, and a cell name for afs compat */
 154             salt->saltvalue.data = strdup(buf[i]);
 155             if (salt->saltvalue.data == NULL) {
 156                 krb5_set_error_message(context, ENOMEM, "malloc: out of memory");
 157                 return ENOMEM;
 158             }
 159             salt->saltvalue.length = strlen(buf[i]);
 160         }
 161     }
 162
 163     if(enctypes == NULL || salt->salttype == 0) {
 164         krb5_set_error_message(context, EINVAL, "bad value for default_keys `%s'", key);
 165         return EINVAL;
 166     }
 167
 168     /* if no salt was specified make up default salt */
 169     if(salt->saltvalue.data == NULL) {
 170         if(salt->salttype == KRB5_PW_SALT)
 171             ret = krb5_get_pw_salt(context, principal, salt);
 172         else if(salt->salttype == KRB5_AFS3_SALT) {
 173             krb5_realm *realm = krb5_princ_realm(context, principal);
 174             salt->saltvalue.data = strdup(*realm);
 175             if(salt->saltvalue.data == NULL) {
 176                 krb5_set_error_message(context, ENOMEM,
 177                                        "out of memory while "
 178                                        "parsing salt specifiers");
 179                 return ENOMEM;
 180             }
 181             strlwr(salt->saltvalue.data);
 182             salt->saltvalue.length = strlen(*realm);
 183         }
 184     }
 185
 186     *ret_enctypes = malloc(sizeof(enctypes[0]) * num_enctypes);
 187     if (*ret_enctypes == NULL) {
 188         krb5_free_salt(context, *salt);
 189         krb5_set_error_message(context, ENOMEM, "malloc: out of memory");
 190         return ENOMEM;
 191     }
 192     memcpy(*ret_enctypes, enctypes, sizeof(enctypes[0]) * num_enctypes);
 193     *ret_num_enctypes = num_enctypes;
 194
 195     return 0;
 196 }
 197
 198 static krb5_error_code
 199 add_enctype_to_key_set(Key **key_set, size_t *nkeyset,
 200                        krb5_enctype enctype, krb5_salt *salt)
 201 {
 202     krb5_error_code ret;
 203     Key key, *tmp;
 204
 205     memset(&key, 0, sizeof(key));
 206
 207     tmp = realloc(*key_set, (*nkeyset + 1) * sizeof((*key_set)[0]));
 208     if (tmp == NULL)
 209         return ENOMEM;
 210
 211     *key_set = tmp;
 212
 213     key.key.keytype = enctype;
 214     key.key.keyvalue.length = 0;
 215     key.key.keyvalue.data = NULL;
 216
 217     if (salt) {
 218         key.salt = malloc(sizeof(*key.salt));
 219         if (key.salt == NULL) {
 220             free_Key(&key);
 221             return ENOMEM;
 222         }
 223
 224         key.salt->type = salt->salttype;
 225         krb5_data_zero (&key.salt->salt);
 226
 227         ret = krb5_data_copy(&key.salt->salt,
 228                              salt->saltvalue.data,
 229                              salt->saltvalue.length);
 230         if (ret) {
 231             free_Key(&key);
 232             return ret;
 233         }
 234     } else
 235         key.salt = NULL;
 236
 237     (*key_set)[*nkeyset] = key;
 238
 239     *nkeyset += 1;
 240
 241     return 0;
 242 }
 243
 244
 245 /*
 246  * Generate the `key_set' from the [kadmin]default_keys statement. If
 247  * `no_salt' is set, salt is not important (and will not be set) since
 248  * it's random keys that is going to be created.
 249  */
 250
 251 krb5_error_code
 252 hdb_generate_key_set(krb5_context context, krb5_principal principal,
 253                      Key **ret_key_set, size_t *nkeyset, int no_salt)
 254 {
 255     char **ktypes, **kp;
 256     krb5_error_code ret;
 257     Key *k, *key_set;
 258     int i, j;
 259     char *default_keytypes[] = {
 260         "des:pw-salt",
 261         "aes256-cts-hmac-sha1-96:pw-salt",
 262         "des3-cbc-sha1:pw-salt",
 263         "arcfour-hmac-md5:pw-salt",
 264         NULL
 265     };
 266
 267     ktypes = krb5_config_get_strings(context, NULL, "kadmin",
 268                                      "default_keys", NULL);
 269     if (ktypes == NULL)
 270         ktypes = default_keytypes;
 271
 272     if (ktypes == NULL)
 273         abort();
 274
 275     *ret_key_set = key_set = NULL;
 276     *nkeyset = 0;
 277
 278     ret = 0;
 279
 280     for(kp = ktypes; kp && *kp; kp++) {
 281         const char *p;
 282         krb5_salt salt;
 283         krb5_enctype *enctypes;
 284         size_t num_enctypes;
 285
 286         p = *kp;
 287         /* check alias */
 288         if(strcmp(p, "v5") == 0)
 289             p = "pw-salt";
 290         else if(strcmp(p, "v4") == 0)
 291             p = "des:pw-salt:";
 292         else if(strcmp(p, "afs") == 0 || strcmp(p, "afs3") == 0)
 293             p = "des:afs3-salt";
 294         else if (strcmp(p, "arcfour-hmac-md5") == 0)
 295             p = "arcfour-hmac-md5:pw-salt";
 296
 297         memset(&salt, 0, sizeof(salt));
 298
 299         ret = parse_key_set(context, p,
 300                             &enctypes, &num_enctypes, &salt, principal);
 301         if (ret) {
 302             krb5_warn(context, ret, "bad value for default_keys `%s'", *kp);
 303             ret = 0;
 304             continue;
 305         }
 306
 307         for (i = 0; i < num_enctypes; i++) {
 308             /* find duplicates */
 309             for (j = 0; j < *nkeyset; j++) {
 310
 311                 k = &key_set[j];
 312
 313                 if (k->key.keytype == enctypes[i]) {
 314                     if (no_salt)
 315                         break;
 316                     if (k->salt == NULL && salt.salttype == KRB5_PW_SALT)
 317                         break;
 318                     if (k->salt->type == salt.salttype &&
 319                         k->salt->salt.length == salt.saltvalue.length &&
 320                         memcmp(k->salt->salt.data, salt.saltvalue.data,
 321                                salt.saltvalue.length) == 0)
 322                         break;
 323                 }
 324             }
 325             /* not a duplicate, lets add it */
 326             if (j == *nkeyset) {
 327                 ret = add_enctype_to_key_set(&key_set, nkeyset, enctypes[i],
 328                                              no_salt ? NULL : &salt);
 329                 if (ret) {
 330                     free(enctypes);
 331                     krb5_free_salt(context, salt);
 332                     goto out;
 333                 }
 334             }
 335         }
 336         free(enctypes);
 337         krb5_free_salt(context, salt);
 338     }
 339
 340     *ret_key_set = key_set;
 341
 342  out:
 343     if (ktypes != default_keytypes)
 344         krb5_config_free_strings(ktypes);
 345
 346     if (ret) {
 347         krb5_warn(context, ret,
 348                   "failed to parse the [kadmin]default_keys values");
 349
 350         for (i = 0; i < *nkeyset; i++)
 351             free_Key(&key_set[i]);
 352         free(key_set);
 353     } else if (*nkeyset == 0) {
 354         krb5_warnx(context,
 355                    "failed to parse any of the [kadmin]default_keys values");
 356         ret = EINVAL; /* XXX */
 357     }
 358
 359     return ret;
 360 }
 361
 362
 363 krb5_error_code
 364 hdb_generate_key_set_password(krb5_context context,
 365                               krb5_principal principal,
 366                               const char *password,
 367                               Key **keys, size_t *num_keys)
 368 {
 369     krb5_error_code ret;
 370     int i;
 371
 372     ret = hdb_generate_key_set(context, principal,
 373                                 keys, num_keys, 0);
 374     if (ret)
 375         return ret;
 376
 377     for (i = 0; i < (*num_keys); i++) {
 378         krb5_salt salt;
 379
 380         salt.salttype = (*keys)[i].salt->type;
 381         salt.saltvalue.length = (*keys)[i].salt->salt.length;
 382         salt.saltvalue.data = (*keys)[i].salt->salt.data;
 383
 384         ret = krb5_string_to_key_salt (context,
 385                                        (*keys)[i].key.keytype,
 386                                        password,
 387                                        salt,
 388                                        &(*keys)[i].key);
 389
 390         if(ret)
 391             break;
 392     }
 393
 394     if(ret) {
 395         hdb_free_keys (context, *num_keys, *keys);
 396         return ret;
 397     }
 398     return ret;
 399 }