samba-mirror/source4/libcli/ldap/ldap_controls.c

/* 
   Unix SMB/CIFS mplementation.
   LDAP protocol helper functions for SAMBA
   
   Copyright (C) Simo Sorce 2005
    
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
   
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
   
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   
*/

#include "includes.h"
#include "system/iconv.h"
#include "libcli/util/asn_1.h"
#include "libcli/ldap/ldap.h"
#include "lib/ldb/include/ldb.h"

struct control_handler {
	const char *oid;
	BOOL (*decode)(void *mem_ctx, DATA_BLOB in, void **out);
	BOOL (*encode)(void *mem_ctx, void *in, DATA_BLOB *out);
};

static BOOL decode_server_sort_response(void *mem_ctx, DATA_BLOB in, void **out)
{
	DATA_BLOB attr;
	struct asn1_data data;
	struct ldb_sort_resp_control *lsrc;

	if (!asn1_load(&data, in)) {
		return False;
	}

	lsrc = talloc(mem_ctx, struct ldb_sort_resp_control);
	if (!lsrc) {
		return False;
	}

	if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
		return False;
	}

	if (!asn1_read_enumerated(&data, &(lsrc->result))) {
		return False;
	}

	lsrc->attr_desc = NULL;
	if (asn1_peek_tag(&data, ASN1_OCTET_STRING)) {
		if (!asn1_read_OctetString(&data, &attr)) {
			return False;
		}
		lsrc->attr_desc = talloc_strndup(lsrc, (const char *)attr.data, attr.length);
		if (!lsrc->attr_desc) {
			return False;
		}
	}

	if (!asn1_end_tag(&data)) {
		return False;
	}

	*out = lsrc;

	return True;
}

static BOOL decode_server_sort_request(void *mem_ctx, DATA_BLOB in, void **out)
{
	DATA_BLOB attr;
	DATA_BLOB rule;
	struct asn1_data data;
	struct ldb_server_sort_control **lssc;
	int num;

	if (!asn1_load(&data, in)) {
		return False;
	}

	if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
		return False;
	}

	lssc = NULL;

	for (num = 0; asn1_peek_tag(&data, ASN1_SEQUENCE(0)); num++) {
		lssc = talloc_realloc(mem_ctx, lssc, struct ldb_server_sort_control *, num + 2);
		if (!lssc) {
			return False;
		}
		lssc[num] = talloc(lssc, struct ldb_server_sort_control);
		if (!lssc[num]) {
			return False;
		}

		if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
			return False;
		}

		if (!asn1_read_OctetString(&data, &attr)) {
			return False;
		}

		lssc[num]->attributeName = talloc_strndup(lssc[num], (const char *)attr.data, attr.length);
		if (!lssc [num]->attributeName) {
			return False;
		}
	
		if (asn1_peek_tag(&data, ASN1_OCTET_STRING)) {
			if (!asn1_read_OctetString(&data, &rule)) {
				return False;
			}
			lssc[num]->orderingRule = talloc_strndup(lssc[num], (const char *)rule.data, rule.length);
			if (!lssc[num]->orderingRule) {
				return False;
			}
		}

		if (asn1_peek_tag(&data, ASN1_BOOLEAN)) {
			if (!asn1_read_BOOLEAN(&data, &(lssc[num]->reverse))) {
			return False;
			}
		}
	
		if (!asn1_end_tag(&data)) {
			return False;
		}
	}

	lssc[num] = NULL;

	if (!asn1_end_tag(&data)) {
		return False;
	}

	*out = lssc;

	return True;
}

static BOOL decode_extended_dn_request(void *mem_ctx, DATA_BLOB in, void **out)
{
	struct asn1_data data;
	struct ldb_extended_dn_control *ledc;

	if (!asn1_load(&data, in)) {
		return False;
	}

	ledc = talloc(mem_ctx, struct ldb_extended_dn_control);
	if (!ledc) {
		return False;
	}

	if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
		return False;
	}

	if (!asn1_read_Integer(&data, &(ledc->type))) {
		return False;
	}
	
	if (!asn1_end_tag(&data)) {
		return False;
	}

	*out = ledc;

	return True;
}

