Files
Charon/backend/internal/security/url_validator_test.go
GitHub Actions 745b9e3e97 fix(security): complete SSRF remediation with defense-in-depth (CWE-918)
Implement three-layer SSRF protection:
- Layer 1: URL pre-validation (existing)
- Layer 2: network.NewSafeHTTPClient() with connection-time IP validation
- Layer 3: Redirect target validation

New package: internal/network/safeclient.go
- IsPrivateIP(): Blocks RFC 1918, loopback, link-local (169.254.x.x),
  reserved ranges, IPv6 private
- safeDialer(): DNS resolve → validate all IPs → dial validated IP
  (prevents DNS rebinding/TOCTOU)
- NewSafeHTTPClient(): Functional options (WithTimeout, WithAllowLocalhost,
  WithAllowedDomains, WithMaxRedirects)

Updated services:
- notification_service.go
- security_notification_service.go
- update_service.go
- crowdsec/registration.go (WithAllowLocalhost for LAPI)
- crowdsec/hub_sync.go (WithAllowedDomains for CrowdSec domains)

Consolidated duplicate isPrivateIP implementations to use network package.

Test coverage: 90.9% for network package
CodeQL: 0 SSRF findings (CWE-918 mitigated)

Closes #450
2025-12-24 17:34:56 +00:00

627 lines
17 KiB
Go

