Version 0.3.0

cloudflare-ddns now supports configuration using a YAML file

Author: Tachi107

README.md

@@ -11,6 +11,8 @@ This tool is a oneshot program: you run it, it updates the DNS record, and it te
 
 To run the tool you'll need an [API token](https://dash.cloudflare.com/profile/api-tokens) and the Zone ID of the DNS that you want to update; you can get the latter in the Overview panel of your zone.
 
+Once you got the executable you can use it in two ways: you can pass the API Token, the Zone ID and the record name as command line arguments or you can use a YAML configuration file, located in `/etc/cloudflare-ddns/config.yaml` on Linux systems; [here's the template](config.yaml). If you prefer, you can even use a configuration file in a custom location, using `--config file-path`.
+
 ## Dependencies
 
 cloudflare-ddns relies only on libcurl and simdjson. I recommend you to compile the program yourself, but I also provide a statically linked executable for every release. It is not 100% self-contained but it should work in most cases.

cloudflare-ddns/CMakeLists.txt

@@ -1,6 +1,8 @@
 cmake_minimum_required(VERSION 3.14)
 
 project(cloudflare-ddns)
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_EXTENSIONS OFF)
 
 include(CheckIPOSupported)
 check_ipo_supported(RESULT ipo_result OUTPUT ipo_output)
@@ -16,7 +18,7 @@ find_package(Threads)
 
 include(FetchContent)
 
