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,v 1.3 2005/03/17 00:42:05 lha Exp $");
  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) {
 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                 continue;
 116             } else if(strcmp(buf[i], "des3") == 0) {
 117                 e = ETYPE_DES3_CBC_SHA1;
 118                 enctypes = &e;
 119                 num_enctypes = 1;
 120                 continue;
 121             } else {
 122                 ret = krb5_string_to_enctype(context, buf[i], &e);
 123                 if (ret == 0) {
 124                     enctypes = &e;
 125                     num_enctypes = 1;
 126                     continue;
 127                 }
 128             }
 129         }
 130
 131         if(salt->salttype == 0) {
 132             /* interpret string as a salt specifier, if no etype
 133                is set, this sets default values */
 134             /* XXX should perhaps use string_to_salttype, but that
 135                interface sucks */
 136             if(strcmp(buf[i], "pw-salt") == 0) {
 137                 if(enctypes == NULL) {
 138                     enctypes = all_etypes;
 139                     num_enctypes = sizeof(all_etypes)/sizeof(all_etypes[0]);
 140                 }
 141                 salt->salttype = KRB5_PW_SALT;
 142             } else if(strcmp(buf[i], "afs3-salt") == 0) {
 143                 if(enctypes == NULL) {
 144                     enctypes = all_etypes;
 145                     num_enctypes = 3;
 146                 }
 147                 salt->salttype = KRB5_AFS3_SALT;
 148             }
 149         } else {
 150             /* if there is a final string, use it as the string to
 151                salt with, this is mostly useful with null salt for
 152                v4 compat, and a cell name for afs compat */
 153             salt->saltvalue.data = strdup(buf[i]);
 154             if (salt->saltvalue.data == NULL) {
 155                 krb5_set_error_string(context, "malloc out of memory");
 156                 return ENOMEM;
 157             }
 158             salt->saltvalue.length = strlen(buf[i]);
 159         }
 160     }
 161
 162     if(enctypes == NULL || salt->salttype == 0) {
 163         krb5_set_error_string(context, "bad value for default_keys `%s'", key);
 164         return EINVAL;
 165     }
 166
 167     /* if no salt was specified make up default salt */
 168     if(salt->saltvalue.data == NULL) {
 169         if(salt->salttype == KRB5_PW_SALT)
 170             ret = krb5_get_pw_salt(context, principal, salt);
 171         else if(salt->salttype == KRB5_AFS3_SALT) {
 172             krb5_realm *realm = krb5_princ_realm(context, principal);
 173             salt->saltvalue.data = strdup(*realm);
 174             if(salt->saltvalue.data == NULL) {
 175                 krb5_set_error_string(context, "out of memory while "
 176                                       "parsing salt specifiers");
 177                 return ENOMEM;
 178             }
 179             strlwr(salt->saltvalue.data);
 180             salt->saltvalue.length = strlen(*realm);
 181         }
 182     }
 183
 184     *ret_enctypes = malloc(sizeof(enctypes[0]) * num_enctypes);
 185     if (*ret_enctypes == NULL) {
 186         krb5_free_salt(context, *salt);
 187         krb5_set_error_string(context, "out of memory");
 188         return ENOMEM;
 189     }
 190     memcpy(*ret_enctypes, enctypes, sizeof(enctypes[0]) * num_enctypes);
 191     *ret_num_enctypes = num_enctypes;
 192
 193     return 0;
 194 }
 195
 196 static krb5_error_code
 197 add_enctype_to_key_set(Key **key_set, size_t *nkeyset,
 198                        krb5_enctype enctype, krb5_salt *salt)
 199 {
 200     krb5_error_code ret;
 201     Key key, *tmp;
 202
 203     memset(&key, 0, sizeof(key));
 204
 205     tmp = realloc(*key_set, (*nkeyset + 1) * sizeof((*key_set)[0]));
 206     if (tmp == NULL)
 207         return ENOMEM;
 208
 209     *key_set = tmp;
 210
 211     key.key.keytype = enctype;
 212     key.key.keyvalue.length = 0;
 213     key.key.keyvalue.data = NULL;
 214
 215     if (salt) {
 216         key.salt = malloc(sizeof(*key.salt));
 217         if (key.salt == NULL) {
 218             free_Key(&key);
 219             return ENOMEM;
 220         }
 221
 222         key.salt->type = salt->salttype;
 223         krb5_data_zero (&key.salt->salt);
 224
 225         ret = krb5_data_copy(&key.salt->salt,
 226                              salt->saltvalue.data,
 227                              salt->saltvalue.length);
 228         if (ret) {
 229             free_Key(&key);
 230             return ret;
 231         }
 232     } else
 233         key.salt = NULL;
 234
 235     (*key_set)[*nkeyset] = key;
 236
 237     *nkeyset += 1;
 238
 239     return 0;
 240 }
 241
 242
 243 /*
 244  * Generate the `key_set' from the [kadmin]default_keys statement. If
 245  * `no_salt' is set, salt is not important (and will not be set) since
 246  * its random keys that is going to be created.
 247  */
 248
 249 krb5_error_code
 250 hdb_generate_key_set(krb5_context context, krb5_principal principal,
 251                      Key **ret_key_set, size_t *nkeyset, int no_salt)
 252 {
 253     char **ktypes, **kp;
 254     krb5_error_code ret;
 255     Key *k, *key_set;
 256     int i, j;
 257     char *default_keytypes[] = {
 258         "des:pw-salt",
 259         "aes256-cts-hmac-sha1-96:pw-salt",
 260         "des3-cbc-sha1:pw-salt",
 261         "arcfour-hmac-md5:pw-salt",
 262         NULL
 263     };
 264
 265     ktypes = krb5_config_get_strings(context, NULL, "kadmin",
 266                                      "default_keys", NULL);
 267     if (ktypes == NULL)
 268         ktypes = default_keytypes;
 269
 270     if (ktypes == NULL)
 271         abort();
 272
 273     *ret_key_set = key_set = NULL;
 274     *nkeyset = 0;
 275
 276     ret = 0;
 277
 278     for(kp = ktypes; kp && *kp; kp++) {
 279         const char *p;
 280         krb5_salt salt;
 281         krb5_enctype *enctypes;
 282         size_t num_enctypes;
 283
 284         p = *kp;
 285         /* check alias */
 286         if(strcmp(p, "v5") == 0)
 287             p = "pw-salt";
 288         else if(strcmp(p, "v4") == 0)
 289             p = "des:pw-salt:";
 290         else if(strcmp(p, "afs") == 0 || strcmp(p, "afs3") == 0)
 291             p = "des:afs3-salt";
 292         else if (strcmp(p, "arcfour-hmac-md5") == 0)
 293             p = "arcfour-hmac-md5:pw-salt";
 294
 295         memset(&salt, 0, sizeof(salt));
 296
 297         ret = parse_key_set(context, p,
 298                             &enctypes, &num_enctypes, &salt, principal);
 299         if (ret) {
 300             krb5_warnx(context, "bad value for default_keys `%s'", *kp);
 301             continue;
 302         }
 303
 304         for (i = 0; i < num_enctypes; i++) {
 305             /* find duplicates */
 306             for (j = 0; j < *nkeyset; j++) {
 307
 308                 k = &key_set[j];
 309
 310                 if (k->key.keytype == enctypes[i]) {
 311                     if (no_salt)
 312                         break;
 313                     if (k->salt == NULL && salt.salttype == KRB5_PW_SALT)
 314                         break;
 315                     if (k->salt->type == salt.salttype &&
 316                         k->salt->salt.length == salt.saltvalue.length &&
 317                         memcmp(k->salt->salt.data, salt.saltvalue.data,
 318                                salt.saltvalue.length) == 0)
 319                         break;
 320                 }
 321             }
 322             /* not a duplicate, lets add it */
 323             if (j == *nkeyset) {
 324                 ret = add_enctype_to_key_set(&key_set, nkeyset, enctypes[i],
 325                                              no_salt ? NULL : &salt);
 326                 if (ret) {
 327                     free(enctypes);
 328                     krb5_free_salt(context, salt);
 329                     goto out;
 330                 }
 331             }
 332         }
 333         free(enctypes);
 334         krb5_free_salt(context, salt);
 335     }
 336
 337  out:
 338     if (ret) {
 339         krb5_warn(context, ret,
 340                   "failed to parse the [kadmin]default_keys values");
 341
 342         for (i = 0; i < *nkeyset; i++)
 343             free_Key(&key_set[i]);
 344         free(key_set);
 345     } else if (*nkeyset == 0) {
 346         krb5_warnx(context,
 347                    "failed to parse any of the [kadmin]default_keys values");
 348         ret = EINVAL; /* XXX */
 349     }
 350
 351     *ret_key_set = key_set;
 352
 353     return ret;
 354 }
 355
 356
 357 krb5_error_code
 358 hdb_generate_key_set_password(krb5_context context,
 359                               krb5_principal principal,
 360                               const char *password,
 361                               Key **keys, size_t *num_keys)
 362 {
 363     krb5_error_code ret;
 364     int i;
 365
 366     ret = hdb_generate_key_set(context, principal,
 367                                 keys, num_keys, 0);
 368     if (ret)
 369         return ret;
 370
 371     for (i = 0; i < (*num_keys); i++) {
 372         krb5_salt salt;
 373
 374         salt.salttype = (*keys)[i].salt->type;
 375         salt.saltvalue.length = (*keys)[i].salt->salt.length;
 376         salt.saltvalue.data = (*keys)[i].salt->salt.data;
 377
 378         ret = krb5_string_to_key_salt (context,
 379                                        (*keys)[i].key.keytype,
 380                                        password,
 381                                        salt,
 382                                        &(*keys)[i].key);
 383
 384         if(ret)
 385             break;
 386     }
 387
 388     if(ret) {
 389         hdb_free_keys (context, *num_keys, *keys);
 390         return ret;
 391     }
 392     return ret;
 393 }