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