update documentation
[metze/heimdal/wip.git] / kdc / mit_dump.c
1 /*
2  * Copyright (c) 2000 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 "hprop.h"
35
36 RCSID("$Id$");
37
38 /*
39 can have any number of princ stanzas.
40 format is as follows (only \n indicates newlines)
41 princ\t%d\t (%d is KRB5_KDB_V1_BASE_LENGTH, always 38)
42 %d\t (strlen of principal e.g. shadow/foo@ANDREW.CMU.EDU)
43 %d\t (number of tl_data)
44 %d\t (number of key data, e.g. how many keys for this user)
45 %d\t (extra data length)
46 %s\t (principal name)
47 %d\t (attributes)
48 %d\t (max lifetime, seconds)
49 %d\t (max renewable life, seconds)
50 %d\t (expiration, seconds since epoch or 2145830400 for never)
51 %d\t (password expiration, seconds, 0 for never)
52 %d\t (last successful auth, seconds since epoch)
53 %d\t (last failed auth, per above)
54 %d\t (failed auth count)
55 foreach tl_data 0 to number of tl_data - 1 as above
56   %d\t%d\t (data type, data length)
57   foreach tl_data 0 to length-1
58     %02x (tl data contents[element n])
59   except if tl_data length is 0
60     %d (always -1)
61   \t
62 foreach key 0 to number of keys - 1 as above
63   %d\t%d\t (key data version, kvno)
64   foreach version 0 to key data version - 1 (a key or a salt)
65     %d\t%d\t(data type for this key, data length for this key)
66     foreach key data length 0 to length-1
67       %02x (key data contents[element n])
68     except if key_data length is 0
69       %d (always -1)
70     \t
71 foreach extra data length 0 to length - 1
72   %02x (extra data part)
73 unless no extra data
74   %d (always -1)
75 ;\n
76
77 */
78
79 static int
80 hex_to_octet_string(const char *ptr, krb5_data *data)
81 {
82     int i;
83     unsigned int v;
84     for(i = 0; i < data->length; i++) {
85         if(sscanf(ptr + 2 * i, "%02x", &v) != 1)
86             return -1;
87         ((unsigned char*)data->data)[i] = v;
88     }
89     return 2 * i;
90 }
91
92 static char *
93 nexttoken(char **p)
94 {
95     char *q;
96     do {
97         q = strsep(p, " \t");
98     } while(q && *q == '\0');
99     return q;
100 }
101
102 static size_t
103 getdata(char **p, unsigned char *buf, size_t len)
104 {
105     size_t i;
106     int v;
107     char *q = nexttoken(p);
108     i = 0;
109     while(*q && i < len) {
110         if(sscanf(q, "%02x", &v) != 1)
111             break;
112         buf[i++] = v;
113         q += 2;
114     }
115     return i;
116 }
117
118 static int
119 getint(char **p)
120 {
121     int val;
122     char *q = nexttoken(p);
123     sscanf(q, "%d", &val);
124     return val;
125 }
126
127 #include <kadm5/admin.h>
128
129 static void
130 attr_to_flags(unsigned attr, HDBFlags *flags)
131 {
132     flags->postdate =           !(attr & KRB5_KDB_DISALLOW_POSTDATED);
133     flags->forwardable =        !(attr & KRB5_KDB_DISALLOW_FORWARDABLE);
134     flags->initial =           !!(attr & KRB5_KDB_DISALLOW_TGT_BASED);
135     flags->renewable =          !(attr & KRB5_KDB_DISALLOW_RENEWABLE);
136     flags->proxiable =          !(attr & KRB5_KDB_DISALLOW_PROXIABLE);
137     /* DUP_SKEY */
138     flags->invalid =           !!(attr & KRB5_KDB_DISALLOW_ALL_TIX);
139     flags->require_preauth =   !!(attr & KRB5_KDB_REQUIRES_PRE_AUTH);
140     /* HW_AUTH */
141     flags->server =             !(attr & KRB5_KDB_DISALLOW_SVR);
142     flags->change_pw =         !!(attr & KRB5_KDB_PWCHANGE_SERVICE);
143     flags->client =             1; /* XXX */
144 }
145
146 #define KRB5_KDB_SALTTYPE_NORMAL        0
147 #define KRB5_KDB_SALTTYPE_V4            1
148 #define KRB5_KDB_SALTTYPE_NOREALM       2
149 #define KRB5_KDB_SALTTYPE_ONLYREALM     3
150 #define KRB5_KDB_SALTTYPE_SPECIAL       4
151 #define KRB5_KDB_SALTTYPE_AFS3          5
152
153 static krb5_error_code
154 fix_salt(krb5_context context, hdb_entry *ent, int key_num)
155 {
156     krb5_error_code ret;
157     Salt *salt = ent->keys.val[key_num].salt;
158     /* fix salt type */
159     switch((int)salt->type) {
160     case KRB5_KDB_SALTTYPE_NORMAL:
161         salt->type = KRB5_PADATA_PW_SALT;
162         break;
163     case KRB5_KDB_SALTTYPE_V4:
164         krb5_data_free(&salt->salt);
165         salt->type = KRB5_PADATA_PW_SALT;
166         break;
167     case KRB5_KDB_SALTTYPE_NOREALM:
168     {
169         size_t len;
170         int i;
171         char *p;
172         
173         len = 0;
174         for (i = 0; i < ent->principal->name.name_string.len; ++i)
175             len += strlen(ent->principal->name.name_string.val[i]);
176         ret = krb5_data_alloc (&salt->salt, len);
177         if (ret)
178             return ret;
179         p = salt->salt.data;
180         for (i = 0; i < ent->principal->name.name_string.len; ++i) {
181             memcpy (p,
182                     ent->principal->name.name_string.val[i],
183                     strlen(ent->principal->name.name_string.val[i]));
184             p += strlen(ent->principal->name.name_string.val[i]);
185         }
186
187         salt->type = KRB5_PADATA_PW_SALT;
188         break;
189     }
190     case KRB5_KDB_SALTTYPE_ONLYREALM:
191         krb5_data_free(&salt->salt);
192         ret = krb5_data_copy(&salt->salt,
193                              ent->principal->realm,
194                              strlen(ent->principal->realm));
195         if(ret)
196             return ret;
197         salt->type = KRB5_PADATA_PW_SALT;
198         break;
199     case KRB5_KDB_SALTTYPE_SPECIAL:
200         salt->type = KRB5_PADATA_PW_SALT;
201         break;
202     case KRB5_KDB_SALTTYPE_AFS3:
203         krb5_data_free(&salt->salt);
204         ret = krb5_data_copy(&salt->salt,
205                        ent->principal->realm,
206                        strlen(ent->principal->realm));
207         if(ret)
208             return ret;
209         salt->type = KRB5_PADATA_AFS3_SALT;
210         break;
211     default:
212         abort();
213     }
214     return 0;
215 }
216
217 int
218 mit_prop_dump(void *arg, const char *file)
219 {
220     krb5_error_code ret;
221     char line [2048];
222     FILE *f;
223     int lineno = 0;
224     struct hdb_entry_ex ent;
225
226     struct prop_data *pd = arg;
227
228     f = fopen(file, "r");
229     if(f == NULL)
230         return errno;
231
232     while(fgets(line, sizeof(line), f)) {
233         char *p = line, *q;
234
235         int i;
236
237         int num_tl_data;
238         int num_key_data;
239         int attributes;
240
241         int tmp;
242
243         lineno++;
244
245         memset(&ent, 0, sizeof(ent));
246
247         q = nexttoken(&p);
248         if(strcmp(q, "kdb5_util") == 0) {
249             int major;
250             q = nexttoken(&p); /* load_dump */
251             if(strcmp(q, "load_dump"))
252                 errx(1, "line %d: unknown version", lineno);
253             q = nexttoken(&p); /* load_dump */
254             if(strcmp(q, "version"))
255                 errx(1, "line %d: unknown version", lineno);
256             q = nexttoken(&p); /* x.0 */
257             if(sscanf(q, "%d", &major) != 1)
258                 errx(1, "line %d: unknown version", lineno);
259             if(major != 4)
260                 errx(1, "unknown dump file format, got %d, expected 4", major);
261             continue;
262         } else if(strcmp(q, "princ") != 0) {
263             warnx("line %d: not a principal", lineno);
264             continue;
265         }
266         tmp = getint(&p);
267         if(tmp != 38) {
268             warnx("line %d: bad base length %d != 38", lineno, tmp);
269             continue;
270         }
271         nexttoken(&p); /* length of principal */
272         num_tl_data = getint(&p); /* number of tl-data */
273         num_key_data = getint(&p); /* number of key-data */
274         getint(&p);  /* length of extra data */
275         q = nexttoken(&p); /* principal name */
276         krb5_parse_name(pd->context, q, &ent.entry.principal);
277         attributes = getint(&p); /* attributes */
278         attr_to_flags(attributes, &ent.entry.flags);
279         tmp = getint(&p); /* max life */
280         if(tmp != 0) {
281             ALLOC(ent.entry.max_life);
282             *ent.entry.max_life = tmp;
283         }
284         tmp = getint(&p); /* max renewable life */
285         if(tmp != 0) {
286             ALLOC(ent.entry.max_renew);
287             *ent.entry.max_renew = tmp;
288         }
289         tmp = getint(&p); /* expiration */
290         if(tmp != 0 && tmp != 2145830400) {
291             ALLOC(ent.entry.valid_end);
292             *ent.entry.valid_end = tmp;
293         }
294         tmp = getint(&p); /* pw expiration */
295         if(tmp != 0) {
296             ALLOC(ent.entry.pw_end);
297             *ent.entry.pw_end = tmp;
298         }
299         nexttoken(&p); /* last auth */
300         nexttoken(&p); /* last failed auth */
301         nexttoken(&p); /* fail auth count */
302         for(i = 0; i < num_tl_data; i++) {
303             unsigned long val;
304             int tl_type, tl_length;
305             unsigned char *buf;
306             krb5_principal princ;
307
308             tl_type = getint(&p); /* data type */
309             tl_length = getint(&p); /* data length */
310
311 #define mit_KRB5_TL_LAST_PWD_CHANGE     1
312 #define mit_KRB5_TL_MOD_PRINC           2
313             switch(tl_type) {
314             case mit_KRB5_TL_MOD_PRINC:
315                 buf = malloc(tl_length);
316                 if (buf == NULL)
317                     errx(ENOMEM, "malloc");
318                 getdata(&p, buf, tl_length); /* data itself */
319                 val = buf[0] | (buf[1] << 8) | (buf[2] << 16) | (buf[3] << 24);
320                 ret = krb5_parse_name(pd->context, (char *)buf + 4, &princ);
321                 if (ret)
322                     krb5_err(pd->context, 1, ret,
323                              "parse_name: %s", (char *)buf + 4);
324                 free(buf);
325                 ALLOC(ent.entry.modified_by);
326                 ent.entry.modified_by->time = val;
327                 ent.entry.modified_by->principal = princ;
328                 break;
329             default:
330                 nexttoken(&p);
331                 break;
332             }
333         }
334         ALLOC_SEQ(&ent.entry.keys, num_key_data);
335         for(i = 0; i < num_key_data; i++) {
336             int key_versions;
337             key_versions = getint(&p); /* key data version */
338             ent.entry.kvno = getint(&p); /* XXX kvno */
339         
340             ALLOC(ent.entry.keys.val[i].mkvno);
341             *ent.entry.keys.val[i].mkvno = 0;
342         
343             /* key version 0 -- actual key */
344             ent.entry.keys.val[i].key.keytype = getint(&p); /* key type */
345             tmp = getint(&p); /* key length */
346             /* the first two bytes of the key is the key length --
347                skip it */
348             krb5_data_alloc(&ent.entry.keys.val[i].key.keyvalue, tmp - 2);
349             q = nexttoken(&p); /* key itself */
350             hex_to_octet_string(q + 4, &ent.entry.keys.val[i].key.keyvalue);
351
352             if(key_versions > 1) {
353                 /* key version 1 -- optional salt */
354                 ALLOC(ent.entry.keys.val[i].salt);
355                 ent.entry.keys.val[i].salt->type = getint(&p); /* salt type */
356                 tmp = getint(&p); /* salt length */
357                 if(tmp > 0) {
358                     krb5_data_alloc(&ent.entry.keys.val[i].salt->salt, tmp - 2);
359                     q = nexttoken(&p); /* salt itself */
360                     hex_to_octet_string(q + 4,
361                                         &ent.entry.keys.val[i].salt->salt);
362                 } else {
363                     ent.entry.keys.val[i].salt->salt.length = 0;
364                     ent.entry.keys.val[i].salt->salt.data = NULL;
365                     getint(&p); /* -1, if no data. */
366                 }
367                 fix_salt(pd->context, &ent.entry, i);
368             }
369         }
370         nexttoken(&p); /* extra data */
371         v5_prop(pd->context, NULL, &ent, arg);
372     }
373     fclose(f);
374     return 0;
375 }