2 * Copyright (c) 1997 - 2008 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
6 * Portions Copyright (c) 2009 Apple Inc. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the Institute nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 #include "krb5_locl.h"
43 /*! @mainpage Heimdal database backend library
45 * @section intro Introduction
47 * Heimdal libhdb library provides the backend support for Heimdal kdc
48 * and kadmind. Its here where plugins for diffrent database engines
49 * can be pluged in and extend support for here Heimdal get the
50 * principal and policy data from.
52 * Example of Heimdal backend are:
60 * The project web page: http://www.h5l.org/
64 const int hdb_interface_version = HDB_INTERFACE_VERSION;
66 static struct hdb_method methods[] = {
67 #if HAVE_DB1 || HAVE_DB3
68 { HDB_INTERFACE_VERSION, "db:", hdb_db_create},
71 { HDB_INTERFACE_VERSION, "mit-db:", hdb_mdb_create},
74 { HDB_INTERFACE_VERSION, "ndbm:", hdb_ndbm_create},
76 { HDB_INTERFACE_VERSION, "keytab:", hdb_keytab_create},
77 #if defined(OPENLDAP) && !defined(OPENLDAP_MODULE)
78 { HDB_INTERFACE_VERSION, "ldap:", hdb_ldap_create},
79 { HDB_INTERFACE_VERSION, "ldapi:", hdb_ldapi_create},
82 { HDB_INTERFACE_VERSION, "sqlite:", hdb_sqlite_create},
87 #if HAVE_DB1 || HAVE_DB3
88 static struct hdb_method dbmetod =
89 { HDB_INTERFACE_VERSION, "", hdb_db_create };
90 #elif defined(HAVE_NDBM)
91 static struct hdb_method dbmetod =
92 { HDB_INTERFACE_VERSION, "", hdb_ndbm_create };
97 hdb_next_enctype2key(krb5_context context,
104 for (k = *key ? (*key) + 1 : e->keys.val;
105 k < e->keys.val + e->keys.len;
108 if(k->key.keytype == enctype){
113 krb5_set_error_message(context, KRB5_PROG_ETYPE_NOSUPP,
114 "No next enctype %d for hdb-entry",
116 return KRB5_PROG_ETYPE_NOSUPP; /* XXX */
120 hdb_enctype2key(krb5_context context,
122 krb5_enctype enctype,
126 return hdb_next_enctype2key(context, e, enctype, key);
130 hdb_free_key(Key *key)
132 memset(key->key.keyvalue.data,
134 key->key.keyvalue.length);
141 hdb_lock(int fd, int operation)
145 for(i = 0; i < 3; i++){
146 code = flock(fd, (operation == HDB_RLOCK ? LOCK_SH : LOCK_EX) | LOCK_NB);
147 if(code == 0 || errno != EWOULDBLOCK)
153 if(errno == EWOULDBLOCK)
154 return HDB_ERR_DB_INUSE;
155 return HDB_ERR_CANT_LOCK_DB;
162 code = flock(fd, LOCK_UN);
164 return 4711 /* XXX */;
169 hdb_free_entry(krb5_context context, hdb_entry_ex *ent)
174 (*ent->free_entry)(context, ent);
176 for(i = 0; i < ent->entry.keys.len; ++i) {
177 Key *k = &ent->entry.keys.val[i];
179 memset (k->key.keyvalue.data, 0, k->key.keyvalue.length);
181 free_hdb_entry(&ent->entry);
185 hdb_foreach(krb5_context context,
188 hdb_foreach_func_t func,
193 ret = db->hdb_firstkey(context, db, flags, &entry);
195 krb5_clear_error_message(context);
197 ret = (*func)(context, db, &entry, data);
198 hdb_free_entry(context, &entry);
200 ret = db->hdb_nextkey(context, db, flags, &entry);
202 if(ret == HDB_ERR_NOENTRY)
208 hdb_check_db_format(krb5_context context, HDB *db)
212 krb5_error_code ret, ret2;
216 ret = db->hdb_lock(context, db, HDB_RLOCK);
220 tag.data = (void *)(intptr_t)HDB_DB_FORMAT_ENTRY;
221 tag.length = strlen(tag.data);
222 ret = (*db->hdb__get)(context, db, tag, &version);
223 ret2 = db->hdb_unlock(context, db);
228 foo = sscanf(version.data, "%u", &ver);
229 krb5_data_free (&version);
231 return HDB_ERR_BADVERSION;
232 if(ver != HDB_DB_FORMAT)
233 return HDB_ERR_BADVERSION;
238 hdb_init_db(krb5_context context, HDB *db)
240 krb5_error_code ret, ret2;
245 ret = hdb_check_db_format(context, db);
246 if(ret != HDB_ERR_NOENTRY)
249 ret = db->hdb_lock(context, db, HDB_WLOCK);
253 tag.data = (void *)(intptr_t)HDB_DB_FORMAT_ENTRY;
254 tag.length = strlen(tag.data);
255 snprintf(ver, sizeof(ver), "%u", HDB_DB_FORMAT);
257 version.length = strlen(version.data) + 1; /* zero terminated */
258 ret = (*db->hdb__put)(context, db, 0, tag, version);
259 ret2 = db->hdb_unlock(context, db);
262 krb5_clear_error_message(context);
271 * Load a dynamic backend from /usr/heimdal/lib/hdb_NAME.so,
272 * looking for the hdb_NAME_create symbol.
275 static const struct hdb_method *
276 find_dynamic_method (krb5_context context,
277 const char *filename,
280 static struct hdb_method method;
281 struct hdb_so_method *mso;
282 char *prefix, *path, *symbol;
287 p = strchr(filename, ':');
289 /* if no prefix, don't know what module to load, just ignore it */
294 *rest = filename + len + 1;
296 prefix = malloc(len + 1);
298 krb5_errx(context, 1, "out of memory");
299 strlcpy(prefix, filename, len + 1);
301 if (asprintf(&path, LIBDIR "/hdb_%s.so", prefix) == -1)
302 krb5_errx(context, 1, "out of memory");
308 #define RTLD_GLOBAL 0
311 dl = dlopen(path, RTLD_NOW | RTLD_GLOBAL);
313 krb5_warnx(context, "error trying to load dynamic module %s: %s\n",
320 if (asprintf(&symbol, "hdb_%s_interface", prefix) == -1)
321 krb5_errx(context, 1, "out of memory");
323 mso = (struct hdb_so_method *) dlsym(dl, symbol);
325 krb5_warnx(context, "error finding symbol %s in %s: %s\n",
326 symbol, path, dlerror());
336 if (mso->version != HDB_INTERFACE_VERSION) {
338 "error wrong version in shared module %s "
339 "version: %d should have been %d\n",
340 prefix, mso->version, HDB_INTERFACE_VERSION);
346 if (mso->create == NULL) {
347 krb5_errx(context, 1,
348 "no entry point function in shared mod %s ",
355 method.create = mso->create;
356 method.prefix = prefix;
360 #endif /* HAVE_DLOPEN */
363 * find the relevant method for `filename', returning a pointer to the
365 * return NULL if there's no such method.
368 static const struct hdb_method *
369 find_method (const char *filename, const char **rest)
371 const struct hdb_method *h;
373 for (h = methods; h->prefix != NULL; ++h) {
374 if (strncmp (filename, h->prefix, strlen(h->prefix)) == 0) {
375 *rest = filename + strlen(h->prefix);
379 #if defined(HAVE_DB1) || defined(HAVE_DB3) || defined(HAVE_NDBM)
380 if (strncmp(filename, "/", 1) == 0
381 || strncmp(filename, "./", 2) == 0
382 || strncmp(filename, "../", 3) == 0)
393 hdb_list_builtin(krb5_context context, char **list)
395 const struct hdb_method *h;
399 for (h = methods; h->prefix != NULL; ++h) {
400 if (h->prefix[0] == '\0')
402 len += strlen(h->prefix) + 2;
408 krb5_set_error_message(context, ENOMEM, "malloc: out of memory");
413 for (h = methods; h->prefix != NULL; ++h) {
415 strlcat(buf, ", ", len);
416 strlcat(buf, h->prefix, len);
423 _hdb_keytab2hdb_entry(krb5_context context,
424 const krb5_keytab_entry *ktentry,
427 entry->entry.kvno = ktentry->vno;
428 entry->entry.created_by.time = ktentry->timestamp;
430 entry->entry.keys.val = calloc(1, sizeof(entry->entry.keys.val[0]));
431 if (entry->entry.keys.val == NULL)
433 entry->entry.keys.len = 1;
435 entry->entry.keys.val[0].mkvno = NULL;
436 entry->entry.keys.val[0].salt = NULL;
438 return krb5_copy_keyblock_contents(context,
440 &entry->entry.keys.val[0].key);
444 * Create a handle for a Kerberos database
446 * Create a handle for a Kerberos database backend specified by a
447 * filename. Doesn't create a file if its doesn't exists, you have to
448 * use O_CREAT to tell the backend to create the file.
452 hdb_create(krb5_context context, HDB **db, const char *filename)
454 const struct hdb_method *h;
455 const char *residual;
457 struct krb5_plugin *list = NULL, *e;
460 filename = HDB_DEFAULT_DB;
461 krb5_add_et_list(context, initialize_hdb_error_table_r);
462 h = find_method (filename, &residual);
465 ret = _krb5_plugin_find(context, PLUGIN_TYPE_DATA, "hdb", &list);
466 if(ret == 0 && list != NULL) {
467 for (e = list; e != NULL; e = _krb5_plugin_get_next(e)) {
468 h = _krb5_plugin_get_symbol(e);
469 if (strncmp (filename, h->prefix, strlen(h->prefix)) == 0
470 && h->interface_version == HDB_INTERFACE_VERSION) {
471 residual = filename + strlen(h->prefix);
477 _krb5_plugin_free(list);
484 h = find_dynamic_method (context, filename, &residual);
487 krb5_errx(context, 1, "No database support for %s", filename);
488 return (*h->create)(context, db, residual);