static BOOL decode_paged_results_request(void *mem_ctx, DATA_BLOB in, void **out)
{
	DATA_BLOB cookie;
	struct asn1_data data;
	struct ldb_paged_control *lprc;

	if (!asn1_load(&data, in)) {
		return False;
	}

	lprc = talloc(mem_ctx, struct ldb_paged_control);
	if (!lprc) {
		return False;
	}

	if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
		return False;
	}

	if (!asn1_read_Integer(&data, &(lprc->size))) {
		return False;
	}
	
	if (!asn1_read_OctetString(&data, &cookie)) {
		return False;
	}
	lprc->cookie_len = cookie.length;
	if (lprc->cookie_len) {
		lprc->cookie = talloc_memdup(lprc, cookie.data, cookie.length);

		if (!(lprc->cookie)) {
			return False;
		}
	} else {
		lprc->cookie = NULL;
	}

	if (!asn1_end_tag(&data)) {
		return False;
	}

	*out = lprc;

	return True;
}

static BOOL decode_dirsync_request(void *mem_ctx, DATA_BLOB in, void **out)
{
	DATA_BLOB cookie;
	struct asn1_data data;
	struct ldb_dirsync_control *ldc;

	if (!asn1_load(&data, in)) {
		return False;
	}

	ldc = talloc(mem_ctx, struct ldb_dirsync_control);
	if (!ldc) {
		return False;
	}

	if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
		return False;
	}

	if (!asn1_read_Integer(&data, &(ldc->flags))) {
		return False;
	}
	
	if (!asn1_read_Integer(&data, &(ldc->max_attributes))) {
		return False;
	}
	
	if (!asn1_read_OctetString(&data, &cookie)) {
		return False;
	}
	ldc->cookie_len = cookie.length;
	if (ldc->cookie_len) {
		ldc->cookie = talloc_memdup(ldc, cookie.data, cookie.length);

		if (!(ldc->cookie)) {
			return False;
		}
	} else {
		ldc->cookie = NULL;
	}

	if (!asn1_end_tag(&data)) {
		return False;
	}

	*out = ldc;

	return True;
}

/* seem that this controls has 2 forms one in case it is used with
 * a Search Request and another when used ina Search Response
 */
static BOOL decode_asq_control(void *mem_ctx, DATA_BLOB in, void **out)
{
	DATA_BLOB source_attribute;
	struct asn1_data data;
	struct ldb_asq_control *lac;

	if (!asn1_load(&data, in)) {
		return False;
	}

	lac = talloc(mem_ctx, struct ldb_asq_control);
	if (!lac) {
		return False;
	}

	if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
		return False;
	}

	if (asn1_peek_tag(&data, ASN1_OCTET_STRING)) {

		if (!asn1_read_OctetString(&data, &source_attribute)) {
			return False;
		}
		lac->src_attr_len = source_attribute.length;
		if (lac->src_attr_len) {
			lac->source_attribute = talloc_strndup(lac, (char *)source_attribute.data, source_attribute.length);

			if (!(lac->source_attribute)) {
				return False;
			}
		} else {
			lac->source_attribute = NULL;
		}

		lac->request = 1;

	} else if (asn1_peek_tag(&data, ASN1_ENUMERATED)) {

		if (!asn1_read_enumerated(&data, &(lac->result))) {
			return False;
		}

		lac->request = 0;

	} else {
		return False;
	}

	if (!asn1_end_tag(&data)) {
		return False;
	}

	*out = lac;

	return True;
}

static BOOL decode_notification_request(void *mem_ctx, DATA_BLOB in, void **out)
{
	if (in.length != 0) {
		return False;
	}

	return True;
}

