/src/samba/source4/libcli/ldap/ldap_controls.c

Source
/*
   Unix SMB/CIFS implementation.
   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 3 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, see <http://www.gnu.org/licenses/>.

*/

#include "includes.h"

#include <ldb.h>

#include "../lib/util/asn1.h"
#include "libcli/ldap/libcli_ldap.h"
#include "libcli/ldap/ldap_proto.h"
#include "dsdb/samdb/samdb.h"

static bool decode_server_sort_response(void *mem_ctx, DATA_BLOB in, void *_out)
{
  void **out = _out;
  DATA_BLOB attr;
  struct asn1_data *data = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);
  struct ldb_sort_resp_control *lsrc;

  if (!data) return false;

  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, mem_ctx, &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)
{
  void **out = _out;
  DATA_BLOB attr;
  DATA_BLOB rule;
  struct asn1_data *data = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);
  struct ldb_server_sort_control **lssc;
  int num;

  if (!data) return false;

  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_zero(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, mem_ctx, &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_CONTEXT_SIMPLE(0))) {
      if (!asn1_read_ContextSimple(data, mem_ctx, 0, &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_CONTEXT_SIMPLE(1))) {
      bool reverse;
      if (!asn1_read_BOOLEAN_context(data, &reverse, 1)) {
      return false;
      }
      lssc[num]->reverse = reverse;
    }

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

  if (lssc != NULL) {
    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)
{
  void **out = _out;
  struct asn1_data *data;
  struct ldb_extended_dn_control *ledc;

  /* The content of this control is optional */
  if (in.length == 0) {
    *out = NULL;
    return true;
  }

  data = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);
  if (!data) return false;

  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_sd_flags_request(void *mem_ctx, DATA_BLOB in, void *_out)
{
  void **out = _out;
  struct asn1_data *data = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);
  struct ldb_sd_flags_control *lsdfc;

  if (!data) return false;

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

  lsdfc = talloc(mem_ctx, struct ldb_sd_flags_control);
  if (!lsdfc) {
    return false;
  }

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

  if (!asn1_read_Integer(data, (int *) &(lsdfc->secinfo_flags))) {
    return false;
  }

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

  *out = lsdfc;

  return true;
}

static bool decode_search_options_request(void *mem_ctx, DATA_BLOB in, void *_out)
{
  void **out = _out;
  struct asn1_data *data = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);
  struct ldb_search_options_control *lsoc;

  if (!data) return false;

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

  lsoc = talloc(mem_ctx, struct ldb_search_options_control);
  if (!lsoc) {
    return false;
  }

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

  if (!asn1_read_Integer(data, (int *) &(lsoc->search_options))) {
    return false;
  }

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

  *out = lsoc;

  return true;
}

static bool decode_paged_results_request(void *mem_ctx, DATA_BLOB in, void *_out)
{
  void **out = _out;
  DATA_BLOB cookie;
  struct asn1_data *data = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);
  struct ldb_paged_control *lprc;

  if (!data) return false;

  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, mem_ctx, &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)
{
  void **out = _out;
  DATA_BLOB cookie;
  struct asn1_data *data = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);
  struct ldb_dirsync_control *ldc;

  if (!data) return false;

  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, mem_ctx, &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 in a Search Response
 */
