/src/gnutls/lib/x509/name_constraints.c

Source
/*
 * Copyright (C) 2014-2016 Free Software Foundation, Inc.
 * Copyright (C) 2016 Red Hat, Inc.
 *
 * Authors: Nikos Mavrogiannopoulos, Daiki Ueno, Martin Ukrop
 *
 * This file is part of GnuTLS.
 *
 * The GnuTLS is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>
 *
 */

/* Functions on X.509 Certificate parsing
 */

#include "gnutls_int.h"
#include "datum.h"
#include "global.h"
#include "errors.h"
#include "common.h"
#include "x509.h"
#include <gnutls/x509-ext.h>
#include "x509_b64.h"
#include "x509_int.h"
#include "x509_ext_int.h"
#include <libtasn1.h>
#include "c-strcase.h"

#include "ip.h"
#include "ip-in-cidr.h"
#include "intprops.h"
#include "minmax.h"
#include "gl_array_list.h"
#include "gl_rbtree_list.h"

#include <assert.h>
#include <string.h>
#include <limits.h>

#define MAX_NC_CHECKS (1 << 20)

#define SAN_MIN GNUTLS_SAN_DNSNAME

/* For historical reasons, these are not in the range
 * SAN_MIN..GNUTLS_SAN_MAX. They should probably deserve a separate
 * enum type.
 */
#define SAN_OTHERNAME_MIN GNUTLS_SAN_OTHERNAME_XMPP
#define SAN_OTHERNAME_MAX GNUTLS_SAN_OTHERNAME_MSUSERPRINCIPAL

typedef unsigned long san_flags_t;

#define SAN_BIT(san)                                 \
  ((san) <= GNUTLS_SAN_MAX ? (san) - SAN_MIN : \
           GNUTLS_SAN_MAX + (san) - SAN_OTHERNAME_MIN)

static_assert(SAN_BIT(SAN_OTHERNAME_MIN) > SAN_BIT(GNUTLS_SAN_MAX));
static_assert(SAN_BIT(SAN_OTHERNAME_MAX) < CHAR_BIT * sizeof(san_flags_t));

#define SAN_FLAG(san) (1UL << SAN_BIT(san))

struct name_constraints_node_st {
  gnutls_x509_subject_alt_name_t type;
  gnutls_datum_t name;
};

struct name_constraints_node_list_st {
  gl_list_t items;
  gl_list_t sorted_items;
};

struct gnutls_name_constraints_st {
  gl_list_t nodes; /* owns elements */
  struct name_constraints_node_list_st permitted; /* borrows elements */
  struct name_constraints_node_list_st excluded; /* borrows elements */
};

static struct name_constraints_node_st *
name_constraints_node_new(gnutls_x509_name_constraints_t nc,
        gnutls_x509_subject_alt_name_t type,
        const unsigned char *data, unsigned int size);

/* An enum for "rich" comparisons that not only let us sort name constraints,
 * children-before-parent, but also subsume them during intersection. */
enum name_constraint_relation {
  NC_SORTS_BEFORE = -2, /* unrelated constraints */
  NC_INCLUDED_BY = -1, /* nc1 is included by nc2 / children sort first */
  NC_EQUAL = 0, /* exact match */
  NC_INCLUDES = 1, /* nc1 includes nc2 / parents sort last */
  NC_SORTS_AFTER = 2 /* unrelated constraints */
};

/* Helpers to compare just a pair of strings with this rich comparison */
static enum name_constraint_relation
compare_strings(const void *n1, size_t n1_len, const void *n2, size_t n2_len)
{
  int r = memcmp(n1, n2, MIN(n1_len, n2_len));
  if (r < 0)
    return NC_SORTS_BEFORE;
  if (r > 0)
    return NC_SORTS_AFTER;
  if (n1_len < n2_len)
    return NC_SORTS_BEFORE;
  if (n1_len > n2_len)
    return NC_SORTS_AFTER;
  return NC_EQUAL;
}

static enum name_constraint_relation
compare_strings_case_insensitive(const void *n1, size_t n1_len, const void *n2,
         size_t n2_len)
{
  int r = c_strncasecmp(n1, n2, MIN(n1_len, n2_len));
  if (r < 0)
    return NC_SORTS_BEFORE;
  if (r > 0)
    return NC_SORTS_AFTER;
  if (n1_len < n2_len)
    return NC_SORTS_BEFORE;
  if (n1_len > n2_len)
    return NC_SORTS_AFTER;
  return NC_EQUAL;
}

/* Rich-compare DNS names. Example order/relationships:
 * z.x.a INCLUDED_BY x.a BEFORE y.a INCLUDED_BY a BEFORE x.b BEFORE y.b */
static enum name_constraint_relation compare_dns_names(const gnutls_datum_t *n1,
                   const gnutls_datum_t *n2)
{
  enum name_constraint_relation rel;
  unsigned int i, j, i_end, j_end;

  /* start from the end of each name */
  i = i_end = n1->size;
  j = j_end = n2->size;

  /* skip the trailing dots for the comparison */
  while (i && n1->data[i - 1] == '.')
    i_end = i = i - 1;
  while (j && n2->data[j - 1] == '.')
    j_end = j = j - 1;

  while (1) {
    // rewind back to beginning or an after-dot position
    while (i && n1->data[i - 1] != '.')
      i--;
    while (j && n2->data[j - 1] != '.')
      j--;

    rel = compare_strings_case_insensitive(&n1->data[i], i_end - i,
                   &n2->data[j], j_end - j);
    if (rel == NC_SORTS_BEFORE) /* x.a BEFORE y.a */
      return NC_SORTS_BEFORE;
    if (rel == NC_SORTS_AFTER) /* y.a AFTER x.a */
      return NC_SORTS_AFTER;
    if (!i && j) /* x.a INCLUDES z.x.a */
      return NC_INCLUDES;
    if (i && !j) /* z.x.a INCLUDED_BY x.a */
      return NC_INCLUDED_BY;

    if (!i && !j) /* r == 0, we ran out of components to compare */
      return NC_EQUAL;
    /* r == 0, i && j: step back past a dot and keep comparing */
    i_end = i = i - 1;
    j_end = j = j - 1;

    /* support for non-standard ".gr INCLUDES example.gr" [1] */
    if (!i && j) /* .a INCLUDES x.a */
      return NC_INCLUDES;
    if (i && !j) /* x.a INCLUDED_BY .a */
      return NC_INCLUDED_BY;
  }
}
/* [1] https://mailarchive.ietf.org/arch/msg/saag/Bw6PtreW0G7aEG7SikfzKHES4VA */

/* Rich-compare email name constraints. Example order/relationships:
 * z@x.a INCLUDED_BY x.a BEFORE y.a INCLUDED_BY a BEFORE x@b BEFORE y@b */
