s4-dsdb: Initial implementation for Tombstone reanimation module
authorKamen Mazdrashki <kamenim@samba.org>
Sat, 27 Dec 2014 19:14:25 +0000 (21:14 +0200)
committerAndrew Bartlett <abartlet@samba.org>
Tue, 3 Feb 2015 04:02:10 +0000 (05:02 +0100)
At the moment it works for basic scenario:
 - add user
 - delete user
 - restore deleted user

TODO:
 - security checks
 - flags verification
 - cross-NC checks
 - asynchronous implementation (may not be needed, but anyway)

Change-Id: If396a6dfc766c224acfeb7e93ca75703e08c26e6
Signed-off-by: Kamen Mazdrashki <kamenim@samba.org>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
Reviewed-by: Garming Sam <garming@catalyst.net.nz>
source4/dsdb/samdb/ldb_modules/tombstone_reanimate.c [new file with mode: 0644]
source4/dsdb/samdb/ldb_modules/wscript_build_server

diff --git a/source4/dsdb/samdb/ldb_modules/tombstone_reanimate.c b/source4/dsdb/samdb/ldb_modules/tombstone_reanimate.c
new file mode 100644 (file)
index 0000000..989a664
--- /dev/null
@@ -0,0 +1,256 @@
+/*
+   ldb database library
+
+   Copyright (C) Kamen Mazdrashki <kamenim@samba.org> 2014
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/*
+ *  Name: tombstone_reanimate
+ *
+ *  Component: Handle Tombstone reanimation requests
+ *
+ *  Description:
+ *     Tombstone reanimation requests are plain ldap modify request like:
+ *       dn: CN=tombi 1\0ADEL:e6e17ff7-8986-4cdd-87ad-afb683ccbb89,CN=Deleted Objects,DC=samba4,DC=devel
+ *       changetype: modify
+ *       delete: isDeleted
+ *       -
+ *       replace: distinguishedName
+ *       distinguishedName: CN=Tombi 1,CN=Users,DC=samba4,DC=devel
+ *       -
+ *
+ *     Usually we don't allow distinguishedName modifications (see rdn_name.c)
+ *     Reanimating Tombstones is described here:
+ *       - TBD
+ *
+ *  Author: Kamen Mazdrashki
+ */
+
+
+#include "includes.h"
+#include "ldb_module.h"
+#include "dsdb/samdb/samdb.h"
+#include "librpc/ndr/libndr.h"
+#include "librpc/gen_ndr/ndr_security.h"
+#include "libcli/security/security.h"
+#include "auth/auth.h"
+#include "param/param.h"
+#include "../libds/common/flags.h"
+#include "dsdb/samdb/ldb_modules/util.h"
+
+struct tr_context {
+
+       struct ldb_module *module;
+       struct ldb_request *req;
+       const struct dsdb_schema *schema;
+
+       struct ldb_reply *search_res;
+       struct ldb_reply *search_res2;
+
+       int (*step_fn)(struct tr_context *);
+};
+
+static struct tr_context *tr_init_context(struct ldb_module *module,
+                                         struct ldb_request *req)
+{
+       struct ldb_context *ldb;
+       struct tr_context *ac;
+
+       ldb = ldb_module_get_ctx(module);
+
+       ac = talloc_zero(req, struct tr_context);
+       if (ac == NULL) {
+               ldb_oom(ldb);
+               return NULL;
+       }
+
+       ac->module = module;
+       ac->req = req;
+       ac->schema = dsdb_get_schema(ldb, ac);
+
+       return ac;
+}
+
+
+static bool is_tombstone_reanimate_request(struct ldb_request *req, struct ldb_message_element **pel_dn)
+{
+       struct ldb_message_element *el_dn;
+       struct ldb_message_element *el_deleted;
+
+       /* check distinguishedName requirement */
+       el_dn = ldb_msg_find_element(req->op.mod.message, "distinguishedName");
+       if (el_dn == NULL || el_dn->flags != LDB_FLAG_MOD_REPLACE) {
+               return false;
+       }
+
+       /* check isDeleted requirement */
+       el_deleted = ldb_msg_find_element(req->op.mod.message, "isDeleted");
+       if (el_deleted == NULL || el_deleted->flags != LDB_FLAG_MOD_DELETE) {
+               return false;
+       }
+
+       *pel_dn = el_dn;
+       return true;
+}
+
+static int _tr_make_object_category(struct tr_context *ac, struct ldb_message *obj,
+                                   TALLOC_CTX *mem_ctx, const char **pobjectcategory)
+{
+       int                             ret;
+       struct ldb_context              *ldb;
+       const struct dsdb_class         *objectclass;
+       struct ldb_message_element      *objectclass_element;
+
+       ldb = ldb_module_get_ctx(ac->module);
+
+       objectclass_element = ldb_msg_find_element(obj, "objectClass");
+       if (!objectclass_element) {
+               ldb_asprintf_errstring(ldb, "tombstone_reanimate: Cannot add %s, no objectclass specified!",
+                                      ldb_dn_get_linearized(obj->dn));
+               return LDB_ERR_OBJECT_CLASS_VIOLATION;
+       }
+       if (objectclass_element->num_values == 0) {
+               ldb_asprintf_errstring(ldb, "tombstone_reanimate: Cannot add %s, at least one (structural) objectclass has to be specified!",
+                                      ldb_dn_get_linearized(obj->dn));
+               return LDB_ERR_CONSTRAINT_VIOLATION;
+       }
+
+       /* Now do the sorting */
+       ret = dsdb_sort_objectClass_attr(ldb, ac->schema,
+                                        objectclass_element, obj,
+                                        objectclass_element);
+       if (ret != LDB_SUCCESS) {
+               return ret;
+       }
+
+       /*
+        * Get the new top-most structural object class and check for
+        * unrelated structural classes
+        */
+       objectclass = dsdb_get_last_structural_class(ac->schema,
+                                                    objectclass_element);
+       if (objectclass == NULL) {
+               ldb_asprintf_errstring(ldb,
+                                      "Failed to find a structural class for %s",
+                                      ldb_dn_get_linearized(obj->dn));
+               return LDB_ERR_UNWILLING_TO_PERFORM;
+       }
+
+       *pobjectcategory = talloc_strdup(mem_ctx, objectclass->defaultObjectCategory);
+       if (*pobjectcategory == NULL) {
+               return ldb_oom(ldb);
+       }
+
+       return LDB_SUCCESS;
+}
+
+static int tombstone_reanimate_modify(struct ldb_module *module, struct ldb_request *req)
+{
+       int                             ret;
+       struct ldb_context              *ldb;
+       struct ldb_dn                   *dn_new;
+       struct ldb_dn                   *objectcategory;
+       struct ldb_message_element      *el_dn = NULL;
+       struct ldb_message              *msg;
+       struct ldb_result               *res_obj;
+       struct tr_context               *ac;
+
+       ldb = ldb_module_get_ctx(module);
+
+       ldb_debug(ldb, LDB_DEBUG_TRACE, "%s\n", __PRETTY_FUNCTION__);
+
+       /* do not manipulate our control entries */
+       if (ldb_dn_is_special(req->op.mod.message->dn)) {
+               return ldb_next_request(module, req);
+       }
+
+       ac = tr_init_context(module, req);
+       if (ac == NULL) {
+               return ldb_operr(ldb);
+       }
+
+       /* Check if this is a reanimate request */
+       if (!is_tombstone_reanimate_request(req, &el_dn)) {
+               return ldb_next_request(module, req);
+       }
+
+       /* Load original object */
+       ret = dsdb_module_search_dn(module, req, &res_obj, req->op.mod.message->dn, NULL, DSDB_FLAG_TOP_MODULE | DSDB_SEARCH_SHOW_DELETED, req);
+       if (ret != LDB_SUCCESS) {
+               return ldb_operr(ldb);
+       }
+       /* check if it a Deleted Object */
+       if (!ldb_msg_find_attr_as_bool(res_obj->msgs[0], "isDeleted", false)) {
+               return ldb_error(ldb, LDB_ERR_UNWILLING_TO_PERFORM, "Trying to restore not deleted object\n");
+       }
+
+       /* Simple implementation */
+       /* Rename request to modify distinguishedName */
+       dn_new = ldb_dn_from_ldb_val(req, ldb, &el_dn->values[0]);
+       if (dn_new == NULL) {
+               return ldb_oom(ldb);
+       }
+       ret = dsdb_module_rename(module, req->op.mod.message->dn, dn_new, DSDB_FLAG_TOP_MODULE | DSDB_SEARCH_SHOW_DELETED, req);
+       if (ret != LDB_SUCCESS) {
+               ldb_debug(ldb, LDB_DEBUG_ERROR, "Renaming object to %s has failed with %s\n", el_dn->values[0].data, ldb_strerror(ret));
+               return ret;
+       }
+
+       /* Modify request to: */
+       msg = ldb_msg_copy_shallow(ac, req->op.mod.message);
+       if (msg == NULL) {
+               return ldb_module_oom(ac->module);
+       }
+       msg->dn = dn_new;
+       /* - delete isDeleted */
+       ldb_msg_remove_attr(msg, "distinguishedName");
+
+       /* - restore objectCategory if not present */
+       objectcategory = ldb_msg_find_attr_as_dn(ldb, ac, msg,
+                                                "objectCategory");
+       if (objectcategory == NULL) {
+               const char *value;
+
+               ret = _tr_make_object_category(ac, res_obj->msgs[0], msg, &value);
+               if (ret != LDB_SUCCESS) {
+                       return ret;
+               }
+
+               ret = ldb_msg_add_string(msg, "objectCategory", value);
+               if (ret != LDB_SUCCESS) {
+                       return ret;
+               }
+               msg->elements[msg->num_elements-1].flags = LDB_FLAG_MOD_ADD;
+       }
+       ret = dsdb_module_modify(module, msg, DSDB_FLAG_NEXT_MODULE, req);
+       if (ret != LDB_SUCCESS) {
+               return ldb_operr(ldb);
+       }
+
+       return ldb_module_done(ac->req, NULL, NULL, LDB_SUCCESS);
+}
+
+
+static const struct ldb_module_ops ldb_reanimate_module_ops = {
+       .name           = "tombstone_reanimate",
+       .modify         = tombstone_reanimate_modify,
+};
+
+int ldb_tombstone_reanimate_module_init(const char *version)
+{
+       LDB_MODULE_CHECK_VERSION(version);
+       return ldb_register_module(&ldb_reanimate_module_ops);
+}
index 8848fd2c77a5b5f9d40d1d6a9b99a4365a675fc4..b54d27f2ae5ac4325a40eb91a48cf1c9f0b57df4 100755 (executable)
@@ -372,4 +372,13 @@ bld.SAMBA_MODULE('ldb_dns_notify',
        module_init_name='ldb_init_module',
        internal_module=False,
        deps='talloc samdb DSDB_MODULE_HELPERS MESSAGING RPC_NDR_IRPC'
-       )
\ No newline at end of file
+       )
+
+bld.SAMBA_MODULE('tombstone_reanimate',
+       source='tombstone_reanimate.c',
+       subsystem='ldb',
+       init_function='ldb_tombstone_reanimate_module_init',
+       module_init_name='ldb_init_module',
+       internal_module=False,
+       deps='talloc samba-util DSDB_MODULE_HELPERS'
+       )