static BOOL decode_manageDSAIT_request(void *mem_ctx, DATA_BLOB in, void **out)
{
	if (in.length != 0) {
		return False;
	}

	return True;
}

static BOOL decode_vlv_request(void *mem_ctx, DATA_BLOB in, void **out)
{
	DATA_BLOB assertion_value, context_id;
	struct asn1_data data;
	struct ldb_vlv_req_control *lvrc;

	if (!asn1_load(&data, in)) {
		return False;
	}

	lvrc = talloc(mem_ctx, struct ldb_vlv_req_control);
	if (!lvrc) {
		return False;
	}

	if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
		return False;
	}

	if (!asn1_read_Integer(&data, &(lvrc->beforeCount))) {
		return False;
	}
	
	if (!asn1_read_Integer(&data, &(lvrc->afterCount))) {
		return False;
	}

	if (asn1_peek_tag(&data, ASN1_SEQUENCE(0))) {

		lvrc->type = 0;
		
		if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
			return False;
		}

		if (!asn1_read_Integer(&data, &(lvrc->match.byOffset.offset))) {
			return False;
		}

		if (!asn1_read_Integer(&data, &(lvrc->match.byOffset.contentCount))) {
			return False;
		}

		if (!asn1_end_tag(&data)) {
			return False;
		}

	} else {

		lvrc->type = 1;

		if (!asn1_read_OctetString(&data, &assertion_value)) {
			return False;
		}
		lvrc->match.gtOrEq.value_len = assertion_value.length;
		if (lvrc->match.gtOrEq.value_len) {
			lvrc->match.gtOrEq.value = talloc_memdup(lvrc, assertion_value.data, assertion_value.length);

			if (!(lvrc->match.gtOrEq.value)) {
				return False;
			}
		} else {
			lvrc->match.gtOrEq.value = NULL;
		}
	}

	if (asn1_peek_tag(&data, ASN1_OCTET_STRING)) {
		if (!asn1_read_OctetString(&data, &context_id)) {
			return False;
		}
		lvrc->ctxid_len = context_id.length;
		if (lvrc->ctxid_len) {
			lvrc->contextId = talloc_memdup(lvrc, context_id.data, context_id.length);

			if (!(lvrc->contextId)) {
				return False;
			}
		} else {
			lvrc->contextId = NULL;
		}
	} else {
		lvrc->contextId = NULL;
		lvrc->ctxid_len = 0;
	}

	if (!asn1_end_tag(&data)) {
		return False;
	}

	*out = lvrc;

	return True;
}

static BOOL decode_vlv_response(void *mem_ctx, DATA_BLOB in, void **out)
{
	DATA_BLOB context_id;
	struct asn1_data data;
	struct ldb_vlv_resp_control *lvrc;

	if (!asn1_load(&data, in)) {
		return False;
	}

	lvrc = talloc(mem_ctx, struct ldb_vlv_resp_control);
	if (!lvrc) {
		return False;
	}

	if (!asn1_start_tag(&data, ASN1_SEQUENCE(0))) {
		return False;
	}

	if (!asn1_read_Integer(&data, &(lvrc->targetPosition))) {
		return False;
	}
	
	if (!asn1_read_Integer(&data, &(lvrc->contentCount))) {
		return False;
	}
	
	if (!asn1_read_enumerated(&data, &(lvrc->vlv_result))) {
		return False;
	}

	if (asn1_peek_tag(&data, ASN1_OCTET_STRING)) {
		if (!asn1_read_OctetString(&data, &context_id)) {
			return False;
		}
		lvrc->contextId = talloc_strndup(lvrc, (const char *)context_id.data, context_id.length);
		if (!lvrc->contextId) {
			return False;
		}
		lvrc->ctxid_len = context_id.length;
	} else {
		lvrc->contextId = NULL;
		lvrc->ctxid_len = 0;
	}

	if (!asn1_end_tag(&data)) {
		return False;
	}

	*out = lvrc;

	return True;
}

