Add support for limiting $INCLUDE depth

Author: k0ekk0ek

include/zone.h

@@ -312,6 +312,8 @@ typedef struct {
   /** Disable $INCLUDE directive. */
   /** Useful in setups where untrusted input may be offered. */
   bool no_includes;
+  /** Maximum $INCLUDE depth. 0 for default. */
+  uint32_t include_limit;
   /** Enable 1h2m3s notations for TTLS. */
   bool pretty_ttls;
   /** Origin in wire format. */

src/generic/format.h

@@ -296,12 +296,18 @@ static really_inline int32_t parse_dollar_include(
   }
 
   // check for recursive includes
-  do {
-    if (strcmp(includer->path, file->path) != 0)
-      continue;
-    zone_close_file(parser, file);
-    SYNTAX_ERROR(parser, "Circular include in %s", NAME(&include));
-  } while ((includer = includer->includer));
+  for (uint32_t depth = 1; includer; depth++, includer = includer->includer) {
+    if (strcmp(includer->path, file->path) == 0) {
+      zone_error(parser, "Circular include in %s", file->name);
+      zone_close_file(parser, file);
+      return ZONE_SEMANTIC_ERROR;
+    }
+    if (depth > parser->options.include_limit) {
+      zone_error(parser, "Include %s nested too deeply", file->name);
+      zone_close_file(parser, file);
+      return ZONE_SEMANTIC_ERROR;
+    }
+  }
 
   adjust_line_count(parser->file);
   parser->file = file;

src/zone.c

@@ -392,6 +392,10 @@ static int32_t initialize_parser(
   parser->owner = &parser->buffers.owner.blocks[0];
   parser->owner->length = 0;
   parser->rdata = &parser->buffers.rdata.blocks[0];
+
+  if (!parser->options.no_includes && !parser->options.include_limit)
+    parser->options.include_limit = 10; // arbitrary, default in NSD
+
   return 0;
 }
 

tests/include.c

@@ -12,6 +12,7 @@
 #include <string.h>
 #include <stdlib.h>
 #include <cmocka.h>
+#include <limits.h>
 #if !_WIN32
 #include <unistd.h>
 #endif
@@ -125,6 +126,42 @@ int setup(void **state)
   return -1;
 }
 