static enum name_constraint_relation compare_emails(const gnutls_datum_t *n1,
                const gnutls_datum_t *n2)
{
  enum name_constraint_relation domains_rel;
  unsigned int i, j, i_end, j_end;
  gnutls_datum_t d1, d2; /* borrow from n1 and n2 */

  /* start from the end of each name */
  i = i_end = n1->size;
  j = j_end = n2->size;

  /* rewind to @s to look for domains */
  while (i && n1->data[i - 1] != '@')
    i--;
  d1.size = i_end - i;
  d1.data = &n1->data[i];
  while (j && n2->data[j - 1] != '@')
    j--;
  d2.size = j_end - j;
  d2.data = &n2->data[j];

  domains_rel = compare_dns_names(&d1, &d2);

  /* email constraint semantics differ from DNS
   * DNS: x.a INCLUDED_BY a
   * Email: x.a INCLUDED_BY .a BEFORE a */
  if (domains_rel == NC_INCLUDED_BY || domains_rel == NC_INCLUDES) {
    bool d1_has_dot = (d1.size > 0 && d1.data[0] == '.');
    bool d2_has_dot = (d2.size > 0 && d2.data[0] == '.');
    /* a constraint without a dot is exact, excluding subdomains */
    if (!d2_has_dot && domains_rel == NC_INCLUDED_BY)
      domains_rel = NC_SORTS_BEFORE; /* x.a BEFORE a */
    if (!d1_has_dot && domains_rel == NC_INCLUDES)
      domains_rel = NC_SORTS_AFTER; /* a AFTER x.a */
  }

  if (!i && !j) { /* both are domains-only */
    return domains_rel;
  } else if (i && !j) { /* n1 is email, n2 is domain */
    switch (domains_rel) {
    case NC_SORTS_AFTER:
      return NC_SORTS_AFTER;
    case NC_SORTS_BEFORE:
      return NC_SORTS_BEFORE;
    case NC_INCLUDES: /* n2 is more specific, a@x.a AFTER z.x.a */
      return NC_SORTS_AFTER;
    case NC_EQUAL: /* subdomains match, z@x.a INCLUDED_BY x.a */
    case NC_INCLUDED_BY: /* n1 is more specific */
      return NC_INCLUDED_BY;
    }
  } else if (!i && j) { /* n1 is domain, n2 is email */
    switch (domains_rel) {
    case NC_SORTS_AFTER:
      return NC_SORTS_AFTER;
    case NC_SORTS_BEFORE:
      return NC_SORTS_BEFORE;
    case NC_INCLUDES: /* n2 is more specific, a AFTER z@x.a */
      return NC_SORTS_AFTER;
    case NC_EQUAL: /* subdomains match, x.a INCLUDES z@x.a */
      return NC_INCLUDES;
    case NC_INCLUDED_BY: /* n1 is more specific, x.a BEFORE z@a */
      return NC_SORTS_BEFORE;
    }
  } else if (i && j) { /* both are emails */
    switch (domains_rel) {
    case NC_SORTS_AFTER:
      return NC_SORTS_AFTER;
    case NC_SORTS_BEFORE:
      return NC_SORTS_BEFORE;
    case NC_INCLUDES: // n2 is more specific
      return NC_SORTS_AFTER;
    case NC_INCLUDED_BY: // n1 is more specific
      return NC_SORTS_BEFORE;
    case NC_EQUAL: // only case when we need to look before the @
      break; // see below for readability
    }
  }

  /* i && j, both are emails, domain names match, compare up to @ */
  return compare_strings(n1->data, i - 1, n2->data, j - 1);
}

/* Rich-compare IP address constraints. Example order/relationships:
 * 10.0.0.0/24 INCLUDED_BY 10.0.0.0/16 BEFORE 1::1/128 INCLUDED_BY 1::1/127 */
static enum name_constraint_relation compare_ip_ncs(const gnutls_datum_t *n1,
                const gnutls_datum_t *n2)
{
  unsigned int len, i;
  int r;
  const unsigned char *ip1, *ip2, *mask1, *mask2;
  unsigned char masked11[16], masked22[16], masked12[16], masked21[16];

  if (n1->size < n2->size)
    return NC_SORTS_BEFORE;
  if (n1->size > n2->size)
    return NC_SORTS_AFTER;
  len = n1->size / 2; /* 4 for IPv4, 16 for IPv6 */

  /* data is a concatenation of prefix and mask */
  ip1 = n1->data;
  ip2 = n2->data;
  mask1 = n1->data + len;
  mask2 = n2->data + len;
  for (i = 0; i < len; i++) {
    masked11[i] = ip1[i] & mask1[i];
    masked22[i] = ip2[i] & mask2[i];
    masked12[i] = ip1[i] & mask2[i];
    masked21[i] = ip2[i] & mask1[i];
  }

  r = memcmp(mask1, mask2, len);
  if (r < 0 && !memcmp(masked11, masked21, len)) /* prefix1 < prefix2 */
    return NC_INCLUDES; /* ip1 & mask1 == ip2 & mask1 */
  if (r > 0 && !memcmp(masked12, masked22, len)) /* prefix1 > prefix2 */
    return NC_INCLUDED_BY; /* ip1 & mask2 == ip2 & mask2 */

  r = memcmp(masked11, masked22, len);
  if (r < 0)
    return NC_SORTS_BEFORE;
  else if (r > 0)
    return NC_SORTS_AFTER;
  return NC_EQUAL;
}

static inline bool is_supported_type(gnutls_x509_subject_alt_name_t type)
{
  /* all of these should be under GNUTLS_SAN_MAX (intersect bitmasks) */
  return type == GNUTLS_SAN_DNSNAME || type == GNUTLS_SAN_RFC822NAME ||
         type == GNUTLS_SAN_IPADDRESS;
}

/* Universal comparison for name constraint nodes.
 * Unsupported types sort before supported types to allow early handling.
 * NULL represents end-of-list and sorts after everything else. */
static enum name_constraint_relation
compare_name_constraint_nodes(const struct name_constraints_node_st *n1,
            const struct name_constraints_node_st *n2)
{
  bool n1_supported, n2_supported;

  if (!n1 && !n2)
    return NC_EQUAL;
  if (!n1)
    return NC_SORTS_AFTER;
  if (!n2)
    return NC_SORTS_BEFORE;

  n1_supported = is_supported_type(n1->type);
  n2_supported = is_supported_type(n2->type);

  /* unsupported types bubble up (sort first). intersect relies on this */
  if (!n1_supported && n2_supported)
    return NC_SORTS_BEFORE;
  if (n1_supported && !n2_supported)
    return NC_SORTS_AFTER;

  /* next, sort by type */
  if (n1->type < n2->type)
    return NC_SORTS_BEFORE;
  if (n1->type > n2->type)
    return NC_SORTS_AFTER;

  /* now look deeper */
  switch (n1->type) {
  case GNUTLS_SAN_DNSNAME:
    return compare_dns_names(&n1->name, &n2->name);
  case GNUTLS_SAN_RFC822NAME:
    return compare_emails(&n1->name, &n2->name);
  case GNUTLS_SAN_IPADDRESS:
    return compare_ip_ncs(&n1->name, &n2->name);
  default:
    /* unsupported types: stable lexicographic order */
    return compare_strings(n1->name.data, n1->name.size,
               n2->name.data, n2->name.size);
  }
}

static int compare_name_constraint_nodes_wrapper(const void *a, const void *b)
{
  const struct name_constraints_node_st *n1 = a;
  const struct name_constraints_node_st *n2 = b;
  enum name_constraint_relation rel;

  rel = compare_name_constraint_nodes(n1, n2);
  switch (rel) {
  case NC_SORTS_BEFORE:
  case NC_INCLUDED_BY:
    return -1;
  case NC_SORTS_AFTER:
  case NC_INCLUDES:
    return 1;
  case NC_EQUAL:
  default:
    return 0;
  }
}

static int
name_constraints_node_list_add(struct name_constraints_node_list_st *list,
             const struct name_constraints_node_st *node)
{
  if (!gl_list_nx_add_last(list->items, node))
    return gnutls_assert_val(GNUTLS_E_MEMORY_ERROR);
  if (!gl_sortedlist_nx_add(list->sorted_items,
          (gl_listelement_compar_fn)
            compare_name_constraint_nodes_wrapper,
          node))
    return gnutls_assert_val(GNUTLS_E_MEMORY_ERROR);
  return 0;
}

static int
name_constraints_node_list_init(struct name_constraints_node_list_st *list)
{
  int ret;
  gl_list_t items = NULL, sorted_items = NULL;

  items = gl_list_nx_create_empty(GL_ARRAY_LIST, NULL, NULL, NULL, true);
  if (!items) {
    ret = gnutls_assert_val(GNUTLS_E_MEMORY_ERROR);
    goto cleanup;
  }

  sorted_items =
    gl_list_nx_create_empty(GL_RBTREE_LIST, NULL, NULL, NULL, true);
  if (!sorted_items) {
    ret = gnutls_assert_val(GNUTLS_E_MEMORY_ERROR);
    goto cleanup;
  }

  list->items = _gnutls_take_pointer(&items);
  list->sorted_items = _gnutls_take_pointer(&sorted_items);

  ret = GNUTLS_E_SUCCESS;

cleanup:
  if (items)
    gl_list_free(items);
  if (sorted_items)
    gl_list_free(sorted_items);
  return ret;
}

static void
name_constraints_node_list_deinit(struct name_constraints_node_list_st *list)
{
  if (list->items)
    gl_list_free(list->items);
  if (list->sorted_items)
    gl_list_free(list->sorted_items);
}

