2 Samba4 module loading module
4 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2009
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.
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.
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/>.
23 * Component: Samba4 module loading module
25 * Description: Implement a single 'module' in the ldb database,
26 * which loads the remaining modules based on 'choice of configuration' attributes
28 * This is to avoid forcing a reprovision of the ldb databases when we change the internal structure of the code
30 * Author: Andrew Bartlett
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"
39 #include "dsdb/samdb/ldb_modules/util.h"
40 #include "dsdb/samdb/samdb.h"
42 static int read_at_rootdse_record(struct ldb_context
*ldb
, struct ldb_module
*module
, TALLOC_CTX
*mem_ctx
,
43 struct ldb_message
**msg
)
46 static const char *rootdse_attrs
[] = { "defaultNamingContext", "configurationNamingContext", "schemaNamingContext", NULL
};
47 struct ldb_result
*rootdse_res
;
48 struct ldb_dn
*rootdse_dn
;
49 TALLOC_CTX
*tmp_ctx
= talloc_new(mem_ctx
);
52 return LDB_ERR_OPERATIONS_ERROR
;
55 rootdse_dn
= ldb_dn_new(tmp_ctx
, ldb
, "@ROOTDSE");
59 return LDB_ERR_OPERATIONS_ERROR
;
62 ret
= dsdb_module_search_dn(module
, tmp_ctx
, &rootdse_res
, rootdse_dn
, rootdse_attrs
, 0);
63 if (ret
!= LDB_SUCCESS
) {
68 talloc_steal(mem_ctx
, rootdse_res
->msgs
);
69 *msg
= rootdse_res
->msgs
[0];
76 static int prepare_modules_line(struct ldb_context
*ldb
,
78 const struct ldb_message
*rootdse_msg
,
79 struct ldb_message
*msg
, const char *backend_attr
,
80 const char *backend_mod
, const char **backend_mod_list
)
83 const char **backend_full_list
;
84 const char *backend_dn
;
85 char *mod_list_string
;
87 TALLOC_CTX
*tmp_ctx
= talloc_new(mem_ctx
);
90 return LDB_ERR_OPERATIONS_ERROR
;
94 backend_dn
= ldb_msg_find_attr_as_string(rootdse_msg
, backend_attr
, NULL
);
96 ldb_asprintf_errstring(ldb
,
98 "unable to read %s from %s:%s",
99 backend_attr
, ldb_dn_get_linearized(rootdse_msg
->dn
),
101 return LDB_ERR_CONSTRAINT_VIOLATION
;
108 backend_full_list
= (const char **)str_list_make_single(tmp_ctx
, backend_mod
);
110 backend_full_list
= (const char **)str_list_make_empty(tmp_ctx
);
112 if (!backend_full_list
) {
113 talloc_free(tmp_ctx
);
115 return LDB_ERR_OPERATIONS_ERROR
;
118 backend_full_list
= str_list_append_const(backend_full_list
, backend_mod_list
);
119 if (!backend_full_list
) {
120 talloc_free(tmp_ctx
);
122 return LDB_ERR_OPERATIONS_ERROR
;
125 mod_list_string
= str_list_join(tmp_ctx
, backend_full_list
, ',');
126 if (!mod_list_string
) {
127 talloc_free(tmp_ctx
);
129 return LDB_ERR_OPERATIONS_ERROR
;
132 full_string
= talloc_asprintf(tmp_ctx
, "%s:%s", backend_dn
, mod_list_string
);
133 ret
= ldb_msg_add_steal_string(msg
, "modules", full_string
);
134 talloc_free(tmp_ctx
);
138 static int samba_dsdb_init(struct ldb_module
*module
)
140 struct ldb_context
*ldb
= ldb_module_get_ctx(module
);
142 TALLOC_CTX
*tmp_ctx
= talloc_new(module
);
143 struct ldb_result
*res
;
144 struct ldb_message
*rootdse_msg
, *partition_msg
;
145 struct ldb_dn
*samba_dsdb_dn
;
146 struct ldb_module
*backend_module
, *module_chain
;
147 const char **final_module_list
, **reverse_module_list
;
149 Add modules to the list to activate them by default
150 beware often order is important
152 Some Known ordering constraints:
153 - rootdse must be first, as it makes redirects from "" -> cn=rootdse
154 - extended_dn_in must be before objectclass.c, as it resolves the DN
155 - objectclass must be before password_hash, because password_hash checks
156 that the objectclass is of type person (filled in by objectclass
157 module when expanding the objectclass list)
158 - partition must be last
159 - each partition has its own module list then
161 The list is presented here as a set of declarations to show the
162 stack visually - the code below then handles the creation of the list
163 based on the parameters loaded from the database.
165 static const char *modules_list
[] = {"resolve_oids",
187 const char *objectguid_module
;
188 /* if serverrole == "domain controller": */
189 const char *repl_meta_data
= "repl_meta_data";
191 const char *objectguid
= "objectguid";
193 const char **link_modules
;
194 static const char *tdb_modules_list
[] = {
200 const char *extended_dn_module
;
201 const char *extended_dn_module_ldb
= "extended_dn_out_ldb";
202 const char *extended_dn_module_fds
= "extended_dn_out_ldb";
203 const char *extended_dn_module_openldap
= "extended_dn_out_ldb";
205 static const char *modules_list2
[] = {"show_deleted",
210 const char **backend_modules
;
211 static const char *fedora_ds_backend_modules
[] = {
212 "nsuniqueid", "paged_searches", NULL
};
213 static const char *openldap_backend_modules
[] = {
214 "nsuniqueid", "paged_searches", NULL
};
216 static const char *samba_dsdb_attrs
[] = { "backendType", "serverRole", NULL
};
217 const char *backendType
, *serverRole
;
221 return LDB_ERR_OPERATIONS_ERROR
;
224 samba_dsdb_dn
= ldb_dn_new(tmp_ctx
, ldb
, "@SAMBA_DSDB");
225 if (!samba_dsdb_dn
) {
226 talloc_free(tmp_ctx
);
228 return LDB_ERR_OPERATIONS_ERROR
;
231 #define CHECK_LDB_RET(check_ret) \
233 if (check_ret != LDB_SUCCESS) { \
234 talloc_free(tmp_ctx); \
239 ret
= dsdb_module_search_dn(module
, tmp_ctx
, &res
, samba_dsdb_dn
, samba_dsdb_attrs
, 0);
240 if (ret
!= LDB_SUCCESS
) {
241 talloc_free(tmp_ctx
);
245 backendType
= ldb_msg_find_attr_as_string(res
->msgs
[0], "backendType", "ldb");
246 serverRole
= ldb_msg_find_attr_as_string(res
->msgs
[0], "serverRole", NULL
);
248 backend_modules
= NULL
;
249 if (strcasecmp(backendType
, "ldb") == 0) {
250 if (strcasecmp(serverRole
, "dc") == 0 || strcasecmp(serverRole
, "domain controller") == 0) {
251 objectguid_module
= repl_meta_data
;
253 objectguid_module
= objectguid
;
255 extended_dn_module
= extended_dn_module_ldb
;
256 link_modules
= tdb_modules_list
;
258 objectguid_module
= NULL
;
260 if (strcasecmp(backendType
, "fedora-ds")) {
261 backend_modules
= fedora_ds_backend_modules
;
262 extended_dn_module
= extended_dn_module_fds
;
263 } else if (strcasecmp(backendType
, "openldap")) {
264 backend_modules
= openldap_backend_modules
;
265 extended_dn_module
= extended_dn_module_openldap
;
269 #define CHECK_MODULE_LIST \
271 if (!final_module_list) { \
272 talloc_free(tmp_ctx); \
274 return LDB_ERR_OPERATIONS_ERROR; \
278 final_module_list
= str_list_copy_const(tmp_ctx
, modules_list
);
281 final_module_list
= str_list_add_const(final_module_list
, objectguid_module
);
284 final_module_list
= str_list_append_const(final_module_list
, link_modules
);
287 final_module_list
= str_list_add_const(final_module_list
, extended_dn_module
);
290 final_module_list
= str_list_append_const(final_module_list
, modules_list2
);
294 ret
= read_at_rootdse_record(ldb
, module
, tmp_ctx
, &rootdse_msg
);
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
);
300 ret
= prepare_modules_line(ldb
, tmp_ctx
,
302 partition_msg
, "defaultNamingContext",
303 "pdc_fsmo", backend_modules
);
306 ret
= prepare_modules_line(ldb
, tmp_ctx
,
308 partition_msg
, "configurationNamingContext",
309 "naming_fsmo", backend_modules
);
312 ret
= prepare_modules_line(ldb
, tmp_ctx
,
314 partition_msg
, "schemaNamingContext",
315 "schema_data", backend_modules
);
318 ret
= prepare_modules_line(ldb
, tmp_ctx
,
321 NULL
, backend_modules
);
324 ret
= ldb_set_opaque(ldb
, DSDB_OPAQUE_PARTITION_MODULE_MSG_OPAQUE_NAME
, partition_msg
);
327 talloc_steal(ldb
, partition_msg
);
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 */};
332 reverse_module_list
= talloc_array(tmp_ctx
, const char *, len
+1);
333 if (!reverse_module_list
) {
334 talloc_free(tmp_ctx
);
336 return LDB_ERR_OPERATIONS_ERROR
;
338 for (i
=0; i
< len
; i
++) {
339 reverse_module_list
[i
] = final_module_list
[(len
- 1) - i
];
341 reverse_module_list
[i
] = NULL
;
343 /* The backend (at least until the partitions module
344 * reconfigures things) is the next module in the currently
346 backend_module
= module
->next
;
347 ret
= ldb_load_modules_list(ldb
, reverse_module_list
, backend_module
, &module_chain
);
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
;
354 return ldb_next_init(module
);
357 const struct ldb_module_ops ldb_samba_dsdb_module_ops
= {
358 .name
= "samba_dsdb",
359 .init_context
= samba_dsdb_init
,