4 LDAP semantics mapping module
6 Copyright (C) Jelmer Vernooij 2005
7 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2006
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.
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.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 This module relies on ldb_map to do all the real work, but performs
25 some of the trivial mappings between AD semantics and that provided
26 by OpenLDAP and similar servers.
30 #include "ldb/include/ldb_module.h"
31 #include "ldb/ldb_map/ldb_map.h"
33 #include "librpc/gen_ndr/ndr_misc.h"
34 #include "librpc/ndr/libndr.h"
35 #include "dsdb/samdb/samdb.h"
37 struct entryuuid_private {
38 struct ldb_context *ldb;
39 struct ldb_dn **base_dns;
42 static struct ldb_val encode_guid(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
45 NTSTATUS status = GUID_from_data_blob(val, &guid);
46 enum ndr_err_code ndr_err;
47 struct ldb_val out = data_blob(NULL, 0);
49 if (!NT_STATUS_IS_OK(status)) {
52 ndr_err = ndr_push_struct_blob(&out, ctx, NULL, &guid,
53 (ndr_push_flags_fn_t)ndr_push_GUID);
54 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
61 static struct ldb_val guid_always_string(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
63 struct ldb_val out = data_blob(NULL, 0);
65 NTSTATUS status = GUID_from_data_blob(val, &guid);
66 if (!NT_STATUS_IS_OK(status)) {
69 return data_blob_string_const(GUID_string(ctx, &guid));
72 static struct ldb_val encode_ns_guid(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
75 NTSTATUS status = NS_GUID_from_string((char *)val->data, &guid);
76 enum ndr_err_code ndr_err;
77 struct ldb_val out = data_blob(NULL, 0);
79 if (!NT_STATUS_IS_OK(status)) {
82 ndr_err = ndr_push_struct_blob(&out, ctx, NULL, &guid,
83 (ndr_push_flags_fn_t)ndr_push_GUID);
84 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
91 static struct ldb_val guid_ns_string(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
93 struct ldb_val out = data_blob(NULL, 0);
95 NTSTATUS status = GUID_from_data_blob(val, &guid);
96 if (!NT_STATUS_IS_OK(status)) {
99 return data_blob_string_const(NS_GUID_string(ctx, &guid));
102 /* The backend holds binary sids, so just copy them back */
103 static struct ldb_val val_copy(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
105 struct ldb_val out = data_blob(NULL, 0);
106 out = ldb_val_dup(ctx, val);
111 /* Ensure we always convert sids into binary, so the backend doesn't have to know about both forms */
112 static struct ldb_val sid_always_binary(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
114 struct ldb_context *ldb = ldb_module_get_ctx(module);
115 struct ldb_val out = data_blob(NULL, 0);
116 const struct ldb_schema_attribute *a = ldb_schema_attribute_by_name(ldb, "objectSid");
118 if (a->syntax->canonicalise_fn(ldb, ctx, val, &out) != LDB_SUCCESS) {
119 return data_blob(NULL, 0);
125 /* Ensure we always convert objectCategory into a DN */
126 static struct ldb_val objectCategory_always_dn(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
128 struct ldb_context *ldb = ldb_module_get_ctx(module);
130 struct ldb_val out = data_blob(NULL, 0);
131 const struct ldb_schema_attribute *a = ldb_schema_attribute_by_name(ldb, "objectCategory");
133 dn = ldb_dn_from_ldb_val(ctx, ldb, val);
134 if (dn && ldb_dn_validate(dn)) {
136 return val_copy(module, ctx, val);
140 if (a->syntax->canonicalise_fn(ldb, ctx, val, &out) != LDB_SUCCESS) {
141 return data_blob(NULL, 0);
147 static struct ldb_val normalise_to_signed32(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
150 /* We've to use "strtoll" here to have the intended overflows.
151 * Otherwise we may get "LONG_MAX" and the conversion is wrong. */
152 int32_t i = (int32_t) strtoll((char *)val->data, NULL, 0);
153 out = data_blob_string_const(talloc_asprintf(ctx, "%d", i));
157 static struct ldb_val usn_to_entryCSN(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
160 unsigned long long usn = strtoull((const char *)val->data, NULL, 10);
161 time_t t = (usn >> 24);
162 out = data_blob_string_const(talloc_asprintf(ctx, "%s#%06x#00#000000", ldb_timestring(ctx, t), (unsigned int)(usn & 0xFFFFFF)));
166 static unsigned long long entryCSN_to_usn_int(TALLOC_CTX *ctx, const struct ldb_val *val)
168 char *entryCSN = talloc_strdup(ctx, (const char *)val->data);
171 unsigned long long usn;
176 p = strchr(entryCSN, '#');
191 usn = strtol(mod_per_sec, NULL, 16);
193 t = ldb_string_to_time(entryCSN);
195 usn = usn | ((unsigned long long)t <<24);
199 static struct ldb_val entryCSN_to_usn(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
202 unsigned long long usn = entryCSN_to_usn_int(ctx, val);
203 out = data_blob_string_const(talloc_asprintf(ctx, "%lld", usn));
207 static struct ldb_val usn_to_timestamp(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
210 unsigned long long usn = strtoull((const char *)val->data, NULL, 10);
211 time_t t = (usn >> 24);
212 out = data_blob_string_const(ldb_timestring(ctx, t));
216 static struct ldb_val timestamp_to_usn(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
220 unsigned long long usn;
222 t = ldb_string_to_time((const char *)val->data);
224 usn = ((unsigned long long)t <<24);
226 out = data_blob_string_const(talloc_asprintf(ctx, "%lld", usn));
231 static const struct ldb_map_attribute entryuuid_attributes[] =
235 .local_name = "objectGUID",
239 .remote_name = "entryUUID",
240 .convert_local = guid_always_string,
241 .convert_remote = encode_guid,
247 .local_name = "invocationId",
251 .remote_name = "invocationId",
252 .convert_local = guid_always_string,
253 .convert_remote = encode_guid,
259 .local_name = "objectSid",
263 .remote_name = "objectSid",
264 .convert_local = sid_always_binary,
265 .convert_remote = val_copy,
270 .local_name = "name",
274 .remote_name = "samba4RDN"
279 .local_name = "whenCreated",
283 .remote_name = "createTimestamp"
288 .local_name = "whenChanged",
292 .remote_name = "modifyTimestamp"
297 .local_name = "objectClasses",
301 .remote_name = "samba4ObjectClasses"
306 .local_name = "dITContentRules",
310 .remote_name = "samba4DITContentRules"
315 .local_name = "attributeTypes",
319 .remote_name = "samba4AttributeTypes"
324 .local_name = "objectCategory",
328 .remote_name = "objectCategory",
329 .convert_local = objectCategory_always_dn,
330 .convert_remote = val_copy,
335 .local_name = "distinguishedName",
339 .remote_name = "entryDN"
344 .local_name = "groupType",
348 .remote_name = "groupType",
349 .convert_local = normalise_to_signed32,
350 .convert_remote = val_copy,
355 .local_name = "userAccountControl",
359 .remote_name = "userAccountControl",
360 .convert_local = normalise_to_signed32,
361 .convert_remote = val_copy,
366 .local_name = "sAMAccountType",
370 .remote_name = "sAMAccountType",
371 .convert_local = normalise_to_signed32,
372 .convert_remote = val_copy,
377 .local_name = "systemFlags",
381 .remote_name = "systemFlags",
382 .convert_local = normalise_to_signed32,
383 .convert_remote = val_copy,
388 .local_name = "usnChanged",
392 .remote_name = "entryCSN",
393 .convert_local = usn_to_entryCSN,
394 .convert_remote = entryCSN_to_usn
399 .local_name = "usnCreated",
403 .remote_name = "createTimestamp",
404 .convert_local = usn_to_timestamp,
405 .convert_remote = timestamp_to_usn,
418 /* This objectClass conflicts with builtin classes on OpenLDAP */
419 const struct ldb_map_objectclass entryuuid_objectclasses[] =
422 .local_name = "subSchema",
423 .remote_name = "samba4SubSchema"
430 /* These things do not show up in wildcard searches in OpenLDAP, but
431 * we need them to show up in the AD-like view */
432 static const char * const entryuuid_wildcard_attributes[] = {
442 static const struct ldb_map_attribute nsuniqueid_attributes[] =
446 .local_name = "objectGUID",
450 .remote_name = "nsuniqueid",
451 .convert_local = guid_ns_string,
452 .convert_remote = encode_ns_guid,
458 .local_name = "objectSid",
462 .remote_name = "objectSid",
463 .convert_local = sid_always_binary,
464 .convert_remote = val_copy,
469 .local_name = "whenCreated",
473 .remote_name = "createTimestamp"
478 .local_name = "whenChanged",
482 .remote_name = "modifyTimestamp"
487 .local_name = "objectCategory",
491 .remote_name = "objectCategory",
492 .convert_local = objectCategory_always_dn,
493 .convert_remote = val_copy,
498 .local_name = "distinguishedName",
502 .remote_name = "entryDN"
507 .local_name = "groupType",
511 .remote_name = "groupType",
512 .convert_local = normalise_to_signed32,
513 .convert_remote = val_copy,
518 .local_name = "userAccountControl",
522 .remote_name = "userAccountControl",
523 .convert_local = normalise_to_signed32,
524 .convert_remote = val_copy,
529 .local_name = "sAMAccountType",
533 .remote_name = "sAMAccountType",
534 .convert_local = normalise_to_signed32,
535 .convert_remote = val_copy,
540 .local_name = "systemFlags",
544 .remote_name = "systemFlags",
545 .convert_local = normalise_to_signed32,
546 .convert_remote = val_copy,
551 .local_name = "usnChanged",
555 .remote_name = "modifyTimestamp",
556 .convert_local = usn_to_timestamp,
557 .convert_remote = timestamp_to_usn,
562 .local_name = "usnCreated",
566 .remote_name = "createTimestamp",
567 .convert_local = usn_to_timestamp,
568 .convert_remote = timestamp_to_usn,
581 /* These things do not show up in wildcard searches in OpenLDAP, but
582 * we need them to show up in the AD-like view */
583 static const char * const nsuniqueid_wildcard_attributes[] = {
592 /* the context init function */
593 static int entryuuid_init(struct ldb_module *module)
596 ret = ldb_map_init(module, entryuuid_attributes, entryuuid_objectclasses, entryuuid_wildcard_attributes, "samba4Top", NULL);
597 if (ret != LDB_SUCCESS)
600 return ldb_next_init(module);
603 /* the context init function */
604 static int nsuniqueid_init(struct ldb_module *module)
607 ret = ldb_map_init(module, nsuniqueid_attributes, NULL, nsuniqueid_wildcard_attributes, "extensibleObject", NULL);
608 if (ret != LDB_SUCCESS)
611 return ldb_next_init(module);
614 static int get_seq_callback(struct ldb_request *req,
615 struct ldb_reply *ares)
617 unsigned long long *seq = (unsigned long long *)req->context;
620 return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
622 if (ares->error != LDB_SUCCESS) {
623 return ldb_request_done(req, ares->error);
626 if (ares->type == LDB_REPLY_ENTRY) {
627 struct ldb_message_element *el = ldb_msg_find_element(ares->message, "contextCSN");
629 *seq = entryCSN_to_usn_int(ares, &el->values[0]);
633 if (ares->type == LDB_REPLY_DONE) {
634 return ldb_request_done(req, LDB_SUCCESS);
641 static int entryuuid_sequence_number(struct ldb_module *module, struct ldb_request *req)
643 struct ldb_context *ldb;
645 struct map_private *map_private;
646 struct entryuuid_private *entryuuid_private;
647 unsigned long long seq_num = 0;
648 struct ldb_request *search_req;
650 const struct ldb_control *partition_ctrl;
651 const struct dsdb_control_current_partition *partition;
653 static const char *contextCSN_attr[] = {
657 struct ldb_seqnum_request *seq;
658 struct ldb_seqnum_result *seqr;
659 struct ldb_extended *ext;
661 ldb = ldb_module_get_ctx(module);
663 seq = talloc_get_type(req->op.extended.data, struct ldb_seqnum_request);
665 map_private = talloc_get_type(ldb_module_get_private(module), struct map_private);
667 entryuuid_private = talloc_get_type(map_private->caller_private, struct entryuuid_private);
669 /* All this to get the DN of the parition, so we can search the right thing */
670 partition_ctrl = ldb_request_get_control(req, DSDB_CONTROL_CURRENT_PARTITION_OID);
671 if (!partition_ctrl) {
672 ldb_debug_set(ldb, LDB_DEBUG_FATAL,
673 "entryuuid_sequence_number: no current partition control found");
674 return LDB_ERR_CONSTRAINT_VIOLATION;
677 partition = talloc_get_type(partition_ctrl->data,
678 struct dsdb_control_current_partition);
679 SMB_ASSERT(partition && partition->version == DSDB_CONTROL_CURRENT_PARTITION_VERSION);
681 ret = ldb_build_search_req(&search_req, ldb, req,
682 partition->dn, LDB_SCOPE_BASE,
683 NULL, contextCSN_attr, NULL,
684 &seq_num, get_seq_callback,
686 if (ret != LDB_SUCCESS) {
690 ret = ldb_next_request(module, search_req);
692 if (ret == LDB_SUCCESS) {
693 ret = ldb_wait(search_req->handle, LDB_WAIT_ALL);
696 talloc_free(search_req);
697 if (ret != LDB_SUCCESS) {
701 ext = talloc_zero(req, struct ldb_extended);
703 return LDB_ERR_OPERATIONS_ERROR;
705 seqr = talloc_zero(req, struct ldb_seqnum_result);
708 return LDB_ERR_OPERATIONS_ERROR;
710 ext->oid = LDB_EXTENDED_SEQUENCE_NUMBER;
714 case LDB_SEQ_HIGHEST_SEQ:
715 seqr->seq_num = seq_num;
718 seqr->seq_num = seq_num;
721 case LDB_SEQ_HIGHEST_TIMESTAMP:
723 seqr->seq_num = (seq_num >> 24);
728 seqr->flags |= LDB_SEQ_TIMESTAMP_SEQUENCE;
729 seqr->flags |= LDB_SEQ_GLOBAL_SEQUENCE;
731 /* send request done */
732 return ldb_module_done(req, NULL, ext, LDB_SUCCESS);
735 static int entryuuid_extended(struct ldb_module *module, struct ldb_request *req)
737 if (strcmp(req->op.extended.oid, LDB_EXTENDED_SEQUENCE_NUMBER) == 0) {
738 return entryuuid_sequence_number(module, req);
741 return ldb_next_request(module, req);
744 _PUBLIC_ const struct ldb_module_ops ldb_entryuuid_module_ops = {
746 .init_context = entryuuid_init,
747 .extended = entryuuid_extended,
751 _PUBLIC_ const struct ldb_module_ops ldb_nsuniqueid_module_ops = {
752 .name = "nsuniqueid",
753 .init_context = nsuniqueid_init,
754 .extended = entryuuid_extended,