path: root/src/knot/zone/backup.c

/*  Copyright (C) 2024 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 <assert.h>
#include <errno.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <unistd.h>

#include "knot/zone/backup.h"

#include "contrib/files.h"
#include "contrib/getline.h"
#include "contrib/macros.h"
#include "contrib/string.h"
#include "knot/catalog/catalog_db.h"
#include "knot/common/log.h"
#include "knot/ctl/commands.h"
#include "knot/dnssec/kasp/kasp_zone.h"
#include "knot/dnssec/kasp/keystore.h"
#include "knot/journal/journal_metadata.h"
#include "knot/server/server.h"
#include "knot/zone/backup_dir.h"
#include "knot/zone/zonefile.h"
#include "libdnssec/error.h"

// Current backup format version for output. Don't decrease it.
#define BACKUP_VERSION BACKUP_FORMAT_2  // Starting with release 3.1.0.

const backup_filter_list_t backup_filters[] = {
	{ "zonefile", BACKUP_PARAM_ZONEFILE, CTL_FILTER_BACKUP_ZONEFILE, CTL_FILTER_BACKUP_NOZONEFILE },
	{ "journal",  BACKUP_PARAM_JOURNAL,  CTL_FILTER_BACKUP_JOURNAL,  CTL_FILTER_BACKUP_NOJOURNAL },
	{ "timers",   BACKUP_PARAM_TIMERS,   CTL_FILTER_BACKUP_TIMERS,   CTL_FILTER_BACKUP_NOTIMERS },
	{ "kaspdb",   BACKUP_PARAM_KASPDB,   CTL_FILTER_BACKUP_KASPDB,   CTL_FILTER_BACKUP_NOKASPDB },
	{ "keysonly", BACKUP_PARAM_KEYSONLY, CTL_FILTER_BACKUP_KEYSONLY, CTL_FILTER_BACKUP_NOKEYSONLY },
	{ "catalog",  BACKUP_PARAM_CATALOG,  CTL_FILTER_BACKUP_CATALOG,  CTL_FILTER_BACKUP_NOCATALOG },
	{ "quic",     BACKUP_PARAM_QUIC,     CTL_FILTER_BACKUP_QUIC,     CTL_FILTER_BACKUP_NOQUIC },
	{ NULL },
};

static void _backup_swap(zone_backup_ctx_t *ctx, void **local, void **remote)
{
	if (ctx->restore_mode) {
		void *temp = *local;
		*local = *remote;
		*remote = temp;
	}
}

#define BACKUP_SWAP(ctx, from, to) _backup_swap((ctx), (void **)&(from), (void **)&(to))

#define MISSING_FROM_BACKUP(request, stored) (((request) ^ (stored)) & (request))

int zone_backup_init(bool restore_mode, knot_backup_params_t filters, bool forced,
                     const char *backup_dir,
                     size_t kasp_db_size, size_t timer_db_size, size_t journal_db_size,
                     size_t catalog_db_size, zone_backup_ctx_t **out_ctx)
{
	if (backup_dir == NULL || out_ctx == NULL) {
		return KNOT_EINVAL;
	}

	size_t backup_dir_len = strlen(backup_dir) + 1;

	zone_backup_ctx_t *ctx = malloc(sizeof(*ctx) + backup_dir_len);
	if (ctx == NULL) {
		return KNOT_ENOMEM;
	}
	ctx->restore_mode = restore_mode;
	ctx->backup_params = filters;
	ctx->in_backup = 0; // Just to be sure.
	ctx->forced = forced;
	ctx->backup_format = BACKUP_VERSION;
	ctx->backup_global = false;
	ctx->readers = 1;
	ctx->failed = false;
	ctx->init_time = time(NULL);
	ctx->zone_count = 0;
	ctx->backup_dir = (char *)(ctx + 1);
	memcpy(ctx->backup_dir, backup_dir, backup_dir_len);

	// Backup directory, lock file, label file.
	// In restore, set the backup format and available data.
	int ret = backupdir_init(ctx);
	if (ret != KNOT_EOK) {
		free(ctx);
		return ret;
	}

	// For restore, check that there are all required data components in the backup.
	if (restore_mode) {
		// '+kaspdb' in backup provides data also for '+keysonly' restore.
		knot_backup_params_t available = ctx->in_backup |
			((bool)(ctx->in_backup & BACKUP_PARAM_KASPDB) * BACKUP_PARAM_KEYSONLY);

		filters = MISSING_FROM_BACKUP(filters, available);
		if (filters) {
			// ctx needed for logging, will be freed later.
			*out_ctx = ctx;
			ctx->backup_params = filters;
			return KNOT_EBACKUPDATA;
		}
	}

	pthread_mutex_init(&ctx->readers_mutex, NULL);

	char db_dir[backup_dir_len + 16];
	(void)snprintf(db_dir, sizeof(db_dir), "%s/keys", backup_dir);
	knot_lmdb_init(&ctx->bck_kasp_db, db_dir, kasp_db_size, 0, "keys_db");

	(void)snprintf(db_dir, sizeof(db_dir), "%s/timers", backup_dir);
	knot_lmdb_init(&ctx->bck_timer_db, db_dir, timer_db_size, 0, NULL);

	(void)snprintf(db_dir, sizeof(db_dir), "%s/journal", backup_dir);
	knot_lmdb_init(&ctx->bck_journal, db_dir, journal_db_size, 0, NULL);

	(void)snprintf(db_dir, sizeof(db_dir), "%s/catalog", backup_dir);
	knot_lmdb_init(&ctx->bck_catalog, db_dir, catalog_db_size, 0, NULL);

	*out_ctx = ctx;
	return KNOT_EOK;
}

int zone_backup_deinit(zone_backup_ctx_t *ctx)
{
	if (ctx == NULL) {
		return KNOT_ENOENT;
	}

	int ret = KNOT_EOK;

	pthread_mutex_lock(&ctx->readers_mutex);
	assert(ctx->readers > 0);
	size_t left = --ctx->readers;
	pthread_mutex_unlock(&ctx->readers_mutex);

	if (left == 0) {
		knot_lmdb_deinit(&ctx->bck_catalog);
		knot_lmdb_deinit(&ctx->bck_journal);
		knot_lmdb_deinit(&ctx->bck_timer_db);
		knot_lmdb_deinit(&ctx->bck_kasp_db);
		pthread_mutex_destroy(&ctx->readers_mutex);

		ret = backupdir_deinit(ctx);
		zone_backups_rem(ctx);
		free(ctx);
	}

	return ret;
}

void zone_backups_init(zone_backup_ctxs_t *ctxs)
{
	init_list(&ctxs->ctxs);
	pthread_mutex_init(&ctxs->mutex, NULL);
}

void zone_backups_deinit(zone_backup_ctxs_t *ctxs)
{
	zone_backup_ctx_t *ctx, *nxt;
	WALK_LIST_DELSAFE(ctx, nxt, ctxs->ctxs) {
		log_warning("backup to '%s' in progress, terminating, will be incomplete",
		            ctx->backup_dir);
		ctx->readers = 1; // ensure full deinit
		ctx->failed = true;
		(void)zone_backup_deinit(ctx);
	}
	pthread_mutex_destroy(&ctxs->mutex);
}

void zone_backups_add(zone_backup_ctxs_t *ctxs, zone_backup_ctx_t *ctx)
{
	pthread_mutex_lock(&ctxs->mutex);
	add_tail(&ctxs->ctxs, (node_t *)ctx);
	pthread_mutex_unlock(&ctxs->mutex);
}

static zone_backup_ctxs_t *get_ctxs_trick(zone_backup_ctx_t *ctx)
{
	node_t *n = (node_t *)ctx;
	while (n->prev != NULL) {
		n = n->prev;
	}
	return (zone_backup_ctxs_t *)n;
}

void zone_backups_rem(zone_backup_ctx_t *ctx)
{
	zone_backup_ctxs_t *ctxs = get_ctxs_trick(ctx);
	pthread_mutex_lock(&ctxs->mutex);
	rem_node((node_t *)ctx);
	pthread_mutex_unlock(&ctxs->mutex);
}

static char *dir_file(const char *dir_name, const char *file_name)
{
	const char *basename = strrchr(file_name, '/');
	if (basename == NULL) {
		basename = file_name;
	} else {
		basename++;
	}

	return sprintf_alloc("%s/%s", dir_name, basename);
}

static int backup_key(key_params_t *parm, dnssec_keystore_t *from, dnssec_keystore_t *to)
{
	dnssec_key_t *key = NULL;
	int ret = dnssec_key_new(&key);
	if (ret != DNSSEC_EOK) {
		return knot_error_from_libdnssec(ret);
	}
	dnssec_key_set_algorithm(key, parm->algorithm);

	ret = dnssec_keystore_get_private(from, parm->id, key);
	if (ret == DNSSEC_EOK) {
		ret = dnssec_keystore_set_private(to, key);
	}

	dnssec_key_free(key);
	return knot_error_from_libdnssec(ret);
}

static conf_val_t get_zone_policy(conf_t *conf, const knot_dname_t *zone)
{
	conf_val_t policy;

	// Global modules don't use DNSSEC policy so check zone modules only.
	conf_val_t modules = conf_zone_get(conf, C_MODULE, zone);
	while (modules.code == KNOT_EOK) {
		conf_mod_id_t *mod_id = conf_mod_id(&modules);
		if (mod_id != NULL && strcmp(mod_id->name + 1, "mod-onlinesign") == 0) {
			policy = conf_mod_get(conf, C_POLICY, mod_id);
			conf_id_fix_default(&policy);
			conf_free_mod_id(mod_id);
			return policy;
		}
		conf_free_mod_id(mod_id);
		conf_val_next(&modules);
	}

	// Use default policy if none is configured.
	policy = conf_zone_get(conf, C_DNSSEC_POLICY, zone);
	conf_id_fix_default(&policy);
	return policy;
}

static int backup_file(char *dst, char *src)
{
	struct stat st;
	int ret;

	if (stat(src, &st) == 0) {
		ret = make_path(dst, S_IRWXU | S_IRWXG);
		if (ret == KNOT_EOK) {
			ret = copy_file(dst, src);
		}
	} else {
		ret = knot_map_errno();
		// If there's no src file, remove any old dst file.
		if (ret == KNOT_ENOENT) {
			unlink(dst);
		}
	}

	return ret;
}

#define LOG_FAIL(action) log_zone_warning(zone->name, "%s, %s failed (%s)", ctx->restore_mode ? \
                         "restore" : "backup", (action), knot_strerror(ret))
#define LOG_MARK_FAIL(action) LOG_FAIL(action); \
                              ctx->failed = true

#define ABORT_IF_ENOMEM(param)	if (param == NULL) { \
					ret = KNOT_ENOMEM; \
					goto done; \
				}

static int backup_zonefile(conf_t *conf, zone_t *zone, zone_backup_ctx_t *ctx)
{
	int ret = KNOT_EOK;

	char *local_zf = conf_zonefile(conf, zone->name);
	char *backup_zfiles_dir = NULL, *backup_zf = NULL, *zone_name_str;

	switch (ctx->backup_format) {
	case BACKUP_FORMAT_1:
		backup_zf = dir_file(ctx->backup_dir, local_zf);
		ABORT_IF_ENOMEM(backup_zf);
		break;
	case BACKUP_FORMAT_2:
	default:
		backup_zfiles_dir = dir_file(ctx->backup_dir, "zonefiles");
		ABORT_IF_ENOMEM(backup_zfiles_dir);
		zone_name_str = knot_dname_to_str_alloc(zone->name);
		ABORT_IF_ENOMEM(zone_name_str);
		backup_zf = sprintf_alloc("%s/%szone", backup_zfiles_dir, zone_name_str);
		free(zone_name_str);
		ABORT_IF_ENOMEM(backup_zf);
	}

	if (ctx->restore_mode) {
		ret = backup_file(local_zf, backup_zf);
                ret = ret == KNOT_ENOENT ? KNOT_EFILE : ret;

	} else {
		conf_val_t val = conf_zone_get(conf, C_ZONEFILE_SYNC, zone->name);
		bool can_flush = (conf_int(&val) > -1);

		// The value of ctx->backup_format is always at least BACKUP_FORMAT_2 for
		// the backup mode, therefore backup_zfiles_dir is always filled at this point.
		assert(backup_zfiles_dir != NULL);

		ret = make_dir(backup_zfiles_dir, S_IRWXU | S_IRWXG, true);
		if (ret == KNOT_EOK) {
			if (can_flush) {
				if (zone->contents != NULL) {
					ret = zonefile_write(backup_zf, zone->contents);
				} else {
					log_zone_notice(zone->name,
					                "empty zone, skipping a zone file backup");
				}
			} else {
				ret = copy_file(backup_zf, local_zf);
			}
		}
	}

done:
	free(backup_zf);
	free(backup_zfiles_dir);
	free(local_zf);
	if (ret == KNOT_EFILE) {
		log_zone_notice(zone->name, "no zone file, skipping a zone file %s",
		                ctx->restore_mode ? "restore" : "backup");
		ret = KNOT_EOK;
	}

	return ret;
}

static int backup_keystore(conf_t *conf, zone_t *zone, zone_backup_ctx_t *ctx)
{
	dnssec_keystore_t *from = NULL, *to = NULL;

	conf_val_t policy_id = get_zone_policy(conf, zone->name);

	unsigned backend_type = 0;
	int ret = zone_init_keystore(conf, &policy_id, NULL, &from, &backend_type, NULL);
	if (ret != KNOT_EOK) {
		LOG_FAIL("keystore init");
		return ret;
	}
	if (backend_type == KEYSTORE_BACKEND_PKCS11) {
		log_zone_notice(zone->name, "private keys from PKCS #11 aren't subject of backup/restore");
		(void)dnssec_keystore_deinit(from);
		return KNOT_EOK;
	}

	char kasp_dir[strlen(ctx->backup_dir) + 6];
	(void)snprintf(kasp_dir, sizeof(kasp_dir), "%s/keys", ctx->backup_dir);
	ret = keystore_load("keys", KEYSTORE_BACKEND_PEM, kasp_dir, &to);
	if (ret != KNOT_EOK) {
		LOG_FAIL("keystore load");
		goto done;
	}

	BACKUP_SWAP(ctx, from, to);

	list_t key_params;
	init_list(&key_params);
	ret = kasp_db_list_keys(zone_kaspdb(zone), zone->name, &key_params);
	ret = (ret == KNOT_ENOENT ? KNOT_EOK : ret);
	if (ret != KNOT_EOK) {
		LOG_FAIL("keystore list");
		goto done;
	}
	ptrnode_t *n;
	WALK_LIST(n, key_params) {
		key_params_t *parm = n->d;
		if (ret == KNOT_EOK && !parm->is_pub_only) {
			ret = backup_key(parm, from, to);
		}
		free_key_params(parm);
	}
	if (ret != KNOT_EOK) {
		LOG_FAIL("key copy");
	}
	ptrlist_deep_free(&key_params, NULL);

done:
	(void)dnssec_keystore_deinit(to);
	(void)dnssec_keystore_deinit(from);
	return ret;
}

static int backup_kaspdb(zone_backup_ctx_t *ctx, conf_t *conf, zone_t *zone,
                         int (*kaspdb_backup_cb)(const knot_dname_t *zone,
                                                 knot_lmdb_db_t *db, knot_lmdb_db_t *backup_db))
{
	knot_lmdb_db_t *kasp_from = zone_kaspdb(zone), *kasp_to = &ctx->bck_kasp_db;
	BACKUP_SWAP(ctx, kasp_from, kasp_to);

	if (knot_lmdb_exists(kasp_from) != KNOT_ENODB) {
		int ret = kaspdb_backup_cb(zone->name, kasp_from, kasp_to);
		if (ret != KNOT_EOK) {
			LOG_MARK_FAIL("KASP database");
			return ret;
		}

		ret = backup_keystore(conf, zone, ctx);
		if (ret != KNOT_EOK) {
			// Errors already logged in detail.
			ctx->failed = true;
			return ret;
		}
	}

	return KNOT_EOK;
}

int zone_backup(conf_t *conf, zone_t *zone)
{
	zone_backup_ctx_t *ctx = zone->backup_ctx;
	if (ctx == NULL) {
		return KNOT_EINVAL;
	}

	int ret = KNOT_EOK;

	if (ctx->backup_params & BACKUP_PARAM_ZONEFILE) {
		ret = backup_zonefile(conf, zone, ctx);
		if (ret != KNOT_EOK) {
			LOG_MARK_FAIL("zone file");
			return ret;
		}
	}

	if (ctx->backup_params & BACKUP_PARAM_KASPDB) {
		ret = backup_kaspdb(ctx, conf, zone, kasp_db_backup);
		if (ret != KNOT_EOK) {
			// Errors already logged in detail.
			return ret;
		}
	}

	if (ctx->backup_params & BACKUP_PARAM_JOURNAL) {
		knot_lmdb_db_t *j_from = zone_journaldb(zone), *j_to = &ctx->bck_journal;
		BACKUP_SWAP(ctx, j_from, j_to);

		ret = journal_copy_with_md(j_from, j_to, zone->name);
	} else if (ctx->restore_mode && (ctx->backup_params & BACKUP_PARAM_ZONEFILE)) {
		ret = journal_scrape_with_md(zone_journal(zone), true);
	}
	if (ret != KNOT_EOK) {
		LOG_MARK_FAIL("journal");
		return ret;
	}

	if (ctx->backup_params & BACKUP_PARAM_TIMERS) {
		ret = knot_lmdb_open(&ctx->bck_timer_db);
		if (ret != KNOT_EOK) {
			LOG_MARK_FAIL("timers open");
			return ret;
		}
		if (ctx->restore_mode) {
			ret = zone_timers_read(&ctx->bck_timer_db, zone->name, &zone->timers);
			zone_timers_sanitize(conf, zone);
			zone->zonefile.bootstrap_cnt = 0;
		} else {
			ret = zone_timers_write(&ctx->bck_timer_db, zone->name, &zone->timers);
		}
		if (ret != KNOT_EOK) {
			LOG_MARK_FAIL("timers");
			return ret;
		}
	}

	return ret;
}

int global_backup(zone_backup_ctx_t *ctx, catalog_t *catalog,
                  const knot_dname_t *zone_only)
{
	if (!(ctx->backup_params & BACKUP_PARAM_CATALOG)) {
		return KNOT_EOK;
	}

	knot_lmdb_db_t *cat_from = &catalog->db, *cat_to = &ctx->bck_catalog;
	BACKUP_SWAP(ctx, cat_from, cat_to);
	int ret = catalog_copy(cat_from, cat_to, zone_only, !ctx->restore_mode);
	if (ret != KNOT_EOK) {
		ctx->failed = true;
	}
	return ret;
}

int zone_backup_keysonly(zone_backup_ctx_t *ctx, conf_t *conf, zone_t *zone)
{
	return backup_kaspdb(ctx, conf, zone, kasp_db_backup_keys);
}

static int backup_quic_file(zone_backup_ctx_t *ctx, char *file, char *subdir,
                            const char *desc, bool required, bool *success)
{
	char *backup_quic_dir = NULL, *backup_orig = NULL, *backup;
	int ret;

	backup_quic_dir = dir_file(ctx->backup_dir, subdir);
	ABORT_IF_ENOMEM(backup_quic_dir);
	backup_orig = backup = dir_file(backup_quic_dir, file);
	ABORT_IF_ENOMEM(backup);

	BACKUP_SWAP(ctx, backup, file);
	ret = backup_file(backup, file);
	if (ret == KNOT_EOK) {
		*success = true;
	} else if (!required && ret == KNOT_ENOENT) {
		ret = KNOT_EOK;
	} else {
		log_ctl_error("control, QUIC %s file %s failed (%s)", desc,
		              ctx->restore_mode ? "restore" : "backup",
		              knot_strerror(ret));
	}
done:
	free(backup_orig);
	free(backup_quic_dir);
	return ret;
}

#define DONE_ON_ERROR	if (ret != KNOT_EOK) { \
				goto done; \
			}

int backup_quic(zone_backup_ctx_t *ctx, bool quic_on)
{
	if (!(ctx->backup_params & BACKUP_PARAM_QUIC)) {
		return KNOT_EOK;
	}

	const char *str_auto = "auto-generated key";
	const char *str_key = "configured key";
	const char *str_cert = "certificate";

	bool log_auto = false;
	bool log_key = false;
	bool log_cert = false;
	int ret;

	char *cert_file = conf_tls(conf(), C_CERT_FILE);
	char *key_file = conf_tls(conf(), C_KEY_FILE);
	bool user_keys = (key_file != NULL);

	char *kasp_dir = conf_db(conf(), C_KASP_DB);
	char *auto_file = abs_path(DFLT_QUIC_KEY_FILE, kasp_dir);
	free(kasp_dir);
	ABORT_IF_ENOMEM(auto_file);

	// Backup/restore of auto-generated key is required if it's in active use,
	// otherwise use it if the file is found (no fail if missing).
	ret = backup_quic_file(ctx, auto_file, "keys", str_auto,
	                       quic_on && !user_keys, &log_auto);
	DONE_ON_ERROR;

	// If QUIC isn't configured, backup of configured key and cert is possible,
	// but it isn't required (no fail if missing).
	if (user_keys && !ctx->restore_mode) {
		char *quic_subdir = "quic";
		ret = backup_quic_file(ctx, key_file, quic_subdir, str_key,
		                       quic_on, &log_key);
		DONE_ON_ERROR;

		ret = backup_quic_file(ctx, cert_file, quic_subdir, str_cert,
		                       quic_on, &log_cert);
		DONE_ON_ERROR;
	}

	if (log_auto || log_key) {
		log_ctl_info("control, QUIC %s%s%s%s%s %s '%s'",
		             log_auto ? str_auto : "",
		             (log_auto && log_key) ? ", " : "",
		             log_key ? str_key : "",
		             log_cert ? " and " : "",
		             log_cert ? str_cert : "",
		             ctx->restore_mode ? "restored from" : "backed up to",
		             ctx->backup_dir);
	}

done:
	free(auto_file);
	free(key_file);
	free(cert_file);

	if (ret != KNOT_EOK) {
		ctx->failed = true;
	}

	return ret;
}