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 "system/iconv.h"
25 #include "libcli/util/asn_1.h"
26 #include "libcli/ldap/ldap.h"
27 #include "lib/ldb/include/ldb.h"
29 struct control_handler {
31 BOOL (*decode)(void *mem_ctx, DATA_BLOB in, void **out);
32 BOOL (*encode)(void *mem_ctx, void *in, DATA_BLOB *out);
35 static BOOL decode_server_sort_response(void *mem_ctx, DATA_BLOB in, void **out)
38 struct asn1_data data;
39 struct ldb_sort_resp_control *lsrc;
41 if (!asn1_load(&data, in)) {
45 lsrc = talloc(mem_ctx, struct ldb_sort_resp_control);
50 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
54 if (!asn1_read_enumerated(&data, &(lsrc->result))) {
58 lsrc->attr_desc = NULL;
59 if (asn1_peek_tag(&data, ASN1_OCTET_STRING)) {
60 if (!asn1_read_OctetString(&data, &attr)) {
63 lsrc->attr_desc = talloc_strndup(lsrc, (const char *)attr.data, attr.length);
64 if (!lsrc->attr_desc) {
69 if (!asn1_end_tag(&data)) {
78 static BOOL decode_server_sort_request(void *mem_ctx, DATA_BLOB in, void **out)
82 struct asn1_data data;
83 struct ldb_server_sort_control **lssc;
86 if (!asn1_load(&data, in)) {
90 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
96 for (num = 0; asn1_peek_tag(&data, ASN1_SEQUENCE(0)); num++) {
97 lssc = talloc_realloc(mem_ctx, lssc, struct ldb_server_sort_control *, num + 2);
101 lssc[num] = talloc_zero(lssc, struct ldb_server_sort_control);
106 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
110 if (!asn1_read_OctetString(&data, &attr)) {
114 lssc[num]->attributeName = talloc_strndup(lssc[num], (const char *)attr.data, attr.length);
115 if (!lssc [num]->attributeName) {
119 if (asn1_peek_tag(&data, ASN1_OCTET_STRING)) {
120 if (!asn1_read_OctetString(&data, &rule)) {
123 lssc[num]->orderingRule = talloc_strndup(lssc[num], (const char *)rule.data, rule.length);
124 if (!lssc[num]->orderingRule) {
129 if (asn1_peek_tag(&data, ASN1_BOOLEAN)) {
130 if (!asn1_read_BOOLEAN(&data, &(lssc[num]->reverse))) {
135 if (!asn1_end_tag(&data)) {
142 if (!asn1_end_tag(&data)) {
151 static BOOL decode_extended_dn_request(void *mem_ctx, DATA_BLOB in, void **out)
153 struct asn1_data data;
154 struct ldb_extended_dn_control *ledc;
156 if (!asn1_load(&data, in)) {
160 ledc = talloc(mem_ctx, struct ldb_extended_dn_control);
165 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
169 if (!asn1_read_Integer(&data, &(ledc->type))) {
173 if (!asn1_end_tag(&data)) {
182 static BOOL decode_paged_results_request(void *mem_ctx, DATA_BLOB in, void **out)
185 struct asn1_data data;
186 struct ldb_paged_control *lprc;
188 if (!asn1_load(&data, in)) {
192 lprc = talloc(mem_ctx, struct ldb_paged_control);
197 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
201 if (!asn1_read_Integer(&data, &(lprc->size))) {
205 if (!asn1_read_OctetString(&data, &cookie)) {
208 lprc->cookie_len = cookie.length;
209 if (lprc->cookie_len) {
210 lprc->cookie = talloc_memdup(lprc, cookie.data, cookie.length);
212 if (!(lprc->cookie)) {
219 if (!asn1_end_tag(&data)) {
228 static BOOL decode_dirsync_request(void *mem_ctx, DATA_BLOB in, void **out)
231 struct asn1_data data;
232 struct ldb_dirsync_control *ldc;
234 if (!asn1_load(&data, in)) {
238 ldc = talloc(mem_ctx, struct ldb_dirsync_control);
243 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
247 if (!asn1_read_Integer(&data, &(ldc->flags))) {
251 if (!asn1_read_Integer(&data, &(ldc->max_attributes))) {
255 if (!asn1_read_OctetString(&data, &cookie)) {
258 ldc->cookie_len = cookie.length;
259 if (ldc->cookie_len) {
260 ldc->cookie = talloc_memdup(ldc, cookie.data, cookie.length);
262 if (!(ldc->cookie)) {
269 if (!asn1_end_tag(&data)) {
278 /* seem that this controls has 2 forms one in case it is used with
279 * a Search Request and another when used ina Search Response
281 static BOOL decode_asq_control(void *mem_ctx, DATA_BLOB in, void **out)
283 DATA_BLOB source_attribute;
284 struct asn1_data data;
285 struct ldb_asq_control *lac;
287 if (!asn1_load(&data, in)) {
291 lac = talloc(mem_ctx, struct ldb_asq_control);
296 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
300 if (asn1_peek_tag(&data, ASN1_OCTET_STRING)) {
302 if (!asn1_read_OctetString(&data, &source_attribute)) {
305 lac->src_attr_len = source_attribute.length;
306 if (lac->src_attr_len) {
307 lac->source_attribute = talloc_strndup(lac, (const char *)source_attribute.data, source_attribute.length);
309 if (!(lac->source_attribute)) {
313 lac->source_attribute = NULL;
318 } else if (asn1_peek_tag(&data, ASN1_ENUMERATED)) {
320 if (!asn1_read_enumerated(&data, &(lac->result))) {
330 if (!asn1_end_tag(&data)) {
339 static BOOL decode_notification_request(void *mem_ctx, DATA_BLOB in, void **out)
341 if (in.length != 0) {
348 static BOOL decode_manageDSAIT_request(void *mem_ctx, DATA_BLOB in, void **out)
350 if (in.length != 0) {
357 static BOOL decode_vlv_request(void *mem_ctx, DATA_BLOB in, void **out)
359 DATA_BLOB assertion_value, context_id;
360 struct asn1_data data;
361 struct ldb_vlv_req_control *lvrc;
363 if (!asn1_load(&data, in)) {
367 lvrc = talloc(mem_ctx, struct ldb_vlv_req_control);
372 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
376 if (!asn1_read_Integer(&data, &(lvrc->beforeCount))) {
380 if (!asn1_read_Integer(&data, &(lvrc->afterCount))) {
384 if (asn1_peek_tag(&data, ASN1_CONTEXT(0))) {
388 if (!asn1_start_tag(&data, ASN1_CONTEXT(0))) {
392 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
396 if (!asn1_read_Integer(&data, &(lvrc->match.byOffset.offset))) {
400 if (!asn1_read_Integer(&data, &(lvrc->match.byOffset.contentCount))) {
404 if (!asn1_end_tag(&data)) { /*SEQUENCE*/
408 if (!asn1_end_tag(&data)) { /*CONTEXT*/
416 if (!asn1_start_tag(&data, ASN1_CONTEXT(1))) {
420 if (!asn1_read_OctetString(&data, &assertion_value)) {
423 lvrc->match.gtOrEq.value_len = assertion_value.length;
424 if (lvrc->match.gtOrEq.value_len) {
425 lvrc->match.gtOrEq.value = talloc_memdup(lvrc, assertion_value.data, assertion_value.length);
427 if (!(lvrc->match.gtOrEq.value)) {
431 lvrc->match.gtOrEq.value = NULL;
434 if (!asn1_end_tag(&data)) { /*CONTEXT*/
439 if (asn1_peek_tag(&data, ASN1_OCTET_STRING)) {
440 if (!asn1_read_OctetString(&data, &context_id)) {
443 lvrc->ctxid_len = context_id.length;
444 if (lvrc->ctxid_len) {
445 lvrc->contextId = talloc_memdup(lvrc, context_id.data, context_id.length);
447 if (!(lvrc->contextId)) {
451 lvrc->contextId = NULL;
454 lvrc->contextId = NULL;
458 if (!asn1_end_tag(&data)) {
467 static BOOL decode_vlv_response(void *mem_ctx, DATA_BLOB in, void **out)
469 DATA_BLOB context_id;
470 struct asn1_data data;
471 struct ldb_vlv_resp_control *lvrc;
473 if (!asn1_load(&data, in)) {
477 lvrc = talloc(mem_ctx, struct ldb_vlv_resp_control);
482 if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
486 if (!asn1_read_Integer(&data, &(lvrc->targetPosition))) {
490 if (!asn1_read_Integer(&data, &(lvrc->contentCount))) {
494 if (!asn1_read_enumerated(&data, &(lvrc->vlv_result))) {
498 if (asn1_peek_tag(&data, ASN1_OCTET_STRING)) {
499 if (!asn1_read_OctetString(&data, &context_id)) {
502 lvrc->contextId = talloc_strndup(lvrc, (const char *)context_id.data, context_id.length);
503 if (!lvrc->contextId) {
506 lvrc->ctxid_len = context_id.length;
508 lvrc->contextId = NULL;
512 if (!asn1_end_tag(&data)) {
521 static BOOL encode_server_sort_response(void *mem_ctx, void *in, DATA_BLOB *out)
523 struct ldb_sort_resp_control *lsrc = talloc_get_type(in, struct ldb_sort_resp_control);
524 struct asn1_data data;
528 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
532 if (!asn1_write_enumerated(&data, lsrc->result)) {
536 if (lsrc->attr_desc) {
537 if (!asn1_write_OctetString(&data, lsrc->attr_desc, strlen(lsrc->attr_desc))) {
542 if (!asn1_pop_tag(&data)) {
546 *out = data_blob_talloc(mem_ctx, data.data, data.length);
547 if (out->data == NULL) {
554 static BOOL encode_server_sort_request(void *mem_ctx, void *in, DATA_BLOB *out)
556 struct ldb_server_sort_control **lssc = talloc_get_type(in, struct ldb_server_sort_control *);
557 struct asn1_data data;
562 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
566 for (num = 0; lssc[num]; num++) {
567 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
571 if (!asn1_write_OctetString(&data, lssc[num]->attributeName, strlen(lssc[num]->attributeName))) {
575 if (lssc[num]->orderingRule) {
576 if (!asn1_write_OctetString(&data, lssc[num]->orderingRule, strlen(lssc[num]->orderingRule))) {
581 if (lssc[num]->reverse) {
582 if (!asn1_write_BOOLEAN(&data, lssc[num]->reverse)) {
587 if (!asn1_pop_tag(&data)) {
592 if (!asn1_pop_tag(&data)) {
596 *out = data_blob_talloc(mem_ctx, data.data, data.length);
597 if (out->data == NULL) {
604 static BOOL encode_extended_dn_request(void *mem_ctx, void *in, DATA_BLOB *out)
606 struct ldb_extended_dn_control *ledc = talloc_get_type(in, struct ldb_extended_dn_control);
607 struct asn1_data data;
611 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
615 if (!asn1_write_Integer(&data, ledc->type)) {
619 if (!asn1_pop_tag(&data)) {
623 *out = data_blob_talloc(mem_ctx, data.data, data.length);
624 if (out->data == NULL) {
631 static BOOL encode_paged_results_request(void *mem_ctx, void *in, DATA_BLOB *out)
633 struct ldb_paged_control *lprc = talloc_get_type(in, struct ldb_paged_control);
634 struct asn1_data data;
638 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
642 if (!asn1_write_Integer(&data, lprc->size)) {
646 if (!asn1_write_OctetString(&data, lprc->cookie, lprc->cookie_len)) {
650 if (!asn1_pop_tag(&data)) {
654 *out = data_blob_talloc(mem_ctx, data.data, data.length);
655 if (out->data == NULL) {
662 /* seem that this controls has 2 forms one in case it is used with
663 * a Search Request and another when used ina Search Response
665 static BOOL encode_asq_control(void *mem_ctx, void *in, DATA_BLOB *out)
667 struct ldb_asq_control *lac = talloc_get_type(in, struct ldb_asq_control);
668 struct asn1_data data;
672 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
678 if (!asn1_write_OctetString(&data, lac->source_attribute, lac->src_attr_len)) {
682 if (!asn1_write_enumerated(&data, lac->result)) {
687 if (!asn1_pop_tag(&data)) {
691 *out = data_blob_talloc(mem_ctx, data.data, data.length);
692 if (out->data == NULL) {
699 static BOOL encode_dirsync_request(void *mem_ctx, void *in, DATA_BLOB *out)
701 struct ldb_dirsync_control *ldc = talloc_get_type(in, struct ldb_dirsync_control);
702 struct asn1_data data;
706 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
710 if (!asn1_write_Integer(&data, ldc->flags)) {
714 if (!asn1_write_Integer(&data, ldc->max_attributes)) {
718 if (!asn1_write_OctetString(&data, ldc->cookie, ldc->cookie_len)) {
722 if (!asn1_pop_tag(&data)) {
726 *out = data_blob_talloc(mem_ctx, data.data, data.length);
727 if (out->data == NULL) {
734 static BOOL encode_notification_request(void *mem_ctx, void *in, DATA_BLOB *out)
740 *out = data_blob(NULL, 0);
744 static BOOL encode_manageDSAIT_request(void *mem_ctx, void *in, DATA_BLOB *out)
750 *out = data_blob(NULL, 0);
754 static BOOL encode_vlv_request(void *mem_ctx, void *in, DATA_BLOB *out)
756 struct ldb_vlv_req_control *lvrc = talloc_get_type(in, struct ldb_vlv_req_control);
757 struct asn1_data data;
761 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
765 if (!asn1_write_Integer(&data, lvrc->beforeCount)) {
769 if (!asn1_write_Integer(&data, lvrc->afterCount)) {
773 if (lvrc->type == 0) {
774 if (!asn1_push_tag(&data, ASN1_CONTEXT(0))) {
778 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
782 if (!asn1_write_Integer(&data, lvrc->match.byOffset.offset)) {
786 if (!asn1_write_Integer(&data, lvrc->match.byOffset.contentCount)) {
790 if (!asn1_pop_tag(&data)) { /*SEQUENCE*/
794 if (!asn1_pop_tag(&data)) { /*CONTEXT*/
798 if (!asn1_push_tag(&data, ASN1_CONTEXT(1))) {
802 if (!asn1_write_OctetString(&data, lvrc->match.gtOrEq.value, lvrc->match.gtOrEq.value_len)) {
806 if (!asn1_pop_tag(&data)) { /*CONTEXT*/
811 if (lvrc->ctxid_len) {
812 if (!asn1_write_OctetString(&data, lvrc->contextId, lvrc->ctxid_len)) {
817 if (!asn1_pop_tag(&data)) {
821 *out = data_blob_talloc(mem_ctx, data.data, data.length);
822 if (out->data == NULL) {
829 static BOOL encode_vlv_response(void *mem_ctx, void *in, DATA_BLOB *out)
831 struct ldb_vlv_resp_control *lvrc = talloc_get_type(in, struct ldb_vlv_resp_control);
832 struct asn1_data data;
836 if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
840 if (!asn1_write_Integer(&data, lvrc->targetPosition)) {
844 if (!asn1_write_Integer(&data, lvrc->contentCount)) {
848 if (!asn1_write_enumerated(&data, lvrc->vlv_result)) {
852 if (lvrc->ctxid_len) {
853 if (!asn1_write_OctetString(&data, lvrc->contextId, lvrc->ctxid_len)) {
858 if (!asn1_pop_tag(&data)) {
862 *out = data_blob_talloc(mem_ctx, data.data, data.length);
863 if (out->data == NULL) {
870 struct control_handler ldap_known_controls[] = {
871 { "1.2.840.113556.1.4.319", decode_paged_results_request, encode_paged_results_request },
872 { "1.2.840.113556.1.4.529", decode_extended_dn_request, encode_extended_dn_request },
873 { "1.2.840.113556.1.4.473", decode_server_sort_request, encode_server_sort_request },
874 { "1.2.840.113556.1.4.474", decode_server_sort_response, encode_server_sort_response },
875 { "1.2.840.113556.1.4.1504", decode_asq_control, encode_asq_control },
876 { "1.2.840.113556.1.4.841", decode_dirsync_request, encode_dirsync_request },
877 { "1.2.840.113556.1.4.528", decode_notification_request, encode_notification_request },
878 { "2.16.840.1.113730.3.4.2", decode_manageDSAIT_request, encode_manageDSAIT_request },
879 { "2.16.840.1.113730.3.4.9", decode_vlv_request, encode_vlv_request },
880 { "2.16.840.1.113730.3.4.10", decode_vlv_response, encode_vlv_response },
884 BOOL ldap_decode_control(void *mem_ctx, struct asn1_data *data, struct ldb_control *ctrl)
890 if (!asn1_start_tag(data, ASN1_SEQUENCE(0))) {
894 if (!asn1_read_OctetString(data, &oid)) {
897 ctrl->oid = talloc_strndup(mem_ctx, (char *)oid.data, oid.length);
902 if (asn1_peek_tag(data, ASN1_BOOLEAN)) {
903 if (!asn1_read_BOOLEAN(data, &(ctrl->critical))) {
907 ctrl->critical = False;
912 if (!asn1_peek_tag(data, ASN1_OCTET_STRING)) {
916 if (!asn1_read_OctetString(data, &value)) {
920 for (i = 0; ldap_known_controls[i].oid != NULL; i++) {
921 if (strcmp(ldap_known_controls[i].oid, ctrl->oid) == 0) {
922 if (!ldap_known_controls[i].decode(mem_ctx, value, &ctrl->data)) {
928 if (ldap_known_controls[i].oid == NULL) {
933 if (!asn1_end_tag(data)) {
940 BOOL ldap_encode_control(void *mem_ctx, struct asn1_data *data, struct ldb_control *ctrl)
945 if (!asn1_push_tag(data, ASN1_SEQUENCE(0))) {
949 if (!asn1_write_OctetString(data, ctrl->oid, strlen(ctrl->oid))) {
953 if (ctrl->critical) {
954 if (!asn1_write_BOOLEAN(data, ctrl->critical)) {
963 for (i = 0; ldap_known_controls[i].oid != NULL; i++) {
964 if (strcmp(ldap_known_controls[i].oid, ctrl->oid) == 0) {
965 if (!ldap_known_controls[i].encode(mem_ctx, ctrl->data, &value)) {
971 if (ldap_known_controls[i].oid == NULL) {
975 if (!asn1_write_OctetString(data, value.data, value.length)) {
980 if (!asn1_pop_tag(data)) {