source4/lib/ldb/common/ldb_modules.c

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