package security
import (
"net"
"strings"
"testing"
"time"
)
func TestValidateExternalURL_BasicValidation(t *testing.T) {
tests := []struct {
name string
url string
options []ValidationOption
shouldFail bool
errContains string
}{
{
name: "Valid HTTPS URL",
url: "https://api.example.com/webhook",
options: nil,
shouldFail: false,
},
{
name: "HTTP without AllowHTTP option",
url: "http://api.example.com/webhook",
options: nil,
shouldFail: true,
errContains: "http scheme not allowed",
},
{
name: "HTTP with AllowHTTP option",
url: "http://api.example.com/webhook",
options: []ValidationOption{WithAllowHTTP()},
shouldFail: false,
},
{
name: "Empty URL",
url: "",
options: nil,
shouldFail: true,
errContains: "unsupported scheme",
},
{
name: "Missing scheme",
url: "example.com",
options: nil,
shouldFail: true,
errContains: "unsupported scheme",
},
{
name: "Just scheme",
url: "https://",
options: nil,
shouldFail: true,
errContains: "missing hostname",
},
{
name: "FTP protocol",
url: "ftp://example.com",
options: nil,
shouldFail: true,
errContains: "unsupported scheme: ftp",
},
{
name: "File protocol",
url: "file:///etc/passwd",
options: nil,
shouldFail: true,
errContains: "unsupported scheme: file",
},
{
name: "Gopher protocol",
url: "gopher://example.com",
options: nil,
shouldFail: true,
errContains: "unsupported scheme: gopher",
},
{
name: "Data URL",
url: "data:text/html,<script>alert(1)</script>",
options: nil,
shouldFail: true,
errContains: "unsupported scheme: data",
},
{
name: "URL with credentials",
url: "https://user:pass@example.com",
options: nil,
shouldFail: true,
errContains: "embedded credentials are not allowed",
},
{
name: "Valid with port",
url: "https://api.example.com:8080/webhook",
options: nil,
shouldFail: false,
},
{
name: "Valid with path",
url: "https://api.example.com/path/to/webhook",
options: nil,
shouldFail: false,
},
{
name: "Valid with query",
url: "https://api.example.com/webhook?token=abc123",
options: nil,
shouldFail: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
_, err := ValidateExternalURL(tt.url, tt.options...)
if tt.shouldFail {
if err == nil {
t.Errorf("Expected error for %s, got nil", tt.url)
} else if tt.errContains != "" && !strings.Contains(err.Error(), tt.errContains) {
t.Errorf("Expected error containing '%s', got: %v", tt.errContains, err)
}
} else {
if err != nil {
// For tests that expect success but DNS may fail in test environment,
// we accept DNS errors but not validation errors
if !strings.Contains(err.Error(), "dns resolution failed") {
t.Errorf("Unexpected validation error for %s: %v", tt.url, err)
} else {
t.Logf("Note: DNS resolution failed for %s (expected in test environment)", tt.url)
}
}
}
})
}
}
func TestValidateExternalURL_LocalhostHandling(t *testing.T) {
tests := []struct {
name string
url string
options []ValidationOption
shouldFail bool
errContains string
}{
{
name: "Localhost without AllowLocalhost",
url: "https://localhost/webhook",
options: nil,
shouldFail: true,
errContains: "", // Will fail on DNS or be blocked
},
{
name: "Localhost with AllowLocalhost",
url: "https://localhost/webhook",
options: []ValidationOption{WithAllowLocalhost()},
shouldFail: false,
},
{
name: "127.0.0.1 with AllowLocalhost and AllowHTTP",
url: "http://127.0.0.1:8080/test",
options: []ValidationOption{WithAllowLocalhost(), WithAllowHTTP()},
shouldFail: false,
},
{
name: "IPv6 loopback with AllowLocalhost",
url: "https://[::1]:3000/test",
options: []ValidationOption{WithAllowLocalhost()},
shouldFail: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
_, err := ValidateExternalURL(tt.url, tt.options...)
if tt.shouldFail {
if err == nil {
t.Errorf("Expected error for %s, got nil", tt.url)
}
} else {
if err != nil {
t.Errorf("Unexpected error for %s: %v", tt.url, err)
}
}
})
}
}
func TestValidateExternalURL_PrivateIPBlocking(t *testing.T) {
tests := []struct {
name string
url string
options []ValidationOption
shouldFail bool
errContains string
}{
// Note: These tests will only work if DNS actually resolves to these IPs
// In practice, we can't control DNS resolution in unit tests
// Integration tests or mocked DNS would be needed for comprehensive coverage
{
name: "Private IP 10.x.x.x",
url: "http://10.0.0.1",
options: []ValidationOption{WithAllowHTTP()},
shouldFail: true,
errContains: "dns resolution failed", // Will likely fail DNS
},
{
name: "Private IP 192.168.x.x",
url: "http://192.168.1.1",
options: []ValidationOption{WithAllowHTTP()},
shouldFail: true,
errContains: "dns resolution failed",
},
{
name: "Private IP 172.16.x.x",
url: "http://172.16.0.1",
options: []ValidationOption{WithAllowHTTP()},
shouldFail: true,
errContains: "dns resolution failed",
},
{
name: "AWS Metadata IP",
url: "http://169.254.169.254",
options: []ValidationOption{WithAllowHTTP()},
shouldFail: true,
errContains: "dns resolution failed",
},
{
name: "Loopback without AllowLocalhost",
url: "http://127.0.0.1",
options: []ValidationOption{WithAllowHTTP()},
shouldFail: true,
errContains: "dns resolution failed",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
_, err := ValidateExternalURL(tt.url, tt.options...)
if tt.shouldFail {
if err == nil {
t.Errorf("Expected error for %s, got nil", tt.url)
}
} else {
if err != nil {
t.Errorf("Unexpected error for %s: %v", tt.url, err)
}
}
})
}
}
func TestValidateExternalURL_Options(t *testing.T) {
t.Run("WithTimeout", func(t *testing.T) {
// Test with very short timeout - should fail for slow DNS
_, err := ValidateExternalURL(
"https://example.com",
WithTimeout(1*time.Nanosecond),
)
// We expect this might fail due to timeout, but it's acceptable
// The point is the option is applied
_ = err // Acknowledge error
})
t.Run("Multiple options", func(t *testing.T) {
_, err := ValidateExternalURL(
"http://localhost:8080/test",
WithAllowLocalhost(),
WithAllowHTTP(),
WithTimeout(5*time.Second),
)
if err != nil {
t.Errorf("Unexpected error with multiple options: %v", err)
}
})
}
func TestIsPrivateIP(t *testing.T) {
tests := []struct {
name string
ip string
isPrivate bool
}{
// RFC 1918 Private Networks
{"10.0.0.0", "10.0.0.0", true},
{"10.255.255.255", "10.255.255.255", true},
{"172.16.0.0", "172.16.0.0", true},
{"172.31.255.255", "172.31.255.255", true},
{"192.168.0.0", "192.168.0.0", true},
{"192.168.255.255", "192.168.255.255", true},
// Loopback
{"127.0.0.1", "127.0.0.1", true},
{"127.0.0.2", "127.0.0.2", true},
{"IPv6 loopback", "::1", true},
// Link-Local (includes AWS/GCP metadata)
{"169.254.1.1", "169.254.1.1", true},
{"AWS metadata", "169.254.169.254", true},
// Reserved ranges
{"0.0.0.0", "0.0.0.0", true},
{"255.255.255.255", "255.255.255.255", true},
{"240.0.0.1", "240.0.0.1", true},
// IPv6 Unique Local and Link-Local
{"IPv6 unique local", "fc00::1", true},
{"IPv6 link-local", "fe80::1", true},
// Public IPs (should NOT be blocked)
{"Google DNS", "8.8.8.8", false},
{"Cloudflare DNS", "1.1.1.1", false},
{"Public IPv6", "2001:4860:4860::8888", false},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
ip := parseIP(tt.ip)
if ip == nil {
t.Fatalf("Invalid test IP: %s", tt.ip)
}
result := isPrivateIP(ip)
if result != tt.isPrivate {
t.Errorf("isPrivateIP(%s) = %v, want %v", tt.ip, result, tt.isPrivate)
}
})
}
}
// Helper function to parse IP address
func parseIP(s string) net.IP {
ip := net.ParseIP(s)
return ip
}
func TestValidateExternalURL_RealWorldURLs(t *testing.T) {
// These tests use real public domains
// They may fail if DNS is unavailable or domains change
tests := []struct {
name string
url string
options []ValidationOption
shouldFail bool
}{
{
name: "Slack webhook format",
url: "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXX",
options: nil,
shouldFail: false,
},
{
name: "Discord webhook format",
url: "https://discord.com/api/webhooks/123456789/abcdefg",
options: nil,
shouldFail: false,
},
{
name: "Generic API endpoint",
url: "https://api.github.com/repos/user/repo",
options: nil,
shouldFail: false,
},
{
name: "Localhost for testing",
url: "http://localhost:3000/webhook",
options: []ValidationOption{WithAllowLocalhost(), WithAllowHTTP()},
shouldFail: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
_, err := ValidateExternalURL(tt.url, tt.options...)
if tt.shouldFail && err == nil {
t.Errorf("Expected error for %s, got nil", tt.url)
}
if !tt.shouldFail && err != nil {
// Real-world URLs might fail due to network issues
// Log but don't fail the test
t.Logf("Note: %s failed validation (may be network issue): %v", tt.url, err)
}
})
}
}
// Phase 4.2: Additional test cases for comprehensive coverage
func TestValidateExternalURL_MultipleOptions(t *testing.T) {
// Test combining multiple validation options
tests := []struct {
name string
url string
options []ValidationOption
shouldPass bool
}{
{
name: "All options enabled",
url: "http://localhost:8080/webhook",
options: []ValidationOption{WithAllowHTTP(), WithAllowLocalhost(), WithTimeout(5 * time.Second)},
shouldPass: true,
},
{
name: "Custom timeout with HTTPS",
url: "https://example.com/api",
options: []ValidationOption{WithTimeout(10 * time.Second)},
shouldPass: true, // May fail DNS in test env
},
{
name: "HTTP without AllowHTTP fails",
url: "http://example.com",
options: []ValidationOption{WithTimeout(5 * time.Second)},
shouldPass: false,
},
{
name: "Localhost without AllowLocalhost fails",
url: "https://localhost",
options: []ValidationOption{WithTimeout(5 * time.Second)},
shouldPass: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
_, err := ValidateExternalURL(tt.url, tt.options...)
if tt.shouldPass {
// In test environment, DNS may fail - that's acceptable
if err != nil && !strings.Contains(err.Error(), "dns resolution failed") {
t.Errorf("Expected success or DNS error, got: %v", err)
}
} else {
if err == nil {
t.Errorf("Expected error for %s, got nil", tt.url)
}
}
})
}
}
func TestValidateExternalURL_CustomTimeout(t *testing.T) {
// Test custom timeout configuration
tests := []struct {
name string
url string
timeout time.Duration
}{
{
name: "Very short timeout",
url: "https://example.com",
timeout: 1 * time.Nanosecond,
},
{
name: "Standard timeout",
url: "https://api.github.com",
timeout: 3 * time.Second,
},
{
name: "Long timeout",
url: "https://slow-dns-server.example",
timeout: 30 * time.Second,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
start := time.Now()
_, err := ValidateExternalURL(tt.url, WithTimeout(tt.timeout))
elapsed := time.Since(start)
// Verify timeout is respected (with some tolerance)
if err != nil && elapsed > tt.timeout*2 {
t.Logf("Warning: timeout may not be strictly enforced (elapsed: %v, timeout: %v)", elapsed, tt.timeout)
}
// Note: We don't fail the test based on timeout behavior alone
// as DNS resolution timing can be unpredictable
t.Logf("URL: %s, Timeout: %v, Elapsed: %v, Error: %v", tt.url, tt.timeout, elapsed, err)
})
}
}
func TestValidateExternalURL_DNSTimeout(t *testing.T) {
// Test DNS resolution timeout behavior
// Use a non-routable IP address to force timeout
_, err := ValidateExternalURL(
"https://10.255.255.1", // Non-routable private IP
WithAllowHTTP(),
WithTimeout(100*time.Millisecond),
)
// Should fail with DNS resolution error or timeout
if err == nil {
t.Error("Expected DNS resolution to fail for non-routable IP")
}
// Accept either DNS failure or timeout
if !strings.Contains(err.Error(), "dns resolution failed") &&
!strings.Contains(err.Error(), "timeout") &&
!strings.Contains(err.Error(), "no route to host") {
t.Logf("Got acceptable error: %v", err)
}
}
func TestValidateExternalURL_MultipleIPsAllPrivate(t *testing.T) {
// Test scenario where DNS returns multiple IPs, all private
// Note: In real environment, we can't control DNS responses
// This test documents expected behavior
// Test with known private IP addresses
privateIPs := []string{
"10.0.0.1",
"172.16.0.1",
"192.168.1.1",
}
for _, ip := range privateIPs {
t.Run("IP_"+ip, func(t *testing.T) {
// Use IP directly as hostname
url := "http://" + ip
_, err := ValidateExternalURL(url, WithAllowHTTP())
// Should fail with DNS resolution error (IP won't resolve)
// or be blocked as private IP if it somehow resolves
if err == nil {
t.Errorf("Expected error for private IP %s", ip)
}
})
}
}
func TestValidateExternalURL_CloudMetadataDetection(t *testing.T) {
// Test detection and blocking of cloud metadata endpoints
tests := []struct {
name string
url string
errContains string
}{
{
name: "AWS metadata service",
url: "http://169.254.169.254/latest/meta-data/",
errContains: "dns resolution failed", // IP won't resolve in test env
},
{
name: "AWS metadata IPv6",
url: "http://[fd00:ec2::254]/latest/meta-data/",
errContains: "dns resolution failed",
},
{
name: "GCP metadata service",
url: "http://metadata.google.internal/computeMetadata/v1/",
errContains: "", // May resolve or fail depending on environment
},
{
name: "Azure metadata service",
url: "http://169.254.169.254/metadata/instance",
errContains: "dns resolution failed",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
_, err := ValidateExternalURL(tt.url, WithAllowHTTP())
// All metadata endpoints should be blocked one way or another
if err == nil {
t.Errorf("Cloud metadata endpoint should be blocked: %s", tt.url)
} else {
t.Logf("Correctly blocked %s with error: %v", tt.url, err)
}
})
}
}
func TestIsPrivateIP_IPv6Comprehensive(t *testing.T) {
// Comprehensive IPv6 private/reserved range testing
tests := []struct {
name string
ip string
isPrivate bool
}{
// IPv6 Loopback
{"IPv6 loopback", "::1", true},
{"IPv6 loopback expanded", "0000:0000:0000:0000:0000:0000:0000:0001", true},
// IPv6 Link-Local (fe80::/10)
{"IPv6 link-local start", "fe80::1", true},
{"IPv6 link-local mid", "fe80:0000:0000:0000:0204:61ff:fe9d:f156", true},
{"IPv6 link-local end", "febf:ffff:ffff:ffff:ffff:ffff:ffff:ffff", true},
// IPv6 Unique Local (fc00::/7)
{"IPv6 unique local fc00", "fc00::1", true},
{"IPv6 unique local fd00", "fd00::1", true},
{"IPv6 unique local fd12", "fd12:3456:789a:1::1", true},
{"IPv6 unique local fdff", "fdff:ffff:ffff:ffff:ffff:ffff:ffff:ffff", true},
// IPv6 Public addresses (should NOT be private)
{"IPv6 Google DNS", "2001:4860:4860::8888", false},
{"IPv6 Cloudflare DNS", "2606:4700:4700::1111", false},
{"IPv6 documentation range", "2001:db8::1", false}, // Reserved but not private for SSRF purposes
// IPv4-mapped IPv6 addresses
{"IPv4-mapped public", "::ffff:8.8.8.8", false},
{"IPv4-mapped loopback", "::ffff:127.0.0.1", true},
{"IPv4-mapped private", "::ffff:192.168.1.1", true},
// Edge cases
{"IPv6 unspecified", "::", true}, // Unspecified addresses should be blocked for SSRF protection
{"IPv6 multicast", "ff02::1", true}, // Multicast is blocked by IsLinkLocalMulticast()
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
ip := net.ParseIP(tt.ip)
if ip == nil {
t.Fatalf("Failed to parse IP: %s", tt.ip)
}
result := isPrivateIP(ip)
if result != tt.isPrivate {
t.Errorf("isPrivateIP(%s) = %v, want %v", tt.ip, result, tt.isPrivate)
}
})
}
}