s4-dsdb: added DSDB_FLAG_OWN_MODULE
[amitay/samba.git] / source4 / dsdb / samdb / ldb_modules / util.c
1 /* 
2    Unix SMB/CIFS implementation.
3    Samba utility functions
4
5    Copyright (C) Andrew Tridgell 2009
6    Copyright (C) Andrew Bartlett <abartlet@samba.org> 2009
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
20 */
21
22 #include "includes.h"
23 #include "ldb.h"
24 #include "ldb_module.h"
25 #include "librpc/ndr/libndr.h"
26 #include "dsdb/samdb/ldb_modules/util.h"
27 #include "dsdb/samdb/samdb.h"
28 #include "util.h"
29
30 /*
31   add a set of controls to a ldb_request structure based on a set of
32   flags. See util.h for a list of available flags
33  */
34 int dsdb_request_add_controls(struct ldb_module *module, struct ldb_request *req, uint32_t dsdb_flags)
35 {
36         int ret;
37         if (dsdb_flags & DSDB_SEARCH_SEARCH_ALL_PARTITIONS) {
38                 struct ldb_search_options_control *options;
39                 /* Using the phantom root control allows us to search all partitions */
40                 options = talloc(req, struct ldb_search_options_control);
41                 if (options == NULL) {
42                         ldb_module_oom(module);
43                         return LDB_ERR_OPERATIONS_ERROR;
44                 }
45                 options->search_options = LDB_SEARCH_OPTION_PHANTOM_ROOT;
46                 
47                 ret = ldb_request_add_control(req,
48                                               LDB_CONTROL_SEARCH_OPTIONS_OID,
49                                               true, options);
50                 if (ret != LDB_SUCCESS) {
51                         return ret;
52                 }
53         }
54
55         if (dsdb_flags & DSDB_SEARCH_SHOW_DELETED) {
56                 ret = ldb_request_add_control(req, LDB_CONTROL_SHOW_DELETED_OID, true, NULL);
57                 if (ret != LDB_SUCCESS) {
58                         return ret;
59                 }
60         }
61
62         if (dsdb_flags & DSDB_SEARCH_SHOW_DN_IN_STORAGE_FORMAT) {
63                 ret = ldb_request_add_control(req, DSDB_CONTROL_DN_STORAGE_FORMAT_OID, true, NULL);
64                 if (ret != LDB_SUCCESS) {
65                         return ret;
66                 }
67         }
68
69         if (dsdb_flags & DSDB_SEARCH_SHOW_EXTENDED_DN) {
70                 struct ldb_extended_dn_control *extended_ctrl = talloc(req, struct ldb_extended_dn_control);
71                 if (!extended_ctrl) {
72                         ldb_module_oom(module);
73                         return LDB_ERR_OPERATIONS_ERROR;
74                 }
75                 extended_ctrl->type = 1;
76                 
77                 ret = ldb_request_add_control(req, LDB_CONTROL_EXTENDED_DN_OID, true, extended_ctrl);
78                 if (ret != LDB_SUCCESS) {
79                         return ret;
80                 }
81         }
82
83         if (dsdb_flags & DSDB_SEARCH_REVEAL_INTERNALS) {
84                 ret = ldb_request_add_control(req, LDB_CONTROL_REVEAL_INTERNALS, false, NULL);
85                 if (ret != LDB_SUCCESS) {
86                         return ret;
87                 }
88         }
89
90         if (dsdb_flags & DSDB_MODIFY_RELAX) {
91                 ret = ldb_request_add_control(req, LDB_CONTROL_RELAX_OID, false, NULL);
92                 if (ret != LDB_SUCCESS) {
93                         return ret;
94                 }
95         }
96
97         return LDB_SUCCESS;
98 }
99
100 /*
101   search for attrs on one DN, in the modules below
102  */
103 int dsdb_module_search_dn(struct ldb_module *module,
104                           TALLOC_CTX *mem_ctx,
105                           struct ldb_result **_res,
106                           struct ldb_dn *basedn,
107                           const char * const *attrs,
108                           uint32_t dsdb_flags)
109 {
110         int ret;
111         struct ldb_request *req;
112         TALLOC_CTX *tmp_ctx;
113         struct ldb_result *res;
114
115         tmp_ctx = talloc_new(mem_ctx);
116
117         res = talloc_zero(tmp_ctx, struct ldb_result);
118         if (!res) {
119                 return LDB_ERR_OPERATIONS_ERROR;
120         }
121
122         ret = ldb_build_search_req(&req, ldb_module_get_ctx(module), tmp_ctx,
123                                    basedn,
124                                    LDB_SCOPE_BASE,
125                                    NULL,
126                                    attrs,
127                                    NULL,
128                                    res,
129                                    ldb_search_default_callback,
130                                    NULL);
131         if (ret != LDB_SUCCESS) {
132                 talloc_free(tmp_ctx);
133                 return ret;
134         }
135
136         ret = dsdb_request_add_controls(module, req, dsdb_flags);
137         if (ret != LDB_SUCCESS) {
138                 talloc_free(tmp_ctx);
139                 return ret;
140         }
141
142         ret = ldb_next_request(module, req);
143         if (ret == LDB_SUCCESS) {
144                 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
145         }
146
147         if (ret != LDB_SUCCESS) {
148                 talloc_free(tmp_ctx);
149                 return ret;
150         }
151
152         if (res->count != 1) {
153                 /* we may be reading a DB that does not have the 'check base on search' option... */
154                 ret = LDB_ERR_NO_SUCH_OBJECT;
155                 ldb_asprintf_errstring(ldb_module_get_ctx(module), 
156                                        "dsdb_module_search_dn: did not find base dn %s (%d results)", 
157                                        ldb_dn_get_linearized(basedn), res->count);
158         } else {
159                 *_res = talloc_steal(mem_ctx, res);
160         }
161         talloc_free(tmp_ctx);
162         return ret;
163 }
164
165 /*
166   search for attrs in the modules below
167  */
168 int dsdb_module_search(struct ldb_module *module,
169                        TALLOC_CTX *mem_ctx,
170                        struct ldb_result **_res,
171                        struct ldb_dn *basedn, enum ldb_scope scope, 
172                        const char * const *attrs,
173                        int dsdb_flags, 
174                        const char *format, ...) _PRINTF_ATTRIBUTE(8, 9)
175 {
176         int ret;
177         struct ldb_request *req;
178         TALLOC_CTX *tmp_ctx;
179         struct ldb_result *res;
180         va_list ap;
181         char *expression;
182
183         tmp_ctx = talloc_new(mem_ctx);
184
185         va_start(ap, format);
186         expression = talloc_vasprintf(tmp_ctx, format, ap);
187         va_end(ap);
188
189         res = talloc_zero(tmp_ctx, struct ldb_result);
190         if (!res) {
191                 return LDB_ERR_OPERATIONS_ERROR;
192         }
193
194         ret = ldb_build_search_req(&req, ldb_module_get_ctx(module), tmp_ctx,
195                                    basedn,
196                                    scope,
197                                    expression,
198                                    attrs,
199                                    NULL,
200                                    res,
201                                    ldb_search_default_callback,
202                                    NULL);
203         if (ret != LDB_SUCCESS) {
204                 talloc_free(tmp_ctx);
205                 return ret;
206         }
207
208         ret = dsdb_request_add_controls(module, req, dsdb_flags);
209         if (ret != LDB_SUCCESS) {
210                 talloc_free(tmp_ctx);
211                 return ret;
212         }
213
214         if (dsdb_flags & DSDB_FLAG_OWN_MODULE) {
215                 const struct ldb_module_ops *ops = ldb_module_get_ops(module);
216                 ret = ops->search(module, req);
217         } else {
218                 ret = ldb_next_request(module, req);
219         }
220         if (ret == LDB_SUCCESS) {
221                 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
222         }
223
224         talloc_free(req);
225         if (ret == LDB_SUCCESS) {
226                 *_res = talloc_steal(mem_ctx, res);
227         }
228         talloc_free(tmp_ctx);
229         return ret;
230 }
231
232 /*
233   find a DN given a GUID. This searches across all partitions
234  */
235 int dsdb_module_dn_by_guid(struct ldb_module *module, TALLOC_CTX *mem_ctx,
236                            const struct GUID *guid, struct ldb_dn **dn)
237 {
238         struct ldb_result *res;
239         const char *attrs[] = { NULL };
240         TALLOC_CTX *tmp_ctx = talloc_new(mem_ctx);
241         int ret;
242
243         ret = dsdb_module_search(module, tmp_ctx, &res, NULL, LDB_SCOPE_SUBTREE,
244                                  attrs,
245                                  DSDB_SEARCH_SHOW_DELETED |
246                                  DSDB_SEARCH_SEARCH_ALL_PARTITIONS |
247                                  DSDB_SEARCH_SHOW_DN_IN_STORAGE_FORMAT,
248                                  "objectGUID=%s", GUID_string(tmp_ctx, guid));
249         if (ret != LDB_SUCCESS) {
250                 talloc_free(tmp_ctx);
251                 return ret;
252         }
253         if (res->count == 0) {
254                 talloc_free(tmp_ctx);
255                 return LDB_ERR_NO_SUCH_OBJECT;
256         }
257         if (res->count != 1) {
258                 ldb_asprintf_errstring(ldb_module_get_ctx(module), "More than one object found matching objectGUID %s\n",
259                                        GUID_string(tmp_ctx, guid));
260                 talloc_free(tmp_ctx);
261                 return LDB_ERR_OPERATIONS_ERROR;
262         }
263
264         *dn = talloc_steal(mem_ctx, res->msgs[0]->dn);
265
266         talloc_free(tmp_ctx);
267         return LDB_SUCCESS;
268 }
269
270 /*
271   find a GUID given a DN.
272  */
273 int dsdb_module_guid_by_dn(struct ldb_module *module, struct ldb_dn *dn, struct GUID *guid)
274 {
275         const char *attrs[] = { NULL };
276         struct ldb_result *res;
277         TALLOC_CTX *tmp_ctx = talloc_new(module);
278         int ret;
279         NTSTATUS status;
280
281         ret = dsdb_module_search_dn(module, tmp_ctx, &res, dn, attrs,
282                                     DSDB_SEARCH_SHOW_DELETED|
283                                     DSDB_SEARCH_SHOW_EXTENDED_DN);
284         if (ret != LDB_SUCCESS) {
285                 ldb_asprintf_errstring(ldb_module_get_ctx(module), "Failed to find GUID for %s",
286                                        ldb_dn_get_linearized(dn));
287                 talloc_free(tmp_ctx);
288                 return ret;
289         }
290
291         status = dsdb_get_extended_dn_guid(res->msgs[0]->dn, guid, "GUID");
292         if (!NT_STATUS_IS_OK(status)) {
293                 talloc_free(tmp_ctx);
294                 return LDB_ERR_OPERATIONS_ERROR;
295         }
296
297         talloc_free(tmp_ctx);
298         return LDB_SUCCESS;
299 }
300
301 /*
302   a ldb_modify request operating on modules below the
303   current module
304  */
305 int dsdb_module_modify(struct ldb_module *module,
306                        const struct ldb_message *message,
307                        uint32_t dsdb_flags)
308 {
309         struct ldb_request *mod_req;
310         int ret;
311         struct ldb_context *ldb = ldb_module_get_ctx(module);
312         TALLOC_CTX *tmp_ctx = talloc_new(module);
313
314         ret = ldb_build_mod_req(&mod_req, ldb, tmp_ctx,
315                                 message,
316                                 NULL,
317                                 NULL,
318                                 ldb_op_default_callback,
319                                 NULL);
320         if (ret != LDB_SUCCESS) {
321                 talloc_free(tmp_ctx);
322                 return ret;
323         }
324
325         ret = dsdb_request_add_controls(module, mod_req, dsdb_flags);
326         if (ret != LDB_SUCCESS) {
327                 talloc_free(tmp_ctx);
328                 return ret;
329         }
330
331         /* Run the new request */
332         if (dsdb_flags & DSDB_FLAG_OWN_MODULE) {
333                 const struct ldb_module_ops *ops = ldb_module_get_ops(module);
334                 ret = ops->modify(module, mod_req);
335         } else {
336                 ret = ldb_next_request(module, mod_req);
337         }
338         if (ret == LDB_SUCCESS) {
339                 ret = ldb_wait(mod_req->handle, LDB_WAIT_ALL);
340         }
341
342         talloc_free(tmp_ctx);
343         return ret;
344 }
345
346
347
348 /*
349   a ldb_rename request operating on modules below the
350   current module
351  */
352 int dsdb_module_rename(struct ldb_module *module,
353                       struct ldb_dn *olddn, struct ldb_dn *newdn,
354                       uint32_t dsdb_flags)
355 {
356         struct ldb_request *req;
357         int ret;
358         struct ldb_context *ldb = ldb_module_get_ctx(module);
359         TALLOC_CTX *tmp_ctx = talloc_new(module);
360
361         ret = ldb_build_rename_req(&req, ldb, tmp_ctx,
362                                    olddn,
363                                    newdn,
364                                    NULL,
365                                    NULL,
366                                    ldb_op_default_callback,
367                                    NULL);
368         if (ret != LDB_SUCCESS) {
369                 talloc_free(tmp_ctx);
370                 return ret;
371         }
372
373         ret = dsdb_request_add_controls(module, req, dsdb_flags);
374         if (ret != LDB_SUCCESS) {
375                 talloc_free(tmp_ctx);
376                 return ret;
377         }
378
379         /* Run the new request */
380         if (dsdb_flags & DSDB_FLAG_OWN_MODULE) {
381                 const struct ldb_module_ops *ops = ldb_module_get_ops(module);
382                 ret = ops->rename(module, req);
383         } else {
384                 ret = ldb_next_request(module, req);
385         }
386         if (ret == LDB_SUCCESS) {
387                 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
388         }
389
390         talloc_free(tmp_ctx);
391         return ret;
392 }
393
394 const struct dsdb_class * get_last_structural_class(const struct dsdb_schema *schema,const struct ldb_message_element *element)
395 {
396         const struct dsdb_class *last_class = NULL;
397         int i;
398
399         for (i = 0; i < element->num_values; i++){
400                 const struct dsdb_class *tmp_class = dsdb_class_by_lDAPDisplayName_ldb_val(schema, &element->values[i]);
401
402                 if(tmp_class == NULL) {
403                         continue;
404                 }
405
406                 if(tmp_class->objectClassCategory == 3) {
407                         continue;
408                 }
409
410                 if (!last_class) {
411                         last_class = tmp_class;
412                 } else {
413                         if (tmp_class->subClass_order > last_class->subClass_order)
414                                 last_class = tmp_class;
415                 }
416         }
417
418         return last_class;
419 }
420
421 /*
422   check if a single valued link has multiple non-deleted values
423
424   This is needed when we will be using the RELAX control to stop
425   ldb_tdb from checking single valued links
426  */
427 int dsdb_check_single_valued_link(const struct dsdb_attribute *attr,
428                                   const struct ldb_message_element *el)
429 {
430         bool found_active = false;
431         int i;
432
433         if (!(attr->ldb_schema_attribute->flags & LDB_ATTR_FLAG_SINGLE_VALUE) ||
434             el->num_values < 2) {
435                 return LDB_SUCCESS;
436         }
437
438         for (i=0; i<el->num_values; i++) {
439                 if (!dsdb_dn_is_deleted_val(&el->values[i])) {
440                         if (found_active) {
441                                 return LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS;
442                         }
443                         found_active = true;
444                 }
445         }
446
447         return LDB_SUCCESS;
448 }