static bool decode_asq_control(void *mem_ctx, DATA_BLOB in, void *_out)
{
  void **out = _out;
  DATA_BLOB source_attribute;
  struct asn1_data *data = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);
  struct ldb_asq_control *lac;

  if (!data) return false;

  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, mem_ctx, &source_attribute)) {
      return false;
    }
    lac->src_attr_len = source_attribute.length;
    if (lac->src_attr_len) {
      lac->source_attribute = talloc_strndup(lac, (const 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_verify_name_request(void *mem_ctx, DATA_BLOB in, void *_out)
{
  void **out = _out;
  DATA_BLOB name;
  struct asn1_data *data = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);
  struct ldb_verify_name_control *lvnc;
  int len;

  if (!data) return false;

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

  lvnc = talloc(mem_ctx, struct ldb_verify_name_control);
  if (!lvnc) {
    return false;
  }

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

  if (!asn1_read_Integer(data, &(lvnc->flags))) {
    return false;
  }

  if (!asn1_read_OctetString(data, mem_ctx, &name)) {
    return false;
  }

  if (name.length) {
    len = utf16_null_terminated_len_n(name.data, name.length);
    convert_string_talloc(mem_ctx, CH_UTF16, CH_UNIX,
          name.data, len,
          &lvnc->gc, &lvnc->gc_len);

    if (!(lvnc->gc)) {
      return false;
    }
  } else {
    lvnc->gc_len = 0;
    lvnc->gc = NULL;
  }

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

  *out = lvnc;
  return true;
}

static bool encode_verify_name_request(void *mem_ctx, void *in, DATA_BLOB *out)
{
  struct ldb_verify_name_control *lvnc = talloc_get_type(in, struct ldb_verify_name_control);
  struct asn1_data *data = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);
  DATA_BLOB gc_utf16;

  if (!data) return false;

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

  if (!asn1_write_Integer(data, lvnc->flags)) {
    return false;
  }

  if (lvnc->gc_len) {
    bool ok;

    ok = convert_string_talloc(mem_ctx, CH_UNIX, CH_UTF16,
             lvnc->gc, lvnc->gc_len,
             &gc_utf16.data, &gc_utf16.length);
    if (!ok) {
      return false;
    }
    if (!asn1_write_OctetString(data, gc_utf16.data, gc_utf16.length)) {
      return false;
    }
  } else {
    if (!asn1_write_OctetString(data, NULL, 0)) {
      return false;
    }
  }

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

  if (!asn1_extract_blob(data, mem_ctx, out)) {
    return false;
  }

  talloc_free(data);

  return true;
}

static bool decode_vlv_request(void *mem_ctx, DATA_BLOB in, void *_out)
{
  void **out = _out;
  DATA_BLOB assertion_value, context_id;
  struct asn1_data *data = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);
  struct ldb_vlv_req_control *lvrc;

  if (!data) return false;

  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_CONTEXT(0))) {

    lvrc->type = 0;

    if (!asn1_start_tag(data, ASN1_CONTEXT(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)) { /*CONTEXT*/
      return false;
    }

  } else {

    lvrc->type = 1;

    if (!asn1_read_ContextSimple(data, mem_ctx, 1, &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, mem_ctx, &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)
{
  void **out = _out;
  DATA_BLOB context_id;
  struct asn1_data *data = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);
  struct ldb_vlv_resp_control *lvrc;

  if (!data) return false;

  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, mem_ctx, &context_id)) {
      return false;
    }
    lvrc->contextId = talloc_memdup(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 = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);

  if (!data) return false;

  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;
  }

  if (!asn1_extract_blob(data, mem_ctx, out)) {
    return false;
  }

  talloc_free(data);

  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 = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);
  int num;

  if (!data) return false;

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

  /*
    RFC2891 section 1.1:
      SortKeyList ::= SEQUENCE OF SEQUENCE {
        attributeType   AttributeDescription,
        orderingRule    [0] MatchingRuleId OPTIONAL,
        reverseOrder    [1] BOOLEAN DEFAULT 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) {
      DATA_BLOB order = data_blob_string_const(lssc[num]->orderingRule);
      if (!asn1_write_ContextSimple(data, 0, &order)) {
        return false;
      }
    }

    if (lssc[num]->reverse) {
      if (!asn1_write_BOOLEAN_context(data, lssc[num]->reverse, 1)) {
        return false;
      }
    }

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

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

  if (!asn1_extract_blob(data, mem_ctx, out)) {
    return false;
  }

  talloc_free(data);

  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;

  if (!in) {
    *out = data_blob(NULL, 0);
    return true;
  }

  data = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);

  if (!data) return false;

  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;
  }

  if (!asn1_extract_blob(data, mem_ctx, out)) {
    return false;
  }

  talloc_free(data);

  return true;
}

static bool encode_sd_flags_request(void *mem_ctx, void *in, DATA_BLOB *out)
{
  struct ldb_sd_flags_control *lsdfc = talloc_get_type(in, struct ldb_sd_flags_control);
  struct asn1_data *data = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);

  if (!data) return false;

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

  if (!asn1_write_Integer(data, lsdfc->secinfo_flags)) {
    return false;
  }

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

  if (!asn1_extract_blob(data, mem_ctx, out)) {
    return false;
  }

  talloc_free(data);

  return true;
}

static bool encode_search_options_request(void *mem_ctx, void *in, DATA_BLOB *out)
{
  struct ldb_search_options_control *lsoc = talloc_get_type(in, struct ldb_search_options_control);
  struct asn1_data *data = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);

  if (!data) return false;

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

  if (!asn1_write_Integer(data, lsoc->search_options)) {
    return false;
  }

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

  if (!asn1_extract_blob(data, mem_ctx, out)) {
    return false;
  }

  talloc_free(data);

  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 = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);

  if (!data) return false;

  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;
  }

  if (!asn1_extract_blob(data, mem_ctx, out)) {
    return false;
  }

  talloc_free(data);

  return true;
}

/* seem that this controls has 2 forms one in case it is used with
 * a Search Request and another when used in a 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 = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);

  if (!data) return false;

  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;
  }

  if (!asn1_extract_blob(data, mem_ctx, out)) {
    return false;
  }

  talloc_free(data);

  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 = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);

  if (!data) return false;

  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;
  }

  if (!asn1_extract_blob(data, mem_ctx, out)) {
    return false;
  }

  talloc_free(data);

  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 = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);

  if (!data) return false;

  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_CONTEXT(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)) { /*CONTEXT*/
      return false;
    }
  } else {
    if (!asn1_push_tag(data, ASN1_CONTEXT_SIMPLE(1))) {
      return false;
    }

    if (!asn1_write(data, lvrc->match.gtOrEq.value, lvrc->match.gtOrEq.value_len)) {
      return false;
    }

    if (!asn1_pop_tag(data)) { /*CONTEXT*/
      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;
  }

  if (!asn1_extract_blob(data, mem_ctx, out)) {
    return false;
  }

  talloc_free(data);

  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 = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);

  if (!data) return false;

  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;
  }

  if (!asn1_extract_blob(data, mem_ctx, out)) {
    return false;
  }

  talloc_free(data);

  return true;
}