-FetchContent_Declare(curl GIT_REPOSITORY https://github.com/curl/curl.git GIT_TAG curl-7_75_0)
+FetchContent_Declare(curl GIT_REPOSITORY https://github.com/curl/curl.git GIT_TAG curl-7_75_0 GIT_SHALLOW TRUE)
 set(BUILD_CURL_EXE OFF CACHE BOOL "")
 set(BUILD_SHARED_LIBS OFF CACHE BOOL "")
 set(CURL_LTO ON CACHE BOOL "")
@@ -31,6 +33,12 @@ set(SIMDJSON_JUST_LIBRARY ON CACHE INTERNAL "")
 set(SIMDJSON_BUILD_STATIC ON CACHE INTERNAL "")
 FetchContent_MakeAvailable(simdjson)
 
+FetchContent_Declare(yaml-cpp GIT_REPOSITORY https://github.com/jbeder/yaml-cpp.git GIT_TAG yaml-cpp-0.6.3 GIT_SHALLOW TRUE)
+set(YAML_CPP_BUILD_TOOLS OFF CACHE BOOL "")
+set(YAML_CPP_BUILD_TESTS OFF CACHE BOOL "")
+set(YAML_CPP_INSTALL OFF CACHE BOOL "")
+FetchContent_MakeAvailable(yaml-cpp)
+
 add_executable(${PROJECT_NAME} cloudflare-ddns/main.cpp)
 
-target_link_libraries(${PROJECT_NAME} PRIVATE Threads::Threads simdjson libcurl)
+target_link_libraries(${PROJECT_NAME} PRIVATE Threads::Threads simdjson libcurl yaml-cpp)

cloudflare-ddns/main.cpp

@@ -3,13 +3,26 @@
 #include <iostream>
 #include <future>
 #include <simdjson.h>
+#include <yaml-cpp/yaml.h>
 
 /*
  * Two handles for two theads.
  * One for cdn-cgi/trace and one for DNS IP
  */
 
-std::size_t writeData(char* incomingBuffer, std::size_t size, std::size_t count, std::string* data) {
+static constexpr const char* configPath {[]() {
+	#if (defined(__linux__) || defined(__unix__) || defined(__unix)) && !defined(__FreeBSD__)
+		return "/etc/cloudflare-ddns/config.yaml";
+	#elif defined(__FreeBSD__)
+		return "/usr/local/etc/cloudflare-ddns/config.yaml";
+	#elif defined(_WIN32)
+		return "Where should I store the config file?";
+	#else
+		return "Unknown";
+	#endif
+}()};
+
+std::size_t writeData(char* incomingBuffer, const std::size_t size, const std::size_t count, std::string* data) {
 	data->append(incomingBuffer, size * count);
 	return size * count;
 }
@@ -46,20 +59,61 @@ std::string getLocalIp() {
 }
 
 // NOT thread-safe, writes into a buffer and uses an handle both owned elsewhere
-void getDnsRecordResponse(CURL** curlHandle, std::string_view requestUri) {
+void getDnsRecordResponse(CURL** curlHandle, const std::string_view requestUri) {
 	curl_easy_setopt(*curlHandle, CURLOPT_HTTPGET, 1L);
 	curl_easy_setopt(*curlHandle, CURLOPT_URL, requestUri.data());
 	curl_easy_perform(*curlHandle);
 }
 
 int main(int argc, char* argv[]) {
-	if (argc != 4) {
-		std::cerr << "Usage: cloudflare-ddns <API token> <Zone ID> <DNS record name>\n";
+	std::string apiToken;
+	std::string zoneId;
+	std::string recordName;
+
+	if (argc == 1) {
+		try {
+			const YAML::Node config {YAML::LoadFile(configPath)};
+			apiToken = config["api-token"].as<std::string>();
+			zoneId = config["zone-id"].as<std::string>();
+			recordName = config["record-name"].as<std::string>();
+		}
+		catch (const YAML::BadFile&) {
+			std::cerr << "No config file found in " << configPath << '\n';
+			return EXIT_FAILURE;
+		}
+		catch (const YAML::Exception&) {
+			std::cerr << "Bad config file\n";
+			return EXIT_FAILURE;
+		}
+	}
+	else if (argc == 3) {
+		const std::string_view configPath {argv[2]};
+		try {
+			const YAML::Node config {YAML::LoadFile(configPath.data())};
+			apiToken = config["api-token"].as<std::string>();
+			zoneId = config["zone-id"].as<std::string>();
+			recordName = config["record-name"].as<std::string>();
+		}
+		catch (const YAML::BadFile&) {
+			std::cerr << "No config file found in " << configPath << '\n';
+			return EXIT_FAILURE;
+		}
+		catch (const YAML::Exception&) {
+			std::cerr << "Bad config file\n";
+			return EXIT_FAILURE;
+		}
+	}
+	else if (argc == 4) {
+		apiToken = argv[1];
+		zoneId = argv[2];
+		recordName = argv[3];
+	}
+	else {
+		std::cerr 
+			<< "Bad usage! You can run the program without arguments and load the config in" << configPath 
+			<< " or pass the API token, the Zone ID and the DNS record name as arguments\n";
 		return EXIT_FAILURE;
 	}
-	const std::string_view apiToken {argv[1]};
-	const std::string zoneId {argv[2]};
-	const std::string recordName {argv[3]};
 
 	curl_global_init(CURL_GLOBAL_SSL);
 

config.yaml

@@ -0,0 +1,3 @@
+api-token:
+zone-id:
+record-name:

meson.build

@@ -8,7 +8,8 @@ project(
 		'b_lto=true'
 	],
 	version: '0.2.1',
-	license: 'AGPL-3.0-or-later'
+	license: 'AGPL-3.0-or-later',
+	meson_version: '>=0.46.0'
 )
 
 simdjson_dep = dependency('simdjson', required: false)
@@ -29,8 +30,17 @@ executable(
 	dependencies: [
 		dependency('libcurl'),
 		simdjson_dep,
-		dependency('threads')
+		dependency('threads'),
+		dependency('yaml-cpp')
 	],
 	cpp_args: '-DOPENSSL_NO_SSL3_METHOD',
 	install: true
 )
+
+if host_machine.system() == 'linux' or host_machine.system() == 'openbsd'
+	install_data('config.yaml', install_dir: '/etc/cloudflare-ddns')
+elif host_machine.system() == 'freebsd'
+	install_data('config.yaml', install_dir: '/usr/local/etc/cloudflare-ddns')
+else
+	install_data('config.yaml')
+endif