Compare commits
48 Commits
d49e6cb528
...
fix/empty-
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
713a2b7332 | ||
| 6ebc4ffa04 | |||
| b20e75459f | |||
| ee14bd01ae | |||
| 2835c2dc43 | |||
| 299a36660f | |||
| 02ca796085 | |||
|
|
2e3526986f | ||
| 55c6c21b5a | |||
|
|
2993911883 | ||
| 70fac87254 | |||
| 940f7c89da | |||
| 0eb57fc15b | |||
| 5739108dc7 | |||
| 54272c2be5 | |||
| 7d380aafa4 | |||
| b18d29d586 | |||
| e63241cc3c | |||
| 5ab217bfd2 | |||
| 518a2cc42e | |||
|
|
4cb81aac24 | ||
|
|
203b581704 | ||
| 8cfff5dcc8 | |||
|
|
d0220e5814 | ||
|
|
82fd68a41b | ||
|
|
f8d0dc4166 | ||
|
|
b162ca743b | ||
| 622acdb494 | |||
| 4d4f74d1b6 | |||
| 617270acba | |||
|
|
687027be53 | ||
|
|
54b00f3b2a | ||
|
|
3fcf203485 | ||
|
|
8770c942cb | ||
| 9ef0d35e81 | |||
|
|
9e4f194c4c | ||
|
|
0486dcfd07 | ||
|
|
1e04a29fbf | ||
|
|
04855d0e5f | ||
| e92d47f052 | |||
| 4394ea9376 | |||
| 59ae8cc14a | |||
| c9c5530f60 | |||
|
|
b2e8ffe5e9 | ||
|
|
ae936b3365 | ||
|
|
bf8c74c97a | ||
|
|
57cd228837 | ||
|
|
ab39e77015 |
6
.dockerignore
Normal file
6
.dockerignore
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
.git/
|
||||||
|
bin/
|
||||||
|
*.md
|
||||||
|
LICENSE
|
||||||
|
.editorconfig
|
||||||
|
.gitignore
|
||||||
12
.editorconfig
Normal file
12
.editorconfig
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
root = true
|
||||||
|
|
||||||
|
[*]
|
||||||
|
indent_style = space
|
||||||
|
indent_size = 4
|
||||||
|
end_of_line = lf
|
||||||
|
charset = utf-8
|
||||||
|
trim_trailing_whitespace = true
|
||||||
|
insert_final_newline = true
|
||||||
|
|
||||||
|
[Makefile]
|
||||||
|
indent_style = tab
|
||||||
9
.gitea/workflows/check.yml
Normal file
9
.gitea/workflows/check.yml
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
name: check
|
||||||
|
on: [push]
|
||||||
|
jobs:
|
||||||
|
check:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
# actions/checkout v4.2.2, 2026-02-28
|
||||||
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
|
||||||
|
- run: docker build .
|
||||||
68
CLAUDE.md
68
CLAUDE.md
@@ -1,68 +0,0 @@
|
|||||||
# Repository Rules
|
|
||||||
|
|
||||||
Last Updated 2026-01-08
|
|
||||||
|
|
||||||
These rules MUST be followed at all times, it is very important.
|
|
||||||
|
|
||||||
* Never use `git add -A` - add specific changes to a deliberate commit. A
|
|
||||||
commit should contain one change. After each change, make a commit with a
|
|
||||||
good one-line summary.
|
|
||||||
|
|
||||||
* NEVER modify the linter config without asking first.
|
|
||||||
|
|
||||||
* NEVER modify tests to exclude special cases or otherwise get them to pass
|
|
||||||
without asking first. In almost all cases, the code should be changed,
|
|
||||||
NOT the tests. If you think the test needs to be changed, make your case
|
|
||||||
for that and ask for permission to proceed, then stop. You need explicit
|
|
||||||
user approval to modify existing tests. (You do not need user approval
|
|
||||||
for writing NEW tests.)
|
|
||||||
|
|
||||||
* When linting, assume the linter config is CORRECT, and that each item
|
|
||||||
output by the linter is something that legitimately needs fixing in the
|
|
||||||
code.
|
|
||||||
|
|
||||||
* When running tests, use `make test`.
|
|
||||||
|
|
||||||
* Before commits, run `make check`. This runs `make lint` and `make test`
|
|
||||||
and `make check-fmt`. Any issues discovered MUST be resolved before
|
|
||||||
committing unless explicitly told otherwise.
|
|
||||||
|
|
||||||
* When fixing a bug, write a failing test for the bug FIRST. Add
|
|
||||||
appropriate logging to the test to ensure it is written correctly. Commit
|
|
||||||
that. Then go about fixing the bug until the test passes (without
|
|
||||||
modifying the test further). Then commit that.
|
|
||||||
|
|
||||||
* When adding a new feature, do the same - implement a test first (TDD). It
|
|
||||||
doesn't have to be super complex. Commit the test, then commit the
|
|
||||||
feature.
|
|
||||||
|
|
||||||
* When adding a new feature, use a feature branch. When the feature is
|
|
||||||
completely finished and the code is up to standards (passes `make check`)
|
|
||||||
then and only then can the feature branch be merged into `main` and the
|
|
||||||
branch deleted.
|
|
||||||
|
|
||||||
* Write godoc documentation comments for all exported types and functions as
|
|
||||||
you go along.
|
|
||||||
|
|
||||||
* ALWAYS be consistent in naming. If you name something one thing in one
|
|
||||||
place, name it the EXACT SAME THING in another place.
|
|
||||||
|
|
||||||
* Be descriptive and specific in naming. `wl` is bad;
|
|
||||||
`SourceHostWhitelist` is good. `ConnsPerHost` is bad;
|
|
||||||
`MaxConnectionsPerHost` is good.
|
|
||||||
|
|
||||||
* This is not prototype or teaching code - this is designed for production.
|
|
||||||
Any security issues (such as denial of service) or other web
|
|
||||||
vulnerabilities are P1 bugs and must be added to TODO.md at the top.
|
|
||||||
|
|
||||||
* As this is production code, no stubbing of implementations unless
|
|
||||||
specifically instructed. We need working implementations.
|
|
||||||
|
|
||||||
* Avoid vendoring deps unless specifically instructed to. NEVER commit
|
|
||||||
the vendor directory, NEVER commit compiled binaries. If these
|
|
||||||
directories or files exist, add them to .gitignore (and commit the
|
|
||||||
.gitignore) if they are not already in there. Keep the entire git
|
|
||||||
repository (with history) small - under 20MiB, unless you specifically
|
|
||||||
must commit larger files (e.g. test fixture example media files). Only
|
|
||||||
OUR source code and immediately supporting files (such as test examples)
|
|
||||||
goes into the repo/history.
|
|
||||||
1225
CONVENTIONS.md
1225
CONVENTIONS.md
File diff suppressed because it is too large
Load Diff
15
Dockerfile
15
Dockerfile
@@ -1,11 +1,13 @@
|
|||||||
# Build stage
|
# Build stage
|
||||||
FROM golang:1.25-alpine AS builder
|
# golang 1.25-alpine, 2026-02-28
|
||||||
|
FROM golang@sha256:f6751d823c26342f9506c03797d2527668d095b0a15f1862cddb4d927a7a4ced AS builder
|
||||||
|
|
||||||
RUN apk add --no-cache git make gcc musl-dev
|
RUN apk add --no-cache git make gcc musl-dev binutils-gold
|
||||||
|
|
||||||
# Install golangci-lint v2
|
# golangci-lint v2.10.1
|
||||||
RUN go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@latest
|
RUN go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@5d1e709b7be35cb2025444e19de266b056b7b7ee
|
||||||
RUN go install golang.org/x/tools/cmd/goimports@latest
|
# goimports v0.42.0
|
||||||
|
RUN go install golang.org/x/tools/cmd/goimports@009367f5c17a8d4c45a961a3a509277190a9a6f0
|
||||||
|
|
||||||
WORKDIR /src
|
WORKDIR /src
|
||||||
COPY go.mod go.sum ./
|
COPY go.mod go.sum ./
|
||||||
@@ -20,7 +22,8 @@ RUN make check
|
|||||||
RUN make build
|
RUN make build
|
||||||
|
|
||||||
# Runtime stage
|
# Runtime stage
|
||||||
FROM alpine:3.21
|
# alpine 3.21, 2026-02-28
|
||||||
|
FROM alpine@sha256:c3f8e73fdb79deaebaa2037150150191b9dcbfba68b4a46d70103204c53f4709
|
||||||
|
|
||||||
RUN apk add --no-cache ca-certificates tzdata
|
RUN apk add --no-cache ca-certificates tzdata
|
||||||
|
|
||||||
|
|||||||
18
Makefile
18
Makefile
@@ -1,4 +1,4 @@
|
|||||||
.PHONY: all build lint fmt test check clean
|
.PHONY: all build lint fmt fmt-check test check clean hooks docker
|
||||||
|
|
||||||
BINARY := dnswatcher
|
BINARY := dnswatcher
|
||||||
VERSION := $(shell git describe --tags --always --dirty 2>/dev/null || echo "dev")
|
VERSION := $(shell git describe --tags --always --dirty 2>/dev/null || echo "dev")
|
||||||
@@ -17,8 +17,11 @@ fmt:
|
|||||||
gofmt -s -w .
|
gofmt -s -w .
|
||||||
goimports -w .
|
goimports -w .
|
||||||
|
|
||||||
|
fmt-check:
|
||||||
|
@test -z "$$(gofmt -l .)" || (echo "gofmt: files not formatted:" && gofmt -l . && exit 1)
|
||||||
|
|
||||||
test:
|
test:
|
||||||
go test -v -race -cover ./...
|
go test -v -race -timeout 30s -cover ./...
|
||||||
|
|
||||||
# Check runs all validation without making changes
|
# Check runs all validation without making changes
|
||||||
# Used by CI and Docker build - fails if anything is wrong
|
# Used by CI and Docker build - fails if anything is wrong
|
||||||
@@ -28,10 +31,19 @@ check:
|
|||||||
@echo "==> Running linter..."
|
@echo "==> Running linter..."
|
||||||
golangci-lint run --config .golangci.yml ./...
|
golangci-lint run --config .golangci.yml ./...
|
||||||
@echo "==> Running tests..."
|
@echo "==> Running tests..."
|
||||||
go test -v -race ./...
|
go test -v -race -timeout 30s ./...
|
||||||
@echo "==> Building..."
|
@echo "==> Building..."
|
||||||
go build -ldflags "$(LDFLAGS)" -o /dev/null ./cmd/dnswatcher
|
go build -ldflags "$(LDFLAGS)" -o /dev/null ./cmd/dnswatcher
|
||||||
@echo "==> All checks passed!"
|
@echo "==> All checks passed!"
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
rm -rf bin/
|
rm -rf bin/
|
||||||
|
|
||||||
|
hooks:
|
||||||
|
@echo '#!/bin/sh' > .git/hooks/pre-commit
|
||||||
|
@echo 'make check' >> .git/hooks/pre-commit
|
||||||
|
@chmod +x .git/hooks/pre-commit
|
||||||
|
@echo "Pre-commit hook installed."
|
||||||
|
|
||||||
|
docker:
|
||||||
|
docker build .
|
||||||
|
|||||||
38
README.md
38
README.md
@@ -1,9 +1,10 @@
|
|||||||
# dnswatcher
|
# dnswatcher
|
||||||
|
|
||||||
|
dnswatcher is a pre-1.0 Go daemon by [@sneak](https://sneak.berlin) that monitors DNS records, TCP port availability, and TLS certificates, delivering real-time change notifications via Slack, Mattermost, and ntfy webhooks.
|
||||||
|
|
||||||
> ⚠️ Pre-1.0 software. APIs, configuration, and behavior may change without notice.
|
> ⚠️ Pre-1.0 software. APIs, configuration, and behavior may change without notice.
|
||||||
|
|
||||||
dnswatcher is a production DNS and infrastructure monitoring daemon written in
|
dnswatcher watches configured DNS domains and hostnames for changes, monitors TCP
|
||||||
Go. It watches configured DNS domains and hostnames for changes, monitors TCP
|
|
||||||
port availability, tracks TLS certificate expiry, and delivers real-time
|
port availability, tracks TLS certificate expiry, and delivers real-time
|
||||||
notifications via Slack, Mattermost, and/or ntfy webhooks.
|
notifications via Slack, Mattermost, and/or ntfy webhooks.
|
||||||
|
|
||||||
@@ -109,8 +110,8 @@ includes:
|
|||||||
- **NS recoveries**: Which nameserver recovered, which hostname/domain.
|
- **NS recoveries**: Which nameserver recovered, which hostname/domain.
|
||||||
- **NS inconsistencies**: Which nameservers disagree, what each one
|
- **NS inconsistencies**: Which nameservers disagree, what each one
|
||||||
returned, which hostname affected.
|
returned, which hostname affected.
|
||||||
- **Port changes**: Which IP:port, old state, new state, associated
|
- **Port changes**: Which IP:port, old state, new state, all associated
|
||||||
hostname.
|
hostnames.
|
||||||
- **TLS expiry warnings**: Which certificate, days remaining, CN,
|
- **TLS expiry warnings**: Which certificate, days remaining, CN,
|
||||||
issuer, associated hostname and IP.
|
issuer, associated hostname and IP.
|
||||||
- **TLS certificate changes**: Old and new CN/issuer/SANs, associated
|
- **TLS certificate changes**: Old and new CN/issuer/SANs, associated
|
||||||
@@ -289,12 +290,12 @@ not as a merged view, to enable inconsistency detection.
|
|||||||
"ports": {
|
"ports": {
|
||||||
"93.184.216.34:80": {
|
"93.184.216.34:80": {
|
||||||
"open": true,
|
"open": true,
|
||||||
"hostname": "www.example.com",
|
"hostnames": ["www.example.com"],
|
||||||
"lastChecked": "2026-02-19T12:00:00Z"
|
"lastChecked": "2026-02-19T12:00:00Z"
|
||||||
},
|
},
|
||||||
"93.184.216.34:443": {
|
"93.184.216.34:443": {
|
||||||
"open": true,
|
"open": true,
|
||||||
"hostname": "www.example.com",
|
"hostnames": ["www.example.com"],
|
||||||
"lastChecked": "2026-02-19T12:00:00Z"
|
"lastChecked": "2026-02-19T12:00:00Z"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@@ -366,9 +367,15 @@ docker run -d \
|
|||||||
triggering change notifications).
|
triggering change notifications).
|
||||||
2. **Initial check**: Immediately perform all DNS, port, and TLS checks
|
2. **Initial check**: Immediately perform all DNS, port, and TLS checks
|
||||||
on startup.
|
on startup.
|
||||||
3. **Periodic checks**:
|
3. **Periodic checks** (DNS always runs first):
|
||||||
- DNS and port checks: every `DNSWATCHER_DNS_INTERVAL` (default 1h).
|
- DNS checks: every `DNSWATCHER_DNS_INTERVAL` (default 1h). Also
|
||||||
- TLS checks: every `DNSWATCHER_TLS_INTERVAL` (default 12h).
|
re-run before every TLS check cycle to ensure fresh IPs.
|
||||||
|
- Port checks: every `DNSWATCHER_DNS_INTERVAL`, after DNS completes.
|
||||||
|
- TLS checks: every `DNSWATCHER_TLS_INTERVAL` (default 12h), after
|
||||||
|
DNS completes.
|
||||||
|
- Port and TLS checks always use freshly resolved IP addresses from
|
||||||
|
the DNS phase that immediately precedes them — never stale IPs
|
||||||
|
from a previous cycle.
|
||||||
4. **On change detection**: Send notifications to all configured
|
4. **On change detection**: Send notifications to all configured
|
||||||
endpoints, update in-memory state, persist to disk.
|
endpoints, update in-memory state, persist to disk.
|
||||||
5. **Shutdown**: Persist final state to disk, complete in-flight
|
5. **Shutdown**: Persist final state to disk, complete in-flight
|
||||||
@@ -385,7 +392,18 @@ docker run -d \
|
|||||||
|
|
||||||
## Project Structure
|
## Project Structure
|
||||||
|
|
||||||
Follows the conventions defined in `CONVENTIONS.md`, adapted from the
|
Follows the conventions defined in `REPO_POLICIES.md`, adapted from the
|
||||||
[upaas](https://git.eeqj.de/sneak/upaas) project template. Uses uber/fx
|
[upaas](https://git.eeqj.de/sneak/upaas) project template. Uses uber/fx
|
||||||
for dependency injection, go-chi for HTTP routing, slog for logging, and
|
for dependency injection, go-chi for HTTP routing, slog for logging, and
|
||||||
Viper for configuration.
|
Viper for configuration.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
License has not yet been chosen for this project. Pending decision by the
|
||||||
|
author (MIT, GPL, or WTFPL).
|
||||||
|
|
||||||
|
## Author
|
||||||
|
|
||||||
|
[@sneak](https://sneak.berlin)
|
||||||
|
|||||||
188
REPO_POLICIES.md
Normal file
188
REPO_POLICIES.md
Normal file
@@ -0,0 +1,188 @@
|
|||||||
|
---
|
||||||
|
title: Repository Policies
|
||||||
|
last_modified: 2026-02-22
|
||||||
|
---
|
||||||
|
|
||||||
|
This document covers repository structure, tooling, and workflow standards. Code
|
||||||
|
style conventions are in separate documents:
|
||||||
|
|
||||||
|
- [Code Styleguide](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/CODE_STYLEGUIDE.md)
|
||||||
|
(general, bash, Docker)
|
||||||
|
- [Go](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/CODE_STYLEGUIDE_GO.md)
|
||||||
|
- [JavaScript](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/CODE_STYLEGUIDE_JS.md)
|
||||||
|
- [Python](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/CODE_STYLEGUIDE_PYTHON.md)
|
||||||
|
- [Go HTTP Server Conventions](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/GO_HTTP_SERVER_CONVENTIONS.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
- Cross-project documentation (such as this file) must include
|
||||||
|
`last_modified: YYYY-MM-DD` in the YAML front matter so it can be kept in sync
|
||||||
|
with the authoritative source as policies evolve.
|
||||||
|
|
||||||
|
- **ALL external references must be pinned by cryptographic hash.** This
|
||||||
|
includes Docker base images, Go modules, npm packages, GitHub Actions, and
|
||||||
|
anything else fetched from a remote source. Version tags (`@v4`, `@latest`,
|
||||||
|
`:3.21`, etc.) are server-mutable and therefore remote code execution
|
||||||
|
vulnerabilities. The ONLY acceptable way to reference an external dependency
|
||||||
|
is by its content hash (Docker `@sha256:...`, Go module hash in `go.sum`, npm
|
||||||
|
integrity hash in lockfile, GitHub Actions `@<commit-sha>`). No exceptions.
|
||||||
|
This also means never `curl | bash` to install tools like pyenv, nvm, rustup,
|
||||||
|
etc. Instead, download a specific release archive from GitHub, verify its hash
|
||||||
|
(hardcoded in the Dockerfile or script), and only then install. Unverified
|
||||||
|
install scripts are arbitrary remote code execution. This is the single most
|
||||||
|
important rule in this document. Double-check every external reference in
|
||||||
|
every file before committing. There are zero exceptions to this rule.
|
||||||
|
|
||||||
|
- Every repo with software must have a root `Makefile` with these targets:
|
||||||
|
`make test`, `make lint`, `make fmt` (writes), `make fmt-check` (read-only),
|
||||||
|
`make check` (prereqs: `test`, `lint`, `fmt-check`), `make docker`, and
|
||||||
|
`make hooks` (installs pre-commit hook). A model Makefile is at
|
||||||
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/Makefile`.
|
||||||
|
|
||||||
|
- Always use Makefile targets (`make fmt`, `make test`, `make lint`, etc.)
|
||||||
|
instead of invoking the underlying tools directly. The Makefile is the single
|
||||||
|
source of truth for how these operations are run.
|
||||||
|
|
||||||
|
- The Makefile is authoritative documentation for how the repo is used. Beyond
|
||||||
|
the required targets above, it should have targets for every common operation:
|
||||||
|
running a local development server (`make run`, `make dev`), re-initializing
|
||||||
|
or migrating the database (`make db-reset`, `make migrate`), building
|
||||||
|
artifacts (`make build`), generating code, seeding data, or anything else a
|
||||||
|
developer would do regularly. If someone checks out the repo and types
|
||||||
|
`make<tab>`, they should see every meaningful operation available. A new
|
||||||
|
contributor should be able to understand the entire development workflow by
|
||||||
|
reading the Makefile.
|
||||||
|
|
||||||
|
- Every repo should have a `Dockerfile`. All Dockerfiles must run `make check`
|
||||||
|
as a build step so the build fails if the branch is not green. For non-server
|
||||||
|
repos, the Dockerfile should bring up a development environment and run
|
||||||
|
`make check`. For server repos, `make check` should run as an early build
|
||||||
|
stage before the final image is assembled.
|
||||||
|
|
||||||
|
- Every repo should have a Gitea Actions workflow (`.gitea/workflows/`) that
|
||||||
|
runs `docker build .` on push. Since the Dockerfile already runs `make check`,
|
||||||
|
a successful build implies all checks pass.
|
||||||
|
|
||||||
|
- Use platform-standard formatters: `black` for Python, `prettier` for
|
||||||
|
JS/CSS/Markdown/HTML, `go fmt` for Go. Always use default configuration with
|
||||||
|
two exceptions: four-space indents (except Go), and `proseWrap: always` for
|
||||||
|
Markdown (hard-wrap at 80 columns). Documentation and writing repos (Markdown,
|
||||||
|
HTML, CSS) should also have `.prettierrc` and `.prettierignore`.
|
||||||
|
|
||||||
|
- Pre-commit hook: `make check` if local testing is possible, otherwise
|
||||||
|
`make lint && make fmt-check`. The Makefile should provide a `make hooks`
|
||||||
|
target to install the pre-commit hook.
|
||||||
|
|
||||||
|
- All repos with software must have tests that run via the platform-standard
|
||||||
|
test framework (`go test`, `pytest`, `jest`/`vitest`, etc.). If no meaningful
|
||||||
|
tests exist yet, add the most minimal test possible — e.g. importing the
|
||||||
|
module under test to verify it compiles/parses. There is no excuse for
|
||||||
|
`make test` to be a no-op.
|
||||||
|
|
||||||
|
- `make test` must complete in under 20 seconds. Add a 30-second timeout in the
|
||||||
|
Makefile.
|
||||||
|
|
||||||
|
- Docker builds must complete in under 5 minutes.
|
||||||
|
|
||||||
|
- `make check` must not modify any files in the repo. Tests may use temporary
|
||||||
|
directories.
|
||||||
|
|
||||||
|
- `main` must always pass `make check`, no exceptions.
|
||||||
|
|
||||||
|
- Never commit secrets. `.env` files, credentials, API keys, and private keys
|
||||||
|
must be in `.gitignore`. No exceptions.
|
||||||
|
|
||||||
|
- `.gitignore` should be comprehensive from the start: OS files (`.DS_Store`),
|
||||||
|
editor files (`.swp`, `*~`), language build artifacts, and `node_modules/`.
|
||||||
|
Fetch the standard `.gitignore` from
|
||||||
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore` when setting up
|
||||||
|
a new repo.
|
||||||
|
|
||||||
|
- Never use `git add -A` or `git add .`. Always stage files explicitly by name.
|
||||||
|
|
||||||
|
- Never force-push to `main`.
|
||||||
|
|
||||||
|
- Make all changes on a feature branch. You can do whatever you want on a
|
||||||
|
feature branch.
|
||||||
|
|
||||||
|
- `.golangci.yml` is standardized and must _NEVER_ be modified by an agent, only
|
||||||
|
manually by the user. Fetch from
|
||||||
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml`.
|
||||||
|
|
||||||
|
- When pinning images or packages by hash, add a comment above the reference
|
||||||
|
with the version and date (YYYY-MM-DD).
|
||||||
|
|
||||||
|
- Use `yarn`, not `npm`.
|
||||||
|
|
||||||
|
- Write all dates as YYYY-MM-DD (ISO 8601).
|
||||||
|
|
||||||
|
- Simple projects should be configured with environment variables.
|
||||||
|
|
||||||
|
- Dockerized web services listen on port 8080 by default, overridable with
|
||||||
|
`PORT`.
|
||||||
|
|
||||||
|
- `README.md` is the primary documentation. Required sections:
|
||||||
|
- **Description**: First line must include the project name, purpose,
|
||||||
|
category (web server, SPA, CLI tool, etc.), license, and author. Example:
|
||||||
|
"µPaaS is an MIT-licensed Go web application by @sneak that receives
|
||||||
|
git-frontend webhooks and deploys applications via Docker in realtime."
|
||||||
|
- **Getting Started**: Copy-pasteable install/usage code block.
|
||||||
|
- **Rationale**: Why does this exist?
|
||||||
|
- **Design**: How is the program structured?
|
||||||
|
- **TODO**: Update meticulously, even between commits. When planning, put
|
||||||
|
the todo list in the README so a new agent can pick up where the last one
|
||||||
|
left off.
|
||||||
|
- **License**: MIT, GPL, or WTFPL. Ask the user for new projects. Include a
|
||||||
|
`LICENSE` file in the repo root and a License section in the README.
|
||||||
|
- **Author**: [@sneak](https://sneak.berlin).
|
||||||
|
|
||||||
|
- First commit of a new repo should contain only `README.md`.
|
||||||
|
|
||||||
|
- Go module root: `sneak.berlin/go/<name>`. Always run `go mod tidy` before
|
||||||
|
committing.
|
||||||
|
|
||||||
|
- Use SemVer.
|
||||||
|
|
||||||
|
- Database migrations live in `internal/db/migrations/` and must be embedded in
|
||||||
|
the binary.
|
||||||
|
- `000_migration.sql` — contains ONLY the creation of the migrations tracking
|
||||||
|
table itself. Nothing else.
|
||||||
|
- `001_schema.sql` — the full application schema.
|
||||||
|
- **Pre-1.0.0:** never add additional migration files (002, 003, etc.). There
|
||||||
|
is no installed base to migrate. Edit `001_schema.sql` directly.
|
||||||
|
- **Post-1.0.0:** add new numbered migration files for each schema change.
|
||||||
|
Never edit existing migrations after release.
|
||||||
|
|
||||||
|
- All repos should have an `.editorconfig` enforcing the project's indentation
|
||||||
|
settings.
|
||||||
|
|
||||||
|
- Avoid putting files in the repo root unless necessary. Root should contain
|
||||||
|
only project-level config files (`README.md`, `Makefile`, `Dockerfile`,
|
||||||
|
`LICENSE`, `.gitignore`, `.editorconfig`, `REPO_POLICIES.md`, and
|
||||||
|
language-specific config). Everything else goes in a subdirectory. Canonical
|
||||||
|
subdirectory names:
|
||||||
|
- `bin/` — executable scripts and tools
|
||||||
|
- `cmd/` — Go command entrypoints
|
||||||
|
- `configs/` — configuration templates and examples
|
||||||
|
- `deploy/` — deployment manifests (k8s, compose, terraform)
|
||||||
|
- `docs/` — documentation and markdown (README.md stays in root)
|
||||||
|
- `internal/` — Go internal packages
|
||||||
|
- `internal/db/migrations/` — database migrations
|
||||||
|
- `pkg/` — Go library packages
|
||||||
|
- `share/` — systemd units, data files
|
||||||
|
- `static/` — static assets (images, fonts, etc.)
|
||||||
|
- `web/` — web frontend source
|
||||||
|
|
||||||
|
- When setting up a new repo, files from the `prompts` repo may be used as
|
||||||
|
templates. Fetch them from
|
||||||
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/<path>`.
|
||||||
|
|
||||||
|
- New repos must contain at minimum:
|
||||||
|
- `README.md`, `.git`, `.gitignore`, `.editorconfig`
|
||||||
|
- `LICENSE`, `REPO_POLICIES.md` (copy from the `prompts` repo)
|
||||||
|
- `Makefile`
|
||||||
|
- `Dockerfile`, `.dockerignore`
|
||||||
|
- `.gitea/workflows/check.yml`
|
||||||
|
- Go: `go.mod`, `go.sum`, `.golangci.yml`
|
||||||
|
- JS: `package.json`, `yarn.lock`, `.prettierrc`, `.prettierignore`
|
||||||
|
- Python: `pyproject.toml`
|
||||||
34
TESTING.md
Normal file
34
TESTING.md
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
# Testing Policy
|
||||||
|
|
||||||
|
## DNS Resolution Tests
|
||||||
|
|
||||||
|
All resolver tests **MUST** use live queries against real DNS servers.
|
||||||
|
No mocking of the DNS client layer is permitted.
|
||||||
|
|
||||||
|
### Rationale
|
||||||
|
|
||||||
|
The resolver performs iterative resolution from root nameservers through
|
||||||
|
the full delegation chain. Mocked responses cannot faithfully represent
|
||||||
|
the variety of real-world DNS behavior (truncation, referrals, glue
|
||||||
|
records, DNSSEC, varied response times, EDNS, etc.). Testing against
|
||||||
|
real servers ensures the resolver works correctly in production.
|
||||||
|
|
||||||
|
### Constraints
|
||||||
|
|
||||||
|
- Tests hit real DNS infrastructure and require network access
|
||||||
|
- Test duration depends on network conditions; timeout tuning keeps
|
||||||
|
the suite within the 30-second target
|
||||||
|
- Query timeout is calibrated to 3× maximum antipodal RTT (~300ms)
|
||||||
|
plus processing margin
|
||||||
|
- Root server fan-out is limited to reduce parallel query load
|
||||||
|
- Flaky failures from transient network issues are acceptable and
|
||||||
|
should be investigated as potential resolver bugs, not papered over
|
||||||
|
with mocks or skip flags
|
||||||
|
|
||||||
|
### What NOT to do
|
||||||
|
|
||||||
|
- **Do not mock `DNSClient`** for resolver tests (the mock constructor
|
||||||
|
exists for unit-testing other packages that consume the resolver)
|
||||||
|
- **Do not add `-short` flags** to skip slow tests
|
||||||
|
- **Do not increase `-timeout`** to hide hanging queries
|
||||||
|
- **Do not modify linter configuration** to suppress findings
|
||||||
1
go.mod
1
go.mod
@@ -13,6 +13,7 @@ require (
|
|||||||
github.com/stretchr/testify v1.11.1
|
github.com/stretchr/testify v1.11.1
|
||||||
go.uber.org/fx v1.24.0
|
go.uber.org/fx v1.24.0
|
||||||
golang.org/x/net v0.50.0
|
golang.org/x/net v0.50.0
|
||||||
|
golang.org/x/sync v0.19.0
|
||||||
)
|
)
|
||||||
|
|
||||||
require (
|
require (
|
||||||
|
|||||||
@@ -15,6 +15,12 @@ import (
|
|||||||
"sneak.berlin/go/dnswatcher/internal/logger"
|
"sneak.berlin/go/dnswatcher/internal/logger"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// ErrNoTargets is returned when DNSWATCHER_TARGETS is empty or unset.
|
||||||
|
var ErrNoTargets = errors.New(
|
||||||
|
"no targets configured: set DNSWATCHER_TARGETS to a comma-separated " +
|
||||||
|
"list of DNS names to monitor",
|
||||||
|
)
|
||||||
|
|
||||||
// Default configuration values.
|
// Default configuration values.
|
||||||
const (
|
const (
|
||||||
defaultPort = 8080
|
defaultPort = 8080
|
||||||
@@ -118,25 +124,9 @@ func buildConfig(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
dnsInterval, err := time.ParseDuration(
|
domains, hostnames, err := classifyAndValidateTargets()
|
||||||
viper.GetString("DNS_INTERVAL"),
|
|
||||||
)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
dnsInterval = defaultDNSInterval
|
return nil, err
|
||||||
}
|
|
||||||
|
|
||||||
tlsInterval, err := time.ParseDuration(
|
|
||||||
viper.GetString("TLS_INTERVAL"),
|
|
||||||
)
|
|
||||||
if err != nil {
|
|
||||||
tlsInterval = defaultTLSInterval
|
|
||||||
}
|
|
||||||
|
|
||||||
domains, hostnames, err := ClassifyTargets(
|
|
||||||
parseCSV(viper.GetString("TARGETS")),
|
|
||||||
)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("invalid targets configuration: %w", err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
cfg := &Config{
|
cfg := &Config{
|
||||||
@@ -148,8 +138,8 @@ func buildConfig(
|
|||||||
SlackWebhook: viper.GetString("SLACK_WEBHOOK"),
|
SlackWebhook: viper.GetString("SLACK_WEBHOOK"),
|
||||||
MattermostWebhook: viper.GetString("MATTERMOST_WEBHOOK"),
|
MattermostWebhook: viper.GetString("MATTERMOST_WEBHOOK"),
|
||||||
NtfyTopic: viper.GetString("NTFY_TOPIC"),
|
NtfyTopic: viper.GetString("NTFY_TOPIC"),
|
||||||
DNSInterval: dnsInterval,
|
DNSInterval: parseDurationOrDefault("DNS_INTERVAL", defaultDNSInterval),
|
||||||
TLSInterval: tlsInterval,
|
TLSInterval: parseDurationOrDefault("TLS_INTERVAL", defaultTLSInterval),
|
||||||
TLSExpiryWarning: viper.GetInt("TLS_EXPIRY_WARNING"),
|
TLSExpiryWarning: viper.GetInt("TLS_EXPIRY_WARNING"),
|
||||||
SentryDSN: viper.GetString("SENTRY_DSN"),
|
SentryDSN: viper.GetString("SENTRY_DSN"),
|
||||||
MaintenanceMode: viper.GetBool("MAINTENANCE_MODE"),
|
MaintenanceMode: viper.GetBool("MAINTENANCE_MODE"),
|
||||||
@@ -162,6 +152,32 @@ func buildConfig(
|
|||||||
return cfg, nil
|
return cfg, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func classifyAndValidateTargets() ([]string, []string, error) {
|
||||||
|
domains, hostnames, err := ClassifyTargets(
|
||||||
|
parseCSV(viper.GetString("TARGETS")),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return nil, nil, fmt.Errorf(
|
||||||
|
"invalid targets configuration: %w", err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(domains) == 0 && len(hostnames) == 0 {
|
||||||
|
return nil, nil, ErrNoTargets
|
||||||
|
}
|
||||||
|
|
||||||
|
return domains, hostnames, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseDurationOrDefault(key string, fallback time.Duration) time.Duration {
|
||||||
|
d, err := time.ParseDuration(viper.GetString(key))
|
||||||
|
if err != nil {
|
||||||
|
return fallback
|
||||||
|
}
|
||||||
|
|
||||||
|
return d
|
||||||
|
}
|
||||||
|
|
||||||
func parseCSV(input string) []string {
|
func parseCSV(input string) []string {
|
||||||
if input == "" {
|
if input == "" {
|
||||||
return nil
|
return nil
|
||||||
|
|||||||
87
internal/config/config_test.go
Normal file
87
internal/config/config_test.go
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
package config_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"go.uber.org/fx"
|
||||||
|
|
||||||
|
"sneak.berlin/go/dnswatcher/internal/config"
|
||||||
|
"sneak.berlin/go/dnswatcher/internal/globals"
|
||||||
|
"sneak.berlin/go/dnswatcher/internal/logger"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestNewReturnsErrNoTargetsWhenEmpty(t *testing.T) {
|
||||||
|
// Cannot use t.Parallel() because t.Setenv modifies the process
|
||||||
|
// environment.
|
||||||
|
t.Setenv("DNSWATCHER_TARGETS", "")
|
||||||
|
t.Setenv("DNSWATCHER_DATA_DIR", t.TempDir())
|
||||||
|
|
||||||
|
var cfg *config.Config
|
||||||
|
|
||||||
|
app := fx.New(
|
||||||
|
fx.Provide(
|
||||||
|
func() *globals.Globals {
|
||||||
|
return &globals.Globals{
|
||||||
|
Appname: "dnswatcher-test-empty",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
logger.New,
|
||||||
|
config.New,
|
||||||
|
),
|
||||||
|
fx.Populate(&cfg),
|
||||||
|
fx.NopLogger,
|
||||||
|
)
|
||||||
|
|
||||||
|
err := app.Err()
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal(
|
||||||
|
"expected error when DNSWATCHER_TARGETS is empty, got nil",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !errors.Is(err, config.ErrNoTargets) {
|
||||||
|
t.Errorf("expected ErrNoTargets, got: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewSucceedsWithTargets(t *testing.T) {
|
||||||
|
// Cannot use t.Parallel() because t.Setenv modifies the process
|
||||||
|
// environment.
|
||||||
|
t.Setenv("DNSWATCHER_TARGETS", "example.com")
|
||||||
|
t.Setenv("DNSWATCHER_DATA_DIR", t.TempDir())
|
||||||
|
|
||||||
|
// Prevent loading a local config file by changing to a temp dir.
|
||||||
|
t.Chdir(t.TempDir())
|
||||||
|
|
||||||
|
var cfg *config.Config
|
||||||
|
|
||||||
|
app := fx.New(
|
||||||
|
fx.Provide(
|
||||||
|
func() *globals.Globals {
|
||||||
|
return &globals.Globals{
|
||||||
|
Appname: "dnswatcher-test-ok",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
logger.New,
|
||||||
|
config.New,
|
||||||
|
),
|
||||||
|
fx.Populate(&cfg),
|
||||||
|
fx.NopLogger,
|
||||||
|
)
|
||||||
|
|
||||||
|
err := app.Err()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf(
|
||||||
|
"expected no error with valid targets, got: %v",
|
||||||
|
err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(cfg.Domains) != 1 || cfg.Domains[0] != "example.com" {
|
||||||
|
t.Errorf(
|
||||||
|
"expected [example.com], got domains=%v",
|
||||||
|
cfg.Domains,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,4 +1,5 @@
|
|||||||
// Package notify provides notification delivery to Slack, Mattermost, and ntfy.
|
// Package notify provides notification delivery to Slack,
|
||||||
|
// Mattermost, and ntfy.
|
||||||
package notify
|
package notify
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -7,6 +8,7 @@ import (
|
|||||||
"encoding/json"
|
"encoding/json"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"io"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/url"
|
"net/url"
|
||||||
@@ -34,8 +36,66 @@ var (
|
|||||||
ErrMattermostFailed = errors.New(
|
ErrMattermostFailed = errors.New(
|
||||||
"mattermost notification failed",
|
"mattermost notification failed",
|
||||||
)
|
)
|
||||||
|
// ErrInvalidScheme is returned for disallowed URL schemes.
|
||||||
|
ErrInvalidScheme = errors.New("URL scheme not allowed")
|
||||||
|
// ErrMissingHost is returned when a URL has no host.
|
||||||
|
ErrMissingHost = errors.New("URL must have a host")
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// IsAllowedScheme checks if the URL scheme is permitted.
|
||||||
|
func IsAllowedScheme(scheme string) bool {
|
||||||
|
return scheme == "https" || scheme == "http"
|
||||||
|
}
|
||||||
|
|
||||||
|
// ValidateWebhookURL validates and sanitizes a webhook URL.
|
||||||
|
// It ensures the URL has an allowed scheme (http/https),
|
||||||
|
// a non-empty host, and returns a pre-parsed *url.URL
|
||||||
|
// reconstructed from validated components.
|
||||||
|
func ValidateWebhookURL(raw string) (*url.URL, error) {
|
||||||
|
u, err := url.ParseRequestURI(raw)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("invalid URL: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !IsAllowedScheme(u.Scheme) {
|
||||||
|
return nil, fmt.Errorf(
|
||||||
|
"%w: %s", ErrInvalidScheme, u.Scheme,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if u.Host == "" {
|
||||||
|
return nil, fmt.Errorf("%w", ErrMissingHost)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reconstruct from parsed components.
|
||||||
|
clean := &url.URL{
|
||||||
|
Scheme: u.Scheme,
|
||||||
|
Host: u.Host,
|
||||||
|
Path: u.Path,
|
||||||
|
RawQuery: u.RawQuery,
|
||||||
|
}
|
||||||
|
|
||||||
|
return clean, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// newRequest creates an http.Request from a pre-validated *url.URL.
|
||||||
|
// This avoids passing URL strings to http.NewRequestWithContext,
|
||||||
|
// which gosec flags as a potential SSRF vector.
|
||||||
|
func newRequest(
|
||||||
|
ctx context.Context,
|
||||||
|
method string,
|
||||||
|
target *url.URL,
|
||||||
|
body io.Reader,
|
||||||
|
) *http.Request {
|
||||||
|
return (&http.Request{
|
||||||
|
Method: method,
|
||||||
|
URL: target,
|
||||||
|
Host: target.Host,
|
||||||
|
Header: make(http.Header),
|
||||||
|
Body: io.NopCloser(body),
|
||||||
|
}).WithContext(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
// Params contains dependencies for Service.
|
// Params contains dependencies for Service.
|
||||||
type Params struct {
|
type Params struct {
|
||||||
fx.In
|
fx.In
|
||||||
@@ -47,7 +107,7 @@ type Params struct {
|
|||||||
// Service provides notification functionality.
|
// Service provides notification functionality.
|
||||||
type Service struct {
|
type Service struct {
|
||||||
log *slog.Logger
|
log *slog.Logger
|
||||||
client *http.Client
|
transport http.RoundTripper
|
||||||
config *config.Config
|
config *config.Config
|
||||||
ntfyURL *url.URL
|
ntfyURL *url.URL
|
||||||
slackWebhookURL *url.URL
|
slackWebhookURL *url.URL
|
||||||
@@ -61,32 +121,40 @@ func New(
|
|||||||
) (*Service, error) {
|
) (*Service, error) {
|
||||||
svc := &Service{
|
svc := &Service{
|
||||||
log: params.Logger.Get(),
|
log: params.Logger.Get(),
|
||||||
client: &http.Client{
|
transport: http.DefaultTransport,
|
||||||
Timeout: httpClientTimeout,
|
|
||||||
},
|
|
||||||
config: params.Config,
|
config: params.Config,
|
||||||
}
|
}
|
||||||
|
|
||||||
if params.Config.NtfyTopic != "" {
|
if params.Config.NtfyTopic != "" {
|
||||||
u, err := url.ParseRequestURI(params.Config.NtfyTopic)
|
u, err := ValidateWebhookURL(
|
||||||
|
params.Config.NtfyTopic,
|
||||||
|
)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("invalid ntfy topic URL: %w", err)
|
return nil, fmt.Errorf(
|
||||||
|
"invalid ntfy topic URL: %w", err,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
svc.ntfyURL = u
|
svc.ntfyURL = u
|
||||||
}
|
}
|
||||||
|
|
||||||
if params.Config.SlackWebhook != "" {
|
if params.Config.SlackWebhook != "" {
|
||||||
u, err := url.ParseRequestURI(params.Config.SlackWebhook)
|
u, err := ValidateWebhookURL(
|
||||||
|
params.Config.SlackWebhook,
|
||||||
|
)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("invalid slack webhook URL: %w", err)
|
return nil, fmt.Errorf(
|
||||||
|
"invalid slack webhook URL: %w", err,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
svc.slackWebhookURL = u
|
svc.slackWebhookURL = u
|
||||||
}
|
}
|
||||||
|
|
||||||
if params.Config.MattermostWebhook != "" {
|
if params.Config.MattermostWebhook != "" {
|
||||||
u, err := url.ParseRequestURI(params.Config.MattermostWebhook)
|
u, err := ValidateWebhookURL(
|
||||||
|
params.Config.MattermostWebhook,
|
||||||
|
)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf(
|
return nil, fmt.Errorf(
|
||||||
"invalid mattermost webhook URL: %w", err,
|
"invalid mattermost webhook URL: %w", err,
|
||||||
@@ -99,7 +167,8 @@ func New(
|
|||||||
return svc, nil
|
return svc, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// SendNotification sends a notification to all configured endpoints.
|
// SendNotification sends a notification to all configured
|
||||||
|
// endpoints.
|
||||||
func (svc *Service) SendNotification(
|
func (svc *Service) SendNotification(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
title, message, priority string,
|
title, message, priority string,
|
||||||
@@ -170,20 +239,20 @@ func (svc *Service) sendNtfy(
|
|||||||
"title", title,
|
"title", title,
|
||||||
)
|
)
|
||||||
|
|
||||||
request, err := http.NewRequestWithContext(
|
ctx, cancel := context.WithTimeout(
|
||||||
ctx,
|
ctx, httpClientTimeout,
|
||||||
http.MethodPost,
|
)
|
||||||
topicURL.String(),
|
defer cancel()
|
||||||
bytes.NewBufferString(message),
|
|
||||||
|
body := bytes.NewBufferString(message)
|
||||||
|
request := newRequest(
|
||||||
|
ctx, http.MethodPost, topicURL, body,
|
||||||
)
|
)
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("creating ntfy request: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
request.Header.Set("Title", title)
|
request.Header.Set("Title", title)
|
||||||
request.Header.Set("Priority", ntfyPriority(priority))
|
request.Header.Set("Priority", ntfyPriority(priority))
|
||||||
|
|
||||||
resp, err := svc.client.Do(request) //nolint:gosec // URL validated at Service construction time
|
resp, err := svc.transport.RoundTrip(request)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("sending ntfy request: %w", err)
|
return fmt.Errorf("sending ntfy request: %w", err)
|
||||||
}
|
}
|
||||||
@@ -192,7 +261,8 @@ func (svc *Service) sendNtfy(
|
|||||||
|
|
||||||
if resp.StatusCode >= httpStatusClientError {
|
if resp.StatusCode >= httpStatusClientError {
|
||||||
return fmt.Errorf(
|
return fmt.Errorf(
|
||||||
"%w: status %d", ErrNtfyFailed, resp.StatusCode,
|
"%w: status %d",
|
||||||
|
ErrNtfyFailed, resp.StatusCode,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -232,6 +302,11 @@ func (svc *Service) sendSlack(
|
|||||||
webhookURL *url.URL,
|
webhookURL *url.URL,
|
||||||
title, message, priority string,
|
title, message, priority string,
|
||||||
) error {
|
) error {
|
||||||
|
ctx, cancel := context.WithTimeout(
|
||||||
|
ctx, httpClientTimeout,
|
||||||
|
)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
svc.log.Debug(
|
svc.log.Debug(
|
||||||
"sending webhook notification",
|
"sending webhook notification",
|
||||||
"url", webhookURL.String(),
|
"url", webhookURL.String(),
|
||||||
@@ -250,22 +325,19 @@ func (svc *Service) sendSlack(
|
|||||||
|
|
||||||
body, err := json.Marshal(payload)
|
body, err := json.Marshal(payload)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("marshaling webhook payload: %w", err)
|
return fmt.Errorf(
|
||||||
|
"marshaling webhook payload: %w", err,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
request, err := http.NewRequestWithContext(
|
request := newRequest(
|
||||||
ctx,
|
ctx, http.MethodPost, webhookURL,
|
||||||
http.MethodPost,
|
|
||||||
webhookURL.String(),
|
|
||||||
bytes.NewBuffer(body),
|
bytes.NewBuffer(body),
|
||||||
)
|
)
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("creating webhook request: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
request.Header.Set("Content-Type", "application/json")
|
request.Header.Set("Content-Type", "application/json")
|
||||||
|
|
||||||
resp, err := svc.client.Do(request) //nolint:gosec // URL validated at Service construction time
|
resp, err := svc.transport.RoundTrip(request)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("sending webhook request: %w", err)
|
return fmt.Errorf("sending webhook request: %w", err)
|
||||||
}
|
}
|
||||||
|
|||||||
100
internal/notify/notify_test.go
Normal file
100
internal/notify/notify_test.go
Normal file
@@ -0,0 +1,100 @@
|
|||||||
|
package notify_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"sneak.berlin/go/dnswatcher/internal/notify"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestValidateWebhookURLValid(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
input string
|
||||||
|
wantURL string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "valid https URL",
|
||||||
|
input: "https://hooks.slack.com/T00/B00",
|
||||||
|
wantURL: "https://hooks.slack.com/T00/B00",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "valid http URL",
|
||||||
|
input: "http://localhost:8080/webhook",
|
||||||
|
wantURL: "http://localhost:8080/webhook",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "https with query",
|
||||||
|
input: "https://ntfy.sh/topic?auth=tok",
|
||||||
|
wantURL: "https://ntfy.sh/topic?auth=tok",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
got, err := notify.ValidateWebhookURL(tt.input)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got.String() != tt.wantURL {
|
||||||
|
t.Errorf(
|
||||||
|
"got %q, want %q",
|
||||||
|
got.String(), tt.wantURL,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestValidateWebhookURLInvalid(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
invalid := []struct {
|
||||||
|
name string
|
||||||
|
input string
|
||||||
|
}{
|
||||||
|
{"ftp scheme", "ftp://example.com/file"},
|
||||||
|
{"file scheme", "file:///etc/passwd"},
|
||||||
|
{"empty string", ""},
|
||||||
|
{"no scheme", "example.com/webhook"},
|
||||||
|
{"no host", "https:///path"},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range invalid {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
got, err := notify.ValidateWebhookURL(tt.input)
|
||||||
|
if err == nil {
|
||||||
|
t.Errorf(
|
||||||
|
"expected error for %q, got %v",
|
||||||
|
tt.input, got,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIsAllowedScheme(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
if !notify.IsAllowedScheme("https") {
|
||||||
|
t.Error("https should be allowed")
|
||||||
|
}
|
||||||
|
|
||||||
|
if !notify.IsAllowedScheme("http") {
|
||||||
|
t.Error("http should be allowed")
|
||||||
|
}
|
||||||
|
|
||||||
|
if notify.IsAllowedScheme("ftp") {
|
||||||
|
t.Error("ftp should not be allowed")
|
||||||
|
}
|
||||||
|
|
||||||
|
if notify.IsAllowedScheme("") {
|
||||||
|
t.Error("empty scheme should not be allowed")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -4,18 +4,39 @@ package portcheck
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
|
"net"
|
||||||
|
"strconv"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
"go.uber.org/fx"
|
"go.uber.org/fx"
|
||||||
|
"golang.org/x/sync/errgroup"
|
||||||
|
|
||||||
"sneak.berlin/go/dnswatcher/internal/logger"
|
"sneak.berlin/go/dnswatcher/internal/logger"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ErrNotImplemented indicates the port checker is not yet implemented.
|
const (
|
||||||
var ErrNotImplemented = errors.New(
|
minPort = 1
|
||||||
"port checker not yet implemented",
|
maxPort = 65535
|
||||||
|
defaultTimeout = 5 * time.Second
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// ErrInvalidPort is returned when a port number is outside
|
||||||
|
// the valid TCP range (1–65535).
|
||||||
|
var ErrInvalidPort = errors.New("invalid port number")
|
||||||
|
|
||||||
|
// PortResult holds the outcome of a single TCP port check.
|
||||||
|
type PortResult struct {
|
||||||
|
// Open indicates whether the port accepted a connection.
|
||||||
|
Open bool
|
||||||
|
// Error contains a description if the connection failed.
|
||||||
|
Error string
|
||||||
|
// Latency is the time taken for the TCP handshake.
|
||||||
|
Latency time.Duration
|
||||||
|
}
|
||||||
|
|
||||||
// Params contains dependencies for Checker.
|
// Params contains dependencies for Checker.
|
||||||
type Params struct {
|
type Params struct {
|
||||||
fx.In
|
fx.In
|
||||||
@@ -38,11 +59,145 @@ func New(
|
|||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// CheckPort tests TCP connectivity to the given address and port.
|
// NewStandalone creates a Checker without fx dependencies.
|
||||||
func (c *Checker) CheckPort(
|
func NewStandalone() *Checker {
|
||||||
_ context.Context,
|
return &Checker{
|
||||||
_ string,
|
log: slog.Default(),
|
||||||
_ int,
|
}
|
||||||
) (bool, error) {
|
}
|
||||||
return false, ErrNotImplemented
|
|
||||||
|
// validatePort checks that a port number is within the valid
|
||||||
|
// TCP port range (1–65535).
|
||||||
|
func validatePort(port int) error {
|
||||||
|
if port < minPort || port > maxPort {
|
||||||
|
return fmt.Errorf(
|
||||||
|
"%w: %d (must be between %d and %d)",
|
||||||
|
ErrInvalidPort, port, minPort, maxPort,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// CheckPort tests TCP connectivity to the given address and port.
|
||||||
|
// It uses a 5-second timeout unless the context has an earlier
|
||||||
|
// deadline.
|
||||||
|
func (c *Checker) CheckPort(
|
||||||
|
ctx context.Context,
|
||||||
|
address string,
|
||||||
|
port int,
|
||||||
|
) (*PortResult, error) {
|
||||||
|
err := validatePort(port)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
target := net.JoinHostPort(
|
||||||
|
address, strconv.Itoa(port),
|
||||||
|
)
|
||||||
|
|
||||||
|
timeout := defaultTimeout
|
||||||
|
|
||||||
|
deadline, hasDeadline := ctx.Deadline()
|
||||||
|
if hasDeadline {
|
||||||
|
remaining := time.Until(deadline)
|
||||||
|
if remaining < timeout {
|
||||||
|
timeout = remaining
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return c.checkConnection(ctx, target, timeout), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// CheckPorts tests TCP connectivity to multiple ports on the
|
||||||
|
// given address concurrently. It returns a map of port number
|
||||||
|
// to result.
|
||||||
|
func (c *Checker) CheckPorts(
|
||||||
|
ctx context.Context,
|
||||||
|
address string,
|
||||||
|
ports []int,
|
||||||
|
) (map[int]*PortResult, error) {
|
||||||
|
for _, port := range ports {
|
||||||
|
err := validatePort(port)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var mu sync.Mutex
|
||||||
|
|
||||||
|
results := make(map[int]*PortResult, len(ports))
|
||||||
|
|
||||||
|
g, ctx := errgroup.WithContext(ctx)
|
||||||
|
|
||||||
|
for _, port := range ports {
|
||||||
|
g.Go(func() error {
|
||||||
|
result, err := c.CheckPort(ctx, address, port)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf(
|
||||||
|
"checking port %d: %w", port, err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
mu.Lock()
|
||||||
|
results[port] = result
|
||||||
|
mu.Unlock()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
err := g.Wait()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return results, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// checkConnection performs the TCP dial and returns a result.
|
||||||
|
func (c *Checker) checkConnection(
|
||||||
|
ctx context.Context,
|
||||||
|
target string,
|
||||||
|
timeout time.Duration,
|
||||||
|
) *PortResult {
|
||||||
|
dialer := &net.Dialer{Timeout: timeout}
|
||||||
|
start := time.Now()
|
||||||
|
|
||||||
|
conn, dialErr := dialer.DialContext(ctx, "tcp", target)
|
||||||
|
latency := time.Since(start)
|
||||||
|
|
||||||
|
if dialErr != nil {
|
||||||
|
c.log.Debug(
|
||||||
|
"port check failed",
|
||||||
|
"target", target,
|
||||||
|
"error", dialErr.Error(),
|
||||||
|
)
|
||||||
|
|
||||||
|
return &PortResult{
|
||||||
|
Open: false,
|
||||||
|
Error: dialErr.Error(),
|
||||||
|
Latency: latency,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
closeErr := conn.Close()
|
||||||
|
if closeErr != nil {
|
||||||
|
c.log.Debug(
|
||||||
|
"closing connection",
|
||||||
|
"target", target,
|
||||||
|
"error", closeErr.Error(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
c.log.Debug(
|
||||||
|
"port check succeeded",
|
||||||
|
"target", target,
|
||||||
|
"latency", latency,
|
||||||
|
)
|
||||||
|
|
||||||
|
return &PortResult{
|
||||||
|
Open: true,
|
||||||
|
Latency: latency,
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
211
internal/portcheck/portcheck_test.go
Normal file
211
internal/portcheck/portcheck_test.go
Normal file
@@ -0,0 +1,211 @@
|
|||||||
|
package portcheck_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"sneak.berlin/go/dnswatcher/internal/portcheck"
|
||||||
|
)
|
||||||
|
|
||||||
|
func listenTCP(
|
||||||
|
t *testing.T,
|
||||||
|
) (net.Listener, int) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
lc := &net.ListenConfig{}
|
||||||
|
|
||||||
|
ln, err := lc.Listen(
|
||||||
|
context.Background(), "tcp", "127.0.0.1:0",
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to start listener: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
addr, ok := ln.Addr().(*net.TCPAddr)
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("unexpected address type")
|
||||||
|
}
|
||||||
|
|
||||||
|
return ln, addr.Port
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCheckPortOpen(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
ln, port := listenTCP(t)
|
||||||
|
|
||||||
|
defer func() { _ = ln.Close() }()
|
||||||
|
|
||||||
|
checker := portcheck.NewStandalone()
|
||||||
|
|
||||||
|
result, err := checker.CheckPort(
|
||||||
|
context.Background(), "127.0.0.1", port,
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !result.Open {
|
||||||
|
t.Error("expected port to be open")
|
||||||
|
}
|
||||||
|
|
||||||
|
if result.Error != "" {
|
||||||
|
t.Errorf("expected no error, got: %s", result.Error)
|
||||||
|
}
|
||||||
|
|
||||||
|
if result.Latency <= 0 {
|
||||||
|
t.Error("expected positive latency")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCheckPortClosed(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
ln, port := listenTCP(t)
|
||||||
|
_ = ln.Close()
|
||||||
|
|
||||||
|
checker := portcheck.NewStandalone()
|
||||||
|
|
||||||
|
result, err := checker.CheckPort(
|
||||||
|
context.Background(), "127.0.0.1", port,
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if result.Open {
|
||||||
|
t.Error("expected port to be closed")
|
||||||
|
}
|
||||||
|
|
||||||
|
if result.Error == "" {
|
||||||
|
t.Error("expected error message for closed port")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCheckPortContextCanceled(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
|
||||||
|
checker := portcheck.NewStandalone()
|
||||||
|
|
||||||
|
result, err := checker.CheckPort(ctx, "127.0.0.1", 1)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if result.Open {
|
||||||
|
t.Error("expected port to not be open")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCheckPortsMultiple(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
ln, openPort := listenTCP(t)
|
||||||
|
|
||||||
|
defer func() { _ = ln.Close() }()
|
||||||
|
|
||||||
|
ln2, closedPort := listenTCP(t)
|
||||||
|
_ = ln2.Close()
|
||||||
|
|
||||||
|
checker := portcheck.NewStandalone()
|
||||||
|
|
||||||
|
results, err := checker.CheckPorts(
|
||||||
|
context.Background(),
|
||||||
|
"127.0.0.1",
|
||||||
|
[]int{openPort, closedPort},
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(results) != 2 {
|
||||||
|
t.Fatalf(
|
||||||
|
"expected 2 results, got %d", len(results),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !results[openPort].Open {
|
||||||
|
t.Error("expected open port to be open")
|
||||||
|
}
|
||||||
|
|
||||||
|
if results[closedPort].Open {
|
||||||
|
t.Error("expected closed port to be closed")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCheckPortInvalidPorts(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
checker := portcheck.NewStandalone()
|
||||||
|
|
||||||
|
cases := []struct {
|
||||||
|
name string
|
||||||
|
port int
|
||||||
|
}{
|
||||||
|
{"zero", 0},
|
||||||
|
{"negative", -1},
|
||||||
|
{"too high", 65536},
|
||||||
|
{"very negative", -1000},
|
||||||
|
{"very high", 100000},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range cases {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
_, err := checker.CheckPort(
|
||||||
|
context.Background(), "127.0.0.1", tc.port,
|
||||||
|
)
|
||||||
|
if err == nil {
|
||||||
|
t.Errorf(
|
||||||
|
"expected error for port %d, got nil",
|
||||||
|
tc.port,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCheckPortsInvalidPort(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
checker := portcheck.NewStandalone()
|
||||||
|
|
||||||
|
_, err := checker.CheckPorts(
|
||||||
|
context.Background(),
|
||||||
|
"127.0.0.1",
|
||||||
|
[]int{80, 0, 443},
|
||||||
|
)
|
||||||
|
if err == nil {
|
||||||
|
t.Error("expected error for invalid port in list")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCheckPortLatencyReasonable(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
ln, port := listenTCP(t)
|
||||||
|
|
||||||
|
defer func() { _ = ln.Close() }()
|
||||||
|
|
||||||
|
checker := portcheck.NewStandalone()
|
||||||
|
|
||||||
|
result, err := checker.CheckPort(
|
||||||
|
context.Background(), "127.0.0.1", port,
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if result.Latency > time.Second {
|
||||||
|
t.Errorf(
|
||||||
|
"latency too high for localhost: %v",
|
||||||
|
result.Latency,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -4,11 +4,6 @@ import "errors"
|
|||||||
|
|
||||||
// Sentinel errors returned by the resolver.
|
// Sentinel errors returned by the resolver.
|
||||||
var (
|
var (
|
||||||
// ErrNotImplemented indicates a method is stubbed out.
|
|
||||||
ErrNotImplemented = errors.New(
|
|
||||||
"resolver not yet implemented",
|
|
||||||
)
|
|
||||||
|
|
||||||
// ErrNoNameservers is returned when no authoritative NS
|
// ErrNoNameservers is returned when no authoritative NS
|
||||||
// could be discovered for a domain.
|
// could be discovered for a domain.
|
||||||
ErrNoNameservers = errors.New(
|
ErrNoNameservers = errors.New(
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
queryTimeoutDuration = 5 * time.Second
|
queryTimeoutDuration = 2 * time.Second
|
||||||
maxRetries = 2
|
maxRetries = 2
|
||||||
maxDelegation = 20
|
maxDelegation = 20
|
||||||
timeoutMultiplier = 2
|
timeoutMultiplier = 2
|
||||||
@@ -227,7 +227,7 @@ func (r *Resolver) followDelegation(
|
|||||||
|
|
||||||
authNS := extractNSSet(resp.Ns)
|
authNS := extractNSSet(resp.Ns)
|
||||||
if len(authNS) == 0 {
|
if len(authNS) == 0 {
|
||||||
return r.resolveNSRecursive(ctx, domain)
|
return r.resolveNSIterative(ctx, domain)
|
||||||
}
|
}
|
||||||
|
|
||||||
glue := extractGlue(resp.Extra)
|
glue := extractGlue(resp.Extra)
|
||||||
@@ -291,60 +291,84 @@ func (r *Resolver) resolveNSIPs(
|
|||||||
return ips
|
return ips
|
||||||
}
|
}
|
||||||
|
|
||||||
// resolveNSRecursive queries for NS records using recursive
|
// resolveNSIterative queries for NS records using iterative
|
||||||
// resolution as a fallback for intercepted environments.
|
// resolution as a fallback when followDelegation finds no
|
||||||
func (r *Resolver) resolveNSRecursive(
|
// authoritative answer in the delegation chain.
|
||||||
|
func (r *Resolver) resolveNSIterative(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
domain string,
|
domain string,
|
||||||
) ([]string, error) {
|
) ([]string, error) {
|
||||||
domain = dns.Fqdn(domain)
|
|
||||||
msg := new(dns.Msg)
|
|
||||||
msg.SetQuestion(domain, dns.TypeNS)
|
|
||||||
msg.RecursionDesired = true
|
|
||||||
|
|
||||||
for _, ip := range rootServerList()[:3] {
|
|
||||||
if checkCtx(ctx) != nil {
|
if checkCtx(ctx) != nil {
|
||||||
return nil, ErrContextCanceled
|
return nil, ErrContextCanceled
|
||||||
}
|
}
|
||||||
|
|
||||||
addr := net.JoinHostPort(ip, "53")
|
domain = dns.Fqdn(domain)
|
||||||
|
servers := rootServerList()
|
||||||
|
|
||||||
resp, _, err := r.client.ExchangeContext(ctx, msg, addr)
|
for range maxDelegation {
|
||||||
|
if checkCtx(ctx) != nil {
|
||||||
|
return nil, ErrContextCanceled
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, err := r.queryServers(
|
||||||
|
ctx, servers, domain, dns.TypeNS,
|
||||||
|
)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
continue
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
nsNames := extractNSSet(resp.Answer)
|
nsNames := extractNSSet(resp.Answer)
|
||||||
if len(nsNames) > 0 {
|
if len(nsNames) > 0 {
|
||||||
return nsNames, nil
|
return nsNames, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Follow delegation.
|
||||||
|
authNS := extractNSSet(resp.Ns)
|
||||||
|
if len(authNS) == 0 {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
glue := extractGlue(resp.Extra)
|
||||||
|
nextServers := glueIPs(authNS, glue)
|
||||||
|
|
||||||
|
if len(nextServers) == 0 {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
servers = nextServers
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil, ErrNoNameservers
|
return nil, ErrNoNameservers
|
||||||
}
|
}
|
||||||
|
|
||||||
// resolveARecord resolves a hostname to IPv4 addresses.
|
// resolveARecord resolves a hostname to IPv4 addresses using
|
||||||
|
// iterative resolution through the delegation chain.
|
||||||
func (r *Resolver) resolveARecord(
|
func (r *Resolver) resolveARecord(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
hostname string,
|
hostname string,
|
||||||
) ([]string, error) {
|
) ([]string, error) {
|
||||||
hostname = dns.Fqdn(hostname)
|
|
||||||
msg := new(dns.Msg)
|
|
||||||
msg.SetQuestion(hostname, dns.TypeA)
|
|
||||||
msg.RecursionDesired = true
|
|
||||||
|
|
||||||
for _, ip := range rootServerList()[:3] {
|
|
||||||
if checkCtx(ctx) != nil {
|
if checkCtx(ctx) != nil {
|
||||||
return nil, ErrContextCanceled
|
return nil, ErrContextCanceled
|
||||||
}
|
}
|
||||||
|
|
||||||
addr := net.JoinHostPort(ip, "53")
|
hostname = dns.Fqdn(hostname)
|
||||||
|
servers := rootServerList()
|
||||||
|
|
||||||
resp, _, err := r.client.ExchangeContext(ctx, msg, addr)
|
for range maxDelegation {
|
||||||
if err != nil {
|
if checkCtx(ctx) != nil {
|
||||||
continue
|
return nil, ErrContextCanceled
|
||||||
}
|
}
|
||||||
|
|
||||||
|
resp, err := r.queryServers(
|
||||||
|
ctx, servers, hostname, dns.TypeA,
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf(
|
||||||
|
"resolving %s: %w", hostname, err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check for A records in the answer section.
|
||||||
var ips []string
|
var ips []string
|
||||||
|
|
||||||
for _, rr := range resp.Answer {
|
for _, rr := range resp.Answer {
|
||||||
@@ -356,6 +380,24 @@ func (r *Resolver) resolveARecord(
|
|||||||
if len(ips) > 0 {
|
if len(ips) > 0 {
|
||||||
return ips, nil
|
return ips, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Follow delegation if present.
|
||||||
|
authNS := extractNSSet(resp.Ns)
|
||||||
|
if len(authNS) == 0 {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
glue := extractGlue(resp.Extra)
|
||||||
|
nextServers := glueIPs(authNS, glue)
|
||||||
|
|
||||||
|
if len(nextServers) == 0 {
|
||||||
|
// Resolve NS IPs iteratively — but guard
|
||||||
|
// against infinite recursion by using only
|
||||||
|
// already-resolved servers.
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
servers = nextServers
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil, fmt.Errorf(
|
return nil, fmt.Errorf(
|
||||||
@@ -418,6 +460,23 @@ func (r *Resolver) QueryNameserver(
|
|||||||
return r.queryAllTypes(ctx, nsHostname, nsIPs[0], hostname)
|
return r.queryAllTypes(ctx, nsHostname, nsIPs[0], hostname)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// QueryNameserverIP queries a nameserver by its IP address directly,
|
||||||
|
// bypassing NS hostname resolution.
|
||||||
|
func (r *Resolver) QueryNameserverIP(
|
||||||
|
ctx context.Context,
|
||||||
|
nsHostname string,
|
||||||
|
nsIP string,
|
||||||
|
hostname string,
|
||||||
|
) (*NameserverResponse, error) {
|
||||||
|
if checkCtx(ctx) != nil {
|
||||||
|
return nil, ErrContextCanceled
|
||||||
|
}
|
||||||
|
|
||||||
|
hostname = dns.Fqdn(hostname)
|
||||||
|
|
||||||
|
return r.queryAllTypes(ctx, nsHostname, nsIP, hostname)
|
||||||
|
}
|
||||||
|
|
||||||
func (r *Resolver) queryAllTypes(
|
func (r *Resolver) queryAllTypes(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
nsHostname string,
|
nsHostname string,
|
||||||
@@ -445,6 +504,7 @@ func (r *Resolver) queryAllTypes(
|
|||||||
type queryState struct {
|
type queryState struct {
|
||||||
gotNXDomain bool
|
gotNXDomain bool
|
||||||
gotSERVFAIL bool
|
gotSERVFAIL bool
|
||||||
|
gotTimeout bool
|
||||||
hasRecords bool
|
hasRecords bool
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -482,6 +542,10 @@ func (r *Resolver) querySingleType(
|
|||||||
) {
|
) {
|
||||||
msg, err := r.queryDNS(ctx, nsIP, hostname, qtype)
|
msg, err := r.queryDNS(ctx, nsIP, hostname, qtype)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
if isTimeout(err) {
|
||||||
|
state.gotTimeout = true
|
||||||
|
}
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -519,12 +583,26 @@ func collectAnswerRecords(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// isTimeout checks whether an error is a network timeout.
|
||||||
|
func isTimeout(err error) bool {
|
||||||
|
var netErr net.Error
|
||||||
|
if errors.As(err, &netErr) {
|
||||||
|
return netErr.Timeout()
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
func classifyResponse(resp *NameserverResponse, state queryState) {
|
func classifyResponse(resp *NameserverResponse, state queryState) {
|
||||||
switch {
|
switch {
|
||||||
case state.gotNXDomain && !state.hasRecords:
|
case state.gotNXDomain && !state.hasRecords:
|
||||||
resp.Status = StatusNXDomain
|
resp.Status = StatusNXDomain
|
||||||
|
case state.gotTimeout && !state.hasRecords:
|
||||||
|
resp.Status = StatusTimeout
|
||||||
|
resp.Error = "all queries timed out"
|
||||||
case state.gotSERVFAIL && !state.hasRecords:
|
case state.gotSERVFAIL && !state.hasRecords:
|
||||||
resp.Status = StatusError
|
resp.Status = StatusError
|
||||||
|
resp.Error = "server returned SERVFAIL"
|
||||||
case !state.hasRecords && !state.gotNXDomain:
|
case !state.hasRecords && !state.gotNXDomain:
|
||||||
resp.Status = StatusNoData
|
resp.Status = StatusNoData
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ const (
|
|||||||
StatusError = "error"
|
StatusError = "error"
|
||||||
StatusNXDomain = "nxdomain"
|
StatusNXDomain = "nxdomain"
|
||||||
StatusNoData = "nodata"
|
StatusNoData = "nodata"
|
||||||
|
StatusTimeout = "timeout"
|
||||||
)
|
)
|
||||||
|
|
||||||
// MaxCNAMEDepth is the maximum CNAME chain depth to follow.
|
// MaxCNAMEDepth is the maximum CNAME chain depth to follow.
|
||||||
@@ -80,4 +81,3 @@ func NewFromLoggerWithClient(
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Method implementations are in iterative.go.
|
// Method implementations are in iterative.go.
|
||||||
|
|
||||||
|
|||||||
@@ -1,85 +0,0 @@
|
|||||||
//go:build integration
|
|
||||||
|
|
||||||
package resolver_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"log/slog"
|
|
||||||
"os"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
|
|
||||||
"sneak.berlin/go/dnswatcher/internal/resolver"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Integration tests hit real DNS servers. Run with:
|
|
||||||
// go test -tags integration -timeout 60s ./internal/resolver/
|
|
||||||
|
|
||||||
func newIntegrationResolver(t *testing.T) *resolver.Resolver {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
log := slog.New(slog.NewTextHandler(
|
|
||||||
os.Stderr,
|
|
||||||
&slog.HandlerOptions{Level: slog.LevelDebug},
|
|
||||||
))
|
|
||||||
|
|
||||||
return resolver.NewFromLogger(log)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIntegration_FindAuthoritativeNameservers(
|
|
||||||
t *testing.T,
|
|
||||||
) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
r := newIntegrationResolver(t)
|
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(
|
|
||||||
context.Background(), 30*time.Second,
|
|
||||||
)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
nameservers, err := r.FindAuthoritativeNameservers(
|
|
||||||
ctx, "example.com",
|
|
||||||
)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.NotEmpty(t, nameservers)
|
|
||||||
|
|
||||||
t.Logf("example.com NS: %v", nameservers)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIntegration_ResolveIPAddresses(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
r := newIntegrationResolver(t)
|
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(
|
|
||||||
context.Background(), 30*time.Second,
|
|
||||||
)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
// sneak.cloud is on Cloudflare
|
|
||||||
nameservers, err := r.FindAuthoritativeNameservers(
|
|
||||||
ctx, "sneak.cloud",
|
|
||||||
)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.NotEmpty(t, nameservers)
|
|
||||||
|
|
||||||
hasCloudflare := false
|
|
||||||
|
|
||||||
for _, ns := range nameservers {
|
|
||||||
if strings.Contains(ns, "cloudflare") {
|
|
||||||
hasCloudflare = true
|
|
||||||
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
assert.True(t, hasCloudflare,
|
|
||||||
"sneak.cloud should be on Cloudflare, got: %v",
|
|
||||||
nameservers,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -57,10 +57,49 @@ type HostnameState struct {
|
|||||||
// PortState holds the monitoring state for a port.
|
// PortState holds the monitoring state for a port.
|
||||||
type PortState struct {
|
type PortState struct {
|
||||||
Open bool `json:"open"`
|
Open bool `json:"open"`
|
||||||
Hostname string `json:"hostname"`
|
Hostnames []string `json:"hostnames"`
|
||||||
LastChecked time.Time `json:"lastChecked"`
|
LastChecked time.Time `json:"lastChecked"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// UnmarshalJSON implements custom unmarshaling to handle both
|
||||||
|
// the old single-hostname format and the new multi-hostname
|
||||||
|
// format for backward compatibility with existing state files.
|
||||||
|
func (ps *PortState) UnmarshalJSON(data []byte) error {
|
||||||
|
// Use an alias to prevent infinite recursion.
|
||||||
|
type portStateAlias struct {
|
||||||
|
Open bool `json:"open"`
|
||||||
|
Hostnames []string `json:"hostnames"`
|
||||||
|
LastChecked time.Time `json:"lastChecked"`
|
||||||
|
}
|
||||||
|
|
||||||
|
var alias portStateAlias
|
||||||
|
|
||||||
|
err := json.Unmarshal(data, &alias)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("unmarshaling port state: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
ps.Open = alias.Open
|
||||||
|
ps.Hostnames = alias.Hostnames
|
||||||
|
ps.LastChecked = alias.LastChecked
|
||||||
|
|
||||||
|
// If Hostnames is empty, try reading the old single-hostname
|
||||||
|
// format for backward compatibility.
|
||||||
|
if len(ps.Hostnames) == 0 {
|
||||||
|
var old struct {
|
||||||
|
Hostname string `json:"hostname"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Best-effort: ignore errors since the main unmarshal
|
||||||
|
// already succeeded.
|
||||||
|
if json.Unmarshal(data, &old) == nil && old.Hostname != "" {
|
||||||
|
ps.Hostnames = []string{old.Hostname}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// CertificateState holds TLS certificate monitoring state.
|
// CertificateState holds TLS certificate monitoring state.
|
||||||
type CertificateState struct {
|
type CertificateState struct {
|
||||||
CommonName string `json:"commonName"`
|
CommonName string `json:"commonName"`
|
||||||
@@ -156,8 +195,8 @@ func (s *State) Load() error {
|
|||||||
|
|
||||||
// Save writes the current state to disk atomically.
|
// Save writes the current state to disk atomically.
|
||||||
func (s *State) Save() error {
|
func (s *State) Save() error {
|
||||||
s.mu.RLock()
|
s.mu.Lock()
|
||||||
defer s.mu.RUnlock()
|
defer s.mu.Unlock()
|
||||||
|
|
||||||
s.snapshot.LastUpdated = time.Now().UTC()
|
s.snapshot.LastUpdated = time.Now().UTC()
|
||||||
|
|
||||||
@@ -263,6 +302,27 @@ func (s *State) GetPortState(key string) (*PortState, bool) {
|
|||||||
return ps, ok
|
return ps, ok
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// DeletePortState removes a port state entry.
|
||||||
|
func (s *State) DeletePortState(key string) {
|
||||||
|
s.mu.Lock()
|
||||||
|
defer s.mu.Unlock()
|
||||||
|
|
||||||
|
delete(s.snapshot.Ports, key)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetAllPortKeys returns all port state keys.
|
||||||
|
func (s *State) GetAllPortKeys() []string {
|
||||||
|
s.mu.RLock()
|
||||||
|
defer s.mu.RUnlock()
|
||||||
|
|
||||||
|
keys := make([]string, 0, len(s.snapshot.Ports))
|
||||||
|
for k := range s.snapshot.Ports {
|
||||||
|
keys = append(keys, k)
|
||||||
|
}
|
||||||
|
|
||||||
|
return keys
|
||||||
|
}
|
||||||
|
|
||||||
// SetCertificateState updates the state for a certificate.
|
// SetCertificateState updates the state for a certificate.
|
||||||
func (s *State) SetCertificateState(
|
func (s *State) SetCertificateState(
|
||||||
key string,
|
key string,
|
||||||
|
|||||||
67
internal/tlscheck/extractcertinfo_test.go
Normal file
67
internal/tlscheck/extractcertinfo_test.go
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
package tlscheck_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/tls"
|
||||||
|
"errors"
|
||||||
|
"net"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"sneak.berlin/go/dnswatcher/internal/tlscheck"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestCheckCertificateNoPeerCerts(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
lc := &net.ListenConfig{}
|
||||||
|
|
||||||
|
ln, err := lc.Listen(
|
||||||
|
context.Background(), "tcp", "127.0.0.1:0",
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
defer func() { _ = ln.Close() }()
|
||||||
|
|
||||||
|
addr, ok := ln.Addr().(*net.TCPAddr)
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("unexpected address type")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Accept and immediately close to cause TLS handshake failure.
|
||||||
|
go func() {
|
||||||
|
conn, err := ln.Accept()
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
_ = conn.Close()
|
||||||
|
}()
|
||||||
|
|
||||||
|
checker := tlscheck.NewStandalone(
|
||||||
|
tlscheck.WithTimeout(2*time.Second),
|
||||||
|
tlscheck.WithTLSConfig(&tls.Config{
|
||||||
|
InsecureSkipVerify: true, //nolint:gosec // test
|
||||||
|
MinVersion: tls.VersionTLS12,
|
||||||
|
}),
|
||||||
|
tlscheck.WithPort(addr.Port),
|
||||||
|
)
|
||||||
|
|
||||||
|
_, err = checker.CheckCertificate(
|
||||||
|
context.Background(), "127.0.0.1", "localhost",
|
||||||
|
)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error when server presents no certs")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestErrNoPeerCertificatesIsSentinel(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
err := tlscheck.ErrNoPeerCertificates
|
||||||
|
if !errors.Is(err, tlscheck.ErrNoPeerCertificates) {
|
||||||
|
t.Fatal("expected sentinel error to match")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -3,8 +3,12 @@ package tlscheck
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"crypto/tls"
|
||||||
"errors"
|
"errors"
|
||||||
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
|
"net"
|
||||||
|
"strconv"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"go.uber.org/fx"
|
"go.uber.org/fx"
|
||||||
@@ -12,11 +16,56 @@ import (
|
|||||||
"sneak.berlin/go/dnswatcher/internal/logger"
|
"sneak.berlin/go/dnswatcher/internal/logger"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ErrNotImplemented indicates the TLS checker is not yet implemented.
|
const (
|
||||||
var ErrNotImplemented = errors.New(
|
defaultTimeout = 10 * time.Second
|
||||||
"tls checker not yet implemented",
|
defaultPort = 443
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// ErrUnexpectedConnType indicates the connection was not a TLS
|
||||||
|
// connection.
|
||||||
|
var ErrUnexpectedConnType = errors.New(
|
||||||
|
"unexpected connection type",
|
||||||
|
)
|
||||||
|
|
||||||
|
// ErrNoPeerCertificates indicates the TLS connection had no peer
|
||||||
|
// certificates.
|
||||||
|
var ErrNoPeerCertificates = errors.New(
|
||||||
|
"no peer certificates",
|
||||||
|
)
|
||||||
|
|
||||||
|
// CertificateInfo holds information about a TLS certificate.
|
||||||
|
type CertificateInfo struct {
|
||||||
|
CommonName string
|
||||||
|
Issuer string
|
||||||
|
NotAfter time.Time
|
||||||
|
SubjectAlternativeNames []string
|
||||||
|
SerialNumber string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Option configures a Checker.
|
||||||
|
type Option func(*Checker)
|
||||||
|
|
||||||
|
// WithTimeout sets the connection timeout.
|
||||||
|
func WithTimeout(d time.Duration) Option {
|
||||||
|
return func(c *Checker) {
|
||||||
|
c.timeout = d
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithTLSConfig sets a custom TLS configuration.
|
||||||
|
func WithTLSConfig(cfg *tls.Config) Option {
|
||||||
|
return func(c *Checker) {
|
||||||
|
c.tlsConfig = cfg
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithPort sets the TLS port to connect to.
|
||||||
|
func WithPort(port int) Option {
|
||||||
|
return func(c *Checker) {
|
||||||
|
c.port = port
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Params contains dependencies for Checker.
|
// Params contains dependencies for Checker.
|
||||||
type Params struct {
|
type Params struct {
|
||||||
fx.In
|
fx.In
|
||||||
@@ -27,14 +76,9 @@ type Params struct {
|
|||||||
// Checker performs TLS certificate inspection.
|
// Checker performs TLS certificate inspection.
|
||||||
type Checker struct {
|
type Checker struct {
|
||||||
log *slog.Logger
|
log *slog.Logger
|
||||||
}
|
timeout time.Duration
|
||||||
|
tlsConfig *tls.Config
|
||||||
// CertificateInfo holds information about a TLS certificate.
|
port int
|
||||||
type CertificateInfo struct {
|
|
||||||
CommonName string
|
|
||||||
Issuer string
|
|
||||||
NotAfter time.Time
|
|
||||||
SubjectAlternativeNames []string
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// New creates a new TLS Checker instance.
|
// New creates a new TLS Checker instance.
|
||||||
@@ -44,15 +88,109 @@ func New(
|
|||||||
) (*Checker, error) {
|
) (*Checker, error) {
|
||||||
return &Checker{
|
return &Checker{
|
||||||
log: params.Logger.Get(),
|
log: params.Logger.Get(),
|
||||||
|
timeout: defaultTimeout,
|
||||||
|
port: defaultPort,
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// CheckCertificate connects to the given IP:port using SNI and
|
// NewStandalone creates a Checker without fx dependencies.
|
||||||
// returns certificate information.
|
func NewStandalone(opts ...Option) *Checker {
|
||||||
func (c *Checker) CheckCertificate(
|
checker := &Checker{
|
||||||
_ context.Context,
|
log: slog.Default(),
|
||||||
_ string,
|
timeout: defaultTimeout,
|
||||||
_ string,
|
port: defaultPort,
|
||||||
) (*CertificateInfo, error) {
|
}
|
||||||
return nil, ErrNotImplemented
|
|
||||||
|
for _, opt := range opts {
|
||||||
|
opt(checker)
|
||||||
|
}
|
||||||
|
|
||||||
|
return checker
|
||||||
|
}
|
||||||
|
|
||||||
|
// CheckCertificate connects to the given IP address using the
|
||||||
|
// specified SNI hostname and returns certificate information.
|
||||||
|
func (c *Checker) CheckCertificate(
|
||||||
|
ctx context.Context,
|
||||||
|
ipAddress string,
|
||||||
|
sniHostname string,
|
||||||
|
) (*CertificateInfo, error) {
|
||||||
|
target := net.JoinHostPort(
|
||||||
|
ipAddress, strconv.Itoa(c.port),
|
||||||
|
)
|
||||||
|
|
||||||
|
tlsCfg := c.buildTLSConfig(sniHostname)
|
||||||
|
dialer := &tls.Dialer{
|
||||||
|
NetDialer: &net.Dialer{Timeout: c.timeout},
|
||||||
|
Config: tlsCfg,
|
||||||
|
}
|
||||||
|
|
||||||
|
conn, err := dialer.DialContext(ctx, "tcp", target)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf(
|
||||||
|
"TLS dial to %s: %w", target, err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
defer func() {
|
||||||
|
closeErr := conn.Close()
|
||||||
|
if closeErr != nil {
|
||||||
|
c.log.Debug(
|
||||||
|
"closing TLS connection",
|
||||||
|
"target", target,
|
||||||
|
"error", closeErr.Error(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
tlsConn, ok := conn.(*tls.Conn)
|
||||||
|
if !ok {
|
||||||
|
return nil, fmt.Errorf(
|
||||||
|
"%s: %w", target, ErrUnexpectedConnType,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return c.extractCertInfo(tlsConn)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Checker) buildTLSConfig(
|
||||||
|
sniHostname string,
|
||||||
|
) *tls.Config {
|
||||||
|
if c.tlsConfig != nil {
|
||||||
|
cfg := c.tlsConfig.Clone()
|
||||||
|
cfg.ServerName = sniHostname
|
||||||
|
|
||||||
|
return cfg
|
||||||
|
}
|
||||||
|
|
||||||
|
return &tls.Config{
|
||||||
|
ServerName: sniHostname,
|
||||||
|
MinVersion: tls.VersionTLS12,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Checker) extractCertInfo(
|
||||||
|
conn *tls.Conn,
|
||||||
|
) (*CertificateInfo, error) {
|
||||||
|
state := conn.ConnectionState()
|
||||||
|
if len(state.PeerCertificates) == 0 {
|
||||||
|
return nil, ErrNoPeerCertificates
|
||||||
|
}
|
||||||
|
|
||||||
|
cert := state.PeerCertificates[0]
|
||||||
|
|
||||||
|
sans := make([]string, 0, len(cert.DNSNames)+len(cert.IPAddresses))
|
||||||
|
sans = append(sans, cert.DNSNames...)
|
||||||
|
|
||||||
|
for _, ip := range cert.IPAddresses {
|
||||||
|
sans = append(sans, ip.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
return &CertificateInfo{
|
||||||
|
CommonName: cert.Subject.CommonName,
|
||||||
|
Issuer: cert.Issuer.CommonName,
|
||||||
|
NotAfter: cert.NotAfter,
|
||||||
|
SubjectAlternativeNames: sans,
|
||||||
|
SerialNumber: cert.SerialNumber.String(),
|
||||||
|
}, nil
|
||||||
}
|
}
|
||||||
|
|||||||
169
internal/tlscheck/tlscheck_test.go
Normal file
169
internal/tlscheck/tlscheck_test.go
Normal file
@@ -0,0 +1,169 @@
|
|||||||
|
package tlscheck_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/tls"
|
||||||
|
"net"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"sneak.berlin/go/dnswatcher/internal/tlscheck"
|
||||||
|
)
|
||||||
|
|
||||||
|
func startTLSServer(
|
||||||
|
t *testing.T,
|
||||||
|
) (*httptest.Server, string, int) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
srv := httptest.NewTLSServer(
|
||||||
|
http.HandlerFunc(
|
||||||
|
func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
},
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
addr, ok := srv.Listener.Addr().(*net.TCPAddr)
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("unexpected address type")
|
||||||
|
}
|
||||||
|
|
||||||
|
return srv, addr.IP.String(), addr.Port
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCheckCertificateValid(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
srv, ip, port := startTLSServer(t)
|
||||||
|
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
checker := tlscheck.NewStandalone(
|
||||||
|
tlscheck.WithTimeout(5*time.Second),
|
||||||
|
tlscheck.WithTLSConfig(&tls.Config{
|
||||||
|
//nolint:gosec // test uses self-signed cert
|
||||||
|
InsecureSkipVerify: true,
|
||||||
|
}),
|
||||||
|
tlscheck.WithPort(port),
|
||||||
|
)
|
||||||
|
|
||||||
|
info, err := checker.CheckCertificate(
|
||||||
|
context.Background(), ip, "localhost",
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if info == nil {
|
||||||
|
t.Fatal("expected non-nil CertificateInfo")
|
||||||
|
}
|
||||||
|
|
||||||
|
if info.NotAfter.IsZero() {
|
||||||
|
t.Error("expected non-zero NotAfter")
|
||||||
|
}
|
||||||
|
|
||||||
|
if info.SerialNumber == "" {
|
||||||
|
t.Error("expected non-empty SerialNumber")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCheckCertificateConnectionRefused(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
lc := &net.ListenConfig{}
|
||||||
|
|
||||||
|
ln, err := lc.Listen(
|
||||||
|
context.Background(), "tcp", "127.0.0.1:0",
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to listen: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
addr, ok := ln.Addr().(*net.TCPAddr)
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("unexpected address type")
|
||||||
|
}
|
||||||
|
|
||||||
|
port := addr.Port
|
||||||
|
|
||||||
|
_ = ln.Close()
|
||||||
|
|
||||||
|
checker := tlscheck.NewStandalone(
|
||||||
|
tlscheck.WithTimeout(2*time.Second),
|
||||||
|
tlscheck.WithPort(port),
|
||||||
|
)
|
||||||
|
|
||||||
|
_, err = checker.CheckCertificate(
|
||||||
|
context.Background(), "127.0.0.1", "localhost",
|
||||||
|
)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for connection refused")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCheckCertificateContextCanceled(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
|
||||||
|
checker := tlscheck.NewStandalone(
|
||||||
|
tlscheck.WithTimeout(2*time.Second),
|
||||||
|
tlscheck.WithPort(1),
|
||||||
|
)
|
||||||
|
|
||||||
|
_, err := checker.CheckCertificate(
|
||||||
|
ctx, "127.0.0.1", "localhost",
|
||||||
|
)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for canceled context")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCheckCertificateTimeout(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
checker := tlscheck.NewStandalone(
|
||||||
|
tlscheck.WithTimeout(1*time.Millisecond),
|
||||||
|
tlscheck.WithPort(1),
|
||||||
|
)
|
||||||
|
|
||||||
|
_, err := checker.CheckCertificate(
|
||||||
|
context.Background(),
|
||||||
|
"192.0.2.1",
|
||||||
|
"example.com",
|
||||||
|
)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for timeout")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCheckCertificateSANs(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
srv, ip, port := startTLSServer(t)
|
||||||
|
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
checker := tlscheck.NewStandalone(
|
||||||
|
tlscheck.WithTimeout(5*time.Second),
|
||||||
|
tlscheck.WithTLSConfig(&tls.Config{
|
||||||
|
//nolint:gosec // test uses self-signed cert
|
||||||
|
InsecureSkipVerify: true,
|
||||||
|
}),
|
||||||
|
tlscheck.WithPort(port),
|
||||||
|
)
|
||||||
|
|
||||||
|
info, err := checker.CheckCertificate(
|
||||||
|
context.Background(), ip, "localhost",
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if info.CommonName == "" && len(info.SubjectAlternativeNames) == 0 {
|
||||||
|
t.Error("expected CN or SANs to be populated")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -4,6 +4,7 @@ package watcher
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
|
||||||
|
"sneak.berlin/go/dnswatcher/internal/portcheck"
|
||||||
"sneak.berlin/go/dnswatcher/internal/tlscheck"
|
"sneak.berlin/go/dnswatcher/internal/tlscheck"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -36,7 +37,7 @@ type PortChecker interface {
|
|||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
address string,
|
address string,
|
||||||
port int,
|
port int,
|
||||||
) (bool, error)
|
) (*portcheck.PortResult, error)
|
||||||
}
|
}
|
||||||
|
|
||||||
// TLSChecker inspects TLS certificates.
|
// TLSChecker inspects TLS certificates.
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ import (
|
|||||||
"log/slog"
|
"log/slog"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"go.uber.org/fx"
|
"go.uber.org/fx"
|
||||||
@@ -49,6 +50,8 @@ type Watcher struct {
|
|||||||
notify Notifier
|
notify Notifier
|
||||||
cancel context.CancelFunc
|
cancel context.CancelFunc
|
||||||
firstRun bool
|
firstRun bool
|
||||||
|
expiryNotifiedMu sync.Mutex
|
||||||
|
expiryNotified map[string]time.Time
|
||||||
}
|
}
|
||||||
|
|
||||||
// New creates a new Watcher instance wired into the fx lifecycle.
|
// New creates a new Watcher instance wired into the fx lifecycle.
|
||||||
@@ -65,16 +68,19 @@ func New(
|
|||||||
tlsCheck: params.TLSCheck,
|
tlsCheck: params.TLSCheck,
|
||||||
notify: params.Notify,
|
notify: params.Notify,
|
||||||
firstRun: true,
|
firstRun: true,
|
||||||
|
expiryNotified: make(map[string]time.Time),
|
||||||
}
|
}
|
||||||
|
|
||||||
lifecycle.Append(fx.Hook{
|
lifecycle.Append(fx.Hook{
|
||||||
OnStart: func(startCtx context.Context) error {
|
OnStart: func(_ context.Context) error {
|
||||||
ctx, cancel := context.WithCancel(
|
// Use context.Background() — the fx startup context
|
||||||
context.WithoutCancel(startCtx),
|
// expires after startup completes, so deriving from it
|
||||||
)
|
// would cancel the watcher immediately. The watcher's
|
||||||
|
// lifetime is controlled by w.cancel in OnStop.
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
w.cancel = cancel
|
w.cancel = cancel
|
||||||
|
|
||||||
go w.Run(ctx)
|
go w.Run(ctx) //nolint:contextcheck // intentionally not derived from startCtx
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
},
|
},
|
||||||
@@ -108,6 +114,7 @@ func NewForTest(
|
|||||||
tlsCheck: tc,
|
tlsCheck: tc,
|
||||||
notify: n,
|
notify: n,
|
||||||
firstRun: true,
|
firstRun: true,
|
||||||
|
expiryNotified: make(map[string]time.Time),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -136,9 +143,16 @@ func (w *Watcher) Run(ctx context.Context) {
|
|||||||
|
|
||||||
return
|
return
|
||||||
case <-dnsTicker.C:
|
case <-dnsTicker.C:
|
||||||
w.runDNSAndPortChecks(ctx)
|
w.runDNSChecks(ctx)
|
||||||
|
|
||||||
|
w.checkAllPorts(ctx)
|
||||||
w.saveState()
|
w.saveState()
|
||||||
case <-tlsTicker.C:
|
case <-tlsTicker.C:
|
||||||
|
// Run DNS first so TLS checks use freshly
|
||||||
|
// resolved IP addresses, not stale ones from
|
||||||
|
// a previous cycle.
|
||||||
|
w.runDNSChecks(ctx)
|
||||||
|
|
||||||
w.runTLSChecks(ctx)
|
w.runTLSChecks(ctx)
|
||||||
w.saveState()
|
w.saveState()
|
||||||
}
|
}
|
||||||
@@ -146,10 +160,26 @@ func (w *Watcher) Run(ctx context.Context) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// RunOnce performs a single complete monitoring cycle.
|
// RunOnce performs a single complete monitoring cycle.
|
||||||
|
// DNS checks run first so that port and TLS checks use
|
||||||
|
// freshly resolved IP addresses. Port checks run before
|
||||||
|
// TLS because TLS checks only target IPs with an open
|
||||||
|
// port 443.
|
||||||
func (w *Watcher) RunOnce(ctx context.Context) {
|
func (w *Watcher) RunOnce(ctx context.Context) {
|
||||||
w.detectFirstRun()
|
w.detectFirstRun()
|
||||||
w.runDNSAndPortChecks(ctx)
|
|
||||||
|
// Phase 1: DNS resolution must complete first so that
|
||||||
|
// subsequent checks use fresh IP addresses.
|
||||||
|
w.runDNSChecks(ctx)
|
||||||
|
|
||||||
|
// Phase 2: Port checks populate port state that TLS
|
||||||
|
// checks depend on (TLS only targets IPs where port
|
||||||
|
// 443 is open).
|
||||||
|
w.checkAllPorts(ctx)
|
||||||
|
|
||||||
|
// Phase 3: TLS checks use fresh DNS IPs and current
|
||||||
|
// port state.
|
||||||
w.runTLSChecks(ctx)
|
w.runTLSChecks(ctx)
|
||||||
|
|
||||||
w.saveState()
|
w.saveState()
|
||||||
w.firstRun = false
|
w.firstRun = false
|
||||||
}
|
}
|
||||||
@@ -166,7 +196,11 @@ func (w *Watcher) detectFirstRun() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *Watcher) runDNSAndPortChecks(ctx context.Context) {
|
// runDNSChecks performs DNS resolution for all configured domains
|
||||||
|
// and hostnames, updating state with freshly resolved records.
|
||||||
|
// This must complete before port or TLS checks run so those
|
||||||
|
// checks operate on current IP addresses.
|
||||||
|
func (w *Watcher) runDNSChecks(ctx context.Context) {
|
||||||
for _, domain := range w.config.Domains {
|
for _, domain := range w.config.Domains {
|
||||||
w.checkDomain(ctx, domain)
|
w.checkDomain(ctx, domain)
|
||||||
}
|
}
|
||||||
@@ -174,8 +208,6 @@ func (w *Watcher) runDNSAndPortChecks(ctx context.Context) {
|
|||||||
for _, hostname := range w.config.Hostnames {
|
for _, hostname := range w.config.Hostnames {
|
||||||
w.checkHostname(ctx, hostname)
|
w.checkHostname(ctx, hostname)
|
||||||
}
|
}
|
||||||
|
|
||||||
w.checkAllPorts(ctx)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *Watcher) checkDomain(
|
func (w *Watcher) checkDomain(
|
||||||
@@ -206,6 +238,28 @@ func (w *Watcher) checkDomain(
|
|||||||
Nameservers: nameservers,
|
Nameservers: nameservers,
|
||||||
LastChecked: now,
|
LastChecked: now,
|
||||||
})
|
})
|
||||||
|
|
||||||
|
// Also look up A/AAAA records for the apex domain so that
|
||||||
|
// port and TLS checks (which read HostnameState) can find
|
||||||
|
// the domain's IP addresses.
|
||||||
|
records, err := w.resolver.LookupAllRecords(ctx, domain)
|
||||||
|
if err != nil {
|
||||||
|
w.log.Error(
|
||||||
|
"failed to lookup records for domain",
|
||||||
|
"domain", domain,
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
prevHS, hasPrevHS := w.state.GetHostnameState(domain)
|
||||||
|
if hasPrevHS && !w.firstRun {
|
||||||
|
w.detectHostnameChanges(ctx, domain, prevHS, records)
|
||||||
|
}
|
||||||
|
|
||||||
|
newState := buildHostnameState(records, now)
|
||||||
|
w.state.SetHostnameState(domain, newState)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *Watcher) detectNSChanges(
|
func (w *Watcher) detectNSChanges(
|
||||||
@@ -421,24 +475,94 @@ func (w *Watcher) detectInconsistencies(
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (w *Watcher) checkAllPorts(ctx context.Context) {
|
func (w *Watcher) checkAllPorts(ctx context.Context) {
|
||||||
for _, hostname := range w.config.Hostnames {
|
// Phase 1: Build current IP:port → hostname associations
|
||||||
w.checkPortsForHostname(ctx, hostname)
|
// from fresh DNS data.
|
||||||
|
associations := w.buildPortAssociations()
|
||||||
|
|
||||||
|
// Phase 2: Check each unique IP:port and update state
|
||||||
|
// with the full set of associated hostnames.
|
||||||
|
for key, hostnames := range associations {
|
||||||
|
ip, port := parsePortKey(key)
|
||||||
|
if port == 0 {
|
||||||
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, domain := range w.config.Domains {
|
w.checkSinglePort(ctx, ip, port, hostnames)
|
||||||
w.checkPortsForHostname(ctx, domain)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Phase 3: Remove port state entries that no longer have
|
||||||
|
// any hostname referencing them.
|
||||||
|
w.cleanupStalePorts(associations)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *Watcher) checkPortsForHostname(
|
// buildPortAssociations constructs a map from IP:port keys to
|
||||||
ctx context.Context,
|
// the sorted set of hostnames currently resolving to that IP.
|
||||||
hostname string,
|
func (w *Watcher) buildPortAssociations() map[string][]string {
|
||||||
) {
|
assoc := make(map[string]map[string]bool)
|
||||||
ips := w.collectIPs(hostname)
|
|
||||||
|
|
||||||
|
allNames := make(
|
||||||
|
[]string, 0,
|
||||||
|
len(w.config.Hostnames)+len(w.config.Domains),
|
||||||
|
)
|
||||||
|
allNames = append(allNames, w.config.Hostnames...)
|
||||||
|
allNames = append(allNames, w.config.Domains...)
|
||||||
|
|
||||||
|
for _, name := range allNames {
|
||||||
|
ips := w.collectIPs(name)
|
||||||
for _, ip := range ips {
|
for _, ip := range ips {
|
||||||
for _, port := range monitoredPorts {
|
for _, port := range monitoredPorts {
|
||||||
w.checkSinglePort(ctx, ip, port, hostname)
|
key := fmt.Sprintf("%s:%d", ip, port)
|
||||||
|
if assoc[key] == nil {
|
||||||
|
assoc[key] = make(map[string]bool)
|
||||||
|
}
|
||||||
|
|
||||||
|
assoc[key][name] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
result := make(map[string][]string, len(assoc))
|
||||||
|
for key, set := range assoc {
|
||||||
|
hostnames := make([]string, 0, len(set))
|
||||||
|
for h := range set {
|
||||||
|
hostnames = append(hostnames, h)
|
||||||
|
}
|
||||||
|
|
||||||
|
sort.Strings(hostnames)
|
||||||
|
|
||||||
|
result[key] = hostnames
|
||||||
|
}
|
||||||
|
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
|
// parsePortKey splits an "ip:port" key into its components.
|
||||||
|
func parsePortKey(key string) (string, int) {
|
||||||
|
lastColon := strings.LastIndex(key, ":")
|
||||||
|
if lastColon < 0 {
|
||||||
|
return key, 0
|
||||||
|
}
|
||||||
|
|
||||||
|
ip := key[:lastColon]
|
||||||
|
|
||||||
|
var p int
|
||||||
|
|
||||||
|
_, err := fmt.Sscanf(key[lastColon+1:], "%d", &p)
|
||||||
|
if err != nil {
|
||||||
|
return ip, 0
|
||||||
|
}
|
||||||
|
|
||||||
|
return ip, p
|
||||||
|
}
|
||||||
|
|
||||||
|
// cleanupStalePorts removes port state entries that are no
|
||||||
|
// longer referenced by any hostname in the current DNS data.
|
||||||
|
func (w *Watcher) cleanupStalePorts(
|
||||||
|
currentAssociations map[string][]string,
|
||||||
|
) {
|
||||||
|
for _, key := range w.state.GetAllPortKeys() {
|
||||||
|
if _, exists := currentAssociations[key]; !exists {
|
||||||
|
w.state.DeletePortState(key)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -475,9 +599,9 @@ func (w *Watcher) checkSinglePort(
|
|||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
ip string,
|
ip string,
|
||||||
port int,
|
port int,
|
||||||
hostname string,
|
hostnames []string,
|
||||||
) {
|
) {
|
||||||
open, err := w.portCheck.CheckPort(ctx, ip, port)
|
result, err := w.portCheck.CheckPort(ctx, ip, port)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
w.log.Error(
|
w.log.Error(
|
||||||
"port check failed",
|
"port check failed",
|
||||||
@@ -493,15 +617,15 @@ func (w *Watcher) checkSinglePort(
|
|||||||
now := time.Now().UTC()
|
now := time.Now().UTC()
|
||||||
prev, hasPrev := w.state.GetPortState(key)
|
prev, hasPrev := w.state.GetPortState(key)
|
||||||
|
|
||||||
if hasPrev && !w.firstRun && prev.Open != open {
|
if hasPrev && !w.firstRun && prev.Open != result.Open {
|
||||||
stateStr := "closed"
|
stateStr := "closed"
|
||||||
if open {
|
if result.Open {
|
||||||
stateStr = "open"
|
stateStr = "open"
|
||||||
}
|
}
|
||||||
|
|
||||||
msg := fmt.Sprintf(
|
msg := fmt.Sprintf(
|
||||||
"Host: %s\nAddress: %s\nPort now %s",
|
"Hosts: %s\nAddress: %s\nPort now %s",
|
||||||
hostname, key, stateStr,
|
strings.Join(hostnames, ", "), key, stateStr,
|
||||||
)
|
)
|
||||||
|
|
||||||
w.notify.SendNotification(
|
w.notify.SendNotification(
|
||||||
@@ -513,8 +637,8 @@ func (w *Watcher) checkSinglePort(
|
|||||||
}
|
}
|
||||||
|
|
||||||
w.state.SetPortState(key, &state.PortState{
|
w.state.SetPortState(key, &state.PortState{
|
||||||
Open: open,
|
Open: result.Open,
|
||||||
Hostname: hostname,
|
Hostnames: hostnames,
|
||||||
LastChecked: now,
|
LastChecked: now,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@@ -691,6 +815,22 @@ func (w *Watcher) checkTLSExpiry(
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Deduplicate expiry warnings: don't re-notify for the same
|
||||||
|
// hostname within the TLS check interval.
|
||||||
|
dedupKey := fmt.Sprintf("expiry:%s:%s", hostname, ip)
|
||||||
|
|
||||||
|
w.expiryNotifiedMu.Lock()
|
||||||
|
|
||||||
|
lastNotified, seen := w.expiryNotified[dedupKey]
|
||||||
|
if seen && time.Since(lastNotified) < w.config.TLSInterval {
|
||||||
|
w.expiryNotifiedMu.Unlock()
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
w.expiryNotified[dedupKey] = time.Now()
|
||||||
|
w.expiryNotifiedMu.Unlock()
|
||||||
|
|
||||||
msg := fmt.Sprintf(
|
msg := fmt.Sprintf(
|
||||||
"Host: %s\nIP: %s\nCN: %s\n"+
|
"Host: %s\nIP: %s\nCN: %s\n"+
|
||||||
"Expires: %s (%.0f days)",
|
"Expires: %s (%.0f days)",
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"sneak.berlin/go/dnswatcher/internal/config"
|
"sneak.berlin/go/dnswatcher/internal/config"
|
||||||
|
"sneak.berlin/go/dnswatcher/internal/portcheck"
|
||||||
"sneak.berlin/go/dnswatcher/internal/state"
|
"sneak.berlin/go/dnswatcher/internal/state"
|
||||||
"sneak.berlin/go/dnswatcher/internal/tlscheck"
|
"sneak.berlin/go/dnswatcher/internal/tlscheck"
|
||||||
"sneak.berlin/go/dnswatcher/internal/watcher"
|
"sneak.berlin/go/dnswatcher/internal/watcher"
|
||||||
@@ -109,24 +110,20 @@ func (m *mockPortChecker) CheckPort(
|
|||||||
_ context.Context,
|
_ context.Context,
|
||||||
address string,
|
address string,
|
||||||
port int,
|
port int,
|
||||||
) (bool, error) {
|
) (*portcheck.PortResult, error) {
|
||||||
m.mu.Lock()
|
m.mu.Lock()
|
||||||
defer m.mu.Unlock()
|
defer m.mu.Unlock()
|
||||||
|
|
||||||
m.calls++
|
m.calls++
|
||||||
|
|
||||||
if m.err != nil {
|
if m.err != nil {
|
||||||
return false, m.err
|
return nil, m.err
|
||||||
}
|
}
|
||||||
|
|
||||||
key := fmt.Sprintf("%s:%d", address, port)
|
key := fmt.Sprintf("%s:%d", address, port)
|
||||||
open, ok := m.results[key]
|
open := m.results[key]
|
||||||
|
|
||||||
if !ok {
|
return &portcheck.PortResult{Open: open}, nil
|
||||||
return false, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return open, nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
type mockTLSChecker struct {
|
type mockTLSChecker struct {
|
||||||
@@ -276,6 +273,10 @@ func setupBaselineMocks(deps *testDeps) {
|
|||||||
"ns1.example.com.",
|
"ns1.example.com.",
|
||||||
"ns2.example.com.",
|
"ns2.example.com.",
|
||||||
}
|
}
|
||||||
|
deps.resolver.allRecords["example.com"] = map[string]map[string][]string{
|
||||||
|
"ns1.example.com.": {"A": {"93.184.216.34"}},
|
||||||
|
"ns2.example.com.": {"A": {"93.184.216.34"}},
|
||||||
|
}
|
||||||
deps.resolver.allRecords["www.example.com"] = map[string]map[string][]string{
|
deps.resolver.allRecords["www.example.com"] = map[string]map[string][]string{
|
||||||
"ns1.example.com.": {"A": {"93.184.216.34"}},
|
"ns1.example.com.": {"A": {"93.184.216.34"}},
|
||||||
"ns2.example.com.": {"A": {"93.184.216.34"}},
|
"ns2.example.com.": {"A": {"93.184.216.34"}},
|
||||||
@@ -293,6 +294,14 @@ func setupBaselineMocks(deps *testDeps) {
|
|||||||
"www.example.com",
|
"www.example.com",
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
deps.tlsChecker.certs["93.184.216.34:example.com"] = &tlscheck.CertificateInfo{
|
||||||
|
CommonName: "example.com",
|
||||||
|
Issuer: "DigiCert",
|
||||||
|
NotAfter: time.Now().Add(90 * 24 * time.Hour),
|
||||||
|
SubjectAlternativeNames: []string{
|
||||||
|
"example.com",
|
||||||
|
},
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func assertNoNotifications(
|
func assertNoNotifications(
|
||||||
@@ -325,14 +334,74 @@ func assertStatePopulated(
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
if len(snap.Hostnames) != 1 {
|
// Hostnames includes both explicit hostnames and domains
|
||||||
|
// (domains now also get hostname state for port/TLS checks).
|
||||||
|
if len(snap.Hostnames) < 1 {
|
||||||
t.Errorf(
|
t.Errorf(
|
||||||
"expected 1 hostname in state, got %d",
|
"expected at least 1 hostname in state, got %d",
|
||||||
len(snap.Hostnames),
|
len(snap.Hostnames),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestDomainPortAndTLSChecks(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
cfg := defaultTestConfig(t)
|
||||||
|
cfg.Domains = []string{"example.com"}
|
||||||
|
|
||||||
|
w, deps := newTestWatcher(t, cfg)
|
||||||
|
|
||||||
|
deps.resolver.nsRecords["example.com"] = []string{
|
||||||
|
"ns1.example.com.",
|
||||||
|
}
|
||||||
|
deps.resolver.allRecords["example.com"] = map[string]map[string][]string{
|
||||||
|
"ns1.example.com.": {"A": {"93.184.216.34"}},
|
||||||
|
}
|
||||||
|
deps.portChecker.results["93.184.216.34:80"] = true
|
||||||
|
deps.portChecker.results["93.184.216.34:443"] = true
|
||||||
|
deps.tlsChecker.certs["93.184.216.34:example.com"] = &tlscheck.CertificateInfo{
|
||||||
|
CommonName: "example.com",
|
||||||
|
Issuer: "DigiCert",
|
||||||
|
NotAfter: time.Now().Add(90 * 24 * time.Hour),
|
||||||
|
SubjectAlternativeNames: []string{
|
||||||
|
"example.com",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
w.RunOnce(t.Context())
|
||||||
|
|
||||||
|
snap := deps.state.GetSnapshot()
|
||||||
|
|
||||||
|
// Domain should have port state populated
|
||||||
|
if len(snap.Ports) == 0 {
|
||||||
|
t.Error("expected port state for domain, got none")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Domain should have certificate state populated
|
||||||
|
if len(snap.Certificates) == 0 {
|
||||||
|
t.Error("expected certificate state for domain, got none")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify port checker was actually called
|
||||||
|
deps.portChecker.mu.Lock()
|
||||||
|
calls := deps.portChecker.calls
|
||||||
|
deps.portChecker.mu.Unlock()
|
||||||
|
|
||||||
|
if calls == 0 {
|
||||||
|
t.Error("expected port checker to be called for domain")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify TLS checker was actually called
|
||||||
|
deps.tlsChecker.mu.Lock()
|
||||||
|
tlsCalls := deps.tlsChecker.calls
|
||||||
|
deps.tlsChecker.mu.Unlock()
|
||||||
|
|
||||||
|
if tlsCalls == 0 {
|
||||||
|
t.Error("expected TLS checker to be called for domain")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestNSChangeDetection(t *testing.T) {
|
func TestNSChangeDetection(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -345,6 +414,12 @@ func TestNSChangeDetection(t *testing.T) {
|
|||||||
"ns1.example.com.",
|
"ns1.example.com.",
|
||||||
"ns2.example.com.",
|
"ns2.example.com.",
|
||||||
}
|
}
|
||||||
|
deps.resolver.allRecords["example.com"] = map[string]map[string][]string{
|
||||||
|
"ns1.example.com.": {"A": {"1.2.3.4"}},
|
||||||
|
"ns2.example.com.": {"A": {"1.2.3.4"}},
|
||||||
|
}
|
||||||
|
deps.portChecker.results["1.2.3.4:80"] = false
|
||||||
|
deps.portChecker.results["1.2.3.4:443"] = false
|
||||||
|
|
||||||
ctx := t.Context()
|
ctx := t.Context()
|
||||||
w.RunOnce(ctx)
|
w.RunOnce(ctx)
|
||||||
@@ -354,6 +429,10 @@ func TestNSChangeDetection(t *testing.T) {
|
|||||||
"ns1.example.com.",
|
"ns1.example.com.",
|
||||||
"ns3.example.com.",
|
"ns3.example.com.",
|
||||||
}
|
}
|
||||||
|
deps.resolver.allRecords["example.com"] = map[string]map[string][]string{
|
||||||
|
"ns1.example.com.": {"A": {"1.2.3.4"}},
|
||||||
|
"ns3.example.com.": {"A": {"1.2.3.4"}},
|
||||||
|
}
|
||||||
deps.resolver.mu.Unlock()
|
deps.resolver.mu.Unlock()
|
||||||
|
|
||||||
w.RunOnce(ctx)
|
w.RunOnce(ctx)
|
||||||
@@ -509,6 +588,61 @@ func TestTLSExpiryWarning(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTLSExpiryWarningDedup(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
cfg := defaultTestConfig(t)
|
||||||
|
cfg.Hostnames = []string{"www.example.com"}
|
||||||
|
cfg.TLSInterval = 24 * time.Hour
|
||||||
|
|
||||||
|
w, deps := newTestWatcher(t, cfg)
|
||||||
|
|
||||||
|
deps.resolver.allRecords["www.example.com"] = map[string]map[string][]string{
|
||||||
|
"ns1.example.com.": {"A": {"1.2.3.4"}},
|
||||||
|
}
|
||||||
|
deps.resolver.ipAddresses["www.example.com"] = []string{
|
||||||
|
"1.2.3.4",
|
||||||
|
}
|
||||||
|
deps.portChecker.results["1.2.3.4:80"] = true
|
||||||
|
deps.portChecker.results["1.2.3.4:443"] = true
|
||||||
|
deps.tlsChecker.certs["1.2.3.4:www.example.com"] = &tlscheck.CertificateInfo{
|
||||||
|
CommonName: "www.example.com",
|
||||||
|
Issuer: "DigiCert",
|
||||||
|
NotAfter: time.Now().Add(3 * 24 * time.Hour),
|
||||||
|
SubjectAlternativeNames: []string{
|
||||||
|
"www.example.com",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx := t.Context()
|
||||||
|
|
||||||
|
// First run = baseline, no notifications
|
||||||
|
w.RunOnce(ctx)
|
||||||
|
|
||||||
|
// Second run should fire one expiry warning
|
||||||
|
w.RunOnce(ctx)
|
||||||
|
|
||||||
|
// Third run should NOT fire another warning (dedup)
|
||||||
|
w.RunOnce(ctx)
|
||||||
|
|
||||||
|
notifications := deps.notifier.getNotifications()
|
||||||
|
|
||||||
|
expiryCount := 0
|
||||||
|
|
||||||
|
for _, n := range notifications {
|
||||||
|
if n.Title == "TLS Expiry Warning: www.example.com" {
|
||||||
|
expiryCount++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if expiryCount != 1 {
|
||||||
|
t.Errorf(
|
||||||
|
"expected exactly 1 expiry warning (dedup), got %d",
|
||||||
|
expiryCount,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestGracefulShutdown(t *testing.T) {
|
func TestGracefulShutdown(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -522,6 +656,11 @@ func TestGracefulShutdown(t *testing.T) {
|
|||||||
deps.resolver.nsRecords["example.com"] = []string{
|
deps.resolver.nsRecords["example.com"] = []string{
|
||||||
"ns1.example.com.",
|
"ns1.example.com.",
|
||||||
}
|
}
|
||||||
|
deps.resolver.allRecords["example.com"] = map[string]map[string][]string{
|
||||||
|
"ns1.example.com.": {"A": {"1.2.3.4"}},
|
||||||
|
}
|
||||||
|
deps.portChecker.results["1.2.3.4:80"] = false
|
||||||
|
deps.portChecker.results["1.2.3.4:443"] = false
|
||||||
|
|
||||||
ctx, cancel := context.WithCancel(t.Context())
|
ctx, cancel := context.WithCancel(t.Context())
|
||||||
|
|
||||||
@@ -543,6 +682,80 @@ func TestGracefulShutdown(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func setupHostnameIP(
|
||||||
|
deps *testDeps,
|
||||||
|
hostname, ip string,
|
||||||
|
) {
|
||||||
|
deps.resolver.allRecords[hostname] = map[string]map[string][]string{
|
||||||
|
"ns1.example.com.": {"A": {ip}},
|
||||||
|
}
|
||||||
|
deps.portChecker.results[ip+":80"] = true
|
||||||
|
deps.portChecker.results[ip+":443"] = true
|
||||||
|
deps.tlsChecker.certs[ip+":"+hostname] = &tlscheck.CertificateInfo{
|
||||||
|
CommonName: hostname,
|
||||||
|
Issuer: "DigiCert",
|
||||||
|
NotAfter: time.Now().Add(90 * 24 * time.Hour),
|
||||||
|
SubjectAlternativeNames: []string{hostname},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func updateHostnameIP(deps *testDeps, hostname, ip string) {
|
||||||
|
deps.resolver.mu.Lock()
|
||||||
|
deps.resolver.allRecords[hostname] = map[string]map[string][]string{
|
||||||
|
"ns1.example.com.": {"A": {ip}},
|
||||||
|
}
|
||||||
|
deps.resolver.mu.Unlock()
|
||||||
|
|
||||||
|
deps.portChecker.mu.Lock()
|
||||||
|
deps.portChecker.results[ip+":80"] = true
|
||||||
|
deps.portChecker.results[ip+":443"] = true
|
||||||
|
deps.portChecker.mu.Unlock()
|
||||||
|
|
||||||
|
deps.tlsChecker.mu.Lock()
|
||||||
|
deps.tlsChecker.certs[ip+":"+hostname] = &tlscheck.CertificateInfo{
|
||||||
|
CommonName: hostname,
|
||||||
|
Issuer: "DigiCert",
|
||||||
|
NotAfter: time.Now().Add(90 * 24 * time.Hour),
|
||||||
|
SubjectAlternativeNames: []string{hostname},
|
||||||
|
}
|
||||||
|
deps.tlsChecker.mu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDNSRunsBeforePortAndTLSChecks(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
cfg := defaultTestConfig(t)
|
||||||
|
cfg.Hostnames = []string{"www.example.com"}
|
||||||
|
|
||||||
|
w, deps := newTestWatcher(t, cfg)
|
||||||
|
|
||||||
|
setupHostnameIP(deps, "www.example.com", "10.0.0.1")
|
||||||
|
|
||||||
|
ctx := t.Context()
|
||||||
|
w.RunOnce(ctx)
|
||||||
|
|
||||||
|
snap := deps.state.GetSnapshot()
|
||||||
|
if _, ok := snap.Ports["10.0.0.1:80"]; !ok {
|
||||||
|
t.Fatal("expected port state for 10.0.0.1:80")
|
||||||
|
}
|
||||||
|
|
||||||
|
// DNS changes to a new IP; port and TLS must pick it up.
|
||||||
|
updateHostnameIP(deps, "www.example.com", "10.0.0.2")
|
||||||
|
|
||||||
|
w.RunOnce(ctx)
|
||||||
|
|
||||||
|
snap = deps.state.GetSnapshot()
|
||||||
|
|
||||||
|
if _, ok := snap.Ports["10.0.0.2:80"]; !ok {
|
||||||
|
t.Error("port check used stale DNS: missing 10.0.0.2:80")
|
||||||
|
}
|
||||||
|
|
||||||
|
certKey := "10.0.0.2:443:www.example.com"
|
||||||
|
if _, ok := snap.Certificates[certKey]; !ok {
|
||||||
|
t.Error("TLS check used stale DNS: missing " + certKey)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestNSFailureAndRecovery(t *testing.T) {
|
func TestNSFailureAndRecovery(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user