Add README, LICENSE

Author: spevnev

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Serhii Pievniev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -1,7 +1,7 @@
-SRC_DIR      := src
-OUT_DIR      := build
-EXTERNAL_DIR := external
-
+SRC_DIR         := src
+OUT_DIR         := build
+EXTERNAL_DIR    := external
+INSTALL_DIR     ?= /usr/local/bin
 TEST_COMMON_DIR := tests/common
 TEST_MOCK_DIR   := tests/mock
 BIND_CASES_DIR  := tests/cases/bind
@@ -12,23 +12,24 @@ BIN_PATH := $(OUT_DIR)/$(BIN_NAME)
 
 CC      := g++
 CFLAGS  := -O2 -std=c++23 -Wall -Wextra -pedantic -I $(SRC_DIR) -MMD -MP
-LDFLAGS := $(shell pkg-config --libs openssl)
 DEBUG_CFLAGS := -g3 -fsanitize=address,leak,undefined
+LDFLAGS := $(shell pkg-config --libs "openssl >= 3.0")
 
-ifeq ($(DEBUG), 1)
-	CFLAGS += $(DEBUG_CFLAGS)
-endif
+BIN_CFLAGS   := $(CFLAGS)
+BIND_TEST_CFLAGS  := $(CFLAGS) $(DEBUG_CFLAGS)
+# Mock tests must not include debug flags because libasan(enable by `fsanitize`) intercepts the
+# required functions(recvfrom and sendto) thus preventing the mocked functions from being used.
+MOCK_TEST_CFLAGS  := $(CFLAGS)
 
-# Disable optimizations to speed up CI
-ifdef CI
-	CFLAGS += -O0
+ifeq ($(DEBUG), 1)
+	BIN_CFLAGS += $(DEBUG_CFLAGS)
 endif
 
 BIN_SRCS := $(shell find $(SRC_DIR) -type f -name '*.cc')
 BIN_OBJS := $(patsubst %.cc, $(OUT_DIR)/%.o, $(BIN_SRCS))
 BIN_DEPS := $(patsubst %.o, %.d, $(BIN_OBJS))
 
-TEST_COMMON_SRCS    := $(shell find $(TEST_COMMON_DIR) -type f -name '*.cc') $(filter-out $(SRC_DIR)/main.cc, $(BIN_SRCS))
+TEST_COMMON_SRCS    := $(filter-out $(SRC_DIR)/main.cc, $(BIN_SRCS))
 BIND_COMMON_OBJ_DIR := $(OUT_DIR)/$(TEST_COMMON_DIR)/bind
 BIND_COMMON_OBJS    := $(patsubst %.cc, $(BIND_COMMON_OBJ_DIR)/%.o, $(TEST_COMMON_SRCS))
 BIND_COMMON_DEPS    := $(patsubst %.o, %.d, $(BIND_COMMON_OBJS))
@@ -59,43 +60,49 @@ clean:
 
 build: $(BIN_PATH)
 
+install: build
+	install -D -m755 $(BIN_PATH) $(INSTALL_DIR)/$(BIN_NAME)
+
+uninstall:
+	rm $(INSTALL_DIR)/$(BIN_NAME)
+
 $(BIN_PATH): $(BIN_OBJS)
 	@mkdir -p $(@D)
-	$(CC) $(CFLAGS) -o $@ $^ $(LDFLAGS)
+	$(CC) $(BIN_CFLAGS) -o $@ $^ $(LDFLAGS)
 
 $(OUT_DIR)/%.o: %.cc
 	@mkdir -p $(@D)
-	$(CC) $(CFLAGS) -I $(EXTERNAL_DIR)/cxxopts -o $@ -c $<
+	$(CC) $(BIN_CFLAGS) -I $(EXTERNAL_DIR)/cxxopts -o $@ -c $<
 
 test: $(BIND_CASES) $(MOCK_CASES)
 	@./tests/test.sh
 
 $(BIND_CASES_OUT_DIR)/%: $(BIND_CASES_OUT_DIR)/%.o $(BIND_COMMON_OBJS)
 	@mkdir -p $(@D)
-	$(CC) $(CFLAGS) $(DEBUG_CFLAGS) -o $@ $^ $(LDFLAGS)
+	$(CC) $(BIND_TEST_CFLAGS) -o $@ $^ $(LDFLAGS)
 
 $(BIND_CASES_OUT_DIR)/%.o: $(BIND_CASES_DIR)/%.cc
 	@mkdir -p $(@D)
-	$(CC) $(CFLAGS) $(DEBUG_CFLAGS) -I $(TEST_COMMON_DIR) -o $@ -c $<
+	$(CC) $(BIND_TEST_CFLAGS) -I $(TEST_COMMON_DIR) -o $@ -c $<
 
 $(BIND_COMMON_OBJ_DIR)/%.o: %.cc
 	@mkdir -p $(@D)
-	$(CC) $(CFLAGS) $(DEBUG_CFLAGS) -o $@ -c $<
+	$(CC) $(BIND_TEST_CFLAGS) -o $@ -c $<
 
 $(MOCK_CASES_OUT_DIR)/%: $(MOCK_CASES_OUT_DIR)/%.o $(TEST_MOCK_OBJS) $(MOCK_COMMON_OBJS)
 	@mkdir -p $(@D)
