Stop using SALT_TYPE_AFS_LENGTH
[krb5.git] / src / lib / kdb / kdb_cpw.c
1 /* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
2 /* lib/kdb/kdb_cpw.c */
3 /*
4  * Copyright 1995, 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 #include "k5-int.h"
53 #include "kdb.h"
54 #include <stdio.h>
55 #include <errno.h>
56
57 int
58 krb5_db_get_key_data_kvno(context, count, data)
59     krb5_context          context;
60     int                   count;
61     krb5_key_data       * data;
62 {
63     int i, kvno;
64     /* Find last key version number */
65     for (kvno = i = 0; i < count; i++) {
66         if (kvno < data[i].key_data_kvno) {
67             kvno = data[i].key_data_kvno;
68         }
69     }
70     return(kvno);
71 }
72
73 static void
74 cleanup_key_data(context, count, data)
75     krb5_context          context;
76     int                   count;
77     krb5_key_data       * data;
78 {
79     int i, j;
80
81     /* If data is NULL, count is always 0 */
82     if (data == NULL) return;
83
84     for (i = 0; i < count; i++) {
85         for (j = 0; j < data[i].key_data_ver; j++) {
86             if (data[i].key_data_length[j]) {
87                 krb5_db_free(context, data[i].key_data_contents[j]);
88             }
89         }
90     }
91     krb5_db_free(context, data);
92 }
93
94 static krb5_error_code
95 add_key_rnd(context, master_key, ks_tuple, ks_tuple_count, db_entry, kvno)
96     krb5_context          context;
97     krb5_keyblock       * master_key;
98     krb5_key_salt_tuple * ks_tuple;
99     int                   ks_tuple_count;
100     krb5_db_entry       * db_entry;
101     int                   kvno;
102 {
103     krb5_principal        krbtgt_princ;
104     krb5_keyblock         key;
105     krb5_db_entry         *krbtgt_entry;
106     int                   max_kvno, i, j, k;
107     krb5_error_code       retval;
108     krb5_key_data         tmp_key_data;
109     krb5_key_data        *tptr;
110
111     memset( &tmp_key_data, 0, sizeof(tmp_key_data));
112
113
114     retval = krb5_build_principal_ext(context, &krbtgt_princ,
115                                       db_entry->princ->realm.length,
116                                       db_entry->princ->realm.data,
117                                       KRB5_TGS_NAME_SIZE,
118                                       KRB5_TGS_NAME,
119                                       db_entry->princ->realm.length,
120                                       db_entry->princ->realm.data,
121                                       0);
122     if (retval)
123         return retval;
124
125     /* Get tgt from database */
126     retval = krb5_db_get_principal(context, krbtgt_princ, 0, &krbtgt_entry);
127     krb5_free_principal(context, krbtgt_princ); /* don't need it anymore */
128     if (retval)
129         return(retval);
130
131     /* Get max kvno */
132     for (max_kvno = j = 0; j < krbtgt_entry->n_key_data; j++) {
133         if (max_kvno < krbtgt_entry->key_data[j].key_data_kvno) {
134             max_kvno = krbtgt_entry->key_data[j].key_data_kvno;
135         }
136     }
137
138     for (i = 0; i < ks_tuple_count; i++) {
139         krb5_boolean similar;
140
141         similar = 0;
142
143         /*
144          * We could use krb5_keysalt_iterate to replace this loop, or use
145          * krb5_keysalt_is_present for the loop below, but we want to avoid
146          * circular library dependencies.
147          */
148         for (j = 0; j < i; j++) {
149             if ((retval = krb5_c_enctype_compare(context,
150                                                  ks_tuple[i].ks_enctype,
151                                                  ks_tuple[j].ks_enctype,
152                                                  &similar)))
153                 return(retval);
154
155             if (similar)
156                 break;
157         }
158
159         if (similar)
160             continue;
161
162         if ((retval = krb5_dbe_create_key_data(context, db_entry)))
163             goto add_key_rnd_err;
164
165         /* there used to be code here to extract the old key, and derive
166            a new key from it.  Now that there's a unified prng, that isn't
167            necessary. */
168
169         /* make new key */
170         if ((retval = krb5_c_make_random_key(context, ks_tuple[i].ks_enctype,
171                                              &key)))
172             goto add_key_rnd_err;
173
174
175         /* db library will free this. Since, its a so, it could actually be using different memory management
176            function. So, its better if the memory is allocated by the db's malloc. So, a temporary memory is used
177            here which will later be copied to the db_entry */
178         retval = krb5_dbe_encrypt_key_data(context, master_key, &key, NULL,
179                                            kvno, &tmp_key_data);
180
181         krb5_free_keyblock_contents(context, &key);
182         if( retval )
183             goto add_key_rnd_err;
184
185         tptr = &db_entry->key_data[db_entry->n_key_data-1];
186
187         tptr->key_data_ver = tmp_key_data.key_data_ver;
188         tptr->key_data_kvno = tmp_key_data.key_data_kvno;
189
190         for( k = 0; k < tmp_key_data.key_data_ver; k++ )
191         {
192             tptr->key_data_type[k] = tmp_key_data.key_data_type[k];
193             tptr->key_data_length[k] = tmp_key_data.key_data_length[k];
194             if( tmp_key_data.key_data_contents[k] )
195             {
196                 tptr->key_data_contents[k] = krb5_db_alloc(context, NULL, tmp_key_data.key_data_length[k]);
197                 if( tptr->key_data_contents[k] == NULL )
198                 {
199                     cleanup_key_data(context, db_entry->n_key_data, db_entry->key_data);
200                     db_entry->key_data = NULL;
201                     db_entry->n_key_data = 0;
202                     retval = ENOMEM;
203                     goto add_key_rnd_err;
204                 }
205                 memcpy( tptr->key_data_contents[k], tmp_key_data.key_data_contents[k], tmp_key_data.key_data_length[k]);
206
207                 memset( tmp_key_data.key_data_contents[k], 0, tmp_key_data.key_data_length[k]);
208                 free( tmp_key_data.key_data_contents[k] );
209                 tmp_key_data.key_data_contents[k] = NULL;
210             }
211         }
212
213     }
214
215 add_key_rnd_err:
216     krb5_db_free_principal(context, krbtgt_entry);
217
218     for( i = 0; i < tmp_key_data.key_data_ver; i++ )
219     {
220         if( tmp_key_data.key_data_contents[i] )
221         {
222             memset( tmp_key_data.key_data_contents[i], 0, tmp_key_data.key_data_length[i]);
223             free( tmp_key_data.key_data_contents[i] );
224         }
225     }
226     return(retval);
227 }
228
229 /*
230  * Change random key for a krb5_db_entry
231  * Assumes the max kvno
232  *
233  * As a side effect all old keys are nuked if keepold is false.
234  */
235 krb5_error_code
236 krb5_dbe_crk(context, master_key, ks_tuple, ks_tuple_count, keepold, db_entry)
237     krb5_context          context;
238     krb5_keyblock       * master_key;
239     krb5_key_salt_tuple * ks_tuple;
240     int                   ks_tuple_count;
241     krb5_boolean          keepold;
242     krb5_db_entry       * db_entry;
243 {
244     int                   key_data_count;
245     int                   n_new_key_data;
246     krb5_key_data       * key_data;
247     krb5_error_code       retval;
248     int                   kvno;
249     int                   i;
250
251     /* First save the old keydata */
252     kvno = krb5_db_get_key_data_kvno(context, db_entry->n_key_data,
253                                      db_entry->key_data);
254     key_data_count = db_entry->n_key_data;
255     key_data = db_entry->key_data;
256     db_entry->key_data = NULL;
257     db_entry->n_key_data = 0;
258
259     /* increment the kvno */
260     kvno++;
261
262     retval = add_key_rnd(context, master_key, ks_tuple,
263                          ks_tuple_count, db_entry, kvno);
264     if (retval) {
265         cleanup_key_data(context, db_entry->n_key_data, db_entry->key_data);
266         db_entry->n_key_data = key_data_count;
267         db_entry->key_data = key_data;
268     } else if (keepold) {
269         n_new_key_data = db_entry->n_key_data;
270         for (i = 0; i < key_data_count; i++) {
271             retval = krb5_dbe_create_key_data(context, db_entry);
272             if (retval) {
273                 cleanup_key_data(context, db_entry->n_key_data,
274                                  db_entry->key_data);
275                 break;
276             }
277             db_entry->key_data[i+n_new_key_data] = key_data[i];
278             memset(&key_data[i], 0, sizeof(krb5_key_data));
279         }
280         krb5_db_free(context, key_data); /* we moved the cotents to new memory. But, the original block which contained the data */
281     } else {
282         cleanup_key_data(context, key_data_count, key_data);
283     }
284     return(retval);
285 }
286
287 /*
288  * Add random key for a krb5_db_entry
289  * Assumes the max kvno
290  *
291  * As a side effect all old keys older than the max kvno are nuked.
292  */
293 krb5_error_code
294 krb5_dbe_ark(context, master_key, ks_tuple, ks_tuple_count, db_entry)
295     krb5_context          context;
296     krb5_keyblock       * master_key;
297     krb5_key_salt_tuple * ks_tuple;
298     int                   ks_tuple_count;
299     krb5_db_entry       * db_entry;
300 {
301     int                   key_data_count;
302     krb5_key_data       * key_data;
303     krb5_error_code       retval;
304     int                   kvno;
305     int                   i;
306
307     /* First save the old keydata */
308     kvno = krb5_db_get_key_data_kvno(context, db_entry->n_key_data,
309                                      db_entry->key_data);
310     key_data_count = db_entry->n_key_data;
311     key_data = db_entry->key_data;
312     db_entry->key_data = NULL;
313     db_entry->n_key_data = 0;
314
315     /* increment the kvno */
316     kvno++;
317
318     if ((retval = add_key_rnd(context, master_key, ks_tuple,
319                               ks_tuple_count, db_entry, kvno))) {
320         cleanup_key_data(context, db_entry->n_key_data, db_entry->key_data);
321         db_entry->n_key_data = key_data_count;
322         db_entry->key_data = key_data;
323     } else {
324         /* Copy keys with key_data_kvno == kvno - 1 ( = old kvno ) */
325         for (i = 0; i < key_data_count; i++) {
326             if (key_data[i].key_data_kvno == (kvno - 1)) {
327                 if ((retval = krb5_dbe_create_key_data(context, db_entry))) {
328                     cleanup_key_data(context, db_entry->n_key_data,
329                                      db_entry->key_data);
330                     break;
331                 }
332                 /* We should decrypt/re-encrypt the data to use the same mkvno*/
333                 db_entry->key_data[db_entry->n_key_data - 1] = key_data[i];
334                 memset(&key_data[i], 0, sizeof(krb5_key_data));
335             }
336         }
337         cleanup_key_data(context, key_data_count, key_data);
338     }
339     return(retval);
340 }
341
342 /* Construct a random explicit salt. */
343 static krb5_error_code
344 make_random_salt(krb5_context context, krb5_keysalt *salt_out)
345 {
346     krb5_error_code retval;
347     unsigned char rndbuf[8];
348     krb5_data salt, rnd = make_data(rndbuf, sizeof(rndbuf));
349     unsigned int i;
350
351     /*
352      * Salts are limited by RFC 4120 to 7-bit ASCII.  For ease of examination
353      * and to avoid certain folding issues for older enctypes, we use printable
354      * characters with four fixed bits and four random bits, encoding 64
355      * psuedo-random bits into 16 bytes.
356      */
357     retval = krb5_c_random_make_octets(context, &rnd);
358     if (retval)
359         return retval;
360     retval = alloc_data(&salt, sizeof(rndbuf) * 2);
361     if (retval)
362         return retval;
363     for (i = 0; i < sizeof(rndbuf); i++) {
364         salt.data[i * 2] = 0x40 | (rndbuf[i] >> 4);
365         salt.data[i * 2 + 1] = 0x40 | (rndbuf[i] & 0xf);
366     }
367
368     salt_out->type = KRB5_KDB_SALTTYPE_SPECIAL;
369     salt_out->data = salt;
370     return 0;
371 }
372
373 /*
374  * Add key_data for a krb5_db_entry
375  * If passwd is NULL the assumes that the caller wants a random password.
376  */
377 static krb5_error_code
378 add_key_pwd(context, master_key, ks_tuple, ks_tuple_count, passwd,
379             db_entry, kvno)
380     krb5_context          context;
381     krb5_keyblock       * master_key;
382     krb5_key_salt_tuple * ks_tuple;
383     int                   ks_tuple_count;
384     char                * passwd;
385     krb5_db_entry       * db_entry;
386     int                   kvno;
387 {
388     krb5_error_code       retval;
389     krb5_keysalt          key_salt;
390     krb5_keyblock         key;
391     krb5_data             pwd;
392     krb5_data             afs_params = string2data("\1"), *s2k_params = NULL;
393     int                   i, j, k;
394     krb5_key_data         tmp_key_data;
395     krb5_key_data        *tptr;
396
397     memset( &tmp_key_data, 0, sizeof(tmp_key_data));
398
399     retval = 0;
400
401     for (i = 0; i < ks_tuple_count; i++) {
402         krb5_boolean similar;
403
404         similar = 0;
405
406         /*
407          * We could use krb5_keysalt_iterate to replace this loop, or use
408          * krb5_keysalt_is_present for the loop below, but we want to avoid
409          * circular library dependencies.
410          */
411         for (j = 0; j < i; j++) {
412             if ((retval = krb5_c_enctype_compare(context,
413                                                  ks_tuple[i].ks_enctype,
414                                                  ks_tuple[j].ks_enctype,
415                                                  &similar)))
416                 return(retval);
417
418             if (similar &&
419                 (ks_tuple[j].ks_salttype == ks_tuple[i].ks_salttype))
420                 break;
421         }
422
423         if (j < i)
424             continue;
425
426         if ((retval = krb5_dbe_create_key_data(context, db_entry)))
427             return(retval);
428
429         /* Convert password string to key using appropriate salt */
430         switch (key_salt.type = ks_tuple[i].ks_salttype) {
431         case KRB5_KDB_SALTTYPE_ONLYREALM: {
432             krb5_data * saltdata;
433             if ((retval = krb5_copy_data(context, krb5_princ_realm(context,
434                                                                    db_entry->princ), &saltdata)))
435                 return(retval);
436
437             key_salt.data = *saltdata;
438             free(saltdata);
439         }
440             break;
441         case KRB5_KDB_SALTTYPE_NOREALM:
442             if ((retval=krb5_principal2salt_norealm(context, db_entry->princ,
443                                                     &key_salt.data)))
444                 return(retval);
445             break;
446         case KRB5_KDB_SALTTYPE_NORMAL:
447             if ((retval = krb5_principal2salt(context, db_entry->princ,
448                                               &key_salt.data)))
449                 return(retval);
450             break;
451         case KRB5_KDB_SALTTYPE_V4:
452             key_salt.data.length = 0;
453             key_salt.data.data = 0;
454             break;
455         case KRB5_KDB_SALTTYPE_AFS3:
456             retval = krb5int_copy_data_contents(context,
457                                                 &db_entry->princ->realm,
458                                                 &key_salt.data);
459             if (retval)
460                 return retval;
461             s2k_params = &afs_params;
462             break;
463         case KRB5_KDB_SALTTYPE_SPECIAL:
464             retval = make_random_salt(context, &key_salt);
465             if (retval)
466                 return retval;
467             break;
468         default:
469             return(KRB5_KDB_BAD_SALTTYPE);
470         }
471
472         pwd.data = passwd;
473         pwd.length = strlen(passwd);
474
475         retval = krb5_c_string_to_key_with_params(context,
476                                                   ks_tuple[i].ks_enctype,
477                                                   &pwd, &key_salt.data,
478                                                   s2k_params, &key);
479         if (retval) {
480             free(key_salt.data.data);
481             return retval;
482         }
483
484         /* memory allocation to be done by db. So, use temporary block and later copy
485            it to the memory allocated by db */
486         retval = krb5_dbe_encrypt_key_data(context, master_key, &key,
487                                            (const krb5_keysalt *)&key_salt,
488                                            kvno, &tmp_key_data);
489         if (key_salt.data.data)
490             free(key_salt.data.data);
491         free(key.contents);
492
493         if( retval )
494             return retval;
495
496         tptr = &db_entry->key_data[db_entry->n_key_data-1];
497
498         tptr->key_data_ver = tmp_key_data.key_data_ver;
499         tptr->key_data_kvno = tmp_key_data.key_data_kvno;
500
501         for( k = 0; k < tmp_key_data.key_data_ver; k++ )
502         {
503             tptr->key_data_type[k] = tmp_key_data.key_data_type[k];
504             tptr->key_data_length[k] = tmp_key_data.key_data_length[k];
505             if( tmp_key_data.key_data_contents[k] )
506             {
507                 tptr->key_data_contents[k] = krb5_db_alloc(context, NULL, tmp_key_data.key_data_length[k]);
508                 if( tptr->key_data_contents[k] == NULL )
509                 {
510                     cleanup_key_data(context, db_entry->n_key_data, db_entry->key_data);
511                     db_entry->key_data = NULL;
512                     db_entry->n_key_data = 0;
513                     retval = ENOMEM;
514                     goto add_key_pwd_err;
515                 }
516                 memcpy( tptr->key_data_contents[k], tmp_key_data.key_data_contents[k], tmp_key_data.key_data_length[k]);
517
518                 memset( tmp_key_data.key_data_contents[k], 0, tmp_key_data.key_data_length[k]);
519                 free( tmp_key_data.key_data_contents[k] );
520                 tmp_key_data.key_data_contents[k] = NULL;
521             }
522         }
523     }
524 add_key_pwd_err:
525     for( i = 0; i < tmp_key_data.key_data_ver; i++ )
526     {
527         if( tmp_key_data.key_data_contents[i] )
528         {
529             memset( tmp_key_data.key_data_contents[i], 0, tmp_key_data.key_data_length[i]);
530             free( tmp_key_data.key_data_contents[i] );
531         }
532     }
533
534     return(retval);
535 }
536
537 /*
538  * Change password for a krb5_db_entry
539  * Assumes the max kvno
540  *
541  * As a side effect all old keys are nuked if keepold is false.
542  */
543 krb5_error_code
544 krb5_dbe_def_cpw(context, master_key, ks_tuple, ks_tuple_count, passwd,
545                  new_kvno, keepold, db_entry)
546     krb5_context          context;
547     krb5_keyblock       * master_key;
548     krb5_key_salt_tuple * ks_tuple;
549     int                   ks_tuple_count;
550     char                * passwd;
551     int                   new_kvno;
552     krb5_boolean          keepold;
553     krb5_db_entry       * db_entry;
554 {
555     int                   key_data_count;
556     int                   n_new_key_data;
557     krb5_key_data       * key_data;
558     krb5_error_code       retval;
559     int                   old_kvno;
560     int                   i;
561
562     /* First save the old keydata */
563     old_kvno = krb5_db_get_key_data_kvno(context, db_entry->n_key_data,
564                                          db_entry->key_data);
565     key_data_count = db_entry->n_key_data;
566     key_data = db_entry->key_data;
567     db_entry->key_data = NULL;
568     db_entry->n_key_data = 0;
569
570     /* increment the kvno.  if the requested kvno is too small,
571        increment the old kvno */
572     if (new_kvno < old_kvno+1)
573         new_kvno = old_kvno+1;
574
575     retval = add_key_pwd(context, master_key, ks_tuple, ks_tuple_count,
576                          passwd, db_entry, new_kvno);
577     if (retval) {
578         cleanup_key_data(context, db_entry->n_key_data, db_entry->key_data);
579         db_entry->n_key_data = key_data_count;
580         db_entry->key_data = key_data;
581     } else if (keepold) {
582         n_new_key_data = db_entry->n_key_data;
583         for (i = 0; i < key_data_count; i++) {
584             retval = krb5_dbe_create_key_data(context, db_entry);
585             if (retval) {
586                 cleanup_key_data(context, db_entry->n_key_data,
587                                  db_entry->key_data);
588                 break;
589             }
590             db_entry->key_data[i+n_new_key_data] = key_data[i];
591             memset(&key_data[i], 0, sizeof(krb5_key_data));
592         }
593         krb5_db_free( context, key_data );
594     } else {
595         cleanup_key_data(context, key_data_count, key_data);
596     }
597     return(retval);
598 }
599
600 /*
601  * Add password for a krb5_db_entry
602  * Assumes the max kvno
603  *
604  * As a side effect all old keys older than the max kvno are nuked.
605  */
606 krb5_error_code
607 krb5_dbe_apw(context, master_key, ks_tuple, ks_tuple_count, passwd, db_entry)
608     krb5_context          context;
609     krb5_keyblock       * master_key;
610     krb5_key_salt_tuple * ks_tuple;
611     int                   ks_tuple_count;
612     char                * passwd;
613     krb5_db_entry       * db_entry;
614 {
615     int                   key_data_count;
616     krb5_key_data       * key_data;
617     krb5_error_code       retval;
618     int                   old_kvno, new_kvno;
619     int                   i;
620
621     /* First save the old keydata */
622     old_kvno = krb5_db_get_key_data_kvno(context, db_entry->n_key_data,
623                                          db_entry->key_data);
624     key_data_count = db_entry->n_key_data;
625     key_data = db_entry->key_data;
626     db_entry->key_data = NULL;
627     db_entry->n_key_data = 0;
628
629     /* increment the kvno */
630     new_kvno = old_kvno+1;
631
632     if ((retval = add_key_pwd(context, master_key, ks_tuple, ks_tuple_count,
633                               passwd, db_entry, new_kvno))) {
634         cleanup_key_data(context, db_entry->n_key_data, db_entry->key_data);
635         db_entry->n_key_data = key_data_count;
636         db_entry->key_data = key_data;
637     } else {
638         /* Copy keys with key_data_kvno == old_kvno */
639         for (i = 0; i < key_data_count; i++) {
640             if (key_data[i].key_data_kvno == old_kvno) {
641                 if ((retval = krb5_dbe_create_key_data(context, db_entry))) {
642                     cleanup_key_data(context, db_entry->n_key_data,
643                                      db_entry->key_data);
644                     break;
645                 }
646                 /* We should decrypt/re-encrypt the data to use the same mkvno*/
647                 db_entry->key_data[db_entry->n_key_data - 1] = key_data[i];
648                 memset(&key_data[i], 0, sizeof(krb5_key_data));
649             }
650         }
651         cleanup_key_data(context, key_data_count, key_data);
652     }
653     return(retval);
654 }