Adding upstream version 3.3.4.upstream/3.3.4

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

3 files changed, 309 insertions, 0 deletions

diff --git a/src/utils/kzonecheck/main.c b/src/utils/kzonecheck/main.c
new file mode 100644
index 0000000..3a2b620
--- /dev/null
+++ b/src/utils/kzonecheck/main.c
@@ -0,0 +1,185 @@
+/*  Copyright (C) 2023 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
+
+    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 <https://www.gnu.org/licenses/>.
+ */
+
+#include <getopt.h>
+#include <libgen.h>
+#include <stdio.h>
+
+#include "contrib/time.h"
+#include "contrib/tolower.h"
+#include "libknot/libknot.h"
+#include "knot/common/log.h"
+#include "knot/zone/semantic-check.h"
+#include "utils/common/msg.h"
+#include "utils/common/params.h"
+#include "utils/kzonecheck/zone_check.h"
+
+#define PROGRAM_NAME "kzonecheck"
+
+#define STDIN_SUBST "-"
+#define STDIN_REPL "/dev/stdin"
+
+static void print_help(void)
+{
+	printf("Usage: %s [options] <filename>\n"
+	       "\n"
+	       "Options:\n"
+	       " -o, --origin <zone_origin>  Zone name.\n"
+	       "                              (default filename without .zone)\n"
+	       " -d, --dnssec <on|off>       Also check DNSSEC-related records.\n"
+	       " -t, --time <timestamp>      Current time specification.\n"
+	       "                              (default current UNIX time)\n"
+	       " -p, --print                 Print the zone on stdout.\n"
+	       " -v, --verbose               Enable debug output.\n"
+	       " -h, --help                  Print the program help.\n"
+	       " -V, --version               Print the program version.\n",
+	       PROGRAM_NAME);
+}
+
+static bool str2bool(const char *s)
+{
+	switch (knot_tolower(s[0])) {
+	case '1':
+	case 'y':
+	case 't':
+		return true;
+	case 'o':
+		return knot_tolower(s[1]) == 'n';
+	default:
+		return false;
+	}
+}
+
+int main(int argc, char *argv[])
+{
+	const char *origin = NULL;
+	bool verbose = false, print = false;
+	semcheck_optional_t optional = SEMCHECK_DNSSEC_AUTO; // default value for --dnssec
+	knot_time_t check_time = (knot_time_t)time(NULL);
+
+	/* Long options. */
+	struct option opts[] = {
+		{ "origin",  required_argument, NULL, 'o' },
+		{ "time",    required_argument, NULL, 't' },
+		{ "dnssec",  required_argument, NULL, 'd' },
+		{ "print",   no_argument,       NULL, 'p' },
+		{ "verbose", no_argument,       NULL, 'v' },
+		{ "help",    no_argument,       NULL, 'h' },
+		{ "version", no_argument,       NULL, 'V' },
+		{ NULL }
+	};
+
+	/* Set the time zone. */
+	tzset();
+
+	/* Parse command line arguments */
+	int opt = 0;
+	while ((opt = getopt_long(argc, argv, "o:t:d:pvVh", opts, NULL)) != -1) {
+		switch (opt) {
+		case 'o':
+			origin = optarg;
+			break;
+		case 'p':
+			print = true;
+			break;
+		case 'v':
+			verbose = true;
+			break;
+		case 'h':
+			print_help();
+			return EXIT_SUCCESS;
+		case 'V':
+			print_version(PROGRAM_NAME);
+			return EXIT_SUCCESS;
+		case 'd':
+			optional = str2bool(optarg) ? SEMCHECK_DNSSEC_ON : SEMCHECK_DNSSEC_OFF;
+			break;
+		case 't':
+			if (knot_time_parse("YMDhms|#|+-#U|+-#",
+			                    optarg, &check_time) != KNOT_EOK) {
+				ERR2("unknown time format");
+				return EXIT_FAILURE;
+			}
+			break;
+		default:
+			print_help();
+			return EXIT_FAILURE;
+		}
+	}
+
+	/* Check if there's at least one remaining non-option. */
+	if (optind >= argc) {
+		ERR2("expected zone file name");
+		print_help();
+		return EXIT_FAILURE;
+	}
+
+	char *filename = argv[optind];
+	if (strncmp(filename, STDIN_SUBST, sizeof(STDIN_SUBST)) == 0) {
+		filename = STDIN_REPL;
+	}
+
+	char *zonename;
+	if (origin == NULL) {
+		/* Get zone name from file name. */
+		const char *ext = ".zone";
+		zonename = basename(filename);
+		if (strcmp(zonename + strlen(zonename) - strlen(ext), ext) == 0) {
+			zonename = strndup(zonename, strlen(zonename) - strlen(ext));
+		} else {
+			zonename = strdup(zonename);
+		}
+	} else {
+		zonename = strdup(origin);
+	}
+
+	log_init();
+	log_levels_set(LOG_TARGET_STDOUT, LOG_SOURCE_ANY, 0);
+	log_levels_set(LOG_TARGET_STDERR, LOG_SOURCE_ANY, 0);
+	log_levels_set(LOG_TARGET_SYSLOG, LOG_SOURCE_ANY, 0);
+	log_flag_set(LOG_FLAG_NOTIMESTAMP | LOG_FLAG_NOINFO);
+	if (verbose) {
+		log_levels_add(LOG_TARGET_STDOUT, LOG_SOURCE_ANY, LOG_UPTO(LOG_DEBUG));
+	}
+
+	knot_dname_t *dname = knot_dname_from_str_alloc(zonename);
+	knot_dname_to_lower(dname);
+	free(zonename);
+	int ret = zone_check(filename, dname, optional, (time_t)check_time, print);
+	knot_dname_free(dname, NULL);
+
+	log_close();
+
+	switch (ret) {
+	case KNOT_EOK:
+		if (verbose) {
+			INFO2("No semantic error found");
+		}
+		return EXIT_SUCCESS;
+	case KNOT_EZONEINVAL:
+		ERR2("serious semantic error detected");
+		// FALLTHROUGH
+	case KNOT_ESEMCHECK:
+		return EXIT_FAILURE;
+	case KNOT_EACCES:
+	case KNOT_EFILE:
+		ERR2("failed to load the zone file");
+		return EXIT_FAILURE;
+	default:
+		ERR2("failed to run semantic checks (%s)", knot_strerror(ret));
+		return EXIT_FAILURE;
+	}
+}
diff --git a/src/utils/kzonecheck/zone_check.c b/src/utils/kzonecheck/zone_check.c
new file mode 100644
index 0000000..542e152
--- /dev/null
+++ b/src/utils/kzonecheck/zone_check.c
@@ -0,0 +1,101 @@
+/*  Copyright (C) 2023 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
+
+    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 <https://www.gnu.org/licenses/>.
+ */
+
+#include <stdio.h>
+#include <assert.h>
+
+#include "utils/kzonecheck/zone_check.h"
+
+#include "knot/zone/contents.h"
+#include "knot/zone/zonefile.h"
+#include "knot/zone/zone-dump.h"
+#include "utils/common/msg.h"
+
+typedef struct {
+	sem_handler_t handler;
+	unsigned errors[SEM_ERR_UNKNOWN + 1]; /*!< Counting errors by type. */
+	unsigned error_count;                 /*!< Total error count. */
+} err_handler_stats_t;
+
+static void err_callback(sem_handler_t *handler, const zone_contents_t *zone,
+                         const knot_dname_t *node, sem_error_t error, const char *data)
+{
+	assert(handler != NULL);
+	assert(zone != NULL);
+	err_handler_stats_t *stats = (err_handler_stats_t *)handler;
+
+	knot_dname_txt_storage_t buff;
+	char *owner = knot_dname_to_str(buff, (node != NULL ? node : zone->apex->owner),
+	                                sizeof(buff));
+	if (owner == NULL) {
+		owner = "";
+	}
+
+	fprintf(stderr, "[%s] %s%s%s\n", owner, sem_error_msg(error),
+	       (data != NULL ? " "  : ""),
+	       (data != NULL ? data : ""));
+
+	stats->errors[error]++;
+	stats->error_count++;
+}
+
+static void print_statistics(err_handler_stats_t *stats)
+{
+	fprintf(stderr, "\nError summary:\n");
+	for (sem_error_t i = 0; i <= SEM_ERR_UNKNOWN; ++i) {
+		if (stats->errors[i] > 0) {
+			fprintf(stderr, "%4u\t%s\n", stats->errors[i], sem_error_msg(i));
+		}
+	}
+}
+
+int zone_check(const char *zone_file, const knot_dname_t *zone_name,
+               semcheck_optional_t optional, time_t time, bool print)
+{
+	err_handler_stats_t stats = {
+		.handler = { .cb = err_callback },
+	};
+
+	zloader_t zl;
+	int ret = zonefile_open(&zl, zone_file, zone_name, optional, time);
+	if (ret != KNOT_EOK) {
+		return ret;
+	}
+	zl.err_handler = (sem_handler_t *)&stats;
+	zl.creator->master = true;
+
+	zone_contents_t *contents = zonefile_load(&zl);
+	zonefile_close(&zl);
+	if (contents == NULL && !stats.handler.error) {
+		return KNOT_ERROR;
+	}
+
+	if (stats.error_count > 0) {
+		print_statistics(&stats);
+		ret = stats.handler.error ? KNOT_EZONEINVAL : KNOT_ESEMCHECK;
+		if (print) {
+			fprintf(stderr, "\n");
+		}
+	}
+
+	if (print) {
+		printf(";; Zone dump (Knot DNS %s)\n", PACKAGE_VERSION);
+		zone_dump_text(contents, stdout, false, NULL);
+	}
+	zone_contents_deep_free(contents);
+
+	return ret;
+}
diff --git a/src/utils/kzonecheck/zone_check.h b/src/utils/kzonecheck/zone_check.h
new file mode 100644
index 0000000..7039f16
--- /dev/null
+++ b/src/utils/kzonecheck/zone_check.h
@@ -0,0 +1,23 @@
+/*  Copyright (C) 2023 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
+
+    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 <https://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include "knot/zone/semantic-check.h"
+#include "libknot/libknot.h"
+
+int zone_check(const char *zone_file, const knot_dname_t *zone_name,
+               semcheck_optional_t optional, time_t time, bool print);