static struct name_constraints_node_list_st
name_constraints_node_list_take(struct name_constraints_node_list_st *list)
{
  struct name_constraints_node_list_st dst;

  dst = *list;
  dst.items = _gnutls_take_pointer(&list->items);
  dst.sorted_items = _gnutls_take_pointer(&list->sorted_items);

  return dst;
}

static int
name_constraints_node_add_new(gnutls_x509_name_constraints_t nc,
            struct name_constraints_node_list_st *list,
            gnutls_x509_subject_alt_name_t type,
            const unsigned char *data, unsigned int size)
{
  struct name_constraints_node_st *node;
  int ret;
  node = name_constraints_node_new(nc, type, data, size);
  if (node == NULL) {
    gnutls_assert();
    return GNUTLS_E_MEMORY_ERROR;
  }
  ret = name_constraints_node_list_add(list, node);
  if (ret < 0) {
    gnutls_assert();
    return ret;
  }
  return GNUTLS_E_SUCCESS;
}

static int
name_constraints_node_add_copy(gnutls_x509_name_constraints_t nc,
             struct name_constraints_node_list_st *dest,
             const struct name_constraints_node_st *src)
{
  if (!src)
    return gnutls_assert_val(GNUTLS_E_INTERNAL_ERROR);
  return name_constraints_node_add_new(nc, dest, src->type,
               src->name.data, src->name.size);
}

/*-
 * _gnutls_x509_name_constraints_is_empty:
 * @nc: name constraints structure
 *
 * Test whether given name constraints structure has any constraints (permitted
 * or excluded). @nc must be allocated (not NULL) before the call.
 *
 * Returns: true if @nc contains no constraints, false otherwise
 -*/
bool _gnutls_x509_name_constraints_is_empty(gnutls_x509_name_constraints_t nc)
{
  return gl_list_size(nc->permitted.items) == 0 &&
         gl_list_size(nc->excluded.items) == 0;
}

static bool name_constraints_contains_type(gnutls_x509_name_constraints_t nc,
             gnutls_x509_subject_alt_name_t type)
{
  const struct name_constraints_node_st *node;
  gl_list_iterator_t iter;

  iter = gl_list_iterator(nc->permitted.items);
  while (gl_list_iterator_next(&iter, (const void **)&node, NULL)) {
    if (node->type == type) {
      gl_list_iterator_free(&iter);
      return true;
    }
  }
  gl_list_iterator_free(&iter);

  iter = gl_list_iterator(nc->excluded.items);
  while (gl_list_iterator_next(&iter, (const void **)&node, NULL)) {
    if (node->type == type) {
      gl_list_iterator_free(&iter);
      return true;
    }
  }
  gl_list_iterator_free(&iter);

  /* no constraint for that type exists */
  return false;
}

/*-
 * validate_name_constraints_node:
 * @type: type of name constraints
 * @name: datum of name constraint
 *
 * Check the validity of given name constraints node (@type and @name).
 * The supported types are GNUTLS_SAN_DNSNAME, GNUTLS_SAN_RFC822NAME,
 * GNUTLS_SAN_DN, GNUTLS_SAN_URI and GNUTLS_SAN_IPADDRESS.
 *
 * CIDR ranges are checked for correct length (IPv4/IPv6) and correct mask format.
 *
 * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value.
 -*/
static int validate_name_constraints_node(gnutls_x509_subject_alt_name_t type,
            const gnutls_datum_t *name)
{
  if (type != GNUTLS_SAN_DNSNAME && type != GNUTLS_SAN_RFC822NAME &&
      type != GNUTLS_SAN_DN && type != GNUTLS_SAN_URI &&
      type != GNUTLS_SAN_IPADDRESS &&
      type != GNUTLS_SAN_OTHERNAME_MSUSERPRINCIPAL &&
      type != GNUTLS_SAN_OTHERNAME_SRV) {
    return gnutls_assert_val(GNUTLS_E_X509_UNKNOWN_SAN);
  }

  if (type == GNUTLS_SAN_IPADDRESS) {
    if (name->size != 8 && name->size != 32)
      return gnutls_assert_val(GNUTLS_E_ILLEGAL_PARAMETER);
    int prefix = _gnutls_mask_to_prefix(name->data + name->size / 2,
                name->size / 2);
    if (prefix < 0)
      return gnutls_assert_val(GNUTLS_E_MALFORMED_CIDR);
  }

  /* Validate DNS names and email addresses for malformed input */
  if (type == GNUTLS_SAN_DNSNAME || type == GNUTLS_SAN_RFC822NAME) {
    unsigned int i;
    if (name->size == 0)
      return GNUTLS_E_SUCCESS;

    /* reject names with consecutive dots... */
    for (i = 0; i + 1 < name->size; i++) {
      if (name->data[i] == '.' && name->data[i + 1] == '.')
        return gnutls_assert_val(
          GNUTLS_E_ILLEGAL_PARAMETER);
    }
    /* ... or names consisting exclusively of dots */
    if (name->size == 1 && name->data[0] == '.')
      return gnutls_assert_val(GNUTLS_E_ILLEGAL_PARAMETER);
  }

  return GNUTLS_E_SUCCESS;
}

static int extract_name_constraints(gnutls_x509_name_constraints_t nc,
            asn1_node c2, const char *vstr,
            struct name_constraints_node_list_st *nodes)
{
  int ret;
  char tmpstr[128];
  unsigned indx;
  gnutls_datum_t tmp = { NULL, 0 };
  gnutls_x509_subject_alt_name_t type;

  for (indx = 1;; indx++) {
    snprintf(tmpstr, sizeof(tmpstr), "%s.?%u.base", vstr, indx);

    ret = _gnutls_parse_general_name2(c2, tmpstr, -1, &tmp, &type,
              0);

    if (ret < 0) {
      gnutls_assert();
      break;
    }

    if (type == GNUTLS_SAN_OTHERNAME) {
      gnutls_datum_t oid = { NULL, 0 };
      gnutls_datum_t parsed_othername = { NULL, 0 };
      ret = _gnutls_parse_general_name2(c2, tmpstr, -1, &oid,
                &type, 1);
      if (ret < 0) {
        gnutls_assert();
        goto cleanup;
      }

      ret = gnutls_x509_othername_to_virtual(
        (char *)oid.data, &tmp, &type,
        &parsed_othername);
      if (ret < 0) {
        gnutls_assert();
        goto cleanup;
      }

      gnutls_free(oid.data);
      gnutls_free(tmp.data);

      memcpy(&tmp, &parsed_othername, sizeof(gnutls_datum_t));
    }

    ret = validate_name_constraints_node(type, &tmp);
    if (ret < 0) {
      gnutls_assert();
      goto cleanup;
    }

    ret = name_constraints_node_add_new(nc, nodes, type, tmp.data,
                tmp.size);
    _gnutls_free_datum(&tmp);
    if (ret < 0) {
      gnutls_assert();
      goto cleanup;
    }
  }

  assert(ret < 0);
  if (ret != GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE) {
    gnutls_assert();
    goto cleanup;
  }

  ret = 0;
cleanup:
  gnutls_free(tmp.data);
  return ret;
}

int _gnutls_x509_name_constraints_extract(asn1_node c2,
            const char *permitted_name,
            const char *excluded_name,
            gnutls_x509_name_constraints_t nc)
{
  int ret;

  ret = extract_name_constraints(nc, c2, permitted_name, &nc->permitted);
  if (ret < 0)
    return gnutls_assert_val(ret);
  ret = extract_name_constraints(nc, c2, excluded_name, &nc->excluded);
  if (ret < 0)
    return gnutls_assert_val(ret);

  return ret;
}

/*-
 * name_constraints_node_free:
 * @node: name constraints node
 *
 * Deallocate a name constraints node.
 -*/
static void name_constraints_node_free(struct name_constraints_node_st *node)
{
  if (node) {
    gnutls_free(node->name.data);
    gnutls_free(node);
  }
}

/*-
 * name_constraints_node_new:
 * @type: name constraints type to set (gnutls_x509_subject_alt_name_t)
 * @nc: a %gnutls_x509_name_constraints_t
 * @data: name.data to set or NULL
 * @size: name.size to set
 *
 * Allocate a new name constraints node and set its type, name size and name data.
 *
 * Returns: Pointer to newly allocated node or NULL in case of memory error.
 -*/