static bool encode_openldap_dereference(void *mem_ctx, void *in, DATA_BLOB *out)
{
  struct dsdb_openldap_dereference_control *control = talloc_get_type(in, struct dsdb_openldap_dereference_control);
  int i,j;
  struct asn1_data *data = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);

  if (!data) return false;

  if (!control) return false;

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

  for (i=0; control->dereference && control->dereference[i]; i++) {
    if (!asn1_push_tag(data, ASN1_SEQUENCE(0))) {
      return false;
    }
    if (!asn1_write_OctetString(data, control->dereference[i]->source_attribute, strlen(control->dereference[i]->source_attribute))) {
      return false;
    }
    if (!asn1_push_tag(data, ASN1_SEQUENCE(0))) {
      return false;
    }
    for (j=0; control->dereference && control->dereference[i]->dereference_attribute[j]; j++) {
      if (!asn1_write_OctetString(data, control->dereference[i]->dereference_attribute[j],
                strlen(control->dereference[i]->dereference_attribute[j]))) {
        return false;
      }
    }

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

  if (!asn1_extract_blob(data, mem_ctx, out)) {
    return false;
  }

  talloc_free(data);
  return true;
}

static bool decode_openldap_dereference(void *mem_ctx, DATA_BLOB in, void *_out)
{
  void **out = _out;
  struct asn1_data *data = asn1_init(mem_ctx, ASN1_MAX_TREE_DEPTH);
  struct dsdb_openldap_dereference_result_control *control;
  struct dsdb_openldap_dereference_result **r = NULL;
  int i = 0;
  if (!data) return false;

  control = talloc(mem_ctx, struct dsdb_openldap_dereference_result_control);
  if (!control) return false;

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

  control = talloc(mem_ctx, struct dsdb_openldap_dereference_result_control);
  if (!control) {
    return false;
  }

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

  while (asn1_tag_remaining(data) > 0) {
    r = talloc_realloc(control, r, struct dsdb_openldap_dereference_result *, i + 2);
    if (!r) {
      return false;
    }
    r[i] = talloc_zero(r, struct dsdb_openldap_dereference_result);
    if (!r[i]) {
      return false;
    }

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

    if (!asn1_read_OctetString_talloc(r[i], data, &r[i]->source_attribute)) {
      return false;
    }
    if (!asn1_read_OctetString_talloc(r[i], data, &r[i]->dereferenced_dn)) {
      return false;
    }
    if (asn1_peek_tag(data, ASN1_CONTEXT(0))) {
      if (!asn1_start_tag(data, ASN1_CONTEXT(0))) {
        return false;
      }
      if (!ldap_decode_attribs_bare(r, data, &r[i]->attributes,
             &r[i]->num_attributes)) {
        return false;
      }
      if (!asn1_end_tag(data)) {
        return false;
      }
    }
    if (!asn1_end_tag(data)) {
      return false;
    }
    i++;
    r[i] = NULL;
  }

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

  control->attributes = r;
  *out = control;

  return true;
}

