source4/dsdb/samdb/ldb_modules/rootdse.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    rootDSE ldb module
   5
   6    Copyright (C) Andrew Tridgell 2005
   7    Copyright (C) Simo Sorce 2005-2008
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21 */
  22
  23 #include "includes.h"
  24 #include "lib/ldb/include/ldb.h"
  25 #include "lib/ldb/include/ldb_errors.h"
  26 #include "lib/ldb/include/ldb_private.h"
  27 #include "system/time.h"
  28 #include "dsdb/samdb/samdb.h"
  29 #include "version.h"
  30
  31 struct private_data {
  32         int num_controls;
  33         char **controls;
  34         int num_partitions;
  35         struct ldb_dn **partitions;
  36 };
  37
  38 /*
  39   return 1 if a specific attribute has been requested
  40 */
  41 static int do_attribute(const char * const *attrs, const char *name)
  42 {
  43         return attrs == NULL ||
  44                 ldb_attr_in_list(attrs, name) ||
  45                 ldb_attr_in_list(attrs, "*");
  46 }
  47
  48 static int do_attribute_explicit(const char * const *attrs, const char *name)
  49 {
  50         return attrs != NULL && ldb_attr_in_list(attrs, name);
  51 }
  52
  53
  54 /*
  55   add dynamically generated attributes to rootDSE result
  56 */
  57 static int rootdse_add_dynamic(struct ldb_module *module, struct ldb_message *msg, const char * const *attrs)
  58 {
  59         struct private_data *priv = talloc_get_type(module->private_data, struct private_data);
  60         char **server_sasl;
  61         const struct dsdb_schema *schema;
  62
  63         schema = dsdb_get_schema(module->ldb);
  64
  65         msg->dn = ldb_dn_new(msg, module->ldb, NULL);
  66
  67         /* don't return the distinduishedName, cn and name attributes */
  68         ldb_msg_remove_attr(msg, "distinguishedName");
  69         ldb_msg_remove_attr(msg, "cn");
  70         ldb_msg_remove_attr(msg, "name");
  71
  72         if (do_attribute(attrs, "currentTime")) {
  73                 if (ldb_msg_add_steal_string(msg, "currentTime",
  74                                              ldb_timestring(msg, time(NULL))) != 0) {
  75                         goto failed;
  76                 }
  77         }
  78
  79         if (do_attribute(attrs, "supportedControl")) {
  80                 int i;
  81                 for (i = 0; i < priv->num_controls; i++) {
  82                         char *control = talloc_strdup(msg, priv->controls[i]);
  83                         if (!control) {
  84                                 goto failed;
  85                         }
  86                         if (ldb_msg_add_steal_string(msg, "supportedControl",
  87                                                      control) != 0) {
  88                                 goto failed;
  89                         }
  90                 }
  91         }
  92
  93         if (do_attribute(attrs, "namingContexts")) {
  94                 int i;
  95                 for (i = 0; i < priv->num_partitions; i++) {
  96                         struct ldb_dn *dn = priv->partitions[i];
  97                         if (ldb_msg_add_steal_string(msg, "namingContexts",
  98                                                      ldb_dn_alloc_linearized(msg, dn)) != 0) {
  99                                 goto failed;
 100                         }
 101                 }
 102         }
 103
 104         server_sasl = talloc_get_type(ldb_get_opaque(module->ldb, "supportedSASLMechanims"),
 105                                        char *);
 106         if (server_sasl && do_attribute(attrs, "supportedSASLMechanisms")) {
 107                 int i;
 108                 for (i = 0; server_sasl && server_sasl[i]; i++) {
 109                         char *sasl_name = talloc_strdup(msg, server_sasl[i]);
 110                         if (!sasl_name) {
 111                                 goto failed;
 112                         }
 113                         if (ldb_msg_add_steal_string(msg, "supportedSASLMechanisms",
 114                                                      sasl_name) != 0) {
 115                                 goto failed;
 116                         }
 117                 }
 118         }
 119
 120         if (do_attribute(attrs, "highestCommittedUSN")) {
 121                 uint64_t seq_num;
 122                 int ret = ldb_sequence_number(module->ldb, LDB_SEQ_HIGHEST_SEQ, &seq_num);
 123                 if (ret == LDB_SUCCESS) {
 124                         if (ldb_msg_add_fmt(msg, "highestCommittedUSN",
 125                                             "%llu", (unsigned long long)seq_num) != 0) {
 126                                 goto failed;
 127                         }
 128                 }
 129         }
 130
 131         if (schema && do_attribute_explicit(attrs, "dsSchemaAttrCount")) {
 132                 struct dsdb_attribute *cur;
 133                 uint32_t n = 0;
 134
 135                 for (cur = schema->attributes; cur; cur = cur->next) {
 136                         n++;
 137                 }
 138
 139                 if (ldb_msg_add_fmt(msg, "dsSchemaAttrCount",
 140                                     "%u", n) != 0) {
 141                         goto failed;
 142                 }
 143         }
 144
 145         if (schema && do_attribute_explicit(attrs, "dsSchemaClassCount")) {
 146                 struct dsdb_class *cur;
 147                 uint32_t n = 0;
 148
 149                 for (cur = schema->classes; cur; cur = cur->next) {
 150                         n++;
 151                 }
 152
 153                 if (ldb_msg_add_fmt(msg, "dsSchemaClassCount",
 154                                     "%u", n) != 0) {
 155                         goto failed;
 156                 }
 157         }
 158
 159         if (schema && do_attribute_explicit(attrs, "dsSchemaPrefixCount")) {
 160                 if (ldb_msg_add_fmt(msg, "dsSchemaPrefixCount",
 161                                     "%u", schema->num_prefixes) != 0) {
 162                         goto failed;
 163                 }
 164         }
 165
 166         if (do_attribute_explicit(attrs, "validFSMOs")) {
 167                 const struct dsdb_naming_fsmo *naming_fsmo;
 168                 const struct dsdb_pdc_fsmo *pdc_fsmo;
 169                 const char *dn_str;
 170
 171                 if (schema && schema->fsmo.we_are_master) {
 172                         dn_str = ldb_dn_get_linearized(samdb_schema_dn(module->ldb));
 173                         if (dn_str && dn_str[0]) {
 174                                 if (ldb_msg_add_fmt(msg, "validFSMOs", "%s", dn_str) != 0) {
 175                                         goto failed;
 176                                 }
 177                         }
 178                 }
 179
 180                 naming_fsmo = talloc_get_type(ldb_get_opaque(module->ldb, "dsdb_naming_fsmo"),
 181                                               struct dsdb_naming_fsmo);
 182                 if (naming_fsmo && naming_fsmo->we_are_master) {
 183                         dn_str = ldb_dn_get_linearized(samdb_partitions_dn(module->ldb, msg));
 184                         if (dn_str && dn_str[0]) {
 185                                 if (ldb_msg_add_fmt(msg, "validFSMOs", "%s", dn_str) != 0) {
 186                                         goto failed;
 187                                 }
 188                         }
 189                 }
 190
 191                 pdc_fsmo = talloc_get_type(ldb_get_opaque(module->ldb, "dsdb_pdc_fsmo"),
 192                                            struct dsdb_pdc_fsmo);
 193                 if (pdc_fsmo && pdc_fsmo->we_are_master) {
 194                         dn_str = ldb_dn_get_linearized(samdb_base_dn(module->ldb));
 195                         if (dn_str && dn_str[0]) {
 196                                 if (ldb_msg_add_fmt(msg, "validFSMOs", "%s", dn_str) != 0) {
 197                                         goto failed;
 198                                 }
 199                         }
 200                 }
 201         }
 202
 203         if (schema && do_attribute_explicit(attrs, "vendorVersion")) {
 204                 if (ldb_msg_add_fmt(msg, "vendorVersion",
 205                                     "%s", SAMBA_VERSION_STRING) != 0) {
 206                         goto failed;
 207                 }
 208         }
 209
 210         /* TODO: lots more dynamic attributes should be added here */
 211
 212         return LDB_SUCCESS;
 213
 214 failed:
 215         return LDB_ERR_OPERATIONS_ERROR;
 216 }
 217
 218 /*
 219   handle search requests
 220 */
 221
 222 struct rootdse_context {
 223         struct ldb_module *module;
 224         struct ldb_request *req;
 225 };
 226
 227 static struct rootdse_context *rootdse_init_context(struct ldb_module *module,
 228                                                     struct ldb_request *req)
 229 {
 230         struct rootdse_context *ac;
 231
 232         ac = talloc_zero(req, struct rootdse_context);
 233         if (ac == NULL) {
 234                 ldb_set_errstring(module->ldb, "Out of Memory");
 235                 return NULL;
 236         }
 237
 238         ac->module = module;
 239         ac->req = req;
 240
 241         return ac;
 242 }
 243
 244 static int rootdse_callback(struct ldb_request *req, struct ldb_reply *ares)
 245 {
 246         struct rootdse_context *ac;
 247         int ret;
 248
 249         ac = talloc_get_type(req->context, struct rootdse_context);
 250
 251         if (!ares) {
 252                 return ldb_module_done(ac->req, NULL, NULL,
 253                                         LDB_ERR_OPERATIONS_ERROR);
 254         }
 255         if (ares->error != LDB_SUCCESS) {
 256                 return ldb_module_done(ac->req, ares->controls,
 257                                         ares->response, ares->error);
 258         }
 259
 260         switch (ares->type) {
 261         case LDB_REPLY_ENTRY:
 262                 /*
 263                  * if the client explicit asks for the 'netlogon' attribute
 264                  * the reply_entry needs to be skipped
 265                  */
 266                 if (ac->req->op.search.attrs &&
 267                     ldb_attr_in_list(ac->req->op.search.attrs, "netlogon")) {
 268                         talloc_free(ares);
 269                         return LDB_SUCCESS;
 270                 }
 271
 272                 /* for each record returned post-process to add any dynamic
 273                    attributes that have been asked for */
 274                 ret = rootdse_add_dynamic(ac->module, ares->message,
 275                                           ac->req->op.search.attrs);
 276                 if (ret != LDB_SUCCESS) {
 277                         talloc_free(ares);
 278                         return ldb_module_done(ac->req, NULL, NULL, ret);
 279                 }
 280
 281                 return ldb_module_send_entry(ac->req, ares->message, ares->controls);
 282
 283         case LDB_REPLY_REFERRAL:
 284                 /* should we allow the backend to return referrals in this case
 285                  * ?? */
 286                 break;
 287
 288         case LDB_REPLY_DONE:
 289                 return ldb_module_done(ac->req, ares->controls,
 290                                         ares->response, ares->error);
 291         }
 292
 293         talloc_free(ares);
 294         return LDB_SUCCESS;
 295 }
 296
 297 static int rootdse_search(struct ldb_module *module, struct ldb_request *req)
 298 {
 299         struct rootdse_context *ac;
 300         struct ldb_request *down_req;
 301         int ret;
 302
 303         /* see if its for the rootDSE - only a base search on the "" DN qualifies */
 304         if (!(req->op.search.scope == LDB_SCOPE_BASE && ldb_dn_is_null(req->op.search.base))) {
 305                 /* Otherwise, pass down to the rest of the stack */
 306                 return ldb_next_request(module, req);
 307         }
 308
 309         ac = rootdse_init_context(module, req);
 310         if (ac == NULL) {
 311                 return LDB_ERR_OPERATIONS_ERROR;
 312         }
 313
 314         /* in our db we store the rootDSE with a DN of @ROOTDSE */
 315         ret = ldb_build_search_req(&down_req, module->ldb, ac,
 316                                         ldb_dn_new(ac, module->ldb, "@ROOTDSE"),
 317                                         LDB_SCOPE_BASE,
 318                                         NULL,
 319                                         req->op.search.attrs,
 320                                         NULL,/* for now skip the controls from the client */
 321                                         ac, rootdse_callback,
 322                                         req);
 323         if (ret != LDB_SUCCESS) {
 324                 return ret;
 325         }
 326
 327         return ldb_next_request(module, down_req);
 328 }
 329
 330 static int rootdse_register_control(struct ldb_module *module, struct ldb_request *req)
 331 {
 332         struct private_data *priv = talloc_get_type(module->private_data, struct private_data);
 333         char **list;
 334
 335         list = talloc_realloc(priv, priv->controls, char *, priv->num_controls + 1);
 336         if (!list) {
 337                 return LDB_ERR_OPERATIONS_ERROR;
 338         }
 339
 340         list[priv->num_controls] = talloc_strdup(list, req->op.reg_control.oid);
 341         if (!list[priv->num_controls]) {
 342                 return LDB_ERR_OPERATIONS_ERROR;
 343         }
 344
 345         priv->num_controls += 1;
 346         priv->controls = list;
 347
 348         return ldb_module_done(req, NULL, NULL, LDB_SUCCESS);
 349 }
 350
 351 static int rootdse_register_partition(struct ldb_module *module, struct ldb_request *req)
 352 {
 353         struct private_data *priv = talloc_get_type(module->private_data, struct private_data);
 354         struct ldb_dn **list;
 355
 356         list = talloc_realloc(priv, priv->partitions, struct ldb_dn *, priv->num_partitions + 1);
 357         if (!list) {
 358                 return LDB_ERR_OPERATIONS_ERROR;
 359         }
 360
 361         list[priv->num_partitions] = ldb_dn_copy(list, req->op.reg_partition.dn);
 362         if (!list[priv->num_partitions]) {
 363                 return LDB_ERR_OPERATIONS_ERROR;
 364         }
 365
 366         priv->num_partitions += 1;
 367         priv->partitions = list;
 368
 369         return ldb_module_done(req, NULL, NULL, LDB_SUCCESS);
 370 }
 371
 372
 373 static int rootdse_request(struct ldb_module *module, struct ldb_request *req)
 374 {
 375         switch (req->operation) {
 376
 377         case LDB_REQ_REGISTER_CONTROL:
 378                 return rootdse_register_control(module, req);
 379         case LDB_REQ_REGISTER_PARTITION:
 380                 return rootdse_register_partition(module, req);
 381
 382         default:
 383                 break;
 384         }
 385         return ldb_next_request(module, req);
 386 }
 387
 388 static int rootdse_init(struct ldb_module *module)
 389 {
 390         struct private_data *data;
 391
 392         data = talloc(module, struct private_data);
 393         if (data == NULL) {
 394                 return -1;
 395         }
 396
 397         data->num_controls = 0;
 398         data->controls = NULL;
 399         data->num_partitions = 0;
 400         data->partitions = NULL;
 401         module->private_data = data;
 402
 403         ldb_set_default_dns(module->ldb);
 404
 405         return ldb_next_init(module);
 406 }
 407
 408 static int rootdse_modify(struct ldb_module *module, struct ldb_request *req)
 409 {
 410         struct ldb_result *ext_res;
 411         int ret;
 412         struct ldb_dn *schema_dn;
 413         struct ldb_message_element *schemaUpdateNowAttr;
 414
 415         /*
 416                 If dn is not "" we should let it pass through
 417         */
 418         if (!ldb_dn_is_null(req->op.mod.message->dn)) {
 419                 return ldb_next_request(module, req);
 420         }
 421
 422         /*
 423                 dn is empty so check for schemaUpdateNow attribute
 424                 "The type of modification and values specified in the LDAP modify operation do not matter." MSDN
 425         */
 426         schemaUpdateNowAttr = ldb_msg_find_element(req->op.mod.message, "schemaUpdateNow");
 427         if (!schemaUpdateNowAttr) {
 428                 return LDB_ERR_OPERATIONS_ERROR;
 429         }
 430
 431         schema_dn = samdb_schema_dn(module->ldb);
 432         if (!schema_dn) {
 433                 ldb_reset_err_string(module->ldb);
 434                 ldb_debug(module->ldb, LDB_DEBUG_WARNING,
 435                           "rootdse_modify: no schema dn present: (skip ldb_extended call)\n");
 436                 return ldb_next_request(module, req);
 437         }
 438
 439         ret = ldb_extended(module->ldb, DSDB_EXTENDED_SCHEMA_UPDATE_NOW_OID, schema_dn, &ext_res);
 440         if (ret != LDB_SUCCESS) {
 441                 return LDB_ERR_OPERATIONS_ERROR;
 442         }
 443
 444         talloc_free(ext_res);
 445         return ret;
 446 }
 447
 448 _PUBLIC_ const struct ldb_module_ops ldb_rootdse_module_ops = {
 449         .name                   = "rootdse",
 450         .init_context   = rootdse_init,
 451         .search         = rootdse_search,
 452         .request                = rootdse_request,
 453         .modify         = rootdse_modify
 454 };