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_paged_results_request(void *mem_ctx, DATA_BLOB in, void **out)
188 struct asn1_data data;
189 struct ldb_paged_control *lprc;
191 if (!asn1_load(&data, in)) {
195 lprc = talloc(mem_ctx, struct ldb_paged_control);
200 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
204 if (!asn1_read_Integer(&data, &(lprc->size))) {
208 if (!asn1_read_OctetString(&data, &cookie)) {
211 lprc->cookie_len = cookie.length;
212 if (lprc->cookie_len) {
213 lprc->cookie = talloc_memdup(lprc, cookie.data, cookie.length);
215 if (!(lprc->cookie)) {
222 if (!asn1_end_tag(&data)) {
231 static BOOL decode_dirsync_request(void *mem_ctx, DATA_BLOB in, void **out)
234 struct asn1_data data;
235 struct ldb_dirsync_control *ldc;
237 if (!asn1_load(&data, in)) {
241 ldc = talloc(mem_ctx, struct ldb_dirsync_control);
246 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
250 if (!asn1_read_Integer(&data, &(ldc->flags))) {
254 if (!asn1_read_Integer(&data, &(ldc->max_attributes))) {
258 if (!asn1_read_OctetString(&data, &cookie)) {
261 ldc->cookie_len = cookie.length;
262 if (ldc->cookie_len) {
263 ldc->cookie = talloc_memdup(ldc, cookie.data, cookie.length);
265 if (!(ldc->cookie)) {
272 if (!asn1_end_tag(&data)) {
281 /* seem that this controls has 2 forms one in case it is used with
282 * a Search Request and another when used ina Search Response
284 static BOOL decode_asq_control(void *mem_ctx, DATA_BLOB in, void **out)
286 DATA_BLOB source_attribute;
287 struct asn1_data data;
288 struct ldb_asq_control *lac;
290 if (!asn1_load(&data, in)) {
294 lac = talloc(mem_ctx, struct ldb_asq_control);
299 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
303 if (asn1_peek_tag(&data, ASN1_OCTET_STRING)) {
305 if (!asn1_read_OctetString(&data, &source_attribute)) {
308 lac->src_attr_len = source_attribute.length;
309 if (lac->src_attr_len) {
310 lac->source_attribute = talloc_strndup(lac, (const char *)source_attribute.data, source_attribute.length);
312 if (!(lac->source_attribute)) {
316 lac->source_attribute = NULL;
321 } else if (asn1_peek_tag(&data, ASN1_ENUMERATED)) {
323 if (!asn1_read_enumerated(&data, &(lac->result))) {
333 if (!asn1_end_tag(&data)) {
342 static BOOL decode_notification_request(void *mem_ctx, DATA_BLOB in, void **out)
344 if (in.length != 0) {
351 static BOOL decode_manageDSAIT_request(void *mem_ctx, DATA_BLOB in, void **out)
353 if (in.length != 0) {
360 static BOOL decode_vlv_request(void *mem_ctx, DATA_BLOB in, void **out)
362 DATA_BLOB assertion_value, context_id;
363 struct asn1_data data;
364 struct ldb_vlv_req_control *lvrc;
366 if (!asn1_load(&data, in)) {
370 lvrc = talloc(mem_ctx, struct ldb_vlv_req_control);
375 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
379 if (!asn1_read_Integer(&data, &(lvrc->beforeCount))) {
383 if (!asn1_read_Integer(&data, &(lvrc->afterCount))) {
387 if (asn1_peek_tag(&data, ASN1_CONTEXT(0))) {
391 if (!asn1_start_tag(&data, ASN1_CONTEXT(0))) {
395 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
399 if (!asn1_read_Integer(&data, &(lvrc->match.byOffset.offset))) {
403 if (!asn1_read_Integer(&data, &(lvrc->match.byOffset.contentCount))) {
407 if (!asn1_end_tag(&data)) { /*SEQUENCE*/
411 if (!asn1_end_tag(&data)) { /*CONTEXT*/
419 if (!asn1_start_tag(&data, ASN1_CONTEXT(1))) {
423 if (!asn1_read_OctetString(&data, &assertion_value)) {
426 lvrc->match.gtOrEq.value_len = assertion_value.length;
427 if (lvrc->match.gtOrEq.value_len) {
428 lvrc->match.gtOrEq.value = talloc_memdup(lvrc, assertion_value.data, assertion_value.length);
430 if (!(lvrc->match.gtOrEq.value)) {
434 lvrc->match.gtOrEq.value = NULL;
437 if (!asn1_end_tag(&data)) { /*CONTEXT*/
442 if (asn1_peek_tag(&data, ASN1_OCTET_STRING)) {
443 if (!asn1_read_OctetString(&data, &context_id)) {
446 lvrc->ctxid_len = context_id.length;
447 if (lvrc->ctxid_len) {
448 lvrc->contextId = talloc_memdup(lvrc, context_id.data, context_id.length);
450 if (!(lvrc->contextId)) {
454 lvrc->contextId = NULL;
457 lvrc->contextId = NULL;
461 if (!asn1_end_tag(&data)) {
470 static BOOL decode_vlv_response(void *mem_ctx, DATA_BLOB in, void **out)
472 DATA_BLOB context_id;
473 struct asn1_data data;
474 struct ldb_vlv_resp_control *lvrc;
476 if (!asn1_load(&data, in)) {
480 lvrc = talloc(mem_ctx, struct ldb_vlv_resp_control);
485 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
489 if (!asn1_read_Integer(&data, &(lvrc->targetPosition))) {
493 if (!asn1_read_Integer(&data, &(lvrc->contentCount))) {
497 if (!asn1_read_enumerated(&data, &(lvrc->vlv_result))) {
501 if (asn1_peek_tag(&data, ASN1_OCTET_STRING)) {
502 if (!asn1_read_OctetString(&data, &context_id)) {
505 lvrc->contextId = talloc_strndup(lvrc, (const char *)context_id.data, context_id.length);
506 if (!lvrc->contextId) {
509 lvrc->ctxid_len = context_id.length;
511 lvrc->contextId = NULL;
515 if (!asn1_end_tag(&data)) {
524 static BOOL encode_server_sort_response(void *mem_ctx, void *in, DATA_BLOB *out)
526 struct ldb_sort_resp_control *lsrc = talloc_get_type(in, struct ldb_sort_resp_control);
527 struct asn1_data data;
531 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
535 if (!asn1_write_enumerated(&data, lsrc->result)) {
539 if (lsrc->attr_desc) {
540 if (!asn1_write_OctetString(&data, lsrc->attr_desc, strlen(lsrc->attr_desc))) {
545 if (!asn1_pop_tag(&data)) {
549 *out = data_blob_talloc(mem_ctx, data.data, data.length);
550 if (out->data == NULL) {
557 static BOOL encode_server_sort_request(void *mem_ctx, void *in, DATA_BLOB *out)
559 struct ldb_server_sort_control **lssc = talloc_get_type(in, struct ldb_server_sort_control *);
560 struct asn1_data data;
565 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
569 for (num = 0; lssc[num]; num++) {
570 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
574 if (!asn1_write_OctetString(&data, lssc[num]->attributeName, strlen(lssc[num]->attributeName))) {
578 if (lssc[num]->orderingRule) {
579 if (!asn1_write_OctetString(&data, lssc[num]->orderingRule, strlen(lssc[num]->orderingRule))) {
584 if (lssc[num]->reverse) {
585 if (!asn1_write_BOOLEAN(&data, lssc[num]->reverse)) {
590 if (!asn1_pop_tag(&data)) {
595 if (!asn1_pop_tag(&data)) {
599 *out = data_blob_talloc(mem_ctx, data.data, data.length);
600 if (out->data == NULL) {
607 static BOOL encode_extended_dn_request(void *mem_ctx, void *in, DATA_BLOB *out)
609 struct ldb_extended_dn_control *ledc = talloc_get_type(in, struct ldb_extended_dn_control);
610 struct asn1_data data;
614 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
618 if (!asn1_write_Integer(&data, ledc->type)) {
622 if (!asn1_pop_tag(&data)) {
626 *out = data_blob_talloc(mem_ctx, data.data, data.length);
627 if (out->data == NULL) {
634 static BOOL encode_paged_results_request(void *mem_ctx, void *in, DATA_BLOB *out)
636 struct ldb_paged_control *lprc = talloc_get_type(in, struct ldb_paged_control);
637 struct asn1_data data;
641 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
645 if (!asn1_write_Integer(&data, lprc->size)) {
649 if (!asn1_write_OctetString(&data, lprc->cookie, lprc->cookie_len)) {
653 if (!asn1_pop_tag(&data)) {
657 *out = data_blob_talloc(mem_ctx, data.data, data.length);
658 if (out->data == NULL) {
665 /* seem that this controls has 2 forms one in case it is used with
666 * a Search Request and another when used ina Search Response
668 static BOOL encode_asq_control(void *mem_ctx, void *in, DATA_BLOB *out)
670 struct ldb_asq_control *lac = talloc_get_type(in, struct ldb_asq_control);
671 struct asn1_data data;
675 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
681 if (!asn1_write_OctetString(&data, lac->source_attribute, lac->src_attr_len)) {
685 if (!asn1_write_enumerated(&data, lac->result)) {
690 if (!asn1_pop_tag(&data)) {
694 *out = data_blob_talloc(mem_ctx, data.data, data.length);
695 if (out->data == NULL) {
702 static BOOL encode_dirsync_request(void *mem_ctx, void *in, DATA_BLOB *out)
704 struct ldb_dirsync_control *ldc = talloc_get_type(in, struct ldb_dirsync_control);
705 struct asn1_data data;
709 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
713 if (!asn1_write_Integer(&data, ldc->flags)) {
717 if (!asn1_write_Integer(&data, ldc->max_attributes)) {
721 if (!asn1_write_OctetString(&data, ldc->cookie, ldc->cookie_len)) {
725 if (!asn1_pop_tag(&data)) {
729 *out = data_blob_talloc(mem_ctx, data.data, data.length);
730 if (out->data == NULL) {
737 static BOOL encode_notification_request(void *mem_ctx, void *in, DATA_BLOB *out)
743 *out = data_blob(NULL, 0);
747 static BOOL encode_manageDSAIT_request(void *mem_ctx, void *in, DATA_BLOB *out)
753 *out = data_blob(NULL, 0);
757 static BOOL encode_vlv_request(void *mem_ctx, void *in, DATA_BLOB *out)
759 struct ldb_vlv_req_control *lvrc = talloc_get_type(in, struct ldb_vlv_req_control);
760 struct asn1_data data;
764 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
768 if (!asn1_write_Integer(&data, lvrc->beforeCount)) {
772 if (!asn1_write_Integer(&data, lvrc->afterCount)) {
776 if (lvrc->type == 0) {
777 if (!asn1_push_tag(&data, ASN1_CONTEXT(0))) {
781 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
785 if (!asn1_write_Integer(&data, lvrc->match.byOffset.offset)) {
789 if (!asn1_write_Integer(&data, lvrc->match.byOffset.contentCount)) {
793 if (!asn1_pop_tag(&data)) { /*SEQUENCE*/
797 if (!asn1_pop_tag(&data)) { /*CONTEXT*/
801 if (!asn1_push_tag(&data, ASN1_CONTEXT(1))) {
805 if (!asn1_write_OctetString(&data, lvrc->match.gtOrEq.value, lvrc->match.gtOrEq.value_len)) {
809 if (!asn1_pop_tag(&data)) { /*CONTEXT*/
814 if (lvrc->ctxid_len) {
815 if (!asn1_write_OctetString(&data, lvrc->contextId, lvrc->ctxid_len)) {
820 if (!asn1_pop_tag(&data)) {
824 *out = data_blob_talloc(mem_ctx, data.data, data.length);
825 if (out->data == NULL) {
832 static BOOL encode_vlv_response(void *mem_ctx, void *in, DATA_BLOB *out)
834 struct ldb_vlv_resp_control *lvrc = talloc_get_type(in, struct ldb_vlv_resp_control);
835 struct asn1_data data;
839 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
843 if (!asn1_write_Integer(&data, lvrc->targetPosition)) {
847 if (!asn1_write_Integer(&data, lvrc->contentCount)) {
851 if (!asn1_write_enumerated(&data, lvrc->vlv_result)) {
855 if (lvrc->ctxid_len) {
856 if (!asn1_write_OctetString(&data, lvrc->contextId, lvrc->ctxid_len)) {
861 if (!asn1_pop_tag(&data)) {
865 *out = data_blob_talloc(mem_ctx, data.data, data.length);
866 if (out->data == NULL) {
873 struct control_handler ldap_known_controls[] = {
874 { "1.2.840.113556.1.4.319", decode_paged_results_request, encode_paged_results_request },
875 { "1.2.840.113556.1.4.529", decode_extended_dn_request, encode_extended_dn_request },
876 { "1.2.840.113556.1.4.473", decode_server_sort_request, encode_server_sort_request },
877 { "1.2.840.113556.1.4.474", decode_server_sort_response, encode_server_sort_response },
878 { "1.2.840.113556.1.4.1504", decode_asq_control, encode_asq_control },
879 { "1.2.840.113556.1.4.841", decode_dirsync_request, encode_dirsync_request },
880 { "1.2.840.113556.1.4.528", decode_notification_request, encode_notification_request },
881 { "2.16.840.1.113730.3.4.2", decode_manageDSAIT_request, encode_manageDSAIT_request },
882 { "2.16.840.1.113730.3.4.9", decode_vlv_request, encode_vlv_request },
883 { "2.16.840.1.113730.3.4.10", decode_vlv_response, encode_vlv_response },
887 BOOL ldap_decode_control(void *mem_ctx, struct asn1_data *data, struct ldb_control *ctrl)
893 if (!asn1_start_tag(data, ASN1_SEQUENCE(0))) {
897 if (!asn1_read_OctetString(data, &oid)) {
900 ctrl->oid = talloc_strndup(mem_ctx, (char *)oid.data, oid.length);
905 if (asn1_peek_tag(data, ASN1_BOOLEAN)) {
907 if (!asn1_read_BOOLEAN(data, &critical)) {
910 ctrl->critical = critical;
912 ctrl->critical = False;
917 if (!asn1_peek_tag(data, ASN1_OCTET_STRING)) {
921 if (!asn1_read_OctetString(data, &value)) {
925 for (i = 0; ldap_known_controls[i].oid != NULL; i++) {
926 if (strcmp(ldap_known_controls[i].oid, ctrl->oid) == 0) {
927 if (!ldap_known_controls[i].decode(mem_ctx, value, &ctrl->data)) {
933 if (ldap_known_controls[i].oid == NULL) {
938 if (!asn1_end_tag(data)) {
945 BOOL ldap_encode_control(void *mem_ctx, struct asn1_data *data, struct ldb_control *ctrl)
950 if (!asn1_push_tag(data, ASN1_SEQUENCE(0))) {
954 if (!asn1_write_OctetString(data, ctrl->oid, strlen(ctrl->oid))) {
958 if (ctrl->critical) {
959 if (!asn1_write_BOOLEAN(data, ctrl->critical)) {
968 for (i = 0; ldap_known_controls[i].oid != NULL; i++) {
969 if (strcmp(ldap_known_controls[i].oid, ctrl->oid) == 0) {
970 if (!ldap_known_controls[i].encode(mem_ctx, ctrl->data, &value)) {
976 if (ldap_known_controls[i].oid == NULL) {
980 if (!asn1_write_OctetString(data, value.data, value.length)) {
985 if (!asn1_pop_tag(data)) {