static struct name_constraints_node_st *
name_constraints_node_new(gnutls_x509_name_constraints_t nc,
        gnutls_x509_subject_alt_name_t type,
        const unsigned char *data, unsigned int size)
{
  struct name_constraints_node_st *tmp;
  int ret;

  tmp = gnutls_calloc(1, sizeof(struct name_constraints_node_st));
  if (tmp == NULL)
    return NULL;
  tmp->type = type;

  if (data) {
    ret = _gnutls_set_strdatum(&tmp->name, data, size);
    if (ret < 0) {
      gnutls_assert();
      gnutls_free(tmp);
      return NULL;
    }
  }

  if (!gl_list_nx_add_last(nc->nodes, tmp)) {
    gnutls_assert();
    name_constraints_node_free(tmp);
    return NULL;
  }

  return tmp;
}

static int name_constraints_node_list_union(
  gnutls_x509_name_constraints_t nc,
  struct name_constraints_node_list_st *result,
  const struct name_constraints_node_list_st *nodes1,
  const struct name_constraints_node_list_st *nodes2);

static san_flags_t name_constraints_node_list_types(
  const struct name_constraints_node_list_st *nodes)
{
  const struct name_constraints_node_st *node;
  gl_list_iterator_t iter;
  san_flags_t flags = 0;

  iter = gl_list_iterator(nodes->sorted_items);
  while (gl_list_iterator_next(&iter, (const void **)&node, NULL))
    flags |= SAN_FLAG(node->type);
  gl_list_iterator_free(&iter);
  return flags;
}

static int name_constraints_node_list_partition(
  struct name_constraints_node_list_st *supported,
  struct name_constraints_node_list_st *unsupported,
  const struct name_constraints_node_list_st *nodes)
{
  int ret;
  const struct name_constraints_node_st *node = NULL;
  gl_list_iterator_t iter;

  iter = gl_list_iterator(nodes->sorted_items);
  while (gl_list_iterator_next(&iter, (const void **)&node, NULL)) {
    ret = name_constraints_node_list_add(
      is_supported_type(node->type) ? supported : unsupported,
      node);
    if (ret < 0) {
      gnutls_assert();
      goto cleanup;
    }
  }

  ret = GNUTLS_E_SUCCESS;

cleanup:
  gl_list_iterator_free(&iter);
  return ret;
}

/*-
 * @brief name_constraints_node_list_intersect:
 * @nc: %gnutls_x509_name_constraints_t
 * @result: resulting name constraints list (permitted)
 * @permitted1: first name constraints list (permitted)
 * @permitted2: second name constraints list (permitted)
 * @excluded: corresponding excluded name constraints list
 *
 * This function finds the intersection of @permitted1 and
 * @permitted2. The result is placed in @result. If necessary, a
 * universal excluded name constraint node of the right type is added
 * to the list provided in @excluded.
 *
 * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value.
 -*/
static int name_constraints_node_list_intersect(
  gnutls_x509_name_constraints_t nc,
  struct name_constraints_node_list_st *result,
  const struct name_constraints_node_list_st *permitted1,
  const struct name_constraints_node_list_st *permitted2,
  struct name_constraints_node_list_st *excluded)
{
  struct name_constraints_node_list_st supported1 = { NULL, }, unsupported1 = { NULL, };
  struct name_constraints_node_list_st supported2 = { NULL, }, unsupported2 = { NULL, };
  int ret;
  const struct name_constraints_node_st *node1 = NULL, *node2 = NULL;
  gl_list_iterator_t iter1, iter2;
  san_flags_t universal_exclude_needed = 0;
  san_flags_t types_in_p1 = 0, types_in_p2 = 0;
  static const unsigned char universal_ip[32] = { 0 };

  /* First partition PERMITTED1 into supported and unsupported lists */
  ret = name_constraints_node_list_init(&supported1);
  if (ret < 0) {
    gnutls_assert();
    goto cleanup;
  }

  ret = name_constraints_node_list_init(&unsupported1);
  if (ret < 0) {
    gnutls_assert();
    goto cleanup;
  }

  ret = name_constraints_node_list_partition(&supported1, &unsupported1,
               permitted1);
  if (ret < 0) {
    gnutls_assert();
    goto cleanup;
  }

  /* Do the same for PERMITTED2 */
  ret = name_constraints_node_list_init(&supported2);
  if (ret < 0) {
    gnutls_assert();
    goto cleanup;
  }

  ret = name_constraints_node_list_init(&unsupported2);
  if (ret < 0) {
    gnutls_assert();
    goto cleanup;
  }

  ret = name_constraints_node_list_partition(&supported2, &unsupported2,
               permitted2);
  if (ret < 0) {
    gnutls_assert();
    goto cleanup;
  }

  /* Store unsupported1 | unsupported2 as a temporary result */
  ret = name_constraints_node_list_union(nc, result, &unsupported1,
                 &unsupported2);
  if (ret < 0) {
    gnutls_assert();
    goto cleanup;
  }

  /* Secondly figure out which types are in supported1 and supported2 */
  types_in_p1 = name_constraints_node_list_types(&supported1);
  types_in_p2 = name_constraints_node_list_types(&supported2);
  /* Universal excludes might be needed for types intersecting
   * to empty */
  universal_exclude_needed = types_in_p1 & types_in_p2;

  /* Finally go through supported type NCs and intersect in a
   * single pass */
  iter1 = gl_list_iterator(supported1.sorted_items);
  iter2 = gl_list_iterator(supported2.sorted_items);
  gl_list_iterator_next(&iter1, (const void **)&node1, NULL);
  gl_list_iterator_next(&iter2, (const void **)&node2, NULL);
  while (node1 || node2) {
    enum name_constraint_relation rel;

    rel = compare_name_constraint_nodes(node1, node2);
    switch (rel) {
    case NC_SORTS_BEFORE:
      assert(node1 != NULL); /* comparator-guaranteed */
      /* if nothing to intersect with, shallow-copy node1 */
      if (!(types_in_p2 & SAN_FLAG(node1->type))) {
        ret = name_constraints_node_list_add(result,
                     node1);
        if (ret < 0) {
          gnutls_assert();
          goto out;
        }
      }
      /* otherwise skip node1 */
      node1 = NULL;
      gl_list_iterator_next(&iter1, (const void **)&node1,
                NULL);
      break;
    case NC_SORTS_AFTER:
      assert(node2 != NULL); /* comparator-guaranteed */
      /* if nothing to intersect with, deep-copy node2 */
      if (!(types_in_p1 & SAN_FLAG(node2->type))) {
        ret = name_constraints_node_add_copy(nc, result,
                     node2);
        if (ret < 0) {
          gnutls_assert();
          goto out;
        }
      }
      /* otherwise skip node2 */
      node2 = NULL;
      gl_list_iterator_next(&iter2, (const void **)&node2,
                NULL);
      break;
    case NC_INCLUDED_BY: /* add node1, shallow-copy */
      assert(node1 != NULL && node2 != NULL); /* comparator */
      universal_exclude_needed &= ~SAN_FLAG(node1->type);
      ret = name_constraints_node_list_add(result, node1);
      if (ret < 0) {
        gnutls_assert();
        goto out;
      }
      node1 = NULL;
      gl_list_iterator_next(&iter1, (const void **)&node1,
                NULL);
      break;
    case NC_INCLUDES: /* pick node2, deep-copy */
      assert(node1 != NULL && node2 != NULL); /* comparator */
      universal_exclude_needed &= ~SAN_FLAG(node2->type);
      ret = name_constraints_node_add_copy(nc, result, node2);
      if (ret < 0) {
        gnutls_assert();
        goto out;
      }
      node2 = NULL;
      gl_list_iterator_next(&iter2, (const void **)&node2,
                NULL);
      break;
    case NC_EQUAL: /* pick whichever: nc1, shallow-copy */
      assert(node1 != NULL &&
             node2 != NULL); /* loop condition */
      universal_exclude_needed &= ~SAN_FLAG(node1->type);
      ret = name_constraints_node_list_add(result, node1);
      if (ret < 0) {
        gnutls_assert();
        goto out;
      }
      node1 = NULL;
      gl_list_iterator_next(&iter1, (const void **)&node1,
                NULL);
      node2 = NULL;
      gl_list_iterator_next(&iter2, (const void **)&node2,
                NULL);
      break;
    }
  }
out:
  gl_list_iterator_free(&iter1);
  gl_list_iterator_free(&iter2);
  if (ret < 0)
    goto cleanup;

