Compare commits
4 Commits
fix/issue-
...
d49e6cb528
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d49e6cb528 | ||
|
|
300114138d | ||
|
|
c486df5259 | ||
| 21de2dd140 |
@@ -1,26 +0,0 @@
|
|||||||
name: Check
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [main]
|
|
||||||
pull_request:
|
|
||||||
branches: [main]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
check:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
|
||||||
|
|
||||||
- uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff # v5
|
|
||||||
with:
|
|
||||||
go-version-file: go.mod
|
|
||||||
|
|
||||||
- name: Install golangci-lint
|
|
||||||
run: go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@5d1e709b7be35cb2025444e19de266b056b7b7ee # v2.10.1
|
|
||||||
|
|
||||||
- name: Install goimports
|
|
||||||
run: go install golang.org/x/tools/cmd/goimports@009367f5c17a8d4c45a961a3a509277190a9a6f0 # v0.42.0
|
|
||||||
|
|
||||||
- name: Run make check
|
|
||||||
run: make check
|
|
||||||
34
TESTING.md
34
TESTING.md
@@ -1,34 +0,0 @@
|
|||||||
# 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,7 +13,6 @@ 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 (
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
// Package notify provides notification delivery to Slack,
|
// Package notify provides notification delivery to Slack, Mattermost, and ntfy.
|
||||||
// Mattermost, and ntfy.
|
|
||||||
package notify
|
package notify
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -8,7 +7,6 @@ import (
|
|||||||
"encoding/json"
|
"encoding/json"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/url"
|
"net/url"
|
||||||
@@ -36,66 +34,8 @@ 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
|
||||||
@@ -107,7 +47,7 @@ type Params struct {
|
|||||||
// Service provides notification functionality.
|
// Service provides notification functionality.
|
||||||
type Service struct {
|
type Service struct {
|
||||||
log *slog.Logger
|
log *slog.Logger
|
||||||
transport http.RoundTripper
|
client *http.Client
|
||||||
config *config.Config
|
config *config.Config
|
||||||
ntfyURL *url.URL
|
ntfyURL *url.URL
|
||||||
slackWebhookURL *url.URL
|
slackWebhookURL *url.URL
|
||||||
@@ -121,40 +61,32 @@ func New(
|
|||||||
) (*Service, error) {
|
) (*Service, error) {
|
||||||
svc := &Service{
|
svc := &Service{
|
||||||
log: params.Logger.Get(),
|
log: params.Logger.Get(),
|
||||||
transport: http.DefaultTransport,
|
client: &http.Client{
|
||||||
|
Timeout: httpClientTimeout,
|
||||||
|
},
|
||||||
config: params.Config,
|
config: params.Config,
|
||||||
}
|
}
|
||||||
|
|
||||||
if params.Config.NtfyTopic != "" {
|
if params.Config.NtfyTopic != "" {
|
||||||
u, err := ValidateWebhookURL(
|
u, err := url.ParseRequestURI(params.Config.NtfyTopic)
|
||||||
params.Config.NtfyTopic,
|
|
||||||
)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf(
|
return nil, fmt.Errorf("invalid ntfy topic URL: %w", err)
|
||||||
"invalid ntfy topic URL: %w", err,
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
svc.ntfyURL = u
|
svc.ntfyURL = u
|
||||||
}
|
}
|
||||||
|
|
||||||
if params.Config.SlackWebhook != "" {
|
if params.Config.SlackWebhook != "" {
|
||||||
u, err := ValidateWebhookURL(
|
u, err := url.ParseRequestURI(params.Config.SlackWebhook)
|
||||||
params.Config.SlackWebhook,
|
|
||||||
)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf(
|
return nil, fmt.Errorf("invalid slack webhook URL: %w", err)
|
||||||
"invalid slack webhook URL: %w", err,
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
svc.slackWebhookURL = u
|
svc.slackWebhookURL = u
|
||||||
}
|
}
|
||||||
|
|
||||||
if params.Config.MattermostWebhook != "" {
|
if params.Config.MattermostWebhook != "" {
|
||||||
u, err := ValidateWebhookURL(
|
u, err := url.ParseRequestURI(params.Config.MattermostWebhook)
|
||||||
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,
|
||||||
@@ -167,8 +99,7 @@ func New(
|
|||||||
return svc, nil
|
return svc, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// SendNotification sends a notification to all configured
|
// SendNotification sends a notification to all configured endpoints.
|
||||||
// endpoints.
|
|
||||||
func (svc *Service) SendNotification(
|
func (svc *Service) SendNotification(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
title, message, priority string,
|
title, message, priority string,
|
||||||
@@ -239,20 +170,20 @@ func (svc *Service) sendNtfy(
|
|||||||
"title", title,
|
"title", title,
|
||||||
)
|
)
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(
|
request, err := http.NewRequestWithContext(
|
||||||
ctx, httpClientTimeout,
|
ctx,
|
||||||
)
|
http.MethodPost,
|
||||||
defer cancel()
|
topicURL.String(),
|
||||||
|
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.transport.RoundTrip(request)
|
resp, err := svc.client.Do(request) //nolint:gosec // URL validated at Service construction time
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("sending ntfy request: %w", err)
|
return fmt.Errorf("sending ntfy request: %w", err)
|
||||||
}
|
}
|
||||||
@@ -261,8 +192,7 @@ func (svc *Service) sendNtfy(
|
|||||||
|
|
||||||
if resp.StatusCode >= httpStatusClientError {
|
if resp.StatusCode >= httpStatusClientError {
|
||||||
return fmt.Errorf(
|
return fmt.Errorf(
|
||||||
"%w: status %d",
|
"%w: status %d", ErrNtfyFailed, resp.StatusCode,
|
||||||
ErrNtfyFailed, resp.StatusCode,
|
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -302,11 +232,6 @@ 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(),
|
||||||
@@ -325,19 +250,22 @@ func (svc *Service) sendSlack(
|
|||||||
|
|
||||||
body, err := json.Marshal(payload)
|
body, err := json.Marshal(payload)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf(
|
return fmt.Errorf("marshaling webhook payload: %w", err)
|
||||||
"marshaling webhook payload: %w", err,
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
request := newRequest(
|
request, err := http.NewRequestWithContext(
|
||||||
ctx, http.MethodPost, webhookURL,
|
ctx,
|
||||||
|
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.transport.RoundTrip(request)
|
resp, err := svc.client.Do(request) //nolint:gosec // URL validated at Service construction time
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("sending webhook request: %w", err)
|
return fmt.Errorf("sending webhook request: %w", err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,100 +0,0 @@
|
|||||||
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,39 +4,18 @@ 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"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
// ErrNotImplemented indicates the port checker is not yet implemented.
|
||||||
minPort = 1
|
var ErrNotImplemented = errors.New(
|
||||||
maxPort = 65535
|
"port checker not yet implemented",
|
||||||
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
|
||||||
@@ -59,145 +38,11 @@ func New(
|
|||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewStandalone creates a Checker without fx dependencies.
|
|
||||||
func NewStandalone() *Checker {
|
|
||||||
return &Checker{
|
|
||||||
log: slog.Default(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// 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.
|
// 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(
|
func (c *Checker) CheckPort(
|
||||||
ctx context.Context,
|
_ context.Context,
|
||||||
address string,
|
_ string,
|
||||||
port int,
|
_ int,
|
||||||
) (*PortResult, error) {
|
) (bool, error) {
|
||||||
err := validatePort(port)
|
return false, ErrNotImplemented
|
||||||
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,
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,211 +0,0 @@
|
|||||||
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,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -24,8 +24,4 @@ var (
|
|||||||
// ErrContextCanceled wraps context cancellation for the
|
// ErrContextCanceled wraps context cancellation for the
|
||||||
// resolver's iterative queries.
|
// resolver's iterative queries.
|
||||||
ErrContextCanceled = errors.New("context canceled")
|
ErrContextCanceled = errors.New("context canceled")
|
||||||
|
|
||||||
// ErrSERVFAIL is returned when a DNS server responds with
|
|
||||||
// SERVFAIL after all retries are exhausted.
|
|
||||||
ErrSERVFAIL = errors.New("SERVFAIL from server")
|
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -4,7 +4,6 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"math/rand"
|
|
||||||
"net"
|
"net"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -14,7 +13,7 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
queryTimeoutDuration = 2 * time.Second
|
queryTimeoutDuration = 5 * time.Second
|
||||||
maxRetries = 2
|
maxRetries = 2
|
||||||
maxDelegation = 20
|
maxDelegation = 20
|
||||||
timeoutMultiplier = 2
|
timeoutMultiplier = 2
|
||||||
@@ -42,22 +41,6 @@ func rootServerList() []string {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
const maxRootServers = 3
|
|
||||||
|
|
||||||
// randomRootServers returns a shuffled subset of root servers.
|
|
||||||
func randomRootServers() []string {
|
|
||||||
all := rootServerList()
|
|
||||||
rand.Shuffle(len(all), func(i, j int) {
|
|
||||||
all[i], all[j] = all[j], all[i]
|
|
||||||
})
|
|
||||||
|
|
||||||
if len(all) > maxRootServers {
|
|
||||||
return all[:maxRootServers]
|
|
||||||
}
|
|
||||||
|
|
||||||
return all
|
|
||||||
}
|
|
||||||
|
|
||||||
func checkCtx(ctx context.Context) error {
|
func checkCtx(ctx context.Context) error {
|
||||||
err := ctx.Err()
|
err := ctx.Err()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -319,7 +302,7 @@ func (r *Resolver) resolveNSRecursive(
|
|||||||
msg.SetQuestion(domain, dns.TypeNS)
|
msg.SetQuestion(domain, dns.TypeNS)
|
||||||
msg.RecursionDesired = true
|
msg.RecursionDesired = true
|
||||||
|
|
||||||
for _, ip := range randomRootServers() {
|
for _, ip := range rootServerList()[:3] {
|
||||||
if checkCtx(ctx) != nil {
|
if checkCtx(ctx) != nil {
|
||||||
return nil, ErrContextCanceled
|
return nil, ErrContextCanceled
|
||||||
}
|
}
|
||||||
@@ -350,7 +333,7 @@ func (r *Resolver) resolveARecord(
|
|||||||
msg.SetQuestion(hostname, dns.TypeA)
|
msg.SetQuestion(hostname, dns.TypeA)
|
||||||
msg.RecursionDesired = true
|
msg.RecursionDesired = true
|
||||||
|
|
||||||
for _, ip := range randomRootServers() {
|
for _, ip := range rootServerList()[:3] {
|
||||||
if checkCtx(ctx) != nil {
|
if checkCtx(ctx) != nil {
|
||||||
return nil, ErrContextCanceled
|
return nil, ErrContextCanceled
|
||||||
}
|
}
|
||||||
@@ -402,7 +385,7 @@ func (r *Resolver) FindAuthoritativeNameservers(
|
|||||||
candidate := strings.Join(labels[i:], ".") + "."
|
candidate := strings.Join(labels[i:], ".") + "."
|
||||||
|
|
||||||
nsNames, err := r.followDelegation(
|
nsNames, err := r.followDelegation(
|
||||||
ctx, candidate, randomRootServers(),
|
ctx, candidate, rootServerList(),
|
||||||
)
|
)
|
||||||
if err == nil && len(nsNames) > 0 {
|
if err == nil && len(nsNames) > 0 {
|
||||||
sort.Strings(nsNames)
|
sort.Strings(nsNames)
|
||||||
@@ -459,15 +442,9 @@ func (r *Resolver) queryAllTypes(
|
|||||||
return resp, nil
|
return resp, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
const (
|
|
||||||
singleTypeMaxRetries = 3
|
|
||||||
singleTypeInitialBackoff = 100 * time.Millisecond
|
|
||||||
)
|
|
||||||
|
|
||||||
type queryState struct {
|
type queryState struct {
|
||||||
gotNXDomain bool
|
gotNXDomain bool
|
||||||
gotSERVFAIL bool
|
gotSERVFAIL bool
|
||||||
gotTimeout bool
|
|
||||||
hasRecords bool
|
hasRecords bool
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -495,21 +472,6 @@ func (r *Resolver) queryEachType(
|
|||||||
return state
|
return state
|
||||||
}
|
}
|
||||||
|
|
||||||
// isTimeout checks whether an error represents a DNS timeout.
|
|
||||||
func isTimeout(err error) bool {
|
|
||||||
if err == nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
var netErr net.Error
|
|
||||||
if errors.As(err, &netErr) && netErr.Timeout() {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
// Also catch i/o timeout strings from the dns library.
|
|
||||||
return strings.Contains(err.Error(), "i/o timeout")
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *Resolver) querySingleType(
|
func (r *Resolver) querySingleType(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
nsIP string,
|
nsIP string,
|
||||||
@@ -518,95 +480,19 @@ func (r *Resolver) querySingleType(
|
|||||||
resp *NameserverResponse,
|
resp *NameserverResponse,
|
||||||
state *queryState,
|
state *queryState,
|
||||||
) {
|
) {
|
||||||
msg, lastErr := r.querySingleTypeWithRetry(
|
msg, err := r.queryDNS(ctx, nsIP, hostname, qtype)
|
||||||
ctx, nsIP, hostname, qtype,
|
if err != nil {
|
||||||
)
|
|
||||||
if msg == nil {
|
|
||||||
r.recordRetryFailure(lastErr, state)
|
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
r.handleDNSResponse(msg, resp, state)
|
if msg.Rcode == dns.RcodeNameError {
|
||||||
}
|
state.gotNXDomain = true
|
||||||
|
|
||||||
func (r *Resolver) querySingleTypeWithRetry(
|
return
|
||||||
ctx context.Context,
|
|
||||||
nsIP string,
|
|
||||||
hostname string,
|
|
||||||
qtype uint16,
|
|
||||||
) (*dns.Msg, error) {
|
|
||||||
var lastErr error
|
|
||||||
|
|
||||||
backoff := singleTypeInitialBackoff
|
|
||||||
|
|
||||||
for attempt := range singleTypeMaxRetries {
|
|
||||||
if checkCtx(ctx) != nil {
|
|
||||||
return nil, ErrContextCanceled
|
|
||||||
}
|
|
||||||
|
|
||||||
if attempt > 0 {
|
|
||||||
if !waitBackoff(ctx, backoff) {
|
|
||||||
return nil, ErrContextCanceled
|
|
||||||
}
|
|
||||||
|
|
||||||
backoff *= timeoutMultiplier
|
|
||||||
}
|
|
||||||
|
|
||||||
msg, err := r.queryDNS(ctx, nsIP, hostname, qtype)
|
|
||||||
if err != nil {
|
|
||||||
lastErr = err
|
|
||||||
|
|
||||||
if !isTimeout(err) {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
continue
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if msg.Rcode == dns.RcodeServerFailure {
|
if msg.Rcode == dns.RcodeServerFailure {
|
||||||
lastErr = ErrSERVFAIL
|
|
||||||
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
return msg, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil, lastErr
|
|
||||||
}
|
|
||||||
|
|
||||||
func waitBackoff(ctx context.Context, d time.Duration) bool {
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
return false
|
|
||||||
case <-time.After(d):
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *Resolver) recordRetryFailure(
|
|
||||||
lastErr error,
|
|
||||||
state *queryState,
|
|
||||||
) {
|
|
||||||
if lastErr == nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if isTimeout(lastErr) {
|
|
||||||
state.gotTimeout = true
|
|
||||||
} else if errors.Is(lastErr, ErrSERVFAIL) {
|
|
||||||
state.gotSERVFAIL = true
|
state.gotSERVFAIL = true
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *Resolver) handleDNSResponse(
|
|
||||||
msg *dns.Msg,
|
|
||||||
resp *NameserverResponse,
|
|
||||||
state *queryState,
|
|
||||||
) {
|
|
||||||
if msg.Rcode == dns.RcodeNameError {
|
|
||||||
state.gotNXDomain = true
|
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -637,12 +523,8 @@ 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 after retries"
|
|
||||||
case state.gotSERVFAIL && !state.hasRecords:
|
case state.gotSERVFAIL && !state.hasRecords:
|
||||||
resp.Status = StatusError
|
resp.Status = StatusError
|
||||||
resp.Error = "server failure (SERVFAIL) after retries"
|
|
||||||
case !state.hasRecords && !state.gotNXDomain:
|
case !state.hasRecords && !state.gotNXDomain:
|
||||||
resp.Status = StatusNoData
|
resp.Status = StatusNoData
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -17,7 +17,6 @@ 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.
|
||||||
@@ -81,3 +80,4 @@ func NewFromLoggerWithClient(
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Method implementations are in iterative.go.
|
// Method implementations are in iterative.go.
|
||||||
|
|
||||||
|
|||||||
85
internal/resolver/resolver_integration_test.go
Normal file
85
internal/resolver/resolver_integration_test.go
Normal file
@@ -0,0 +1,85 @@
|
|||||||
|
//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
@@ -156,8 +156,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.Lock()
|
s.mu.RLock()
|
||||||
defer s.mu.Unlock()
|
defer s.mu.RUnlock()
|
||||||
|
|
||||||
s.snapshot.LastUpdated = time.Now().UTC()
|
s.snapshot.LastUpdated = time.Now().UTC()
|
||||||
|
|
||||||
|
|||||||
@@ -1,67 +0,0 @@
|
|||||||
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,12 +3,8 @@ 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"
|
||||||
@@ -16,56 +12,11 @@ import (
|
|||||||
"sneak.berlin/go/dnswatcher/internal/logger"
|
"sneak.berlin/go/dnswatcher/internal/logger"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
// ErrNotImplemented indicates the TLS checker is not yet implemented.
|
||||||
defaultTimeout = 10 * time.Second
|
var ErrNotImplemented = errors.New(
|
||||||
defaultPort = 443
|
"tls checker not yet implemented",
|
||||||
)
|
)
|
||||||
|
|
||||||
// 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
|
||||||
@@ -76,9 +27,14 @@ 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
|
|
||||||
port int
|
// CertificateInfo holds information about a TLS certificate.
|
||||||
|
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.
|
||||||
@@ -88,109 +44,15 @@ func New(
|
|||||||
) (*Checker, error) {
|
) (*Checker, error) {
|
||||||
return &Checker{
|
return &Checker{
|
||||||
log: params.Logger.Get(),
|
log: params.Logger.Get(),
|
||||||
timeout: defaultTimeout,
|
|
||||||
port: defaultPort,
|
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewStandalone creates a Checker without fx dependencies.
|
// CheckCertificate connects to the given IP:port using SNI and
|
||||||
func NewStandalone(opts ...Option) *Checker {
|
// returns certificate information.
|
||||||
checker := &Checker{
|
|
||||||
log: slog.Default(),
|
|
||||||
timeout: defaultTimeout,
|
|
||||||
port: defaultPort,
|
|
||||||
}
|
|
||||||
|
|
||||||
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(
|
func (c *Checker) CheckCertificate(
|
||||||
ctx context.Context,
|
_ context.Context,
|
||||||
ipAddress string,
|
_ string,
|
||||||
sniHostname string,
|
_ string,
|
||||||
) (*CertificateInfo, error) {
|
) (*CertificateInfo, error) {
|
||||||
target := net.JoinHostPort(
|
return nil, ErrNotImplemented
|
||||||
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
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,169 +0,0 @@
|
|||||||
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,7 +4,6 @@ package watcher
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
|
||||||
"sneak.berlin/go/dnswatcher/internal/portcheck"
|
|
||||||
"sneak.berlin/go/dnswatcher/internal/tlscheck"
|
"sneak.berlin/go/dnswatcher/internal/tlscheck"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -37,7 +36,7 @@ type PortChecker interface {
|
|||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
address string,
|
address string,
|
||||||
port int,
|
port int,
|
||||||
) (*portcheck.PortResult, error)
|
) (bool, error)
|
||||||
}
|
}
|
||||||
|
|
||||||
// TLSChecker inspects TLS certificates.
|
// TLSChecker inspects TLS certificates.
|
||||||
|
|||||||
@@ -6,7 +6,6 @@ import (
|
|||||||
"log/slog"
|
"log/slog"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"go.uber.org/fx"
|
"go.uber.org/fx"
|
||||||
@@ -50,8 +49,6 @@ 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.
|
||||||
@@ -68,7 +65,6 @@ 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{
|
||||||
@@ -112,7 +108,6 @@ func NewForTest(
|
|||||||
tlsCheck: tc,
|
tlsCheck: tc,
|
||||||
notify: n,
|
notify: n,
|
||||||
firstRun: true,
|
firstRun: true,
|
||||||
expiryNotified: make(map[string]time.Time),
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -211,28 +206,6 @@ 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(
|
||||||
@@ -504,7 +477,7 @@ func (w *Watcher) checkSinglePort(
|
|||||||
port int,
|
port int,
|
||||||
hostname string,
|
hostname string,
|
||||||
) {
|
) {
|
||||||
result, err := w.portCheck.CheckPort(ctx, ip, port)
|
open, 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",
|
||||||
@@ -520,9 +493,9 @@ 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 != result.Open {
|
if hasPrev && !w.firstRun && prev.Open != open {
|
||||||
stateStr := "closed"
|
stateStr := "closed"
|
||||||
if result.Open {
|
if open {
|
||||||
stateStr = "open"
|
stateStr = "open"
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -540,7 +513,7 @@ func (w *Watcher) checkSinglePort(
|
|||||||
}
|
}
|
||||||
|
|
||||||
w.state.SetPortState(key, &state.PortState{
|
w.state.SetPortState(key, &state.PortState{
|
||||||
Open: result.Open,
|
Open: open,
|
||||||
Hostname: hostname,
|
Hostname: hostname,
|
||||||
LastChecked: now,
|
LastChecked: now,
|
||||||
})
|
})
|
||||||
@@ -718,22 +691,6 @@ 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,7 +9,6 @@ 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"
|
||||||
@@ -110,20 +109,24 @@ func (m *mockPortChecker) CheckPort(
|
|||||||
_ context.Context,
|
_ context.Context,
|
||||||
address string,
|
address string,
|
||||||
port int,
|
port int,
|
||||||
) (*portcheck.PortResult, error) {
|
) (bool, 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 nil, m.err
|
return false, m.err
|
||||||
}
|
}
|
||||||
|
|
||||||
key := fmt.Sprintf("%s:%d", address, port)
|
key := fmt.Sprintf("%s:%d", address, port)
|
||||||
open := m.results[key]
|
open, ok := m.results[key]
|
||||||
|
|
||||||
return &portcheck.PortResult{Open: open}, nil
|
if !ok {
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return open, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
type mockTLSChecker struct {
|
type mockTLSChecker struct {
|
||||||
@@ -273,10 +276,6 @@ 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"}},
|
||||||
@@ -294,14 +293,6 @@ 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(
|
||||||
@@ -334,74 +325,14 @@ func assertStatePopulated(
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Hostnames includes both explicit hostnames and domains
|
if len(snap.Hostnames) != 1 {
|
||||||
// (domains now also get hostname state for port/TLS checks).
|
|
||||||
if len(snap.Hostnames) < 1 {
|
|
||||||
t.Errorf(
|
t.Errorf(
|
||||||
"expected at least 1 hostname in state, got %d",
|
"expected 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()
|
||||||
|
|
||||||
@@ -414,12 +345,6 @@ 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)
|
||||||
@@ -429,10 +354,6 @@ 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)
|
||||||
@@ -588,61 +509,6 @@ 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()
|
||||||
|
|
||||||
@@ -656,11 +522,6 @@ 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())
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user