2 Unix SMB/CIFS mplementation.
3 LDAP protocol helper functions for SAMBA
5 Copyright (C) Simo Sorce 2005
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 2 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, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include "libcli/util/asn_1.h"
25 #include "libcli/ldap/ldap.h"
26 #include "lib/ldb/include/ldb.h"
28 struct control_handler {
30 BOOL (*decode)(void *mem_ctx, DATA_BLOB in, void **out);
31 BOOL (*encode)(void *mem_ctx, void *in, DATA_BLOB *out);
34 static BOOL decode_server_sort_response(void *mem_ctx, DATA_BLOB in, void **out)
37 struct asn1_data data;
38 struct ldb_sort_resp_control *lsrc;
40 if (!asn1_load(&data, in)) {
44 lsrc = talloc(mem_ctx, struct ldb_sort_resp_control);
49 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
53 if (!asn1_read_enumerated(&data, &(lsrc->result))) {
57 lsrc->attr_desc = NULL;
58 if (asn1_peek_tag(&data, ASN1_OCTET_STRING)) {
59 if (!asn1_read_OctetString(&data, &attr)) {
62 lsrc->attr_desc = talloc_strndup(lsrc, (const char *)attr.data, attr.length);
63 if (!lsrc->attr_desc) {
68 if (!asn1_end_tag(&data)) {
77 static BOOL decode_server_sort_request(void *mem_ctx, DATA_BLOB in, void **out)
81 struct asn1_data data;
82 struct ldb_server_sort_control **lssc;
85 if (!asn1_load(&data, in)) {
89 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
95 for (num = 0; asn1_peek_tag(&data, ASN1_SEQUENCE(0)); num++) {
96 lssc = talloc_realloc(mem_ctx, lssc, struct ldb_server_sort_control *, num + 2);
100 lssc[num] = talloc_zero(lssc, struct ldb_server_sort_control);
105 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
109 if (!asn1_read_OctetString(&data, &attr)) {
113 lssc[num]->attributeName = talloc_strndup(lssc[num], (const char *)attr.data, attr.length);
114 if (!lssc [num]->attributeName) {
118 if (asn1_peek_tag(&data, ASN1_OCTET_STRING)) {
119 if (!asn1_read_OctetString(&data, &rule)) {
122 lssc[num]->orderingRule = talloc_strndup(lssc[num], (const char *)rule.data, rule.length);
123 if (!lssc[num]->orderingRule) {
128 if (asn1_peek_tag(&data, ASN1_BOOLEAN)) {
130 if (!asn1_read_BOOLEAN(&data, &reverse)) {
133 lssc[num]->reverse = reverse;
136 if (!asn1_end_tag(&data)) {
145 if (!asn1_end_tag(&data)) {
154 static BOOL decode_extended_dn_request(void *mem_ctx, DATA_BLOB in, void **out)
156 struct asn1_data data;
157 struct ldb_extended_dn_control *ledc;
159 if (!asn1_load(&data, in)) {
163 ledc = talloc(mem_ctx, struct ldb_extended_dn_control);
168 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
172 if (!asn1_read_Integer(&data, &(ledc->type))) {
176 if (!asn1_end_tag(&data)) {
185 static BOOL decode_sd_flags_request(void *mem_ctx, DATA_BLOB in, void **out)
187 struct asn1_data data;
188 struct ldb_sd_flags_control *lsdfc;
190 if (!asn1_load(&data, in)) {
194 lsdfc = talloc(mem_ctx, struct ldb_sd_flags_control);
199 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
203 if (!asn1_read_Integer(&data, &(lsdfc->secinfo_flags))) {
207 if (!asn1_end_tag(&data)) {
216 static BOOL decode_search_options_request(void *mem_ctx, DATA_BLOB in, void **out)
218 struct asn1_data data;
219 struct ldb_search_options_control *lsoc;
221 if (!asn1_load(&data, in)) {
225 lsoc = talloc(mem_ctx, struct ldb_search_options_control);
230 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
234 if (!asn1_read_Integer(&data, &(lsoc->search_options))) {
238 if (!asn1_end_tag(&data)) {
247 static BOOL decode_paged_results_request(void *mem_ctx, DATA_BLOB in, void **out)
250 struct asn1_data data;
251 struct ldb_paged_control *lprc;
253 if (!asn1_load(&data, in)) {
257 lprc = talloc(mem_ctx, struct ldb_paged_control);
262 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
266 if (!asn1_read_Integer(&data, &(lprc->size))) {
270 if (!asn1_read_OctetString(&data, &cookie)) {
273 lprc->cookie_len = cookie.length;
274 if (lprc->cookie_len) {
275 lprc->cookie = talloc_memdup(lprc, cookie.data, cookie.length);
277 if (!(lprc->cookie)) {
284 if (!asn1_end_tag(&data)) {
293 static BOOL decode_dirsync_request(void *mem_ctx, DATA_BLOB in, void **out)
296 struct asn1_data data;
297 struct ldb_dirsync_control *ldc;
299 if (!asn1_load(&data, in)) {
303 ldc = talloc(mem_ctx, struct ldb_dirsync_control);
308 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
312 if (!asn1_read_Integer(&data, &(ldc->flags))) {
316 if (!asn1_read_Integer(&data, &(ldc->max_attributes))) {
320 if (!asn1_read_OctetString(&data, &cookie)) {
323 ldc->cookie_len = cookie.length;
324 if (ldc->cookie_len) {
325 ldc->cookie = talloc_memdup(ldc, cookie.data, cookie.length);
327 if (!(ldc->cookie)) {
334 if (!asn1_end_tag(&data)) {
343 /* seem that this controls has 2 forms one in case it is used with
344 * a Search Request and another when used ina Search Response
346 static BOOL decode_asq_control(void *mem_ctx, DATA_BLOB in, void **out)
348 DATA_BLOB source_attribute;
349 struct asn1_data data;
350 struct ldb_asq_control *lac;
352 if (!asn1_load(&data, in)) {
356 lac = talloc(mem_ctx, struct ldb_asq_control);
361 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
365 if (asn1_peek_tag(&data, ASN1_OCTET_STRING)) {
367 if (!asn1_read_OctetString(&data, &source_attribute)) {
370 lac->src_attr_len = source_attribute.length;
371 if (lac->src_attr_len) {
372 lac->source_attribute = talloc_strndup(lac, (const char *)source_attribute.data, source_attribute.length);
374 if (!(lac->source_attribute)) {
378 lac->source_attribute = NULL;
383 } else if (asn1_peek_tag(&data, ASN1_ENUMERATED)) {
385 if (!asn1_read_enumerated(&data, &(lac->result))) {
395 if (!asn1_end_tag(&data)) {
404 static BOOL decode_domain_scope_request(void *mem_ctx, DATA_BLOB in, void **out)
406 if (in.length != 0) {
413 static BOOL decode_notification_request(void *mem_ctx, DATA_BLOB in, void **out)
415 if (in.length != 0) {
422 static BOOL decode_manageDSAIT_request(void *mem_ctx, DATA_BLOB in, void **out)
424 if (in.length != 0) {
431 static BOOL decode_vlv_request(void *mem_ctx, DATA_BLOB in, void **out)
433 DATA_BLOB assertion_value, context_id;
434 struct asn1_data data;
435 struct ldb_vlv_req_control *lvrc;
437 if (!asn1_load(&data, in)) {
441 lvrc = talloc(mem_ctx, struct ldb_vlv_req_control);
446 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
450 if (!asn1_read_Integer(&data, &(lvrc->beforeCount))) {
454 if (!asn1_read_Integer(&data, &(lvrc->afterCount))) {
458 if (asn1_peek_tag(&data, ASN1_CONTEXT(0))) {
462 if (!asn1_start_tag(&data, ASN1_CONTEXT(0))) {
466 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
470 if (!asn1_read_Integer(&data, &(lvrc->match.byOffset.offset))) {
474 if (!asn1_read_Integer(&data, &(lvrc->match.byOffset.contentCount))) {
478 if (!asn1_end_tag(&data)) { /*SEQUENCE*/
482 if (!asn1_end_tag(&data)) { /*CONTEXT*/
490 if (!asn1_start_tag(&data, ASN1_CONTEXT(1))) {
494 if (!asn1_read_OctetString(&data, &assertion_value)) {
497 lvrc->match.gtOrEq.value_len = assertion_value.length;
498 if (lvrc->match.gtOrEq.value_len) {
499 lvrc->match.gtOrEq.value = talloc_memdup(lvrc, assertion_value.data, assertion_value.length);
501 if (!(lvrc->match.gtOrEq.value)) {
505 lvrc->match.gtOrEq.value = NULL;
508 if (!asn1_end_tag(&data)) { /*CONTEXT*/
513 if (asn1_peek_tag(&data, ASN1_OCTET_STRING)) {
514 if (!asn1_read_OctetString(&data, &context_id)) {
517 lvrc->ctxid_len = context_id.length;
518 if (lvrc->ctxid_len) {
519 lvrc->contextId = talloc_memdup(lvrc, context_id.data, context_id.length);
521 if (!(lvrc->contextId)) {
525 lvrc->contextId = NULL;
528 lvrc->contextId = NULL;
532 if (!asn1_end_tag(&data)) {
541 static BOOL decode_vlv_response(void *mem_ctx, DATA_BLOB in, void **out)
543 DATA_BLOB context_id;
544 struct asn1_data data;
545 struct ldb_vlv_resp_control *lvrc;
547 if (!asn1_load(&data, in)) {
551 lvrc = talloc(mem_ctx, struct ldb_vlv_resp_control);
556 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
560 if (!asn1_read_Integer(&data, &(lvrc->targetPosition))) {
564 if (!asn1_read_Integer(&data, &(lvrc->contentCount))) {
568 if (!asn1_read_enumerated(&data, &(lvrc->vlv_result))) {
572 if (asn1_peek_tag(&data, ASN1_OCTET_STRING)) {
573 if (!asn1_read_OctetString(&data, &context_id)) {
576 lvrc->contextId = talloc_strndup(lvrc, (const char *)context_id.data, context_id.length);
577 if (!lvrc->contextId) {
580 lvrc->ctxid_len = context_id.length;
582 lvrc->contextId = NULL;
586 if (!asn1_end_tag(&data)) {
595 static BOOL encode_server_sort_response(void *mem_ctx, void *in, DATA_BLOB *out)
597 struct ldb_sort_resp_control *lsrc = talloc_get_type(in, struct ldb_sort_resp_control);
598 struct asn1_data data;
602 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
606 if (!asn1_write_enumerated(&data, lsrc->result)) {
610 if (lsrc->attr_desc) {
611 if (!asn1_write_OctetString(&data, lsrc->attr_desc, strlen(lsrc->attr_desc))) {
616 if (!asn1_pop_tag(&data)) {
620 *out = data_blob_talloc(mem_ctx, data.data, data.length);
621 if (out->data == NULL) {
628 static BOOL encode_server_sort_request(void *mem_ctx, void *in, DATA_BLOB *out)
630 struct ldb_server_sort_control **lssc = talloc_get_type(in, struct ldb_server_sort_control *);
631 struct asn1_data data;
636 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
640 for (num = 0; lssc[num]; num++) {
641 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
645 if (!asn1_write_OctetString(&data, lssc[num]->attributeName, strlen(lssc[num]->attributeName))) {
649 if (lssc[num]->orderingRule) {
650 if (!asn1_write_OctetString(&data, lssc[num]->orderingRule, strlen(lssc[num]->orderingRule))) {
655 if (lssc[num]->reverse) {
656 if (!asn1_write_BOOLEAN(&data, lssc[num]->reverse)) {
661 if (!asn1_pop_tag(&data)) {
666 if (!asn1_pop_tag(&data)) {
670 *out = data_blob_talloc(mem_ctx, data.data, data.length);
671 if (out->data == NULL) {
678 static BOOL encode_extended_dn_request(void *mem_ctx, void *in, DATA_BLOB *out)
680 struct ldb_extended_dn_control *ledc = talloc_get_type(in, struct ldb_extended_dn_control);
681 struct asn1_data data;
685 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
689 if (!asn1_write_Integer(&data, ledc->type)) {
693 if (!asn1_pop_tag(&data)) {
697 *out = data_blob_talloc(mem_ctx, data.data, data.length);
698 if (out->data == NULL) {
705 static BOOL encode_sd_flags_request(void *mem_ctx, void *in, DATA_BLOB *out)
707 struct ldb_sd_flags_control *lsdfc = talloc_get_type(in, struct ldb_sd_flags_control);
708 struct asn1_data data;
712 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
716 if (!asn1_write_Integer(&data, lsdfc->secinfo_flags)) {
720 if (!asn1_pop_tag(&data)) {
724 *out = data_blob_talloc(mem_ctx, data.data, data.length);
725 if (out->data == NULL) {
732 static BOOL encode_search_options_request(void *mem_ctx, void *in, DATA_BLOB *out)
734 struct ldb_search_options_control *lsoc = talloc_get_type(in, struct ldb_search_options_control);
735 struct asn1_data data;
739 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
743 if (!asn1_write_Integer(&data, lsoc->search_options)) {
747 if (!asn1_pop_tag(&data)) {
751 *out = data_blob_talloc(mem_ctx, data.data, data.length);
752 if (out->data == NULL) {
759 static BOOL encode_paged_results_request(void *mem_ctx, void *in, DATA_BLOB *out)
761 struct ldb_paged_control *lprc = talloc_get_type(in, struct ldb_paged_control);
762 struct asn1_data data;
766 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
770 if (!asn1_write_Integer(&data, lprc->size)) {
774 if (!asn1_write_OctetString(&data, lprc->cookie, lprc->cookie_len)) {
778 if (!asn1_pop_tag(&data)) {
782 *out = data_blob_talloc(mem_ctx, data.data, data.length);
783 if (out->data == NULL) {
790 /* seem that this controls has 2 forms one in case it is used with
791 * a Search Request and another when used ina Search Response
793 static BOOL encode_asq_control(void *mem_ctx, void *in, DATA_BLOB *out)
795 struct ldb_asq_control *lac = talloc_get_type(in, struct ldb_asq_control);
796 struct asn1_data data;
800 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
806 if (!asn1_write_OctetString(&data, lac->source_attribute, lac->src_attr_len)) {
810 if (!asn1_write_enumerated(&data, lac->result)) {
815 if (!asn1_pop_tag(&data)) {
819 *out = data_blob_talloc(mem_ctx, data.data, data.length);
820 if (out->data == NULL) {
827 static BOOL encode_dirsync_request(void *mem_ctx, void *in, DATA_BLOB *out)
829 struct ldb_dirsync_control *ldc = talloc_get_type(in, struct ldb_dirsync_control);
830 struct asn1_data data;
834 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
838 if (!asn1_write_Integer(&data, ldc->flags)) {
842 if (!asn1_write_Integer(&data, ldc->max_attributes)) {
846 if (!asn1_write_OctetString(&data, ldc->cookie, ldc->cookie_len)) {
850 if (!asn1_pop_tag(&data)) {
854 *out = data_blob_talloc(mem_ctx, data.data, data.length);
855 if (out->data == NULL) {
862 static BOOL encode_domain_scope_request(void *mem_ctx, void *in, DATA_BLOB *out)
868 *out = data_blob(NULL, 0);
872 static BOOL encode_notification_request(void *mem_ctx, void *in, DATA_BLOB *out)
878 *out = data_blob(NULL, 0);
882 static BOOL encode_manageDSAIT_request(void *mem_ctx, void *in, DATA_BLOB *out)
888 *out = data_blob(NULL, 0);
892 static BOOL encode_vlv_request(void *mem_ctx, void *in, DATA_BLOB *out)
894 struct ldb_vlv_req_control *lvrc = talloc_get_type(in, struct ldb_vlv_req_control);
895 struct asn1_data data;
899 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
903 if (!asn1_write_Integer(&data, lvrc->beforeCount)) {
907 if (!asn1_write_Integer(&data, lvrc->afterCount)) {
911 if (lvrc->type == 0) {
912 if (!asn1_push_tag(&data, ASN1_CONTEXT(0))) {
916 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
920 if (!asn1_write_Integer(&data, lvrc->match.byOffset.offset)) {
924 if (!asn1_write_Integer(&data, lvrc->match.byOffset.contentCount)) {
928 if (!asn1_pop_tag(&data)) { /*SEQUENCE*/
932 if (!asn1_pop_tag(&data)) { /*CONTEXT*/
936 if (!asn1_push_tag(&data, ASN1_CONTEXT(1))) {
940 if (!asn1_write_OctetString(&data, lvrc->match.gtOrEq.value, lvrc->match.gtOrEq.value_len)) {
944 if (!asn1_pop_tag(&data)) { /*CONTEXT*/
949 if (lvrc->ctxid_len) {
950 if (!asn1_write_OctetString(&data, lvrc->contextId, lvrc->ctxid_len)) {
955 if (!asn1_pop_tag(&data)) {
959 *out = data_blob_talloc(mem_ctx, data.data, data.length);
960 if (out->data == NULL) {
967 static BOOL encode_vlv_response(void *mem_ctx, void *in, DATA_BLOB *out)
969 struct ldb_vlv_resp_control *lvrc = talloc_get_type(in, struct ldb_vlv_resp_control);
970 struct asn1_data data;
974 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
978 if (!asn1_write_Integer(&data, lvrc->targetPosition)) {
982 if (!asn1_write_Integer(&data, lvrc->contentCount)) {
986 if (!asn1_write_enumerated(&data, lvrc->vlv_result)) {
990 if (lvrc->ctxid_len) {
991 if (!asn1_write_OctetString(&data, lvrc->contextId, lvrc->ctxid_len)) {
996 if (!asn1_pop_tag(&data)) {
1000 *out = data_blob_talloc(mem_ctx, data.data, data.length);
1001 if (out->data == NULL) {
1008 struct control_handler ldap_known_controls[] = {
1009 { "1.2.840.113556.1.4.319", decode_paged_results_request, encode_paged_results_request },
1010 { "1.2.840.113556.1.4.529", decode_extended_dn_request, encode_extended_dn_request },
1011 { "1.2.840.113556.1.4.473", decode_server_sort_request, encode_server_sort_request },
1012 { "1.2.840.113556.1.4.474", decode_server_sort_response, encode_server_sort_response },
1013 { "1.2.840.113556.1.4.1504", decode_asq_control, encode_asq_control },
1014 { "1.2.840.113556.1.4.841", decode_dirsync_request, encode_dirsync_request },
1015 { "1.2.840.113556.1.4.528", decode_notification_request, encode_notification_request },
1016 { "1.2.840.113556.1.4.801", decode_sd_flags_request, encode_sd_flags_request },
1017 { "1.2.840.113556.1.4.1339", decode_domain_scope_request, encode_domain_scope_request },
1018 { "1.2.840.113556.1.4.1340", decode_search_options_request, encode_search_options_request },
1019 { "2.16.840.1.113730.3.4.2", decode_manageDSAIT_request, encode_manageDSAIT_request },
1020 { "2.16.840.1.113730.3.4.9", decode_vlv_request, encode_vlv_request },
1021 { "2.16.840.1.113730.3.4.10", decode_vlv_response, encode_vlv_response },
1022 { NULL, NULL, NULL }
1025 BOOL ldap_decode_control(void *mem_ctx, struct asn1_data *data, struct ldb_control *ctrl)
1031 if (!asn1_start_tag(data, ASN1_SEQUENCE(0))) {
1035 if (!asn1_read_OctetString(data, &oid)) {
1038 ctrl->oid = talloc_strndup(mem_ctx, (char *)oid.data, oid.length);
1043 if (asn1_peek_tag(data, ASN1_BOOLEAN)) {
1045 if (!asn1_read_BOOLEAN(data, &critical)) {
1048 ctrl->critical = critical;
1050 ctrl->critical = False;
1055 if (!asn1_peek_tag(data, ASN1_OCTET_STRING)) {
1059 if (!asn1_read_OctetString(data, &value)) {
1063 for (i = 0; ldap_known_controls[i].oid != NULL; i++) {
1064 if (strcmp(ldap_known_controls[i].oid, ctrl->oid) == 0) {
1065 if (!ldap_known_controls[i].decode(mem_ctx, value, &ctrl->data)) {
1071 if (ldap_known_controls[i].oid == NULL) {
1076 if (!asn1_end_tag(data)) {
1083 BOOL ldap_encode_control(void *mem_ctx, struct asn1_data *data, struct ldb_control *ctrl)
1088 if (!asn1_push_tag(data, ASN1_SEQUENCE(0))) {
1092 if (!asn1_write_OctetString(data, ctrl->oid, strlen(ctrl->oid))) {
1096 if (ctrl->critical) {
1097 if (!asn1_write_BOOLEAN(data, ctrl->critical)) {
1106 for (i = 0; ldap_known_controls[i].oid != NULL; i++) {
1107 if (strcmp(ldap_known_controls[i].oid, ctrl->oid) == 0) {
1108 if (!ldap_known_controls[i].encode(mem_ctx, ctrl->data, &value)) {
1114 if (ldap_known_controls[i].oid == NULL) {
1118 if (!asn1_write_OctetString(data, value.data, value.length)) {
1123 if (!asn1_pop_tag(data)) {