4 Copyright (C) Simo Sorce 2006-2008
5 Copyright (C) Nadezhda Ivanova 2010
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * Component: ldb ACL Read module
26 * Description: Module that performs authorisation access checks on read requests
27 * Only DACL checks implemented at this point
29 * Author: Nadezhda Ivanova
33 #include "ldb_module.h"
34 #include "auth/auth.h"
35 #include "libcli/security/security.h"
36 #include "dsdb/samdb/samdb.h"
37 #include "librpc/gen_ndr/ndr_security.h"
38 #include "param/param.h"
39 #include "dsdb/samdb/ldb_modules/util.h"
42 struct aclread_context {
43 struct ldb_module *module;
44 struct ldb_request *req;
45 const char * const *attrs;
46 const struct dsdb_schema *schema;
52 struct aclread_private {
56 static void aclread_mark_inaccesslible(struct ldb_message_element *el) {
57 el->flags |= LDB_FLAG_INTERNAL_INACCESSIBLE_ATTRIBUTE;
60 static bool aclread_is_inaccessible(struct ldb_message_element *el) {
61 return el->flags & LDB_FLAG_INTERNAL_INACCESSIBLE_ATTRIBUTE;
64 static int aclread_callback(struct ldb_request *req, struct ldb_reply *ares)
66 struct ldb_context *ldb;
67 struct aclread_context *ac;
68 struct ldb_message *ret_msg;
69 struct ldb_message *msg;
70 int ret, num_of_attrs = 0;
71 unsigned int i, k = 0;
72 struct security_descriptor *sd;
73 struct dom_sid *sid = NULL;
75 uint32_t instanceType;
77 ac = talloc_get_type(req->context, struct aclread_context);
78 ldb = ldb_module_get_ctx(ac->module);
80 return ldb_module_done(ac->req, NULL, NULL, LDB_ERR_OPERATIONS_ERROR );
82 if (ares->error != LDB_SUCCESS) {
83 return ldb_module_done(ac->req, ares->controls,
84 ares->response, ares->error);
86 tmp_ctx = talloc_new(ac);
90 ret = dsdb_get_sd_from_ldb_message(ldb, tmp_ctx, msg, &sd);
91 if (ret != LDB_SUCCESS) {
92 DEBUG(10, ("acl_read: cannot get descriptor\n"));
93 ret = LDB_ERR_OPERATIONS_ERROR;
96 sid = samdb_result_dom_sid(tmp_ctx, msg, "objectSid");
97 /* get the object instance type */
98 instanceType = ldb_msg_find_attr_as_uint(msg,
100 if (!ldb_dn_is_null(msg->dn) && !(instanceType & INSTANCE_TYPE_IS_NC_HEAD))
102 /* the object has a parent, so we have to check for visibility */
103 struct ldb_dn *parent_dn = ldb_dn_get_parent(tmp_ctx, msg->dn);
104 ret = dsdb_module_check_access_on_dn(ac->module,
109 if (ret == LDB_ERR_INSUFFICIENT_ACCESS_RIGHTS) {
110 talloc_free(tmp_ctx);
112 } else if (ret != LDB_SUCCESS) {
116 /* for every element in the message check RP */
117 for (i=0; i < msg->num_elements; i++) {
118 const struct dsdb_attribute *attr;
119 bool is_sd, is_objectsid, is_instancetype;
120 uint32_t access_mask;
121 attr = dsdb_attribute_by_lDAPDisplayName(ac->schema,
122 msg->elements[i].name);
124 DEBUG(2, ("acl_read: cannot find attribute %s in schema\n",
125 msg->elements[i].name));
126 ret = LDB_ERR_OPERATIONS_ERROR;
129 is_sd = ldb_attr_cmp("nTSecurityDescriptor",
130 msg->elements[i].name) == 0;
131 is_objectsid = ldb_attr_cmp("objectSid",
132 msg->elements[i].name) == 0;
133 is_instancetype = ldb_attr_cmp("instanceType",
134 msg->elements[i].name) == 0;
135 /* these attributes were added to perform access checks and must be removed */
136 if (is_objectsid && ac->object_sid) {
137 aclread_mark_inaccesslible(&msg->elements[i]);
140 if (is_instancetype && ac->instance_type) {
141 aclread_mark_inaccesslible(&msg->elements[i]);
144 if (is_sd && ac->sd) {
145 aclread_mark_inaccesslible(&msg->elements[i]);
148 /* nTSecurityDescriptor is a special case */
150 access_mask = SEC_FLAG_SYSTEM_SECURITY|SEC_STD_READ_CONTROL;
152 access_mask = SEC_ADS_READ_PROP;
154 ret = acl_check_access_on_attribute(ac->module,
161 if (ret == LDB_ERR_INSUFFICIENT_ACCESS_RIGHTS) {
162 /* do not return this entry if attribute is
163 part of the search filter */
164 if (dsdb_attr_in_parse_tree(ac->req->op.search.tree,
165 msg->elements[i].name)) {
166 talloc_free(tmp_ctx);
169 aclread_mark_inaccesslible(&msg->elements[i]);
170 } else if (ret != LDB_SUCCESS) {
174 for (i=0; i < msg->num_elements; i++) {
175 if (!aclread_is_inaccessible(&msg->elements[i])) {
179 /*create a new message to return*/
180 ret_msg = ldb_msg_new(req);
181 ret_msg->dn = msg->dn;
182 ret_msg->num_elements = num_of_attrs;
183 if (num_of_attrs > 0) {
184 ret_msg->elements = talloc_array(ret_msg,
185 struct ldb_message_element,
187 if (ret_msg->elements == NULL) {
190 for (i=0; i < msg->num_elements; i++) {
191 bool to_remove = aclread_is_inaccessible(&msg->elements[i]);
193 ret_msg->elements[k] = msg->elements[i];
194 if (!talloc_reference(ret_msg->elements,
195 msg->elements[i].values)) {
196 talloc_free(tmp_ctx);
197 return ldb_operr(ldb);
203 ret_msg->elements = NULL;
205 talloc_free(tmp_ctx);
207 return ldb_module_send_entry(ac->req, ret_msg, ares->controls);
208 case LDB_REPLY_REFERRAL:
209 return ldb_module_send_referral(ac->req, ares->referral);
211 return ldb_module_done(ac->req, ares->controls,
212 ares->response, LDB_SUCCESS);
217 talloc_free(tmp_ctx);
218 return ldb_module_done(ac->req, NULL, NULL, ret);
222 static int aclread_search(struct ldb_module *module, struct ldb_request *req)
224 struct ldb_context *ldb;
226 struct aclread_context *ac;
227 struct ldb_request *down_req;
228 struct ldb_control *as_system = ldb_request_get_control(req, LDB_CONTROL_AS_SYSTEM_OID);
229 struct ldb_result *res;
230 struct aclread_private *p;
231 bool is_untrusted = ldb_req_is_untrusted(req);
232 const char * const *attrs = NULL;
233 uint32_t instanceType;
234 static const char *acl_attrs[] = {
239 ldb = ldb_module_get_ctx(module);
240 p = talloc_get_type(ldb_module_get_private(module), struct aclread_private);
242 /* skip access checks if we are system or system control is supplied
243 * or this is not LDAP server request */
244 if (!p || !p->enabled ||
245 dsdb_module_am_system(module)
246 || as_system || !is_untrusted) {
247 return ldb_next_request(module, req);
249 /* no checks on special dn */
250 if (ldb_dn_is_special(req->op.search.base)) {
251 return ldb_next_request(module, req);
254 /* check accessibility of base */
255 if (!ldb_dn_is_null(req->op.search.base)) {
256 ret = dsdb_module_search_dn(module, req, &res, req->op.search.base,
258 DSDB_FLAG_NEXT_MODULE |
259 DSDB_SEARCH_SHOW_DELETED);
260 if (ret != LDB_SUCCESS) {
261 return ldb_error(ldb, ret,
262 "acl_read: Error retrieving instanceType for base.");
264 instanceType = ldb_msg_find_attr_as_uint(res->msgs[0],
266 if (instanceType != 0 && !(instanceType & INSTANCE_TYPE_IS_NC_HEAD))
268 /* the object has a parent, so we have to check for visibility */
269 struct ldb_dn *parent_dn = ldb_dn_get_parent(req, req->op.search.base);
270 ret = dsdb_module_check_access_on_dn(module,
275 if (ret == LDB_ERR_INSUFFICIENT_ACCESS_RIGHTS) {
276 return ldb_module_done(req, NULL, NULL, LDB_ERR_NO_SUCH_OBJECT);
277 } else if (ret != LDB_SUCCESS) {
278 return ldb_module_done(req, NULL, NULL, ret);
282 ac = talloc_zero(req, struct aclread_context);
288 ac->schema = dsdb_get_schema(ldb, req);
290 return ldb_operr(ldb);
292 ac->sd = !(ldb_attr_in_list(req->op.search.attrs, "nTSecurityDescriptor"));
293 if (req->op.search.attrs && !ldb_attr_in_list(req->op.search.attrs, "*")) {
294 if (!ldb_attr_in_list(req->op.search.attrs, "instanceType")) {
295 ac->instance_type = true;
296 attrs = ldb_attr_list_copy_add(ac, req->op.search.attrs, "instanceType");
298 attrs = req->op.search.attrs;
300 if (!ldb_attr_in_list(req->op.search.attrs, "objectSid")) {
301 ac->object_sid = true;
302 attrs = ldb_attr_list_copy_add(ac, attrs, "objectSid");
307 /* avoid replacing all attributes with nTSecurityDescriptor
308 * if attribute list is empty */
310 attrs = ldb_attr_list_copy_add(ac, attrs, "*");
312 attrs = ldb_attr_list_copy_add(ac, attrs, "nTSecurityDescriptor");
314 ac->attrs = req->op.search.attrs;
315 ret = ldb_build_search_req_ex(&down_req,
318 req->op.search.scope,
322 ac, aclread_callback,
325 if (ret != LDB_SUCCESS) {
326 return LDB_ERR_OPERATIONS_ERROR;
329 return ldb_next_request(module, down_req);
332 static int aclread_init(struct ldb_module *module)
334 struct ldb_context *ldb = ldb_module_get_ctx(module);
335 struct aclread_private *p = talloc_zero(module, struct aclread_private);
337 return ldb_module_oom(module);
339 p->enabled = lpcfg_parm_bool(ldb_get_opaque(ldb, "loadparm"), NULL, "acl", "search", false);
340 ldb_module_set_private(module, p);
341 return ldb_next_init(module);
344 static const struct ldb_module_ops ldb_aclread_module_ops = {
346 .search = aclread_search,
347 .init_context = aclread_init
350 int ldb_aclread_module_init(const char *version)
352 LDB_MODULE_CHECK_VERSION(version);
353 return ldb_register_module(&ldb_aclread_module_ops);