Initial commit: all files from local directory

This commit is contained in:
thakares committed 2025-05-24 23:07:23 +05:30
commit d32886d84f
33 files changed
+6027

No files matched your search

+146
View File
@@ -0,0 +1,146 @@
# DNS Server Algorithm & Flowchart
This document outlines the algorithm and flowchart for a DNS server implementation compliant with RFC 1035 (DNS) and RFC 4034 (DNSSEC).
---
## ✅ Server Algorithm
### 1. Server Initialization
1. Load configuration from environment variables.
2. Initialize the logging system.
3. Create SQLite database connection and initialize schema.
4. Initialize cache with NS records.
5. Start periodic cache cleanup task (every 5 minutes).
6. Bind and listen on UDP and TCP sockets.
### 2. Query Handling Flow
#### Upon Receiving a DNS Query:
1. Validate DNS query packet.
2. Parse header and extract domain name and query type.
3. If query type is `DNSKEY` or `DS`, return signed records.
4. Check DNS cache:
- If **hit**, build and return response.
- If **miss**, lookup in database:
- If found, respond and cache it.
- If not found:
- If authoritative, return `NXDOMAIN`.
- Else, forward to upstream resolvers.
5. Add DNSSEC signatures if applicable.
6. Send response to the client.
### 3. DNSSEC Signing Process
1. Load DNSSEC key from configured file.
2. For each relevant record:
- Generate `RRSIG`.
- Encode signature (Base64).
- Calculate key tag and signature expiration.
3. Add `RRSIG` to the answer section.
4. Include `DNSKEY` in the authority section if needed.
### 4. Response Generation Logic
1. Construct response header:
- Set QR flag and response code.
- Include Authoritative Answer (AA) if authoritative.
2. Attach original question section.
3. Populate:
- **Answer** section: with resolved records.
- **Authority** section: with NS and DS records.
- **Additional** section: with glue records, DNSKEY if required.
---
## 📊 Flowchart
![Flowchart](flow-chart.png)
Below is the visual representation of the DNS query handling logic:
```
+---------------------+
| Start DNS Server |
+---------------------+
|
v
+---------------------+
| Receive DNS Query |
+---------------------+
|
v
+---------------------+
| Parse Header and |
| Extract Domain & |
| Query Type |
+---------------------+
|
+---------------------+
| |
v v
+---------------------+ +---------------------+
| Is Query Type | | Use Cache |
| DNSKEY/DS? | | |
+---------------------+ +---------------------+
| |
Yes | |
v v
+---------------------+ +---------------------+
| Return | | Lookup in SQLite DB |
| DNSSEC Record | | |
+---------------------+ +---------------------+
|
v
+---------------------+
| Is Authoritative |
| Zone? |
+---------------------+
|
No |
v
+---------------------+
| Return NXDOMAIN |
+---------------------+
|
v
+---------------------+
| Add GSSEC |
+---------------------+
|
v
+---------------------+
| Send Response |
+---------------------+
|
v
+---------------------+
| End |
+---------------------+
```
## 🧩 Key Components
| Component | Purpose | Details |
|----------------|----------------------------|------------------------------------------|
| `DnsCache` | DNS Response Cache | Thread-safe HashMap with TTL |
| `ServerConfig` | Server Configuration | Loaded via environment variables |
| `rusqlite` | Record Storage | SQLite database backend |
| `tokio` | Async I/O Runtime | UDP/TCP async handlers and tasks |
| `DNSSEC` | Secure DNS Signing | RSA-SHA256 with Base64-encoded keys |
---
## ⚠️ Error Handling Strategy
- Custom `DnsError` enum via `thiserror`
- Graceful shutdown via `SIGINT`
- Cache cleanup every 5 minutes
- Fallback to resolver forwarding
- Detailed logging at every stage
---
+128
View File
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
mailto: sunil@thakares.com.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
+253
View File
@@ -0,0 +1,253 @@
# Contributing to nx9-dns-server
Thank you for considering contributing to nx9-dns-server! This document provides guidelines and instructions to help you contribute effectively to this project.
## Table of Contents
- [Code of Conduct](#code-of-conduct)
- [Getting Started](#getting-started)
- [Project Setup](#project-setup)
- [Development Environment](#development-environment)
- [How to Contribute](#how-to-contribute)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Code Contributions](#code-contributions)
- [Pull Request Process](#pull-request-process)
- [Style Guidelines](#style-guidelines)
- [Rust Code Style](#rust-code-style)
- [Commit Messages](#commit-messages)
- [Documentation](#documentation)
- [Priority Areas](#priority-areas)
- [Community](#community)
- [License](#license)
## Code of Conduct
By participating in this project, you are expected to uphold our [Code of Conduct](CODE_OF_CONDUCT.md). Please report unacceptable behavior to [project maintainers](mailto:maintainer@example.com).
## Getting Started
### Project Setup
1. **Fork the repository** on GitHub
2. **Clone your fork**:
```bash
git clone https://github.com/your-username/nx9-dns-server.git
cd nx9-dns-server
```
3. **Add the upstream remote**:
```bash
git remote add upstream https://github.com/thakares/nx9-dns-server.git
```
4. **Create a branch** for your work:
```bash
git checkout -b feature/your-feature-name
```
### Development Environment
#### Requirements
- Rust (stable, 1.70+)
- SQLite 3.x
- Cargo and standard Rust toolchain
#### Setup
1. **Install dependencies**:
```bash
# For Debian/Ubuntu
sudo apt-get install build-essential pkg-config libsqlite3-dev
# For Fedora/RHEL
sudo dnf install gcc sqlite-devel pkgconfig
# For macOS with Homebrew
brew install sqlite
```
2. **Compile and run the project**:
```bash
cargo build
cargo run
```
3. **Run tests**:
```bash
cargo test
```
## How to Contribute
### Reporting Bugs
Before submitting a bug report:
- Check the [issue tracker](https://github.com/thakares/nx9-dns-server/issues) to see if the issue has already been reported
- Make sure you're using the latest version of the software
- Perform a quick search to see if the problem has already been addressed
When submitting a bug report:
1. Use the bug report template provided
2. Include a clear and descriptive title
3. Describe the exact steps to reproduce the issue
4. Provide specific examples to demonstrate the steps
5. Describe the behavior you observed and what you expected to see
6. Include relevant logs, screenshots, or other materials
7. Mention your environment (OS, Rust version, etc.)
### Suggesting Enhancements
Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion:
1. Use the feature request template provided
2. Include a clear and descriptive title
3. Provide a detailed description of the proposed functionality
4. Explain why this enhancement would be useful to most users
5. List any alternatives you've considered
6. Include any mockups or examples if applicable
### Code Contributions
We're actively seeking contributions in these areas:
1. **Web UI Development**
- Frontend components and integration with backend
- UI/UX design for DNS management
2. **API Service**
- RESTful API implementation
- Authentication and permission handling
- Request validation
3. **User Management**
- Authentication systems
- Role-based access control
- User onboarding flows
4. **DNSSEC Improvements**
- Key rotation automation
- Signature verification tools
- DNSSEC validation utilities
5. **Core DNS Improvements**
- Performance optimizations
- Additional record type support
- Protocol extensions
6. **Documentation and Testing**
- Improving guides and examples
- Unit and integration tests
- Benchmarking tools
## Pull Request Process
1. **Update your fork** with the latest from upstream:
```bash
git fetch upstream
git merge upstream/main
```
2. **Implement your changes** and commit them to your feature branch
3. **Run the test suite** to ensure your changes don't break existing functionality:
```bash
cargo test
```
4. **Add or update tests** as needed for your new functionality
5. **Update documentation** including README.md if needed
6. **Submit a pull request** to the main repository:
- Fill out the PR template completely
- Reference any related issues (e.g., "Fixes #123")
- Include a clear description of the changes and their motivation
- Add screenshots or terminal output if relevant
7. **Code review process**:
- Maintainers will review your PR
- Address any requested changes or feedback
- Once approved, maintainers will merge your PR
## Style Guidelines
### Rust Code Style
- Follow the [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/)
- Use `rustfmt` to format your code:
```bash
cargo fmt
```
- Use `clippy` to catch common mistakes and non-idiomatic code:
```bash
cargo clippy
```
- Follow the existing project style for consistency
- Use meaningful variable and function names
- Include comments for complex sections of code
- Write comprehensive documentation for public API functions
### Commit Messages
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests after the first line
- Consider using a structured format:
```
[Component] Short summary (up to 72 chars)
More detailed explanation, if necessary. Wrap lines at around 72
characters. Explain the problem this commit is solving. Focus on why
you are making this change as opposed to how.
Fixes #123
```
### Documentation
- Use proper grammatical sentences with punctuation
- Keep documentation up-to-date with code changes
- Include examples where appropriate
- Document all public API functions, structs, and traits
- Use Markdown formatting in doc comments and documentation files
## Priority Areas
We are particularly interested in contributions in these areas:
1. **Web UI Development**:
- Creating a responsive, user-friendly interface for DNS management
- Implementing dashboard components for monitoring DNS health
- Building forms for record management with validation
2. **API Service**:
- Implementing RESTful endpoints for DNS record CRUD operations
- Adding authentication and authorization mechanisms
- Developing batch operations for efficient record updates
3. **User Management**:
- Building a role-based access control system
- Implementing secure authentication flows
- Creating administrative tools for user management
4. **Documentation**:
- Improving guides and examples
- Creating API documentation
- Adding diagrams and architecture documentation
5. **Testing**:
- Unit tests for core components
- Integration tests for end-to-end validation
- Building automated CI pipelines
## Community
- Join our [Discord server](https://discord.com/channels/1179651660184817714/1369586647393370253) for discussions
- Follow the project on [Twitter](https://x.com/thakares)
- Subscribe to our [mailing list](https://example.com/mailing-list) for updates
## License
By contributing to nx9-dns-server, you agree that your contributions will be licensed under the project's [GNU General Public License v3.0 (GPLv3)](LICENSE).
---
Thank you for your interest in improving nx9-dns-server! We appreciate your time and effort in contributing to this project.
Generated
+1340
View File
File diff suppressed because it is too large. Load diff
+20
View File
@@ -0,0 +1,20 @@
# Cargo.toml
[package]
name = "nx9-dns-server"
version = "0.1.0"
edition = "2021"
[dependencies]
tokio = { version = "1.32", features = ["full"] }
rusqlite = { version = "0.29", features = ["bundled"] }
log = "0.4"
env_logger = "0.10"
thiserror = "1.0"
hex = "0.4"
base64 = "0.21"
r2d2 = "0.8"
r2d2_sqlite = "0.22"
lru = "0.12"
metrics = "0.21"
metrics-exporter-prometheus = "0.12"
chrono = "0.4"
+57
View File
@@ -0,0 +1,57 @@
# Build stage
FROM rust:1.72-slim-bookworm AS builder
# Install necessary build dependencies
RUN apt-get update && apt-get install -y \
musl-tools \
build-essential \
pkg-config \
libssl-dev \
&& rm -rf /var/lib/apt/lists/*
# Add support for cross-compilation to Alpine
RUN rustup target add x86_64-unknown-linux-musl
# Create a new empty project
WORKDIR /app
COPY . .
# Build the project with musl target
RUN cargo build --target x86_64-unknown-linux-musl --release
# Runtime stage
FROM alpine:3.18
# Install runtime dependencies
RUN apk --no-cache add ca-certificates sqlite tzdata
# Create a non-root user for running the application
RUN addgroup -S dns && adduser -S dnsuser -G dns
# Create necessary directories
RUN mkdir -p /var/nx9-dns-server /var/log/nx9-dns-server /etc/nx9-dns-server
RUN chown -R dnsuser:dns /var/nx9-dns-server /var/log/nx9-dns-server /etc/nx9-dns-server
# Copy the compiled binary
COPY --from=builder /app/target/x86_64-unknown-linux-musl/release/dns_server /usr/local/bin/
RUN chmod +x /usr/local/bin/dns_server
# Copy configuration files
COPY --from=builder /app/conf/dns_records.sql /etc/nx9-dns-server/
COPY --from=builder /app/conf/dns.db.sample /etc/nx9-dns-server/
# Expose DNS ports
EXPOSE 53/udp 53/tcp
# Expose Web UI port
EXPOSE 8080/tcp
# Expose API port
EXPOSE 8081/tcp
# Set working directory
WORKDIR /var/nx9-dns-server
# Switch to non-root user
USER dnsuser
# Command to run the application
CMD ["/usr/local/bin/dns_server"]
+24
View File
@@ -0,0 +1,24 @@
version: '3.8'
services:
dns:
image: nx9-dns-server:latest
container_name: nx9-dns
ports:
- "53:53/udp"
- "53:53/tcp"
- "8080:8080"
- "8081:8081"
volumes:
- ./data/dns.db:/var/nx9-dns-server/dns.db
- ./keys:/etc/nx9-dns-server/keys
- ./logs:/var/log/nx9-dns-server
environment:
- DNS_BIND=0.0.0.0:53
- DNS_DB_PATH=/var/nx9-dns-server/dns.db
- DNSSEC_KEY_FILE=/etc/nx9-dns-server/keys/Kanydomain.tld.key
- DNS_FORWARDERS=8.8.8.8:53,1.1.1.1:53
- DNS_NS_RECORDS=ns1.anydomain.tld.,ns2.anydomain.tld.
- WEB_UI_BIND=0.0.0.0:8080
- API_BIND=0.0.0.0:8081
restart: unless-stopped
+57
View File
@@ -0,0 +1,57 @@
# Build stage
FROM rust:1.72-slim-bookworm AS builder
# Install necessary build dependencies
RUN apt-get update && apt-get install -y \
musl-tools \
build-essential \
pkg-config \
libssl-dev \
&& rm -rf /var/lib/apt/lists/*
# Add support for cross-compilation to Alpine
RUN rustup target add x86_64-unknown-linux-musl
# Create a new empty project
WORKDIR /app
COPY . .
# Build the project with musl target
RUN cargo build --target x86_64-unknown-linux-musl --release
# Runtime stage
FROM alpine:3.18
# Install runtime dependencies
RUN apk --no-cache add ca-certificates sqlite tzdata
# Create a non-root user for running the application
RUN addgroup -S dns && adduser -S dnsuser -G dns
# Create necessary directories
RUN mkdir -p /var/nx9-dns-server /var/log/nx9-dns-server /etc/nx9-dns-server
RUN chown -R dnsuser:dns /var/nx9-dns-server /var/log/nx9-dns-server /etc/nx9-dns-server
# Copy the compiled binary
COPY --from=builder /app/target/x86_64-unknown-linux-musl/release/dns_server /usr/local/bin/
RUN chmod +x /usr/local/bin/dns_server
# Copy configuration files
COPY --from=builder /app/conf/dns_records.sql /etc/nx9-dns-server/
COPY --from=builder /app/conf/dns.db.sample /etc/nx9-dns-server/
# Expose DNS ports
EXPOSE 53/udp 53/tcp
# Expose Web UI port
EXPOSE 8080/tcp
# Expose API port
EXPOSE 8081/tcp
# Set working directory
WORKDIR /var/nx9-dns-server
# Switch to non-root user
USER dnsuser
# Command to run the application
CMD ["/usr/local/bin/dns_server"]
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 MiB

+674
View File
@@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
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/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.
+575
View File
@@ -0,0 +1,575 @@
# nx9-dns-server
**nx9-dns-server** is a high-performance, RFC-compliant authoritative DNS server implemented in Rust. It is designed for any domain (e.g., `anydomain.tld`), supporting a wide range of DNS record types, DNSSEC, and robust operational features. The server is optimized for reliability, security, and ease of deployment in production environments.
---
## Table of Contents
- [Features](#features)
- [Architecture](#architecture)
- [DNS Record Management](#dns-record-management)
- [Web UI](#web-ui)
- [API Service](#api-service)
- [User Management](#user-management)
- [DNSSEC Support](#dnssec-support)
- [How to Create DNSSEC_KEY_FILE](#how-to-create-dnssec_key_file)
- [Deployment](#deployment)
- [Traditional Deployment](#traditional-deployment)
- [Docker Deployment](#docker-deployment)
- [Configuration](#configuration)
- [Testing & Diagnostics](#testing--diagnostics)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Acknowledgements](#acknowledgements)
---
## Features
- **Authoritative DNS**: Serves authoritative responses for all queries to your domain (e.g., `anydomain.tld`).
- **Multi-Record Support**: Handles A, AAAA, MX, NS, SOA, PTR, TXT, and CNAME records.
- **DNSSEC Ready**: Supports DNSSEC key management and secure record signing.
- **High Performance**: Asynchronous networking (UDP/TCP) via Tokio for handling thousands of concurrent queries.
- **RFC Compliance**: Strict adherence to DNS protocol standards for interoperability.
- **Extensible Storage**: Uses SQLite for DNS record storage, allowing easy updates and migrations.
- **Easy Deployment**: Includes deployment and update scripts for smooth operational workflows.
- **Comprehensive Logging**: Integrates with `env_logger` for detailed runtime diagnostics.
- **Web Interface**: (Coming soon) Administrative web UI for DNS record management.
- **API Service**: (Coming soon) RESTful API service for programmatic DNS record management.
- **User Management**: (Coming soon) Multi-user access control with role-based permissions.
---
## Architecture
- **Language**: Rust (2021 edition)
- **Async Runtime**: [Tokio](https://tokio.rs/)
- **Database**: SQLite via [rusqlite](https://crates.io/crates/rusqlite)
- **Logging**: [log](https://crates.io/crates/log) and [env_logger](https://crates.io/crates/env_logger)
- **Error Handling**: [thiserror](https://crates.io/crates/thiserror)
- **DNSSEC**: Built-in support for key loading and RRSIG/DS/DNSKEY records
- **Web Framework**: (Coming soon) [Rocket](https://rocket.rs/) or [Axum](https://github.com/tokio-rs/axum) for UI and API endpoints
- **Authentication**: (Coming soon) JWT-based authentication and role-based authorization
- **Containerization**: Docker support with Alpine Linux for minimal footprint
- **Cross-Compilation**: Support for building from Debian to Alpine Linux (musl) target
---
## DNS Record Management
DNS records are managed in an SQLite database (`dns.db`). The schema supports multiple records per domain and type, and can be easily updated using SQL scripts.
**Example schema (`dns_records.sql`):**
```sql
CREATE TABLE IF NOT EXISTS dns_records (
domain TEXT NOT NULL,
record_type TEXT NOT NULL,
value TEXT NOT NULL,
ttl INTEGER DEFAULT 3600,
PRIMARY KEY (domain, record_type, value)
) WITHOUT ROWID;
```
**Sample records:**
```sql
INSERT OR REPLACE INTO dns_records VALUES
('anydomain.tld', 'A', '203.0.113.10', 3600),
('anydomain.tld', 'MX', '10 mail.anydomain.tld', 3600),
('anydomain.tld', 'NS', 'ns1.anydomain.tld', 3600),
('anydomain.tld', 'NS', 'ns2.anydomain.tld', 3600),
('anydomain.tld', 'SOA', 'ns1.anydomain.tld hostmaster.anydomain.tld 1 10800 3600 604800 86400', 3600),
('anydomain.tld', 'TXT', '"v=spf1 a mx ~all"', 3600),
('www.anydomain.tld', 'A', '203.0.113.10', 3600);
```
---
## Web UI
> 🚧 **Under Development - Seeking Contributors!** 🚧
>
> We're actively looking for community contributions to our Web UI implementation. If you have experience with Rust web frameworks (Rocket/Axum) and modern frontend technologies (React/Vue/Svelte), please consider contributing!
The planned Web UI will provide:
- **Dashboard**: Visual overview of DNS zone statistics and recent queries
- **Record Management**: Intuitive interface for creating, viewing, updating, and deleting DNS records
- **DNSSEC Management**: UI for key generation, rotation, and signature verification
- **Audit Logging**: Visual timeline of all record changes with user attribution
- **Responsive Design**: Mobile-friendly interface for management on any device
**Tech Stack (Proposed):**
- Backend: Rust with Rocket or Axum
- Frontend: TypeScript with React or Svelte
- Authentication: JWT-based with session management
**Contribution Areas:**
- UI/UX design mockups
- Frontend component development
- API integration
- Automated testing
- Documentation
If interested in contributing, please open an issue discussing your implementation approach before submitting PRs.
---
## API Service
> 🚧 **Under Development - Seeking Contributors!** 🚧
>
> We're building a RESTful API service for programmatic DNS record management. Contributors with experience in API design and Rust web services are welcome!
The DNS record management API will provide:
- **Full CRUD Operations**: Create, read, update, and delete DNS records via REST endpoints
- **Batch Operations**: Support for bulk record changes in a single request
- **Validation**: Strict validation of record syntax and domain integrity
- **Rate Limiting**: Protection against API abuse
- **Authentication**: Secure token-based authentication with scoped permissions
- **Webhooks**: (Planned) Event notifications for record changes
**Planned Endpoints:**
```
GET /api/v1/zones # List all zones
POST /api/v1/zones # Create new zone
GET /api/v1/zones/{zone} # Get zone details
PUT /api/v1/zones/{zone} # Update zone properties
DELETE /api/v1/zones/{zone} # Remove zone
GET /api/v1/zones/{zone}/records # List all records in zone
POST /api/v1/zones/{zone}/records # Create new record
GET /api/v1/zones/{zone}/records/{id} # Get record details
PUT /api/v1/zones/{zone}/records/{id} # Update record
DELETE /api/v1/zones/{zone}/records/{id} # Remove record
POST /api/v1/zones/{zone}/records/batch # Batch create/update/delete
```
If you're interested in contributing to the API service, please refer to our API design document in the project wiki.
---
## User Management
> 🚧 **Under Development - Community Input Requested!** 🚧
>
> We're designing a user management system and need input from the community on requirements and features.
Planned user management features:
- **Multi-User Support**: Multiple administrator and operator accounts
- **Role-Based Access Control**: Granular permissions for different user roles
- **Authentication Options**: Local accounts and potential OAuth/LDAP integration
- **Audit Trail**: Comprehensive logging of all user actions
- **Password Policies**: Configurable password requirements and rotation policies
- **Two-Factor Authentication**: Additional security layer for administrative access
- **API Tokens**: Management of scoped API tokens for programmatic access
**User Roles (Proposed):**
- **Administrator**: Full system access
- **Operator**: Can manage DNS records but not system settings
- **Viewer**: Read-only access to records and statistics
- **API Client**: Programmatic access via API tokens
**We welcome community input on:**
- Authentication mechanisms
- Additional role definitions and permission scopes
- UI/UX design for user management interfaces
- Enterprise integration requirements
Please open an issue with the tag `user-management` to share your feedback and requirements.
---
## DNSSEC Support
- **Key Management**: DNSSEC keys are loaded from environment-configured paths.
- **Record Signing**: Supports RRSIG, DS, and DNSKEY records for secure, signed DNS responses.
- **Preprocessing**: Key files can be preprocessed using provided scripts before deployment.
---
## How to Create `DNSSEC_KEY_FILE`
To enable DNSSEC for `nx9-dns-server`, you need to generate a DNSSEC key pair and provide the public key file to the server via the `DNSSEC_KEY_FILE` environment variable. Here's how you can do it using [BIND's dnssec-keygen tool](https://bind9.readthedocs.io/en/latest/reference.html#dnssec-keygen):
### 1. Install `dnssec-keygen`
On most Linux systems, you can install it via the package manager:
```bash
sudo apt-get install bind9-dnsutils # Debian/Ubuntu
# or
sudo yum install bind-utils # CentOS/RHEL
```
### 2. Generate DNSSEC Key Pair
Run the following command to generate a 2048-bit RSA key for your domain (replace `anydomain.tld` with your actual domain):
```bash
dnssec-keygen -a RSASHA256 -b 2048 -n ZONE anydomain.tld
```
- This will produce two files in your current directory:
- `K.+008+.key` (public key)
- `K.+008+.private` (private key)
### 3. Set the `DNSSEC_KEY_FILE` Environment Variable
Copy the public key file (`.key`) to your server's key directory (e.g., `/var/nx9-dns-server/`):
```bash
cp Kanydomain.tld.+008+24550.key /var/nx9-dns-server/
```
Then, set the environment variable in your deployment environment or systemd service:
```bash
export DNSSEC_KEY_FILE="/var/nx9-dns-server/Kanydomain.tld.+008+24550.key"
```
Or in your systemd unit file:
```
Environment="DNSSEC_KEY_FILE=/var/nx9-dns-server/Kanydomain.tld.+008+24550.key"
```
### 4. (Optional) Preprocess the Key
If your deployment uses a preprocessing script (as referenced in your `deploy.sh`), run:
```bash
sudo chmod +x /var/nx9-dns-server/preprocess-key.sh
sudo -u dnsuser /var/nx9-dns-server/preprocess-key.sh
```
This may normalize the key format or permissions as required by your server.
### 5. Restart the DNS Server
After setting the key file, restart your DNS server to load the new key:
```bash
sudo systemctl restart dns-server.service
```
### 6. Verify DNSSEC is Working
Use the provided `dnscheck.sh` script or `dig` to verify DNSSEC records:
```bash
bash dnscheck.sh
# or manually:
dig @localhost anydomain.tld DNSKEY +dnssec
```
**Note:**
- Keep your `.private` key file secure and never expose it publicly.
- Only the `.key` (public) file should be referenced by the server.
- The server will load and use the public key for signing DNS responses.
---
## Deployment
### Traditional Deployment
Deployment is automated and robust, using the provided [`deploy.sh`](deploy.sh) script. This script handles permissions, key preprocessing, SOA updates, binary replacement, and service management.
**Typical deployment steps:**
```bash
#!/bin/bash
set -e
SRC_BIN="/home/youruser/apps/your-ddns/dns_server"
DEST_DIR="/var/nx9-dns-server"
DEST_BIN="$DEST_DIR/dns_server"
PREPROCESS_SCRIPT="$DEST_DIR/preprocess-key.sh"
SOA_UPDATE_SCRIPT="$DEST_DIR/soa-update.sh"
echo "🔐 Fixing permissions and running preprocess..."
sudo chmod +x "$PREPROCESS_SCRIPT"
sudo -u dnsuser "$PREPROCESS_SCRIPT"
echo "🛠 Updating SOA record..."
sudo chown dnsuser:dnsuser "$SOA_UPDATE_SCRIPT"
sudo chmod +x "$SOA_UPDATE_SCRIPT"
sudo -u dnsuser "$SOA_UPDATE_SCRIPT"
echo "📄 Verifying processed.key content..."
sudo cat "$DEST_DIR/processed.key"
echo "🛑 Stopping DNS server..."
sudo systemctl stop dns-server.service
echo "📦 Deploying new dns_server binary..."
sudo cp "$SRC_BIN" "$DEST_BIN"
sudo chown dnsuser:dnsuser "$DEST_DIR"
echo "🔁 Reloading systemd and restarting service..."
sudo systemctl daemon-reload
sudo systemctl restart dns-server.service
echo "📈 Checking service status..."
sudo systemctl status dns-server.service
```
See [`deploy.sh`](deploy.sh) for the full deployment script.
### Docker Deployment
We provide a Docker-based deployment option using Alpine Linux for a minimal and secure container.
#### Dockerfile
```Dockerfile
# Build stage
FROM rust:1.72-slim-bookworm AS builder
# Install necessary build dependencies
RUN apt-get update && apt-get install -y \
musl-tools \
build-essential \
pkg-config \
libssl-dev \
&& rm -rf /var/lib/apt/lists/*
# Add support for cross-compilation to Alpine
RUN rustup target add x86_64-unknown-linux-musl
# Create a new empty project
WORKDIR /app
COPY . .
# Build the project with musl target
RUN cargo build --target x86_64-unknown-linux-musl --release
# Runtime stage
FROM alpine:3.18
# Install runtime dependencies
RUN apk --no-cache add ca-certificates sqlite tzdata
# Create a non-root user for running the application
RUN addgroup -S dns && adduser -S dnsuser -G dns
# Create necessary directories
RUN mkdir -p /var/nx9-dns-server /var/log/nx9-dns-server /etc/nx9-dns-server
RUN chown -R dnsuser:dns /var/nx9-dns-server /var/log/nx9-dns-server /etc/nx9-dns-server
# Copy the compiled binary
COPY --from=builder /app/target/x86_64-unknown-linux-musl/release/dns_server /usr/local/bin/
RUN chmod +x /usr/local/bin/dns_server
# Copy configuration files
COPY --from=builder /app/conf/dns_records.sql /etc/nx9-dns-server/
COPY --from=builder /app/conf/dns.db.sample /etc/nx9-dns-server/
# Expose DNS ports
EXPOSE 53/udp 53/tcp
# Expose Web UI port
EXPOSE 8080/tcp
# Expose API port
EXPOSE 8081/tcp
# Set working directory
WORKDIR /var/nx9-dns-server
# Switch to non-root user
USER dnsuser
# Command to run the application
CMD ["/usr/local/bin/dns_server"]
```
#### Building the Docker Image
```bash
# Clone the repository
git clone https://github.com/thakares/nx9-dns-server.git
cd nx9-dns-server
# Build the Docker image
docker build -t nx9-dns-server:latest .
```
#### Running the Container
```bash
# Run with basic configuration
docker run -d --name nx9-dns \
-p 53:53/udp -p 53:53/tcp \
-p 8080:8080 -p 8081:8081 \
-v /path/to/dns.db:/var/nx9-dns-server/dns.db \
-v /path/to/keys:/etc/nx9-dns-server/keys \
-e DNS_BIND=0.0.0.0:53 \
-e DNS_DB_PATH=/var/nx9-dns-server/dns.db \
-e DNSSEC_KEY_FILE=/etc/nx9-dns-server/keys/Kanydomain.tld.key \
-e WEB_UI_BIND=0.0.0.0:8080 \
-e API_BIND=0.0.0.0:8081 \
nx9-dns-server:latest
```
#### Using Docker Compose
For more complex deployments, a `docker-compose.yml` file is recommended:
```yaml
version: '3.8'
services:
dns:
image: nx9-dns-server:latest
container_name: nx9-dns
ports:
- "53:53/udp"
- "53:53/tcp"
- "8080:8080"
- "8081:8081"
volumes:
- ./data/dns.db:/var/nx9-dns-server/dns.db
- ./keys:/etc/nx9-dns-server/keys
- ./logs:/var/log/nx9-dns-server
environment:
- DNS_BIND=0.0.0.0:53
- DNS_DB_PATH=/var/nx9-dns-server/dns.db
- DNSSEC_KEY_FILE=/etc/nx9-dns-server/keys/Kanydomain.tld.key
- DNS_FORWARDERS=8.8.8.8:53,1.1.1.1:53
- DNS_NS_RECORDS=ns1.anydomain.tld.,ns2.anydomain.tld.
- WEB_UI_BIND=0.0.0.0:8080
- API_BIND=0.0.0.0:8081
restart: unless-stopped
```
To run with Docker Compose:
```bash
docker-compose up -d
```
---
## Configuration
Configuration is environment-driven and highly flexible.
**Key environment variables:**
- `DNS_BIND`: Bind address (default: `0.0.0.0:53`)
- `DNS_DB_PATH`: Path to the SQLite database (default: `dns.db`)
- `DNSSEC_KEY_FILE`: Path to DNSSEC key file
- `DNS_FORWARDERS`: Comma-separated list of upstream DNS resolvers
- `DNS_NS_RECORDS`: Comma-separated list of NS records
- `DNS_CACHE_TTL`: Cache TTL in seconds
- `WEB_UI_BIND`: Bind address for web interface (default: `127.0.0.1:8080`)
- `API_BIND`: Bind address for API service (default: `127.0.0.1:8081`)
- `AUTH_SECRET`: Secret key for JWT token signing
- `ADMIN_PASSWORD`: Initial admin password (only used if no users exist)
**Example:**
```bash
export DNS_BIND="0.0.0.0:53"
export DNS_DB_PATH="/var/nx9-dns-server/dns.db"
export DNSSEC_KEY_FILE="/var/nx9-dns-server/Kanydomain.tld.+008+24550.key"
export DNS_FORWARDERS="8.8.8.8:53,1.1.1.1:53"
export DNS_NS_RECORDS="ns1.anydomain.tld.,ns2.anydomain.tld."
export WEB_UI_BIND="0.0.0.0:8080"
export API_BIND="0.0.0.0:8081"
export AUTH_SECRET="your-secure-random-string-here"
```
---
## Testing & Diagnostics
A suite of shell scripts is provided for diagnostics and record verification:
- **dnscheck.sh**: Runs a series of `dig` queries for all major record types and DNSSEC.
- **dns_dump.sh**: Dumps all record types for a given domain.
- **api_test.sh**: (Coming soon) Tests the API endpoints with sample requests.
- **performance_test.sh**: (Coming soon) Benchmarks server performance under load.
**Example usage:**
```bash
bash dnscheck.sh
bash dns_dump.sh anydomain.tld
```
---
## Roadmap
Our planned features and improvements:
### Short-term (1-3 months)
- [x] Core DNS server functionality
- [x] DNSSEC implementation
- [ ] Web UI development (in progress)
- [ ] RESTful API service (in progress)
- [ ] User management system (planning)
- [ ] Docker container support
### Medium-term (3-6 months)
- [ ] Clustered deployment support
- [ ] Metrics and monitoring integration (Prometheus)
- [ ] Zone transfer (AXFR/IXFR) support
- [ ] Dynamic DNS update protocol (RFC 2136)
- [ ] DNSSEC key rotation automation
- [ ] Kubernetes Helm charts for enterprise deployment
### Long-term (6+ months)
- [ ] Secondary/slave DNS server support
- [ ] Geo-based DNS responses
- [ ] DNS over HTTPS (DoH) support
- [ ] DNS over TLS (DoT) support
- [ ] Record templating system
---
## Contributing
Contributions, bug reports, and feature requests are welcome! Please open issues or pull requests via GitHub.
### Priority Contribution Areas
We're actively seeking contributions in these areas:
1. **Web UI Development**: Frontend components and integration with the backend
2. **API Service**: RESTful API implementation for DNS record management
3. **User Management**: Authentication, authorization, and user interface
4. **Documentation**: Improving guides and examples
5. **Testing**: Unit tests, integration tests, and automated CI pipelines
### How to Contribute
1. Fork the repository
2. Create a feature branch: `git checkout -b feature/amazing-feature`
3. Commit your changes: `git commit -m 'Add some amazing feature'`
4. Push to the branch: `git push origin feature/amazing-feature`
5. Open a Pull Request
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for detailed contribution guidelines.
---
## License
This project is licensed under the [GNU General Public License v3.0 (GPLv3)](LICENSE).
---
## Acknowledgements
- [Tokio](https://tokio.rs/) for async runtime
- [rusqlite](https://crates.io/crates/rusqlite) for SQLite integration
- [dig](https://linux.die.net/man/1/dig) for DNS diagnostics
- Community contributors and supporters
---
**nx9-dns-server** is developed and maintained by Sunil Purushottam Thakare <sunil@thakares.com>.
For more information, see the source code or contact the maintainer via GitHub.
---
**Tip:**
Replace `anydomain.tld` with your actual domain throughout the configuration and database files.
+35
View File
@@ -0,0 +1,35 @@
#!/bin/bash
set -e # Exit on error
echo "🔧 Making preprocess-key.sh executable..."
sudo chmod +x /var/nx9-dns-server/preprocess-key.sh
echo "👤 Running preprocess-key.sh as dnsuser..."
sudo -u dnsuser /var/nx9-dns-server/preprocess-key.sh
echo "🔧 Setting ownership and permissions for soa-update.sh..."
sudo chown dnsuser:dnsuser /var/nx9-dns-server/soa-update.sh
sudo chmod +x /var/nx9-dns-server/soa-update.sh
echo "👤 Running soa-update.sh as dnsuser..."
sudo -u dnsuser /var/nx9-dns-server/soa-update.sh
echo "📄 Checking output of processed.key..."
sudo cat /var/nx9-dns-server/processed.key
echo "🛑 Stopping dns-server.service..."
sudo systemctl stop dns-server.service
echo "📦 Deploying compiled binary to /var/nx9-dns-server..."
sudo cp /home/sunil/apps/nx9-bzo-ddns/dns_server /var/nx9-dns-server/dns_server
echo "👤 Fixing ownership of /var/nx9-dns-server..."
sudo chown dnsuser:dnsuser /var/nx9-dns-server
echo "🔄 Reloading systemd daemon and restarting service..."
sudo systemctl daemon-reload
sudo systemctl restart dns-server.service
echo "📡 Checking status of dns-server.service..."
sudo systemctl status dns-server.service
+35
View File
@@ -0,0 +1,35 @@
#!/bin/bash
set -e
# Paths
SRC_BIN="/home/<user-name>/apps/nx9-dns-server/dns_server"
DEST_DIR="/var/nx9-dns-server"
DEST_BIN="$DEST_DIR/nx9-dns_server"
PREPROCESS_SCRIPT="$DEST_DIR/preprocess-key.sh"
SOA_UPDATE_SCRIPT="$DEST_DIR/soa-update.sh"
echo "🔐 Fixing permissions and running preprocess..."
sudo chmod +x "$PREPROCESS_SCRIPT"
sudo -u dnsuser "$PREPROCESS_SCRIPT"
echo "🛠 Updating SOA record..."
sudo chown dnsuser:dnsuser "$SOA_UPDATE_SCRIPT"
sudo chmod +x "$SOA_UPDATE_SCRIPT"
sudo -u dnsuser "$SOA_UPDATE_SCRIPT"
echo "📄 Verifying processed.key content..."
sudo cat "$DEST_DIR/processed.key"
echo "🛑 Stopping DNS server..."
sudo systemctl stop dns-server.service
echo "📦 Deploying new dns_server binary..."
sudo cp "$SRC_BIN" "$DEST_BIN"
sudo chown dnsuser:dnsuser "$DEST_DIR"
echo "🔁 Reloading systemd and restarting service..."
sudo systemctl daemon-reload
sudo systemctl restart dns-server.service
echo "📈 Checking service status..."
sudo systemctl status dns-server.service
+9
View File
@@ -0,0 +1,9 @@
#!/bin/bash
DOMAIN=$1
RECORDS="A AAAA MX TXT CNAME NS SOA PTR"
for TYPE in $RECORDS; do
echo "== $TYPE records for $DOMAIN =="
dig $DOMAIN $TYPE
echo
done
+36
View File
@@ -0,0 +1,36 @@
-- dns.query - SQL commands to populate DNS records
BEGIN TRANSACTION;
-- First modify the table schema to allow multiple NS records
CREATE TABLE IF NOT EXISTS dns_records (
domain TEXT NOT NULL,
record_type TEXT NOT NULL,
value TEXT NOT NULL,
ttl INTEGER DEFAULT 3600,
PRIMARY KEY (domain, record_type, value)
) WITHOUT ROWID;
-- Copy existing data to new table
INSERT INTO dns_records_new SELECT * FROM dns_records;
-- Replace the old table
DROP TABLE dns_records;
ALTER TABLE dns_records_new RENAME TO dns_records;
-- Now insert all DNS records
INSERT OR REPLACE INTO dns_records VALUES
('33.61.254.60.in-addr.arpa', 'PTR', 'ns1.yourdomain.tld', 3600),
('admin.yourdomain.tld', 'A', '60.254.61.33', 3600),
('api.yourdomain.tld', 'A', '60.254.61.33', 3600),
('yourdomain.tld', 'A', '60.254.61.33', 3600),
('yourdomain.tld', 'MX', '10 mail.yourdomain.tld', 3600),
('yourdomain.tld', 'NS', 'ns1.yourdomain.tld', 3600),
('yourdomain.tld', 'NS', 'ns2.yourdomain.tld', 3600), -- This will now work with the new schema
('yourdomain.tld', 'SOA', 'ns1.yourdomain.tld hostmaster.yourdomain.tld 1 10800 3600 604800 86400', 3600),
('yourdomain.tld', 'TXT', '"v=spf1 a mx ~all"', 3600),
('ddns.yourdomain.tld', 'A', '60.254.61.33', 3600),
('ns1.yourdomain.tld', 'A', '60.254.61.33', 3600),
('ns2.yourdomain.tld', 'A', '60.254.61.33', 3600),
('www.yourdomain.tld', 'A', '60.254.61.33', 3600);
COMMIT;
+33
View File
@@ -0,0 +1,33 @@
[Unit]
Description=NX9 DNS Server
After=network.target
[Service]
User=dnsuser
Group=dnsuser
WorkingDirectory=/var/nx9-dns-server
ExecStart=/var/dns-server/nx9-dns_server # Run directly, skip wrapper
Restart=always
Environment=DNS_BIND=0.0.0.0:53
Environment=DNS_ENABLE_IPV6=1
Environment=DNS_MAX_PACKET_SIZE=4096
Environment=DNS_DB_PATH=/var/nx9-dns-server/dns.db
Environment=DNS_NS_RECORDS=ns1.yourdomain.tld.,ns2.yourdomain.tld.
Environment=DNS_AUTHORITATIVE=1
Environment=DNS_CACHE_TTL=300
Environment=RUST_LOG=info
Environment=DNS_DEFAULT_DOMAIN=yourdomain.tld
Environment=DNS_DEFAULT_IP=<YOUR-PUBLIC-IP4>
Environment="DNS_RECURSIVE=1" # Enable recursive resolution
Environment="DNS_CACHE_SIZE=10000"
Environment="DNS_FORWARDERS=8.8.8.8:53,1.1.1.1:53,9.9.9.9:53"
CapabilityBoundingSet=CAP_NET_BIND_SERVICE
AmbientCapabilities=CAP_NET_BIND_SERVICE
ReadWritePaths=/var/nx9-dns-server
ProtectSystem=full
LimitNOFILE=65536
[Install]
WantedBy=multi-user.target
+22
View File
@@ -0,0 +1,22 @@
# Create a file at /var/nx9-dns-server/dns_wrapper.sh
#!/bin/bash
# Log start with timestamp
echo "Starting DNS server at $(date)" >> /var/log/nx9-dns_server_wrapper.log
# Export all environment variables explicitly
export DNS_DB_PATH=/var/nx9-dns-server/dns.db
export DNS_BIND=0.0.0.0:53
export DNS_ENABLE_IPV6=1
export DNS_MAX_PACKET_SIZE=4096
export DNS_NS_RECORDS=ns1.yourdomain.tld.,ns2.yourdomain.tld.
export DNS_AUTHORITATIVE=1
export DNS_CACHE_TTL=300
export RUST_LOG=info
export DNS_DEFAULT_DOMAIN=yourdomain.tld
export DNS_DEFAULT_IP=<YOUR-PUBLIC-IP4>
# Print environment for debugging
env >> /var/log/nx9-dns-server_wrapper.log
# Run the DNS server
/var/dns-server/nx9-dns-server
+44
View File
@@ -0,0 +1,44 @@
#!/bin/bash
DOMAIN="yourdomain.tld"
DNS_SERVER="192.168.1.200" # your LAN Server Address
echo "=== DNS Diagnostic Report for $DOMAIN using $DNS_SERVER ==="
echo
# DNSKEY with DNSSEC
echo ">>> DNSKEY (with DNSSEC):"
dig @"$DNS_SERVER" "$DOMAIN." DNSKEY +dnssec
echo
# DS record
echo ">>> DS Record:"
dig @"$DNS_SERVER" "$DOMAIN." DS
echo
# NS record
echo ">>> NS Record:"
dig @"$DNS_SERVER" "$DOMAIN." NS
echo
# MX record
echo ">>> MX Record:"
dig @"$DNS_SERVER" "$DOMAIN." MX
echo
# SOA record
echo ">>> SOA Record:"
dig @"$DNS_SERVER" "$DOMAIN." SOA
echo
# A record
echo ">>> A Record:"
dig @"$DNS_SERVER" "$DOMAIN." A
echo
# Optional: check AAAA (IPv6) record
echo ">>> AAAA (IPv6) Record:"
dig @"$DNS_SERVER" "$DOMAIN." AAAA
echo
echo "=== End of DNS Report ==="
+24
View File
@@ -0,0 +1,24 @@
version: '3.8'
services:
dns:
image: nx9-dns-server:latest
container_name: nx9-dns
ports:
- "53:53/udp"
- "53:53/tcp"
- "8080:8080"
- "8081:8081"
volumes:
- ./data/dns.db:/var/nx9-dns-server/dns.db
- ./keys:/etc/nx9-dns-server/keys
- ./logs:/var/log/nx9-dns-server
environment:
- DNS_BIND=0.0.0.0:53
- DNS_DB_PATH=/var/nx9-dns-server/dns.db
- DNSSEC_KEY_FILE=/etc/nx9-dns-server/keys/Kanydomain.tld.key
- DNS_FORWARDERS=8.8.8.8:53,1.1.1.1:53
- DNS_NS_RECORDS=ns1.anydomain.tld.,ns2.anydomain.tld.
- WEB_UI_BIND=0.0.0.0:8080
- API_BIND=0.0.0.0:8081
restart: unless-stopped
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 MiB

+26
View File
@@ -0,0 +1,26 @@
#!/bin/bash
INPUT_FILE="/var/nx9-dns-server/Kyourdomain.+nnn+nnnnn.key"
OUTPUT_FILE="/var/nx9-dns-server/processed.key"
# Extract and clean the DNSKEY record
DNSKEY_RECORD=$(grep -E '^[^;].*IN[[:space:]]+DNSKEY' "$INPUT_FILE" | head -1)
if [ -z "$DNSKEY_RECORD" ]; then
echo "Error: No valid DNSKEY record found" >&2
exit 1
fi
# Format: "domain. IN DNSKEY flags protocol algorithm key"
echo "$DNSKEY_RECORD" | awk '{
# Remove comments and extra spaces
gsub(/;.*$/, "");
gsub(/[[:space:]]+/, " ");
# Reconstruct with clean base64
printf "%s %s %s %s %s %s ", $1, $2, $3, $4, $5, $6;
# Print key without any whitespace
for (i=7; i<=NF; i++) printf "%s", $i;
print "";
}' > "$OUTPUT_FILE"
exit 0
+17
View File
@@ -0,0 +1,17 @@
#!/bin/bash
DB_PATH="/var/nx9-dns-server/dns.db"
ZONE="yourdomain.tld"
# Get today's date and an incremental suffix
DATE=$(date +%Y%m%d)
SERIAL_SUFFIX="01"
NEW_SERIAL="${DATE}${SERIAL_SUFFIX}"
# Update SOA value
sqlite3 "$DB_PATH" <<EOF
UPDATE dns_records
SET value = 'ns1.yourdomain.tld hostmaster.yourdomain.tld $NEW_SERIAL 10800 3600 604800 86400'
WHERE domain = '$ZONE' AND record_type = 'SOA';
EOF
echo "SOA record updated with serial: $NEW_SERIAL"
+102
View File
@@ -0,0 +1,102 @@
//! DNS cache implementation.
//!
//! This module provides a simple in-memory cache for DNS records to improve
//! performance by avoiding repeated database lookups for frequently accessed domains.
#![allow(dead_code)]
#[allow(unused_variables)]
use std::{
collections::HashMap,
sync::{Arc, Mutex, OnceLock},
time::{Duration, SystemTime},
};
use log::debug;
/// Interval for cleaning up expired cache entries (in seconds).
pub const CACHE_CLEANUP_INTERVAL: Duration = Duration::from_secs(300);
/// Global cache instance.
pub static CACHE: OnceLock<DnsCache> = OnceLock::new();
/// An entry in the DNS cache.
#[derive(Debug, Clone)]
pub struct CacheEntry {
/// The IP address for the domain.
pub ip: String,
/// When this entry was added to the cache.
pub inserted: SystemTime,
/// Time-to-live in seconds.
pub ttl: u64,
}
/// Cache for DNS records to improve performance.
#[derive(Debug, Clone)]
pub struct DnsCache {
/// Map of domain names to cache entries.
pub entries: Arc<Mutex<HashMap<String, CacheEntry>>>,
/// List of NS records for zones this server is authoritative for.
pub ns_records: Vec<String>,
}
impl DnsCache {
/// Create a new DNS cache.
///
/// # Arguments
/// * `ns_records` - List of NS records for zones this server is authoritative for.
///
/// # Returns
/// A new `DnsCache` instance.
pub fn new(ns_records: Vec<String>) -> Self {
Self {
entries: Arc::new(Mutex::new(HashMap::new())),
ns_records,
}
}
/// Get a cached IP address for a domain.
///
/// # Arguments
/// * `domain` - The domain name to look up.
///
/// # Returns
/// An `Option` containing the IP address and TTL if found and not expired.
pub fn get(&self, domain: &str) -> Option<(String, u64)> {
let cache = self.entries.lock().unwrap();
if let Some(entry) = cache.get(domain) {
if entry.inserted.elapsed().map(|d| d.as_secs() <= entry.ttl).unwrap_or(true) {
return Some((entry.ip.clone(), entry.ttl));
}
}
None
}
/// Add or update a domain in the cache.
///
/// # Arguments
/// * `domain` - The domain name to cache.
/// * `ip` - The IP address for the domain.
/// * `ttl` - Time-to-live in seconds.
pub fn set(&self, domain: String, ip: String, ttl: u64) {
let mut cache = self.entries.lock().unwrap();
cache.insert(
domain,
CacheEntry {
ip,
inserted: SystemTime::now(),
ttl,
},
);
}
/// Remove expired entries from the cache.
pub fn cleanup(&self) {
let mut cache = self.entries.lock().unwrap();
cache.retain(|_, entry| {
entry.inserted.elapsed().map(|d| d.as_secs() <= entry.ttl).unwrap_or(true)
});
debug!("Cache cleanup completed");
}
}
+117
View File
@@ -0,0 +1,117 @@
//! Configuration for the DNS server.
//!
//! This module defines the configuration structure and methods to load
//! configuration from environment variables.
#![allow(dead_code)]
#[allow(unused_variables)]
use std::{env, fs, net::SocketAddr};
use log::{error, info};
use crate::errors::DnsError;
/// Default TTL for DNS records in seconds.
pub const DEFAULT_TTL: u64 = 600;
/// Maximum size of DNS packets in bytes.
pub const MAX_PACKET_SIZE: usize = 4096;
/// Server configuration loaded from environment variables.
#[derive(Debug, Clone)]
pub struct ServerConfig {
/// Address to bind the DNS server to.
pub bind_addr: SocketAddr,
/// Path to the SQLite database file.
pub db_path: String,
/// Time-to-live for cached DNS records.
pub cache_ttl: u64,
/// Whether to enable IPv6 support.
pub enable_ipv6: bool,
/// Maximum size of DNS packets.
pub max_packet_size: usize,
/// Whether this server is authoritative for its zones.
pub authoritative: bool,
/// List of NS records for zones this server is authoritative for.
pub ns_records: Vec<String>,
/// Default domain for the server.
pub default_domain: String,
/// Default IP address for the server.
pub default_ip: String,
/// List of upstream DNS servers to forward queries to.
pub forwarders: Vec<SocketAddr>,
/// List of DS records for DNSSEC.
pub ds_records: Vec<String>,
/// List of DNSKEY records for DNSSEC.
pub dnskey_records: Vec<String>,
}
impl ServerConfig {
/// Load server configuration from environment variables.
///
/// # Returns
/// A `Result` containing either the loaded `ServerConfig` or a `DnsError`.
pub fn from_env() -> Result<Self, DnsError> {
let bind_addr = env::var("DNS_BIND")
.unwrap_or_else(|_| "0.0.0.0:53".into())
.parse()
.map_err(|_| DnsError::Config("Invalid DNS_BIND address".into()))?;
let forwarders = env::var("DNS_FORWARDERS")
.unwrap_or_else(|_| "8.8.8.8:53,1.1.1.1:53,9.9.9.9:53".into())
.split(',')
.filter_map(|s| s.trim().parse().ok())
.collect();
let key_path = env::var("DNSSEC_KEY_FILE").unwrap_or_else(|_| "Kbzo.in.+008+24550.key".to_string());
let dnskey_records = match fs::read_to_string(&key_path) {
Ok(content) => {
info!("Loaded DNSSEC key from {}", key_path);
vec![content.trim().to_string()]
},
Err(e) => {
error!("Failed to load DNSSEC key from {}: {}", key_path, e);
vec![]
}
};
Ok(Self {
bind_addr,
db_path: env::var("DNS_DB_PATH").unwrap_or_else(|_| "dns.db".into()),
cache_ttl: env::var("DNS_CACHE_TTL")
.ok()
.and_then(|v| v.parse().ok())
.unwrap_or(DEFAULT_TTL),
enable_ipv6: env::var("DNS_ENABLE_IPV6")
.map(|v| v == "1" || v.eq_ignore_ascii_case("true"))
.unwrap_or(false),
max_packet_size: env::var("DNS_MAX_PACKET_SIZE")
.ok()
.and_then(|v| v.parse().ok())
.unwrap_or(MAX_PACKET_SIZE),
authoritative: env::var("DNS_AUTHORITATIVE")
.map(|v| v == "1" || v.eq_ignore_ascii_case("true"))
.unwrap_or(false),
ns_records: env::var("DNS_NS_RECORDS")
.map(|v| v.split(',').map(|s| s.trim().to_string()).collect())
.unwrap_or_else(|_| vec!["ns1.yourdomain.tld.".into(), "ns2.yourdomain.tld.".into()]),
default_domain: env::var("DNS_DEFAULT_DOMAIN").unwrap_or_else(|_| "bzo.in".into()),
default_ip: env::var("DNS_DEFAULT_IP").unwrap_or_else(|_| "<your-public-ip4-here>".into()),
ds_records: vec![
"yourdomain.tld. IN DS 24550 8 2 1F21CA282945434EE0662805430599CB2A6C479D9F934087150901CE2DA580A0".to_string()
],
dnskey_records,
forwarders,
})
}
}
+224
View File
@@ -0,0 +1,224 @@
//! Database operations for the DNS server.
//!
//! This module provides functions for interacting with the SQLite database
//! that stores DNS records and zone information.
use rusqlite::{params, Connection};
use crate::errors::DnsError;
use crate::config::ServerConfig;
/// Information about a DNS zone.
#[derive(Debug, Clone)]
pub struct ZoneInfo {
/// The domain name of the zone.
pub name: String,
/// List of NS records for the zone.
pub ns_records: Vec<String>,
/// SOA record for the zone, if available.
pub soa_record: Option<String>,
}
/// Initialize the DNS database.
///
/// Creates the database schema if it doesn't exist and populates it with default records
/// if the database is empty.
///
/// # Arguments
/// * `db_path` - Path to the SQLite database file.
/// * `default_domain` - Default domain name to use for initial records.
/// * `default_ip` - Default IP address to use for initial records.
///
/// # Returns
/// A `Result` indicating success or failure.
pub fn init_db(db_path: &str, default_domain: &str, default_ip: &str) -> Result<(), DnsError> {
let conn = Connection::open(db_path)?;
// Updated schema to allow multiple NS records
conn.execute(
"CREATE TABLE IF NOT EXISTS dns_records (
domain TEXT NOT NULL,
record_type TEXT NOT NULL CHECK(record_type IN (
'A','AAAA','MX','TXT','NS','CNAME','PTR','SOA',
'SRV','CAA','NAPTR','DS','DNSKEY','RRSIG','NSEC',
'TLSA','SSHFP'
)),
value TEXT NOT NULL,
ttl INTEGER DEFAULT 3600,
PRIMARY KEY (domain, record_type, value) -- Now allows multiple NS records
) WITHOUT ROWID",
[],
)?;
let count: i64 = conn.query_row("SELECT COUNT(*) FROM dns_records", [], |row| row.get(0))?;
if count == 0 && !default_ip.is_empty() {
let mail_domain = format!("mail.{}", default_domain);
let ns1 = format!("ns1.{}", default_domain);
let ns2 = format!("ns2.{}", default_domain);
let soa_record = format!("{} hostmaster.{} 1 10800 3600 604800 86400", ns1, default_domain);
conn.execute_batch(
&format!(
r#"
INSERT OR IGNORE INTO dns_records VALUES('{0}', 'A', ?, 3600);
INSERT OR IGNORE INTO dns_records VALUES('www.{0}', 'A', ?, 3600);
INSERT OR IGNORE INTO dns_records VALUES('api.{0}', 'A', ?, 3600);
INSERT OR IGNORE INTO dns_records VALUES('mail.{0}', 'A', ?, 3600);
INSERT OR IGNORE INTO dns_records VALUES('ns1.{0}', 'A', ?, 3600);
INSERT OR IGNORE INTO dns_records VALUES('ns2.{0}', 'A', ?, 3600);
INSERT OR IGNORE INTO dns_records VALUES('{0}', 'MX', '10 {1}', 3600);
INSERT OR IGNORE INTO dns_records VALUES('{0}', 'TXT', '\"v=spf1 a mx ~all\"', 3600);
INSERT OR IGNORE INTO dns_records VALUES('{0}', 'NS', '{2}', 3600);
INSERT OR IGNORE INTO dns_records VALUES('{0}', 'NS', '{3}', 3600);
INSERT OR IGNORE INTO dns_records VALUES('{0}', 'SOA', '{4}', 3600);
"#,
default_domain, mail_domain, ns1, ns2, soa_record
),
)?;
}
Ok(())
}
/// Look up DNS records for a domain.
///
/// # Arguments
/// * `db_path` - Path to the SQLite database file.
/// * `domain` - Domain name to look up.
///
/// # Returns
/// A vector of tuples containing (value, ttl, record_type) for each record found.
pub fn lookup_records(db_path: &str, domain: &str) -> Vec<(String, u64, String)> {
let conn = Connection::open(db_path);
match conn {
Ok(conn) => {
match conn.prepare(
"SELECT value, ttl, record_type FROM dns_records WHERE domain = ?"
) {
Ok(mut stmt) => {
match stmt.query_map(params![domain], |row| {
Ok((
row.get(0).unwrap_or_default(),
row.get(1).unwrap_or_default(),
row.get(2).unwrap_or_default(),
))
}) {
Ok(rows) => rows.filter_map(Result::ok).collect(),
Err(_) => Vec::new(),
}
}
Err(_) => Vec::new(),
}
}
Err(_) => Vec::new(),
}
}
/// Get information about all zones for which this server is authoritative.
///
/// # Arguments
/// * `db_path` - Path to the SQLite database file.
///
/// # Returns
/// A vector of `ZoneInfo` structs containing information about each zone.
pub fn get_authoritative_zones(db_path: &str) -> Vec<ZoneInfo> {
let mut zones = Vec::new();
if let Ok(conn) = Connection::open(db_path) {
// Find all domains with NS records (these are zones)
if let Ok(mut stmt) = conn.prepare(
"SELECT DISTINCT domain FROM dns_records WHERE record_type = 'NS'"
) {
if let Ok(rows) = stmt.query_map([], |row| {
Ok(row.get::<_, String>(0)?)
}) {
for domain_result in rows {
if let Ok(domain) = domain_result {
let mut zone_info = ZoneInfo {
name: domain.clone(),
ns_records: Vec::new(),
soa_record: None,
};
// Get NS records for this zone
if let Ok(mut ns_stmt) = conn.prepare(
"SELECT value FROM dns_records WHERE domain = ? AND record_type = 'NS'"
) {
if let Ok(ns_rows) = ns_stmt.query_map([&domain], |row| {
Ok(row.get::<_, String>(0)?)
}) {
zone_info.ns_records = ns_rows.filter_map(Result::ok).collect();
}
}
// Get SOA record if exists
if let Ok(mut soa_stmt) = conn.prepare(
"SELECT value FROM dns_records WHERE domain = ? AND record_type = 'SOA' LIMIT 1"
) {
if let Ok(mut soa_rows) = soa_stmt.query_map([&domain], |row| {
Ok(row.get::<_, String>(0)?)
}) {
zone_info.soa_record = soa_rows.next().and_then(|r| r.ok());
}
}
zones.push(zone_info);
}
}
}
}
}
// Add default zone information from config
if zones.is_empty() {
if let Ok(config) = ServerConfig::from_env() {
let default_zone = ZoneInfo {
name: config.default_domain.clone(),
ns_records: config.ns_records.clone(),
soa_record: Some(format!(
"{} hostmaster.{} 1 10800 3600 604800 86400",
config.ns_records.first().unwrap_or(&String::from("ns1.example.com.")),
config.default_domain
)),
};
zones.push(default_zone);
}
}
zones
}
/// Find the closest parent zone for a given domain.
///
/// # Arguments
/// * `domain` - Domain name to find the parent zone for.
/// * `zones` - List of zones to search in.
///
/// # Returns
/// An `Option` containing the closest parent zone, if found.
pub fn find_closest_parent_zone(domain: &str, zones: &[ZoneInfo]) -> Option<ZoneInfo> {
let domain_parts: Vec<&str> = domain.split('.').collect();
// Try progressively shorter parent domains
for i in 0..domain_parts.len() {
let candidate = domain_parts[i..].join(".");
// Exact match
if let Some(zone) = zones.iter().find(|z| z.name == candidate) {
return Some(zone.clone());
}
}
// Check if domain is a subdomain of any zone we're authoritative for
for zone in zones {
if domain.ends_with(&format!(".{}", zone.name)) {
return Some(zone.clone());
}
}
// If no match found, return None - we are not authoritative for this domain
None
}
+1229
View File
File diff suppressed because it is too large. Load diff
+39
View File
@@ -0,0 +1,39 @@
//! Error types for the DNS server
#![allow(dead_code)]
#[allow(unused_variables)]
use std::io;
use rusqlite;
use thiserror::Error;
/// Errors that can occur in the DNS server
#[derive(Debug, Error)]
pub enum DnsError {
/// I/O errors from the underlying system
#[error("I/O error: {0}")]
Io(#[from] io::Error),
/// Database errors from SQLite operations
#[error("Database error: {0}")]
Db(#[from] rusqlite::Error),
/// Protocol errors related to DNS message format or content
#[error("Protocol error: {0}")]
Protocol(String),
/// Configuration errors from invalid settings
#[error("Configuration error: {0}")]
Config(String),
/// Parse errors from string to number conversions
#[error("Parse error: {0}")]
Parse(#[from] std::num::ParseIntError),
/// Base64 decoding errors
#[error("Base64 error: {0}")]
Base64(String),
/// Shutdown signal received
#[error("Shutdown signal received")]
Shutdown,
}
+39
View File
@@ -0,0 +1,39 @@
//! Error types for the DNS server.
//!
//! This module defines the error types used throughout the DNS server implementation.
#![allow(dead_code)]
#[allow(unused_variables)]
use thiserror::Error;
/// Represents errors that can occur in the DNS server.
#[derive(Error, Debug)]
pub enum DnsError {
/// I/O errors from the standard library.
#[error("I/O error: {0}")]
Io(#[from] std::io::Error),
/// Database errors from rusqlite.
#[error("Database error: {0}")]
Db(#[from] rusqlite::Error),
/// Errors related to DNS protocol parsing or formatting.
#[error("Invalid DNS packet: {0}")]
Protocol(String),
/// Configuration errors.
#[error("Configuration error: {0}")]
Config(String),
/// Integer parsing errors.
#[error("Parse error: {0}")]
Parse(#[from] std::num::ParseIntError),
/// Base64 decoding errors.
#[error("Base64 error: {0}")]
Base64(String),
/// Shutdown signal received.
#[error("Shutdown signal received")]
Shutdown,
}
+190
View File
@@ -0,0 +1,190 @@
//! Request handlers for the DNS server.
//!
//! This module provides functions for handling DNS requests over UDP and TCP.
#![allow(dead_code)]
#[allow(unused_variables)]
use std::net::SocketAddr;
use std::sync::Arc;
use log::{debug, error, info, warn};
use tokio::{
io::AsyncReadExt,
net::{TcpListener, TcpStream, UdpSocket},
task,
};
use crate::errors::DnsError;
use crate::config::ServerConfig;
use crate::utils::extract_domain;
use crate::dns::{
build_not_implemented_response, build_nxdomain_response, generate_dns_response,
send_tcp_response,
};
/// Run the UDP DNS server.
///
/// # Arguments
/// * `config` - The server configuration.
///
/// # Returns
/// A `Result` indicating success or failure.
pub async fn run_udp_server(config: ServerConfig) -> Result<(), DnsError> {
let socket = UdpSocket::bind(config.bind_addr).await?;
info!("UDP DNS server listening on {}", config.bind_addr);
let socket = Arc::new(socket);
let mut buf = vec![0u8; config.max_packet_size];
loop {
match socket.recv_from(&mut buf).await {
Ok((amt, src)) => {
let query = buf[..amt].to_vec();
let socket = socket.clone();
let config = config.clone();
task::spawn(async move {
if let Err(e) = handle_udp_query(query, src, socket, config).await {
warn!("UDP query error: {}", e);
}
});
}
Err(e) => error!("UDP receive error: {}", e),
}
}
}
/// Handle a UDP DNS query.
///
/// # Arguments
/// * `query` - The DNS query.
/// * `src` - The source address of the query.
/// * `socket` - The UDP socket to send the response on.
/// * `config` - The server configuration.
///
/// # Returns
/// A `Result` indicating success or failure.
pub async fn handle_udp_query(
query: Vec<u8>,
src: SocketAddr,
socket: Arc<UdpSocket>,
config: ServerConfig,
) -> Result<(), DnsError> {
if query.len() < 12 {
debug!("Received malformed query from {}", src);
return Ok(());
}
let opcode = (query[2] & 0x78) >> 3;
if opcode != 0 {
if let Some(response) = build_not_implemented_response(&query, config.authoritative) {
socket.send_to(&response, src).await?;
}
return Ok(());
}
let domain = match extract_domain(&query) {
Some(d) => d,
None => {
info!("Failed to extract domain from query");
return Ok(());
}
};
debug!("UDP query for {} from {}", domain, src);
info!("Processing query for domain: {}", domain);
let response = match generate_dns_response(&query, domain.clone(), &config).await {
Ok(resp) => resp,
Err(_) => {
build_nxdomain_response(&query, config.authoritative)
.ok_or(DnsError::Protocol("NXDOMAIN".into()))?
}
};
socket.send_to(&response, src).await?;
Ok(())
}
/// Run the TCP DNS server.
///
/// # Arguments
/// * `config` - The server configuration.
///
/// # Returns
/// A `Result` indicating success or failure.
pub async fn run_tcp_server(config: ServerConfig) -> Result<(), DnsError> {
let listener = TcpListener::bind(config.bind_addr).await?;
info!("TCP DNS server listening on {}", config.bind_addr);
loop {
match listener.accept().await {
Ok((stream, addr)) => {
let config = config.clone();
task::spawn(async move {
if let Err(e) = handle_tcp_connection(stream, addr, config).await {
warn!("TCP connection error: {}", e);
}
});
}
Err(e) => error!("TCP accept error: {}", e),
}
}
}
/// Handle a TCP DNS connection.
///
/// # Arguments
/// * `stream` - The TCP stream.
/// * `addr` - The client address.
/// * `config` - The server configuration.
///
/// # Returns
/// A `Result` indicating success or failure.
pub async fn handle_tcp_connection(
mut stream: TcpStream,
addr: SocketAddr,
config: ServerConfig,
) -> Result<(), DnsError> {
// Read the 2-byte length prefix
let mut len_buf = [0u8; 2];
stream.read_exact(&mut len_buf).await?;
let len = u16::from_be_bytes(len_buf) as usize;
// Read the DNS query
let mut query = vec![0u8; len];
stream.read_exact(&mut query).await?;
if query.len() < 12 {
debug!("Received malformed TCP query from {}", addr);
return Ok(());
}
let opcode = (query[2] & 0x78) >> 3;
if opcode != 0 {
if let Some(response) = build_not_implemented_response(&query, config.authoritative) {
send_tcp_response(&mut stream, &response).await?;
}
return Ok(());
}
let domain = match extract_domain(&query) {
Some(d) => d,
None => {
info!("Failed to extract domain from TCP query");
return Ok(());
}
};
debug!("TCP query for {} from {}", domain, addr);
info!("Processing TCP query for domain: {}", domain);
let response = match generate_dns_response(&query, domain.clone(), &config).await {
Ok(resp) => resp,
Err(_) => {
build_nxdomain_response(&query, config.authoritative)
.ok_or(DnsError::Protocol("NXDOMAIN".into()))?
}
};
// Send the response (local/cache answer)
send_tcp_response(&mut stream, &response).await?;
Ok(())
}
+23
View File
@@ -0,0 +1,23 @@
//! NX9 DNS Server Library
//!
//! This library provides functionality for a DNS server implementation.
//! It handles DNS queries over UDP and TCP, supports various record types,
//! and can forward queries to upstream DNS servers.
#![allow(dead_code)]
#[allow(unused_variables)]
// Define modules
pub mod errors;
pub mod config;
pub mod cache;
pub mod db;
pub mod dns;
pub mod handlers;
pub mod utils;
mod error;
// Re-export commonly used items
pub use errors::DnsError;
pub use config::ServerConfig;
pub use cache::DnsCache;
+69
View File
@@ -0,0 +1,69 @@
//! NX9 DNS Server
//!
//! A DNS server implementation that supports various record types and can forward
//! queries to upstream DNS servers.
//!
//! Author: Sunil Purushottam Thakare
#![allow(dead_code)]
#[allow(unused_variables)]
use log::info;
use tokio::{signal, task};
use nx9_dns_server::{
cache::{CACHE, CACHE_CLEANUP_INTERVAL},
config::ServerConfig,
db::init_db,
errors::DnsError,
handlers::{run_tcp_server, run_udp_server},
};
#[tokio::main]
async fn main() -> Result<(), DnsError> {
// Initialize the logger
env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info"))
.format_timestamp_micros()
.init();
// Load configuration from environment variables
let config = ServerConfig::from_env()?;
// Initialize cache with NS records from config
let cache = CACHE.get_or_init(|| nx9_dns_server::cache::DnsCache::new(config.ns_records.clone()));
// Initialize the database
init_db(&config.db_path, &config.default_domain, &config.default_ip)?;
// Set up cache cleanup task
let cache_cleanup = task::spawn({
let cache = cache.clone();
async move {
let mut interval = tokio::time::interval(CACHE_CLEANUP_INTERVAL);
loop {
interval.tick().await;
cache.cleanup();
}
}
});
// Set up shutdown signal handler
let shutdown_signal = async {
signal::ctrl_c().await.expect("Failed to listen for shutdown signal");
info!("Shutdown signal received");
};
// Start UDP and TCP servers
let udp_server = run_udp_server(config.clone());
let tcp_server = run_tcp_server(config.clone());
// Wait for either a shutdown signal or server error
tokio::select! {
_ = shutdown_signal => {
info!("Initiating graceful shutdown...");
cache_cleanup.abort();
Ok(())
},
res = udp_server => res,
res = tcp_server => res,
}
}
+427
View File
@@ -0,0 +1,427 @@
//! Utility functions for DNS operations.
//!
//! This module provides helper functions for parsing and encoding DNS data.
#![allow(dead_code)]
#[allow(unused_variables)]
use std::str;
use chrono::{NaiveDateTime, TimeZone, Utc};
use crate::errors::DnsError;
/// Extract the domain name from a DNS query packet.
///
/// # Arguments
/// * `query` - The DNS query packet.
///
/// # Returns
/// An `Option` containing the domain name if successfully extracted.
pub fn extract_domain(query: &[u8]) -> Option<String> {
if query.len() < 12 {
return None; // DNS header is 12 bytes
}
let mut pos = 12; // Start after header
let mut domain = String::new();
// Extract QNAME (domain)
loop {
if pos >= query.len() {
return None;
}
let len = query[pos] as usize;
if len == 0 {
break; // End of QNAME
}
pos += 1;
if pos + len > query.len() {
return None; // Invalid length
}
if !domain.is_empty() {
domain.push('.');
}
let label = match str::from_utf8(&query[pos..pos + len]) {
Ok(l) => l,
Err(_) => return None, // Invalid UTF-8
};
domain.push_str(label);
pos += len;
}
// Skip QTYPE and QCLASS (4 bytes)
pos += 4;
// Verify we have enough data for at least QTYPE/QCLASS
if pos > query.len() {
return None;
}
Some(domain)
}
/// Extract the query type from a DNS query packet.
///
/// # Arguments
/// * `query` - The DNS query packet.
///
/// # Returns
/// An `Option` containing the query type as a u16 if successfully extracted.
pub fn extract_query_type(query: &[u8]) -> Option<u16> {
if query.len() < 12 {
return None; // DNS header is 12 bytes
}
let mut pos = 12; // Start after header
// Skip QNAME
loop {
if pos >= query.len() {
return None;
}
let len = query[pos] as usize;
if len == 0 {
pos += 1;
break; // End of QNAME
}
pos += len + 1;
}
// Get QTYPE (2 bytes after QNAME)
if pos + 1 < query.len() {
Some(((query[pos] as u16) << 8) | query[pos + 1] as u16)
} else {
None
}
}
/// Encode a domain name in DNS wire format.
///
/// # Arguments
/// * `name` - The domain name to encode.
///
/// # Returns
/// A vector of bytes containing the encoded domain name.
pub fn encode_dns_name(name: &str) -> Vec<u8> {
let mut out = Vec::new();
for part in name.trim_end_matches('.').split('.') {
if part.len() > 63 {
continue; // Skip invalid labels
}
out.push(part.len() as u8);
out.extend_from_slice(part.as_bytes());
}
out.push(0); // Null terminator
out
}
/// Parse a signature time in YYYYMMDDHHMMSS format to seconds since epoch.
///
/// # Arguments
/// * `s` - The signature time string.
///
/// # Returns
/// A `Result` containing the parsed time as a u32 or an error.
pub fn parse_sig_time(s: &str) -> Result<u32, DnsError> {
let dt = NaiveDateTime::parse_from_str(s, "%Y%m%d%H%M%S")
.map_err(|e| DnsError::Config(format!("Invalid sigtime: {e}")))?;
Ok(Utc.from_utc_datetime(&dt).timestamp() as u32)
}
/// Check if a DNS query packet has an OPT record (EDNS).
///
/// # Arguments
/// * `query` - The DNS query packet.
///
/// # Returns
/// A boolean indicating whether the query has an OPT record.
pub fn has_opt_record(query: &[u8]) -> bool {
if query.len() < 12 {
return false;
}
// Get ARCOUNT (number of additional records)
let arcount = ((query[10] as u16) << 8) | query[11] as u16;
if arcount == 0 {
return false;
}
// Skip header
let mut pos = 12;
// Skip question section
// First skip QNAME
loop {
if pos >= query.len() {
return false;
}
let len = query[pos] as usize;
if len == 0 {
pos += 1;
break;
}
pos += len + 1;
}
// Skip QTYPE and QCLASS
pos += 4;
// Skip answer and authority sections
let ancount = ((query[6] as u16) << 8) | query[7] as u16;
let nscount = ((query[8] as u16) << 8) | query[9] as u16;
for _ in 0..(ancount + nscount) {
// Skip name
if pos >= query.len() {
return false;
}
// Handle compression pointers
if (query[pos] & 0xC0) == 0xC0 {
pos += 2; // Skip compression pointer
} else {
// Skip labels
loop {
if pos >= query.len() {
return false;
}
let len = query[pos] as usize;
if len == 0 {
pos += 1;
break;
}
pos += len + 1;
}
}
// Skip TYPE, CLASS, TTL, RDLENGTH, RDATA
if pos + 10 > query.len() {
return false;
}
let rdlength = ((query[pos + 8] as usize) << 8) | query[pos + 9] as usize;
pos += 10 + rdlength;
}
// Check additional records for OPT
for _ in 0..arcount {
if pos >= query.len() {
return false;
}
// OPT record has empty (root) name
if query[pos] == 0 {
// Check if TYPE is OPT (41)
if pos + 2 < query.len() && query[pos + 1] == 0 && query[pos + 2] == 41 {
return true;
}
}
// Skip this record
if pos + 10 >= query.len() { break; }
let rdlength = ((query[pos + 8] as usize) << 8) | query[pos + 9] as usize;
pos += 10 + rdlength;
}
false // No OPT record found
}
/// Extract the EDNS payload size from a DNS query packet.
///
/// # Arguments
/// * `query` - The DNS query packet.
///
/// # Returns
/// An `Option` containing the EDNS payload size if found.
pub fn extract_edns_payload_size(query: &[u8]) -> Option<u16> {
if query.len() < 12 {
return None;
}
// Get ARCOUNT (number of additional records)
let arcount = ((query[10] as u16) << 8) | query[11] as u16;
if arcount == 0 {
return None;
}
// Skip header
let mut pos = 12;
// Skip question section
// First skip QNAME
loop {
if pos >= query.len() {
return None;
}
let len = query[pos] as usize;
if len == 0 {
pos += 1;
break;
}
pos += len + 1;
}
// Skip QTYPE and QCLASS
pos += 4;
// Skip answer and authority sections
let ancount = ((query[6] as u16) << 8) | query[7] as u16;
let nscount = ((query[8] as u16) << 8) | query[9] as u16;
for _ in 0..(ancount + nscount) {
// Skip name
if pos >= query.len() {
return None;
}
// Handle compression pointers
if (query[pos] & 0xC0) == 0xC0 {
pos += 2; // Skip compression pointer
} else {
// Skip labels
loop {
if pos >= query.len() {
return None;
}
let len = query[pos] as usize;
if len == 0 {
pos += 1;
break;
}
pos += len + 1;
}
}
// Skip TYPE, CLASS, TTL, RDLENGTH, RDATA
if pos + 10 > query.len() {
return None;
}
let rdlength = ((query[pos + 8] as usize) << 8) | query[pos + 9] as usize;
pos += 10 + rdlength;
}
// Check additional records for OPT
for _ in 0..arcount {
if pos >= query.len() {
return None;
}
// OPT record has empty (root) name
if query[pos] == 0 {
// Check if TYPE is OPT (41)
if pos + 5 < query.len() && query[pos + 1] == 0 && query[pos + 2] == 41 {
// Extract UDP payload size (CLASS field in OPT record)
return Some(((query[pos + 3] as u16) << 8) | query[pos + 4] as u16);
}
}
// Skip this record
if pos + 10 >= query.len() { break; }
let rdlength = ((query[pos + 8] as usize) << 8) | query[pos + 9] as usize;
pos += 10 + rdlength;
}
None // No OPT record found
}
/// Extract the DO (DNSSEC OK) bit from a DNS query packet.
///
/// # Arguments
/// * `query` - The DNS query packet.
///
/// # Returns
/// A boolean indicating whether the DO bit is set.
pub fn extract_do_bit(query: &[u8]) -> bool {
if query.len() < 12 {
return false;
}
// Get ARCOUNT (number of additional records)
let arcount = ((query[10] as u16) << 8) | query[11] as u16;
if arcount == 0 {
return false;
}
// Skip header
let mut pos = 12;
// Skip question section
// First skip QNAME
loop {
if pos >= query.len() {
return false;
}
let len = query[pos] as usize;
if len == 0 {
pos += 1;
break;
}
pos += len + 1;
}
// Skip QTYPE and QCLASS
pos += 4;
// Skip answer and authority sections
let ancount = ((query[6] as u16) << 8) | query[7] as u16;
let nscount = ((query[8] as u16) << 8) | query[9] as u16;
for _ in 0..(ancount + nscount) {
// Skip name
if pos >= query.len() {
return false;
}
// Handle compression pointers
if (query[pos] & 0xC0) == 0xC0 {
pos += 2; // Skip compression pointer
} else {
// Skip labels
loop {
if pos >= query.len() {
return false;
}
let len = query[pos] as usize;
if len == 0 {
pos += 1;
break;
}
pos += len + 1;
}
}
// Skip TYPE, CLASS, TTL, RDLENGTH, RDATA
if pos + 10 > query.len() {
return false;
}
let rdlength = ((query[pos + 8] as usize) << 8) | query[pos + 9] as usize;
pos += 10 + rdlength;
}
// Check additional records for OPT
for _ in 0..arcount {
if pos >= query.len() {
return false;
}
// OPT record has empty (root) name
if query[pos] == 0 {
// Check if TYPE is OPT (41)
if pos + 7 < query.len() && query[pos + 1] == 0 && query[pos + 2] == 41 {
// Check DO bit (bit 15 of TTL field, which is used for flags in OPT)
return (query[pos + 6] & 0x80) != 0;
}
}
// Skip this record
if pos + 10 >= query.len() { break; }
let rdlength = ((query[pos + 8] as usize) << 8) | query[pos + 9] as usize;
pos += 10 + rdlength;
}
false // No OPT record found or no DO bit set
}
+13
View File
@@ -0,0 +1,13 @@
#!/bin/bash
export DNS_BIND=0.0.0.0:53
export DNS_ENABLE_IPV6=1
export DNS_MAX_PACKET_SIZE=4096
export DNS_DB_PATH=/var/nx9-dns-server/dns.db
export DNS_NS_RECORDS=ns1.yourdomain.tld.,ns2.yourdomain.tld.
export DNS_AUTHORITATIVE=1
export DNS_CACHE_TTL=300
export RUST_LOG=info
export DNS_DEFAULT_DOMAIN=yourdomain.tld
export DNS_DEFAULT_IP=<YOUR-PUBLIC-IP4>
exec /var/dns-server/nx9-dns_server