  /* finishing touch: add universal excluded constraints for types where
   * both lists had constraints, but all intersections ended up empty */
  for (gnutls_x509_subject_alt_name_t type = SAN_MIN;
       type <= GNUTLS_SAN_MAX; type++) {
    if (!(universal_exclude_needed & SAN_FLAG(type)))
      continue;
    _gnutls_hard_log(
      "Adding universal excluded name constraint for type %d.\n",
      type);
    switch (type) {
    case GNUTLS_SAN_IPADDRESS:
      // add universal restricted range for IPv4
      ret = name_constraints_node_add_new(
        nc, excluded, GNUTLS_SAN_IPADDRESS,
        universal_ip, 8);
      if (ret < 0) {
        gnutls_assert();
        goto cleanup;
      }
      // add universal restricted range for IPv6
      ret = name_constraints_node_add_new(
        nc, excluded, GNUTLS_SAN_IPADDRESS,
        universal_ip, 32);
      if (ret < 0) {
        gnutls_assert();
        goto cleanup;
      }
      break;
    case GNUTLS_SAN_DNSNAME:
    case GNUTLS_SAN_RFC822NAME:
      ret = name_constraints_node_add_new(nc, excluded, type,
                  NULL, 0);
      if (ret < 0) {
        gnutls_assert();
        goto cleanup;
      }
      break;
    default: /* unsupported type; should be unreacheable */
      ret = gnutls_assert_val(GNUTLS_E_INTERNAL_ERROR);
      goto cleanup;
    }
  }

  ret = GNUTLS_E_SUCCESS;

cleanup:
  name_constraints_node_list_deinit(&supported1);
  name_constraints_node_list_deinit(&unsupported1);
  name_constraints_node_list_deinit(&supported2);
  name_constraints_node_list_deinit(&unsupported2);
  return ret;
}

static int name_constraints_node_list_union(
  gnutls_x509_name_constraints_t nc,
  struct name_constraints_node_list_st *result,
  const struct name_constraints_node_list_st *nodes1,
  const struct name_constraints_node_list_st *nodes2)
{
  int ret;
  gl_list_iterator_t iter1, iter2;
  const struct name_constraints_node_st *node1 = NULL, *node2 = NULL;

  /* traverse both lists in a single pass and merge them w/o duplicates */
  iter1 = gl_list_iterator(nodes1->sorted_items);
  iter2 = gl_list_iterator(nodes2->sorted_items);
  gl_list_iterator_next(&iter1, (const void **)&node1, NULL);
  gl_list_iterator_next(&iter2, (const void **)&node2, NULL);
  while (node1 || node2) {
    enum name_constraint_relation rel;

    rel = compare_name_constraint_nodes(node1, node2);
    switch (rel) {
    case NC_SORTS_BEFORE:
      assert(node1 != NULL); /* comparator-guaranteed */
      ret = name_constraints_node_list_add(result, node1);
      if (ret < 0) {
        gnutls_assert();
        goto cleanup;
      }
      node1 = NULL;
      gl_list_iterator_next(&iter1, (const void **)&node1,
                NULL);
      break;
    case NC_SORTS_AFTER:
      assert(node2 != NULL); /* comparator-guaranteed */
      ret = name_constraints_node_add_copy(nc, result, node2);
      if (ret < 0) {
        gnutls_assert();
        goto cleanup;
      }
      node2 = NULL;
      gl_list_iterator_next(&iter2, (const void **)&node2,
                NULL);
      break;
    case NC_INCLUDES: /* node1 is broader, shallow-copy it */
      assert(node1 != NULL && node2 != NULL); /* comparator */
      ret = name_constraints_node_list_add(result, node1);
      if (ret < 0) {
        gnutls_assert();
        goto cleanup;
      }
      node1 = NULL;
      gl_list_iterator_next(&iter1, (const void **)&node1,
                NULL);
      node2 = NULL;
      gl_list_iterator_next(&iter2, (const void **)&node2,
                NULL);
      break;
    case NC_INCLUDED_BY: /* node2 is broader, deep-copy it */
      assert(node1 != NULL && node2 != NULL); /* comparator */
      ret = name_constraints_node_add_copy(nc, result, node2);
      if (ret < 0) {
        gnutls_assert();
        goto cleanup;
      }
      node1 = NULL;
      gl_list_iterator_next(&iter1, (const void **)&node1,
                NULL);
      node2 = NULL;
      gl_list_iterator_next(&iter2, (const void **)&node2,
                NULL);
      break;
    case NC_EQUAL:
      assert(node1 != NULL &&
             node2 != NULL); /* loop condition */
      ret = name_constraints_node_list_add(result, node1);
      if (ret < 0) {
        gnutls_assert();
        goto cleanup;
      }
      node1 = NULL;
      gl_list_iterator_next(&iter1, (const void **)&node1,
                NULL);
      node2 = NULL;
      gl_list_iterator_next(&iter2, (const void **)&node2,
                NULL);
      break;
    }
  }

  ret = GNUTLS_E_SUCCESS;

cleanup:
  gl_list_iterator_free(&iter1);
  gl_list_iterator_free(&iter2);

  return ret;
}

/**
 * gnutls_x509_crt_get_name_constraints:
 * @crt: should contain a #gnutls_x509_crt_t type
 * @nc: The nameconstraints intermediate type
 * @flags: zero or %GNUTLS_EXT_FLAG_APPEND
 * @critical: the extension status
 *
 * This function will return an intermediate type containing
 * the name constraints of the provided CA certificate. That
 * structure can be used in combination with gnutls_x509_name_constraints_check()
 * to verify whether a server's name is in accordance with the constraints.
 *
 * When the @flags is set to %GNUTLS_EXT_FLAG_APPEND,
 * then if the @nc structure is empty this function will behave
 * identically as if the flag was not set.
 * Otherwise if there are elements in the @nc structure then the
 * constraints will be merged with the existing constraints following
 * RFC5280 p6.1.4 (excluded constraints will be appended, permitted
 * will be intersected).
 *
 * Note that @nc must be initialized prior to calling this function.
 *
 * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE
 * if the extension is not present, otherwise a negative error value.
 *
 * Since: 3.3.0
 **/
int gnutls_x509_crt_get_name_constraints(gnutls_x509_crt_t crt,
           gnutls_x509_name_constraints_t nc,
           unsigned int flags,
           unsigned int *critical)
{
  int ret;
  gnutls_datum_t der = { NULL, 0 };

  if (crt == NULL) {
    gnutls_assert();
    return GNUTLS_E_INVALID_REQUEST;
  }

  ret = _gnutls_x509_crt_get_extension(crt, "2.5.29.30", 0, &der,
               critical);
  if (ret < 0)
    return gnutls_assert_val(ret);

  if (der.size == 0 || der.data == NULL)
    return gnutls_assert_val(GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE);

  ret = gnutls_x509_ext_import_name_constraints(&der, nc, flags);
  if (ret < 0) {
    gnutls_assert();
    goto cleanup;
  }

  ret = 0;

cleanup:
  _gnutls_free_datum(&der);

  return ret;
}

static void name_constraints_deinit(struct gnutls_name_constraints_st *nc)
{
  if (nc->nodes)
    gl_list_free(nc->nodes);
  name_constraints_node_list_deinit(&nc->permitted);
  name_constraints_node_list_deinit(&nc->excluded);
}

static struct gnutls_name_constraints_st
name_constraints_take(struct gnutls_name_constraints_st *nc)
{
  struct gnutls_name_constraints_st dst;

  dst = *nc;
  dst.nodes = _gnutls_take_pointer(&nc->nodes);
  dst.permitted = name_constraints_node_list_take(&nc->permitted);
  dst.excluded = name_constraints_node_list_take(&nc->excluded);

  return dst;
}

