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.h"
31 #include "ldb/include/ldb_private.h"
32 #include "ldb/include/ldb_errors.h"
33 #include "ldb/ldb_map/ldb_map.h"
35 #include "librpc/gen_ndr/ndr_misc.h"
36 #include "librpc/ndr/libndr.h"
38 struct entryuuid_private {
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_string((char *)val->data, &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)
64 struct ldb_val out = data_blob(NULL, 0);
65 if (val->length >= 32 && val->data[val->length] == '\0') {
66 ldb_handler_copy(module->ldb, ctx, val, &out);
68 enum ndr_err_code ndr_err;
70 guid = talloc(ctx, struct GUID);
74 ndr_err = ndr_pull_struct_blob(val, guid, NULL, guid,
75 (ndr_pull_flags_fn_t)ndr_pull_GUID);
76 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
80 out = data_blob_string_const(GUID_string(ctx, guid));
86 static struct ldb_val encode_ns_guid(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
89 NTSTATUS status = NS_GUID_from_string((char *)val->data, &guid);
90 enum ndr_err_code ndr_err;
91 struct ldb_val out = data_blob(NULL, 0);
93 if (!NT_STATUS_IS_OK(status)) {
96 ndr_err = ndr_push_struct_blob(&out, ctx, NULL, &guid,
97 (ndr_push_flags_fn_t)ndr_push_GUID);
98 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
105 static struct ldb_val guid_ns_string(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
107 struct ldb_val out = data_blob(NULL, 0);
108 if (val->length >= 32 && val->data[val->length] == '\0') {
110 GUID_from_string((char *)val->data, &guid);
111 out = data_blob_string_const(NS_GUID_string(ctx, &guid));
113 enum ndr_err_code ndr_err;
115 guid_p = talloc(ctx, struct GUID);
116 if (guid_p == NULL) {
119 ndr_err = ndr_pull_struct_blob(val, guid_p, NULL, guid_p,
120 (ndr_pull_flags_fn_t)ndr_pull_GUID);
121 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
125 out = data_blob_string_const(NS_GUID_string(ctx, guid_p));
131 /* The backend holds binary sids, so just copy them back */
132 static struct ldb_val val_copy(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
134 struct ldb_val out = data_blob(NULL, 0);
135 ldb_handler_copy(module->ldb, ctx, val, &out);
140 /* Ensure we always convert sids into binary, so the backend doesn't have to know about both forms */
141 static struct ldb_val sid_always_binary(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
143 struct ldb_val out = data_blob(NULL, 0);
144 const struct ldb_schema_attribute *a = ldb_schema_attribute_by_name(module->ldb, "objectSid");
146 if (a->syntax->canonicalise_fn(module->ldb, ctx, val, &out) != LDB_SUCCESS) {
147 return data_blob(NULL, 0);
153 /* Ensure we always convert objectCategory into a DN */
154 static struct ldb_val objectCategory_always_dn(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
157 struct ldb_val out = data_blob(NULL, 0);
158 const struct ldb_schema_attribute *a = ldb_schema_attribute_by_name(module->ldb, "objectCategory");
160 dn = ldb_dn_new(ctx, module->ldb, val->data);
161 if (dn && ldb_dn_validate(dn)) {
163 return val_copy(module, ctx, val);
167 if (a->syntax->canonicalise_fn(module->ldb, ctx, val, &out) != LDB_SUCCESS) {
168 return data_blob(NULL, 0);
174 static struct ldb_val normalise_to_signed32(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
176 long long int signed_ll = strtoll((const char *)val->data, NULL, 10);
177 if (signed_ll >= 0x80000000LL) {
180 uint32_t unsigned_int;
182 .unsigned_int = strtoul((const char *)val->data, NULL, 10)
185 struct ldb_val out = data_blob_string_const(talloc_asprintf(ctx, "%d", u.signed_int));
188 return val_copy(module, ctx, val);
191 static struct ldb_val usn_to_entryCSN(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
194 unsigned long long usn = strtoull((const char *)val->data, NULL, 10);
195 time_t t = (usn >> 24);
196 out = data_blob_string_const(talloc_asprintf(ctx, "%s#%06x#00#000000", ldb_timestring(ctx, t), (unsigned int)(usn & 0xFFFFFF)));
200 static unsigned long long entryCSN_to_usn_int(TALLOC_CTX *ctx, const struct ldb_val *val)
202 char *entryCSN = talloc_strdup(ctx, (const char *)val->data);
205 unsigned long long usn;
210 p = strchr(entryCSN, '#');
225 usn = strtol(mod_per_sec, NULL, 16);
227 t = ldb_string_to_time(entryCSN);
229 usn = usn | ((unsigned long long)t <<24);
233 static struct ldb_val entryCSN_to_usn(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
236 unsigned long long usn = entryCSN_to_usn_int(ctx, val);
237 out = data_blob_string_const(talloc_asprintf(ctx, "%lld", usn));
241 static struct ldb_val usn_to_timestamp(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
244 unsigned long long usn = strtoull((const char *)val->data, NULL, 10);
245 time_t t = (usn >> 24);
246 out = data_blob_string_const(ldb_timestring(ctx, t));
250 static struct ldb_val timestamp_to_usn(struct ldb_module *module, TALLOC_CTX *ctx, const struct ldb_val *val)
254 unsigned long long usn;
256 t = ldb_string_to_time((const char *)val->data);
258 usn = ((unsigned long long)t <<24);
260 out = data_blob_string_const(talloc_asprintf(ctx, "%lld", usn));
265 static const struct ldb_map_attribute entryuuid_attributes[] =
269 .local_name = "objectGUID",
273 .remote_name = "entryUUID",
274 .convert_local = guid_always_string,
275 .convert_remote = encode_guid,
281 .local_name = "invocationId",
285 .remote_name = "invocationId",
286 .convert_local = guid_always_string,
287 .convert_remote = encode_guid,
293 .local_name = "objectSid",
297 .remote_name = "objectSid",
298 .convert_local = sid_always_binary,
299 .convert_remote = val_copy,
304 .local_name = "name",
308 .remote_name = "samba4RDN"
313 .local_name = "whenCreated",
317 .remote_name = "createTimestamp"
322 .local_name = "whenChanged",
326 .remote_name = "modifyTimestamp"
331 .local_name = "objectClasses",
335 .remote_name = "samba4ObjectClasses"
340 .local_name = "dITContentRules",
344 .remote_name = "samba4DITContentRules"
349 .local_name = "attributeTypes",
353 .remote_name = "samba4AttributeTypes"
358 .local_name = "objectCategory",
362 .remote_name = "objectCategory",
363 .convert_local = objectCategory_always_dn,
364 .convert_remote = val_copy,
369 .local_name = "distinguishedName",
373 .remote_name = "entryDN"
378 .local_name = "groupType",
382 .remote_name = "groupType",
383 .convert_local = normalise_to_signed32,
384 .convert_remote = val_copy,
389 .local_name = "sAMAccountType",
393 .remote_name = "sAMAccountType",
394 .convert_local = normalise_to_signed32,
395 .convert_remote = val_copy,
400 .local_name = "usnChanged",
404 .remote_name = "entryCSN",
405 .convert_local = usn_to_entryCSN,
406 .convert_remote = entryCSN_to_usn
411 .local_name = "usnCreated",
415 .remote_name = "createTimestamp",
416 .convert_local = usn_to_timestamp,
417 .convert_remote = timestamp_to_usn,
430 /* This objectClass conflicts with builtin classes on OpenLDAP */
431 const struct ldb_map_objectclass entryuuid_objectclasses[] =
434 .local_name = "subSchema",
435 .remote_name = "samba4SubSchema"
442 /* These things do not show up in wildcard searches in OpenLDAP, but
443 * we need them to show up in the AD-like view */
444 static const char * const entryuuid_wildcard_attributes[] = {
454 static const struct ldb_map_attribute nsuniqueid_attributes[] =
458 .local_name = "objectGUID",
462 .remote_name = "nsuniqueid",
463 .convert_local = guid_ns_string,
464 .convert_remote = encode_ns_guid,
470 .local_name = "objectSid",
474 .remote_name = "objectSid",
475 .convert_local = sid_always_binary,
476 .convert_remote = val_copy,
481 .local_name = "whenCreated",
485 .remote_name = "createTimestamp"
490 .local_name = "whenChanged",
494 .remote_name = "modifyTimestamp"
499 .local_name = "objectCategory",
503 .remote_name = "objectCategory",
504 .convert_local = objectCategory_always_dn,
505 .convert_remote = val_copy,
510 .local_name = "distinguishedName",
514 .remote_name = "entryDN"
519 .local_name = "groupType",
523 .remote_name = "groupType",
524 .convert_local = normalise_to_signed32,
525 .convert_remote = val_copy,
530 .local_name = "sAMAccountType",
534 .remote_name = "sAMAccountType",
535 .convert_local = normalise_to_signed32,
536 .convert_remote = val_copy,
541 .local_name = "usnChanged",
545 .remote_name = "modifyTimestamp",
546 .convert_local = usn_to_timestamp,
547 .convert_remote = timestamp_to_usn,
552 .local_name = "usnCreated",
556 .remote_name = "createTimestamp",
557 .convert_local = usn_to_timestamp,
558 .convert_remote = timestamp_to_usn,
571 /* These things do not show up in wildcard searches in OpenLDAP, but
572 * we need them to show up in the AD-like view */
573 static const char * const nsuniqueid_wildcard_attributes[] = {
582 static int get_remote_rootdse(struct ldb_context *ldb, void *context,
583 struct ldb_reply *ares)
585 struct entryuuid_private *entryuuid_private;
586 entryuuid_private = talloc_get_type(context,
587 struct entryuuid_private);
588 if (ares->type == LDB_REPLY_ENTRY) {
590 struct ldb_message_element *el = ldb_msg_find_element(ares->message, "namingContexts");
591 entryuuid_private->base_dns = talloc_realloc(entryuuid_private, entryuuid_private->base_dns, struct ldb_dn *,
593 for (i=0; i < el->num_values; i++) {
594 if (!entryuuid_private->base_dns) {
595 return LDB_ERR_OPERATIONS_ERROR;
597 entryuuid_private->base_dns[i] = ldb_dn_new(entryuuid_private->base_dns, ldb, (const char *)el->values[i].data);
598 if ( ! ldb_dn_validate(entryuuid_private->base_dns[i])) {
599 return LDB_ERR_OPERATIONS_ERROR;
602 entryuuid_private->base_dns[i] = NULL;
608 static int find_base_dns(struct ldb_module *module,
609 struct entryuuid_private *entryuuid_private)
612 struct ldb_request *req;
613 const char *naming_context_attr[] = {
617 req = talloc(entryuuid_private, struct ldb_request);
619 ldb_set_errstring(module->ldb, "Out of Memory");
620 return LDB_ERR_OPERATIONS_ERROR;
623 req->operation = LDB_SEARCH;
624 req->op.search.base = ldb_dn_new(req, module->ldb, NULL);
625 req->op.search.scope = LDB_SCOPE_BASE;
627 req->op.search.tree = ldb_parse_tree(req, "objectClass=*");
628 if (req->op.search.tree == NULL) {
629 ldb_set_errstring(module->ldb, "Unable to parse search expression");
631 return LDB_ERR_OPERATIONS_ERROR;
634 req->op.search.attrs = naming_context_attr;
635 req->controls = NULL;
636 req->context = entryuuid_private;
637 req->callback = get_remote_rootdse;
638 ldb_set_timeout(module->ldb, req, 0); /* use default timeout */
640 ret = ldb_next_request(module, req);
642 if (ret == LDB_SUCCESS) {
643 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
647 if (ret != LDB_SUCCESS) {
654 /* the context init function */
655 static int entryuuid_init(struct ldb_module *module)
658 struct map_private *map_private;
659 struct entryuuid_private *entryuuid_private;
661 ret = ldb_map_init(module, entryuuid_attributes, entryuuid_objectclasses, entryuuid_wildcard_attributes, "samba4Top", NULL);
662 if (ret != LDB_SUCCESS)
665 map_private = talloc_get_type(module->private_data, struct map_private);
667 entryuuid_private = talloc_zero(map_private, struct entryuuid_private);
668 map_private->caller_private = entryuuid_private;
670 ret = find_base_dns(module, entryuuid_private);
672 return ldb_next_init(module);
675 /* the context init function */
676 static int nsuniqueid_init(struct ldb_module *module)
679 struct map_private *map_private;
680 struct entryuuid_private *entryuuid_private;
682 ret = ldb_map_init(module, nsuniqueid_attributes, NULL, nsuniqueid_wildcard_attributes, "extensibleObject", NULL);
683 if (ret != LDB_SUCCESS)
686 map_private = talloc_get_type(module->private_data, struct map_private);
688 entryuuid_private = talloc_zero(map_private, struct entryuuid_private);
689 map_private->caller_private = entryuuid_private;
691 ret = find_base_dns(module, entryuuid_private);
693 return ldb_next_init(module);
696 static int get_seq(struct ldb_context *ldb, void *context,
697 struct ldb_reply *ares)
699 unsigned long long *max_seq = (unsigned long long *)context;
700 unsigned long long seq;
701 if (ares->type == LDB_REPLY_ENTRY) {
702 struct ldb_message_element *el = ldb_msg_find_element(ares->message, "contextCSN");
704 seq = entryCSN_to_usn_int(ares, &el->values[0]);
705 *max_seq = MAX(seq, *max_seq);
712 static int entryuuid_sequence_number(struct ldb_module *module, struct ldb_request *req)
715 struct map_private *map_private;
716 struct entryuuid_private *entryuuid_private;
717 unsigned long long max_seq = 0;
718 struct ldb_request *search_req;
719 map_private = talloc_get_type(module->private_data, struct map_private);
721 entryuuid_private = talloc_get_type(map_private->caller_private, struct entryuuid_private);
723 /* Search the baseDNs for a sequence number */
724 for (i=0; entryuuid_private &&
725 entryuuid_private->base_dns &&
726 entryuuid_private->base_dns[i];
728 static const char *contextCSN_attr[] = {
731 search_req = talloc(req, struct ldb_request);
732 if (search_req == NULL) {
733 ldb_set_errstring(module->ldb, "Out of Memory");
734 return LDB_ERR_OPERATIONS_ERROR;
737 search_req->operation = LDB_SEARCH;
738 search_req->op.search.base = entryuuid_private->base_dns[i];
739 search_req->op.search.scope = LDB_SCOPE_BASE;
741 search_req->op.search.tree = ldb_parse_tree(search_req, "objectClass=*");
742 if (search_req->op.search.tree == NULL) {
743 ldb_set_errstring(module->ldb, "Unable to parse search expression");
744 talloc_free(search_req);
745 return LDB_ERR_OPERATIONS_ERROR;
748 search_req->op.search.attrs = contextCSN_attr;
749 search_req->controls = NULL;
750 search_req->context = &max_seq;
751 search_req->callback = get_seq;
752 ldb_set_timeout(module->ldb, search_req, 0); /* use default timeout */
754 ret = ldb_next_request(module, search_req);
756 if (ret == LDB_SUCCESS) {
757 ret = ldb_wait(search_req->handle, LDB_WAIT_ALL);
760 talloc_free(search_req);
761 if (ret != LDB_SUCCESS) {
766 switch (req->op.seq_num.type) {
767 case LDB_SEQ_HIGHEST_SEQ:
768 req->op.seq_num.seq_num = max_seq;
771 req->op.seq_num.seq_num = max_seq;
772 req->op.seq_num.seq_num++;
774 case LDB_SEQ_HIGHEST_TIMESTAMP:
776 req->op.seq_num.seq_num = (max_seq >> 24);
780 req->op.seq_num.flags = 0;
781 req->op.seq_num.flags |= LDB_SEQ_TIMESTAMP_SEQUENCE;
782 req->op.seq_num.flags |= LDB_SEQ_GLOBAL_SEQUENCE;
786 _PUBLIC_ const struct ldb_module_ops ldb_entryuuid_module_ops = {
788 .init_context = entryuuid_init,
789 .sequence_number = entryuuid_sequence_number,
793 _PUBLIC_ const struct ldb_module_ops ldb_nsuniqueid_module_ops = {
794 .name = "nsuniqueid",
795 .init_context = nsuniqueid_init,
796 .sequence_number = entryuuid_sequence_number,