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 <ldb.h>
  35 #include <ldb_errors.h>
  36 #include <ldb_module.h>
  37 #include "dsdb/samdb/ldb_modules/util.h"
  38 #include "dsdb/samdb/samdb.h"
  39 #include "librpc/ndr/libndr.h"
  40 #include "auth/credentials/credentials.h"
  41 #include "param/secrets.h"
  42 #include "lib/ldb-samba/ldb_wrap.h"
  43
  44 static int read_at_rootdse_record(struct ldb_context *ldb, struct ldb_module *module, TALLOC_CTX *mem_ctx,
  45                                   struct ldb_message **msg, struct ldb_request *parent)
  46 {
  47         int ret;
  48         static const char *rootdse_attrs[] = { "defaultNamingContext", "configurationNamingContext", "schemaNamingContext", NULL };
  49         struct ldb_result *rootdse_res;
  50         struct ldb_dn *rootdse_dn;
  51         TALLOC_CTX *tmp_ctx = talloc_new(mem_ctx);
  52         if (!tmp_ctx) {
  53                 return ldb_oom(ldb);
  54         }
  55
  56         rootdse_dn = ldb_dn_new(tmp_ctx, ldb, "@ROOTDSE");
  57         if (!rootdse_dn) {
  58                 talloc_free(tmp_ctx);
  59                 return ldb_oom(ldb);
  60         }
  61
  62         ret = dsdb_module_search_dn(module, tmp_ctx, &rootdse_res, rootdse_dn,
  63                                     rootdse_attrs, DSDB_FLAG_NEXT_MODULE, parent);
  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                 return ldb_oom(ldb);
  91         }
  92
  93         if (backend_attr) {
  94                 backend_dn = ldb_msg_find_attr_as_string(rootdse_msg, backend_attr, NULL);
  95                 if (!backend_dn) {
  96                         ldb_asprintf_errstring(ldb,
  97                                                "samba_dsdb_init: "
  98                                                "unable to read %s from %s:%s",
  99                                                backend_attr, ldb_dn_get_linearized(rootdse_msg->dn),
 100                                                ldb_errstring(ldb));
 101                         return LDB_ERR_CONSTRAINT_VIOLATION;
 102                 }
 103         } else {
 104                 backend_dn = "*";
 105         }
 106
 107         if (backend_mod) {
 108                 char **b = str_list_make_single(tmp_ctx, backend_mod);
 109                 backend_full_list = discard_const_p(const char *, b);
 110         } else {
 111                 char **b = str_list_make_empty(tmp_ctx);
 112                 backend_full_list = discard_const_p(const char *, b);
 113         }
 114         if (!backend_full_list) {
 115                 talloc_free(tmp_ctx);
 116                 return ldb_oom(ldb);
 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                 return ldb_oom(ldb);
 123         }
 124
 125         mod_list_string = str_list_join(tmp_ctx, backend_full_list, ',');
 126         if (!mod_list_string) {
 127                 talloc_free(tmp_ctx);
 128                 return ldb_oom(ldb);
 129         }
 130
 131         full_string = talloc_asprintf(tmp_ctx, "%s:%s", backend_dn, mod_list_string);
 132         ret = ldb_msg_add_steal_string(msg, "modules", full_string);
 133         talloc_free(tmp_ctx);
 134         return ret;
 135 }
 136
 137 /*
 138  * Force overwrite of the credentials with those
 139  * specified in secrets.ldb, to connect across the
 140  * ldapi socket to an LDAP backend
 141  */
 142
 143 static int set_ldap_credentials(struct ldb_context *ldb, bool use_external)
 144 {
 145         const char *secrets_ldb_path, *sam_ldb_path;
 146         char *private_dir, *p, *error_string;
 147         struct ldb_context *secrets_ldb;
 148         struct cli_credentials *cred;
 149         struct loadparm_context *lp_ctx = ldb_get_opaque(ldb, "loadparm");
 150         TALLOC_CTX *tmp_ctx = talloc_new(ldb);
 151
 152         if (!tmp_ctx) {
 153                 return ldb_oom(ldb);
 154         }
 155
 156         cred = cli_credentials_init(ldb);
 157         if (!cred) {
 158                 talloc_free(tmp_ctx);
 159                 return ldb_oom(ldb);
 160         }
 161         cli_credentials_set_anonymous(cred);
 162         if (use_external) {
 163                 cli_credentials_set_forced_sasl_mech(cred, "EXTERNAL");
 164         } else {
 165                 cli_credentials_set_forced_sasl_mech(cred, "DIGEST-MD5");
 166
 167                 /*
 168                  * We don't want to use krb5 to talk to our samdb - recursion
 169                  * here would be bad, and this account isn't in the KDC
 170                  * anyway
 171                  */
 172                 cli_credentials_set_kerberos_state(cred, CRED_DONT_USE_KERBEROS);
 173
 174                 /*
 175                  * Work out where *our* secrets.ldb is.  It must be in
 176                  * the same directory as sam.ldb
 177                  */
 178                 sam_ldb_path = (const char *)ldb_get_opaque(ldb, "ldb_url");
 179                 if (!sam_ldb_path) {
 180                         talloc_free(tmp_ctx);
 181                         return ldb_operr(ldb);
 182                 }
 183                 if (strncmp("tdb://", sam_ldb_path, 6) == 0) {
 184                         sam_ldb_path += 6;
 185                 }
 186                 private_dir = talloc_strdup(tmp_ctx, sam_ldb_path);
 187                 p = strrchr(private_dir, '/');
 188                 if (p) {
 189                         *p = '\0';
 190                 } else {
 191                         private_dir = talloc_strdup(tmp_ctx, ".");
 192                 }
 193
 194                 secrets_ldb_path = talloc_asprintf(private_dir, "tdb://%s/secrets.ldb",
 195                                                    private_dir);
 196
 197                 if (!secrets_ldb_path) {
 198                         talloc_free(tmp_ctx);
 199                         return ldb_oom(ldb);
 200                 }
 201
 202                 /*
 203                  * Now that we have found the location, connect to
 204                  * secrets.ldb so we can read the SamDB Credentials
 205                  * record
 206                  */
 207                 secrets_ldb = ldb_wrap_connect(tmp_ctx, NULL, lp_ctx, secrets_ldb_path,
 208                                                NULL, NULL, 0);
 209
 210                 if (!NT_STATUS_IS_OK(cli_credentials_set_secrets(cred, NULL, secrets_ldb, NULL,
 211                                                                  SECRETS_LDAP_FILTER, &error_string))) {
 212                         ldb_asprintf_errstring(ldb, "Failed to read LDAP backend password from %s", secrets_ldb_path);
 213                         talloc_free(tmp_ctx);
 214                         return LDB_ERR_STRONG_AUTH_REQUIRED;
 215                 }
 216         }
 217
 218         /*
 219          * Finally overwrite any supplied credentials with
 220          * these ones, as only secrets.ldb contains the magic
 221          * credentials to talk on the ldapi socket
 222          */
 223         if (ldb_set_opaque(ldb, "credentials", cred)) {
 224                 talloc_free(tmp_ctx);
 225                 return ldb_operr(ldb);
 226         }
 227         talloc_free(tmp_ctx);
 228         return LDB_SUCCESS;
 229 }
 230
 231 static int samba_dsdb_init(struct ldb_module *module)
 232 {
 233         struct ldb_context *ldb = ldb_module_get_ctx(module);
 234         int ret, len, i;
 235         TALLOC_CTX *tmp_ctx = talloc_new(module);
 236         struct ldb_result *res;
 237         struct ldb_message *rootdse_msg = NULL, *partition_msg;
 238         struct ldb_dn *samba_dsdb_dn, *partition_dn;
 239         struct ldb_module *backend_module, *module_chain;
 240         const char **final_module_list, **reverse_module_list;
 241         /*
 242           Add modules to the list to activate them by default
 243           beware often order is important
 244
 245           Some Known ordering constraints:
 246           - rootdse must be first, as it makes redirects from "" -> cn=rootdse
 247           - extended_dn_in must be before objectclass.c, as it resolves the DN
 248           - objectclass must be before password_hash and samldb since these LDB
 249             modules require the expanded "objectClass" list
 250           - objectclass must be before descriptor and acl, as both assume that
 251             objectClass values are sorted
 252           - objectclass_attrs must be behind operational in order to see all
 253             attributes (the operational module protects and therefore
 254             suppresses per default some important ones)
 255           - partition must be last
 256           - each partition has its own module list then
 257
 258           The list is presented here as a set of declarations to show the
 259           stack visually - the code below then handles the creation of the list
 260           based on the parameters loaded from the database.
 261         */
 262         static const char *modules_list1[] = {"resolve_oids",
 263                                              "rootdse",
 264                                              "dsdb_notification",
 265                                              "schema_load",
 266                                              "lazy_commit",
 267                                              "dirsync",
 268                                              "paged_results",
 269                                              "vlv",
 270                                              "ranged_results",
 271                                              "anr",
 272                                              "server_sort",
 273                                              "asq",
 274                                              "extended_dn_store",
 275                                              NULL };
 276         /* extended_dn_in or extended_dn_in_openldap goes here */
 277         static const char *modules_list1a[] = {"objectclass",
 278                                              "descriptor",
 279                                              "acl",
 280                                              "aclread",
 281                                              "samldb",
 282                                              "password_hash",
 283                                              "instancetype",
 284                                              "objectclass_attrs",
 285                                              NULL };
 286
 287         const char **link_modules;
 288         static const char *fedora_ds_modules[] = {
 289                 "rdn_name", NULL };
 290         static const char *openldap_modules[] = {
 291                 NULL };
 292         static const char *tdb_modules_list[] = {
 293                 "rdn_name",
 294                 "subtree_delete",
 295                 "repl_meta_data",
 296                 "operational",
 297                 "subtree_rename",
 298                 "linked_attributes",
 299                 NULL};
 300
 301         const char *extended_dn_module;
 302         const char *extended_dn_module_ldb = "extended_dn_out_ldb";
 303         const char *extended_dn_module_fds = "extended_dn_out_fds";
 304         const char *extended_dn_module_openldap = "extended_dn_out_openldap";
 305         const char *extended_dn_in_module = "extended_dn_in";
 306
 307         static const char *modules_list2[] = {"dns_notify",
 308                                               "show_deleted",
 309                                               "new_partition",
 310                                               "partition",
 311                                               NULL };
 312
 313         const char **backend_modules;
 314         static const char *fedora_ds_backend_modules[] = {
 315                 "dsdb_flags_ignore", "nsuniqueid", "paged_searches", "simple_dn", NULL };
 316         static const char *openldap_backend_modules[] = {
 317                 "dsdb_flags_ignore", "entryuuid", "simple_dn", NULL };
 318
 319         static const char *samba_dsdb_attrs[] = { "backendType", NULL };
 320         static const char *partition_attrs[] = { "ldapBackend", NULL };
 321         const char *backendType, *backendUrl;
 322         bool use_sasl_external = false;
 323
 324         if (!tmp_ctx) {
 325                 return ldb_oom(ldb);
 326         }
 327
 328         ret = ldb_register_samba_handlers(ldb);
 329         if (ret != LDB_SUCCESS) {
 330                 talloc_free(tmp_ctx);
 331                 return ret;
 332         }
 333
 334         samba_dsdb_dn = ldb_dn_new(tmp_ctx, ldb, "@SAMBA_DSDB");
 335         if (!samba_dsdb_dn) {
 336                 talloc_free(tmp_ctx);
 337                 return ldb_oom(ldb);
 338         }
 339
 340         partition_dn = ldb_dn_new(tmp_ctx, ldb, DSDB_PARTITION_DN);
 341         if (!partition_dn) {
 342                 talloc_free(tmp_ctx);
 343                 return ldb_oom(ldb);
 344         }
 345
 346 #define CHECK_LDB_RET(check_ret)                                \
 347         do {                                                    \
 348                 if (check_ret != LDB_SUCCESS) {                 \
 349                         talloc_free(tmp_ctx);                   \
 350                         return check_ret;                       \
 351                 }                                               \
 352         } while (0)
 353
 354         ret = dsdb_module_search_dn(module, tmp_ctx, &res, samba_dsdb_dn,
 355                                     samba_dsdb_attrs, DSDB_FLAG_NEXT_MODULE, NULL);
 356         if (ret == LDB_ERR_NO_SUCH_OBJECT) {
 357                 backendType = "ldb";
 358         } else if (ret == LDB_SUCCESS) {
 359                 backendType = ldb_msg_find_attr_as_string(res->msgs[0], "backendType", "ldb");
 360         } else {
 361                 talloc_free(tmp_ctx);
 362                 return ret;
 363         }
 364
 365         backend_modules = NULL;
 366         if (strcasecmp(backendType, "ldb") == 0) {
 367                 extended_dn_module = extended_dn_module_ldb;
 368                 link_modules = tdb_modules_list;
 369         } else {
 370                 struct cli_credentials *cred;
 371                 bool is_ldapi = false;
 372
 373                 ret = dsdb_module_search_dn(module, tmp_ctx, &res, partition_dn,
 374                                             partition_attrs, DSDB_FLAG_NEXT_MODULE, NULL);
 375                 if (ret == LDB_SUCCESS) {
 376                         backendUrl = ldb_msg_find_attr_as_string(res->msgs[0], "ldapBackend", "ldapi://");
 377                         if (!strncasecmp(backendUrl, "ldapi://", sizeof("ldapi://")-1)) {
 378                                 is_ldapi = true;
 379                         }
 380                 } else if (ret != LDB_ERR_NO_SUCH_OBJECT) {
 381                         talloc_free(tmp_ctx);
 382                         return ret;
 383                 }
 384                 if (strcasecmp(backendType, "fedora-ds") == 0) {
 385                         link_modules = fedora_ds_modules;
 386                         backend_modules = fedora_ds_backend_modules;
 387                         extended_dn_module = extended_dn_module_fds;
 388                 } else if (strcasecmp(backendType, "openldap") == 0) {
 389                         link_modules = openldap_modules;
 390                         backend_modules = openldap_backend_modules;
 391                         extended_dn_module = extended_dn_module_openldap;
 392                         extended_dn_in_module = "extended_dn_in_openldap";
 393                         if (is_ldapi) {
 394                                 use_sasl_external = true;
 395                         }
 396                 } else {
 397                         return ldb_error(ldb, LDB_ERR_OPERATIONS_ERROR, "invalid backend type");
 398                 }
 399                 ret = ldb_set_opaque(ldb, "readOnlySchema", (void*)1);
 400                 if (ret != LDB_SUCCESS) {
 401                         ldb_set_errstring(ldb, "Failed to set readOnlySchema opaque");
 402                 }
 403
 404                 cred = ldb_get_opaque(ldb, "credentials");
 405                 if (!cred || !cli_credentials_authentication_requested(cred)) {
 406                         ret = set_ldap_credentials(ldb, use_sasl_external);
 407                         if (ret != LDB_SUCCESS) {
 408                                 return ret;
 409                         }
 410                 }
 411         }
 412
 413 #define CHECK_MODULE_LIST \
 414         do {                                                    \
 415                 if (!final_module_list) {                       \
 416                         talloc_free(tmp_ctx);                   \
 417                         return ldb_oom(ldb);                    \
 418                 }                                               \
 419         } while (0)
 420
 421         final_module_list = str_list_copy_const(tmp_ctx, modules_list1);
 422         CHECK_MODULE_LIST;
 423
 424         final_module_list = str_list_add_const(final_module_list, extended_dn_in_module);
 425         CHECK_MODULE_LIST;
 426
 427         final_module_list = str_list_append_const(final_module_list, modules_list1a);
 428         CHECK_MODULE_LIST;
 429
 430         final_module_list = str_list_append_const(final_module_list, link_modules);
 431         CHECK_MODULE_LIST;
 432
 433         final_module_list = str_list_add_const(final_module_list, extended_dn_module);
 434         CHECK_MODULE_LIST;
 435
 436         final_module_list = str_list_append_const(final_module_list, modules_list2);
 437         CHECK_MODULE_LIST;
 438
 439
 440         ret = read_at_rootdse_record(ldb, module, tmp_ctx, &rootdse_msg, NULL);
 441         CHECK_LDB_RET(ret);
 442
 443         partition_msg = ldb_msg_new(tmp_ctx);
 444         partition_msg->dn = ldb_dn_new(partition_msg, ldb, "@" DSDB_OPAQUE_PARTITION_MODULE_MSG_OPAQUE_NAME);
 445
 446         ret = prepare_modules_line(ldb, tmp_ctx,
 447                                    rootdse_msg,
 448                                    partition_msg, "schemaNamingContext",
 449                                    "schema_data", backend_modules);
 450         CHECK_LDB_RET(ret);
 451
 452         ret = prepare_modules_line(ldb, tmp_ctx,
 453                                    rootdse_msg,
 454                                    partition_msg, NULL,
 455                                    NULL, backend_modules);
 456         CHECK_LDB_RET(ret);
 457
 458         ret = ldb_set_opaque(ldb, DSDB_OPAQUE_PARTITION_MODULE_MSG_OPAQUE_NAME, partition_msg);
 459         CHECK_LDB_RET(ret);
 460
 461         talloc_steal(ldb, partition_msg);
 462
 463         /* Now prepare the module chain.  Oddly, we must give it to ldb_load_modules_list in REVERSE */
 464         for (len = 0; final_module_list[len]; len++) { /* noop */};
 465
 466         reverse_module_list = talloc_array(tmp_ctx, const char *, len+1);
 467         if (!reverse_module_list) {
 468                 talloc_free(tmp_ctx);
 469                 return ldb_oom(ldb);
 470         }
 471         for (i=0; i < len; i++) {
 472                 reverse_module_list[i] = final_module_list[(len - 1) - i];
 473         }
 474         reverse_module_list[i] = NULL;
 475
 476         /* The backend (at least until the partitions module
 477          * reconfigures things) is the next module in the currently
 478          * loaded chain */
 479         backend_module = ldb_module_next(module);
 480         ret = ldb_module_load_list(ldb, reverse_module_list, backend_module, &module_chain);
 481         CHECK_LDB_RET(ret);
 482
 483         talloc_free(tmp_ctx);
 484         /* Set this as the 'next' module, so that we effectivly append it to module chain */
 485         ldb_module_set_next(module, module_chain);
 486
 487         return ldb_next_init(module);
 488 }
 489
 490 static const struct ldb_module_ops ldb_samba_dsdb_module_ops = {
 491         .name              = "samba_dsdb",
 492         .init_context      = samba_dsdb_init,
 493 };
 494
 495 static struct ldb_message *dsdb_flags_ignore_fixup(TALLOC_CTX *mem_ctx,
 496                                                 const struct ldb_message *_msg)
 497 {
 498         struct ldb_message *msg = NULL;
 499         unsigned int i;
 500
 501         /* we have to copy the message as the caller might have it as a const */
 502         msg = ldb_msg_copy_shallow(mem_ctx, _msg);
 503         if (msg == NULL) {
 504                 return NULL;
 505         }
 506
 507         for (i=0; i < msg->num_elements;) {
 508                 struct ldb_message_element *e = &msg->elements[i];
 509
 510                 if (!(e->flags & DSDB_FLAG_INTERNAL_FORCE_META_DATA)) {
 511                         i++;
 512                         continue;
 513                 }
 514
 515                 e->flags &= ~DSDB_FLAG_INTERNAL_FORCE_META_DATA;
 516
 517                 if (e->num_values != 0) {
 518                         i++;
 519                         continue;
 520                 }
 521
 522                 ldb_msg_remove_element(msg, e);
 523         }
 524
 525         return msg;
 526 }
 527
 528 static int dsdb_flags_ignore_add(struct ldb_module *module, struct ldb_request *req)
 529 {
 530         struct ldb_context *ldb = ldb_module_get_ctx(module);
 531         struct ldb_request *down_req = NULL;
 532         struct ldb_message *msg = NULL;
 533         int ret;
 534
 535         msg = dsdb_flags_ignore_fixup(req, req->op.add.message);
 536         if (msg == NULL) {
 537                 return ldb_module_oom(module);
 538         }
 539
 540         ret = ldb_build_add_req(&down_req, ldb, req,
 541                                 msg,
 542                                 req->controls,
 543                                 req, dsdb_next_callback,
 544                                 req);
 545         LDB_REQ_SET_LOCATION(down_req);
 546         if (ret != LDB_SUCCESS) {
 547                 return ret;
 548         }
 549
 550         /* go on with the call chain */
 551         return ldb_next_request(module, down_req);
 552 }
 553
 554 static int dsdb_flags_ignore_modify(struct ldb_module *module, struct ldb_request *req)
 555 {
 556         struct ldb_context *ldb = ldb_module_get_ctx(module);
 557         struct ldb_request *down_req = NULL;
 558         struct ldb_message *msg = NULL;
 559         int ret;
 560
 561         msg = dsdb_flags_ignore_fixup(req, req->op.mod.message);
 562         if (msg == NULL) {
 563                 return ldb_module_oom(module);
 564         }
 565
 566         ret = ldb_build_mod_req(&down_req, ldb, req,
 567                                 msg,
 568                                 req->controls,
 569                                 req, dsdb_next_callback,
 570                                 req);
 571         LDB_REQ_SET_LOCATION(down_req);
 572         if (ret != LDB_SUCCESS) {
 573                 return ret;
 574         }
 575
 576         /* go on with the call chain */
 577         return ldb_next_request(module, down_req);
 578 }
 579
 580 static const struct ldb_module_ops ldb_dsdb_flags_ignore_module_ops = {
 581         .name   = "dsdb_flags_ignore",
 582         .add    = dsdb_flags_ignore_add,
 583         .modify = dsdb_flags_ignore_modify,
 584 };
 585
 586 int ldb_samba_dsdb_module_init(const char *version)
 587 {
 588         int ret;
 589         LDB_MODULE_CHECK_VERSION(version);
 590         ret = ldb_register_module(&ldb_samba_dsdb_module_ops);
 591         if (ret != LDB_SUCCESS) {
 592                 return ret;
 593         }
 594         ret = ldb_register_module(&ldb_dsdb_flags_ignore_module_ops);
 595         if (ret != LDB_SUCCESS) {
 596                 return ret;
 597         }
 598         return LDB_SUCCESS;
 599 }