more comments about how useful krb5_generate_random_block() is
[heimdal.git] / lib / krb5 / keytab_keyfile.c
blobd1af4c19c507b0de2c3ba0b2f702cef3d33fdcea
1 /*
2 * Copyright (c) 1997 - 2007 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
4 * All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
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.
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.
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.
34 #include "krb5_locl.h"
36 #ifndef HEIMDAL_SMALLER
38 /* afs keyfile operations --------------------------------------- */
41 * Minimum tools to handle the AFS KeyFile.
43 * Format of the KeyFile is:
44 * <int32_t numkeys> {[<int32_t kvno> <char[8] deskey>] * numkeys}
46 * It just adds to the end of the keyfile, deleting isn't implemented.
47 * Use your favorite text/hex editor to delete keys.
51 #define AFS_SERVERTHISCELL "/usr/afs/etc/ThisCell"
52 #define AFS_SERVERMAGICKRBCONF "/usr/afs/etc/krb.conf"
54 struct akf_data {
55 uint32_t num_entries;
56 char *filename;
57 char *cell;
58 char *realm;
62 * set `d->cell' and `d->realm'
65 static int
66 get_cell_and_realm (krb5_context context, struct akf_data *d)
68 FILE *f;
69 char buf[BUFSIZ], *cp;
70 int ret;
72 f = fopen (AFS_SERVERTHISCELL, "r");
73 if (f == NULL) {
74 ret = errno;
75 krb5_set_error_message (context, ret,
76 N_("Open ThisCell %s: %s", ""),
77 AFS_SERVERTHISCELL,
78 strerror(ret));
79 return ret;
81 if (fgets (buf, sizeof(buf), f) == NULL) {
82 fclose (f);
83 krb5_set_error_message (context, EINVAL,
84 N_("No cell in ThisCell file %s", ""),
85 AFS_SERVERTHISCELL);
86 return EINVAL;
88 buf[strcspn(buf, "\n")] = '\0';
89 fclose(f);
91 d->cell = strdup (buf);
92 if (d->cell == NULL)
93 return krb5_enomem(context);
95 f = fopen (AFS_SERVERMAGICKRBCONF, "r");
96 if (f != NULL) {
97 if (fgets (buf, sizeof(buf), f) == NULL) {
98 free (d->cell);
99 d->cell = NULL;
100 fclose (f);
101 krb5_set_error_message (context, EINVAL,
102 N_("No realm in ThisCell file %s", ""),
103 AFS_SERVERMAGICKRBCONF);
104 return EINVAL;
106 buf[strcspn(buf, "\n")] = '\0';
107 fclose(f);
109 /* uppercase */
110 for (cp = buf; *cp != '\0'; cp++)
111 *cp = toupper((unsigned char)*cp);
113 d->realm = strdup (buf);
114 if (d->realm == NULL) {
115 free (d->cell);
116 d->cell = NULL;
117 return krb5_enomem(context);
119 return 0;
123 * init and get filename
126 static krb5_error_code KRB5_CALLCONV
127 akf_resolve(krb5_context context, const char *name, krb5_keytab id)
129 int ret;
130 struct akf_data *d = malloc(sizeof (struct akf_data));
132 if (d == NULL)
133 return krb5_enomem(context);
135 d->num_entries = 0;
136 ret = get_cell_and_realm (context, d);
137 if (ret) {
138 free (d);
139 return ret;
141 d->filename = strdup (name);
142 if (d->filename == NULL) {
143 free (d->cell);
144 free (d->realm);
145 free (d);
146 return krb5_enomem(context);
148 id->data = d;
150 return 0;
154 * cleanup
157 static krb5_error_code KRB5_CALLCONV
158 akf_close(krb5_context context, krb5_keytab id)
160 struct akf_data *d = id->data;
162 free (d->filename);
163 free (d->cell);
164 free (d);
165 return 0;
169 * Return filename
172 static krb5_error_code KRB5_CALLCONV
173 akf_get_name(krb5_context context,
174 krb5_keytab id,
175 char *name,
176 size_t name_sz)
178 struct akf_data *d = id->data;
180 strlcpy (name, d->filename, name_sz);
181 return 0;
185 * Init
188 static krb5_error_code KRB5_CALLCONV
189 akf_start_seq_get(krb5_context context,
190 krb5_keytab id,
191 krb5_kt_cursor *c)
193 int32_t ret;
194 struct akf_data *d = id->data;
196 c->fd = open (d->filename, O_RDONLY | O_BINARY | O_CLOEXEC, 0600);
197 if (c->fd < 0) {
198 ret = errno;
199 krb5_set_error_message(context, ret,
200 N_("keytab afs keyfile open %s failed: %s", ""),
201 d->filename, strerror(ret));
202 return ret;
205 c->data = NULL;
206 c->sp = krb5_storage_from_fd(c->fd);
207 if (c->sp == NULL) {
208 close(c->fd);
209 krb5_clear_error_message (context);
210 return KRB5_KT_NOTFOUND;
212 krb5_storage_set_eof_code(c->sp, KRB5_KT_END);
214 ret = krb5_ret_uint32(c->sp, &d->num_entries);
215 if(ret || d->num_entries > INT_MAX / 8) {
216 krb5_storage_free(c->sp);
217 close(c->fd);
218 krb5_clear_error_message (context);
219 if(ret == KRB5_KT_END)
220 return KRB5_KT_NOTFOUND;
221 return ret;
224 return 0;
227 static krb5_error_code KRB5_CALLCONV
228 akf_next_entry(krb5_context context,
229 krb5_keytab id,
230 krb5_keytab_entry *entry,
231 krb5_kt_cursor *cursor)
233 struct akf_data *d = id->data;
234 int32_t kvno;
235 off_t pos;
236 int ret;
238 pos = krb5_storage_seek(cursor->sp, 0, SEEK_CUR);
240 if ((pos - 4) / (4 + 8) >= d->num_entries)
241 return KRB5_KT_END;
243 ret = krb5_make_principal (context, &entry->principal,
244 d->realm, "afs", d->cell, NULL);
245 if (ret)
246 goto out;
248 ret = krb5_ret_int32(cursor->sp, &kvno);
249 if (ret) {
250 krb5_free_principal (context, entry->principal);
251 goto out;
254 entry->vno = kvno;
256 if (cursor->data)
257 entry->keyblock.keytype = ETYPE_DES_CBC_MD5;
258 else
259 entry->keyblock.keytype = ETYPE_DES_CBC_CRC;
260 entry->keyblock.keyvalue.length = 8;
261 entry->keyblock.keyvalue.data = malloc (8);
262 if (entry->keyblock.keyvalue.data == NULL) {
263 krb5_free_principal (context, entry->principal);
264 ret = krb5_enomem(context);
265 goto out;
268 ret = krb5_storage_read(cursor->sp, entry->keyblock.keyvalue.data, 8);
269 if(ret != 8)
270 ret = (ret < 0) ? errno : KRB5_KT_END;
271 else
272 ret = 0;
274 entry->timestamp = time(NULL);
275 entry->flags = 0;
276 entry->aliases = NULL;
278 out:
279 if (cursor->data) {
280 krb5_storage_seek(cursor->sp, pos + 4 + 8, SEEK_SET);
281 cursor->data = NULL;
282 } else
283 cursor->data = cursor;
284 return ret;
287 static krb5_error_code KRB5_CALLCONV
288 akf_end_seq_get(krb5_context context,
289 krb5_keytab id,
290 krb5_kt_cursor *cursor)
292 krb5_storage_free(cursor->sp);
293 close(cursor->fd);
294 cursor->data = NULL;
295 return 0;
298 static krb5_error_code KRB5_CALLCONV
299 akf_add_entry(krb5_context context,
300 krb5_keytab id,
301 krb5_keytab_entry *entry)
303 struct akf_data *d = id->data;
304 int fd, created = 0;
305 krb5_error_code ret;
306 int32_t len;
307 krb5_storage *sp;
310 if (entry->keyblock.keyvalue.length != 8)
311 return 0;
312 switch(entry->keyblock.keytype) {
313 case ETYPE_DES_CBC_CRC:
314 case ETYPE_DES_CBC_MD4:
315 case ETYPE_DES_CBC_MD5:
316 break;
317 default:
318 return 0;
321 fd = open (d->filename, O_RDWR | O_BINARY | O_CLOEXEC);
322 if (fd < 0) {
323 fd = open (d->filename,
324 O_RDWR | O_BINARY | O_CREAT | O_EXCL | O_CLOEXEC, 0600);
325 if (fd < 0) {
326 ret = errno;
327 krb5_set_error_message(context, ret,
328 N_("open keyfile(%s): %s", ""),
329 d->filename,
330 strerror(ret));
331 return ret;
333 created = 1;
336 sp = krb5_storage_from_fd(fd);
337 if(sp == NULL) {
338 close(fd);
339 return krb5_enomem(context);
341 if (created)
342 len = 0;
343 else {
344 if(krb5_storage_seek(sp, 0, SEEK_SET) < 0) {
345 ret = errno;
346 krb5_storage_free(sp);
347 close(fd);
348 krb5_set_error_message(context, ret,
349 N_("seeking in keyfile: %s", ""),
350 strerror(ret));
351 return ret;
354 ret = krb5_ret_int32(sp, &len);
355 if(ret) {
356 krb5_storage_free(sp);
357 close(fd);
358 return ret;
363 * Make sure we don't add the entry twice, assumes the DES
364 * encryption types are all the same key.
366 if (len > 0) {
367 int32_t kvno;
368 int i;
370 for (i = 0; i < len; i++) {
371 ret = krb5_ret_int32(sp, &kvno);
372 if (ret) {
373 krb5_set_error_message (context, ret,
374 N_("Failed getting kvno from keyfile", ""));
375 goto out;
377 if(krb5_storage_seek(sp, 8, SEEK_CUR) < 0) {
378 ret = errno;
379 krb5_set_error_message (context, ret,
380 N_("Failed seeing in keyfile: %s", ""),
381 strerror(ret));
382 goto out;
384 if (kvno == entry->vno) {
385 ret = 0;
386 goto out;
391 len++;
393 if(krb5_storage_seek(sp, 0, SEEK_SET) < 0) {
394 ret = errno;
395 krb5_set_error_message (context, ret,
396 N_("Failed seeing in keyfile: %s", ""),
397 strerror(ret));
398 goto out;
401 ret = krb5_store_int32(sp, len);
402 if(ret) {
403 ret = errno;
404 krb5_set_error_message (context, ret,
405 N_("keytab keyfile failed new length", ""));
406 return ret;
409 if(krb5_storage_seek(sp, (len - 1) * (8 + 4), SEEK_CUR) < 0) {
410 ret = errno;
411 krb5_set_error_message (context, ret,
412 N_("seek to end: %s", ""), strerror(ret));
413 goto out;
416 ret = krb5_store_int32(sp, entry->vno);
417 if(ret) {
418 krb5_set_error_message(context, ret,
419 N_("keytab keyfile failed store kvno", ""));
420 goto out;
422 ret = krb5_storage_write(sp, entry->keyblock.keyvalue.data,
423 entry->keyblock.keyvalue.length);
424 if(ret != entry->keyblock.keyvalue.length) {
425 if (ret < 0)
426 ret = errno;
427 else
428 ret = ENOTTY;
429 krb5_set_error_message(context, ret,
430 N_("keytab keyfile failed to add key", ""));
431 goto out;
433 ret = 0;
434 out:
435 krb5_storage_free(sp);
436 close (fd);
437 return ret;
440 const krb5_kt_ops krb5_akf_ops = {
441 "AFSKEYFILE",
442 akf_resolve,
443 akf_get_name,
444 akf_close,
445 NULL, /* destroy */
446 NULL, /* get */
447 akf_start_seq_get,
448 akf_next_entry,
449 akf_end_seq_get,
450 akf_add_entry,
451 NULL, /* remove */
452 NULL,
456 #endif /* HEIMDAL_SMALLER */