static int name_constraints_init(struct gnutls_name_constraints_st *nc)
{
  struct gnutls_name_constraints_st tmp = {
    NULL,
  };
  int ret;

  tmp.nodes = gl_list_nx_create_empty(
    GL_ARRAY_LIST, NULL, NULL,
    (gl_listelement_dispose_fn)name_constraints_node_free, true);
  if (!tmp.nodes) {
    ret = gnutls_assert_val(GNUTLS_E_MEMORY_ERROR);
    goto cleanup;
  }

  ret = name_constraints_node_list_init(&tmp.permitted);
  if (ret < 0) {
    gnutls_assert();
    goto cleanup;
  }

  ret = name_constraints_node_list_init(&tmp.excluded);
  if (ret < 0) {
    gnutls_assert();
    goto cleanup;
  }

  *nc = name_constraints_take(&tmp);

  ret = 0;

cleanup:
  name_constraints_deinit(&tmp);
  return ret;
}

int _gnutls_x509_name_constraints_clear(gnutls_x509_name_constraints_t nc)
{
  name_constraints_deinit(nc);
  return name_constraints_init(nc);
}

/**
 * gnutls_x509_name_constraints_deinit:
 * @nc: The nameconstraints
 *
 * This function will deinitialize a name constraints type.
 *
 * Since: 3.3.0
 **/
void gnutls_x509_name_constraints_deinit(gnutls_x509_name_constraints_t nc)
{
  name_constraints_deinit(nc);
  gnutls_free(nc);
}

/**
 * gnutls_x509_name_constraints_init:
 * @nc: The nameconstraints
 *
 * This function will initialize a name constraints type.
 *
 * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value.
 *
 * Since: 3.3.0
 **/
int gnutls_x509_name_constraints_init(gnutls_x509_name_constraints_t *nc)
{
  struct gnutls_name_constraints_st *tmp;
  int ret;

  tmp = gnutls_calloc(1, sizeof(struct gnutls_name_constraints_st));
  if (tmp == NULL) {
    gnutls_assert();
    return GNUTLS_E_MEMORY_ERROR;
  }

  ret = name_constraints_init(tmp);
  if (ret < 0) {
    gnutls_assert();
    goto cleanup;
  }

  *nc = _gnutls_take_pointer(&tmp);
  ret = 0;

cleanup:
  if (tmp) {
    name_constraints_deinit(tmp);
    gnutls_free(tmp);
  }
  return ret;
}

static int name_constraints_add(gnutls_x509_name_constraints_t nc,
        gnutls_x509_subject_alt_name_t type,
        const gnutls_datum_t *name, unsigned permitted)
{
  struct name_constraints_node_list_st *nodes;
  int ret;

  ret = validate_name_constraints_node(type, name);
  if (ret < 0)
    return gnutls_assert_val(ret);

  nodes = permitted ? &nc->permitted : &nc->excluded;

  ret = name_constraints_node_add_new(nc, nodes, type, name->data,
              name->size);
  if (ret < 0)
    return gnutls_assert_val(ret);

  return 0;
}

/*-
 * _gnutls_x509_name_constraints_merge:
 * @nc: The nameconstraints
 * @nc2: The name constraints to be merged with
 *
 * This function will merge the provided name constraints structures
 * as per RFC5280 p6.1.4. That is, the excluded constraints will be unioned,
 * and permitted will be intersected. The intersection assumes that @nc
 * is the root CA constraints.
 *
 * The merged constraints will be placed in @nc.
 *
 * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value.
 *
 * Since: 3.5.0
 -*/
int _gnutls_x509_name_constraints_merge(gnutls_x509_name_constraints_t nc,
          gnutls_x509_name_constraints_t nc2)
{
  struct name_constraints_node_list_st permitted = { NULL, }, excluded = { NULL, };
  int ret;

  ret = name_constraints_node_list_init(&permitted);
  if (ret < 0) {
    gnutls_assert();
    goto cleanup;
  }

  ret = name_constraints_node_list_intersect(
    nc, &permitted, &nc->permitted, &nc2->permitted, &nc->excluded);
  if (ret < 0) {
    gnutls_assert();
    goto cleanup;
  }

  ret = name_constraints_node_list_init(&excluded);
  if (ret < 0) {
    gnutls_assert();
    goto cleanup;
  }

  ret = name_constraints_node_list_union(nc, &excluded, &nc->excluded,
                 &nc2->excluded);
  if (ret < 0) {
    gnutls_assert();
    goto cleanup;
  }
  name_constraints_node_list_deinit(&nc->permitted);
  nc->permitted = name_constraints_node_list_take(&permitted);
  name_constraints_node_list_deinit(&nc->excluded);
  nc->excluded = name_constraints_node_list_take(&excluded);

  ret = GNUTLS_E_SUCCESS;

cleanup:
  name_constraints_node_list_deinit(&permitted);
  name_constraints_node_list_deinit(&excluded);
  return ret;
}

/**
 * gnutls_x509_name_constraints_add_permitted:
 * @nc: The nameconstraints
 * @type: The type of the constraints
 * @name: The data of the constraints
 *
 * This function will add a name constraint to the list of permitted
 * constraints. The constraints @type can be any of the following types:
 * %GNUTLS_SAN_DNSNAME, %GNUTLS_SAN_RFC822NAME, %GNUTLS_SAN_DN,
 * %GNUTLS_SAN_URI, %GNUTLS_SAN_IPADDRESS. For the latter, an IP address
 * in network byte order is expected, followed by its network mask.
 *
 * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value.
 *
 * Since: 3.3.0
 **/
int gnutls_x509_name_constraints_add_permitted(
  gnutls_x509_name_constraints_t nc, gnutls_x509_subject_alt_name_t type,
  const gnutls_datum_t *name)
{
  return name_constraints_add(nc, type, name, 1);
}

/**
 * gnutls_x509_name_constraints_add_excluded:
 * @nc: The nameconstraints
 * @type: The type of the constraints
 * @name: The data of the constraints
 *
 * This function will add a name constraint to the list of excluded
 * constraints. The constraints @type can be any of the following types:
 * %GNUTLS_SAN_DNSNAME, %GNUTLS_SAN_RFC822NAME, %GNUTLS_SAN_DN,
 * %GNUTLS_SAN_URI, %GNUTLS_SAN_IPADDRESS. For the latter, an IP address
 * in network byte order is expected, followed by its network mask (which is
 * 4 bytes in IPv4 or 16-bytes in IPv6).
 *
 * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value.
 *
 * Since: 3.3.0
 **/
int gnutls_x509_name_constraints_add_excluded(
  gnutls_x509_name_constraints_t nc, gnutls_x509_subject_alt_name_t type,
  const gnutls_datum_t *name)
{
  return name_constraints_add(nc, type, name, 0);
}

/**
 * gnutls_x509_crt_set_name_constraints:
 * @crt: The certificate
 * @nc: The nameconstraints structure
 * @critical: whether this extension will be critical
 *
 * This function will set the provided name constraints to
 * the certificate extension list. This extension is always
 * marked as critical.
 *
 * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value.
 *
 * Since: 3.3.0
 **/
int gnutls_x509_crt_set_name_constraints(gnutls_x509_crt_t crt,
           gnutls_x509_name_constraints_t nc,
           unsigned int critical)
{
  int ret;
  gnutls_datum_t der;

  ret = gnutls_x509_ext_export_name_constraints(nc, &der);
  if (ret < 0)
    return gnutls_assert_val(ret);

  ret = _gnutls_x509_crt_set_extension(crt, "2.5.29.30", &der, critical);
  if (ret < 0) {
    gnutls_assert();
    goto cleanup;
  }

  ret = 0;
  crt->use_extensions = 1;

cleanup:
  _gnutls_free_datum(&der);
  return ret;
}

static bool dnsname_matches(const gnutls_datum_t *name,
          const gnutls_datum_t *suffix)
{
  _gnutls_hard_log("matching %.*s with DNS constraint %.*s\n", name->size,
       name->data, suffix->size, suffix->data);

  enum name_constraint_relation rel = compare_dns_names(name, suffix);
  return rel == NC_EQUAL || rel == NC_INCLUDED_BY;
}

static bool email_matches(const gnutls_datum_t *name,
        const gnutls_datum_t *suffix)
{
  _gnutls_hard_log("matching %.*s with e-mail constraint %.*s\n",
       name->size, name->data, suffix->size, suffix->data);

  enum name_constraint_relation rel = compare_emails(name, suffix);
  return rel == NC_EQUAL || rel == NC_INCLUDED_BY;
}

