s4: fix few comment typos
[nivanova/samba.git] / source4 / dsdb / samdb / ldb_modules / objectclass_attrs.c
1 /*
2    ldb database library
3
4    Copyright (C) Simo Sorce  2006-2008
5    Copyright (C) Andrew Bartlett <abartlet@samba.org> 2005-2009
6    Copyright (C) Stefan Metzmacher 2009
7    Copyright (C) Matthias Dieter Wallnöfer 2010
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 Lesser General Public
20    License along with this library; if not, see <http://www.gnu.org/licenses/>.
21 */
22
23 /*
24  *  Name: ldb
25  *
26  *  Component: objectclass attribute checking module
27  *
28  *  Description: this checks the attributes on a directory entry (if they're
29  *    allowed, if the syntax is correct, if mandatory ones are missing,
30  *    denies the deletion of mandatory ones...). The module contains portions
31  *    of the "objectclass" and the "validate_update" LDB module.
32  *
33  *  Author: Matthias Dieter Wallnöfer
34  */
35
36 #include "includes.h"
37 #include "ldb_module.h"
38 #include "dsdb/samdb/samdb.h"
39
40 struct oc_context {
41
42         struct ldb_module *module;
43         struct ldb_request *req;
44         const struct dsdb_schema *schema;
45
46         struct ldb_reply *search_res;
47         struct ldb_reply *mod_ares;
48 };
49
50 static struct oc_context *oc_init_context(struct ldb_module *module,
51                                           struct ldb_request *req)
52 {
53         struct ldb_context *ldb;
54         struct oc_context *ac;
55
56         ldb = ldb_module_get_ctx(module);
57
58         ac = talloc_zero(req, struct oc_context);
59         if (ac == NULL) {
60                 ldb_oom(ldb);
61                 return NULL;
62         }
63
64         ac->module = module;
65         ac->req = req;
66         ac->schema = dsdb_get_schema(ldb, ac);
67
68         return ac;
69 }
70
71 static int oc_op_callback(struct ldb_request *req, struct ldb_reply *ares);
72
73 static int attr_handler(struct oc_context *ac)
74 {
75         struct ldb_context *ldb;
76         struct ldb_message *msg;
77         struct ldb_request *child_req;
78         const struct dsdb_attribute *attr;
79         unsigned int i;
80         int ret;
81         WERROR werr;
82         struct dsdb_syntax_ctx syntax_ctx;
83
84         ldb = ldb_module_get_ctx(ac->module);
85
86         if (ac->req->operation == LDB_ADD) {
87                 msg = ldb_msg_copy_shallow(ac, ac->req->op.add.message);
88         } else {
89                 msg = ldb_msg_copy_shallow(ac, ac->req->op.mod.message);
90         }
91         if (msg == NULL) {
92                 return ldb_oom(ldb);
93         }
94
95         /* initialize syntax checking context */
96         dsdb_syntax_ctx_init(&syntax_ctx, ldb, ac->schema);
97
98         /* Check if attributes exist in the schema, if the values match,
99          * if they're not operational and fix the names to the match the schema
100          * case */
101         for (i = 0; i < msg->num_elements; i++) {
102                 attr = dsdb_attribute_by_lDAPDisplayName(ac->schema,
103                                                          msg->elements[i].name);
104                 if (attr == NULL) {
105                         ldb_asprintf_errstring(ldb, "objectclass_attrs: attribute '%s' on entry '%s' was not found in the schema!",
106                                                msg->elements[i].name,
107                                                ldb_dn_get_linearized(msg->dn));
108                         return LDB_ERR_NO_SUCH_ATTRIBUTE;
109                 }
110
111                 if ((attr->linkID & 1) == 1) {
112                         /* Odd is for the target.  Illegal to modify */
113                         ldb_asprintf_errstring(ldb, 
114                                                "objectclass_attrs: attribute '%s' on entry '%s' must not be modified directly, it is a linked attribute", 
115                                                msg->elements[i].name,
116                                                ldb_dn_get_linearized(msg->dn));
117                         return LDB_ERR_UNWILLING_TO_PERFORM;
118                 }
119                 
120                 if (!(msg->elements[i].flags & LDB_FLAG_INTERNAL_DISABLE_VALIDATION)) {
121                         werr = attr->syntax->validate_ldb(&syntax_ctx, attr,
122                                                           &msg->elements[i]);
123                         if (!W_ERROR_IS_OK(werr)) {
124                                 ldb_asprintf_errstring(ldb, "objectclass_attrs: attribute '%s' on entry '%s' contains at least one invalid value!",
125                                                        msg->elements[i].name,
126                                                        ldb_dn_get_linearized(msg->dn));
127                                 return LDB_ERR_INVALID_ATTRIBUTE_SYNTAX;
128                         }
129                 }
130
131                 if ((attr->systemFlags & DS_FLAG_ATTR_IS_CONSTRUCTED) != 0) {
132                         ldb_asprintf_errstring(ldb, "objectclass_attrs: attribute '%s' on entry '%s' is constructed!",
133                                                msg->elements[i].name,
134                                                ldb_dn_get_linearized(msg->dn));
135                         if (ac->req->operation == LDB_ADD) {
136                                 return LDB_ERR_UNDEFINED_ATTRIBUTE_TYPE;
137                         } else {
138                                 return LDB_ERR_CONSTRAINT_VIOLATION;
139                         }
140                 }
141
142                 /* Substitute the attribute name to match in case */
143                 msg->elements[i].name = attr->lDAPDisplayName;
144         }
145
146         if (ac->req->operation == LDB_ADD) {
147                 ret = ldb_build_add_req(&child_req, ldb, ac,
148                                         msg, ac->req->controls,
149                                         ac, oc_op_callback, ac->req);
150         } else {
151                 ret = ldb_build_mod_req(&child_req, ldb, ac,
152                                         msg, ac->req->controls,
153                                         ac, oc_op_callback, ac->req);
154         }
155         if (ret != LDB_SUCCESS) {
156                 return ret;
157         }
158
159         return ldb_next_request(ac->module, child_req);
160 }
161
162 /*
163   these are attributes which are left over from old ways of doing
164   things in ldb, and are harmless
165  */
166 static const char *harmless_attrs[] = { "parentGUID", NULL };
167
168 static int attr_handler2(struct oc_context *ac)
169 {
170         struct ldb_context *ldb;
171         struct ldb_message_element *oc_element;
172         struct ldb_message *msg;
173         const char **must_contain, **may_contain, **found_must_contain;
174         const struct dsdb_attribute *attr;
175         unsigned int i;
176         bool found;
177
178         ldb = ldb_module_get_ctx(ac->module);
179
180         if (ac->search_res == NULL) {
181                 return ldb_operr(ldb);
182         }
183
184         /* We rely here on the preceding "objectclass" LDB module which did
185          * already fix up the objectclass list (inheritance, order...). */
186         oc_element = ldb_msg_find_element(ac->search_res->message,
187                                           "objectClass");
188         if (oc_element == NULL) {
189                 return ldb_operr(ldb);
190         }
191
192         must_contain = dsdb_full_attribute_list(ac, ac->schema, oc_element,
193                                                 DSDB_SCHEMA_ALL_MUST);
194         may_contain =  dsdb_full_attribute_list(ac, ac->schema, oc_element,
195                                                 DSDB_SCHEMA_ALL_MAY);
196         found_must_contain = const_str_list(str_list_copy(ac, must_contain));
197         if ((must_contain == NULL) || (may_contain == NULL)
198             || (found_must_contain == NULL)) {
199                 return ldb_operr(ldb);
200         }
201
202         /* Check if all specified attributes are valid in the given
203          * objectclasses and if they meet additional schema restrictions. */
204         msg = ac->search_res->message;
205         for (i = 0; i < msg->num_elements; i++) {
206                 attr = dsdb_attribute_by_lDAPDisplayName(ac->schema,
207                                                          msg->elements[i].name);
208                 if (attr == NULL) {
209                         return ldb_operr(ldb);
210                 }
211
212                 /* Check if they're single-valued if this is requested */
213                 if ((msg->elements[i].num_values > 1) && (attr->isSingleValued)) {
214                         ldb_asprintf_errstring(ldb, "objectclass_attrs: attribute '%s' on entry '%s' is single-valued!",
215                                                msg->elements[i].name,
216                                                ldb_dn_get_linearized(msg->dn));
217                         if (ac->req->operation == LDB_ADD) {
218                                 return LDB_ERR_CONSTRAINT_VIOLATION;
219                         } else {
220                                 return LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS;
221                         }
222                 }
223
224                 /* We can use "str_list_check" with "strcmp" here since the
225                  * attribute informations from the schema are always equal
226                  * up-down-cased. */
227                 found = str_list_check(must_contain, attr->lDAPDisplayName);
228                 if (found) {
229                         str_list_remove(found_must_contain, attr->lDAPDisplayName);
230                 } else {
231                         found = str_list_check(may_contain, attr->lDAPDisplayName);
232                 }
233                 if (!found) {
234                         found = str_list_check(harmless_attrs, attr->lDAPDisplayName);
235                 }
236                 if (!found) {
237                         ldb_asprintf_errstring(ldb, "objectclass_attrs: attribute '%s' on entry '%s' does not exist in the specified objectclasses!",
238                                                msg->elements[i].name,
239                                                ldb_dn_get_linearized(msg->dn));
240                         return LDB_ERR_OBJECT_CLASS_VIOLATION;
241                 }
242         }
243
244         if (found_must_contain[0] != NULL) {
245                 ldb_asprintf_errstring(ldb, "objectclass_attrs: at least one mandatory attribute ('%s') on entry '%s' wasn't specified!",
246                                        found_must_contain[0],
247                                        ldb_dn_get_linearized(msg->dn));
248                 return LDB_ERR_OBJECT_CLASS_VIOLATION;
249         }
250
251         return ldb_module_done(ac->req, ac->mod_ares->controls,
252                                ac->mod_ares->response, LDB_SUCCESS);
253 }
254
255 static int get_search_callback(struct ldb_request *req, struct ldb_reply *ares)
256 {
257         struct ldb_context *ldb;
258         struct oc_context *ac;
259         int ret;
260
261         ac = talloc_get_type(req->context, struct oc_context);
262         ldb = ldb_module_get_ctx(ac->module);
263
264         if (!ares) {
265                 return ldb_module_done(ac->req, NULL, NULL,
266                                        LDB_ERR_OPERATIONS_ERROR);
267         }
268         if (ares->error != LDB_SUCCESS) {
269                 return ldb_module_done(ac->req, ares->controls,
270                                        ares->response, ares->error);
271         }
272
273         ldb_reset_err_string(ldb);
274
275         switch (ares->type) {
276         case LDB_REPLY_ENTRY:
277                 if (ac->search_res != NULL) {
278                         ldb_set_errstring(ldb, "Too many results");
279                         talloc_free(ares);
280                         return ldb_module_done(ac->req, NULL, NULL,
281                                                LDB_ERR_OPERATIONS_ERROR);
282                 }
283
284                 ac->search_res = talloc_steal(ac, ares);
285                 break;
286
287         case LDB_REPLY_REFERRAL:
288                 /* ignore */
289                 talloc_free(ares);
290                 break;
291
292         case LDB_REPLY_DONE:
293                 talloc_free(ares);
294                 ret = attr_handler2(ac);
295                 if (ret != LDB_SUCCESS) {
296                         return ldb_module_done(ac->req, NULL, NULL, ret);
297                 }
298                 break;
299         }
300
301         return LDB_SUCCESS;
302 }
303
304 static int oc_op_callback(struct ldb_request *req, struct ldb_reply *ares)
305 {
306         struct oc_context *ac;
307         struct ldb_context *ldb;
308         struct ldb_request *search_req;
309         struct ldb_dn *base_dn;
310         int ret;
311
312         ac = talloc_get_type(req->context, struct oc_context);
313         ldb = ldb_module_get_ctx(ac->module);
314
315         if (!ares) {
316                 return ldb_module_done(ac->req, NULL, NULL,
317                                        LDB_ERR_OPERATIONS_ERROR);
318         }
319
320         if (ares->type == LDB_REPLY_REFERRAL) {
321                 return ldb_module_send_referral(ac->req, ares->referral);
322         }
323
324         if (ares->error != LDB_SUCCESS) {
325                 return ldb_module_done(ac->req, ares->controls, ares->response,
326                                        ares->error);
327         }
328
329         if (ares->type != LDB_REPLY_DONE) {
330                 talloc_free(ares);
331                 return ldb_module_done(ac->req, NULL, NULL,
332                                        LDB_ERR_OPERATIONS_ERROR);
333         }
334
335         ac->search_res = NULL;
336         ac->mod_ares = talloc_steal(ac, ares);
337
338         /* This looks up all attributes of our just added/modified entry */
339         base_dn = ac->req->operation == LDB_ADD ? ac->req->op.add.message->dn
340                 : ac->req->op.mod.message->dn;
341         ret = ldb_build_search_req(&search_req, ldb, ac, base_dn,
342                                    LDB_SCOPE_BASE, "(objectClass=*)",
343                                    NULL, NULL, ac,
344                                    get_search_callback, ac->req);
345         if (ret != LDB_SUCCESS) {
346                 return ldb_module_done(ac->req, NULL, NULL, ret);
347         }
348
349         ret = ldb_request_add_control(search_req, LDB_CONTROL_SHOW_DELETED_OID,
350                                       true, NULL);
351         if (ret != LDB_SUCCESS) {
352                 return ldb_module_done(ac->req, NULL, NULL, ret);
353         }
354
355         ret = ldb_next_request(ac->module, search_req);
356         if (ret != LDB_SUCCESS) {
357                 return ldb_module_done(ac->req, NULL, NULL, ret);
358         }
359
360         /* "ldb_module_done" isn't called here since we need to do additional
361          * checks. It is called at the end of "attr_handler2". */
362         return LDB_SUCCESS;
363 }
364
365 static int objectclass_attrs_add(struct ldb_module *module,
366                                  struct ldb_request *req)
367 {
368         struct ldb_context *ldb;
369         struct oc_context *ac;
370
371         ldb = ldb_module_get_ctx(module);
372
373         ldb_debug(ldb, LDB_DEBUG_TRACE, "objectclass_attrs_add\n");
374
375         /* do not manipulate our control entries */
376         if (ldb_dn_is_special(req->op.add.message->dn)) {
377                 return ldb_next_request(module, req);
378         }
379
380         ac = oc_init_context(module, req);
381         if (ac == NULL) {
382                 return ldb_operr(ldb);
383         }
384
385         /* without schema, there isn't much to do here */
386         if (ac->schema == NULL) {
387                 talloc_free(ac);
388                 return ldb_next_request(module, req);
389         }
390
391         return attr_handler(ac);
392 }
393
394 static int objectclass_attrs_modify(struct ldb_module *module,
395                                     struct ldb_request *req)
396 {
397         struct ldb_context *ldb;
398         struct oc_context *ac;
399
400         ldb = ldb_module_get_ctx(module);
401
402         ldb_debug(ldb, LDB_DEBUG_TRACE, "objectclass_attrs_modify\n");
403
404         /* do not manipulate our control entries */
405         if (ldb_dn_is_special(req->op.mod.message->dn)) {
406                 return ldb_next_request(module, req);
407         }
408
409         ac = oc_init_context(module, req);
410         if (ac == NULL) {
411                 return ldb_operr(ldb);
412         }
413
414         /* without schema, there isn't much to do here */
415         if (ac->schema == NULL) {
416                 talloc_free(ac);
417                 return ldb_next_request(module, req);
418         }
419
420         return attr_handler(ac);
421 }
422
423 _PUBLIC_ const struct ldb_module_ops ldb_objectclass_attrs_module_ops = {
424         .name              = "objectclass_attrs",
425         .add               = objectclass_attrs_add,
426         .modify            = objectclass_attrs_modify
427 };