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 20214 2007-02-09 21:51:10Z 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},
58 #ifdef HAVE_LDB /* Used for integrated samba build */
59 {"ldb:", hdb_ldb_create},
64 #if HAVE_DB1 || HAVE_DB3
65 static struct hdb_method dbmetod = {"", hdb_db_create };
66 #elif defined(HAVE_NDBM)
67 static struct hdb_method dbmetod = {"", hdb_ndbm_create };
72 hdb_next_enctype2key(krb5_context context,
79 for (k = *key ? (*key) + 1 : e->keys.val;
80 k < e->keys.val + e->keys.len;
83 if(k->key.keytype == enctype){
88 krb5_set_error_string(context, "No next enctype %d for hdb-entry",
90 return KRB5_PROG_ETYPE_NOSUPP; /* XXX */
94 hdb_enctype2key(krb5_context context,
100 return hdb_next_enctype2key(context, e, enctype, key);
104 hdb_free_key(Key *key)
106 memset(key->key.keyvalue.data,
108 key->key.keyvalue.length);
115 hdb_lock(int fd, int operation)
119 for(i = 0; i < 3; i++){
120 code = flock(fd, (operation == HDB_RLOCK ? LOCK_SH : LOCK_EX) | LOCK_NB);
121 if(code == 0 || errno != EWOULDBLOCK)
127 if(errno == EWOULDBLOCK)
128 return HDB_ERR_DB_INUSE;
129 return HDB_ERR_CANT_LOCK_DB;
136 code = flock(fd, LOCK_UN);
138 return 4711 /* XXX */;
143 hdb_free_entry(krb5_context context, hdb_entry_ex *ent)
148 (*ent->free_entry)(context, ent);
150 for(i = 0; i < ent->entry.keys.len; ++i) {
151 Key *k = &ent->entry.keys.val[i];
153 memset (k->key.keyvalue.data, 0, k->key.keyvalue.length);
155 free_hdb_entry(&ent->entry);
159 hdb_foreach(krb5_context context,
162 hdb_foreach_func_t func,
167 ret = db->hdb_firstkey(context, db, flags, &entry);
169 krb5_clear_error_string(context);
171 ret = (*func)(context, db, &entry, data);
172 hdb_free_entry(context, &entry);
174 ret = db->hdb_nextkey(context, db, flags, &entry);
176 if(ret == HDB_ERR_NOENTRY)
182 hdb_check_db_format(krb5_context context, HDB *db)
186 krb5_error_code ret, ret2;
190 ret = db->hdb_lock(context, db, HDB_RLOCK);
194 tag.data = HDB_DB_FORMAT_ENTRY;
195 tag.length = strlen(tag.data);
196 ret = (*db->hdb__get)(context, db, tag, &version);
197 ret2 = db->hdb_unlock(context, db);
202 foo = sscanf(version.data, "%u", &ver);
203 krb5_data_free (&version);
205 return HDB_ERR_BADVERSION;
206 if(ver != HDB_DB_FORMAT)
207 return HDB_ERR_BADVERSION;
212 hdb_init_db(krb5_context context, HDB *db)
214 krb5_error_code ret, ret2;
219 ret = hdb_check_db_format(context, db);
220 if(ret != HDB_ERR_NOENTRY)
223 ret = db->hdb_lock(context, db, HDB_WLOCK);
227 tag.data = HDB_DB_FORMAT_ENTRY;
228 tag.length = strlen(tag.data);
229 snprintf(ver, sizeof(ver), "%u", HDB_DB_FORMAT);
231 version.length = strlen(version.data) + 1; /* zero terminated */
232 ret = (*db->hdb__put)(context, db, 0, tag, version);
233 ret2 = db->hdb_unlock(context, db);
236 krb5_clear_error_string(context);
245 * Load a dynamic backend from /usr/heimdal/lib/hdb_NAME.so,
246 * looking for the hdb_NAME_create symbol.
249 static const struct hdb_method *
250 find_dynamic_method (krb5_context context,
251 const char *filename,
254 static struct hdb_method method;
255 struct hdb_so_method *mso;
256 char *prefix, *path, *symbol;
261 p = strchr(filename, ':');
263 /* if no prefix, don't know what module to load, just ignore it */
268 *rest = filename + len + 1;
270 prefix = strndup(filename, len);
272 krb5_errx(context, 1, "out of memory");
274 if (asprintf(&path, LIBDIR "/hdb_%s.so", prefix) == -1)
275 krb5_errx(context, 1, "out of memory");
281 #define RTLD_GLOBAL 0
284 dl = dlopen(path, RTLD_NOW | RTLD_GLOBAL);
286 krb5_warnx(context, "error trying to load dynamic module %s: %s\n",
293 if (asprintf(&symbol, "hdb_%s_interface", prefix) == -1)
294 krb5_errx(context, 1, "out of memory");
296 mso = dlsym(dl, symbol);
298 krb5_warnx(context, "error finding symbol %s in %s: %s\n",
299 symbol, path, dlerror());
309 if (mso->version != HDB_INTERFACE_VERSION) {
311 "error wrong version in shared module %s "
312 "version: %d should have been %d\n",
313 prefix, mso->version, HDB_INTERFACE_VERSION);
319 if (mso->create == NULL) {
320 krb5_errx(context, 1,
321 "no entry point function in shared mod %s ",
328 method.create = mso->create;
329 method.prefix = prefix;
333 #endif /* HAVE_DLOPEN */
336 * find the relevant method for `filename', returning a pointer to the
338 * return NULL if there's no such method.
341 static const struct hdb_method *
342 find_method (const char *filename, const char **rest)
344 const struct hdb_method *h;
346 for (h = methods; h->prefix != NULL; ++h) {
347 if (strncmp (filename, h->prefix, strlen(h->prefix)) == 0) {
348 *rest = filename + strlen(h->prefix);
352 #if defined(HAVE_DB1) || defined(HAVE_DB3) || defined(HAVE_NDBM)
353 if (strncmp(filename, "/", 1) == 0
354 || strncmp(filename, "./", 2) == 0
355 || strncmp(filename, "../", 3) == 0)
366 hdb_list_builtin(krb5_context context, char **list)
368 const struct hdb_method *h;
372 for (h = methods; h->prefix != NULL; ++h) {
373 if (h->prefix[0] == '\0')
375 len += strlen(h->prefix) + 2;
381 krb5_set_error_string(context, "malloc: out of memory");
386 for (h = methods; h->prefix != NULL; ++h) {
388 strlcat(buf, ", ", len);
389 strlcat(buf, h->prefix, len);
396 hdb_create(krb5_context context, HDB **db, const char *filename)
398 const struct hdb_method *h;
399 const char *residual;
402 filename = HDB_DEFAULT_DB;
403 krb5_add_et_list(context, initialize_hdb_error_table_r);
404 h = find_method (filename, &residual);
407 h = find_dynamic_method (context, filename, &residual);
410 krb5_errx(context, 1, "No database support for %s", filename);
411 return (*h->create)(context, db, residual);