implement error_on_unknown_config_opts, slightly improve related code

Signed-off-by: June Strawberry <june@vern.cc>

docker/Dockerfile.complement

@@ -62,8 +62,8 @@ COPY <<EOF complement.toml
     database_path = "/database"
     dns_attempts = 20
     dns_timeout = 60
+    error_on_unknown_config_opts = true
     federation_idle_timeout = 300
-    intentionally_unknown_config_option_for_testing = true
     ip_range_denylist = []
     log = "debug,tuwunel=trace,h2=warn,hyper=warn"
     log_colors = false

docker/Dockerfile.matrix-rust-sdk

@@ -35,6 +35,7 @@ COPY <<EOF tuwunel.toml
     allow_public_room_directory_without_auth = true
     allow_registration = true
     create_admin_room = false
+    error_on_unknown_config_opts = true
     ip_range_denylist = []
     log = "debug,tuwunel=trace,h2=warn,hyper=warn"
     log_colors = false

docker/Dockerfile.nix

@@ -65,6 +65,7 @@ RUN \
             -- \
             -Otest='["smoke", "fresh"]' \
             -Oserver_name=\"localhost\" \
+            -Oerror_on_unknown_config_opts=true \
 EOF
 
 

docker/Dockerfile.smoketest

@@ -19,7 +19,8 @@ RUN <<EOF
     tuwunel \
         -Otest='["smoke"]' \
         -Oserver_name=\"localhost\" \
-        -Odatabase_path=\"${TUWUNEL_DATABASE_PATH}\"
+        -Odatabase_path=\"${TUWUNEL_DATABASE_PATH}\" \
+        -Oerror_on_unknown_config_opts=true
 
     rm -rf "${TUWUNEL_DATABASE_PATH}"
 EOF
@@ -44,7 +45,8 @@ RUN <<EOF
             -Otest='["smoke"]' \
             -Oserver_name=\"localhost\" \
             -Odatabase_path=\"${TUWUNEL_DATABASE_PATH}\" \
-            -Odb_pool_max_workers=${db_pool_max_workers}
+            -Odb_pool_max_workers=${db_pool_max_workers} \
+            -Oerror_on_unknown_config_opts=true
 
     rm -rf "${TUWUNEL_DATABASE_PATH}"
 EOF
@@ -62,7 +64,8 @@ RUN <<EOF
         tuwunel \
             -Otest='["smoke"]' \
             -Oserver_name=\"localhost\" \
-            -Odatabase_path=\"${TUWUNEL_DATABASE_PATH}\"
+            -Odatabase_path=\"${TUWUNEL_DATABASE_PATH}\" \
+            -Oerror_on_unknown_config_opts=true
 
     rm -rf "${TUWUNEL_DATABASE_PATH}"
 EOF

nix/pkgs/complement/config.toml

@@ -6,6 +6,7 @@ allow_public_room_directory_over_federation = true
 allow_public_room_directory_without_auth = true
 allow_registration = true
 database_path = "/database"
+error_on_unknown_config_opts = true
 log = "trace,h2=debug,hyper=debug"
 port = [8008, 8448]
 trusted_servers = []

src/core/config/check.rs

@@ -2,6 +2,7 @@ use std::env::consts::OS;
 
 use either::Either;
 use figment::Figment;
+use itertools::Itertools;
 
 use super::{DEPRECATED_KEYS, IdentityProvider};
 use crate::{Config, Err, Result, Server, debug, debug_info, debug_warn, error, warn};
@@ -35,7 +36,7 @@ pub fn check(config: &Config) -> Result {
 	}
 
 	warn_deprecated(config);
-	warn_unknown_key(config);
+	warn_unknown_key(config)?;
 
 	if config.sentry && config.sentry_endpoint.is_none() {
 		return Err!(Config(
@@ -358,34 +359,47 @@ pub fn check(config: &Config) -> Result {
 /// deprecated key specified
 fn warn_deprecated(config: &Config) {
 	debug!("Checking for deprecated config keys");
-	let mut was_deprecated = false;
-	for key in config
+	let found_deprecated_keys = config
 		.catchall
 		.keys()
 		.filter(|key| DEPRECATED_KEYS.iter().any(|s| s == key))
-	{
-		warn!("Config parameter \"{}\" is deprecated, ignoring.", key);
-		was_deprecated = true;
-	}
+		.inspect(|key| warn!("Config parameter \"{key}\" is deprecated, ignoring."))
+		.next()
+		.is_some();
 
-	if was_deprecated {
+	if found_deprecated_keys {
 		warn!(
-			"Read tuwunel config documentation at https://tuwunel.chat/configuration.html and \
+			"Deprecated config keys were found. Read tuwunel config documentation at https://tuwunel.chat/configuration.html and \
 			 check your configuration if any new configuration parameters should be adjusted"
 		);
 	}
 }
 
-/// iterates over all the catchall keys (unknown config options) and warns
-/// if there are any.
-fn warn_unknown_key(config: &Config) {
+/// iterates over all the catchall keys (unknown config options) and warns or
+/// errors if there are any.
+fn warn_unknown_key(config: &Config) -> Result {
 	debug!("Checking for unknown config keys");
-	for key in config
+	let unknown_keys = config
 		.catchall
 		.keys()
-		.filter(|key| "config".to_owned().ne(key.to_owned()) /* "config" is expected */)
-	{
-		warn!("Config parameter \"{}\" is unknown to tuwunel, ignoring.", key);
+		.filter_map(|key| {
+			if key == "config" {
+				None
+			} else {
+				if config.error_on_unknown_config_opts {
+					error!("Config parameter \"{key}\" is unknown to tuwunel");
+				} else {
+					warn!("Config parameter \"{key}\" is unknown to tuwunel, ignoring.");
+				}
+				Some(key.as_str())
+			}
+		})
+		.collect_vec();
+
+	if !unknown_keys.is_empty() && config.error_on_unknown_config_opts {
+		Err!("Unknown config options were found: {unknown_keys:?}")
+	} else {
+		Ok(())
 	}
 }
 

src/core/config/mod.rs

@@ -146,6 +146,14 @@ pub struct Config {
 	#[serde(default = "default_unix_socket_perms")]
 	pub unix_socket_perms: u32,
 
+	/// Error on startup if any config option specified is unknown to Tuwunel.
+	///
+	/// This is false by default to allow easier deprecation or removal of
+	/// config options in the future without breaking existing deployments. The
+	/// default behaviour is to simply warn on startup.
+	#[serde(default)]
+	pub error_on_unknown_config_opts: bool,
+
 	/// tuwunel supports online database backups using RocksDB's Backup engine
 	/// API. To use this, set a database backup path that tuwunel can write
 	/// to.

tuwunel-example.toml

@@ -89,6 +89,14 @@
 #
 #unix_socket_perms = 660
 
+# Error on startup if any config option specified is unknown to Tuwunel.
+#
+# This is false by default to allow easier deprecation or removal of
+# config options in the future without breaking existing deployments. The
+# default behaviour is to simply warn on startup.
+#
+#error_on_unknown_config_opts = false
+
 # tuwunel supports online database backups using RocksDB's Backup engine
 # API. To use this, set a database backup path that tuwunel can write
 # to.