mirror of
https://github.com/angristan/openvpn-install.git
synced 2025-12-16 17:07:02 +01:00
## Summary Comprehensive IPv4/IPv6 overhaul that decouples server endpoint addressing from client tunnel addressing, supporting all combinations with automatic leak prevention. ### Supported Configurations | Endpoint | Client Mode | Description | |----------|-------------|-------------| | IPv4 | IPv4-only | Traditional setup (4→4) | | IPv4 | Dual-stack | IPv4 endpoint, clients get both (4→4/6) | | IPv4 | IPv6-only | IPv4 endpoint, clients get IPv6 only (4→6) | | IPv6 | IPv4-only | IPv6 endpoint, clients get IPv4 only (6→4) | | IPv6 | Dual-stack | IPv6 endpoint, clients get both (6→4/6) | | IPv6 | IPv6-only | Full IPv6 setup (6→6) | ### Leak Prevention - **IPv4-only mode**: Pushes `block-ipv6` to clients, blocking all IPv6 traffic - **IPv6-only mode**: Assigns IPv4 addresses and pushes `redirect-gateway def1` to capture IPv4 traffic, which is then dropped (no IPv4 NAT configured) - **Dual-stack mode**: Both protocols tunneled normally ### New CLI Options ``` Network Options: --endpoint-type <4|6> Endpoint IP version (default: 4) --client-ipv4 Enable IPv4 for VPN clients (default: enabled) --no-client-ipv4 Disable IPv4 for VPN clients --client-ipv6 Enable IPv6 for VPN clients (default: disabled) --no-client-ipv6 Disable IPv6 for VPN clients --subnet-ipv4 <x.x.x.0> IPv4 VPN subnet (default: 10.8.0.0) --subnet-ipv6 <prefix> IPv6 VPN subnet (default: fd42:42:42:42::) ``` ### Usage Examples ```bash # Dual-stack clients (IPv4 + IPv6) ./openvpn-install.sh install --client-ipv4 --client-ipv6 # IPv6-only clients (IPv4 traffic blocked) ./openvpn-install.sh install --no-client-ipv4 --client-ipv6 # IPv4-only clients (IPv6 traffic blocked) - default behavior ./openvpn-install.sh install --client-ipv4 --no-client-ipv6 # IPv6 server endpoint ./openvpn-install.sh install --endpoint-type 6 --endpoint 2001:db8::1 # Custom subnets ./openvpn-install.sh install --client-ipv6 --subnet-ipv4 10.9.0.0 --subnet-ipv6 fd00🔢5678:: ``` ### Implementation Details **Core changes:** - New `ENDPOINT_TYPE` variable (4 or 6) controls server listening protocol - New `CLIENT_IPV4`/`CLIENT_IPV6` variables control client tunnel addressing - Renamed `VPN_SUBNET` → `VPN_SUBNET_IPV4`, added `VPN_SUBNET_IPV6` - Separate `resolvePublicIPv4()` and `resolvePublicIPv6()` functions - New `validate_subnet_ipv6()` for ULA (fd00::/8) validation **Protocol handling:** - Uses `proto udp6`/`tcp6` when endpoint type is IPv6 - Firewall and SELinux commands handle both protocol variants **Firewall updates:** - firewalld: Conditional IPv6 masquerade and forwarding - nftables: Separate ip/ip6 tables for NAT based on client config - iptables: ip6tables rules only when IPv6 clients enabled **DNS configuration:** - Unbound listens on IPv4/IPv6 gateway addresses as needed - All third-party DNS providers now include IPv6 servers: - Cloudflare: 2606:4700:4700::1111 - Quad9: 2620:fe::fe - Google: 2001:4860:4860::8888 - OpenDNS: 2620:119:35::35 - AdGuard: 2a10:50c0::ad1:ff **CI/Testing:** - Added `ubuntu-24.04-dual-stack` test matrix entry - Docker test container enables IPv6 forwarding - `CLIENT_IPV6` environment variable passed to test container ## Test Plan - [x] Shellcheck passes - [x] CI Docker tests pass (including new dual-stack test) - [x] Manual testing: IPv4-only mode blocks IPv6 traffic - [x] Manual testing: IPv6-only mode blocks IPv4 traffic - [x] Manual testing: Dual-stack mode tunnels both protocols --- Closes #1317 Closes #1288 Closes #1084 Closes #701 Closes #350
404 lines
12 KiB
Bash
Executable File
404 lines
12 KiB
Bash
Executable File
#!/bin/bash
|
|
set -e
|
|
|
|
echo "=== OpenVPN Client Container ==="
|
|
|
|
# Create TUN device if it doesn't exist
|
|
if [ ! -c /dev/net/tun ]; then
|
|
mkdir -p /dev/net
|
|
mknod /dev/net/tun c 10 200
|
|
chmod 600 /dev/net/tun
|
|
fi
|
|
|
|
echo "TUN device ready"
|
|
|
|
# Wait for client config to be available
|
|
echo "Waiting for client config..."
|
|
while [ ! -f /shared/client.ovpn ]; do
|
|
sleep 2
|
|
echo "Waiting for client config..."
|
|
done
|
|
|
|
echo "Client config found!"
|
|
cat /shared/client.ovpn
|
|
|
|
# Load VPN network config from server
|
|
if [ -f /shared/vpn-config.env ]; then
|
|
# shellcheck source=/dev/null
|
|
source /shared/vpn-config.env
|
|
echo "VPN config loaded: VPN_SUBNET_IPV4=$VPN_SUBNET_IPV4, VPN_GATEWAY=$VPN_GATEWAY"
|
|
if [ "${CLIENT_IPV6:-n}" = "y" ]; then
|
|
# shellcheck disable=SC2153 # Variables are sourced from vpn-config.env
|
|
echo "IPv6 enabled: VPN_SUBNET_IPV6=$VPN_SUBNET_IPV6, VPN_GATEWAY_IPV6=$VPN_GATEWAY_IPV6"
|
|
fi
|
|
else
|
|
echo "WARNING: vpn-config.env not found, using defaults"
|
|
VPN_SUBNET_IPV4="10.8.0.0"
|
|
VPN_GATEWAY="10.8.0.1"
|
|
CLIENT_IPV6="n"
|
|
fi
|
|
|
|
# Connect to VPN
|
|
echo "Connecting to OpenVPN server..."
|
|
openvpn --config /shared/client.ovpn --daemon --log /var/log/openvpn.log
|
|
|
|
# Wait for connection
|
|
echo "Waiting for VPN connection..."
|
|
while ! ip addr show tun0 2>/dev/null | grep -q "inet "; do
|
|
sleep 2
|
|
echo "Waiting for tun0..."
|
|
# Show recent log for debugging
|
|
if [ -f /var/log/openvpn.log ]; then
|
|
tail -3 /var/log/openvpn.log
|
|
fi
|
|
done
|
|
|
|
echo "=== VPN Connected! ==="
|
|
ip addr show tun0
|
|
|
|
# Allow routing tables to stabilize before running tests
|
|
# This prevents race conditions where tun0 is up but routing isn't ready
|
|
echo "Waiting for routing to stabilize..."
|
|
sleep 5
|
|
|
|
# Run connectivity tests
|
|
echo ""
|
|
echo "=== Running connectivity tests ==="
|
|
|
|
# Test 1: Check tun0 interface (IPv4)
|
|
echo "Test 1: Checking tun0 interface (IPv4)..."
|
|
# Extract base of subnet (e.g., "10.9.0" from "10.9.0.0")
|
|
VPN_SUBNET_BASE="${VPN_SUBNET_IPV4%.*}"
|
|
if ip addr show tun0 | grep -q "$VPN_SUBNET_BASE"; then
|
|
echo "PASS: tun0 interface has correct IPv4 range (${VPN_SUBNET_BASE}.x)"
|
|
else
|
|
echo "FAIL: tun0 interface doesn't have expected IPv4"
|
|
exit 1
|
|
fi
|
|
|
|
# Test 1b: Check tun0 IPv6 address (if IPv6 enabled)
|
|
if [ "${CLIENT_IPV6:-n}" = "y" ]; then
|
|
echo "Test 1b: Checking tun0 interface (IPv6)..."
|
|
# Extract prefix of subnet (e.g., "fd42:42:42:42" from "fd42:42:42:42::")
|
|
VPN_SUBNET_IPV6_PREFIX="${VPN_SUBNET_IPV6%::}"
|
|
if ip -6 addr show tun0 | grep -q "$VPN_SUBNET_IPV6_PREFIX"; then
|
|
echo "PASS: tun0 interface has correct IPv6 range (${VPN_SUBNET_IPV6_PREFIX}::x)"
|
|
else
|
|
echo "FAIL: tun0 interface doesn't have expected IPv6"
|
|
ip -6 addr show tun0
|
|
exit 1
|
|
fi
|
|
fi
|
|
|
|
# Test 2: Ping VPN gateway (IPv4) (retries indefinitely, relies on job timeout)
|
|
echo "Test 2: Pinging VPN gateway (IPv4) ($VPN_GATEWAY)..."
|
|
while ! ping -c 3 -W 2 "$VPN_GATEWAY" >/dev/null 2>&1; do
|
|
echo "Ping failed, retrying..."
|
|
sleep 3
|
|
done
|
|
echo "PASS: Can ping VPN gateway (IPv4)"
|
|
|
|
# Test 2b: Ping VPN gateway (IPv6, if enabled)
|
|
if [ "${CLIENT_IPV6:-n}" = "y" ]; then
|
|
echo "Test 2b: Pinging VPN gateway (IPv6) ($VPN_GATEWAY_IPV6)..."
|
|
if ping6 -c 5 "$VPN_GATEWAY_IPV6"; then
|
|
echo "PASS: Can ping VPN gateway (IPv6)"
|
|
else
|
|
echo "FAIL: Cannot ping VPN gateway (IPv6)"
|
|
exit 1
|
|
fi
|
|
fi
|
|
|
|
# Test 3: DNS resolution through Unbound
|
|
echo "Test 3: Testing DNS resolution via Unbound ($VPN_GATEWAY)..."
|
|
DNS_SUCCESS=false
|
|
DNS_MAX_RETRIES=10
|
|
for i in $(seq 1 $DNS_MAX_RETRIES); do
|
|
DIG_OUTPUT=$(dig @"$VPN_GATEWAY" example.com +short +time=5 2>&1)
|
|
if [ -n "$DIG_OUTPUT" ] && ! echo "$DIG_OUTPUT" | grep -qi "timed out\|SERVFAIL\|connection refused"; then
|
|
DNS_SUCCESS=true
|
|
break
|
|
fi
|
|
echo "DNS attempt $i failed:"
|
|
echo "$DIG_OUTPUT"
|
|
sleep 2
|
|
done
|
|
if [ "$DNS_SUCCESS" = true ]; then
|
|
echo "PASS: DNS resolution through Unbound works"
|
|
echo "Resolved example.com to: $(dig @"$VPN_GATEWAY" example.com +short +time=5)"
|
|
else
|
|
echo "FAIL: DNS resolution through Unbound failed after $DNS_MAX_RETRIES attempts"
|
|
dig @"$VPN_GATEWAY" example.com +time=5 || true
|
|
exit 1
|
|
fi
|
|
|
|
echo ""
|
|
echo "=== Initial connectivity tests PASSED ==="
|
|
|
|
# Signal server that initial tests passed
|
|
touch /shared/initial-tests-passed
|
|
|
|
# =====================================================
|
|
# Certificate Revocation E2E Tests
|
|
# =====================================================
|
|
echo ""
|
|
echo "=== Starting Certificate Revocation E2E Tests ==="
|
|
|
|
REVOKE_CLIENT="revoketest"
|
|
|
|
# Wait for revoke test client config
|
|
echo "Waiting for revoke test client config..."
|
|
while [ ! -f /shared/revoke-client-config-ready ]; do
|
|
sleep 2
|
|
echo "Waiting for revoke test config..."
|
|
done
|
|
|
|
if [ ! -f "/shared/$REVOKE_CLIENT.ovpn" ]; then
|
|
echo "FAIL: Revoke test client config file not found"
|
|
exit 1
|
|
fi
|
|
|
|
echo "Revoke test client config found!"
|
|
|
|
# Disconnect current VPN (testclient) before connecting with revoke test client
|
|
echo "Disconnecting current VPN connection..."
|
|
pkill openvpn || true
|
|
sleep 2
|
|
|
|
# Connect with revoke test client
|
|
echo "Connecting with '$REVOKE_CLIENT' certificate..."
|
|
openvpn --config "/shared/$REVOKE_CLIENT.ovpn" --daemon --log /var/log/openvpn-revoke.log
|
|
|
|
# Wait for connection
|
|
echo "Waiting for VPN connection with revoke test client..."
|
|
while ! ip addr show tun0 2>/dev/null | grep -q "inet "; do
|
|
sleep 2
|
|
echo "Waiting for tun0..."
|
|
if [ -f /var/log/openvpn-revoke.log ]; then
|
|
tail -3 /var/log/openvpn-revoke.log
|
|
fi
|
|
done
|
|
|
|
echo "PASS: Connected with '$REVOKE_CLIENT' certificate"
|
|
ip addr show tun0
|
|
|
|
# Verify connectivity (retries indefinitely, relies on job timeout)
|
|
while ! ping -c 3 -W 2 "$VPN_GATEWAY" >/dev/null 2>&1; do
|
|
echo "Ping failed, retrying..."
|
|
sleep 3
|
|
done
|
|
echo "PASS: Can ping VPN gateway with revoke test client"
|
|
|
|
# Signal server that we're connected with revoke test client
|
|
touch /shared/revoke-client-connected
|
|
|
|
# Wait for server to signal us to disconnect
|
|
echo "Waiting for server to signal disconnect..."
|
|
while [ ! -f /shared/revoke-client-disconnect ]; do
|
|
sleep 2
|
|
done
|
|
|
|
# Disconnect
|
|
echo "Disconnecting revoke test client..."
|
|
pkill openvpn || true
|
|
|
|
# Wait for openvpn to fully exit and tun0 to be released
|
|
WAITED=0
|
|
MAX_WAIT_DISCONNECT=10
|
|
while (pgrep openvpn >/dev/null || ip addr show tun0 2>/dev/null | grep -q "inet ") && [ $WAITED -lt $MAX_WAIT_DISCONNECT ]; do
|
|
sleep 1
|
|
WAITED=$((WAITED + 1))
|
|
done
|
|
|
|
# Verify disconnected
|
|
if ip addr show tun0 2>/dev/null | grep -q "inet "; then
|
|
echo "FAIL: tun0 still has IP after disconnect"
|
|
exit 1
|
|
fi
|
|
echo "PASS: Disconnected successfully"
|
|
|
|
# Signal server that we're disconnected
|
|
touch /shared/revoke-client-disconnected
|
|
|
|
# Wait for server to revoke the certificate and signal us to reconnect
|
|
echo "Waiting for server to revoke certificate and signal reconnect..."
|
|
while [ ! -f /shared/revoke-try-reconnect ]; do
|
|
sleep 2
|
|
done
|
|
|
|
# Try to reconnect with the now-revoked certificate (should fail)
|
|
echo "Attempting to reconnect with revoked certificate (should fail)..."
|
|
rm -f /var/log/openvpn-revoke-fail.log
|
|
openvpn --config "/shared/$REVOKE_CLIENT.ovpn" --daemon --log /var/log/openvpn-revoke-fail.log
|
|
|
|
# Wait and check if connection fails
|
|
# The connection should fail due to certificate being revoked
|
|
echo "Waiting to verify connection is rejected..."
|
|
CONNECT_FAILED=false
|
|
while true; do
|
|
sleep 2
|
|
|
|
# Check if tun0 came up (would mean revocation didn't work)
|
|
if ip addr show tun0 2>/dev/null | grep -q "inet "; then
|
|
echo "FAIL: Connection succeeded with revoked certificate!"
|
|
cat /var/log/openvpn-revoke-fail.log || true
|
|
exit 1
|
|
fi
|
|
|
|
# Check for certificate verification failure in log
|
|
if [ -f /var/log/openvpn-revoke-fail.log ]; then
|
|
if grep -qi "certificate verify failed\|TLS Error\|AUTH_FAILED\|certificate revoked" /var/log/openvpn-revoke-fail.log; then
|
|
echo "Connection correctly rejected (certificate revoked)"
|
|
CONNECT_FAILED=true
|
|
break
|
|
fi
|
|
fi
|
|
|
|
echo "Checking connection status..."
|
|
if [ -f /var/log/openvpn-revoke-fail.log ]; then
|
|
tail -3 /var/log/openvpn-revoke-fail.log
|
|
fi
|
|
done
|
|
|
|
# Kill any remaining openvpn process
|
|
pkill openvpn 2>/dev/null || true
|
|
sleep 1
|
|
|
|
# Even if we didn't see explicit error, verify tun0 is not up
|
|
if ip addr show tun0 2>/dev/null | grep -q "inet "; then
|
|
echo "FAIL: tun0 interface exists - revoked cert may have connected"
|
|
exit 1
|
|
fi
|
|
|
|
if [ "$CONNECT_FAILED" = true ]; then
|
|
echo "PASS: Connection with revoked certificate was correctly rejected"
|
|
else
|
|
echo "PASS: Connection with revoked certificate did not succeed (no tun0)"
|
|
echo "OpenVPN log:"
|
|
cat /var/log/openvpn-revoke-fail.log || true
|
|
fi
|
|
|
|
# Signal server that reconnect with revoked cert failed
|
|
touch /shared/revoke-reconnect-failed
|
|
|
|
# =====================================================
|
|
# Test connecting with new certificate (same name)
|
|
# =====================================================
|
|
echo ""
|
|
echo "=== Testing connection with recreated certificate ==="
|
|
|
|
# Wait for server to create new cert and signal us
|
|
echo "Waiting for new client config with same name..."
|
|
while [ ! -f /shared/new-client-config-ready ]; do
|
|
sleep 2
|
|
echo "Waiting for new config..."
|
|
done
|
|
|
|
if [ ! -f "/shared/$REVOKE_CLIENT-new.ovpn" ]; then
|
|
echo "FAIL: New client config file not found"
|
|
exit 1
|
|
fi
|
|
|
|
echo "New client config found!"
|
|
|
|
# Connect with the new certificate
|
|
echo "Connecting with new '$REVOKE_CLIENT' certificate..."
|
|
rm -f /var/log/openvpn-new.log
|
|
openvpn --config "/shared/$REVOKE_CLIENT-new.ovpn" --daemon --log /var/log/openvpn-new.log
|
|
|
|
# Wait for connection
|
|
echo "Waiting for VPN connection with new certificate..."
|
|
while ! ip addr show tun0 2>/dev/null | grep -q "inet "; do
|
|
sleep 2
|
|
echo "Waiting for tun0..."
|
|
if [ -f /var/log/openvpn-new.log ]; then
|
|
tail -3 /var/log/openvpn-new.log
|
|
fi
|
|
done
|
|
|
|
echo "PASS: Connected with new '$REVOKE_CLIENT' certificate"
|
|
ip addr show tun0
|
|
|
|
# Verify connectivity (retries indefinitely, relies on job timeout)
|
|
while ! ping -c 3 -W 2 "$VPN_GATEWAY" >/dev/null 2>&1; do
|
|
echo "Ping failed, retrying..."
|
|
sleep 3
|
|
done
|
|
echo "PASS: Can ping VPN gateway with new certificate"
|
|
|
|
# Signal server that we connected with new cert
|
|
touch /shared/new-client-connected
|
|
|
|
echo ""
|
|
echo "=== Certificate Revocation E2E Tests PASSED ==="
|
|
|
|
# =====================================================
|
|
# Test PASSPHRASE-protected client connection
|
|
# =====================================================
|
|
echo ""
|
|
echo "=== Testing PASSPHRASE-protected Client Connection ==="
|
|
|
|
PASSPHRASE_CLIENT="passphrasetest"
|
|
|
|
# Wait for passphrase test client config
|
|
echo "Waiting for passphrase test client config..."
|
|
while [ ! -f /shared/passphrase-client-config-ready ]; do
|
|
sleep 2
|
|
echo "Waiting for passphrase test config..."
|
|
done
|
|
|
|
if [ ! -f "/shared/$PASSPHRASE_CLIENT.ovpn" ]; then
|
|
echo "FAIL: Passphrase test client config file not found"
|
|
exit 1
|
|
fi
|
|
|
|
if [ ! -f "/shared/$PASSPHRASE_CLIENT.pass" ]; then
|
|
echo "FAIL: Passphrase file not found"
|
|
exit 1
|
|
fi
|
|
|
|
echo "Passphrase test client config found!"
|
|
|
|
# Disconnect current VPN before connecting with passphrase client
|
|
echo "Disconnecting current VPN connection..."
|
|
pkill openvpn || true
|
|
sleep 2
|
|
|
|
# Connect with passphrase-protected client using --askpass
|
|
echo "Connecting with '$PASSPHRASE_CLIENT' certificate (passphrase-protected)..."
|
|
openvpn --config "/shared/$PASSPHRASE_CLIENT.ovpn" --askpass "/shared/$PASSPHRASE_CLIENT.pass" --daemon --log /var/log/openvpn-passphrase.log
|
|
|
|
# Wait for connection
|
|
echo "Waiting for VPN connection with passphrase-protected client..."
|
|
while ! ip addr show tun0 2>/dev/null | grep -q "inet "; do
|
|
sleep 2
|
|
echo "Waiting for tun0..."
|
|
if [ -f /var/log/openvpn-passphrase.log ]; then
|
|
tail -3 /var/log/openvpn-passphrase.log
|
|
fi
|
|
done
|
|
|
|
echo "PASS: Connected with passphrase-protected '$PASSPHRASE_CLIENT' certificate"
|
|
ip addr show tun0
|
|
|
|
# Verify connectivity (retries indefinitely, relies on job timeout)
|
|
while ! ping -c 3 -W 2 "$VPN_GATEWAY" >/dev/null 2>&1; do
|
|
echo "Ping failed, retrying..."
|
|
sleep 3
|
|
done
|
|
echo "PASS: Can ping VPN gateway with passphrase-protected client"
|
|
|
|
# Signal server that we connected with passphrase client
|
|
touch /shared/passphrase-client-connected
|
|
|
|
echo ""
|
|
echo "=== PASSPHRASE-protected Client Tests PASSED ==="
|
|
|
|
echo ""
|
|
echo "=========================================="
|
|
echo " ALL TESTS PASSED!"
|
|
echo "=========================================="
|
|
|
|
# Keep container running for debugging if needed
|
|
exec tail -f /var/log/openvpn-new.log 2>/dev/null || tail -f /var/log/openvpn.log 2>/dev/null || sleep infinity
|