static BOOL encode_server_sort_response(void *mem_ctx, void *in, DATA_BLOB *out)
{
	struct ldb_sort_resp_control *lsrc = talloc_get_type(in, struct ldb_sort_resp_control);
	struct asn1_data data;

	ZERO_STRUCT(data);

	if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
		return False;
	}

	if (!asn1_write_enumerated(&data, lsrc->result)) {
		return False;
	}

	if (lsrc->attr_desc) {
		if (!asn1_write_OctetString(&data, lsrc->attr_desc, strlen(lsrc->attr_desc))) {
			return False;
		}
	}

	if (!asn1_pop_tag(&data)) {
		return False;
	}

	*out = data_blob_talloc(mem_ctx, data.data, data.length);
	if (out->data == NULL) {
		return False;
	}

	return True;
}

static BOOL encode_server_sort_request(void *mem_ctx, void *in, DATA_BLOB *out)
{
	struct ldb_server_sort_control **lssc = talloc_get_type(in, struct ldb_server_sort_control *);
	struct asn1_data data;
	int num;

	ZERO_STRUCT(data);

	if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
		return False;
	}

	for (num = 0; lssc[num]; num++) {
		if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
			return False;
		}
		
		if (!asn1_write_OctetString(&data, lssc[num]->attributeName, strlen(lssc[num]->attributeName))) {
			return False;
		}

		if (lssc[num]->orderingRule) {
			if (!asn1_write_OctetString(&data, lssc[num]->orderingRule, strlen(lssc[num]->orderingRule))) {
				return False;
			}
		}

		if (lssc[num]->reverse) {
			if (!asn1_write_BOOLEAN(&data, lssc[num]->reverse)) {
				return False;
			}
		}

		if (!asn1_pop_tag(&data)) {
			return False;
		}
	}

	if (!asn1_pop_tag(&data)) {
		return False;
	}

	*out = data_blob_talloc(mem_ctx, data.data, data.length);
	if (out->data == NULL) {
		return False;
	}

	return True;
}

static BOOL encode_extended_dn_request(void *mem_ctx, void *in, DATA_BLOB *out)
{
	struct ldb_extended_dn_control *ledc = talloc_get_type(in, struct ldb_extended_dn_control);
	struct asn1_data data;

	ZERO_STRUCT(data);

	if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
		return False;
	}

	if (!asn1_write_Integer(&data, ledc->type)) {
		return False;
	}

	if (!asn1_pop_tag(&data)) {
		return False;
	}

	*out = data_blob_talloc(mem_ctx, data.data, data.length);
	if (out->data == NULL) {
		return False;
	}

	return True;
}

static BOOL encode_paged_results_request(void *mem_ctx, void *in, DATA_BLOB *out)
{
	struct ldb_paged_control *lprc = talloc_get_type(in, struct ldb_paged_control);
	struct asn1_data data;

	ZERO_STRUCT(data);

	if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
		return False;
	}

	if (!asn1_write_Integer(&data, lprc->size)) {
		return False;
	}

	if (!asn1_write_OctetString(&data, lprc->cookie, lprc->cookie_len)) {
		return False;
	}	

	if (!asn1_pop_tag(&data)) {
		return False;
	}

	*out = data_blob_talloc(mem_ctx, data.data, data.length);
	if (out->data == NULL) {
		return False;
	}

	return True;
}

/* seem that this controls has 2 forms one in case it is used with
 * a Search Request and another when used ina Search Response
 */
