2 * Copyright (c) 1997 - 2007 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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
36 RCSID("$Id: hdb.c 23316 2008-06-23 04:32:32Z lha $");
44 krb5_error_code (*create)(krb5_context, HDB **, const char *filename);
47 static struct hdb_method methods[] = {
48 #if HAVE_DB1 || HAVE_DB3
49 {"db:", hdb_db_create},
52 {"ndbm:", hdb_ndbm_create},
54 #if defined(OPENLDAP) && !defined(OPENLDAP_MODULE)
55 {"ldap:", hdb_ldap_create},
56 {"ldapi:", hdb_ldapi_create},
59 {"ldb:", hdb_ldb_create},
61 #ifdef HAVE_LDB /* Used for integrated samba build */
62 {"ldb:", hdb_ldb_create},
67 #if HAVE_DB1 || HAVE_DB3
68 static struct hdb_method dbmetod = {"", hdb_db_create };
69 #elif defined(HAVE_NDBM)
70 static struct hdb_method dbmetod = {"", hdb_ndbm_create };
75 hdb_next_enctype2key(krb5_context context,
82 for (k = *key ? (*key) + 1 : e->keys.val;
83 k < e->keys.val + e->keys.len;
86 if(k->key.keytype == enctype){
91 krb5_set_error_message(context, KRB5_PROG_ETYPE_NOSUPP,
92 "No next enctype %d for hdb-entry",
94 return KRB5_PROG_ETYPE_NOSUPP; /* XXX */
98 hdb_enctype2key(krb5_context context,
100 krb5_enctype enctype,
104 return hdb_next_enctype2key(context, e, enctype, key);
108 hdb_free_key(Key *key)
110 memset(key->key.keyvalue.data,
112 key->key.keyvalue.length);
119 hdb_lock(int fd, int operation)
123 for(i = 0; i < 3; i++){
124 code = flock(fd, (operation == HDB_RLOCK ? LOCK_SH : LOCK_EX) | LOCK_NB);
125 if(code == 0 || errno != EWOULDBLOCK)
131 if(errno == EWOULDBLOCK)
132 return HDB_ERR_DB_INUSE;
133 return HDB_ERR_CANT_LOCK_DB;
140 code = flock(fd, LOCK_UN);
142 return 4711 /* XXX */;
147 hdb_free_entry(krb5_context context, hdb_entry_ex *ent)
152 (*ent->free_entry)(context, ent);
154 for(i = 0; i < ent->entry.keys.len; ++i) {
155 Key *k = &ent->entry.keys.val[i];
157 memset (k->key.keyvalue.data, 0, k->key.keyvalue.length);
159 free_hdb_entry(&ent->entry);
163 hdb_foreach(krb5_context context,
166 hdb_foreach_func_t func,
171 ret = db->hdb_firstkey(context, db, flags, &entry);
173 krb5_clear_error_string(context);
175 ret = (*func)(context, db, &entry, data);
176 hdb_free_entry(context, &entry);
178 ret = db->hdb_nextkey(context, db, flags, &entry);
180 if(ret == HDB_ERR_NOENTRY)
186 hdb_check_db_format(krb5_context context, HDB *db)
190 krb5_error_code ret, ret2;
194 ret = db->hdb_lock(context, db, HDB_RLOCK);
198 tag.data = HDB_DB_FORMAT_ENTRY;
199 tag.length = strlen(tag.data);
200 ret = (*db->hdb__get)(context, db, tag, &version);
201 ret2 = db->hdb_unlock(context, db);
206 foo = sscanf(version.data, "%u", &ver);
207 krb5_data_free (&version);
209 return HDB_ERR_BADVERSION;
210 if(ver != HDB_DB_FORMAT)
211 return HDB_ERR_BADVERSION;
216 hdb_init_db(krb5_context context, HDB *db)
218 krb5_error_code ret, ret2;
223 ret = hdb_check_db_format(context, db);
224 if(ret != HDB_ERR_NOENTRY)
227 ret = db->hdb_lock(context, db, HDB_WLOCK);
231 tag.data = HDB_DB_FORMAT_ENTRY;
232 tag.length = strlen(tag.data);
233 snprintf(ver, sizeof(ver), "%u", HDB_DB_FORMAT);
235 version.length = strlen(version.data) + 1; /* zero terminated */
236 ret = (*db->hdb__put)(context, db, 0, tag, version);
237 ret2 = db->hdb_unlock(context, db);
240 krb5_clear_error_string(context);
249 * Load a dynamic backend from /usr/heimdal/lib/hdb_NAME.so,
250 * looking for the hdb_NAME_create symbol.
253 static const struct hdb_method *
254 find_dynamic_method (krb5_context context,
255 const char *filename,
258 static struct hdb_method method;
259 struct hdb_so_method *mso;
260 char *prefix, *path, *symbol;
265 p = strchr(filename, ':');
267 /* if no prefix, don't know what module to load, just ignore it */
272 *rest = filename + len + 1;
274 prefix = strndup(filename, len);
276 krb5_errx(context, 1, "out of memory");
278 if (asprintf(&path, LIBDIR "/hdb_%s.so", prefix) == -1)
279 krb5_errx(context, 1, "out of memory");
285 #define RTLD_GLOBAL 0
288 dl = dlopen(path, RTLD_NOW | RTLD_GLOBAL);
290 krb5_warnx(context, "error trying to load dynamic module %s: %s\n",
297 if (asprintf(&symbol, "hdb_%s_interface", prefix) == -1)
298 krb5_errx(context, 1, "out of memory");
300 mso = dlsym(dl, symbol);
302 krb5_warnx(context, "error finding symbol %s in %s: %s\n",
303 symbol, path, dlerror());
313 if (mso->version != HDB_INTERFACE_VERSION) {
315 "error wrong version in shared module %s "
316 "version: %d should have been %d\n",
317 prefix, mso->version, HDB_INTERFACE_VERSION);
323 if (mso->create == NULL) {
324 krb5_errx(context, 1,
325 "no entry point function in shared mod %s ",
332 method.create = mso->create;
333 method.prefix = prefix;
337 #endif /* HAVE_DLOPEN */
340 * find the relevant method for `filename', returning a pointer to the
342 * return NULL if there's no such method.
345 static const struct hdb_method *
346 find_method (const char *filename, const char **rest)
348 const struct hdb_method *h;
350 for (h = methods; h->prefix != NULL; ++h) {
351 if (strncmp (filename, h->prefix, strlen(h->prefix)) == 0) {
352 *rest = filename + strlen(h->prefix);
356 #if defined(HAVE_DB1) || defined(HAVE_DB3) || defined(HAVE_NDBM)
357 if (strncmp(filename, "/", 1) == 0
358 || strncmp(filename, "./", 2) == 0
359 || strncmp(filename, "../", 3) == 0)
370 hdb_list_builtin(krb5_context context, char **list)
372 const struct hdb_method *h;
376 for (h = methods; h->prefix != NULL; ++h) {
377 if (h->prefix[0] == '\0')
379 len += strlen(h->prefix) + 2;
385 krb5_set_error_message(context, ENOMEM, "malloc: out of memory");
390 for (h = methods; h->prefix != NULL; ++h) {
392 strlcat(buf, ", ", len);
393 strlcat(buf, h->prefix, len);
400 hdb_create(krb5_context context, HDB **db, const char *filename)
402 const struct hdb_method *h;
403 const char *residual;
406 filename = HDB_DEFAULT_DB;
407 krb5_add_et_list(context, initialize_hdb_error_table_r);
408 h = find_method (filename, &residual);
411 h = find_dynamic_method (context, filename, &residual);
414 krb5_errx(context, 1, "No database support for %s", filename);
415 return (*h->create)(context, db, residual);