/* $NetBSD: log.c,v 1.3.4.1 2024/02/29 12:28:18 martin Exp $ */ /* * Copyright (C) Internet Systems Consortium, Inc. ("ISC") * * SPDX-License-Identifier: MPL-2.0 * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, you can obtain one at https://mozilla.org/MPL/2.0/. * * See the COPYRIGHT file distributed with this work for additional * information regarding copyright ownership. */ /*! \file */ #include #include #include #include #include #include #include #ifndef ISC_FACILITY #define ISC_FACILITY LOG_DAEMON #endif /* ifndef ISC_FACILITY */ /*% * When adding a new category, be sure to add the appropriate * \#define to and to update the list in * bin/check/check-tool.c. */ static isc_logcategory_t categories[] = { { "", 0 }, { "unmatched", 0 }, { NULL, 0 } }; /*% * When adding a new module, be sure to add the appropriate * \#define to . */ static isc_logmodule_t modules[] = { { "main", 0 }, { "server", 0 }, { "control", 0 }, { NULL, 0 } }; isc_result_t named_log_init(bool safe) { isc_result_t result; isc_logconfig_t *lcfg = NULL; named_g_categories = categories; named_g_modules = modules; /* * Setup a logging context. */ isc_log_create(named_g_mctx, &named_g_lctx, &lcfg); /* * named-checktool.c:setup_logging() needs to be kept in sync. */ isc_log_registercategories(named_g_lctx, named_g_categories); isc_log_registermodules(named_g_lctx, named_g_modules); isc_log_setcontext(named_g_lctx); dns_log_init(named_g_lctx); dns_log_setcontext(named_g_lctx); cfg_log_init(named_g_lctx); ns_log_init(named_g_lctx); ns_log_setcontext(named_g_lctx); if (safe) { named_log_setsafechannels(lcfg); } else { named_log_setdefaultchannels(lcfg); } result = named_log_setdefaultcategory(lcfg); if (result != ISC_R_SUCCESS) { goto cleanup; } named_log_setdefaultsslkeylogfile(lcfg); return (ISC_R_SUCCESS); cleanup: isc_log_destroy(&named_g_lctx); isc_log_setcontext(NULL); dns_log_setcontext(NULL); return (result); } void named_log_setdefaultchannels(isc_logconfig_t *lcfg) { isc_logdestination_t destination; /* * By default, the logging library makes "default_debug" log to * stderr. In BIND, we want to override this and log to named.run * instead, unless the -g option was given. */ if (!named_g_logstderr) { destination.file.stream = NULL; destination.file.name = "named.run"; destination.file.versions = ISC_LOG_ROLLNEVER; destination.file.maximum_size = 0; isc_log_createchannel(lcfg, "default_debug", ISC_LOG_TOFILE, ISC_LOG_DYNAMIC, &destination, ISC_LOG_PRINTTIME | ISC_LOG_DEBUGONLY); } if (named_g_logfile != NULL) { destination.file.stream = NULL; destination.file.name = named_g_logfile; destination.file.versions = ISC_LOG_ROLLNEVER; destination.file.maximum_size = 0; isc_log_createchannel(lcfg, "default_logfile", ISC_LOG_TOFILE, ISC_LOG_DYNAMIC, &destination, ISC_LOG_PRINTTIME | ISC_LOG_PRINTCATEGORY | ISC_LOG_PRINTLEVEL); } #if ISC_FACILITY != LOG_DAEMON destination.facility = ISC_FACILITY; isc_log_createchannel(lcfg, "default_syslog", ISC_LOG_TOSYSLOG, ISC_LOG_INFO, &destination, 0); #endif /* if ISC_FACILITY != LOG_DAEMON */ /* * Set the initial debug level. */ isc_log_setdebuglevel(named_g_lctx, named_g_debuglevel); } void named_log_setsafechannels(isc_logconfig_t *lcfg) { isc_logdestination_t destination; if (!named_g_logstderr) { isc_log_createchannel(lcfg, "default_debug", ISC_LOG_TONULL, ISC_LOG_DYNAMIC, NULL, 0); /* * Setting the debug level to zero should get the output * discarded a bit faster. */ isc_log_setdebuglevel(named_g_lctx, 0); } else { isc_log_setdebuglevel(named_g_lctx, named_g_debuglevel); } if (named_g_logfile != NULL) { destination.file.stream = NULL; destination.file.name = named_g_logfile; destination.file.versions = ISC_LOG_ROLLNEVER; destination.file.maximum_size = 0; isc_log_createchannel(lcfg, "default_logfile", ISC_LOG_TOFILE, ISC_LOG_DYNAMIC, &destination, ISC_LOG_PRINTTIME | ISC_LOG_PRINTCATEGORY | ISC_LOG_PRINTLEVEL); } #if ISC_FACILITY != LOG_DAEMON destination.facility = ISC_FACILITY; isc_log_createchannel(lcfg, "default_syslog", ISC_LOG_TOSYSLOG, ISC_LOG_INFO, &destination, 0); #endif /* if ISC_FACILITY != LOG_DAEMON */ } /* * If the SSLKEYLOGFILE environment variable is set, TLS pre-master secrets are * logged (for debugging purposes) to the file whose path is provided in that * variable. Set up a default logging channel which maintains up to 10 files * containing TLS pre-master secrets, each up to 100 MB in size. If the * SSLKEYLOGFILE environment variable is set to the string "config", suppress * creation of the default channel, allowing custom logging channel * configuration for TLS pre-master secrets to be provided via the "logging" * stanza in the configuration file. */ void named_log_setdefaultsslkeylogfile(isc_logconfig_t *lcfg) { const char *sslkeylogfile_path = getenv("SSLKEYLOGFILE"); isc_logdestination_t destination = { .file = { .name = sslkeylogfile_path, .versions = 10, .suffix = isc_log_rollsuffix_timestamp, .maximum_size = 100 * 1024 * 1024, }, }; isc_result_t result; if (sslkeylogfile_path == NULL || strcmp(sslkeylogfile_path, "config") == 0) { return; } isc_log_createchannel(lcfg, "default_sslkeylogfile", ISC_LOG_TOFILE, ISC_LOG_INFO, &destination, 0); result = isc_log_usechannel(lcfg, "default_sslkeylogfile", ISC_LOGCATEGORY_SSLKEYLOG, NULL); RUNTIME_CHECK(result == ISC_R_SUCCESS); } isc_result_t named_log_setdefaultcategory(isc_logconfig_t *lcfg) { isc_result_t result = ISC_R_SUCCESS; result = isc_log_usechannel(lcfg, "default_debug", ISC_LOGCATEGORY_DEFAULT, NULL); if (result != ISC_R_SUCCESS) { goto cleanup; } if (!named_g_logstderr) { if (named_g_logfile != NULL) { result = isc_log_usechannel(lcfg, "default_logfile", ISC_LOGCATEGORY_DEFAULT, NULL); } else if (!named_g_nosyslog) { result = isc_log_usechannel(lcfg, "default_syslog", ISC_LOGCATEGORY_DEFAULT, NULL); } } cleanup: return (result); } isc_result_t named_log_setunmatchedcategory(isc_logconfig_t *lcfg) { isc_result_t result; result = isc_log_usechannel(lcfg, "null", NAMED_LOGCATEGORY_UNMATCHED, NULL); return (result); } void named_log_shutdown(void) { isc_log_destroy(&named_g_lctx); isc_log_setcontext(NULL); dns_log_setcontext(NULL); }