/*
 * Returns: true if the certification is acceptable, and false otherwise.
 */
static bool check_unsupported_constraint(gnutls_x509_name_constraints_t nc,
           gnutls_x509_subject_alt_name_t type)
{
  unsigned i;
  int ret;
  unsigned rtype;
  gnutls_datum_t rname;

  /* check if there is a restrictions with that type, if
   * yes, then reject the name.
   */
  i = 0;
  do {
    ret = gnutls_x509_name_constraints_get_excluded(nc, i++, &rtype,
                &rname);
    if (ret >= 0) {
      if (rtype != type)
        continue;
      else
        return gnutls_assert_val(false);
    }

  } while (ret == 0);

  return true;
}

static bool check_dns_constraints(gnutls_x509_name_constraints_t nc,
          const gnutls_datum_t *name)
{
  unsigned i;
  int ret;
  unsigned rtype;
  bool allowed_found = false;
  gnutls_datum_t rname;

  /* check restrictions */
  i = 0;
  do {
    ret = gnutls_x509_name_constraints_get_excluded(nc, i++, &rtype,
                &rname);
    if (ret >= 0) {
      if (rtype != GNUTLS_SAN_DNSNAME)
        continue;

      /* a name of value 0 means that the CA shouldn't have issued
       * a certificate with a DNSNAME. */
      if (rname.size == 0)
        return gnutls_assert_val(false);

      if (dnsname_matches(name, &rname))
        return gnutls_assert_val(false); /* rejected */
    }
  } while (ret == 0);

  /* check allowed */
  i = 0;
  do {
    ret = gnutls_x509_name_constraints_get_permitted(
      nc, i++, &rtype, &rname);
    if (ret >= 0) {
      if (rtype != GNUTLS_SAN_DNSNAME)
        continue;

      if (rname.size == 0)
        continue;

      allowed_found = true;

      if (dnsname_matches(name, &rname))
        return true; /* accepted */
    }
  } while (ret == 0);

  /* there are allowed directives but this host wasn't found */
  if (allowed_found)
    return gnutls_assert_val(false);

  return true;
}

static unsigned check_email_constraints(gnutls_x509_name_constraints_t nc,
          const gnutls_datum_t *name)
{
  unsigned i;
  int ret;
  unsigned rtype;
  bool allowed_found = false;
  gnutls_datum_t rname;

  /* check restrictions */
  i = 0;
  do {
    ret = gnutls_x509_name_constraints_get_excluded(nc, i++, &rtype,
                &rname);
    if (ret >= 0) {
      if (rtype != GNUTLS_SAN_RFC822NAME)
        continue;

      /* a name of value 0 means that the CA shouldn't have issued
       * a certificate with an e-mail. */
      if (rname.size == 0)
        return gnutls_assert_val(false);

      if (email_matches(name, &rname))
        return gnutls_assert_val(false); /* rejected */
    }
  } while (ret == 0);

  /* check allowed */
  i = 0;
  do {
    ret = gnutls_x509_name_constraints_get_permitted(
      nc, i++, &rtype, &rname);
    if (ret >= 0) {
      if (rtype != GNUTLS_SAN_RFC822NAME)
        continue;

      if (rname.size == 0)
        continue;

      allowed_found = true;

      if (email_matches(name, &rname))
        return true; /* accepted */
    }
  } while (ret == 0);

  /* there are allowed directives but this host wasn't found */
  if (allowed_found)
    return gnutls_assert_val(false);

  return true;
}

static unsigned check_ip_constraints(gnutls_x509_name_constraints_t nc,
             const gnutls_datum_t *name)
{
  unsigned i;
  int ret;
  unsigned rtype;
  bool allowed_found = false;
  gnutls_datum_t rname;

  /* check restrictions */
  i = 0;
  do {
    ret = gnutls_x509_name_constraints_get_excluded(nc, i++, &rtype,
                &rname);
    if (ret >= 0) {
      if (rtype != GNUTLS_SAN_IPADDRESS)
        continue;

      /* do not check IPv4 against IPv6 constraints and vice versa */
      if (name->size != rname.size / 2)
        continue;

      if (ip_in_cidr(name, &rname))
        return gnutls_assert_val(false); /* rejected */
    }
  } while (ret == 0);

  /* check allowed */
  i = 0;
  do {
    ret = gnutls_x509_name_constraints_get_permitted(
      nc, i++, &rtype, &rname);
    if (ret >= 0) {
      if (rtype != GNUTLS_SAN_IPADDRESS)
        continue;

      /* do not check IPv4 against IPv6 constraints and vice versa */
      if (name->size != rname.size / 2)
        continue;

      allowed_found = true;

      if (ip_in_cidr(name, &rname))
        return true; /* accepted */
    }
  } while (ret == 0);

  /* there are allowed directives but this host wasn't found */
  if (allowed_found)
    return gnutls_assert_val(false);

  return true;
}

/**
 * gnutls_x509_name_constraints_check:
 * @nc: the extracted name constraints
 * @type: the type of the constraint to check (of type gnutls_x509_subject_alt_name_t)
 * @name: the name to be checked
 *
 * This function will check the provided name against the constraints in
 * @nc using the RFC5280 rules. Currently this function is limited to DNS
 * names, emails and IP addresses (of type %GNUTLS_SAN_DNSNAME,
 * %GNUTLS_SAN_RFC822NAME and %GNUTLS_SAN_IPADDRESS).
 *
 * Returns: zero if the provided name is not acceptable, and non-zero otherwise.
 *
 * Since: 3.3.0
 **/
unsigned gnutls_x509_name_constraints_check(gnutls_x509_name_constraints_t nc,
              gnutls_x509_subject_alt_name_t type,
              const gnutls_datum_t *name)
{
  if (type == GNUTLS_SAN_DNSNAME)
    return check_dns_constraints(nc, name);

  if (type == GNUTLS_SAN_RFC822NAME)
    return check_email_constraints(nc, name);

  if (type == GNUTLS_SAN_IPADDRESS)
    return check_ip_constraints(nc, name);

  return check_unsupported_constraint(nc, type);
}

/* This function checks for unsupported constraints, that we also
 * know their structure. That is it will fail only if the constraint
 * is present in the CA, _and_ the name in the end certificate contains
 * the constrained element.
 *
 * Returns: true if the certification is acceptable, and false otherwise
 */
static bool check_unsupported_constraint2(gnutls_x509_crt_t cert,
            gnutls_x509_name_constraints_t nc,
            gnutls_x509_subject_alt_name_t type)
{
  unsigned idx;
  bool found_one;
  char name[MAX_CN];
  size_t name_size;
  unsigned san_type;
  int ret;

  found_one = false;

  for (idx = 0;; idx++) {
    name_size = sizeof(name);
    ret = gnutls_x509_crt_get_subject_alt_name2(
      cert, idx, name, &name_size, &san_type, NULL);
    if (ret == GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE)
      break;
    else if (ret < 0)
      return gnutls_assert_val(false);

    if (san_type != GNUTLS_SAN_URI)
      continue;

    found_one = true;
    break;
  }

  if (found_one)
    return check_unsupported_constraint(nc, type);

  /* no name was found in the certificate, so accept */
  return true;
}

/**
 * gnutls_x509_name_constraints_check_crt:
 * @nc: the extracted name constraints
 * @type: the type of the constraint to check (of type gnutls_x509_subject_alt_name_t)
 * @cert: the certificate to be checked
 *
 * This function will check the provided certificate names against the constraints in
 * @nc using the RFC5280 rules. It will traverse all the certificate's names and
 * alternative names.
 *
 * Currently this function is limited to DNS
 * names and emails (of type %GNUTLS_SAN_DNSNAME and %GNUTLS_SAN_RFC822NAME).
 *
 * Returns: zero if the provided name is not acceptable, and non-zero otherwise.
 *
 * Since: 3.3.0
 **/