+static char *generate_include(const char *text)
+{
+  char *path = tempnam(NULL, "zone");
+  if (path) {
+    FILE *handle = fopen(path, "wbx");
+    if (handle) {
+      int result = fputs(text, handle);
+      (void)fclose(handle);
+      if (result != EOF)
+        return path;
+    }
+    free(path);
+  }
+  return NULL;
+}
+
+static int32_t parse(
+  const zone_options_t *options, const char *text, void *user_data)
+{
+  zone_parser_t parser = { 0 };
+  zone_name_buffer_t name;
+  zone_rdata_buffer_t rdata;
+  zone_buffers_t buffers = { 1, &name, &rdata };
+
+  int32_t code;
+  size_t length = strlen(text);
+  char *string = malloc(length + 1 + ZONE_PADDING_SIZE);
+  assert_non_null(string);
+  memcpy(string, text, length);
+  string[length] = '\0';
+
+  code = zone_parse_string(&parser, options, &buffers, string, length, user_data);
+  free(string);
+  return code;
+}
+
 diagnostic_pop()
 
 static int32_t add_rr(
@@ -216,12 +253,12 @@ static int32_t no_such_file_accept(
 
 static void no_such_file_log(
   zone_parser_t *parser,
-  uint32_t category,
+  uint32_t priority,
   const char *message,
   void *user_data)
 {
   (void)parser;
-  (void)category;
+  (void)priority;
   if (!strstr(message, "no such file"))
     return;
   no_file_test_t *test = (no_file_test_t*)user_data;
@@ -232,10 +269,6 @@ static void no_such_file_log(
 void the_include_that_wasnt(void **state)
 {
   // test $INCLUDE of nonexistent file is handled gracefully
-  zone_parser_t parser = { 0 };
-  zone_name_buffer_t name;
-  zone_rdata_buffer_t rdata;
-  zone_buffers_t buffers = { 1, &name, &rdata };
   zone_options_t options = { 0 };
   no_file_test_t test = { 0 };
   int32_t code;
@@ -245,7 +278,7 @@ void the_include_that_wasnt(void **state)
   options.origin.octets = origin;
   options.origin.length = sizeof(origin);
   options.default_ttl = 3600;
-  options.default_class = ZONE_IN;
+  options.default_class = 1;
 
   (void)state;
 
@@ -256,16 +289,139 @@ void the_include_that_wasnt(void **state)
   int length = snprintf(buffer, sizeof(buffer), "$INCLUDE %s", non_include);
   assert_true(length >= 0 && (size_t)length < SIZE_MAX - (ZONE_PADDING_SIZE + 1));
 
-  char *include = malloc((size_t)length + 1 + ZONE_PADDING_SIZE);
+  char *include = malloc((size_t)length + 1);
   assert_non_null(include);
   (void)snprintf(include, (size_t)length + 1, "$INCLUDE %s", non_include);
 
-  code = zone_parse_string(&parser, &options, &buffers, include, (size_t)length, &test);
+  code = parse(&options, include, &test);
+  free(include);
+  free(non_include);
   assert_int_equal(code, ZONE_NOT_A_FILE);
   assert_true(test.log_count == 1);
   assert_true(test.accept_count == 0);
+}
+
+static int32_t in_too_deep_accept(
+  zone_parser_t *parser,
+  const zone_name_t *owner,
+  uint16_t type,
+  uint16_t class,
+  uint32_t ttl,
+  uint16_t rdlength,
+  const uint8_t *rdata,
+  void *user_data)
+{
+  (void)parser;
+  (void)owner;
+  (void)type;
+  (void)class;
+  (void)ttl;
+  (void)rdlength;
+  (void)rdata;
+  (*(size_t *)user_data)++;
+  return 0;
+}
+
+static void in_too_deep_log(
+  zone_parser_t *parser,
+  uint32_t priority,
+  const char *message,
+  void *user_data)
+{
+  (void)parser;
+  (void)priority;
+
+  if (strstr(message, "nested too deeply"))
+    *(size_t *)user_data |= 1u << 7;
+}
+
+/*!cmocka */
+void in_too_deep(void **state)
+{
+  (void)state;
+
+  int32_t code;
+  size_t records;
+  zone_options_t options = { 0 };
+
+  options.accept.callback = &in_too_deep_accept;
+  options.log.callback = &in_too_deep_log;
+  options.origin.octets = origin;
+  options.origin.length = sizeof(origin);
+  options.default_ttl = 3600;
+  options.default_class = 1;
+  options.include_limit = 1;
+
+#define INCLUDE "$INCLUDE %s\n"
+
+  char *deeper = generate_include("foo. TXT \"bar\"");
+  assert_non_null(deeper);
+  char buffer[16];
+  int length = snprintf(buffer, sizeof(buffer), INCLUDE, deeper);
+  assert_true(length > 0);
+  char *inception = malloc((size_t)length + 1);
+  assert_non_null(inception);
+  (void)snprintf(inception, (size_t)length + 1, INCLUDE, deeper);
+  char *deep = generate_include(inception);
+  assert_non_null(deep);
+  free(inception);
+  length = snprintf(buffer, sizeof(buffer), INCLUDE, deep);
+  assert_true(length > 0);
+  inception = malloc((size_t)length + 1);
+  (void)snprintf(inception, (size_t)length + 1, INCLUDE, deep);
+
+#undef INCLUDE
+
+  records = 0;
+  code = parse(&options, inception, &records);
+  assert_int_equal(code, ZONE_SEMANTIC_ERROR);
+  assert_int_equal(records, (1u << 7));
+
+  options.include_limit = 0;
+  records = 0;
+  code = parse(&options, inception, &records);
+  assert_int_equal(code, ZONE_SUCCESS);
+  assert_int_equal(records, 1u);
+
+  free(inception);
+  free(deep);
+  free(deeper);
+}
+
+/*!cmocka */
+void been_there_done_that(void **state)
+{
+  (void)state;
+
+  zone_options_t options = { 0 };
+  options.accept.callback = &in_too_deep_accept;
+  options.log.callback = &in_too_deep_log;
+  options.origin.octets = origin;
+  options.origin.length = sizeof(origin);
+  options.default_ttl = 3600;
+  options.default_class = 1;
+  options.include_limit = 1;
+
+  int32_t code;
+  size_t count = 0;
+
+  char *path = generate_include(" ");
+  assert_non_null(path);
+  FILE* handle = fopen(path, "wb");
+  assert_non_null(handle);
+  char dummy[16];
+  int length = snprintf(dummy, sizeof(dummy), "$INCLUDE \"%s\"\n", path);
+  assert_true(length > 0 && length < INT_MAX - ZONE_PADDING_SIZE);
+  char *include = malloc((size_t)length + 1 + ZONE_PADDING_SIZE);
+  assert_non_null(include);
+  (void)snprintf(include, (size_t)length + 1, "$INCLUDE \"%s\"\n", path);
+  int result = fputs(include, handle);
+  assert_true(result >= 0);
+  (void)fclose(handle);
+  free(path);
+  code = parse(&options, include, &count);
   free(include);
-  free(non_include);
+  assert_int_equal(code, ZONE_SEMANTIC_ERROR);
 }
 
 //

tests/syntax.c

@@ -634,33 +634,6 @@ void no_famous_last_words(void **state)
   assert_true(count == 0);
 }
 
-/*!cmocka */
-void been_there_done_that(void **state)
-{
-  (void)state;
-
-  int32_t code;
-  size_t count = 0;
-
-  char *path = generate_include(" ");
-  assert_non_null(path);
-  FILE* handle = fopen(path, "wb");
-  assert_non_null(handle);
-  char dummy[16];
-  int length = snprintf(dummy, sizeof(dummy), "$INCLUDE \"%s\"\n", path);
-  assert_true(length > 0 && length < INT_MAX - ZONE_PADDING_SIZE);
-  char *include = malloc((size_t)length + 1 + ZONE_PADDING_SIZE);
-  assert_non_null(include);
-  (void)snprintf(include, (size_t)length + 1, "$INCLUDE \"%s\"\n", path);
-  int result = fputs(include, handle);
-  assert_true(result >= 0);
-  (void)fclose(handle);
-  free(path);
-  code = parse(include, &count);
-  free(include);
-  assert_int_equal(code, ZONE_SYNTAX_ERROR);
-}
-
 /*!cmocka */
 void bad_a_rrs(void **state)
 {