static BOOL encode_asq_control(void *mem_ctx, void *in, DATA_BLOB *out)
{
	struct ldb_asq_control *lac = talloc_get_type(in, struct ldb_asq_control);
	struct asn1_data data;

	ZERO_STRUCT(data);

	if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
		return False;
	}

	if (lac->request) {

		if (!asn1_write_OctetString(&data, lac->source_attribute, lac->src_attr_len)) {
			return False;
		}
	} else {
		if (!asn1_write_enumerated(&data, lac->result)) {
			return False;
		}
	}

	if (!asn1_pop_tag(&data)) {
		return False;
	}

	*out = data_blob_talloc(mem_ctx, data.data, data.length);
	if (out->data == NULL) {
		return False;
	}

	return True;
}

static BOOL encode_dirsync_request(void *mem_ctx, void *in, DATA_BLOB *out)
{
	struct ldb_dirsync_control *ldc = talloc_get_type(in, struct ldb_dirsync_control);
	struct asn1_data data;

	ZERO_STRUCT(data);

	if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
		return False;
	}

	if (!asn1_write_Integer(&data, ldc->flags)) {
		return False;
	}

	if (!asn1_write_Integer(&data, ldc->max_attributes)) {
		return False;
	}

	if (!asn1_write_OctetString(&data, ldc->cookie, ldc->cookie_len)) {
		return False;
	}	

	if (!asn1_pop_tag(&data)) {
		return False;
	}

	*out = data_blob_talloc(mem_ctx, data.data, data.length);
	if (out->data == NULL) {
		return False;
	}

	return True;
}

static BOOL encode_notification_request(void *mem_ctx, void *in, DATA_BLOB *out)
{
	if (in) {
		return False;
	}

	*out = data_blob(NULL, 0);
	return True;
}

static BOOL encode_manageDSAIT_request(void *mem_ctx, void *in, DATA_BLOB *out)
{
	if (in) {
		return False;
	}

	*out = data_blob(NULL, 0);
	return True;
}

static BOOL encode_vlv_request(void *mem_ctx, void *in, DATA_BLOB *out)
{
	struct ldb_vlv_req_control *lvrc = talloc_get_type(in, struct ldb_vlv_req_control);
	struct asn1_data data;

	ZERO_STRUCT(data);

	if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
		return False;
	}

	if (!asn1_write_Integer(&data, lvrc->beforeCount)) {
		return False;
	}

	if (!asn1_write_Integer(&data, lvrc->afterCount)) {
		return False;
	}

	if (lvrc->type == 0) {
		if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
			return False;
		}
		
		if (!asn1_write_Integer(&data, lvrc->match.byOffset.offset)) {
			return False;
		}

		if (!asn1_write_Integer(&data, lvrc->match.byOffset.contentCount)) {
			return False;
		}

		if (!asn1_pop_tag(&data)) {
			return False;
		}
	} else {
		
		if (!asn1_write_OctetString(&data, lvrc->match.gtOrEq.value, lvrc->match.gtOrEq.value_len)) {
			return False;
		}
	}

	if (lvrc->ctxid_len) {
		if (!asn1_write_OctetString(&data, lvrc->contextId, lvrc->ctxid_len)) {
			return False;
		}
	}

	if (!asn1_pop_tag(&data)) {
		return False;
	}

	*out = data_blob_talloc(mem_ctx, data.data, data.length);
	if (out->data == NULL) {
		return False;
	}

	return True;
}

static BOOL encode_vlv_response(void *mem_ctx, void *in, DATA_BLOB *out)
{
	struct ldb_vlv_resp_control *lvrc = talloc_get_type(in, struct ldb_vlv_resp_control);
	struct asn1_data data;

	ZERO_STRUCT(data);

	if (!asn1_push_tag(&data, ASN1_SEQUENCE(0))) {
		return False;
	}

	if (!asn1_write_Integer(&data, lvrc->targetPosition)) {
		return False;
	}

	if (!asn1_write_Integer(&data, lvrc->contentCount)) {
		return False;
	}

	if (!asn1_write_enumerated(&data, lvrc->vlv_result)) {
		return False;
	}

	if (lvrc->ctxid_len) {
		if (!asn1_write_OctetString(&data, lvrc->contextId, lvrc->ctxid_len)) {
			return False;
		}
	}

	if (!asn1_pop_tag(&data)) {
		return False;
	}

	*out = data_blob_talloc(mem_ctx, data.data, data.length);
	if (out->data == NULL) {
		return False;
	}

	return True;
}