unsigned
gnutls_x509_name_constraints_check_crt(gnutls_x509_name_constraints_t nc,
               gnutls_x509_subject_alt_name_t type,
               gnutls_x509_crt_t cert)
{
  char name[MAX_CN];
  size_t name_size;
  int ret;
  unsigned idx, t, san_type;
  gnutls_datum_t n;
  bool found_one;
  size_t checks;

  if (!name_constraints_contains_type(nc, type))
    return 1; /* shortcut; no constraints to check */

  if (!INT_ADD_OK(gl_list_size(nc->permitted.items),
      gl_list_size(nc->excluded.items), &checks) ||
      !INT_MULTIPLY_OK(checks, cert->san->size, &checks) ||
      checks > MAX_NC_CHECKS) {
    return gnutls_assert_val(0);
  }

  if (type == GNUTLS_SAN_RFC822NAME) {
    found_one = false;
    for (idx = 0;; idx++) {
      name_size = sizeof(name);
      ret = gnutls_x509_crt_get_subject_alt_name2(
        cert, idx, name, &name_size, &san_type, NULL);
      if (ret == GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE)
        break;
      else if (ret < 0)
        return gnutls_assert_val(0);

      if (san_type != GNUTLS_SAN_RFC822NAME)
        continue;

      found_one = true;
      n.data = (void *)name;
      n.size = name_size;
      t = gnutls_x509_name_constraints_check(
        nc, GNUTLS_SAN_RFC822NAME, &n);
      if (t == 0)
        return gnutls_assert_val(t);
    }

    /* there is at least a single e-mail. That means that the EMAIL field will
     * not be used for verifying the identity of the holder. */
    if (found_one)
      return 1;

    do {
      /* ensure there is only a single EMAIL, similarly to CN handling (rfc6125) */
      name_size = sizeof(name);
      ret = gnutls_x509_crt_get_dn_by_oid(
        cert, GNUTLS_OID_PKCS9_EMAIL, 1, 0, name,
        &name_size);
      if (ret != GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE)
        return gnutls_assert_val(0);

      name_size = sizeof(name);
      ret = gnutls_x509_crt_get_dn_by_oid(
        cert, GNUTLS_OID_PKCS9_EMAIL, 0, 0, name,
        &name_size);
      if (ret == GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE)
        break;
      else if (ret < 0)
        return gnutls_assert_val(0);

      found_one = true;
      n.data = (void *)name;
      n.size = name_size;
      t = gnutls_x509_name_constraints_check(
        nc, GNUTLS_SAN_RFC822NAME, &n);
      if (t == 0)
        return gnutls_assert_val(t);
    } while (0);

    /* passed */
    if (found_one)
      return 1;
    else {
      /* no name was found. According to RFC5280: 
       * If no name of the type is in the certificate, the certificate is acceptable.
       */
      return gnutls_assert_val(1);
    }
  } else if (type == GNUTLS_SAN_DNSNAME) {
    found_one = false;
    for (idx = 0;; idx++) {
      name_size = sizeof(name);
      ret = gnutls_x509_crt_get_subject_alt_name2(
        cert, idx, name, &name_size, &san_type, NULL);
      if (ret == GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE)
        break;
      else if (ret < 0)
        return gnutls_assert_val(0);

      if (san_type != GNUTLS_SAN_DNSNAME)
        continue;

      found_one = true;
      n.data = (void *)name;
      n.size = name_size;
      t = gnutls_x509_name_constraints_check(
        nc, GNUTLS_SAN_DNSNAME, &n);
      if (t == 0)
        return gnutls_assert_val(t);
    }

    /* there is at least a single DNS name. That means that the CN will
     * not be used for verifying the identity of the holder. */
    if (found_one)
      return 1;

    /* verify the name constraints against the CN, if the certificate is
     * not a CA. We do this check only on certificates marked as WWW server,
     * because that's where the CN check is only performed. */
    if (_gnutls_check_key_purpose(cert, GNUTLS_KP_TLS_WWW_SERVER,
                0) != 0)
      do {
        /* ensure there is only a single CN, according to rfc6125 */
        name_size = sizeof(name);
        ret = gnutls_x509_crt_get_dn_by_oid(
          cert, GNUTLS_OID_X520_COMMON_NAME, 1, 0,
          name, &name_size);
        if (ret !=
            GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE)
          return gnutls_assert_val(0);

        name_size = sizeof(name);
        ret = gnutls_x509_crt_get_dn_by_oid(
          cert, GNUTLS_OID_X520_COMMON_NAME, 0, 0,
          name, &name_size);
        if (ret ==
            GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE)
          break;
        else if (ret < 0)
          return gnutls_assert_val(0);

        found_one = true;
        n.data = (void *)name;
        n.size = name_size;
        t = gnutls_x509_name_constraints_check(
          nc, GNUTLS_SAN_DNSNAME, &n);
        if (t == 0)
          return gnutls_assert_val(t);
      } while (0);

    /* passed */
    if (found_one)
      return 1;
    else {
      /* no name was found. According to RFC5280: 
       * If no name of the type is in the certificate, the certificate is acceptable.
       */
      return gnutls_assert_val(1);
    }
  } else if (type == GNUTLS_SAN_IPADDRESS) {
    found_one = false;
    for (idx = 0;; idx++) {
      name_size = sizeof(name);
      ret = gnutls_x509_crt_get_subject_alt_name2(
        cert, idx, name, &name_size, &san_type, NULL);
      if (ret == GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE)
        break;
      else if (ret < 0)
        return gnutls_assert_val(0);

      if (san_type != GNUTLS_SAN_IPADDRESS)
        continue;

      found_one = true;
      n.data = (void *)name;
      n.size = name_size;
      t = gnutls_x509_name_constraints_check(
        nc, GNUTLS_SAN_IPADDRESS, &n);
      if (t == 0)
        return gnutls_assert_val(t);
    }

    /* there is at least a single IP address. */

    if (found_one) {
      return 1;
    } else {
      /* no name was found. According to RFC5280:
       * If no name of the type is in the certificate, the certificate is acceptable.
       */
      return gnutls_assert_val(1);
    }
  } else if (type == GNUTLS_SAN_URI) {
    return check_unsupported_constraint2(cert, nc, type);
  } else
    return check_unsupported_constraint(nc, type);
}

/**
 * gnutls_x509_name_constraints_get_permitted:
 * @nc: the extracted name constraints
 * @idx: the index of the constraint
 * @type: the type of the constraint (of type gnutls_x509_subject_alt_name_t)
 * @name: the name in the constraint (of the specific type)
 *
 * This function will return an intermediate type containing
 * the name constraints of the provided CA certificate. That
 * structure can be used in combination with gnutls_x509_name_constraints_check()
 * to verify whether a server's name is in accordance with the constraints.
 *
 * The name should be treated as constant and valid for the lifetime of @nc.
 *
 * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE
 * if the extension is not present, otherwise a negative error value.
 *
 * Since: 3.3.0
 **/
int gnutls_x509_name_constraints_get_permitted(gnutls_x509_name_constraints_t nc,
                 unsigned idx, unsigned *type,
                 gnutls_datum_t *name)
{
  const struct name_constraints_node_st *tmp;

  if (idx >= gl_list_size(nc->permitted.items))
    return gnutls_assert_val(GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE);

  tmp = gl_list_get_at(nc->permitted.items, idx);

  *type = tmp->type;
  *name = tmp->name;

  return 0;
}

/**
 * gnutls_x509_name_constraints_get_excluded:
 * @nc: the extracted name constraints
 * @idx: the index of the constraint
 * @type: the type of the constraint (of type gnutls_x509_subject_alt_name_t)
 * @name: the name in the constraint (of the specific type)
 *
 * This function will return an intermediate type containing
 * the name constraints of the provided CA certificate. That
 * structure can be used in combination with gnutls_x509_name_constraints_check()
 * to verify whether a server's name is in accordance with the constraints.
 *
 * The name should be treated as constant and valid for the lifetime of @nc.
 *
 * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE
 * if the extension is not present, otherwise a negative error value.
 *
 * Since: 3.3.0
 **/
int gnutls_x509_name_constraints_get_excluded(gnutls_x509_name_constraints_t nc,
                unsigned idx, unsigned *type,
                gnutls_datum_t *name)
{
  const struct name_constraints_node_st *tmp;

  if (idx >= gl_list_size(nc->excluded.items))
    return gnutls_assert_val(GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE);

  tmp = gl_list_get_at(nc->excluded.items, idx);

  *type = tmp->type;
  *name = tmp->name;

  return 0;
}

Coverage Report

Created: 2026-05-16 07:57