source4/dsdb/samdb/ldb_modules/samba_dsdb.c

   1 /*
   2    Samba4 module loading module
   3
   4    Copyright (C) Andrew Bartlett <abartlet@samba.org> 2009
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 /*
  21  *  Name: ldb
  22  *
  23  *  Component: Samba4 module loading module
  24  *
  25  *  Description: Implement a single 'module' in the ldb database,
  26  *  which loads the remaining modules based on 'choice of configuration' attributes
  27  *
  28  *  This is to avoid forcing a reprovision of the ldb databases when we change the internal structure of the code
  29  *
  30  *  Author: Andrew Bartlett
  31  */
  32
  33 #include "includes.h"
  34 #include "lib/ldb/include/ldb.h"
  35 #include "lib/ldb/include/ldb_errors.h"
  36 #include "lib/ldb/include/ldb_module.h"
  37 #include "lib/ldb/include/ldb_private.h"
  38
  39 #include "dsdb/samdb/ldb_modules/util.h"
  40 #include "dsdb/samdb/samdb.h"
  41 #include "librpc/ndr/libndr.h"
  42
  43 static int read_at_rootdse_record(struct ldb_context *ldb, struct ldb_module *module, TALLOC_CTX *mem_ctx,
  44                                   struct ldb_message **msg)
  45 {
  46         int ret;
  47         static const char *rootdse_attrs[] = { "defaultNamingContext", "configurationNamingContext", "schemaNamingContext", NULL };
  48         struct ldb_result *rootdse_res;
  49         struct ldb_dn *rootdse_dn;
  50         TALLOC_CTX *tmp_ctx = talloc_new(mem_ctx);
  51         if (!tmp_ctx) {
  52                 ldb_oom(ldb);
  53                 return LDB_ERR_OPERATIONS_ERROR;
  54         }
  55
  56         rootdse_dn = ldb_dn_new(tmp_ctx, ldb, "@ROOTDSE");
  57         if (!rootdse_dn) {
  58                 talloc_free(tmp_ctx);
  59                 ldb_oom(ldb);
  60                 return LDB_ERR_OPERATIONS_ERROR;
  61         }
  62
  63         ret = dsdb_module_search_dn(module, tmp_ctx, &rootdse_res, rootdse_dn, rootdse_attrs, 0);
  64         if (ret != LDB_SUCCESS) {
  65                 talloc_free(tmp_ctx);
  66                 return ret;
  67         }
  68
  69         talloc_steal(mem_ctx, rootdse_res->msgs);
  70         *msg = rootdse_res->msgs[0];
  71
  72         talloc_free(tmp_ctx);
  73
  74         return ret;
  75 }
  76
  77 static int prepare_modules_line(struct ldb_context *ldb,
  78                                 TALLOC_CTX *mem_ctx,
  79                                 const struct ldb_message *rootdse_msg,
  80                                 struct ldb_message *msg, const char *backend_attr,
  81                                 const char *backend_mod, const char **backend_mod_list)
  82 {
  83         int ret;
  84         const char **backend_full_list;
  85         const char *backend_dn;
  86         char *mod_list_string;
  87         char *full_string;
  88         TALLOC_CTX *tmp_ctx = talloc_new(mem_ctx);
  89         if (!tmp_ctx) {
  90                 ldb_oom(ldb);
  91                 return LDB_ERR_OPERATIONS_ERROR;
  92         }
  93
  94         if (backend_attr) {
  95                 backend_dn = ldb_msg_find_attr_as_string(rootdse_msg, backend_attr, NULL);
  96                 if (!backend_dn) {
  97                         ldb_asprintf_errstring(ldb,
  98                                                "samba_dsdb_init: "
  99                                                "unable to read %s from %s:%s",
 100                                                backend_attr, ldb_dn_get_linearized(rootdse_msg->dn),
 101                                                ldb_errstring(ldb));
 102                         return LDB_ERR_CONSTRAINT_VIOLATION;
 103                 }
 104         } else {
 105                 backend_dn = "*";
 106         }
 107
 108         if (backend_mod) {
 109                 backend_full_list = (const char **)str_list_make_single(tmp_ctx, backend_mod);
 110         } else {
 111                 backend_full_list = (const char **)str_list_make_empty(tmp_ctx);
 112         }
 113         if (!backend_full_list) {
 114                 talloc_free(tmp_ctx);
 115                 ldb_oom(ldb);
 116                 return LDB_ERR_OPERATIONS_ERROR;
 117         }
 118
 119         backend_full_list = str_list_append_const(backend_full_list, backend_mod_list);
 120         if (!backend_full_list) {
 121                 talloc_free(tmp_ctx);
 122                 ldb_oom(ldb);
 123                 return LDB_ERR_OPERATIONS_ERROR;
 124         }
 125
 126         mod_list_string = str_list_join(tmp_ctx, backend_full_list, ',');
 127         if (!mod_list_string) {
 128                 talloc_free(tmp_ctx);
 129                 ldb_oom(ldb);
 130                 return LDB_ERR_OPERATIONS_ERROR;
 131         }
 132
 133         full_string = talloc_asprintf(tmp_ctx, "%s:%s", backend_dn, mod_list_string);
 134         ret = ldb_msg_add_steal_string(msg, "modules", full_string);
 135         talloc_free(tmp_ctx);
 136         return ret;
 137 }
 138
 139
 140
 141 static int samba_dsdb_init(struct ldb_module *module)
 142 {
 143         struct ldb_context *ldb = ldb_module_get_ctx(module);
 144         int ret, len, i;
 145         TALLOC_CTX *tmp_ctx = talloc_new(module);
 146         struct ldb_result *res;
 147         struct ldb_message *rootdse_msg, *partition_msg;
 148         struct ldb_dn *samba_dsdb_dn;
 149         struct ldb_module *backend_module, *module_chain;
 150         const char **final_module_list, **reverse_module_list;
 151         /*
 152           Add modules to the list to activate them by default
 153           beware often order is important
 154
 155           Some Known ordering constraints:
 156           - rootdse must be first, as it makes redirects from "" -> cn=rootdse
 157           - extended_dn_in must be before objectclass.c, as it resolves the DN
 158           - objectclass must be before password_hash and samldb since these LDB
 159             modules require the expanded "objectClass" list
 160           - objectclass_attrs must be behind operational in order to see all
 161             attributes (the operational attributes protects and therefore
 162             suppresses per default some important ontes)
 163           - partition must be last
 164           - each partition has its own module list then
 165
 166           The list is presented here as a set of declarations to show the
 167           stack visually - the code below then handles the creation of the list
 168           based on the parameters loaded from the database.
 169         */
 170         static const char *modules_list[] = {"resolve_oids",
 171                                              "rootdse",
 172                                              "lazy_commit",
 173                                              "paged_results",
 174                                              "ranged_results",
 175                                              "anr",
 176                                              "server_sort",
 177                                              "asq",
 178                                              "extended_dn_store",
 179                                              "extended_dn_in",
 180                                              "objectclass",
 181                                              "descriptor",
 182                                              "acl",
 183                                              "samldb",
 184                                              "password_hash",
 185                                              "operational",
 186                                              "objectclass_attrs",
 187                                              "kludge_acl",
 188                                              "schema_load",
 189                                              "instancetype",
 190                                              NULL };
 191
 192         const char **link_modules;
 193         static const char *fedora_ds_modules[] = {
 194                 "rdn_name", NULL };
 195         static const char *openldap_modules[] = {
 196                 NULL };
 197         static const char *tdb_modules_list[] = {
 198                 "rdn_name",
 199                 "subtree_delete",
 200                 "repl_meta_data",
 201                 "subtree_rename",
 202                 "linked_attributes",
 203                 NULL};
 204
 205         const char *extended_dn_module;
 206         const char *extended_dn_module_ldb = "extended_dn_out_ldb";
 207         const char *extended_dn_module_fds = "extended_dn_out_fds";
 208         const char *extended_dn_module_openldap = "extended_dn_out_openldap";
 209
 210         static const char *modules_list2[] = {"show_deleted",
 211                                               "new_partition",
 212                                               "partition",
 213                                               NULL };
 214
 215         const char **backend_modules;
 216         static const char *fedora_ds_backend_modules[] = {
 217                 "nsuniqueid", "paged_searches", NULL };
 218         static const char *openldap_backend_modules[] = {
 219                 "entryuuid", "paged_searches", NULL };
 220
 221         static const char *samba_dsdb_attrs[] = { "backendType", "serverRole", NULL };
 222         const char *backendType, *serverRole;
 223
 224         if (!tmp_ctx) {
 225                 ldb_oom(ldb);
 226                 return LDB_ERR_OPERATIONS_ERROR;
 227         }
 228
 229         samba_dsdb_dn = ldb_dn_new(tmp_ctx, ldb, "@SAMBA_DSDB");
 230         if (!samba_dsdb_dn) {
 231                 talloc_free(tmp_ctx);
 232                 ldb_oom(ldb);
 233                 return LDB_ERR_OPERATIONS_ERROR;
 234         }
 235
 236 #define CHECK_LDB_RET(check_ret)                                \
 237         do {                                                    \
 238                 if (check_ret != LDB_SUCCESS) {                 \
 239                         talloc_free(tmp_ctx);                   \
 240                         return check_ret;                       \
 241                 }                                               \
 242         } while (0)
 243
 244         ret = dsdb_module_search_dn(module, tmp_ctx, &res, samba_dsdb_dn, samba_dsdb_attrs, 0);
 245         if (ret == LDB_ERR_NO_SUCH_OBJECT) {
 246                 backendType = "ldb";
 247                 serverRole = "domain controller";
 248         } else if (ret == LDB_SUCCESS) {
 249                 backendType = ldb_msg_find_attr_as_string(res->msgs[0], "backendType", "ldb");
 250                 serverRole = ldb_msg_find_attr_as_string(res->msgs[0], "serverRole", "domain controller");
 251         } else {
 252                 talloc_free(tmp_ctx);
 253                 return ret;
 254         }
 255
 256         backend_modules = NULL;
 257         if (strcasecmp(backendType, "ldb") == 0) {
 258                 extended_dn_module = extended_dn_module_ldb;
 259                 link_modules = tdb_modules_list;
 260         } else {
 261                 if (strcasecmp(backendType, "fedora-ds") == 0) {
 262                         link_modules = fedora_ds_modules;
 263                         backend_modules = fedora_ds_backend_modules;
 264                         extended_dn_module = extended_dn_module_fds;
 265                 } else if (strcasecmp(backendType, "openldap") == 0) {
 266                         link_modules = openldap_modules;
 267                         backend_modules = openldap_backend_modules;
 268                         extended_dn_module = extended_dn_module_openldap;
 269                 }
 270         }
 271
 272 #define CHECK_MODULE_LIST \
 273         do {                                                    \
 274                 if (!final_module_list) {                       \
 275                         talloc_free(tmp_ctx);                   \
 276                         ldb_oom(ldb);                           \
 277                         return LDB_ERR_OPERATIONS_ERROR;        \
 278                 }                                               \
 279         } while (0)
 280
 281         final_module_list = str_list_copy_const(tmp_ctx, modules_list);
 282         CHECK_MODULE_LIST;
 283
 284         final_module_list = str_list_append_const(final_module_list, link_modules);
 285         CHECK_MODULE_LIST;
 286
 287         final_module_list = str_list_add_const(final_module_list, extended_dn_module);
 288         CHECK_MODULE_LIST;
 289
 290         final_module_list = str_list_append_const(final_module_list, modules_list2);
 291         CHECK_MODULE_LIST;
 292
 293
 294         ret = read_at_rootdse_record(ldb, module, tmp_ctx, &rootdse_msg);
 295         CHECK_LDB_RET(ret);
 296
 297         partition_msg = ldb_msg_new(tmp_ctx);
 298         partition_msg->dn = ldb_dn_new(partition_msg, ldb, "@" DSDB_OPAQUE_PARTITION_MODULE_MSG_OPAQUE_NAME);
 299
 300         ret = prepare_modules_line(ldb, tmp_ctx,
 301                                    rootdse_msg,
 302                                    partition_msg, "defaultNamingContext",
 303                                    "pdc_fsmo", backend_modules);
 304         CHECK_LDB_RET(ret);
 305
 306         ret = prepare_modules_line(ldb, tmp_ctx,
 307                                    rootdse_msg,
 308                                    partition_msg, "configurationNamingContext",
 309                                    "naming_fsmo", backend_modules);
 310         CHECK_LDB_RET(ret);
 311
 312         ret = prepare_modules_line(ldb, tmp_ctx,
 313                                    rootdse_msg,
 314                                    partition_msg, "schemaNamingContext",
 315                                    "schema_data", backend_modules);
 316         CHECK_LDB_RET(ret);
 317
 318         ret = prepare_modules_line(ldb, tmp_ctx,
 319                                    rootdse_msg,
 320                                    partition_msg, NULL,
 321                                    NULL, backend_modules);
 322         CHECK_LDB_RET(ret);
 323
 324         ret = ldb_set_opaque(ldb, DSDB_OPAQUE_PARTITION_MODULE_MSG_OPAQUE_NAME, partition_msg);
 325         CHECK_LDB_RET(ret);
 326
 327         talloc_steal(ldb, partition_msg);
 328
 329         /* Now prepare the module chain.  Oddly, we must give it to ldb_load_modules_list in REVERSE */
 330         for (len = 0; final_module_list[len]; len++) { /* noop */};
 331
 332         reverse_module_list = talloc_array(tmp_ctx, const char *, len+1);
 333         if (!reverse_module_list) {
 334                 talloc_free(tmp_ctx);
 335                 ldb_oom(ldb);
 336                 return LDB_ERR_OPERATIONS_ERROR;
 337         }
 338         for (i=0; i < len; i++) {
 339                 reverse_module_list[i] = final_module_list[(len - 1) - i];
 340         }
 341         reverse_module_list[i] = NULL;
 342
 343         /* The backend (at least until the partitions module
 344          * reconfigures things) is the next module in the currently
 345          * loaded chain */
 346         backend_module = module->next;
 347         ret = ldb_load_modules_list(ldb, reverse_module_list, backend_module, &module_chain);
 348         CHECK_LDB_RET(ret);
 349
 350         talloc_free(tmp_ctx);
 351         /* Set this as the 'next' module, so that we effectivly append it to module chain */
 352         module->next = module_chain;
 353
 354         return ldb_next_init(module);
 355 }
 356
 357 const struct ldb_module_ops ldb_samba_dsdb_module_ops = {
 358         .name              = "samba_dsdb",
 359         .init_context      = samba_dsdb_init,
 360 };