add scripts for ovpn

This commit is contained in:
Pavel Muhortov 2023-04-13 13:29:49 +03:00
parent 39d30bd7bd
commit 9a6867ab61
3 changed files with 646 additions and 0 deletions

View File

@ -7,6 +7,8 @@ Small tools needed to solve immediate tasks independently or as part of a projec
* [`confutil`.py](https://git.hmp.today/pavel.muhortov/utils#confutil-py) * [`confutil`.py](https://git.hmp.today/pavel.muhortov/utils#confutil-py)
* [`sendmail`.py](https://git.hmp.today/pavel.muhortov/utils#sendmail-py) * [`sendmail`.py](https://git.hmp.today/pavel.muhortov/utils#sendmail-py)
* [`simplewc`.py](https://git.hmp.today/pavel.muhortov/utils#simplewc-py) * [`simplewc`.py](https://git.hmp.today/pavel.muhortov/utils#simplewc-py)
* [`ovpn-client-management`.sh](https://git.hmp.today/pavel.muhortov/utils#ovpn-client-management-sh)
* [`ovpn-connect-handling`.sh](https://git.hmp.today/pavel.muhortov/utils#ovpn-connect-handling-sh)
____ ____
@ -218,3 +220,100 @@ chmod u+x ./simplewc.py
``` ```
____ ____
## `ovpn-client-management`.sh
**Description:**
> Creating or deleting client config for openvpn and sending config and info to email.
**Dependencies:**
>
> * chpasswd
> * [openvpn](https://openvpn.net/) (tested version 2.5.1 on [Debian GNU/Linux 11](http://ftp.debian.org/debian/dists/bullseye/))
> * [easy-rsa](https://github.com/OpenVPN/easy-rsa) (tested version 3.0.8 on [Debian GNU/Linux 11](http://ftp.debian.org/debian/dists/bullseye/))
> * tar
> * [Python 3](https://www.python.org/downloads/) (tested version 3.9.5 on [Debian GNU/Linux 11](http://ftp.debian.org/debian/dists/bullseye/))
> * existing [/usr/local/bin/sendmail.py](http://git.hmp.today/pavel.muhortov/utils/raw/branch/master/sendmail.py)
| POSITION | PARAMETERS | DESCRIPTION | DEFAULT |
|-----------|--------------|------------------------|---------------|
| 1 |**add\|del**|add or delete client config|**REQUIRED**|
| 2 |**\<username\>**|client username|**REQUIRED**|
| 3 |**\<password\>**|client password||
| 4 |**[-f]**|service will restart after username delete||
Example usage:
```bash
# download
sudo wget https://git.hmp.today/pavel.muhortov/utils/src/branch/master/ovpn-client-management.sh -O /etc/openvpn/server/ovpn-client-management.sh
sudo chmod +x /etc/openvpn/server/ovpn-client-management.sh
```
```bash
# create link
ln -s /etc/openvpn/server/ovpn-client-management.sh ./ovpn
```
```bash
# create client
sudo ./ovpn add username password
```
```bash
# delete client (and restart service for applying changes)
sudo ./ovpn del username -f
```
```bash
# check journal
tail -f /var/log/openvpn/ovpn.log
```
____
## `ovpn-connect-handling`.sh
**Description:**
> Handling client connection and preparing stats for monitoring.
**Dependencies:**
>
> * executing by [openvpn](https://openvpn.net/) server (tested version 2.5.1 on [Debian GNU/Linux 11](http://ftp.debian.org/debian/dists/bullseye/))
> * [jq](https://github.com/stedolan/jq) (tested version 1.6 on [Debian GNU/Linux 11](http://ftp.debian.org/debian/dists/bullseye/))
> [grepcidr](https://github.com/ryantig/grepcidr) (tested version 2.0 on [Debian GNU/Linux 11](http://ftp.debian.org/debian/dists/bullseye/))
> * [Python 3](https://www.python.org/downloads/) (tested version 3.9.5 on [Debian GNU/Linux 11](http://ftp.debian.org/debian/dists/bullseye/))
> * existing [/usr/local/bin/sendmail.py](http://git.hmp.today/pavel.muhortov/utils/raw/branch/master/sendmail.py)
> * [bash](https://www.gnu.org/software/bash/) (tested versions: 5.1.4 on [Debian GNU/Linux 11](http://ftp.debian.org/debian/dists/bullseye/), 5.0.17 on [Ubuntu 20](https://wiki.ubuntu.com/FocalFossa/ReleaseNotes), 4.2.46 on [CentOS 7](https://wiki.centos.org/Manuals/ReleaseNotes/CentOS7.2009))
| POSITION | PARAMETERS | DESCRIPTION | DEFAULT |
|-----------|--------------|------------------------|---------------|
| 1 |**inc\|dec**|increment or decrement counter|**REQUIRED**|
| 2 |**</path/to/dir>**|root path for counter, names, log|**REQUIRED**|
| 3 |**[mail]**|send email notification||
| 4 |**[geo]**|check client address geolocation||
Example usage:
```bash
# download
sudo wget https://git.hmp.today/pavel.muhortov/utils/src/branch/master/ovpn-connect-handling.sh -O /etc/openvpn/server/ovpn-connect-handling.sh
sudo chmod +x /etc/openvpn/server/ovpn-connect-handling.sh
```
```bash
# add options to openvpn server config file
sudo tee -a /etc/openvpn/server/server.conf > /dev/null <<'EOF'
script-security 2
client-connect "/etc/openvpn/server/ovpn-connect-handling.sh inc /var/log/openvpn mail geo"
client-disconnect "/etc/openvpn/server/ovpn-connect-handling.sh dec /var/log/openvpn - -"
EOF
sudo systemctl restart openvpn@server
```
```bash
# check counter and names
cat /var/log/openvpn/openvpn-counts.log
# check journal
tail -f /var/log/openvpn/ovpn-connect-handling.log
```

353
ovpn-client-management.sh Normal file
View File

@ -0,0 +1,353 @@
#! /bin/bash
# DESCRIPTION:
# creating or deleting client config for openvpn
# and
# sending config and info to email
#
# DEPENDENCIES:
# - chpasswd
# - openvpn
# - easy-rsa
# - tar
# - Python 3
# - existing /usr/local/bin/sendmail.py
#
# PARAMETERS:
# 1: "add|del" - add or delete client config
# 2: username - client username
# 3: password - client password
# -f - service will restart after username delete
#
# FUNCTIONS:
#
#######################################
# Print message and add to log.
# Globals:
# logs
# Arguments:
# 1: message to print and logging
#######################################
addtologs() {
echo "$(date +'%Y.%m.%d-%H:%M:%S') $1" | tee -a "${logs}"
}
#######################################
# Exit procedure.
# Globals:
# show
# Arguments:
# None
#######################################
execquite() {
addtologs "execution time is $(($(date +%s)-time)) seconds, exit"
exit
}
#######################################
# Error exit procedure
# Globals:
# None
# Arguments:
# 1: message to print and logging
#######################################
execerror() {
addtologs "error: $1"
execquite
}
#######################################
# Checking user rights.
# Globals:
# None
# Arguments:
# None
# return:
# 0 - if privileged rights, 1 - if not privileged rights
#######################################
checkroot() {
if [ "${EUID}" -ne 0 ]; then
return 1 # false
else
return 0 # true
fi
}
#######################################
# Creating linux user
# Globals:
# clientname
# clientpass
# Arguments:
# None
#######################################
createuser() {
useradd "${clientname}" --shell /sbin/nologin
echo "${clientname}:${clientpass}" | chpasswd
}
#######################################
# Creating Easy-RSA user certificate
# Globals:
# easyrsadir
# easyrsavar
# easyrsaexe
# easyrsacap
# clientname
# clientpass
# Arguments:
# None
#######################################
# shellcheck disable=SC2016
createcert() {
cd ${easyrsadir} || execerror ""
sed -i -e '$aset_var EASYRSA_REQ_CN '"${clientname}"'' ${easyrsavar}
${easyrsaexe} --passout=pass:"${clientpass}" --passin=pass:${easyrsacap} build-client-full "${clientname}"
sed -i '/EASYRSA_REQ_CN/d' ${easyrsavar}
}
#######################################
# Creating ovpn config file
# Globals:
# easyrsadir
# ovpncfgdef
# clientname
# ovpncfgdir
# Arguments:
# None
#######################################
createovpn() {
cd ${easyrsadir} || execerror ""
{
cat "${ovpncfgdef}"
echo -e '<ca>'
cat "${easyrsadir}/pki/ca.crt"
echo -e '</ca>\n<cert>'
cat "${easyrsadir}/pki/issued/${clientname}.crt"
echo -e '</cert>\n<key>'
cat "${easyrsadir}/pki/private/${clientname}.key"
echo -e '</key>\n<tls-auth>'
cat "${easyrsadir}/pki/ta.key"
echo -e '</tls-auth>'
} >> "${ovpncfgdir}/${clientname}.ovpn"
}
#######################################
# Creating tar with config file
# Globals:
# easyrsadir
# clientname
# ovpncfgdir
# Arguments:
# None
#######################################
createtars() {
cp "${ovpncfgdir}/${clientname}.ovpn" "${ovpncfgdir}/vpn.cnf"
sed -i "s#auth-user-pass#auth-user-pass /config/openvpn/vpn.txt#g" ${ovpncfgdir}/vpn.cnf
{
echo -e "${clientname}"
echo -e "${clientpass}"
} >> "${ovpncfgdir}/vpn.txt"
cd ${ovpncfgdir} || execerror ""
tar cf "${clientname}.tar" --remove-files vpn.cnf vpn.txt
}
#######################################
# Creating info file
# Globals:
# easyrsadir
# easyrsaexe
# clientname
# ovpncfgdir
# Arguments:
# None
#######################################
createinfo() {
cd ${easyrsadir} || execerror
validuntil=$(${easyrsaexe} show-cert "${clientname}" | grep "Not After" | cut -d: -f2-)
faqprofile=$(cat <<END
OpenVPN Connect client and installation instructions:
https://openvpn.net/vpn-client/
OpenVPN GUI client:
https://openvpn.net/community-downloads/
User Login: ${clientname}
User Password: ${clientpass}
Time Expired: ${validuntil}
END
)
echo -e "${faqprofile}" > "${ovpncfgdir}/${clientname}.info"
}
#######################################
# Send email notification about client connect
# Globals:
# clientname
# faqprofile
# ovpncfgdir
# Arguments:
# None
#######################################
startsendmail() {
subj="[OVPN Settings] $(cat /etc/hostname): ${clientname}.ovpn client profile"
(
python3 /usr/local/bin/sendmail.py \
-u "$(grep "from=" /usr/local/bin/sendmail.config | cut -d= -f2)" \
-p "$(grep "pass=" /usr/local/bin/sendmail.config | cut -d= -f2)" \
-d "$(grep "dest=" /usr/local/bin/sendmail.config | cut -d= -f2)" \
--smtp "$(grep "smtp=" /usr/local/bin/sendmail.config | cut -d= -f2)" \
--port "$(grep "port=" /usr/local/bin/sendmail.config | cut -d= -f2)" \
--stls "True" \
--subj "${subj}" \
--text "${faqprofile}" \
--file "${ovpncfgdir}/${clientname}.ovpn,${ovpncfgdir}/${clientname}.tar" \
>> /dev/null 2>&1 &
)
addtologs "sent mail with subject '${subj}'"
}
#######################################
# Deleting linux user
# Globals:
# clientname
# Arguments:
# None
#######################################
deleteuser() {
userdel -f -r "${clientname}"
}
#######################################
# Deleting Easy-RSA user certificate
# Globals:
# easyrsadir
# easyrsavar
# easyrsaexe
# easyrsacap
# clientname
# Arguments:
# None
#######################################
deletecert() {
cd ${easyrsadir} || execerror
${easyrsaexe} --batch --passin=pass:${easyrsacap} revoke "${clientname}"
${easyrsaexe} --batch --passin=pass:${easyrsacap} gen-crl
}
#######################################
# Deleting ovpn config file
# Globals:
# clientname
# ovpncfgdir
# Arguments:
# None
#######################################
deleteovpn() {
rm -f "${ovpncfgdir}/${clientname}.ovpn"
}
#######################################
# Deleting tar with config file
# Globals:
# clientname
# ovpncfgdir
# Arguments:
# None
#######################################
deletetars() {
rm -f "${ovpncfgdir}/${clientname}.tar"
}
#######################################
# Deleting info file
# Globals:
# clientname
# ovpncfgdir
# Arguments:
# None
#######################################
deleteinfo() {
rm -f "${ovpncfgdir}/${clientname}.info"
}
#
# VARIABLES:
#
easyrsadir="/etc/openvpn/easy-rsa"
easyrsaidx="${easyrsadir}/pki/index.txt"
easyrsaexe="${easyrsadir}/easyrsa"
easyrsavar="${easyrsadir}/vars"
easyrsacap="openvpnca"
ovpncfgdir="/etc/openvpn/client"
ovpncfgdef="${ovpncfgdir}/client.conf.default"
logs=/var/log/openvpn/$(basename -s .sh "$0").log
clienttodo=$1
clientname=$2
clientpass=$3
time=$(date +%s)
#
# MAIN:
#
if checkroot; then
if [ "${clienttodo}" == "add" ] && \
[ -n "${clientname}" ] && \
[ "${#clientpass}" -ge 8 ]; then
if id -u "${clientname}" >/dev/null 2>&1 || \
grep -w "${clientname}" ${easyrsaidx} || \
[ -e "${ovpncfgdir}/${clientname}.ovpn" ]; then
execerror "linux user or certificate or ovpn config exist, exit"
else
createuser && addtologs "created Linux user '${clientname}'"
createcert && addtologs "created certificate for ${clientname}"
createovpn && addtologs "created ovpn config file for ${clientname}"
createtars && addtologs "created tar with config file for ${clientname}"
createinfo && addtologs "created info file for ${clientname}"
startsendmail
fi
elif [ "${clienttodo}" == "del" ] && [ -n "${clientname}" ]; then
resetforce=0
while :; do
case "${3-}" in
-f | --force)
resetforce=1
shift
;;
*)
break
;;
esac
shift
done
if id -u "${clientname}" >/dev/null 2>&1 || \
grep -w "${clientname}" ${easyrsaidx} || \
[ -e "${ovpncfgdir}/${clientname}.ovpn" ]; then
deleteuser
addtologs "deleted Linux user '${clientname}'"
deletecert
deleteovpn
deletetars
deleteinfo
if [ "${resetforce}" -eq 1 ];then
addtologs "restarting openvpn@server..."
systemctl restart openvpn@server
fi
else
execerror "linux user and certificate and ovpn config not exist, exit"
fi
else
printf "%s\n" "Usage example: $0 'add' 'username(surname)' 'password(not less 8 symbols)'"
printf "%s\n" "Usage example: $0 'del' 'username(surname)'"
printf "%s\n" "Usage example: $0 'del' 'username(surname)' -f"
fi
else
execerror "Restart this as root!"
fi
execquite

194
ovpn-connect-handling.sh Normal file
View File

@ -0,0 +1,194 @@
#! /bin/bash
# DESCRIPTION:
# handling client connection
# and
# preparing stats for monitoring
#
# DEPENDENCIES:
# - executing by openvpn server
# - jq
# - grepcidr
# - Python 3
# - existing /usr/local/bin/sendmail.py
#
# PARAMETERS:
# 1: "inc|dec" - increment or decrement counter
# 2: root path for counter, names, log
# 3: "email" - send email notification
# 4: "geo" - check client address geolocation
#
# FUNCTIONS:
#
#######################################
# Print message and add to log.
# Globals:
# logs
# Arguments:
# 1: message to print and logging
#######################################
addtologs() {
echo "$(date +'%Y.%m.%d-%H:%M:%S') $1" | tee -a "${logs}"
}
#######################################
# Exit procedure.
# Globals:
# show
# Arguments:
# None
#######################################
execquite() {
addtologs "execution time is $(($(date +%s)-time)) seconds, exit"
exit
}
#######################################
# Error exit procedure
# Globals:
# None
# Arguments:
# 1: message to print and logging
#######################################
execerror() {
addtologs "error: $1"
execquite
}
#######################################
# Incrementing counter with adding client name
# Globals:
# counts_file
# common_name (variable by openvpn server)
# ifconfig_pool_remote_ip (variable by openvpn server)
# Arguments:
# None
#######################################
# shellcheck disable=SC2154
incremcounter() {
summary_cur=$(grep 'total=' "${counts_file}" | cut -d= -f2)
summary_new=${summary_cur} && (( summary_new += 1 ))
counts_temp=$(sed -e "s/total=${summary_cur}/total=${summary_new}/g" "${counts_file}" \
| sed -e '$a'"${common_name}"'_'"${ifconfig_pool_remote_ip}"'')
addtologs "client ${common_name} connected, counter increment to ${summary_new}"
printf "%s\n" "${counts_temp}" > "${counts_file}"
}
#######################################
# Decrementing counter with deleting client name
# Globals:
# counts_file
# common_name (variable by openvpn server)
# Arguments:
# None
#######################################
decremcounter(){
summary_cur=$(grep 'total=' "${counts_file}" | cut -d= -f2)
summary_new=${summary_cur} && (( summary_new -= 1 ))
counts_temp=$(sed -e "s/total=${summary_cur}/total=${summary_new}/g" "${counts_file}" \
| sed '0,/'"${common_name}"'/{/'"${common_name}"'/d}')
addtologs "client ${common_name} disconnected, counter decrement to ${summary_new}"
printf "%s\n" "${counts_temp}" > "${counts_file}"
}
#######################################
# Get information about client address
# Globals:
# untrusted_ip (variable by openvpn server)
# Arguments:
# None
#######################################
# shellcheck disable=SC2154
expandaddress() {
ipinfo="Source address is ${untrusted_ip}"
localnetworks="10.0.0.0/8
100.64.0.0/10
127.0.0.1/8
172.16.0.0/12
192.168.0.0/16
"
if ! grepcidr "${localnetworks}" <(echo "${untrusted_ip}") >/dev/null; then
if [ "${flaggeol}" == "geo" ]; then
ipinfo=$(curl "https://api.ipbase.com/v1/json/${untrusted_ip}")
if [ "$(jq -r '.country_name' <<< "$ipinfo")" != "" ]; then
z=$(jq -r '.zip_code' <<< "$ipinfo")
c=$(jq -r '.country_name' <<< "$ipinfo")
r=$(jq -r '.region_name' <<< "$ipinfo")
t=$(jq -r '.city' <<< "$ipinfo")
ipinfo="Source address ${untrusted_ip} is from ${z}, ${c}, ${r}, ${t}"
fi
fi
fi
addtologs "client ${common_name} checked. ${ipinfo}"
}
#######################################
# Send email notification about client connect
# Globals:
# ipinfo
# common_name (variable by openvpn server)
# ifconfig_pool_remote_ip (variable by openvpn server)
# Arguments:
# None
#######################################
startsendmail() {
subj="[VPN Connected] $(cat /etc/hostname): ${common_name} connect to ${ifconfig_pool_remote_ip}"
(
python3 /usr/local/bin/sendmail.py \
-u "$(grep "from=" /usr/local/bin/sendmail.config | cut -d= -f2)" \
-p "$(grep "pass=" /usr/local/bin/sendmail.config | cut -d= -f2)" \
-d "$(grep "dest=" /usr/local/bin/sendmail.config | cut -d= -f2)" \
--smtp "$(grep "smtp=" /usr/local/bin/sendmail.config | cut -d= -f2)" \
--port "$(grep "port=" /usr/local/bin/sendmail.config | cut -d= -f2)" \
--stls "True" \
--subj "${subj}" \
--text "${ipinfo}" \
>> /dev/null 2>&1 &
)
addtologs "sent mail with subject '${subj}'"
}
#
# VARIABLES:
#
flagmath=$1
pathroot=$2
flagmail=$3
flaggeol=$4
time=$(date +%s)
logs="${pathroot}/$(basename -s .sh "$0").log"
counts_file="${pathroot}/openvpn-counts.log"
if [ -z "${pathroot}" ]; then
logs=/dev/null
execerror "Usage example: $0 'inc|dec' '/var/log/openvpn' '-' '-'"
elif [ ! -e "${logs}" ]; then
touch "${logs}"
fi
if ! command -v curl &> /dev/null || \
! command -v /usr/local/bin/sendmail.py &> /dev/null || \
! command -v python3 &> /dev/null || \
! command -v grepcidr &> /dev/null || \
! command -v jq &> /dev/null; then
execerror "Not found dependencies"
fi
#
# MAIN:
#
if [ "${flagmath}" == "inc" ]; then
incremcounter
expandaddress
if [ "${flagmail}" == "mail" ]; then
startsendmail
fi
elif [ "${flagmath}" == "dec" ]; then
decremcounter
else
execerror "Usage example: $0 'inc|dec' '/var/log/openvpn' '-' '-'"
fi
execquite