static bool encode_flag_request(void *mem_ctx, void *in, DATA_BLOB *out)
{
  if (in) {
    return false;
  }

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

static bool decode_flag_request(void *mem_ctx, DATA_BLOB in, void *_out)
{
  if (in.length != 0) {
    return false;
  }

  return true;
}

static const struct ldap_control_handler ldap_known_controls[] = {
  { LDB_CONTROL_PAGED_RESULTS_OID, decode_paged_results_request, encode_paged_results_request },
  { LDB_CONTROL_SD_FLAGS_OID, decode_sd_flags_request, encode_sd_flags_request },
  { LDB_CONTROL_DOMAIN_SCOPE_OID, decode_flag_request, encode_flag_request },
  { LDB_CONTROL_SEARCH_OPTIONS_OID, decode_search_options_request, encode_search_options_request },
  { LDB_CONTROL_NOTIFICATION_OID, decode_flag_request, encode_flag_request },
  { LDB_CONTROL_TREE_DELETE_OID, decode_flag_request, encode_flag_request },
  { LDB_CONTROL_SHOW_DELETED_OID, decode_flag_request, encode_flag_request },
  { LDB_CONTROL_SHOW_RECYCLED_OID, decode_flag_request, encode_flag_request },
  { LDB_CONTROL_SHOW_DEACTIVATED_LINK_OID, decode_flag_request, encode_flag_request },
  { LDB_CONTROL_EXTENDED_DN_OID, decode_extended_dn_request, encode_extended_dn_request },
  { LDB_CONTROL_SERVER_SORT_OID, decode_server_sort_request, encode_server_sort_request },
  { LDB_CONTROL_SORT_RESP_OID, decode_server_sort_response, encode_server_sort_response },
  { LDB_CONTROL_ASQ_OID, decode_asq_control, encode_asq_control },
  { LDB_CONTROL_DIRSYNC_OID, decode_dirsync_request, encode_dirsync_request },
  { LDB_CONTROL_DIRSYNC_EX_OID, decode_dirsync_request, encode_dirsync_request },
  { LDB_CONTROL_VLV_REQ_OID, decode_vlv_request, encode_vlv_request },
  { LDB_CONTROL_VLV_RESP_OID, decode_vlv_response, encode_vlv_response },
  { LDB_CONTROL_PERMISSIVE_MODIFY_OID, decode_flag_request, encode_flag_request },
  { LDB_CONTROL_SERVER_LAZY_COMMIT, decode_flag_request, encode_flag_request },
  { LDB_CONTROL_RODC_DCPROMO_OID, decode_flag_request, encode_flag_request },
  { LDB_CONTROL_RELAX_OID, decode_flag_request, encode_flag_request },
  { DSDB_OPENLDAP_DEREFERENCE_CONTROL, decode_openldap_dereference, encode_openldap_dereference },
  { LDB_CONTROL_VERIFY_NAME_OID, decode_verify_name_request, encode_verify_name_request },

  /* the following are internal only, with a network
     representation */
  { DSDB_CONTROL_BYPASS_PASSWORD_HASH_OID, decode_flag_request, encode_flag_request },

  /* all the ones below are internal only, and have no network
   * representation */
  { DSDB_CONTROL_CURRENT_PARTITION_OID, NULL, NULL },
  { DSDB_CONTROL_REPLICATED_UPDATE_OID, NULL, NULL },
  { DSDB_CONTROL_DN_STORAGE_FORMAT_OID, NULL, NULL },
  { LDB_CONTROL_RECALCULATE_SD_OID, NULL, NULL },
  { LDB_CONTROL_REVEAL_INTERNALS, NULL, NULL },
  { LDB_CONTROL_AS_SYSTEM_OID, NULL, NULL },
  { DSDB_CONTROL_PASSWORD_CHANGE_STATUS_OID, NULL, NULL },
  { DSDB_CONTROL_PASSWORD_HASH_VALUES_OID, NULL, NULL },
  { DSDB_CONTROL_PASSWORD_CHANGE_OLD_PW_CHECKED_OID, NULL, NULL },
  { DSDB_CONTROL_PASSWORD_ACL_VALIDATION_OID, NULL, NULL },
  { DSDB_CONTROL_APPLY_LINKS, NULL, NULL },
  { LDB_CONTROL_BYPASS_OPERATIONAL_OID, NULL, NULL },
  { DSDB_CONTROL_CHANGEREPLMETADATA_OID, NULL, NULL },
  { LDB_CONTROL_PROVISION_OID, NULL, NULL },
  { DSDB_EXTENDED_REPLICATED_OBJECTS_OID, NULL, NULL },
  { DSDB_EXTENDED_SCHEMA_UPDATE_NOW_OID, NULL, NULL },
  { DSDB_EXTENDED_ALLOCATE_RID_POOL, NULL, NULL },
  { DSDB_CONTROL_NO_GLOBAL_CATALOG, NULL, NULL },
  { DSDB_CONTROL_PARTIAL_REPLICA, NULL, NULL },
  { DSDB_CONTROL_DBCHECK, NULL, NULL },
  { DSDB_CONTROL_DBCHECK_MODIFY_RO_REPLICA, NULL, NULL },
  { DSDB_CONTROL_DBCHECK_FIX_DUPLICATE_LINKS, NULL, NULL },
  { DSDB_CONTROL_DBCHECK_FIX_LINK_DN_NAME, NULL, NULL },
  { DSDB_CONTROL_DBCHECK_FIX_LINK_DN_SID, NULL, NULL },
  { DSDB_CONTROL_PASSWORD_BYPASS_LAST_SET_OID, NULL, NULL },
  { DSDB_CONTROL_SEC_DESC_PROPAGATION_OID, NULL, NULL },
  { DSDB_CONTROL_PERMIT_INTERDOMAIN_TRUST_UAC_OID, NULL, NULL },
  { DSDB_CONTROL_RESTORE_TOMBSTONE_OID, NULL, NULL },
  { DSDB_CONTROL_CHANGEREPLMETADATA_RESORT_OID, NULL, NULL },
  { DSDB_CONTROL_PASSWORD_DEFAULT_LAST_SET_OID, NULL, NULL },
  { DSDB_CONTROL_PASSWORD_USER_ACCOUNT_CONTROL_OID, NULL, NULL },
  { DSDB_CONTROL_SKIP_DUPLICATES_CHECK_OID, NULL, NULL },
  { DSDB_CONTROL_REPLMD_VANISH_LINKS, NULL, NULL },
  { LDB_CONTROL_RECALCULATE_RDN_OID, NULL, NULL },
  { DSDB_CONTROL_FORCE_RODC_LOCAL_CHANGE, NULL, NULL },
  { DSDB_CONTROL_FORCE_ALLOW_VALIDATED_DNS_HOSTNAME_SPN_WRITE_OID, NULL, NULL },
  { DSDB_CONTROL_ACL_READ_OID, NULL, NULL },
  { DSDB_CONTROL_GMSA_UPDATE_OID, NULL, NULL },
  { DSDB_CONTROL_PASSWORD_KDC_RESET_SMARTCARD_ACCOUNT_PASSWORD, NULL, NULL },
  { DSDB_EXTENDED_SCHEMA_UPGRADE_IN_PROGRESS_OID, NULL, NULL },
  { DSDB_CONTROL_TRANSACTION_IDENTIFIER_OID, NULL, NULL},
  { DSDB_CONTROL_CALCULATED_DEFAULT_SD_OID, NULL, NULL },
  { NULL, NULL, NULL }
};

const struct ldap_control_handler *samba_ldap_control_handlers(void)
{
  return ldap_known_controls;
}

Coverage Report

Created: 2025-11-16 06:57