source3/lib/ldb/common/ldb_modules.c

   1
   2 /*
   3    ldb database library
   4
   5    Copyright (C) Simo Sorce  2004
   6
   7      ** NOTE! The following LGPL license applies to the ldb
   8      ** library. This does NOT imply that all of Samba is released
   9      ** under the LGPL
  10
  11    This library is free software; you can redistribute it and/or
  12    modify it under the terms of the GNU Lesser General Public
  13    License as published by the Free Software Foundation; either
  14    version 3 of the License, or (at your option) any later version.
  15
  16    This library is distributed in the hope that it will be useful,
  17    but WITHOUT ANY WARRANTY; without even the implied warranty of
  18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19    Lesser General Public License for more details.
  20
  21    You should have received a copy of the GNU Lesser General Public
  22    License along with this library; if not, see <http://www.gnu.org/licenses/>.
  23 */
  24
  25 /*
  26  *  Name: ldb
  27  *
  28  *  Component: ldb modules core
  29  *
  30  *  Description: core modules routines
  31  *
  32  *  Author: Simo Sorce
  33  */
  34
  35 #include "includes.h"
  36 #include "ldb/include/includes.h"
  37
  38 #if (_SAMBA_BUILD_ >= 4)
  39 #include "build.h"
  40 #include "dynconfig.h"
  41 #endif
  42
  43 #define LDB_MODULE_PREFIX       "modules:"
  44 #define LDB_MODULE_PREFIX_LEN   8
  45
  46 static char *ldb_modules_strdup_no_spaces(TALLOC_CTX *mem_ctx, const char *string)
  47 {
  48         int i, len;
  49         char *trimmed;
  50
  51         trimmed = talloc_strdup(mem_ctx, string);
  52         if (!trimmed) {
  53                 return NULL;
  54         }
  55
  56         len = strlen(trimmed);
  57         for (i = 0; trimmed[i] != '\0'; i++) {
  58                 switch (trimmed[i]) {
  59                 case ' ':
  60                 case '\t':
  61                 case '\n':
  62                         memmove(&trimmed[i], &trimmed[i + 1], len -i -1);
  63                         break;
  64                 }
  65         }
  66
  67         return trimmed;
  68 }
  69
  70
  71 /* modules are called in inverse order on the stack.
  72    Lets place them as an admin would think the right order is.
  73    Modules order is important */
  74 const char **ldb_modules_list_from_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *string)
  75 {
  76         char **modules = NULL;
  77         const char **m;
  78         char *modstr, *p;
  79         int i;
  80
  81         /* spaces not admitted */
  82         modstr = ldb_modules_strdup_no_spaces(mem_ctx, string);
  83         if ( ! modstr) {
  84                 ldb_debug(ldb, LDB_DEBUG_FATAL, "Out of Memory in ldb_modules_strdup_no_spaces()\n");
  85                 return NULL;
  86         }
  87
  88         modules = talloc_realloc(mem_ctx, modules, char *, 2);
  89         if ( ! modules ) {
  90                 ldb_debug(ldb, LDB_DEBUG_FATAL, "Out of Memory in ldb_modules_list_from_string()\n");
  91                 talloc_free(modstr);
  92                 return NULL;
  93         }
  94         talloc_steal(modules, modstr);
  95
  96         i = 0;
  97         /* The str*r*chr walks backwards:  This is how we get the inverse order mentioned above */
  98         while ((p = strrchr(modstr, ',')) != NULL) {
  99                 *p = '\0';
 100                 p++;
 101                 modules[i] = p;
 102
 103                 i++;
 104                 modules = talloc_realloc(mem_ctx, modules, char *, i + 2);
 105                 if ( ! modules ) {
 106                         ldb_debug(ldb, LDB_DEBUG_FATAL, "Out of Memory in ldb_modules_list_from_string()\n");
 107                         return NULL;
 108                 }
 109
 110         }
 111         modules[i] = modstr;
 112
 113         modules[i + 1] = NULL;
 114
 115         m = (const char **)modules;
 116
 117         return m;
 118 }
 119
 120 static struct ops_list_entry {
 121         const struct ldb_module_ops *ops;
 122         struct ops_list_entry *next;
 123 } *registered_modules = NULL;
 124
 125 static const struct ldb_module_ops *ldb_find_module_ops(const char *name)
 126 {
 127         struct ops_list_entry *e;
 128
 129         for (e = registered_modules; e; e = e->next) {
 130                 if (strcmp(e->ops->name, name) == 0)
 131                         return e->ops;
 132         }
 133
 134         return NULL;
 135 }
 136
 137 #ifndef STATIC_ldb_MODULES
 138
 139 #ifdef HAVE_LDB_LDAP
 140 #define LDAP_INIT ldb_ldap_init,
 141 #else
 142 #define LDAP_INIT
 143 #endif
 144
 145 #ifdef HAVE_LDB_SQLITE3
 146 #define SQLITE3_INIT ldb_sqlite3_init,
 147 #else
 148 #define SQLITE3_INIT
 149 #endif
 150
 151 #define STATIC_ldb_MODULES \
 152         {       \
 153                 LDAP_INIT \
 154                 SQLITE3_INIT \
 155                 ldb_tdb_init,   \
 156                 ldb_operational_init,   \
 157                 ldb_rdn_name_init,      \
 158                 ldb_objectclass_init,   \
 159                 ldb_paged_results_init, \
 160                 ldb_sort_init,          \
 161                 ldb_asq_init,           \
 162                 NULL                    \
 163         }
 164 #endif
 165
 166 int ldb_global_init(void)
 167 {
 168         static int (*static_init_fns[])(void) = STATIC_ldb_MODULES;
 169
 170         static int initialized = 0;
 171         int ret = 0, i;
 172
 173         if (initialized)
 174                 return 0;
 175
 176         initialized = 1;
 177
 178         for (i = 0; static_init_fns[i]; i++) {
 179                 if (static_init_fns[i]() == -1)
 180                         ret = -1;
 181         }
 182
 183         return ret;
 184 }
 185
 186 int ldb_register_module(const struct ldb_module_ops *ops)
 187 {
 188         struct ops_list_entry *entry = talloc(talloc_autofree_context(), struct ops_list_entry);
 189
 190         if (ldb_find_module_ops(ops->name) != NULL)
 191                 return -1;
 192
 193         if (entry == NULL)
 194                 return -1;
 195
 196         entry->ops = ops;
 197         entry->next = registered_modules;
 198         registered_modules = entry;
 199
 200         return 0;
 201 }
 202
 203 int ldb_try_load_dso(struct ldb_context *ldb, const char *name)
 204 {
 205         char *path;
 206         void *handle;
 207         int (*init_fn) (void);
 208         char *modulesdir;
 209
 210 #ifdef HAVE_DLOPEN
 211         if (getenv("LD_LDB_MODULE_PATH") != NULL) {
 212                 modulesdir = talloc_strdup(ldb, getenv("LD_LDB_MODULE_PATH"));
 213         } else {
 214 #ifdef _SAMBA_BUILD_
 215                 modulesdir = talloc_asprintf(ldb, "%s/ldb", dyn_MODULESDIR);
 216 #else
 217                 modulesdir = talloc_strdup(ldb, MODULESDIR);
 218 #endif
 219         }
 220
 221         path = talloc_asprintf(ldb, "%s/%s.%s", modulesdir, name, SHLIBEXT);
 222
 223         talloc_free(modulesdir);
 224
 225         ldb_debug(ldb, LDB_DEBUG_TRACE, "trying to load %s from %s\n", name, path);
 226
 227         handle = dlopen(path, RTLD_NOW);
 228         if (handle == NULL) {
 229                 ldb_debug(ldb, LDB_DEBUG_WARNING, "unable to load %s from %s: %s\n", name, path, dlerror());
 230                 return -1;
 231         }
 232
 233         init_fn = (int (*)(void))dlsym(handle, "init_module");
 234
 235         if (init_fn == NULL) {
 236                 ldb_debug(ldb, LDB_DEBUG_ERROR, "no symbol `init_module' found in %s: %s\n", path, dlerror());
 237                 return -1;
 238         }
 239
 240         talloc_free(path);
 241
 242         return init_fn();
 243 #else
 244         ldb_debug(ldb, LDB_DEBUG_TRACE, "no dlopen() - not trying to load %s module\n", name);
 245         return -1;
 246 #endif
 247 }
 248
 249 int ldb_load_modules_list(struct ldb_context *ldb, const char **module_list, struct ldb_module *backend, struct ldb_module **out)
 250 {
 251         struct ldb_module *module;
 252         int i;
 253
 254         module = backend;
 255
 256         for (i = 0; module_list[i] != NULL; i++) {
 257                 struct ldb_module *current;
 258                 const struct ldb_module_ops *ops;
 259
 260                 ops = ldb_find_module_ops(module_list[i]);
 261                 if (ops == NULL) {
 262                         if (ldb_try_load_dso(ldb, module_list[i]) == 0) {
 263                                 ops = ldb_find_module_ops(module_list[i]);
 264                         }
 265                 }
 266
 267                 if (ops == NULL) {
 268                         ldb_debug(ldb, LDB_DEBUG_WARNING, "WARNING: Module [%s] not found\n",
 269                                   module_list[i]);
 270                         continue;
 271                 }
 272
 273                 current = talloc_zero(ldb, struct ldb_module);
 274                 if (current == NULL) {
 275                         return LDB_ERR_OPERATIONS_ERROR;
 276                 }
 277                 talloc_set_name(current, "ldb_module: %s", module_list[i]);
 278
 279                 current->ldb = ldb;
 280                 current->ops = ops;
 281
 282                 DLIST_ADD(module, current);
 283         }
 284         *out = module;
 285         return LDB_SUCCESS;
 286 }
 287
 288 int ldb_init_module_chain(struct ldb_context *ldb, struct ldb_module *module)
 289 {
 290         while (module && module->ops->init_context == NULL)
 291                 module = module->next;
 292
 293         if (module && module->ops->init_context &&
 294                 module->ops->init_context(module) != LDB_SUCCESS) {
 295                 ldb_debug(ldb, LDB_DEBUG_FATAL, "module initialization failed\n");
 296                 return LDB_ERR_OPERATIONS_ERROR;
 297         }
 298
 299         return LDB_SUCCESS;
 300 }
 301
 302 int ldb_load_modules(struct ldb_context *ldb, const char *options[])
 303 {
 304         const char **modules = NULL;
 305         int i;
 306         int ret;
 307         TALLOC_CTX *mem_ctx = talloc_new(ldb);
 308         if (!mem_ctx) {
 309                 return LDB_ERR_OPERATIONS_ERROR;
 310         }
 311
 312         /* find out which modules we are requested to activate */
 313
 314         /* check if we have a custom module list passd as ldb option */
 315         if (options) {
 316                 for (i = 0; options[i] != NULL; i++) {
 317                         if (strncmp(options[i], LDB_MODULE_PREFIX, LDB_MODULE_PREFIX_LEN) == 0) {
 318                                 modules = ldb_modules_list_from_string(ldb, mem_ctx, &options[i][LDB_MODULE_PREFIX_LEN]);
 319                         }
 320                 }
 321         }
 322
 323         /* if not overloaded by options and the backend is not ldap try to load the modules list from ldb */
 324         if ((modules == NULL) && (strcmp("ldap", ldb->modules->ops->name) != 0)) {
 325                 const char * const attrs[] = { "@LIST" , NULL};
 326                 struct ldb_result *res = NULL;
 327                 struct ldb_dn *mods_dn;
 328
 329                 mods_dn = ldb_dn_explode(mem_ctx, "@MODULES");
 330                 if (mods_dn == NULL) {
 331                         talloc_free(mem_ctx);
 332                         return -1;
 333                 }
 334
 335                 ret = ldb_search(ldb, mods_dn, LDB_SCOPE_BASE, "", attrs, &res);
 336                 talloc_steal(mods_dn, res);
 337                 if (ret == LDB_SUCCESS && (res->count == 0 || res->msgs[0]->num_elements == 0)) {
 338                         ldb_debug(ldb, LDB_DEBUG_TRACE, "no modules required by the db\n");
 339                 } else {
 340                         if (ret != LDB_SUCCESS) {
 341                                 ldb_debug(ldb, LDB_DEBUG_FATAL, "ldb error (%s) occurred searching for modules, bailing out\n", ldb_errstring(ldb));
 342                                 talloc_free(mem_ctx);
 343                                 return -1;
 344                         }
 345                         if (res->count > 1) {
 346                                 ldb_debug(ldb, LDB_DEBUG_FATAL, "Too many records found (%d), bailing out\n", res->count);
 347                                 talloc_free(mem_ctx);
 348                                 return -1;
 349                         }
 350
 351                         modules = ldb_modules_list_from_string(ldb, mem_ctx,
 352                                                                (const char *)res->msgs[0]->elements[0].values[0].data);
 353
 354                 }
 355
 356                 talloc_free(mods_dn);
 357         }
 358
 359         if (modules != NULL) {
 360                 ret = ldb_load_modules_list(ldb, modules, ldb->modules, &ldb->modules);
 361                 talloc_free(modules);
 362                 if (ret != LDB_SUCCESS) {
 363                         return ret;
 364                 }
 365         } else {
 366                 ldb_debug(ldb, LDB_DEBUG_TRACE, "No modules specified for this database\n");
 367         }
 368
 369         return ldb_init_module_chain(ldb, ldb->modules);
 370 }
 371
 372 /*
 373   by using this we allow ldb modules to only implement the functions they care about,
 374   which makes writing a module simpler, and makes it more likely to keep working
 375   when ldb is extended
 376 */
 377 #define FIND_OP(module, op) do { \
 378         struct ldb_context *ldb = module->ldb; \
 379         module = module->next; \
 380         while (module && module->ops->op == NULL) module = module->next; \
 381         if (module == NULL) { \
 382                 ldb_asprintf_errstring(ldb, "Unable to find backend operation for " #op ); \
 383                 return LDB_ERR_OPERATIONS_ERROR;        \
 384         }                                               \
 385 } while (0)
 386
 387
 388 /*
 389    helper functions to call the next module in chain
 390 */
 391
 392 int ldb_next_request(struct ldb_module *module, struct ldb_request *request)
 393 {
 394         switch (request->operation) {
 395         case LDB_SEARCH:
 396                 FIND_OP(module, search);
 397                 return module->ops->search(module, request);
 398         case LDB_ADD:
 399                 FIND_OP(module, add);
 400                 return module->ops->add(module, request);
 401         case LDB_MODIFY:
 402                 FIND_OP(module, modify);
 403                 return module->ops->modify(module, request);
 404         case LDB_DELETE:
 405                 FIND_OP(module, del);
 406                 return module->ops->del(module, request);
 407         case LDB_RENAME:
 408                 FIND_OP(module, rename);
 409                 return module->ops->rename(module, request);
 410         case LDB_SEQUENCE_NUMBER:
 411                 FIND_OP(module, sequence_number);
 412                 return module->ops->sequence_number(module, request);
 413         default:
 414                 FIND_OP(module, request);
 415                 return module->ops->request(module, request);
 416         }
 417 }
 418
 419 int ldb_next_init(struct ldb_module *module)
 420 {
 421         /* init is different in that it is not an error if modules
 422          * do not require initialization */
 423
 424         module = module->next;
 425
 426         while (module && module->ops->init_context == NULL)
 427                 module = module->next;
 428
 429         if (module == NULL)
 430                 return LDB_SUCCESS;
 431
 432         return module->ops->init_context(module);
 433 }
 434
 435 int ldb_next_start_trans(struct ldb_module *module)
 436 {
 437         FIND_OP(module, start_transaction);
 438         return module->ops->start_transaction(module);
 439 }
 440
 441 int ldb_next_end_trans(struct ldb_module *module)
 442 {
 443         FIND_OP(module, end_transaction);
 444         return module->ops->end_transaction(module);
 445 }
 446
 447 int ldb_next_del_trans(struct ldb_module *module)
 448 {
 449         FIND_OP(module, del_transaction);
 450         return module->ops->del_transaction(module);
 451 }