struct control_handler ldap_known_controls[] = {
	{ "1.2.840.113556.1.4.319", decode_paged_results_request, encode_paged_results_request },
	{ "1.2.840.113556.1.4.529", decode_extended_dn_request, encode_extended_dn_request },
	{ "1.2.840.113556.1.4.473", decode_server_sort_request, encode_server_sort_request },
	{ "1.2.840.113556.1.4.474", decode_server_sort_response, encode_server_sort_response },
	{ "1.2.840.113556.1.4.1504", decode_asq_control, encode_asq_control },
	{ "1.2.840.113556.1.4.841", decode_dirsync_request, encode_dirsync_request },
	{ "1.2.840.113556.1.4.528", decode_notification_request, encode_notification_request },
	{ "2.16.840.1.113730.3.4.2", decode_manageDSAIT_request, encode_manageDSAIT_request },
	{ "2.16.840.1.113730.3.4.9", decode_vlv_request, encode_vlv_request },
	{ "2.16.840.1.113730.3.4.10", decode_vlv_response, encode_vlv_response },
	{ NULL, NULL, NULL }
};

BOOL ldap_decode_control(void *mem_ctx, struct asn1_data *data, struct ldap_Control *ctrl)
{
	int i;
	DATA_BLOB oid;
	DATA_BLOB value;

	if (!asn1_start_tag(data, ASN1_SEQUENCE(0))) {
		return False;
	}

	if (!asn1_read_OctetString(data, &oid)) {
		return False;
	}
	ctrl->oid = talloc_strndup(mem_ctx, (char *)oid.data, oid.length);
	if (!(ctrl->oid)) {
		return False;
	}

	if (asn1_peek_tag(data, ASN1_BOOLEAN)) {
		if (!asn1_read_BOOLEAN(data, &(ctrl->critical))) {
			return False;
		}
	} else {
		ctrl->critical = False;
	}

	ctrl->value = NULL;

	for (i = 0; ldap_known_controls[i].oid != NULL; i++) {
		if (strcmp(ldap_known_controls[i].oid, ctrl->oid) == 0) {
			
			if (!asn1_read_OctetString(data, &value)) {
				return False;
			}
			if (!ldap_known_controls[i].decode(mem_ctx, value, &(ctrl->value))) {
				return False;
			}
			break;
		}
	}
	if (ldap_known_controls[i].oid == NULL) {
		return False;
	}

	if (!asn1_end_tag(data)) {
		return False;
	}

	return True;
}

BOOL ldap_encode_control(void *mem_ctx, struct asn1_data *data, struct ldap_Control *ctrl)
{
	DATA_BLOB value;
	int i;

	if (!asn1_push_tag(data, ASN1_SEQUENCE(0))) {
		return False;
	}
	
	if (!asn1_write_OctetString(data, ctrl->oid, strlen(ctrl->oid))) {
		return False;
	}
	
	if (ctrl->critical) {
		if (!asn1_write_BOOLEAN(data, ctrl->critical)) {
			return False;
		}
	}

	for (i = 0; ldap_known_controls[i].oid != NULL; i++) {
		if (strcmp(ldap_known_controls[i].oid, ctrl->oid) == 0) {
			if (!ldap_known_controls[i].encode(mem_ctx, ctrl->value, &value)) {
				return False;
			}
			break;
		}
	}
	if (ldap_known_controls[i].oid == NULL) {
		return False;
	}

	if (value.length != 0) {
		if (!asn1_write_OctetString(data, value.data, value.length)) {
			return False;
		}
	}

	if (!asn1_pop_tag(data)) {
		return False;
	}

	return True;
}