#!/bin/bash # shellcheck disable=SC1091,SC2034 # SC1091: Not following /etc/os-release (sourced dynamically) # SC2034: Variables used indirectly or exported for subprocesses # Secure OpenVPN server installer for Debian, Ubuntu, CentOS, Amazon Linux 2, Fedora, Oracle Linux, Arch Linux, Rocky Linux and AlmaLinux. # https://github.com/angristan/openvpn-install # Configuration constants readonly CERT_VALIDITY_DAYS=3650 # 10 years readonly CRL_VALIDITY_DAYS=3650 # 10 years readonly EASYRSA_VERSION="3.1.2" readonly EASYRSA_SHA256="d63cf129490ffd6d8792ede7344806c506c82c32428b5bb609ad97ca6a6e4499" # ============================================================================= # Logging Configuration # ============================================================================= # Set VERBOSE=1 to see command output, VERBOSE=0 (default) for quiet mode # Set LOG_FILE to customize log location (default: openvpn-install.log in current dir) # Set LOG_FILE="" to disable file logging VERBOSE=${VERBOSE:-0} LOG_FILE=${LOG_FILE:-openvpn-install.log} # Color definitions (disabled if not a terminal, unless FORCE_COLOR=1) if [[ -t 1 ]] || [[ $FORCE_COLOR == "1" ]]; then readonly COLOR_RESET='\033[0m' readonly COLOR_RED='\033[0;31m' readonly COLOR_GREEN='\033[0;32m' readonly COLOR_YELLOW='\033[0;33m' readonly COLOR_BLUE='\033[0;34m' readonly COLOR_CYAN='\033[0;36m' readonly COLOR_DIM='\033[0;90m' readonly COLOR_BOLD='\033[1m' else readonly COLOR_RESET='' readonly COLOR_RED='' readonly COLOR_GREEN='' readonly COLOR_YELLOW='' readonly COLOR_BLUE='' readonly COLOR_CYAN='' readonly COLOR_DIM='' readonly COLOR_BOLD='' fi # Write to log file (no colors, with timestamp) _log_to_file() { if [[ -n "$LOG_FILE" ]]; then echo "$(date '+%Y-%m-%d %H:%M:%S') $*" >>"$LOG_FILE" fi } # Logging functions log_info() { echo -e "${COLOR_BLUE}[INFO]${COLOR_RESET} $*" _log_to_file "[INFO] $*" } log_warn() { echo -e "${COLOR_YELLOW}[WARN]${COLOR_RESET} $*" _log_to_file "[WARN] $*" } log_error() { echo -e "${COLOR_RED}[ERROR]${COLOR_RESET} $*" >&2 _log_to_file "[ERROR] $*" if [[ -n "$LOG_FILE" ]]; then echo -e "${COLOR_YELLOW} Check the log file for details: ${LOG_FILE}${COLOR_RESET}" >&2 fi } log_fatal() { echo -e "${COLOR_RED}[ERROR]${COLOR_RESET} $*" >&2 _log_to_file "[FATAL] $*" if [[ -n "$LOG_FILE" ]]; then echo -e "${COLOR_YELLOW} Check the log file for details: ${LOG_FILE}${COLOR_RESET}" >&2 _log_to_file "Script exited with error" fi exit 1 } log_success() { echo -e "${COLOR_GREEN}[OK]${COLOR_RESET} $*" _log_to_file "[OK] $*" } log_debug() { if [[ $VERBOSE -eq 1 ]]; then echo -e "${COLOR_DIM}[DEBUG]${COLOR_RESET} $*" fi _log_to_file "[DEBUG] $*" } log_prompt() { # For user-facing prompts/questions (no prefix, just cyan) # Skip display in auto-install mode if [[ $AUTO_INSTALL != "y" ]]; then echo -e "${COLOR_CYAN}$*${COLOR_RESET}" fi _log_to_file "[PROMPT] $*" } log_header() { # For section headers # Skip display in auto-install mode if [[ $AUTO_INSTALL != "y" ]]; then echo "" echo -e "${COLOR_BOLD}${COLOR_BLUE}=== $* ===${COLOR_RESET}" echo "" fi _log_to_file "=== $* ===" } log_menu() { # For menu options - only show in interactive mode if [[ $AUTO_INSTALL != "y" ]]; then echo "$@" fi } # Run a command with optional output suppression # Usage: run_cmd "description" command [args...] run_cmd() { local desc="$1" shift echo -e "${COLOR_DIM}> $*${COLOR_RESET}" _log_to_file "[CMD] $*" if [[ $VERBOSE -eq 1 ]]; then if [[ -n "$LOG_FILE" ]]; then "$@" 2>&1 | tee -a "$LOG_FILE" else "$@" fi else if [[ -n "$LOG_FILE" ]]; then "$@" >>"$LOG_FILE" 2>&1 else "$@" >/dev/null 2>&1 fi fi local ret=$? if [[ $ret -eq 0 ]]; then log_debug "$desc completed successfully" else log_error "$desc failed with exit code $ret" fi return $ret } function isRoot() { if [ "$EUID" -ne 0 ]; then return 1 fi } function tunAvailable() { if [ ! -e /dev/net/tun ]; then return 1 fi } function checkOS() { if [[ -e /etc/debian_version ]]; then OS="debian" source /etc/os-release if [[ $ID == "debian" || $ID == "raspbian" ]]; then if [[ $VERSION_ID -lt 11 ]]; then log_warn "Your version of Debian is not supported." log_info "However, if you're using Debian >= 11 or unstable/testing, you can continue at your own risk." until [[ $CONTINUE =~ (y|n) ]]; do read -rp "Continue? [y/n]: " -e CONTINUE done if [[ $CONTINUE == "n" ]]; then exit 1 fi fi elif [[ $ID == "ubuntu" ]]; then OS="ubuntu" MAJOR_UBUNTU_VERSION=$(echo "$VERSION_ID" | cut -d '.' -f1) if [[ $MAJOR_UBUNTU_VERSION -lt 18 ]]; then log_warn "Your version of Ubuntu is not supported." log_info "However, if you're using Ubuntu >= 18.04 or beta, you can continue at your own risk." until [[ $CONTINUE =~ (y|n) ]]; do read -rp "Continue? [y/n]: " -e CONTINUE done if [[ $CONTINUE == "n" ]]; then exit 1 fi fi fi elif [[ -e /etc/system-release ]]; then source /etc/os-release if [[ $ID == "fedora" || $ID_LIKE == "fedora" ]]; then OS="fedora" fi if [[ $ID == "centos" || $ID == "rocky" || $ID == "almalinux" ]]; then OS="centos" if [[ ${VERSION_ID%.*} -lt 8 ]]; then log_info "The script only supports CentOS Stream 8+ / Rocky Linux 8+ / AlmaLinux 8+." log_fatal "Your version of CentOS is not supported." fi fi if [[ $ID == "ol" ]]; then OS="oracle" if [[ ! $VERSION_ID =~ ^(8|9) ]]; then log_info "The script only supports Oracle Linux 8 and 9." log_fatal "Your version of Oracle Linux is not supported." fi fi if [[ $ID == "amzn" ]]; then if [[ $VERSION_ID == "2" ]]; then OS="amzn" elif [[ "$(echo "$PRETTY_NAME" | cut -c 1-18)" == "Amazon Linux 2023." ]] && [[ "$(echo "$PRETTY_NAME" | cut -c 19)" -ge 6 ]]; then OS="amzn2023" else log_info "The script only supports Amazon Linux 2 or Amazon Linux 2023.6+" log_fatal "Your version of Amazon Linux is not supported." fi fi elif [[ -e /etc/arch-release ]]; then OS=arch else log_fatal "It looks like you aren't running this installer on a Debian, Ubuntu, Fedora, CentOS, Amazon Linux 2, Oracle Linux or Arch Linux system." fi } function initialCheck() { if ! isRoot; then log_fatal "Sorry, you need to run this script as root." fi if ! tunAvailable; then log_fatal "TUN is not available." fi checkOS } function installUnbound() { log_info "Installing Unbound DNS resolver..." # If Unbound isn't installed, install it if [[ ! -e /etc/unbound/unbound.conf ]]; then if [[ $OS =~ (debian|ubuntu) ]]; then run_cmd "Installing Unbound" apt-get install -y unbound # Configuration echo 'interface: 10.8.0.1 access-control: 10.8.0.1/24 allow hide-identity: yes hide-version: yes use-caps-for-id: yes prefetch: yes' >>/etc/unbound/unbound.conf elif [[ $OS =~ (centos|amzn|oracle) ]]; then run_cmd "Installing Unbound" yum install -y unbound # Configuration sed -i 's|# interface: 0.0.0.0$|interface: 10.8.0.1|' /etc/unbound/unbound.conf sed -i 's|# access-control: 127.0.0.0/8 allow|access-control: 10.8.0.1/24 allow|' /etc/unbound/unbound.conf sed -i 's|# hide-identity: no|hide-identity: yes|' /etc/unbound/unbound.conf sed -i 's|# hide-version: no|hide-version: yes|' /etc/unbound/unbound.conf sed -i 's|use-caps-for-id: no|use-caps-for-id: yes|' /etc/unbound/unbound.conf elif [[ $OS == "fedora" ]]; then run_cmd "Installing Unbound" dnf install -y unbound # Configuration sed -i 's|# interface: 0.0.0.0$|interface: 10.8.0.1|' /etc/unbound/unbound.conf sed -i 's|# access-control: 127.0.0.0/8 allow|access-control: 10.8.0.1/24 allow|' /etc/unbound/unbound.conf sed -i 's|# hide-identity: no|hide-identity: yes|' /etc/unbound/unbound.conf sed -i 's|# hide-version: no|hide-version: yes|' /etc/unbound/unbound.conf sed -i 's|# use-caps-for-id: no|use-caps-for-id: yes|' /etc/unbound/unbound.conf elif [[ $OS == "arch" ]]; then run_cmd "Installing Unbound" pacman -Syu --noconfirm unbound # Get root servers list run_cmd "Downloading root hints" curl -o /etc/unbound/root.hints https://www.internic.net/domain/named.cache # Verify download was successful and file contains expected content if [[ ! -s /etc/unbound/root.hints ]] || ! grep -q "ROOT-SERVERS" /etc/unbound/root.hints; then run_cmd "Cleaning up invalid file" rm -f /etc/unbound/root.hints log_fatal "Failed to download root.hints or file is invalid!" fi if [[ ! -f /etc/unbound/unbound.conf.old ]]; then run_cmd "Backing up unbound.conf" mv /etc/unbound/unbound.conf /etc/unbound/unbound.conf.old fi echo 'server: use-syslog: yes do-daemonize: no username: "unbound" directory: "/etc/unbound" trust-anchor-file: trusted-key.key root-hints: root.hints interface: 10.8.0.1 access-control: 10.8.0.1/24 allow port: 53 num-threads: 2 use-caps-for-id: yes harden-glue: yes hide-identity: yes hide-version: yes qname-minimisation: yes prefetch: yes' >/etc/unbound/unbound.conf fi # IPv6 DNS for all OS if [[ $IPV6_SUPPORT == 'y' ]]; then echo 'interface: fd42:42:42:42::1 access-control: fd42:42:42:42::/112 allow' >>/etc/unbound/unbound.conf fi if [[ ! $OS =~ (fedora|centos|amzn|oracle) ]]; then # DNS Rebinding fix echo "private-address: 10.0.0.0/8 private-address: fd42:42:42:42::/112 private-address: 172.16.0.0/12 private-address: 192.168.0.0/16 private-address: 169.254.0.0/16 private-address: fd00::/8 private-address: fe80::/10 private-address: 127.0.0.0/8 private-address: ::ffff:0:0/96" >>/etc/unbound/unbound.conf fi else # Unbound is already installed echo 'include: /etc/unbound/openvpn.conf' >>/etc/unbound/unbound.conf # Add Unbound 'server' for the OpenVPN subnet echo 'server: interface: 10.8.0.1 access-control: 10.8.0.1/24 allow hide-identity: yes hide-version: yes use-caps-for-id: yes prefetch: yes private-address: 10.0.0.0/8 private-address: fd42:42:42:42::/112 private-address: 172.16.0.0/12 private-address: 192.168.0.0/16 private-address: 169.254.0.0/16 private-address: fd00::/8 private-address: fe80::/10 private-address: 127.0.0.0/8 private-address: ::ffff:0:0/96' >/etc/unbound/openvpn.conf if [[ $IPV6_SUPPORT == 'y' ]]; then echo 'interface: fd42:42:42:42::1 access-control: fd42:42:42:42::/112 allow' >>/etc/unbound/openvpn.conf fi fi run_cmd "Enabling Unbound service" systemctl enable unbound run_cmd "Starting Unbound service" systemctl restart unbound } function resolvePublicIP() { # IP version flags, we'll use as default the IPv4 CURL_IP_VERSION_FLAG="-4" DIG_IP_VERSION_FLAG="-4" # Behind NAT, we'll default to the publicly reachable IPv4/IPv6. if [[ $IPV6_SUPPORT == "y" ]]; then CURL_IP_VERSION_FLAG="" DIG_IP_VERSION_FLAG="-6" fi # If there is no public ip yet, we'll try to solve it using: https://api.seeip.org if [[ -z $PUBLIC_IP ]]; then PUBLIC_IP=$(curl -f -m 5 -sS --retry 2 --retry-connrefused "$CURL_IP_VERSION_FLAG" https://api.seeip.org 2>/dev/null) fi # If there is no public ip yet, we'll try to solve it using: https://ifconfig.me if [[ -z $PUBLIC_IP ]]; then PUBLIC_IP=$(curl -f -m 5 -sS --retry 2 --retry-connrefused "$CURL_IP_VERSION_FLAG" https://ifconfig.me 2>/dev/null) fi # If there is no public ip yet, we'll try to solve it using: https://api.ipify.org if [[ -z $PUBLIC_IP ]]; then PUBLIC_IP=$(curl -f -m 5 -sS --retry 2 --retry-connrefused "$CURL_IP_VERSION_FLAG" https://api.ipify.org 2>/dev/null) fi # If there is no public ip yet, we'll try to solve it using: ns1.google.com if [[ -z $PUBLIC_IP ]]; then PUBLIC_IP=$(dig $DIG_IP_VERSION_FLAG TXT +short o-o.myaddr.l.google.com @ns1.google.com | tr -d '"') fi if [[ -z $PUBLIC_IP ]]; then log_fatal "Couldn't solve the public IP" fi echo "$PUBLIC_IP" } function installQuestions() { log_header "OpenVPN Installer" log_prompt "The git repository is available at: https://github.com/angristan/openvpn-install" log_prompt "I need to ask you a few questions before starting the setup." log_prompt "You can leave the default options and just press enter if you are okay with them." log_menu "" log_prompt "I need to know the IPv4 address of the network interface you want OpenVPN listening to." log_prompt "Unless your server is behind NAT, it should be your public IPv4 address." # Detect public IPv4 address and pre-fill for the user IP=$(ip -4 addr | sed -ne 's|^.* inet \([^/]*\)/.* scope global.*$|\1|p' | head -1) if [[ -z $IP ]]; then # Detect public IPv6 address IP=$(ip -6 addr | sed -ne 's|^.* inet6 \([^/]*\)/.* scope global.*$|\1|p' | head -1) fi APPROVE_IP=${APPROVE_IP:-n} if [[ $APPROVE_IP =~ n ]]; then read -rp "IP address: " -e -i "$IP" IP fi # If $IP is a private IP address, the server must be behind NAT if echo "$IP" | grep -qE '^(10\.|172\.1[6789]\.|172\.2[0-9]\.|172\.3[01]\.|192\.168)'; then log_menu "" log_prompt "It seems this server is behind NAT. What is its public IPv4 address or hostname?" log_prompt "We need it for the clients to connect to the server." if [[ -z $ENDPOINT ]]; then DEFAULT_ENDPOINT=$(resolvePublicIP) fi until [[ $ENDPOINT != "" ]]; do read -rp "Public IPv4 address or hostname: " -e -i "$DEFAULT_ENDPOINT" ENDPOINT done fi log_menu "" log_prompt "Checking for IPv6 connectivity..." # "ping6" and "ping -6" availability varies depending on the distribution if type ping6 >/dev/null 2>&1; then PING6="ping6 -c3 ipv6.google.com > /dev/null 2>&1" else PING6="ping -6 -c3 ipv6.google.com > /dev/null 2>&1" fi if eval "$PING6"; then log_prompt "Your host appears to have IPv6 connectivity." SUGGESTION="y" else log_prompt "Your host does not appear to have IPv6 connectivity." SUGGESTION="n" fi log_menu "" # Ask the user if they want to enable IPv6 regardless its availability. until [[ $IPV6_SUPPORT =~ (y|n) ]]; do read -rp "Do you want to enable IPv6 support (NAT)? [y/n]: " -e -i $SUGGESTION IPV6_SUPPORT done log_menu "" log_prompt "What port do you want OpenVPN to listen to?" log_menu " 1) Default: 1194" log_menu " 2) Custom" log_menu " 3) Random [49152-65535]" until [[ $PORT_CHOICE =~ ^[1-3]$ ]]; do read -rp "Port choice [1-3]: " -e -i 1 PORT_CHOICE done case $PORT_CHOICE in 1) PORT="1194" ;; 2) until [[ $PORT =~ ^[0-9]+$ ]] && [ "$PORT" -ge 1 ] && [ "$PORT" -le 65535 ]; do read -rp "Custom port [1-65535]: " -e -i 1194 PORT done ;; 3) # Generate random number within private ports range PORT=$(shuf -i49152-65535 -n1) log_info "Random Port: $PORT" ;; esac log_menu "" log_prompt "What protocol do you want OpenVPN to use?" log_prompt "UDP is faster. Unless it is not available, you shouldn't use TCP." log_menu " 1) UDP" log_menu " 2) TCP" until [[ $PROTOCOL_CHOICE =~ ^[1-2]$ ]]; do read -rp "Protocol [1-2]: " -e -i 1 PROTOCOL_CHOICE done case $PROTOCOL_CHOICE in 1) PROTOCOL="udp" ;; 2) PROTOCOL="tcp" ;; esac log_menu "" log_prompt "What DNS resolvers do you want to use with the VPN?" log_menu " 1) Current system resolvers (from /etc/resolv.conf)" log_menu " 2) Self-hosted DNS Resolver (Unbound)" log_menu " 3) Cloudflare (Anycast: worldwide)" log_menu " 4) Quad9 (Anycast: worldwide)" log_menu " 5) Quad9 uncensored (Anycast: worldwide)" log_menu " 6) FDN (France)" log_menu " 7) DNS.WATCH (Germany)" log_menu " 8) OpenDNS (Anycast: worldwide)" log_menu " 9) Google (Anycast: worldwide)" log_menu " 10) Yandex Basic (Russia)" log_menu " 11) AdGuard DNS (Anycast: worldwide)" log_menu " 12) NextDNS (Anycast: worldwide)" log_menu " 13) Custom" until [[ $DNS =~ ^[0-9]+$ ]] && [ "$DNS" -ge 1 ] && [ "$DNS" -le 13 ]; do read -rp "DNS [1-13]: " -e -i 11 DNS if [[ $DNS == 2 ]] && [[ -e /etc/unbound/unbound.conf ]]; then log_menu "" log_prompt "Unbound is already installed." log_prompt "You can allow the script to configure it in order to use it from your OpenVPN clients" log_prompt "We will simply add a second server to /etc/unbound/unbound.conf for the OpenVPN subnet." log_prompt "No changes are made to the current configuration." log_menu "" until [[ $CONTINUE =~ (y|n) ]]; do read -rp "Apply configuration changes to Unbound? [y/n]: " -e CONTINUE done if [[ $CONTINUE == "n" ]]; then # Break the loop and cleanup unset DNS unset CONTINUE fi elif [[ $DNS == "13" ]]; then until [[ $DNS1 =~ ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ ]]; do read -rp "Primary DNS: " -e DNS1 done until [[ $DNS2 =~ ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ ]]; do read -rp "Secondary DNS (optional): " -e DNS2 if [[ $DNS2 == "" ]]; then break fi done fi done log_menu "" log_prompt "Do you want to use compression? It is not recommended since the VORACLE attack makes use of it." until [[ $COMPRESSION_ENABLED =~ (y|n) ]]; do read -rp"Enable compression? [y/n]: " -e -i n COMPRESSION_ENABLED done if [[ $COMPRESSION_ENABLED == "y" ]]; then log_prompt "Choose which compression algorithm you want to use: (they are ordered by efficiency)" log_menu " 1) LZ4-v2" log_menu " 2) LZ4" log_menu " 3) LZ0" until [[ $COMPRESSION_CHOICE =~ ^[1-3]$ ]]; do read -rp"Compression algorithm [1-3]: " -e -i 1 COMPRESSION_CHOICE done case $COMPRESSION_CHOICE in 1) COMPRESSION_ALG="lz4-v2" ;; 2) COMPRESSION_ALG="lz4" ;; 3) COMPRESSION_ALG="lzo" ;; esac fi log_menu "" log_prompt "Do you want to customize encryption settings?" log_prompt "Unless you know what you're doing, you should stick with the default parameters provided by the script." log_prompt "Note that whatever you choose, all the choices presented in the script are safe (unlike OpenVPN's defaults)." log_prompt "See https://github.com/angristan/openvpn-install#security-and-encryption to learn more." log_menu "" until [[ $CUSTOMIZE_ENC =~ (y|n) ]]; do read -rp "Customize encryption settings? [y/n]: " -e -i n CUSTOMIZE_ENC done if [[ $CUSTOMIZE_ENC == "n" ]]; then # Use default, sane and fast parameters CIPHER="AES-128-GCM" CERT_TYPE="1" # ECDSA CERT_CURVE="prime256v1" CC_CIPHER="TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256" DH_TYPE="1" # ECDH DH_CURVE="prime256v1" HMAC_ALG="SHA256" TLS_SIG="1" # tls-crypt else log_menu "" log_prompt "Choose which cipher you want to use for the data channel:" log_menu " 1) AES-128-GCM (recommended)" log_menu " 2) AES-192-GCM" log_menu " 3) AES-256-GCM" log_menu " 4) AES-128-CBC" log_menu " 5) AES-192-CBC" log_menu " 6) AES-256-CBC" until [[ $CIPHER_CHOICE =~ ^[1-6]$ ]]; do read -rp "Cipher [1-6]: " -e -i 1 CIPHER_CHOICE done case $CIPHER_CHOICE in 1) CIPHER="AES-128-GCM" ;; 2) CIPHER="AES-192-GCM" ;; 3) CIPHER="AES-256-GCM" ;; 4) CIPHER="AES-128-CBC" ;; 5) CIPHER="AES-192-CBC" ;; 6) CIPHER="AES-256-CBC" ;; esac log_menu "" log_prompt "Choose what kind of certificate you want to use:" log_menu " 1) ECDSA (recommended)" log_menu " 2) RSA" until [[ $CERT_TYPE =~ ^[1-2]$ ]]; do read -rp"Certificate key type [1-2]: " -e -i 1 CERT_TYPE done case $CERT_TYPE in 1) log_menu "" log_prompt "Choose which curve you want to use for the certificate's key:" log_menu " 1) prime256v1 (recommended)" log_menu " 2) secp384r1" log_menu " 3) secp521r1" until [[ $CERT_CURVE_CHOICE =~ ^[1-3]$ ]]; do read -rp"Curve [1-3]: " -e -i 1 CERT_CURVE_CHOICE done case $CERT_CURVE_CHOICE in 1) CERT_CURVE="prime256v1" ;; 2) CERT_CURVE="secp384r1" ;; 3) CERT_CURVE="secp521r1" ;; esac ;; 2) log_menu "" log_prompt "Choose which size you want to use for the certificate's RSA key:" log_menu " 1) 2048 bits (recommended)" log_menu " 2) 3072 bits" log_menu " 3) 4096 bits" until [[ $RSA_KEY_SIZE_CHOICE =~ ^[1-3]$ ]]; do read -rp "RSA key size [1-3]: " -e -i 1 RSA_KEY_SIZE_CHOICE done case $RSA_KEY_SIZE_CHOICE in 1) RSA_KEY_SIZE="2048" ;; 2) RSA_KEY_SIZE="3072" ;; 3) RSA_KEY_SIZE="4096" ;; esac ;; esac log_menu "" log_prompt "Choose which cipher you want to use for the control channel:" case $CERT_TYPE in 1) log_menu " 1) ECDHE-ECDSA-AES-128-GCM-SHA256 (recommended)" log_menu " 2) ECDHE-ECDSA-AES-256-GCM-SHA384" until [[ $CC_CIPHER_CHOICE =~ ^[1-2]$ ]]; do read -rp"Control channel cipher [1-2]: " -e -i 1 CC_CIPHER_CHOICE done case $CC_CIPHER_CHOICE in 1) CC_CIPHER="TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256" ;; 2) CC_CIPHER="TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384" ;; esac ;; 2) log_menu " 1) ECDHE-RSA-AES-128-GCM-SHA256 (recommended)" log_menu " 2) ECDHE-RSA-AES-256-GCM-SHA384" until [[ $CC_CIPHER_CHOICE =~ ^[1-2]$ ]]; do read -rp"Control channel cipher [1-2]: " -e -i 1 CC_CIPHER_CHOICE done case $CC_CIPHER_CHOICE in 1) CC_CIPHER="TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256" ;; 2) CC_CIPHER="TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384" ;; esac ;; esac log_menu "" log_prompt "Choose what kind of Diffie-Hellman key you want to use:" log_menu " 1) ECDH (recommended)" log_menu " 2) DH" until [[ $DH_TYPE =~ [1-2] ]]; do read -rp"DH key type [1-2]: " -e -i 1 DH_TYPE done case $DH_TYPE in 1) log_menu "" log_prompt "Choose which curve you want to use for the ECDH key:" log_menu " 1) prime256v1 (recommended)" log_menu " 2) secp384r1" log_menu " 3) secp521r1" while [[ $DH_CURVE_CHOICE != "1" && $DH_CURVE_CHOICE != "2" && $DH_CURVE_CHOICE != "3" ]]; do read -rp"Curve [1-3]: " -e -i 1 DH_CURVE_CHOICE done case $DH_CURVE_CHOICE in 1) DH_CURVE="prime256v1" ;; 2) DH_CURVE="secp384r1" ;; 3) DH_CURVE="secp521r1" ;; esac ;; 2) log_menu "" log_prompt "Choose what size of Diffie-Hellman key you want to use:" log_menu " 1) 2048 bits (recommended)" log_menu " 2) 3072 bits" log_menu " 3) 4096 bits" until [[ $DH_KEY_SIZE_CHOICE =~ ^[1-3]$ ]]; do read -rp "DH key size [1-3]: " -e -i 1 DH_KEY_SIZE_CHOICE done case $DH_KEY_SIZE_CHOICE in 1) DH_KEY_SIZE="2048" ;; 2) DH_KEY_SIZE="3072" ;; 3) DH_KEY_SIZE="4096" ;; esac ;; esac log_menu "" # The "auth" options behaves differently with AEAD ciphers if [[ $CIPHER =~ CBC$ ]]; then log_prompt "The digest algorithm authenticates data channel packets and tls-auth packets from the control channel." elif [[ $CIPHER =~ GCM$ ]]; then log_prompt "The digest algorithm authenticates tls-auth packets from the control channel." fi log_prompt "Which digest algorithm do you want to use for HMAC?" log_menu " 1) SHA-256 (recommended)" log_menu " 2) SHA-384" log_menu " 3) SHA-512" until [[ $HMAC_ALG_CHOICE =~ ^[1-3]$ ]]; do read -rp "Digest algorithm [1-3]: " -e -i 1 HMAC_ALG_CHOICE done case $HMAC_ALG_CHOICE in 1) HMAC_ALG="SHA256" ;; 2) HMAC_ALG="SHA384" ;; 3) HMAC_ALG="SHA512" ;; esac log_menu "" log_prompt "You can add an additional layer of security to the control channel with tls-auth and tls-crypt" log_prompt "tls-auth authenticates the packets, while tls-crypt authenticate and encrypt them." log_menu " 1) tls-crypt (recommended)" log_menu " 2) tls-auth" until [[ $TLS_SIG =~ [1-2] ]]; do read -rp "Control channel additional security mechanism [1-2]: " -e -i 1 TLS_SIG done fi log_menu "" log_prompt "Okay, that was all I needed. We are ready to setup your OpenVPN server now." log_prompt "You will be able to generate a client at the end of the installation." APPROVE_INSTALL=${APPROVE_INSTALL:-n} if [[ $APPROVE_INSTALL =~ n ]]; then read -n1 -r -p "Press any key to continue..." fi } function installOpenVPN() { if [[ $AUTO_INSTALL == "y" ]]; then # Set default choices so that no questions will be asked. APPROVE_INSTALL=${APPROVE_INSTALL:-y} APPROVE_IP=${APPROVE_IP:-y} IPV6_SUPPORT=${IPV6_SUPPORT:-n} PORT_CHOICE=${PORT_CHOICE:-1} PROTOCOL_CHOICE=${PROTOCOL_CHOICE:-1} DNS=${DNS:-1} COMPRESSION_ENABLED=${COMPRESSION_ENABLED:-n} CUSTOMIZE_ENC=${CUSTOMIZE_ENC:-n} CLIENT=${CLIENT:-client} PASS=${PASS:-1} CONTINUE=${CONTINUE:-y} if [[ -z $ENDPOINT ]]; then ENDPOINT=$(resolvePublicIP) fi # Log auto-install mode and parameters log_info "=== OpenVPN Auto-Install ===" log_info "Running in auto-install mode with the following settings:" log_info " ENDPOINT=$ENDPOINT" log_info " IPV6_SUPPORT=$IPV6_SUPPORT" log_info " PORT_CHOICE=$PORT_CHOICE" log_info " PROTOCOL_CHOICE=$PROTOCOL_CHOICE" log_info " DNS=$DNS" log_info " COMPRESSION_ENABLED=$COMPRESSION_ENABLED" log_info " CUSTOMIZE_ENC=$CUSTOMIZE_ENC" log_info " CLIENT=$CLIENT" log_info " PASS=$PASS" fi # Run setup questions first, and set other variables if auto-install installQuestions # Get the "public" interface from the default route NIC=$(ip -4 route ls | grep default | grep -Po '(?<=dev )(\S+)' | head -1) if [[ -z $NIC ]] && [[ $IPV6_SUPPORT == 'y' ]]; then NIC=$(ip -6 route show default | sed -ne 's/^default .* dev \([^ ]*\) .*$/\1/p') fi # $NIC can not be empty for script rm-openvpn-rules.sh if [[ -z $NIC ]]; then log_warn "Could not detect public interface." log_info "This needs for setup MASQUERADE." until [[ $CONTINUE =~ (y|n) ]]; do read -rp "Continue? [y/n]: " -e CONTINUE done if [[ $CONTINUE == "n" ]]; then exit 1 fi fi # If OpenVPN isn't installed yet, install it. This script is more-or-less # idempotent on multiple runs, but will only install OpenVPN from upstream # the first time. if [[ ! -e /etc/openvpn/server.conf ]]; then log_header "Installing OpenVPN" if [[ $OS =~ (debian|ubuntu) ]]; then log_info "Updating package lists..." run_cmd "Update package lists" apt-get update run_cmd "Installing prerequisites" apt-get -y install ca-certificates gnupg # Ubuntu >= 18.04 and Debian >= 11 have OpenVPN >= 2.4 without the need of a third party repository. log_info "Installing OpenVPN and dependencies..." run_cmd "Installing OpenVPN" apt-get install -y openvpn iptables openssl wget ca-certificates curl elif [[ $OS == 'centos' ]]; then log_info "Installing EPEL repository..." run_cmd "Installing EPEL" yum install -y epel-release log_info "Installing OpenVPN and dependencies..." run_cmd "Installing OpenVPN" yum install -y openvpn iptables openssl wget ca-certificates curl tar 'policycoreutils-python*' elif [[ $OS == 'oracle' ]]; then log_info "Installing EPEL repository..." if [[ $VERSION_ID =~ ^8 ]]; then run_cmd "Installing Oracle EPEL" yum install -y oracle-epel-release-el8 run_cmd "Enabling EPEL repository" yum-config-manager --enable ol8_developer_EPEL elif [[ $VERSION_ID =~ ^9 ]]; then run_cmd "Installing Oracle EPEL" yum install -y oracle-epel-release-el9 run_cmd "Enabling EPEL repository" yum-config-manager --enable ol9_developer_EPEL fi log_info "Installing OpenVPN and dependencies..." run_cmd "Installing OpenVPN" yum install -y openvpn iptables openssl wget ca-certificates curl tar policycoreutils-python-utils elif [[ $OS == 'amzn' ]]; then log_info "Installing EPEL repository..." run_cmd "Installing EPEL" amazon-linux-extras install -y epel log_info "Installing OpenVPN and dependencies..." run_cmd "Installing OpenVPN" yum install -y openvpn iptables openssl wget ca-certificates curl elif [[ $OS == 'amzn2023' ]]; then log_info "Installing OpenVPN and dependencies..." run_cmd "Installing OpenVPN" dnf install -y openvpn iptables openssl wget ca-certificates elif [[ $OS == 'fedora' ]]; then log_info "Installing OpenVPN and dependencies..." run_cmd "Installing OpenVPN" dnf install -y openvpn iptables openssl wget ca-certificates curl policycoreutils-python-utils elif [[ $OS == 'arch' ]]; then # Install required dependencies and upgrade the system log_info "Installing OpenVPN and dependencies..." run_cmd "Installing OpenVPN" pacman --needed --noconfirm -Syu openvpn iptables openssl wget ca-certificates curl fi # An old version of easy-rsa was available by default in some openvpn packages if [[ -d /etc/openvpn/easy-rsa/ ]]; then run_cmd "Removing old Easy-RSA" rm -rf /etc/openvpn/easy-rsa/ fi fi # Find out if the machine uses nogroup or nobody for the permissionless group if grep -qs "^nogroup:" /etc/group; then NOGROUP=nogroup else NOGROUP=nobody fi # Install the latest version of easy-rsa from source, if not already installed. if [[ ! -d /etc/openvpn/easy-rsa/ ]]; then run_cmd "Downloading Easy-RSA v${EASYRSA_VERSION}" wget -O ~/easy-rsa.tgz "https://github.com/OpenVPN/easy-rsa/releases/download/v${EASYRSA_VERSION}/EasyRSA-${EASYRSA_VERSION}.tgz" log_info "Verifying Easy-RSA checksum..." if ! echo "${EASYRSA_SHA256} $HOME/easy-rsa.tgz" | sha256sum -c --status; then run_cmd "Cleaning up failed download" rm -f ~/easy-rsa.tgz log_fatal "SHA256 checksum verification failed for easy-rsa download!" fi run_cmd "Creating Easy-RSA directory" mkdir -p /etc/openvpn/easy-rsa run_cmd "Extracting Easy-RSA" tar xzf ~/easy-rsa.tgz --strip-components=1 --no-same-owner --directory /etc/openvpn/easy-rsa run_cmd "Cleaning up archive" rm -f ~/easy-rsa.tgz cd /etc/openvpn/easy-rsa/ || return case $CERT_TYPE in 1) echo "set_var EASYRSA_ALGO ec" >vars echo "set_var EASYRSA_CURVE $CERT_CURVE" >>vars ;; 2) echo "set_var EASYRSA_KEY_SIZE $RSA_KEY_SIZE" >vars ;; esac # Generate a random, alphanumeric identifier of 16 characters for CN and one for server name SERVER_CN="cn_$(head /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 16 | head -n 1)" echo "$SERVER_CN" >SERVER_CN_GENERATED SERVER_NAME="server_$(head /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 16 | head -n 1)" echo "$SERVER_NAME" >SERVER_NAME_GENERATED # Create the PKI, set up the CA, the DH params and the server certificate log_info "Initializing PKI..." run_cmd "Initializing PKI" ./easyrsa init-pki export EASYRSA_CA_EXPIRE=$CERT_VALIDITY_DAYS log_info "Building CA..." run_cmd "Building CA" ./easyrsa --batch --req-cn="$SERVER_CN" build-ca nopass if [[ $DH_TYPE == "2" ]]; then # ECDH keys are generated on-the-fly so we don't need to generate them beforehand run_cmd "Generating DH parameters (this may take a while)" openssl dhparam -out dh.pem "$DH_KEY_SIZE" fi export EASYRSA_CERT_EXPIRE=$CERT_VALIDITY_DAYS log_info "Building server certificate..." run_cmd "Building server certificate" ./easyrsa --batch build-server-full "$SERVER_NAME" nopass export EASYRSA_CRL_DAYS=$CRL_VALIDITY_DAYS run_cmd "Generating CRL" ./easyrsa gen-crl log_info "Generating TLS key..." case $TLS_SIG in 1) # Generate tls-crypt key run_cmd "Generating tls-crypt key" openvpn --genkey --secret /etc/openvpn/tls-crypt.key ;; 2) # Generate tls-auth key run_cmd "Generating tls-auth key" openvpn --genkey --secret /etc/openvpn/tls-auth.key ;; esac else # If easy-rsa is already installed, grab the generated SERVER_NAME # for client configs cd /etc/openvpn/easy-rsa/ || return SERVER_NAME=$(cat SERVER_NAME_GENERATED) fi # Move all the generated files log_info "Copying certificates..." run_cmd "Copying certificates to /etc/openvpn" cp pki/ca.crt pki/private/ca.key "pki/issued/$SERVER_NAME.crt" "pki/private/$SERVER_NAME.key" /etc/openvpn/easy-rsa/pki/crl.pem /etc/openvpn if [[ $DH_TYPE == "2" ]]; then run_cmd "Copying DH parameters" cp dh.pem /etc/openvpn fi # Make cert revocation list readable for non-root run_cmd "Setting CRL permissions" chmod 644 /etc/openvpn/crl.pem # Generate server.conf log_info "Generating server configuration..." echo "port $PORT" >/etc/openvpn/server.conf if [[ $IPV6_SUPPORT == 'n' ]]; then echo "proto $PROTOCOL" >>/etc/openvpn/server.conf elif [[ $IPV6_SUPPORT == 'y' ]]; then echo "proto ${PROTOCOL}6" >>/etc/openvpn/server.conf fi echo "dev tun user nobody group $NOGROUP persist-key persist-tun keepalive 10 120 topology subnet server 10.8.0.0 255.255.255.0 ifconfig-pool-persist ipp.txt" >>/etc/openvpn/server.conf # DNS resolvers case $DNS in 1) # Current system resolvers # Locate the proper resolv.conf # Needed for systems running systemd-resolved if grep -q "127.0.0.53" "/etc/resolv.conf"; then RESOLVCONF='/run/systemd/resolve/resolv.conf' else RESOLVCONF='/etc/resolv.conf' fi # Obtain the resolvers from resolv.conf and use them for OpenVPN sed -ne 's/^nameserver[[:space:]]\+\([^[:space:]]\+\).*$/\1/p' $RESOLVCONF | while read -r line; do # Copy, if it's a IPv4 |or| if IPv6 is enabled, IPv4/IPv6 does not matter if [[ $line =~ ^[0-9.]*$ ]] || [[ $IPV6_SUPPORT == 'y' ]]; then echo "push \"dhcp-option DNS $line\"" >>/etc/openvpn/server.conf fi done ;; 2) # Self-hosted DNS resolver (Unbound) echo 'push "dhcp-option DNS 10.8.0.1"' >>/etc/openvpn/server.conf if [[ $IPV6_SUPPORT == 'y' ]]; then echo 'push "dhcp-option DNS fd42:42:42:42::1"' >>/etc/openvpn/server.conf fi ;; 3) # Cloudflare echo 'push "dhcp-option DNS 1.0.0.1"' >>/etc/openvpn/server.conf echo 'push "dhcp-option DNS 1.1.1.1"' >>/etc/openvpn/server.conf ;; 4) # Quad9 echo 'push "dhcp-option DNS 9.9.9.9"' >>/etc/openvpn/server.conf echo 'push "dhcp-option DNS 149.112.112.112"' >>/etc/openvpn/server.conf ;; 5) # Quad9 uncensored echo 'push "dhcp-option DNS 9.9.9.10"' >>/etc/openvpn/server.conf echo 'push "dhcp-option DNS 149.112.112.10"' >>/etc/openvpn/server.conf ;; 6) # FDN echo 'push "dhcp-option DNS 80.67.169.40"' >>/etc/openvpn/server.conf echo 'push "dhcp-option DNS 80.67.169.12"' >>/etc/openvpn/server.conf ;; 7) # DNS.WATCH echo 'push "dhcp-option DNS 84.200.69.80"' >>/etc/openvpn/server.conf echo 'push "dhcp-option DNS 84.200.70.40"' >>/etc/openvpn/server.conf ;; 8) # OpenDNS echo 'push "dhcp-option DNS 208.67.222.222"' >>/etc/openvpn/server.conf echo 'push "dhcp-option DNS 208.67.220.220"' >>/etc/openvpn/server.conf ;; 9) # Google echo 'push "dhcp-option DNS 8.8.8.8"' >>/etc/openvpn/server.conf echo 'push "dhcp-option DNS 8.8.4.4"' >>/etc/openvpn/server.conf ;; 10) # Yandex Basic echo 'push "dhcp-option DNS 77.88.8.8"' >>/etc/openvpn/server.conf echo 'push "dhcp-option DNS 77.88.8.1"' >>/etc/openvpn/server.conf ;; 11) # AdGuard DNS echo 'push "dhcp-option DNS 94.140.14.14"' >>/etc/openvpn/server.conf echo 'push "dhcp-option DNS 94.140.15.15"' >>/etc/openvpn/server.conf ;; 12) # NextDNS echo 'push "dhcp-option DNS 45.90.28.167"' >>/etc/openvpn/server.conf echo 'push "dhcp-option DNS 45.90.30.167"' >>/etc/openvpn/server.conf ;; 13) # Custom DNS echo "push \"dhcp-option DNS $DNS1\"" >>/etc/openvpn/server.conf if [[ $DNS2 != "" ]]; then echo "push \"dhcp-option DNS $DNS2\"" >>/etc/openvpn/server.conf fi ;; esac echo 'push "redirect-gateway def1 bypass-dhcp"' >>/etc/openvpn/server.conf # IPv6 network settings if needed if [[ $IPV6_SUPPORT == 'y' ]]; then echo 'server-ipv6 fd42:42:42:42::/112 tun-ipv6 push tun-ipv6 push "route-ipv6 2000::/3" push "redirect-gateway ipv6"' >>/etc/openvpn/server.conf fi if [[ $COMPRESSION_ENABLED == "y" ]]; then echo "compress $COMPRESSION_ALG" >>/etc/openvpn/server.conf fi if [[ $DH_TYPE == "1" ]]; then echo "dh none" >>/etc/openvpn/server.conf echo "ecdh-curve $DH_CURVE" >>/etc/openvpn/server.conf elif [[ $DH_TYPE == "2" ]]; then echo "dh dh.pem" >>/etc/openvpn/server.conf fi case $TLS_SIG in 1) echo "tls-crypt tls-crypt.key" >>/etc/openvpn/server.conf ;; 2) echo "tls-auth tls-auth.key 0" >>/etc/openvpn/server.conf ;; esac echo "crl-verify crl.pem ca ca.crt cert $SERVER_NAME.crt key $SERVER_NAME.key auth $HMAC_ALG cipher $CIPHER ncp-ciphers $CIPHER tls-server tls-version-min 1.2 tls-cipher $CC_CIPHER client-config-dir /etc/openvpn/ccd status /var/log/openvpn/status.log verb 3" >>/etc/openvpn/server.conf # Create client-config-dir dir run_cmd "Creating client config directory" mkdir -p /etc/openvpn/ccd # Create log dir run_cmd "Creating log directory" mkdir -p /var/log/openvpn # Enable routing log_info "Enabling IP forwarding..." mkdir -p /etc/sysctl.d echo 'net.ipv4.ip_forward=1' >/etc/sysctl.d/99-openvpn.conf if [[ $IPV6_SUPPORT == 'y' ]]; then echo 'net.ipv6.conf.all.forwarding=1' >>/etc/sysctl.d/99-openvpn.conf fi # Apply sysctl rules run_cmd "Applying sysctl rules" sysctl --system # If SELinux is enabled and a custom port was selected, we need this if hash sestatus 2>/dev/null; then if sestatus | grep "Current mode" | grep -qs "enforcing"; then if [[ $PORT != '1194' ]]; then run_cmd "Configuring SELinux port" semanage port -a -t openvpn_port_t -p "$PROTOCOL" "$PORT" fi fi fi # Finally, restart and enable OpenVPN log_info "Configuring OpenVPN service..." if [[ $OS == 'arch' || $OS == 'fedora' || $OS == 'centos' || $OS == 'oracle' || $OS == 'amzn2023' ]]; then # Don't modify package-provided service run_cmd "Copying OpenVPN service file" cp /usr/lib/systemd/system/openvpn-server@.service /etc/systemd/system/openvpn-server@.service # Workaround to fix OpenVPN service on OpenVZ run_cmd "Patching service file (LimitNPROC)" sed -i 's|LimitNPROC|#LimitNPROC|' /etc/systemd/system/openvpn-server@.service # Another workaround to keep using /etc/openvpn/ run_cmd "Patching service file (paths)" sed -i 's|/etc/openvpn/server|/etc/openvpn|' /etc/systemd/system/openvpn-server@.service run_cmd "Reloading systemd" systemctl daemon-reload run_cmd "Enabling OpenVPN service" systemctl enable openvpn-server@server run_cmd "Starting OpenVPN service" systemctl restart openvpn-server@server else # Don't modify package-provided service run_cmd "Copying OpenVPN service file" cp /lib/systemd/system/openvpn\@.service /etc/systemd/system/openvpn\@.service # Workaround to fix OpenVPN service on OpenVZ run_cmd "Patching service file (LimitNPROC)" sed -i 's|LimitNPROC|#LimitNPROC|' /etc/systemd/system/openvpn\@.service # Another workaround to keep using /etc/openvpn/ run_cmd "Patching service file (paths)" sed -i 's|/etc/openvpn/server|/etc/openvpn|' /etc/systemd/system/openvpn\@.service run_cmd "Reloading systemd" systemctl daemon-reload run_cmd "Enabling OpenVPN service" systemctl enable openvpn@server run_cmd "Starting OpenVPN service" systemctl restart openvpn@server fi if [[ $DNS == 2 ]]; then installUnbound fi # Add iptables rules in two scripts log_info "Configuring firewall rules..." run_cmd "Creating iptables directory" mkdir -p /etc/iptables # Script to add rules echo "#!/bin/sh iptables -t nat -I POSTROUTING 1 -s 10.8.0.0/24 -o $NIC -j MASQUERADE iptables -I INPUT 1 -i tun0 -j ACCEPT iptables -I FORWARD 1 -i $NIC -o tun0 -j ACCEPT iptables -I FORWARD 1 -i tun0 -o $NIC -j ACCEPT iptables -I INPUT 1 -i $NIC -p $PROTOCOL --dport $PORT -j ACCEPT" >/etc/iptables/add-openvpn-rules.sh if [[ $IPV6_SUPPORT == 'y' ]]; then echo "ip6tables -t nat -I POSTROUTING 1 -s fd42:42:42:42::/112 -o $NIC -j MASQUERADE ip6tables -I INPUT 1 -i tun0 -j ACCEPT ip6tables -I FORWARD 1 -i $NIC -o tun0 -j ACCEPT ip6tables -I FORWARD 1 -i tun0 -o $NIC -j ACCEPT ip6tables -I INPUT 1 -i $NIC -p $PROTOCOL --dport $PORT -j ACCEPT" >>/etc/iptables/add-openvpn-rules.sh fi # Script to remove rules echo "#!/bin/sh iptables -t nat -D POSTROUTING -s 10.8.0.0/24 -o $NIC -j MASQUERADE iptables -D INPUT -i tun0 -j ACCEPT iptables -D FORWARD -i $NIC -o tun0 -j ACCEPT iptables -D FORWARD -i tun0 -o $NIC -j ACCEPT iptables -D INPUT -i $NIC -p $PROTOCOL --dport $PORT -j ACCEPT" >/etc/iptables/rm-openvpn-rules.sh if [[ $IPV6_SUPPORT == 'y' ]]; then echo "ip6tables -t nat -D POSTROUTING -s fd42:42:42:42::/112 -o $NIC -j MASQUERADE ip6tables -D INPUT -i tun0 -j ACCEPT ip6tables -D FORWARD -i $NIC -o tun0 -j ACCEPT ip6tables -D FORWARD -i tun0 -o $NIC -j ACCEPT ip6tables -D INPUT -i $NIC -p $PROTOCOL --dport $PORT -j ACCEPT" >>/etc/iptables/rm-openvpn-rules.sh fi run_cmd "Making iptables scripts executable" chmod +x /etc/iptables/add-openvpn-rules.sh run_cmd "Making iptables scripts executable" chmod +x /etc/iptables/rm-openvpn-rules.sh # Handle the rules via a systemd script echo "[Unit] Description=iptables rules for OpenVPN Before=network-online.target Wants=network-online.target [Service] Type=oneshot ExecStart=/etc/iptables/add-openvpn-rules.sh ExecStop=/etc/iptables/rm-openvpn-rules.sh RemainAfterExit=yes [Install] WantedBy=multi-user.target" >/etc/systemd/system/iptables-openvpn.service # Enable service and apply rules run_cmd "Reloading systemd" systemctl daemon-reload run_cmd "Enabling iptables service" systemctl enable iptables-openvpn run_cmd "Starting iptables service" systemctl start iptables-openvpn # If the server is behind a NAT, use the correct IP address for the clients to connect to if [[ $ENDPOINT != "" ]]; then IP=$ENDPOINT fi # client-template.txt is created so we have a template to add further users later log_info "Creating client template..." echo "client" >/etc/openvpn/client-template.txt if [[ $PROTOCOL == 'udp' ]]; then echo "proto udp" >>/etc/openvpn/client-template.txt echo "explicit-exit-notify" >>/etc/openvpn/client-template.txt elif [[ $PROTOCOL == 'tcp' ]]; then echo "proto tcp-client" >>/etc/openvpn/client-template.txt fi echo "remote $IP $PORT dev tun resolv-retry infinite nobind persist-key persist-tun remote-cert-tls server verify-x509-name $SERVER_NAME name auth $HMAC_ALG auth-nocache cipher $CIPHER tls-client tls-version-min 1.2 tls-cipher $CC_CIPHER ignore-unknown-option block-outside-dns setenv opt block-outside-dns # Prevent Windows 10 DNS leak verb 3" >>/etc/openvpn/client-template.txt if [[ $COMPRESSION_ENABLED == "y" ]]; then echo "compress $COMPRESSION_ALG" >>/etc/openvpn/client-template.txt fi # Generate the custom client.ovpn log_info "Generating first client certificate..." newClient log_success "If you want to add more clients, you simply need to run this script another time!" } function newClient() { log_header "New Client Setup" log_prompt "Tell me a name for the client." log_prompt "The name must consist of alphanumeric character. It may also include an underscore or a dash." until [[ $CLIENT =~ ^[a-zA-Z0-9_-]+$ ]]; do read -rp "Client name: " -e CLIENT done log_menu "" log_prompt "Do you want to protect the configuration file with a password?" log_prompt "(e.g. encrypt the private key with a password)" log_menu " 1) Add a passwordless client" log_menu " 2) Use a password for the client" until [[ $PASS =~ ^[1-2]$ ]]; do read -rp "Select an option [1-2]: " -e -i 1 PASS done CLIENTEXISTS=$(tail -n +2 /etc/openvpn/easy-rsa/pki/index.txt | grep -c -E "/CN=$CLIENT\$") if [[ $CLIENTEXISTS == '1' ]]; then log_error "The specified client CN was already found in easy-rsa, please choose another name." exit else cd /etc/openvpn/easy-rsa/ || return log_info "Generating client certificate..." export EASYRSA_CERT_EXPIRE=$CERT_VALIDITY_DAYS case $PASS in 1) run_cmd "Building client certificate" ./easyrsa --batch build-client-full "$CLIENT" nopass ;; 2) log_warn "You will be asked for the client password below" ./easyrsa --batch build-client-full "$CLIENT" ;; esac log_success "Client $CLIENT added." fi # Home directory of the user, where the client configuration will be written if [ -e "/home/${CLIENT}" ]; then # if $1 is a user name homeDir="/home/${CLIENT}" elif [ "${SUDO_USER}" ]; then # if not, use SUDO_USER if [ "${SUDO_USER}" == "root" ]; then # If running sudo as root homeDir="/root" else homeDir="/home/${SUDO_USER}" fi else # if not SUDO_USER, use /root homeDir="/root" fi # Determine if we use tls-auth or tls-crypt if grep -qs "^tls-crypt" /etc/openvpn/server.conf; then TLS_SIG="1" elif grep -qs "^tls-auth" /etc/openvpn/server.conf; then TLS_SIG="2" fi # Generates the custom client.ovpn run_cmd "Creating client config" cp /etc/openvpn/client-template.txt "$homeDir/$CLIENT.ovpn" { echo "" cat "/etc/openvpn/easy-rsa/pki/ca.crt" echo "" echo "" awk '/BEGIN/,/END CERTIFICATE/' "/etc/openvpn/easy-rsa/pki/issued/$CLIENT.crt" echo "" echo "" cat "/etc/openvpn/easy-rsa/pki/private/$CLIENT.key" echo "" case $TLS_SIG in 1) echo "" cat /etc/openvpn/tls-crypt.key echo "" ;; 2) echo "key-direction 1" echo "" cat /etc/openvpn/tls-auth.key echo "" ;; esac } >>"$homeDir/$CLIENT.ovpn" echo "" log_success "The configuration file has been written to $homeDir/$CLIENT.ovpn." log_info "Download the .ovpn file and import it in your OpenVPN client." exit 0 } function revokeClient() { NUMBEROFCLIENTS=$(tail -n +2 /etc/openvpn/easy-rsa/pki/index.txt | grep -c "^V") if [[ $NUMBEROFCLIENTS == '0' ]]; then log_fatal "You have no existing clients!" fi log_header "Revoke Client" log_prompt "Select the existing client certificate you want to revoke" tail -n +2 /etc/openvpn/easy-rsa/pki/index.txt | grep "^V" | cut -d '=' -f 2 | nl -s ') ' until [[ $CLIENTNUMBER -ge 1 && $CLIENTNUMBER -le $NUMBEROFCLIENTS ]]; do if [[ $CLIENTNUMBER == '1' ]]; then read -rp "Select one client [1]: " CLIENTNUMBER else read -rp "Select one client [1-$NUMBEROFCLIENTS]: " CLIENTNUMBER fi done CLIENT=$(tail -n +2 /etc/openvpn/easy-rsa/pki/index.txt | grep "^V" | cut -d '=' -f 2 | sed -n "$CLIENTNUMBER"p) cd /etc/openvpn/easy-rsa/ || return log_info "Revoking certificate for $CLIENT..." run_cmd "Revoking certificate" ./easyrsa --batch revoke "$CLIENT" export EASYRSA_CRL_DAYS=$CRL_VALIDITY_DAYS run_cmd "Regenerating CRL" ./easyrsa gen-crl run_cmd "Removing old CRL" rm -f /etc/openvpn/crl.pem run_cmd "Copying new CRL" cp /etc/openvpn/easy-rsa/pki/crl.pem /etc/openvpn/crl.pem run_cmd "Setting CRL permissions" chmod 644 /etc/openvpn/crl.pem run_cmd "Removing client config from /home" find /home/ -maxdepth 2 -name "$CLIENT.ovpn" -delete run_cmd "Removing client config from /root" rm -f "/root/$CLIENT.ovpn" run_cmd "Removing IP assignment" sed -i "/^$CLIENT,.*/d" /etc/openvpn/ipp.txt run_cmd "Backing up index" cp /etc/openvpn/easy-rsa/pki/index.txt{,.bk} log_success "Certificate for client $CLIENT revoked." } function removeUnbound() { # Remove OpenVPN-related config run_cmd "Removing Unbound include" sed -i '/include: \/etc\/unbound\/openvpn.conf/d' /etc/unbound/unbound.conf run_cmd "Removing OpenVPN Unbound config" rm /etc/unbound/openvpn.conf until [[ $REMOVE_UNBOUND =~ (y|n) ]]; do log_info "If you were already using Unbound before installing OpenVPN, I removed the configuration related to OpenVPN." read -rp "Do you want to completely remove Unbound? [y/n]: " -e REMOVE_UNBOUND done if [[ $REMOVE_UNBOUND == 'y' ]]; then log_info "Removing Unbound..." # Stop Unbound run_cmd "Stopping Unbound" systemctl stop unbound if [[ $OS =~ (debian|ubuntu) ]]; then run_cmd "Removing Unbound" apt-get remove --purge -y unbound elif [[ $OS == 'arch' ]]; then run_cmd "Removing Unbound" pacman --noconfirm -R unbound elif [[ $OS =~ (centos|amzn|oracle) ]]; then run_cmd "Removing Unbound" yum remove -y unbound elif [[ $OS == 'fedora' ]]; then run_cmd "Removing Unbound" dnf remove -y unbound fi run_cmd "Removing Unbound config" rm -rf /etc/unbound/ log_success "Unbound removed!" else run_cmd "Restarting Unbound" systemctl restart unbound log_info "Unbound wasn't removed." fi } function removeOpenVPN() { log_header "Remove OpenVPN" read -rp "Do you really want to remove OpenVPN? [y/n]: " -e -i n REMOVE if [[ $REMOVE == 'y' ]]; then # Get OpenVPN port from the configuration PORT=$(grep '^port ' /etc/openvpn/server.conf | cut -d " " -f 2) PROTOCOL=$(grep '^proto ' /etc/openvpn/server.conf | cut -d " " -f 2) # Stop OpenVPN log_info "Stopping OpenVPN service..." if [[ $OS =~ (fedora|arch|centos|oracle) ]]; then run_cmd "Disabling OpenVPN service" systemctl disable openvpn-server@server run_cmd "Stopping OpenVPN service" systemctl stop openvpn-server@server # Remove customised service run_cmd "Removing service file" rm /etc/systemd/system/openvpn-server@.service else run_cmd "Disabling OpenVPN service" systemctl disable openvpn@server run_cmd "Stopping OpenVPN service" systemctl stop openvpn@server # Remove customised service run_cmd "Removing service file" rm /etc/systemd/system/openvpn\@.service fi # Remove the iptables rules related to the script log_info "Removing iptables rules..." run_cmd "Stopping iptables service" systemctl stop iptables-openvpn # Cleanup run_cmd "Disabling iptables service" systemctl disable iptables-openvpn run_cmd "Removing iptables service file" rm /etc/systemd/system/iptables-openvpn.service run_cmd "Reloading systemd" systemctl daemon-reload run_cmd "Removing iptables add script" rm /etc/iptables/add-openvpn-rules.sh run_cmd "Removing iptables rm script" rm /etc/iptables/rm-openvpn-rules.sh # SELinux if hash sestatus 2>/dev/null; then if sestatus | grep "Current mode" | grep -qs "enforcing"; then if [[ $PORT != '1194' ]]; then run_cmd "Removing SELinux port" semanage port -d -t openvpn_port_t -p "$PROTOCOL" "$PORT" fi fi fi log_info "Removing OpenVPN package..." if [[ $OS =~ (debian|ubuntu) ]]; then run_cmd "Removing OpenVPN" apt-get remove --purge -y openvpn if [[ -e /etc/apt/sources.list.d/openvpn.list ]]; then run_cmd "Removing OpenVPN repo" rm /etc/apt/sources.list.d/openvpn.list run_cmd "Updating package lists" apt-get update fi elif [[ $OS == 'arch' ]]; then run_cmd "Removing OpenVPN" pacman --noconfirm -R openvpn elif [[ $OS =~ (centos|amzn|oracle) ]]; then run_cmd "Removing OpenVPN" yum remove -y openvpn elif [[ $OS == 'fedora' ]]; then run_cmd "Removing OpenVPN" dnf remove -y openvpn fi # Cleanup run_cmd "Removing client configs from /home" find /home/ -maxdepth 2 -name "*.ovpn" -delete run_cmd "Removing client configs from /root" find /root/ -maxdepth 1 -name "*.ovpn" -delete run_cmd "Removing /etc/openvpn" rm -rf /etc/openvpn run_cmd "Removing OpenVPN docs" rm -rf /usr/share/doc/openvpn* run_cmd "Removing sysctl config" rm -f /etc/sysctl.d/99-openvpn.conf run_cmd "Removing OpenVPN logs" rm -rf /var/log/openvpn # Unbound if [[ -e /etc/unbound/openvpn.conf ]]; then removeUnbound fi log_success "OpenVPN removed!" else log_info "Removal aborted!" fi } function manageMenu() { log_header "OpenVPN Management" log_prompt "The git repository is available at: https://github.com/angristan/openvpn-install" log_success "OpenVPN is already installed." echo "" log_prompt "What do you want to do?" log_menu " 1) Add a new user" log_menu " 2) Revoke existing user" log_menu " 3) Remove OpenVPN" log_menu " 4) Exit" until [[ $MENU_OPTION =~ ^[1-4]$ ]]; do read -rp "Select an option [1-4]: " MENU_OPTION done case $MENU_OPTION in 1) newClient ;; 2) revokeClient ;; 3) removeOpenVPN ;; 4) exit 0 ;; esac } # Check for root, TUN, OS... initialCheck # Check if OpenVPN is already installed if [[ -e /etc/openvpn/server.conf && $AUTO_INSTALL != "y" ]]; then manageMenu else installOpenVPN fi