-	$(CC) $(CFLAGS) -o $@ $^ $(LDFLAGS)
+	$(CC) $(MOCK_TEST_CFLAGS) -o $@ $^ $(LDFLAGS)
 
 $(MOCK_CASES_OUT_DIR)/%.o: $(MOCK_CASES_DIR)/%.cc
 	@mkdir -p $(@D)
-	$(CC) $(CFLAGS) -I $(TEST_COMMON_DIR) -I $(TEST_MOCK_DIR) -o $@ -c $<
+	$(CC) $(MOCK_TEST_CFLAGS) -I $(TEST_COMMON_DIR) -I $(TEST_MOCK_DIR) -o $@ -c $<
 
 $(MOCK_COMMON_OBJ_DIR)/%.o: %.cc
 	@mkdir -p $(@D)
-	$(CC) $(CFLAGS) -o $@ -c $<
+	$(CC) $(MOCK_TEST_CFLAGS) -o $@ -c $<
 
 $(TEST_MOCK_OBJ_DIR)/%.o: %.cc
 	@mkdir -p $(@D)
-	$(CC) $(CFLAGS) -I $(TEST_COMMON_DIR) -o $@ -c $<
+	$(CC) $(MOCK_TEST_CFLAGS) -I $(TEST_COMMON_DIR) -o $@ -c $<
 
 -include $(BIN_DEPS) $(BIND_COMMON_DEPS) $(MOCK_COMMON_DEPS) $(TEST_MOCK_DEPS) $(BIND_CASES_DEPS) $(MOCK_CASES_DEPS)

README.md

@@ -0,0 +1,24 @@
+# Iterative DNS Resolver CLI
+
+## Dependencies
+
+- Make >= 4.3
+- pkg-config >= 1.8.1
+- OpenSSL >= 3.0.14
+- g++ >= 15
+- libstdc++ (comes with g++) >= 15
+
+## Implemented RFCs
+- [RFC1034](https://www.rfc-editor.org/rfc/rfc1034): DOMAIN NAMES - CONCEPTS AND FACILITIES
+- [RFC1035](https://www.rfc-editor.org/rfc/rfc1035): DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION
+- [RFC4033](https://www.rfc-editor.org/rfc/rfc4033): DNS Security Introduction and Requirements
+- [RFC4034](https://www.rfc-editor.org/rfc/rfc4034): Resource Records for the DNS Security Extensions
+- [RFC4035](https://www.rfc-editor.org/rfc/rfc4035): Protocol Modifications for the DNS Security Extensions
+- [RFC5155](https://www.rfc-editor.org/rfc/rfc5155): DNS Security (DNSSEC) Hashed Authenticated Denial of Existence
+- [RFC5702](https://www.rfc-editor.org/rfc/rfc5702): Use of SHA-2 Algorithms with RSA in DNSKEY and RRSIG Resource Records for DNSSEC
+- [RFC6605](https://www.rfc-editor.org/rfc/rfc6605): Elliptic Curve Digital Signature Algorithm (DSA) for DNSSEC
+- [RFC6840](https://www.rfc-editor.org/rfc/rfc6840): Clarifications and Implementation Notes for DNS Security (DNSSEC)
+- [RFC6891](https://www.rfc-editor.org/rfc/rfc6891): Extension Mechanisms for DNS (EDNS(0))
+- [RFC7129](https://www.rfc-editor.org/rfc/rfc7129): Authenticated Denial of Existence in the DNS
+- [RFC7873](https://www.rfc-editor.org/rfc/rfc7873): Domain Name System (DNS) Cookies
+- [RFC8080](https://www.rfc-editor.org/rfc/rfc8080): Edwards-Curve Digital Security Algorithm (EdDSA) for DNSSEC

src/main.cc

@@ -55,7 +55,7 @@ std::istream &operator>>(std::istream &is, FeatureState &out) {
 
 int main(int argc, char **argv) {
     try {
-        cxxopts::Options options{"resolver", "CLI DNS resolver"};
+        cxxopts::Options options{"resolver", "Iterative DNS Resolver CLI"};
         options.custom_help("[options]");
         options.positional_help("<domain>");
 

tests/common/common.cc

@@ -3,7 +3,9 @@
 #include <arpa/inet.h>
 #include <netinet/in.h>
 #include <sys/socket.h>
+#include <cassert>
 #include <cstdlib>
+#include <cstring>
 #include <print>  // IWYU pragma: keep
 
 #define ASSERT(condition)                                                                          \
@@ -14,5 +16,16 @@
         }                                                                                          \
     } while (0)
 
-in_addr_t get_ip4(const char *ip_str);
-bool ip6_equals(struct in6_addr address, const char *ip_str);
+inline in_addr_t get_ip4(const char *ip_str) {
+    in_addr_t ip_addr;
+    auto result = inet_pton(AF_INET, ip_str, &ip_addr);
+    assert(result == 1);
+    return ip_addr;
+}
+
+inline bool ip6_equals(struct in6_addr address_a, const char *ip_str) {
+    struct in6_addr address_b;
+    auto result = inet_pton(AF_INET6, ip_str, &address_b);
+    assert(result == 1);
+    return std::memcmp(&address_a, &address_b, sizeof(address_a)) == 0;
+}