Compare commits
106 Commits
Author | SHA1 | Date | |
---|---|---|---|
93c3a0453d | |||
b868fa9093 | |||
fbb97918cf | |||
e282e1eed0 | |||
5236365fe1 | |||
a293af4246 | |||
47de917de5 | |||
cbf9cbf433 | |||
4fd8296a62 | |||
0e3f34effd | |||
e8b568a0b9 | |||
a2adb59d69 | |||
f4351bb0dd | |||
14c45f418c | |||
7627f8e9f9 | |||
26635395b2 | |||
abdf537da5 | |||
1d2a2e8b29 | |||
f487184a4a | |||
1a984ba9cd | |||
aaf2c0fee1 | |||
c4fc888dca | |||
be165e209e | |||
ef8221372d | |||
c9ada1eac4 | |||
2cc170f001 | |||
8f304ea3fe | |||
a20c63893e | |||
fbdc8e32c6 | |||
3ebc4903d8 | |||
1129eb09bc | |||
b07b4957f8 | |||
4725f3621f | |||
c6d0a71901 | |||
4737654cb2 | |||
5e95b64ff1 | |||
4fd33ab077 | |||
093fc9fafc | |||
14d6f7f491 | |||
431c4a3e82 | |||
70373df974 | |||
4328fe2071 | |||
1e24ee19d9 | |||
acc84e016c | |||
876a686e7d | |||
6028a2b5b7 | |||
9d1c90cde7 | |||
d2c5648825 | |||
51270aae82 | |||
72a3c8a001 | |||
2e943378d1 | |||
bdeaff217c | |||
3f3a4ea9be | |||
e8eb1dda0c | |||
97f8677a03 | |||
ac3cb44d85 | |||
39996ed568 | |||
1807bc6dc4 | |||
a17dfd7808 | |||
62b6cc3db9 | |||
379766fc5e | |||
9e7b363758 | |||
0c743d91b6 | |||
a3d5ac8e90 | |||
8027454cb5 | |||
e3a68c784a | |||
bcf8dc51eb | |||
65bebaebd8 | |||
93098fb165 | |||
ee5d6a6b8a | |||
e700aa1f9f | |||
96668fedbb | |||
dc9c30ff5a | |||
baf9504875 | |||
438316a895 | |||
85680566d3 | |||
6899426152 | |||
698be88ce0 | |||
a1071add9e | |||
dcc33e2483 | |||
0a5a792519 | |||
bcedc8d6d6 | |||
ff731723d4 | |||
b81b2dd472 | |||
4f269704c4 | |||
3e747b353e | |||
dac38246bd | |||
c12fdcd83f | |||
50f387169a | |||
22cc82d21d | |||
14827df71d | |||
e8eb47ef2b | |||
30adfd5632 | |||
f3a24fee60 | |||
61bb4a933c | |||
a5b9ade314 | |||
5d436643b2 | |||
d77ba5e1e8 | |||
097376db75 | |||
caffc0b715 | |||
7eede0d8e5 | |||
22f90831cf | |||
793f83d620 | |||
191cb45106 | |||
df63db02a0 | |||
d3fcec15f1 |
22
.travis.yml
22
.travis.yml
@ -12,10 +12,22 @@ services:
|
||||
|
||||
before_install:
|
||||
- docker --version
|
||||
- docker build -t kylemanna/openvpn .
|
||||
- docker inspect kylemanna/openvpn
|
||||
- docker run kylemanna/openvpn openvpn --version || true # why does it returns 1?
|
||||
- docker run kylemanna/openvpn openssl version
|
||||
|
||||
install:
|
||||
- git clone https://github.com/docker-library/official-images.git official-images
|
||||
|
||||
# Assist with ci test debugging:
|
||||
# - DEBUG=1
|
||||
before_script:
|
||||
- image="kylemanna/openvpn"
|
||||
- docker build -t "$image" .
|
||||
- docker inspect "$image"
|
||||
- docker run --rm "$image" openvpn --version || true # why does it return 1?
|
||||
- docker run --rm "$image" openssl version
|
||||
|
||||
script:
|
||||
- pushd tests && for i in *.sh; do "./$i"; done && popd
|
||||
- official-images/test/run.sh "$image"
|
||||
- test/run.sh "$image"
|
||||
|
||||
after_script:
|
||||
- docker images
|
||||
|
@ -18,7 +18,7 @@ If you have a special feature, you're likely to try but it will likely be reject
|
||||
|
||||
## Tests
|
||||
|
||||
In an effort to not repeat bugs (and break less popular features), unit tests are run on [Travis CI](https://travis-ci.org/kylemanna/docker-openvpn). The goal of the tests are to be simple and to be placed in the `tests` directory where it will be automatically run. Review existing tests for an example.
|
||||
In an effort to not repeat bugs (and break less popular features), unit tests are run on [Travis CI](https://travis-ci.org/kylemanna/docker-openvpn). The goal of the tests are to be simple and to be placed in the `test/tests` directory where it will be automatically run. Review existing tests for an example.
|
||||
|
||||
## Style
|
||||
|
||||
|
@ -1,7 +1,7 @@
|
||||
# Original credit: https://github.com/jpetazzo/dockvpn
|
||||
|
||||
# Smallest base image
|
||||
FROM alpine:3.2
|
||||
FROM alpine:3.5
|
||||
|
||||
MAINTAINER Kyle Manna <kyle@kylemanna.com>
|
||||
|
||||
@ -9,7 +9,7 @@ RUN echo "http://dl-4.alpinelinux.org/alpine/edge/community/" >> /etc/apk/reposi
|
||||
echo "http://dl-4.alpinelinux.org/alpine/edge/testing/" >> /etc/apk/repositories && \
|
||||
apk add --update openvpn iptables bash easy-rsa openvpn-auth-pam google-authenticator pamtester && \
|
||||
ln -s /usr/share/easy-rsa/easyrsa /usr/local/bin && \
|
||||
rm -rf /tmp/* /var/tmp/* /var/cache/apk/*
|
||||
rm -rf /tmp/* /var/tmp/* /var/cache/apk/* /var/cache/distfiles/*
|
||||
|
||||
# Needed by scripts
|
||||
ENV OPENVPN /etc/openvpn
|
||||
@ -22,7 +22,6 @@ VOLUME ["/etc/openvpn"]
|
||||
# Internally uses port 1194/udp, remap using `docker run -p 443:1194/tcp`
|
||||
EXPOSE 1194/udp
|
||||
|
||||
WORKDIR /etc/openvpn
|
||||
CMD ["ovpn_run"]
|
||||
|
||||
ADD ./bin /usr/local/bin
|
||||
|
62
README.md
62
README.md
@ -3,8 +3,8 @@
|
||||
[](https://travis-ci.org/kylemanna/docker-openvpn)
|
||||
[](https://hub.docker.com/r/kylemanna/openvpn/)
|
||||
[](https://hub.docker.com/r/kylemanna/openvpn/)
|
||||
[](https://hub.docker.com/r/kylemanna/openvpn/)
|
||||
[](https://hub.docker.com/r/kylemanna/openvpn/)
|
||||
[](https://microbadger.com/#/images/kylemanna/openvpn)
|
||||
|
||||
|
||||
OpenVPN server in a Docker container complete with an EasyRSA PKI CA.
|
||||
|
||||
@ -16,46 +16,41 @@ a corresponding [Digital Ocean Community Tutorial](http://bit.ly/1AGUZkq).
|
||||
* Docker Registry @ [kylemanna/openvpn](https://hub.docker.com/r/kylemanna/openvpn/)
|
||||
* GitHub @ [kylemanna/docker-openvpn](https://github.com/kylemanna/docker-openvpn)
|
||||
|
||||
#### Example Service
|
||||
|
||||
* [backroad.io](http://beta.backroad.io?utm_source=kylemanna/openvpn&utm_medium=readme&utm_campaign=20150621) - powered by *kylemanna/openvpn*
|
||||
|
||||
## Quick Start
|
||||
|
||||
* Create the `$OVPN_DATA` volume container, i.e. `OVPN_DATA="ovpn-data"`
|
||||
* Pick a name for the `$OVPN_DATA` data volume container, it will be created automatically.
|
||||
|
||||
docker run --name $OVPN_DATA -v /etc/openvpn busybox
|
||||
OVPN_DATA="ovpn-data"
|
||||
|
||||
* Initialize the `$OVPN_DATA` container that will hold the configuration files and certificates
|
||||
|
||||
docker run --volumes-from $OVPN_DATA --rm kylemanna/openvpn ovpn_genconfig -u udp://VPN.SERVERNAME.COM
|
||||
docker run --volumes-from $OVPN_DATA --rm -it kylemanna/openvpn ovpn_initpki
|
||||
docker volume create --name $OVPN_DATA
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm kylemanna/openvpn ovpn_genconfig -u udp://VPN.SERVERNAME.COM
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm -it kylemanna/openvpn ovpn_initpki
|
||||
|
||||
* Start OpenVPN server process
|
||||
|
||||
- On Docker [version 1.2](http://blog.docker.com/2014/08/announcing-docker-1-2-0/) and newer
|
||||
|
||||
docker run --volumes-from $OVPN_DATA -d -p 1194:1194/udp --cap-add=NET_ADMIN kylemanna/openvpn
|
||||
|
||||
- On Docker older than version 1.2
|
||||
|
||||
docker run --volumes-from $OVPN_DATA -d -p 1194:1194/udp --privileged kylemanna/openvpn
|
||||
docker run -v $OVPN_DATA:/etc/openvpn -d -p 1194:1194/udp --cap-add=NET_ADMIN kylemanna/openvpn
|
||||
|
||||
* Generate a client certificate without a passphrase
|
||||
|
||||
docker run --volumes-from $OVPN_DATA --rm -it kylemanna/openvpn easyrsa build-client-full CLIENTNAME nopass
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm -it kylemanna/openvpn easyrsa build-client-full CLIENTNAME nopass
|
||||
|
||||
* Retrieve the client configuration with embedded certificates
|
||||
|
||||
docker run --volumes-from $OVPN_DATA --rm kylemanna/openvpn ovpn_getclient CLIENTNAME > CLIENTNAME.ovpn
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm kylemanna/openvpn ovpn_getclient CLIENTNAME > CLIENTNAME.ovpn
|
||||
|
||||
## Docker Compose
|
||||
|
||||
If you prefer to use `docker-compose` please refer to the [documentation](docs/docker-compose.md).
|
||||
|
||||
## Debugging Tips
|
||||
|
||||
* Create an environment variable with the name DEBUG and value of 1 to enable debug output (using "docker -e").
|
||||
|
||||
docker run --volumes-from $OVPN_DATA -p 1194:1194/udp --privileged -e DEBUG=1 kylemanna/openvpn
|
||||
docker run -v $OVPN_DATA:/etc/openvpn -p 1194:1194/udp --privileged -e DEBUG=1 kylemanna/openvpn
|
||||
|
||||
* Test using a client that has openvpn installed correctly
|
||||
* Test using a client that has openvpn installed correctly
|
||||
|
||||
$ openvpn --config CLIENTNAME.ovpn
|
||||
|
||||
@ -65,6 +60,10 @@ a corresponding [Digital Ocean Community Tutorial](http://bit.ly/1AGUZkq).
|
||||
$ dig google.com # won't use the search directives in resolv.conf
|
||||
$ nslookup google.com # will use search
|
||||
|
||||
* Consider setting up a [systemd service](/docs/systemd.md) for automatic
|
||||
start-up at boot time and restart in the event the OpenVPN daemon or Docker
|
||||
crashes.
|
||||
|
||||
## How Does It Work?
|
||||
|
||||
Initialize the volume container using the `kylemanna/openvpn` image with the
|
||||
@ -80,12 +79,12 @@ The OpenVPN server is started with the default run cmd of `ovpn_run`
|
||||
|
||||
The configuration is located in `/etc/openvpn`, and the Dockerfile
|
||||
declares that directory as a volume. It means that you can start another
|
||||
container with the `--volumes-from` flag, and access the configuration.
|
||||
container with the `-v` argument, and access the configuration.
|
||||
The volume also holds the PKI keys and certs so that it could be backed up.
|
||||
|
||||
To generate a client certificate, `kylemanna/openvpn` uses EasyRSA via the
|
||||
`easyrsa` command in the container's path. The `EASYRSA_*` environmental
|
||||
variables place the PKI CA under `/etc/opevpn/pki`.
|
||||
variables place the PKI CA under `/etc/openvpn/pki`.
|
||||
|
||||
Conveniently, `kylemanna/openvpn` comes with a script called `ovpn_getclient`,
|
||||
which dumps an inline OpenVPN client configuration file. This single file can
|
||||
@ -153,11 +152,11 @@ OpenVPN with latest OpenSSL on Ubuntu 12.04 LTS).
|
||||
### It Doesn't Stomp All Over the Server's Filesystem
|
||||
|
||||
Everything for the Docker container is contained in two images: the ephemeral
|
||||
run time image (kylemanna/openvpn) and the data image (using busybox as a
|
||||
base). To remove it, remove the two Docker images and corresponding containers
|
||||
and it's all gone. This also makes it easier to run multiple servers since
|
||||
each lives in the bubble of the container (of course multiple IPs or separate
|
||||
ports are needed to communicate with the world).
|
||||
run time image (kylemanna/openvpn) and the `$OVPN_DATA` data volume. To remove
|
||||
it, remove the corresponding containers, `$OVPN_DATA` data volume and Docker
|
||||
image and it's completely removed. This also makes it easier to run multiple
|
||||
servers since each lives in the bubble of the container (of course multiple IPs
|
||||
or separate ports are needed to communicate with the world).
|
||||
|
||||
### Some (arguable) Security Benefits
|
||||
|
||||
@ -175,7 +174,7 @@ of a guarantee in the future.
|
||||
volume for re-use across containers
|
||||
* Addition of tls-auth for HMAC security
|
||||
|
||||
## Tested On
|
||||
## Originally Tested On
|
||||
|
||||
* Docker hosts:
|
||||
* server a [Digital Ocean](https://www.digitalocean.com/?refcode=d19f7fe88c94) Droplet with 512 MB RAM running Ubuntu 14.04
|
||||
@ -184,8 +183,3 @@ of a guarantee in the future.
|
||||
* OpenVPN core 3.0 android armv7a thumb2 32-bit
|
||||
* OS X Mavericks with Tunnelblick 3.4beta26 (build 3828) using openvpn-2.3.4
|
||||
* ArchLinux OpenVPN pkg 2.3.4-1
|
||||
*
|
||||
|
||||
## Having permissions issues with Selinux enabled?
|
||||
|
||||
See [this](docs/selinux.md)
|
||||
|
52
alpine/google-authenticator/APKBUILD
Normal file
52
alpine/google-authenticator/APKBUILD
Normal file
@ -0,0 +1,52 @@
|
||||
# Contributor: Fabio Napoleoni <f.napoleoni@gmail.com>
|
||||
# Maintainer:
|
||||
pkgname=google-authenticator
|
||||
pkgver=20160207
|
||||
pkgrel=1
|
||||
pkgdesc="Google Authenticator PAM module"
|
||||
url="https://github.com/google/google-authenticator"
|
||||
arch="all"
|
||||
license="ASL 2.0"
|
||||
depends=
|
||||
depends_dev=
|
||||
makedepends="$depends_dev autoconf automake libtool linux-pam-dev m4 openssl-dev"
|
||||
install=
|
||||
subpackages="$pkgname-doc"
|
||||
source="https://github.com/google/google-authenticator/archive/c0404dcdbda9ab9e4f0b8451ecdd44eee8db2425.zip"
|
||||
|
||||
_builddir="$srcdir"/$pkgname-c0404dcdbda9ab9e4f0b8451ecdd44eee8db2425/libpam
|
||||
|
||||
prepare() {
|
||||
local i
|
||||
cd "$_builddir"
|
||||
for i in $source; do
|
||||
case $i in
|
||||
*.patch) msg $i; patch -p1 -i "$srcdir"/$i || return 1;;
|
||||
esac
|
||||
done
|
||||
}
|
||||
|
||||
build() {
|
||||
cd "$_builddir"
|
||||
./bootstrap.sh || return 1
|
||||
./configure \
|
||||
--build=$CBUILD \
|
||||
--host=$CHOST \
|
||||
--prefix=/usr \
|
||||
--libdir=/lib \
|
||||
--sysconfdir=/etc \
|
||||
--mandir=/usr/share/man \
|
||||
--infodir=/usr/share/info \
|
||||
|| return 1
|
||||
|
||||
make || return 1
|
||||
}
|
||||
|
||||
package() {
|
||||
cd "$_builddir"
|
||||
make DESTDIR="$pkgdir" install || return 1
|
||||
}
|
||||
|
||||
md5sums="33d3cbd0488bcb4f50b34b5670deffae c0404dcdbda9ab9e4f0b8451ecdd44eee8db2425.zip"
|
||||
sha256sums="e32abe693e54195bdb6aca52783e6e1c239e67296876ac59211a59e4608338b8 c0404dcdbda9ab9e4f0b8451ecdd44eee8db2425.zip"
|
||||
sha512sums="b44a626e6cc5d8e27685f5d39b5d33f49fc7070331db7b458d3ee40723972821bb8ed5458f27a287dc664d162acf1f8f9a36ca3b1bf767f2bbf27d4f538e9872 c0404dcdbda9ab9e4f0b8451ecdd44eee8db2425.zip"
|
@ -29,13 +29,19 @@ FILES=(
|
||||
"pki/dh.pem"
|
||||
"pki/ta.key"
|
||||
"pki/ca.crt"
|
||||
"ccd"
|
||||
)
|
||||
|
||||
if [ -f "${OPENVPN}/pki/crl.pem" ]; then
|
||||
FILES+=("pki/crl.pem")
|
||||
fi
|
||||
|
||||
# Ensure the ccd directory exists, even if empty
|
||||
mkdir -p "ccd"
|
||||
|
||||
# rsync isn't available to keep size down
|
||||
# cp --parents isn't in busybox version
|
||||
# hack the directory structure with tar
|
||||
tar cf - -C "${OPENVPN}" "${FILES[@]}" | tar xvf - -C "${TARGET}"
|
||||
|
||||
mkdir -p "$TARGET/ccd"
|
||||
|
||||
echo "Created the openvpn configuration for the server: $TARGET"
|
||||
|
@ -4,6 +4,56 @@
|
||||
# Generate OpenVPN configs
|
||||
#
|
||||
|
||||
TMP_PUSH_CONFIGFILE=$(mktemp -t vpn_push.XXXXXXX)
|
||||
TMP_ROUTE_CONFIGFILE=$(mktemp -t vpn_route.XXXXXXX)
|
||||
TMP_EXTRA_CONFIGFILE=$(mktemp -t vpn_extra.XXXXXXX)
|
||||
TMP_EXTRA_CLIENT_CONFIGFILE=$(mktemp -t vpn_extra_client.XXXXXXX)
|
||||
|
||||
#Traceback on Error and Exit come from https://docwhat.org/tracebacks-in-bash/
|
||||
set -eu
|
||||
|
||||
_showed_traceback=f
|
||||
|
||||
traceback() {
|
||||
# Hide the traceback() call.
|
||||
local -i start=$(( ${1:-0} + 1 ))
|
||||
local -i end=${#BASH_SOURCE[@]}
|
||||
local -i i=0
|
||||
local -i j=0
|
||||
|
||||
echo "Traceback (last called is first):" 1>&2
|
||||
for ((i=${start}; i < ${end}; i++)); do
|
||||
j=$(( $i - 1 ))
|
||||
local function="${FUNCNAME[$i]}"
|
||||
local file="${BASH_SOURCE[$i]}"
|
||||
local line="${BASH_LINENO[$j]}"
|
||||
echo " ${function}() in ${file}:${line}" 1>&2
|
||||
done
|
||||
}
|
||||
|
||||
on_error() {
|
||||
local _ec="$?"
|
||||
local _cmd="${BASH_COMMAND:-unknown}"
|
||||
traceback 1
|
||||
_showed_traceback=t
|
||||
echo "The command ${_cmd} exited with exit code ${_ec}." 1>&2
|
||||
}
|
||||
trap on_error ERR
|
||||
|
||||
|
||||
on_exit() {
|
||||
echo "Cleaning up before Exit ..."
|
||||
rm -f $TMP_PUSH_CONFIGFILE
|
||||
rm -f $TMP_ROUTE_CONFIGFILE
|
||||
rm -f $TMP_EXTRA_CONFIGFILE
|
||||
rm -f $TMP_EXTRA_CLIENT_CONFIGFILE
|
||||
local _ec="$?"
|
||||
if [[ $_ec != 0 && "${_showed_traceback}" != t ]]; then
|
||||
traceback 1
|
||||
fi
|
||||
}
|
||||
trap on_exit EXIT
|
||||
|
||||
# Convert 1.2.3.4/24 -> 255.255.255.0
|
||||
cidr2mask()
|
||||
{
|
||||
@ -34,58 +84,102 @@ getroute() {
|
||||
usage() {
|
||||
echo "usage: $0 [-d]"
|
||||
echo " -u SERVER_PUBLIC_URL"
|
||||
echo " [-s SERVER_SUBNET]"
|
||||
echo " [-r ROUTE ...]"
|
||||
echo " [-p PUSH ...]"
|
||||
echo " [-e EXTRA_SERVER_CONFIG ]"
|
||||
echo " [-E EXTRA_CLIENT_CONFIG ]"
|
||||
echo " [-f FRAGMENT ]"
|
||||
echo " [-n DNS_SERVER ...]"
|
||||
echo " [-p PUSH ...]"
|
||||
echo " [-r ROUTE ...]"
|
||||
echo " [-s SERVER_SUBNET]"
|
||||
echo
|
||||
echo "optional arguments:"
|
||||
echo " -d Disable NAT routing and default route"
|
||||
echo " -2 Enable two factor authentication using Google Authenticator."
|
||||
echo " -a Authenticate packets with HMAC using the given message digest algorithm (auth)."
|
||||
echo " -c Enable client-to-client option"
|
||||
echo " -C A list of allowable TLS ciphers delimited by a colon (cipher)."
|
||||
echo " -d Disable NAT routing and default route"
|
||||
echo " -D Do not push dns servers"
|
||||
echo " -N Configure NAT to access external server network"
|
||||
echo " -m Set client MTU"
|
||||
echo " -N Configure NAT to access external server network"
|
||||
echo " -t Use TAP device (instead of TUN device)"
|
||||
echo " -T Encrypt packets with the given cipher algorithm instead of the default one (tls-cipher)."
|
||||
echo " -C A list of allowable TLS ciphers delimited by a colon (cipher)."
|
||||
echo " -a Authenticate packets with HMAC using the given message digest algorithm (auth)."
|
||||
echo " -z Enable comp-lzo compression."
|
||||
echo " -2 Enable two factor authentication using Google Authenticator."
|
||||
echo " -f Set the fragment directive."
|
||||
}
|
||||
|
||||
if [ "$DEBUG" == "1" ]; then
|
||||
process_route_config() {
|
||||
local ovpn_route_config=''
|
||||
ovpn_route_config="$1"
|
||||
# If user passed "0" skip this, assume no extra routes
|
||||
[[ "$ovpn_route_config" == "0" ]] && break;
|
||||
echo "Processing Route Config: '${ovpn_route_config}'"
|
||||
[[ -n "$ovpn_route_config" ]] && echo "route $(getroute $ovpn_route_config)" >> "$TMP_ROUTE_CONFIGFILE"
|
||||
}
|
||||
|
||||
process_push_config() {
|
||||
local ovpn_push_config=''
|
||||
ovpn_push_config="$1"
|
||||
echo "Processing PUSH Config: '${ovpn_push_config}'"
|
||||
[[ -n "$ovpn_push_config" ]] && echo "push $ovpn_push_config" >> "$TMP_PUSH_CONFIGFILE"
|
||||
}
|
||||
|
||||
process_extra_config() {
|
||||
local ovpn_extra_config=''
|
||||
ovpn_extra_config="$1"
|
||||
echo "Processing Extra Config: '${ovpn_extra_config}'"
|
||||
[[ -n "$ovpn_extra_config" ]] && echo "$ovpn_extra_config" >> "$TMP_EXTRA_CONFIGFILE"
|
||||
|
||||
}
|
||||
|
||||
process_extra_client_config() {
|
||||
local ovpn_extra_config=''
|
||||
ovpn_extra_config="$1"
|
||||
echo "Processing Extra Client Config: '${ovpn_extra_config}'"
|
||||
[[ -n "$ovpn_extra_config" ]] && echo "$ovpn_extra_config" >> "$TMP_EXTRA_CLIENT_CONFIGFILE"
|
||||
}
|
||||
|
||||
if [ "${DEBUG:-}" == "1" ]; then
|
||||
set -x
|
||||
fi
|
||||
|
||||
set -e
|
||||
|
||||
OVPN_ENV=$OPENVPN/ovpn_env.sh
|
||||
if [ -z "${OPENVPN:-}" ]; then
|
||||
export OPENVPN="$PWD"
|
||||
fi
|
||||
if [ -z "${EASYRSA_PKI:-}" ]; then
|
||||
export EASYRSA_PKI="$OPENVPN/pki"
|
||||
fi
|
||||
|
||||
OVPN_ENV=${OPENVPN}/ovpn_env.sh
|
||||
OVPN_SERVER=192.168.255.0/24
|
||||
OVPN_DEFROUTE=1
|
||||
OVPN_NAT=0
|
||||
OVPN_DNS=1
|
||||
OVPN_DEVICE="tun"
|
||||
OVPN_DEVICEN=0
|
||||
OVPN_ROUTES=()
|
||||
TMP_ROUTES=()
|
||||
OVPN_PUSH=()
|
||||
TMP_PUSH=()
|
||||
OVPN_DNS_SERVERS=("8.8.8.8" "8.8.4.4")
|
||||
TMP_DNS_SERVERS=()
|
||||
OVPN_TLS_CIPHER=''
|
||||
OVPN_CIPHER=''
|
||||
OVPN_AUTH=''
|
||||
OVPN_EXTRA_CONFIG=''
|
||||
CUSTOM_ROUTE_CONFIG=''
|
||||
|
||||
# Import defaults if present
|
||||
[ -r "$OVPN_ENV" ] && source "$OVPN_ENV"
|
||||
|
||||
# Parse arguments
|
||||
while getopts ":a:C:T:r:s:du:cp:n:DNmf:tz2" opt; do
|
||||
while getopts ":a:e:E:C:T:r:s:du:cp:n:DNmf:tz2" opt; do
|
||||
case $opt in
|
||||
a)
|
||||
OVPN_AUTH="$OPTARG"
|
||||
;;
|
||||
e)
|
||||
process_extra_config "$OPTARG"
|
||||
;;
|
||||
E)
|
||||
process_extra_client_config "$OPTARG"
|
||||
;;
|
||||
C)
|
||||
OVPN_CIPHER="$OPTARG"
|
||||
;;
|
||||
@ -93,7 +187,8 @@ while getopts ":a:C:T:r:s:du:cp:n:DNmf:tz2" opt; do
|
||||
OVPN_TLS_CIPHER="$OPTARG"
|
||||
;;
|
||||
r)
|
||||
TMP_ROUTES+=("$OPTARG")
|
||||
CUSTOM_ROUTE_CONFIG=1
|
||||
process_route_config "$OPTARG"
|
||||
;;
|
||||
s)
|
||||
OVPN_SERVER=$OPTARG
|
||||
@ -108,7 +203,7 @@ while getopts ":a:C:T:r:s:du:cp:n:DNmf:tz2" opt; do
|
||||
OVPN_CLIENT_TO_CLIENT=1
|
||||
;;
|
||||
p)
|
||||
TMP_PUSH+=("$OPTARG")
|
||||
process_push_config "$OPTARG"
|
||||
;;
|
||||
n)
|
||||
TMP_DNS_SERVERS+=("$OPTARG")
|
||||
@ -149,17 +244,14 @@ while getopts ":a:C:T:r:s:du:cp:n:DNmf:tz2" opt; do
|
||||
esac
|
||||
done
|
||||
|
||||
# if new routes were not defined with -r, use default
|
||||
[ ${#TMP_ROUTES[@]} -gt 0 ] && OVPN_ROUTES=("${TMP_ROUTES[@]}")
|
||||
|
||||
# if new push directives were not defined with -p, use default
|
||||
[ ${#TMP_PUSH[@]} -gt 0 ] && OVPN_PUSH=("${TMP_PUSH[@]}")
|
||||
# Create ccd directory for static routes
|
||||
[ ! -d "${OPENVPN:-}/ccd" ] && mkdir -p ${OPENVPN:-}/ccd
|
||||
|
||||
# if dns servers were not defined with -n, use google nameservers
|
||||
[ ${#TMP_DNS_SERVERS[@]} -gt 0 ] && OVPN_DNS_SERVERS=("${TMP_DNS_SERVERS[@]}")
|
||||
|
||||
# Server name is in the form "udp://vpn.example.com:1194"
|
||||
if [[ "$OVPN_SERVER_URL" =~ ^((udp|tcp)://)?([0-9a-zA-Z\.\-]+)(:([0-9]+))?$ ]]; then
|
||||
if [[ "${OVPN_SERVER_URL:-}" =~ ^((udp|tcp|udp6|tcp6)://)?([0-9a-zA-Z\.\-]+)(:([0-9]+))?$ ]]; then
|
||||
OVPN_PROTO=${BASH_REMATCH[2]};
|
||||
OVPN_CN=${BASH_REMATCH[3]};
|
||||
OVPN_PORT=${BASH_REMATCH[5]};
|
||||
@ -173,7 +265,12 @@ fi
|
||||
# Apply defaults
|
||||
[ -z "$OVPN_PROTO" ] && OVPN_PROTO=udp
|
||||
[ -z "$OVPN_PORT" ] && OVPN_PORT=1194
|
||||
[ ${#OVPN_ROUTES[@]} -eq 0 ] && OVPN_ROUTES=("192.168.254.0/24")
|
||||
[ -z "$CUSTOM_ROUTE_CONFIG" ] && process_route_config "192.168.254.0/24"
|
||||
|
||||
# Save extra client config from temp file only if temp file is not empty
|
||||
if [ -s "$TMP_EXTRA_CLIENT_CONFIGFILE" ]; then
|
||||
OVPN_ADDITIONAL_CLIENT_CONFIG=$(cat $TMP_EXTRA_CLIENT_CONFIGFILE)
|
||||
fi
|
||||
|
||||
export OVPN_SERVER OVPN_ROUTES OVPN_DEFROUTE
|
||||
export OVPN_SERVER_URL OVPN_ENV OVPN_PROTO OVPN_CN OVPN_PORT
|
||||
@ -182,6 +279,7 @@ export OVPN_TLS_CIPHER OVPN_CIPHER OVPN_AUTH
|
||||
export OVPN_COMP_LZO
|
||||
export OVPN_OTP_AUTH
|
||||
export OVPN_FRAGMENT
|
||||
export OVPN_ADDITIONAL_CLIENT_CONFIG
|
||||
|
||||
# Preserve config
|
||||
if [ -f "$OVPN_ENV" ]; then
|
||||
@ -189,9 +287,20 @@ if [ -f "$OVPN_ENV" ]; then
|
||||
echo "Backing up $OVPN_ENV -> $bak_env"
|
||||
mv "$OVPN_ENV" "$bak_env"
|
||||
fi
|
||||
export | grep OVPN_ > "$OVPN_ENV"
|
||||
|
||||
conf=$OPENVPN/openvpn.conf
|
||||
# Like `export | grep OVPN_ > "$OVPN_ENV"` but handles multiline variables
|
||||
set +u
|
||||
while read var ; do
|
||||
eval value=\$$var
|
||||
if [ -n "$value" ]; then
|
||||
echo "declare -x $var=\"$value\"" >> "$OVPN_ENV"
|
||||
else
|
||||
echo "declare -x $var" >> "$OVPN_ENV"
|
||||
fi
|
||||
done < <(export | egrep -o '(OVPN_[^=]+)')
|
||||
set -u
|
||||
|
||||
conf=${OPENVPN:-}/openvpn.conf
|
||||
if [ -f "$conf" ]; then
|
||||
bak=$conf.$(date +%s).bak
|
||||
echo "Backing up $conf -> $bak"
|
||||
@ -221,44 +330,48 @@ user nobody
|
||||
group nogroup
|
||||
EOF
|
||||
|
||||
#This was in the heredoc, we use the new function instead
|
||||
process_push_config "block-outside-dns"
|
||||
|
||||
[ -n "$OVPN_TLS_CIPHER" ] && echo "tls-cipher $OVPN_TLS_CIPHER" >> "$conf"
|
||||
[ -n "$OVPN_CIPHER" ] && echo "cipher $OVPN_CIPHER" >> "$conf"
|
||||
[ -n "$OVPN_AUTH" ] && echo "auth $OVPN_AUTH" >> "$conf"
|
||||
|
||||
[ -n "$OVPN_CLIENT_TO_CLIENT" ] && echo "client-to-client" >> "$conf"
|
||||
[ -n "$OVPN_COMP_LZO" ] && echo "comp-lzo" >> "$conf"
|
||||
[ -n "${OVPN_CLIENT_TO_CLIENT:-}" ] && echo "client-to-client" >> "$conf"
|
||||
[ -n "${OVPN_COMP_LZO:-}" ] && echo "comp-lzo" >> "$conf"
|
||||
|
||||
[ -n "$OVPN_FRAGMENT" ] && echo "fragment $OVPN_FRAGMENT" >> "$conf"
|
||||
[ -n "${OVPN_FRAGMENT:-}" ] && echo "fragment $OVPN_FRAGMENT" >> "$conf"
|
||||
|
||||
[ "$OVPN_DNS" == "1" ] && for i in "${OVPN_DNS_SERVERS[@]}"; do
|
||||
echo "push dhcp-option DNS $i" >> "$conf"
|
||||
done
|
||||
# Append Routes
|
||||
for i in "${OVPN_ROUTES[@]}"; do
|
||||
# If user passed "0" skip this, assume no extra routes
|
||||
[ "$i" = "0" ] && break;
|
||||
echo route $(getroute "$i") >> "$conf"
|
||||
process_push_config "dhcp-option DNS $i"
|
||||
done
|
||||
|
||||
# Append route commands
|
||||
echo -e "\n### Route Configurations Below" >> "$conf"
|
||||
cat $TMP_ROUTE_CONFIGFILE >> "$conf"
|
||||
|
||||
# Append push commands
|
||||
for i in "${OVPN_PUSH[@]}"; do
|
||||
echo push \"$i\" >> "$conf"
|
||||
done
|
||||
echo -e "\n### Push Configurations Below" >> "$conf"
|
||||
cat $TMP_PUSH_CONFIGFILE >> "$conf"
|
||||
|
||||
# Optional OTP authentication support
|
||||
if [ -n "$OVPN_OTP_AUTH" ]; then
|
||||
if [ -n "${OVPN_OTP_AUTH:-}" ]; then
|
||||
echo -e "\n\n# Enable OTP+PAM for user authentication" >> "$conf"
|
||||
echo "plugin /usr/lib/openvpn/plugins/openvpn-plugin-auth-pam.so openvpn" >> "$conf"
|
||||
echo "reneg-sec 0" >> "$conf"
|
||||
fi
|
||||
|
||||
echo -e "\n### Extra Configurations Below" >> "$conf"
|
||||
cat $TMP_EXTRA_CONFIGFILE >> "$conf"
|
||||
|
||||
set +e
|
||||
|
||||
# Clean-up duplicate configs
|
||||
if diff -q "$bak_env" "$OVPN_ENV" 2>/dev/null; then
|
||||
if diff -q "${bak_env:-}" "$OVPN_ENV" 2>/dev/null; then
|
||||
echo "Removing duplicate back-up: $bak_env"
|
||||
rm -fv "$bak_env"
|
||||
fi
|
||||
if diff -q "$bak" "$conf" 2>/dev/null; then
|
||||
if diff -q "${bak:-}" "$conf" 2>/dev/null; then
|
||||
echo "Removing duplicate back-up: $bak"
|
||||
rm -fv "$bak"
|
||||
fi
|
||||
|
@ -35,9 +35,17 @@ get_client_config() {
|
||||
client
|
||||
nobind
|
||||
dev $OVPN_DEVICE
|
||||
key-direction 1
|
||||
remote-cert-tls server
|
||||
|
||||
remote $OVPN_CN $OVPN_PORT $OVPN_PROTO
|
||||
remote $OVPN_CN $OVPN_PORT $OVPN_PROTO"
|
||||
if [ "$OVPN_PROTO" == "udp6" ]; then
|
||||
echo "remote $OVPN_CN $OVPN_PORT udp"
|
||||
fi
|
||||
if [ "$OVPN_PROTO" == "tcp6" ]; then
|
||||
echo "remote $OVPN_CN $OVPN_PORT tcp"
|
||||
fi
|
||||
echo "$OVPN_ADDITIONAL_CLIENT_CONFIG
|
||||
"
|
||||
if [ "$mode" == "combined" ]; then
|
||||
echo "
|
||||
@ -61,7 +69,6 @@ key ${cn}.key
|
||||
ca ca.crt
|
||||
cert ${cn}.crt
|
||||
tls-auth ta.key 1
|
||||
$OVPN_ADDITIONAL_CLIENT_CONFIG
|
||||
"
|
||||
fi
|
||||
|
||||
@ -93,6 +100,10 @@ $OVPN_ADDITIONAL_CLIENT_CONFIG
|
||||
if [ -n "$OVPN_COMP_LZO" ]; then
|
||||
echo "comp-lzo"
|
||||
fi
|
||||
|
||||
if [ -n "$OVPN_OTP_AUTH" ]; then
|
||||
echo reneg-sec 0
|
||||
fi
|
||||
}
|
||||
|
||||
dir="$OPENVPN/clients/$cn"
|
||||
@ -109,6 +120,7 @@ case "$parm" in
|
||||
get_client_config "combined"
|
||||
;;
|
||||
"combined-save")
|
||||
mkdir -p "$dir"
|
||||
get_client_config "combined" > "$dir/${cn}-combined.ovpn"
|
||||
;;
|
||||
*)
|
||||
|
@ -24,7 +24,7 @@ easyrsa init-pki
|
||||
easyrsa build-ca $nopass
|
||||
|
||||
easyrsa gen-dh
|
||||
openvpn --genkey --secret $OPENVPN/pki/ta.key
|
||||
openvpn --genkey --secret $EASYRSA_PKI/ta.key
|
||||
|
||||
# Was nice to autoset, but probably a bad idea in practice, users should
|
||||
# have to explicitly specify the common name of their server
|
||||
|
45
bin/ovpn_listclients
Executable file
45
bin/ovpn_listclients
Executable file
@ -0,0 +1,45 @@
|
||||
#!/bin/bash
|
||||
|
||||
if [ -z "$OPENVPN" ]; then
|
||||
export OPENVPN="$PWD"
|
||||
fi
|
||||
if ! source "$OPENVPN/ovpn_env.sh"; then
|
||||
echo "Could not source $OPENVPN/ovpn_env.sh."
|
||||
exit 1
|
||||
fi
|
||||
if [ -z "$EASYRSA_PKI" ]; then
|
||||
export EASYRSA_PKI="$OPENVPN/pki"
|
||||
fi
|
||||
|
||||
cd "$EASYRSA_PKI"
|
||||
|
||||
if [ -e crl.pem ]; then
|
||||
cat ca.crt crl.pem > cacheck.pem
|
||||
fi
|
||||
|
||||
echo "name,begin,end,status"
|
||||
for name in issued/*.crt; do
|
||||
path=$name
|
||||
begin=$(openssl x509 -noout -startdate -in $path | awk -F= '{ print $2 }')
|
||||
end=$(openssl x509 -noout -enddate -in $path | awk -F= '{ print $2 }')
|
||||
|
||||
name=${name%.crt}
|
||||
name=${name#issued/}
|
||||
if [ "$name" != "$OVPN_CN" ]; then
|
||||
if [ -e crl.pem ]; then
|
||||
if openssl verify -crl_check -CAfile cacheck.pem $path &> /dev/null; then
|
||||
status="VALID"
|
||||
else
|
||||
status="REVOKED"
|
||||
fi
|
||||
else
|
||||
status="VALID"
|
||||
fi
|
||||
|
||||
echo "$name,$begin,$end,$status"
|
||||
fi
|
||||
done
|
||||
|
||||
if [ -e crl.pem ]; then
|
||||
rm cacheck.pem
|
||||
fi
|
64
bin/ovpn_run
64
bin/ovpn_run
@ -10,8 +10,47 @@ fi
|
||||
|
||||
set -e
|
||||
|
||||
cd $OPENVPN
|
||||
|
||||
# Build runtime arguments array based on environment
|
||||
ARGS=("--config" "$OPENVPN/openvpn.conf")
|
||||
USER_ARGS=("${@}")
|
||||
ARGS=()
|
||||
|
||||
# Checks if ARGS already contains the given value
|
||||
function hasArg {
|
||||
local element
|
||||
for element in "${@:2}"; do
|
||||
[ "${element}" == "${1}" ] && return 0
|
||||
done
|
||||
return 1
|
||||
}
|
||||
|
||||
# Adds the given argument if it's not already specified.
|
||||
function addArg {
|
||||
local arg="${1}"
|
||||
[ $# -ge 1 ] && local val="${2}"
|
||||
if ! hasArg "${arg}" "${USER_ARGS[@]}"; then
|
||||
ARGS+=("${arg}")
|
||||
[ $# -ge 1 ] && ARGS+=("${val}")
|
||||
fi
|
||||
}
|
||||
|
||||
# set up iptables rules and routing
|
||||
# this allows rules/routing to be altered by supplying this function
|
||||
# in an included file, such as ovpn_env.sh
|
||||
function setupIptablesAndRouting {
|
||||
iptables -t nat -C POSTROUTING -s $OVPN_SERVER -o $OVPN_NATDEVICE -j MASQUERADE || {
|
||||
iptables -t nat -A POSTROUTING -s $OVPN_SERVER -o $OVPN_NATDEVICE -j MASQUERADE
|
||||
}
|
||||
for i in "${OVPN_ROUTES[@]}"; do
|
||||
iptables -t nat -C POSTROUTING -s "$i" -o $OVPN_NATDEVICE -j MASQUERADE || {
|
||||
iptables -t nat -A POSTROUTING -s "$i" -o $OVPN_NATDEVICE -j MASQUERADE
|
||||
}
|
||||
done
|
||||
}
|
||||
|
||||
|
||||
addArg "--config" "$OPENVPN/openvpn.conf"
|
||||
|
||||
source "$OPENVPN/ovpn_env.sh"
|
||||
|
||||
@ -21,7 +60,7 @@ if [ ! -c /dev/net/tun ]; then
|
||||
fi
|
||||
|
||||
if [ -d "$OPENVPN/ccd" ]; then
|
||||
ARGS+=("--client-config-dir" "$OPENVPN/ccd")
|
||||
addArg "--client-config-dir" "$OPENVPN/ccd"
|
||||
fi
|
||||
|
||||
# When using --net=host, use this to specify nat device.
|
||||
@ -29,14 +68,10 @@ fi
|
||||
|
||||
# Setup NAT forwarding if requested
|
||||
if [ "$OVPN_DEFROUTE" != "0" ] || [ "$OVPN_NAT" == "1" ] ; then
|
||||
iptables -t nat -C POSTROUTING -s $OVPN_SERVER -o $OVPN_NATDEVICE -j MASQUERADE || {
|
||||
iptables -t nat -A POSTROUTING -s $OVPN_SERVER -o $OVPN_NATDEVICE -j MASQUERADE
|
||||
}
|
||||
for i in "${OVPN_ROUTES[@]}"; do
|
||||
iptables -t nat -C POSTROUTING -s "$i" -o $OVPN_NATDEVICE -j MASQUERADE || {
|
||||
iptables -t nat -A POSTROUTING -s "$i" -o $OVPN_NATDEVICE -j MASQUERADE
|
||||
}
|
||||
done
|
||||
# call function to setup iptables rules and routing
|
||||
# this allows rules to be customized by supplying
|
||||
# a replacement function in, for example, ovpn_env.sh
|
||||
setupIptablesAndRouting
|
||||
fi
|
||||
|
||||
# Use a hacky hardlink as the CRL Needs to be readable by the user/group
|
||||
@ -46,7 +81,7 @@ if [ -r "$EASYRSA_PKI/crl.pem" ]; then
|
||||
ln "$EASYRSA_PKI/crl.pem" "$OPENVPN/crl.pem"
|
||||
chmod 644 "$OPENVPN/crl.pem"
|
||||
fi
|
||||
ARGS+=("--crl-verify" "$OPENVPN/crl.pem")
|
||||
addArg "--crl-verify" "$OPENVPN/crl.pem"
|
||||
fi
|
||||
|
||||
ip -6 route show default 2>/dev/null
|
||||
@ -59,8 +94,5 @@ if [ $? = 0 ]; then
|
||||
sysctl -w net.ipv6.conf.all.forwarding=1 || echo "Failed to enable IPv6 Forwarding"
|
||||
fi
|
||||
|
||||
if [ "$#" -gt 0 ]; then
|
||||
exec openvpn "$@"
|
||||
else
|
||||
exec openvpn ${ARGS[@]}
|
||||
fi
|
||||
echo "Running 'openvpn ${ARGS[@]} ${USER_ARGS[@]}'"
|
||||
exec openvpn ${ARGS[@]} ${USER_ARGS[@]}
|
||||
|
@ -4,7 +4,7 @@ The [`ovpn_genconfig`](/bin/ovpn_genconfig) script is intended for simple config
|
||||
|
||||
## Create host volume mounts rather than data volumes
|
||||
|
||||
* Refer to the Quick Start document, and substitute `--volumes-from $OVPN_DATA` with `-v /path/on/host/openvpn0:/etc/openvpn`
|
||||
* Refer to the Quick Start document, and substitute `-v $OVPN_DATA:/etc/openvpn` with `-v /path/on/host/openvpn0:/etc/openvpn`
|
||||
* Quick example that is likely to be out of date, but here's how to get started:
|
||||
|
||||
mkdir openvpn0
|
||||
|
@ -11,10 +11,11 @@ I'd recommend encrypting the archive with something strong (e.g. gpg or openssl
|
||||
|
||||
## Backup to Archive
|
||||
|
||||
docker run --volumes-from $OVPN_DATA --rm busybox tar -cvf - -C /etc openvpn | xz > openvpn-backup.tar.xz
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm kylemanna/openvpn tar -cvf - -C /etc openvpn | xz > openvpn-backup.tar.xz
|
||||
|
||||
## Restore to New Container
|
||||
## Restore to New Data Volume
|
||||
|
||||
Assumes an existing container named `$OVPN_DATA` to extract the data over the top.
|
||||
Creates an volume container named `$OVPN_DATA` to extract the data to.
|
||||
|
||||
xzcat openvpn-backup.tar.xz | docker run --name $OVPN_DATA -v /etc/openvpn -i busybox tar -xvf - -C /etc
|
||||
docker volume create --name $OVPN_DATA
|
||||
xzcat openvpn-backup.tar.xz | docker run -v $OVPN_DATA:/etc/openvpn -i kylemanna/openvpn tar -xvf - -C /etc
|
||||
|
@ -9,13 +9,19 @@ The [`ovpn_getclient`](/bin/ovpn_getclient) can produce two different versions o
|
||||
|
||||
Note that some client software might be picky about which configuration format it accepts.
|
||||
|
||||
## Client List
|
||||
|
||||
See an overview of the configured clients, including revocation status:
|
||||
|
||||
docker run --rm -it -v $OVPN_DATA:/etc/openvpn kylemanna/openvpn ovpn_listclients
|
||||
|
||||
## Batch Mode
|
||||
|
||||
If you have more than a few clients, you will want to generate and update your client configuration in batch. For this task the script [`ovpn_getclient_all`](/bin/ovpn_getclient_all) was written, which writes out the configuration for each client to a separate directory called `clients/$cn`.
|
||||
|
||||
Execute the following to generate the configuration for all clients:
|
||||
|
||||
docker run --rm -it --volumes-from $OVPN_DATA --volume /tmp/openvpn_clients:/etc/openvpn/clients kylemanna/openvpn ovpn_getclient_all
|
||||
docker run --rm -it -v $OVPN_DATA:/etc/openvpn --volume /tmp/openvpn_clients:/etc/openvpn/clients kylemanna/openvpn ovpn_getclient_all
|
||||
|
||||
After doing so, you will find the following files in each of the `$cn` directories:
|
||||
|
||||
@ -30,7 +36,7 @@ After doing so, you will find the following files in each of the `$cn` directori
|
||||
|
||||
Revoke `client1`'s certificate and generate the certificate revocation list (CRL):
|
||||
|
||||
docker run --rm -it --volumes-from $OVPN_DATA kylemanna/openvpn easyrsa revoke client1
|
||||
docker run --rm -it --volumes-from $OVPN_DATA kylemanna/openvpn easyrsa gen-crl
|
||||
docker run --rm -it -v $OVPN_DATA:/etc/openvpn kylemanna/openvpn easyrsa revoke client1
|
||||
docker run --rm -it -v $OVPN_DATA:/etc/openvpn kylemanna/openvpn easyrsa gen-crl
|
||||
|
||||
The OpenVPN server will read this change every time a client connects (no need to restart server) and deny clients access using revoked certificates.
|
||||
|
@ -7,7 +7,7 @@ Random things I do to debug the containers.
|
||||
* Create a shell in the running docker container (aka namespace) with [nsenter](https://github.com/jpetazzo/nsenter)
|
||||
* If you don't have nsenter/docker-enter, you can mount the data container and modify it with
|
||||
|
||||
docker run --rm -it --volumes-from $OVPN_DATA kylemanna/openvpn bash -l
|
||||
docker run --rm -it -v $OVPN_DATA:/etc/openvpn kylemanna/openvpn bash -l
|
||||
|
||||
## Stream OpenVPN Logs
|
||||
|
||||
|
68
docs/docker-compose.md
Normal file
68
docs/docker-compose.md
Normal file
@ -0,0 +1,68 @@
|
||||
# Quick Start with docker-compose
|
||||
|
||||
* Add a new service in docker-compose.yml
|
||||
|
||||
```yaml
|
||||
version: '2'
|
||||
services:
|
||||
openvpn:
|
||||
cap_add:
|
||||
- NET_ADMIN
|
||||
image: kylemanna/openvpn
|
||||
container_name: openvpn
|
||||
ports:
|
||||
- "1194:1194/udp"
|
||||
restart: always
|
||||
volumes:
|
||||
- ./openvpn-data/conf:/etc/openvpn
|
||||
```
|
||||
|
||||
|
||||
* Initialize the configuration files and certificates
|
||||
|
||||
```bash
|
||||
docker-compose run --rm openvpn ovpn_genconfig -u udp://VPN.SERVERNAME.COM
|
||||
docker-compose run --rm openvpn ovpn_initpki
|
||||
```
|
||||
|
||||
* Fix ownership (depending on how to handle your backups, this may not be needed)
|
||||
|
||||
```bash
|
||||
sudo chown -R $(whoami): ./openvpn-data
|
||||
```
|
||||
|
||||
* Start OpenVPN server process
|
||||
|
||||
```bash
|
||||
docker-compose up -d openvpn
|
||||
```
|
||||
|
||||
* You can access the container logs with
|
||||
|
||||
```bash
|
||||
docker-compose logs -f
|
||||
```
|
||||
|
||||
* Generate a client certificate
|
||||
|
||||
```bash
|
||||
export CLIENTNAME="your_client_name"
|
||||
# with a passphrase (recommended)
|
||||
docker-compose run --rm openvpn easyrsa build-client-full $CLIENTNAME
|
||||
# without a passphrase (not recommended)
|
||||
docker-compose run --rm openvpn easyrsa build-client-full $CLIENTNAME nopass
|
||||
```
|
||||
|
||||
* Retrieve the client configuration with embedded certificates
|
||||
|
||||
```bash
|
||||
docker-compose run --rm openvpn ovpn_getclient $CLIENTNAME > $CLIENTNAME.ovpn
|
||||
```
|
||||
|
||||
## Debugging Tips
|
||||
|
||||
* Create an environment variable with the name DEBUG and value of 1 to enable debug output (using "docker -e").
|
||||
|
||||
```bash
|
||||
docker-compose run -e DEBUG=1 openvpn
|
||||
```
|
10
docs/faqs.md
10
docs/faqs.md
@ -4,7 +4,7 @@
|
||||
|
||||
Use a Docker image with a text editor pre-installed (i.e. Ubuntu) and connect the volume container:
|
||||
|
||||
docker run --volumes-from $OVPN_DATA --rm -it ubuntu vi /etc/openvpn/openvpn.conf
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm -it ubuntu vi /etc/openvpn/openvpn.conf
|
||||
|
||||
|
||||
## Why not keep everything in one image?
|
||||
@ -15,6 +15,12 @@ If it was all in one container, an upgrade would require a few steps to extract
|
||||
|
||||
## How do I set up a split tunnel?
|
||||
|
||||
Split tunnels are configurations where only some of the traffic from a client goes to the VPN, with the remainder routed through the normal non-VPN interfaces. You'll want to disable a default route (-d) when you generate the configuration, but still use NAT (-N) to keep network address translation enabled.
|
||||
Split tunnels are configurations where only some of the traffic from a client goes to the VPN, with the remainder routed through the normal non-VPN interfaces. You'll want to disable a default route (-d) when you generate the configuration, but still use NAT (-N) to keep network address translation enabled.
|
||||
|
||||
ovpn_genconfig -N -d ...
|
||||
|
||||
## I need to add some extra configurations to openvpn.conf, How can I do that ?
|
||||
|
||||
You can pass multiple (**-e**) options to `ovpn_genconfig`. For example, if you need to add _'duplicate-cn'_ and _'topology subnet'_ to the server configuration you could do something like this:
|
||||
|
||||
ovpn_genconfig -e 'duplicate-cn' -e 'topology subnet' -u udp://VPN.SERVERNAME.COM
|
||||
|
@ -91,4 +91,11 @@ Fire up a web browser and attempt to navigate to [https://ipv6.google.com](https
|
||||
|
||||
## Connect to the OpenVPN Server Over IPv6
|
||||
|
||||
Not implemented, yet.
|
||||
This feature requires a docker daemon with working IPv6 support.
|
||||
|
||||
This will allow connections over IPv4 and IPv6.
|
||||
|
||||
Generate server configuration with the udp6 or tcp6 protocol:
|
||||
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm kylemanna/openvpn ovpn_genconfig -u udp6://VPN.SERVERNAME.COM
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm kylemanna/openvpn ovpn_genconfig -u tcp6://VPN.SERVERNAME.COM
|
||||
|
18
docs/otp.md
18
docs/otp.md
@ -11,17 +11,19 @@ and use this image to generate user configuration.
|
||||
|
||||
In order to enable two factor authentication the following steps are required.
|
||||
|
||||
* Generate server configuration with `-2` option
|
||||
* Choose a more secure [cipher](https://community.openvpn.net/openvpn/wiki/SWEET32) to use because since [OpenVPN 2.3.13](https://community.openvpn.net/openvpn/wiki/ChangesInOpenvpn23#OpenVPN2.3.13) the default openvpn cipher BF-CBC will cause a renegotiated connection every 64 MB of data
|
||||
|
||||
docker run --volumes-from $OVPN_DATA --rm fabn/openvpn ovpn_genconfig -u udp://vpn.example.com -2
|
||||
* Generate server configuration with `-2` and `-C $CIPHER` options
|
||||
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm kylemanna/openvpn ovpn_genconfig -u udp://vpn.example.com -2 -C $CIPHER
|
||||
|
||||
* Generate your client certificate (possibly without a password since you're using OTP)
|
||||
|
||||
docker run --volumes-from $OVPN_DATA --rm -it fabn/openvpn easyrsa build-client-full <user> nopass
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm -it kylemanna/openvpn easyrsa build-client-full <user> nopass
|
||||
|
||||
* Generate authentication configuration for your client. -t is needed to show QR code, -i is optional for interactive usage
|
||||
|
||||
docker run --volumes-from $OVPN_DATA --rm -t fabn/openvpn ovpn_otp_user <user>
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm -t kylemanna/openvpn ovpn_otp_user <user>
|
||||
|
||||
The last step will generate OTP configuration for the provided user with the following options
|
||||
|
||||
@ -62,11 +64,13 @@ If something is not working you can verify your PAM setup with these commands
|
||||
|
||||
```
|
||||
# Start a shell in container
|
||||
docker run --volumes-from $OVPN_DATA --rm -it fabn/openvpn bash
|
||||
# Then in container install pamtester utility
|
||||
apt-get update && apt-get install -y pamtester
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm -it kylemanna/openvpn bash
|
||||
# Then in container you have pamtester utility already installed
|
||||
which pamtester
|
||||
# To check authentication use this command that will prompt for a valid code from Authenticator APP
|
||||
pamtester -v openvpn <user> authenticate
|
||||
```
|
||||
|
||||
In the last command `<user>` should be replaced by the exact string you used in the ovpn_otp_user command.
|
||||
|
||||
If you configured everything correctly you should get authenticated by entering a OTP code from the app.
|
||||
|
@ -22,11 +22,28 @@ If you want to select the cyphers used by OpenVPN the following parameters of th
|
||||
|
||||
The following options have been tested successfully:
|
||||
|
||||
docker run --volumes-from $OVPN_DATA --net=none --rm kylemanna/openvpn ovpn_genconfig -C 'AES-256-CBC' -a 'SHA384'
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --net=none --rm kylemanna/openvpn ovpn_genconfig -C 'AES-256-CBC' -a 'SHA384'
|
||||
|
||||
Changing the `tls-cipher` option seems to be more complicated because some clients (namely NetworkManager in Debian Jessie) seem to have trouble with this. Running `openvpn` manually also did not solve the issue:
|
||||
|
||||
TLS Error: TLS key negotiation failed to occur within 60 seconds (check your network connectivity)
|
||||
TLS Error: TLS handshake failed
|
||||
|
||||
## EasyRSA and 4096 bit RSA Keys
|
||||
|
||||
EasyRSA will generate 4096 bit RSA keys when the `-e EASYRSA_KEY_SIZE=4096` argument is added to `ovpn_initpki` and `easyrsa build-client-full` commands.
|
||||
|
||||
docker run -e EASYRSA_KEY_SIZE=4096 -v $OVPN_DATA:/etc/openvpn --rm -it kylemanna/openvpn ovpn_initpki
|
||||
docker run -e EASYRSA_KEY_SIZE=4096 -v $OVPN_DATA:/etc/openvpn --rm -it kylemanna/openvpn easyrsa build-client-full CLIENTNAME nopass
|
||||
|
||||
## Logging and stdout
|
||||
|
||||
Because you are running within Docker, remember that any command that generates output to stdout may also log that output through Docker's log-driver mechanism. That may mean that e.g. keying material generated by `ovpn_getclient` will be logged somewhere that you don't want it to be logged.
|
||||
|
||||
A simple way to avoid having Docker log output for a given command is to run with `--log-driver=none`, e.g
|
||||
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --log-driver=none --rm kylemanna/openvpn ovpn_getclient USER > USER.ovpn
|
||||
|
||||
## Additional Resources
|
||||
|
||||
Have a look at the [Applied-Crypto-Hardening](https://github.com/BetterCrypto/Applied-Crypto-Hardening/tree/master/src/configuration/VPNs/OpenVPN) project for more examples.
|
||||
|
@ -6,7 +6,7 @@ The docker image is setup for static client configuration on the 192.168.254.0/2
|
||||
|
||||
1. Create a client specific configuration:
|
||||
|
||||
$ echo "ifconfig-push 192.168.254.1 192.168.254.2" | docker run --volumes-from $OVPN_DATA -i --rm kylemanna/openvpn tee /etc/openvpn/ccd/CERT_COMMON_NAME
|
||||
$ echo "ifconfig-push 192.168.254.1 192.168.254.2" | docker run -v $OVPN_DATA:/etc/openvpn -i --rm kylemanna/openvpn tee /etc/openvpn/ccd/CERT_COMMON_NAME
|
||||
ifconfig-push 192.168.254.1 192.168.254.2
|
||||
|
||||
2. Wait for client to reconnect if necessary
|
||||
@ -15,10 +15,10 @@ The docker image is setup for static client configuration on the 192.168.254.0/2
|
||||
|
||||
Login to the data volume with a `bash` container, note only changes in /etc/openvpn will persist:
|
||||
|
||||
docker run --volumes-from $OVPN_DATA -it --rm kylemanna/openvpn bash -l
|
||||
docker run -v $OVPN_DATA:/etc/openvpn -it --rm kylemanna/openvpn bash -l
|
||||
|
||||
## Upgrading from Old OpenVPN Configurations
|
||||
|
||||
If you're running an old configuration and need to upgrade it to pull in the ccd directory run the following:
|
||||
|
||||
docker run --volumes-from $OVPN_DATA --rm kylemanna/openvpn ovpn_genconfig
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm kylemanna/openvpn ovpn_genconfig
|
||||
|
37
docs/systemd.md
Normal file
37
docs/systemd.md
Normal file
@ -0,0 +1,37 @@
|
||||
# Docker + OpenVPN systemd Service
|
||||
|
||||
The systemd service aims to make the update and invocation of the
|
||||
`docker-openvpn` container seamless. It automatically downloads the latest
|
||||
`docker-openvpn` image and instantiates a Docker container with that image. At
|
||||
shutdown it cleans-up the old container.
|
||||
|
||||
In the event the service dies (crashes, or is killed) systemd will attempt to
|
||||
restart the service every 10 seconds until the service is stopped with
|
||||
`systemctl stop docker-openvpn@NAME.service`.
|
||||
|
||||
A number of IPv6 hacks are incorporated to workaround Docker shortcomings and
|
||||
are harmless for those not using IPv6.
|
||||
|
||||
To use and enable automatic start by systemd:
|
||||
|
||||
1. Create a Docker volume container named `ovpn-data-NAME` where `NAME` is the
|
||||
user's choice to describe the use of the container. In the example
|
||||
configuration given in the [README](/README.md) `NAME=data`.
|
||||
2. Initialize the data container according to the [docker-openvpn
|
||||
README](/README.md), but don't start the container. Stop the Docker
|
||||
container if started.
|
||||
3. Download the [docker-openvpn@.service](https://raw.githubusercontent.com/kylemanna/docker-openvpn/master/init/docker-openvpn%40.service)
|
||||
file to `/etc/systemd/system`:
|
||||
|
||||
curl -L https://raw.githubusercontent.com/kylemanna/docker-openvpn/master/init/docker-openvpn%40.service | sudo tee /etc/systemd/system/docker-openvpn@.service
|
||||
|
||||
4. Enable and start the service with:
|
||||
|
||||
systemctl enable --now docker-openvpn@NAME.service
|
||||
|
||||
5. Verify service start-up with:
|
||||
|
||||
systemctl status docker-openvpn@NAME.service
|
||||
journalctl --unit docker-openvpn@NAME.service
|
||||
|
||||
For more information, see the [systemd manual pages](https://www.freedesktop.org/software/systemd/man/index.html).
|
19
docs/tcp.md
19
docs/tcp.md
@ -5,14 +5,27 @@ By default, OpenVPN is configured to use the UDP protocol. Because UDP incurs m
|
||||
|
||||
As an example, users connecting from an airplane wifi network may experience high packet drop rates, where the error detection and sliding window control of TCP can more readily adjust to the inconsistent connection.
|
||||
|
||||
Another example would be trying to open a VPN connection from within a very restrictive network. In some cases port 1194, or even UDP traffic on any port, may be restricted by network policy. Because TCP traffic on port 443 is used for normal TLS (https) web browsing, it is very unlikely to be blocked.
|
||||
|
||||
## Using TCP
|
||||
Those requiring TCP connections should initialize the data container by specifying the TCP protocol and port number:
|
||||
|
||||
docker run --volumes-from $OVPN_DATA --rm kylemanna/openvpn ovpn_genconfig -u tcp://VPN.SERVERNAME.COM:443
|
||||
docker run --volumes-from $OVPN_DATA --rm -it kylemanna/openvpn ovpn_initpki
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm kylemanna/openvpn ovpn_genconfig -u tcp://VPN.SERVERNAME.COM:443
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm -it kylemanna/openvpn ovpn_initpki
|
||||
|
||||
Because the server container always exposes port 1194, regardless of the
|
||||
specified protocol, adjust the mapping appropriately:
|
||||
|
||||
docker run --volumes-from $OVPN_DATA -d -p 443:1194/tcp --cap-add=NET_ADMIN kylemanna/openvpn
|
||||
docker run -v $OVPN_DATA:/etc/openvpn -d -p 443:1194/tcp --cap-add=NET_ADMIN kylemanna/openvpn
|
||||
|
||||
## Running a Second Fallback TCP Container
|
||||
Instead of choosing between UDP and TCP, you can use both. A single instance of OpenVPN can only listen for a single protocol on a single port, but this image makes it easy to run two instances simultaneously. After building, configuring, and starting a standard container listening for UDP traffic on 1194, you can start a second container listening for tcp traffic on port 443:
|
||||
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm -p 443:1194/tcp --privileged kylemanna/openvpn ovpn_run --proto tcp
|
||||
|
||||
`ovpn_run` will load all the values from the default config file, and `--proto tcp` will override the protocol setting.
|
||||
|
||||
This allows you to use UDP most of the time, but fall back to TCP on the rare occasion that you need it.
|
||||
|
||||
Note that you will need to configure client connections manually. At this time it is not possible to generate a client config that will automatically fall back to the TCP connection.
|
||||
|
||||
|
@ -1,3 +1,35 @@
|
||||
#
|
||||
# Docker + OpenVPN systemd service
|
||||
#
|
||||
# Author: Kyle Manna <kyle@kylemanna.com>
|
||||
# Source: https://github.com/kylemanna/docker-openvpn
|
||||
#
|
||||
# This service aims to make the update and invocation of the docker-openvpn
|
||||
# container seemless. It automatically downloads the latest docker-openvpn
|
||||
# image and instantiates a Docker container with that image. At shutdown it
|
||||
# cleans-up the old container.
|
||||
#
|
||||
# In the event the service dies (crashes, or is killed) systemd will attempt
|
||||
# to restart the service every 10 seconds until the service is stopped with
|
||||
# `systemctl stop docker-openvpn@NAME`.
|
||||
#
|
||||
# A number of IPv6 hacks are incorporated to workaround Docker shortcomings and
|
||||
# are harmless for those not using IPv6.
|
||||
#
|
||||
# To use:
|
||||
# 1. Create a Docker volume container named `ovpn-data-NAME` where NAME is the
|
||||
# user's choice to describe the use of the container.
|
||||
# 2. Initialize the data container according to the docker-openvpn README, but
|
||||
# don't start the container. Stop the docker container if started.
|
||||
# 3. Download this service file to /etc/systemd/service/docker-openvpn@.service
|
||||
# 4. Enable and start the service template with:
|
||||
# `systemctl enable --now docker-openvpn@NAME.service`
|
||||
# 5. Verify service start-up with:
|
||||
# `systemctl status docker-openvpn@NAME.service`
|
||||
# `journalctl --unit docker-openvpn@NAME.service`
|
||||
#
|
||||
# For more information, see the systemd manual pages.
|
||||
#
|
||||
[Unit]
|
||||
Description=OpenVPN Docker Container
|
||||
Documentation=https://github.com/kylemanna/docker-openvpn
|
||||
@ -32,7 +64,7 @@ ExecStartPre=-/usr/bin/docker pull $IMG
|
||||
ExecStartPre=/bin/sh -c 'test -z "$IP6_PREFIX" && exit 0; sysctl net.ipv6.conf.all.forwarding=1'
|
||||
|
||||
# Main process
|
||||
ExecStart=/usr/bin/docker run --rm --privileged --volumes-from ${DATA_VOL}:ro --name ${NAME} -p ${PORT} ${IMG} ovpn_run $ARGS
|
||||
ExecStart=/usr/bin/docker run --rm --privileged -v ${DATA_VOL}:/etc/openvpn --name ${NAME} -p ${PORT} ${IMG} ovpn_run $ARGS
|
||||
|
||||
# IPv6: Add static route for IPv6 after it starts up
|
||||
ExecStartPost=/bin/sh -c 'test -z "${IP6_PREFIX}" && exit 0; sleep 1; ip route replace ${IP6_PREFIX} via $(docker inspect -f "{{ .NetworkSettings.GlobalIPv6Address }}" $NAME ) dev docker0'
|
||||
|
@ -4,5 +4,5 @@ start on filesystem and started docker
|
||||
stop on runlevel [!2345]
|
||||
respawn
|
||||
script
|
||||
exec docker run --volumes-from ovpn-data --rm -p 1194:1194/udp --cap-add=NET_ADMIN kylemanna/openvpn
|
||||
exec docker run -v ovpn-data:/etc/openvpn --rm -p 1194:1194/udp --cap-add=NET_ADMIN kylemanna/openvpn
|
||||
end script
|
||||
|
19
test/README.md
Normal file
19
test/README.md
Normal file
@ -0,0 +1,19 @@
|
||||
# Tests
|
||||
|
||||
Philosophy is to not re-invent the wheel while allowing users to quickly test repository specific tests.
|
||||
|
||||
Example invocation from top-level of repository:
|
||||
|
||||
docker build -t kylemanna/openvpn .
|
||||
test/run.sh kylemanna/openvpn
|
||||
# Be sure to pull kylemanna/openvpn:latest after you're done testing
|
||||
|
||||
More details: https://github.com/docker-library/official-images/tree/master/test
|
||||
|
||||
## Continuous Integration
|
||||
|
||||
The set of scripts defined by `config.sh` are run every time a pull request or push to the repository is made.
|
||||
|
||||
## Maintenance
|
||||
|
||||
Periodically these scripts may need to be synchronized with their upsteam source. Would be nice to be able to just use them from upstream if it such a feature is added later to avoid having to copy them in place.
|
@ -1,5 +1,8 @@
|
||||
#!/bin/bash
|
||||
set -ex
|
||||
set -e
|
||||
|
||||
[ -n "${DEBUG+x}" ] && set -x
|
||||
|
||||
OPENVPN_CONFIG=${1:-/client/config.ovpn}
|
||||
|
||||
# Run in background, rely on bash for job management
|
17
test/config.sh
Normal file
17
test/config.sh
Normal file
@ -0,0 +1,17 @@
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
testAlias+=(
|
||||
[kylemanna/openvpn]='openvpn'
|
||||
)
|
||||
|
||||
imageTests+=(
|
||||
[openvpn]='
|
||||
paranoid
|
||||
conf_options
|
||||
basic
|
||||
dual-proto
|
||||
otp
|
||||
iptables
|
||||
'
|
||||
)
|
202
test/run.sh
Executable file
202
test/run.sh
Executable file
@ -0,0 +1,202 @@
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
dir="$(dirname "$(readlink -f "$BASH_SOURCE")")"
|
||||
|
||||
self="$(basename "$0")"
|
||||
|
||||
usage() {
|
||||
cat <<EOUSAGE
|
||||
|
||||
usage: $self [-t test ...] image:tag [...]
|
||||
ie: $self debian:wheezy
|
||||
$self -t utc python:3
|
||||
$self -t utc python:3 -t python-hy
|
||||
|
||||
This script processes the specified Docker images to test their running
|
||||
environments.
|
||||
EOUSAGE
|
||||
}
|
||||
|
||||
# arg handling
|
||||
opts="$(getopt -o 'ht:c:?' --long 'dry-run,help,test:,config:' -- "$@" || { usage >&2 && false; })"
|
||||
eval set -- "$opts"
|
||||
|
||||
declare -A argTests=()
|
||||
declare -a configs=()
|
||||
dryRun=
|
||||
while true; do
|
||||
flag=$1
|
||||
shift
|
||||
case "$flag" in
|
||||
--dry-run) dryRun=1 ;;
|
||||
--help|-h|'-?') usage && exit 0 ;;
|
||||
--test|-t) argTests["$1"]=1 && shift ;;
|
||||
--config|-c) configs+=("$(readlink -f "$1")") && shift ;;
|
||||
--) break ;;
|
||||
*)
|
||||
{
|
||||
echo "error: unknown flag: $flag"
|
||||
usage
|
||||
} >&2
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
if [ $# -eq 0 ]; then
|
||||
usage >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# declare configuration variables
|
||||
declare -a globalTests=()
|
||||
declare -A testAlias=()
|
||||
declare -A imageTests=()
|
||||
declare -A globalExcludeTests=()
|
||||
declare -A explicitTests=()
|
||||
|
||||
# if there are no user-specified configs, use the default config
|
||||
if [ ${#configs} -eq 0 ]; then
|
||||
configs+=("$dir/config.sh")
|
||||
fi
|
||||
|
||||
# load the configs
|
||||
declare -A testPaths=()
|
||||
for conf in "${configs[@]}"; do
|
||||
. "$conf"
|
||||
|
||||
# Determine the full path to any newly-declared tests
|
||||
confDir="$(dirname "$conf")"
|
||||
|
||||
for testName in ${globalTests[@]} ${imageTests[@]}; do
|
||||
[ "${testPaths[$testName]}" ] && continue
|
||||
|
||||
if [ -d "$confDir/tests/$testName" ]; then
|
||||
# Test directory found relative to the conf file
|
||||
testPaths[$testName]="$confDir/tests/$testName"
|
||||
elif [ -d "$dir/tests/$testName" ]; then
|
||||
# Test directory found in the main tests/ directory
|
||||
testPaths[$testName]="$dir/tests/$testName"
|
||||
fi
|
||||
done
|
||||
done
|
||||
|
||||
didFail=
|
||||
for dockerImage in "$@"; do
|
||||
echo "testing $dockerImage"
|
||||
|
||||
if ! docker inspect "$dockerImage" &> /dev/null; then
|
||||
echo $'\timage does not exist!'
|
||||
didFail=1
|
||||
continue
|
||||
fi
|
||||
|
||||
repo="${dockerImage%:*}"
|
||||
tagVar="${dockerImage#*:}"
|
||||
#version="${tagVar%-*}"
|
||||
variant="${tagVar##*-}"
|
||||
|
||||
testRepo=$repo
|
||||
[ -z "${testAlias[$repo]}" ] || testRepo="${testAlias[$repo]}"
|
||||
|
||||
explicitVariant=
|
||||
if [ \
|
||||
"${explicitTests[:$variant]}" \
|
||||
-o "${explicitTests[$repo:$variant]}" \
|
||||
-o "${explicitTests[$testRepo:$variant]}" \
|
||||
]; then
|
||||
explicitVariant=1
|
||||
fi
|
||||
|
||||
testCandidates=()
|
||||
if [ -z "$explicitVariant" ]; then
|
||||
testCandidates+=( "${globalTests[@]}" )
|
||||
fi
|
||||
testCandidates+=(
|
||||
${imageTests[:$variant]}
|
||||
)
|
||||
if [ -z "$explicitVariant" ]; then
|
||||
testCandidates+=(
|
||||
${imageTests[$testRepo]}
|
||||
)
|
||||
fi
|
||||
testCandidates+=(
|
||||
${imageTests[$testRepo:$variant]}
|
||||
)
|
||||
if [ "$testRepo" != "$repo" ]; then
|
||||
if [ -z "$explicitVariant" ]; then
|
||||
testCandidates+=(
|
||||
${imageTests[$repo]}
|
||||
)
|
||||
fi
|
||||
testCandidates+=(
|
||||
${imageTests[$repo:$variant]}
|
||||
)
|
||||
fi
|
||||
|
||||
tests=()
|
||||
for t in "${testCandidates[@]}"; do
|
||||
if [ ${#argTests[@]} -gt 0 -a -z "${argTests[$t]}" ]; then
|
||||
# skipping due to -t
|
||||
continue
|
||||
fi
|
||||
|
||||
if [ \
|
||||
! -z "${globalExcludeTests[${testRepo}_$t]}" \
|
||||
-o ! -z "${globalExcludeTests[${testRepo}:${variant}_$t]}" \
|
||||
-o ! -z "${globalExcludeTests[:${variant}_$t]}" \
|
||||
-o ! -z "${globalExcludeTests[${repo}_$t]}" \
|
||||
-o ! -z "${globalExcludeTests[${repo}:${variant}_$t]}" \
|
||||
-o ! -z "${globalExcludeTests[:${variant}_$t]}" \
|
||||
]; then
|
||||
# skipping due to exclude
|
||||
continue
|
||||
fi
|
||||
|
||||
tests+=( "$t" )
|
||||
done
|
||||
|
||||
currentTest=0
|
||||
totalTest="${#tests[@]}"
|
||||
for t in "${tests[@]}"; do
|
||||
(( currentTest+=1 ))
|
||||
echo -ne "\t'$t' [$currentTest/$totalTest]..."
|
||||
|
||||
# run test against dockerImage here
|
||||
# find the script for the test
|
||||
scriptDir="${testPaths[$t]}"
|
||||
if [ -d "$scriptDir" ]; then
|
||||
script="$scriptDir/run.sh"
|
||||
if [ -x "$script" -a ! -d "$script" ]; then
|
||||
# TODO dryRun logic
|
||||
if output="$("$script" $dockerImage)"; then
|
||||
if [ -f "$scriptDir/expected-std-out.txt" ] && ! d="$(echo "$output" | diff -u "$scriptDir/expected-std-out.txt" - 2>/dev/null)"; then
|
||||
echo 'failed; unexpected output:'
|
||||
echo "$d"
|
||||
didFail=1
|
||||
else
|
||||
echo 'passed'
|
||||
fi
|
||||
else
|
||||
echo 'failed'
|
||||
didFail=1
|
||||
fi
|
||||
else
|
||||
echo "skipping"
|
||||
echo >&2 "error: $script missing, not executable or is a directory"
|
||||
didFail=1
|
||||
continue
|
||||
fi
|
||||
else
|
||||
echo "skipping"
|
||||
echo >&2 "error: unable to locate test '$t'"
|
||||
didFail=1
|
||||
continue
|
||||
fi
|
||||
done
|
||||
done
|
||||
|
||||
if [ "$didFail" ]; then
|
||||
exit 1
|
||||
fi
|
@ -1,45 +1,46 @@
|
||||
#!/bin/bash
|
||||
set -ex
|
||||
set -e
|
||||
|
||||
[ -n "${DEBUG+x}" ] && set -x
|
||||
|
||||
OVPN_DATA=basic-data
|
||||
CLIENT=travis-client
|
||||
IMG=kylemanna/openvpn
|
||||
|
||||
#
|
||||
# Create a docker container with the config data
|
||||
#
|
||||
docker run --name $OVPN_DATA -v /etc/openvpn busybox
|
||||
CLIENT_DIR="$(readlink -f "$(dirname "$BASH_SOURCE")/../../client")"
|
||||
|
||||
ip addr ls
|
||||
SERV_IP=$(ip -4 -o addr show scope global | awk '{print $4}' | sed -e 's:/.*::' | head -n1)
|
||||
docker run --volumes-from $OVPN_DATA --rm $IMG ovpn_genconfig -u udp://$SERV_IP
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm $IMG ovpn_genconfig -u udp://$SERV_IP
|
||||
|
||||
# nopass is insecure
|
||||
docker run --volumes-from $OVPN_DATA --rm -it -e "EASYRSA_BATCH=1" -e "EASYRSA_REQ_CN=Travis-CI Test CA" $IMG ovpn_initpki nopass
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm -it -e "EASYRSA_BATCH=1" -e "EASYRSA_REQ_CN=Travis-CI Test CA" $IMG ovpn_initpki nopass
|
||||
|
||||
docker run --volumes-from $OVPN_DATA --rm -it $IMG easyrsa build-client-full $CLIENT nopass
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm -it $IMG easyrsa build-client-full $CLIENT nopass
|
||||
|
||||
docker run --volumes-from $OVPN_DATA --rm $IMG ovpn_getclient $CLIENT | tee client/config.ovpn
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm $IMG ovpn_getclient $CLIENT | tee $CLIENT_DIR/config.ovpn
|
||||
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm $IMG ovpn_listclients | grep $CLIENT
|
||||
|
||||
#
|
||||
# Fire up the server
|
||||
#
|
||||
sudo iptables -N DOCKER
|
||||
sudo iptables -I FORWARD -j DOCKER
|
||||
sudo iptables -N DOCKER || echo 'Firewall already configured'
|
||||
sudo iptables -I FORWARD -j DOCKER || echo 'Forward already configured'
|
||||
# run in shell bg to get logs
|
||||
docker run --name "ovpn-test" --volumes-from $OVPN_DATA --rm -p 1194:1194/udp --privileged $IMG &
|
||||
docker run --name "ovpn-test" -v $OVPN_DATA:/etc/openvpn --rm -p 1194:1194/udp --privileged $IMG &
|
||||
|
||||
#for i in $(seq 10); do
|
||||
# SERV_IP=$(docker inspect --format '{{ .NetworkSettings.IPAddress }}')
|
||||
# test -n "$SERV_IP" && break
|
||||
#done
|
||||
#sed -ie s:SERV_IP:$SERV_IP:g client/config.ovpn
|
||||
#sed -ie s:SERV_IP:$SERV_IP:g config.ovpn
|
||||
|
||||
#
|
||||
# Fire up a client in a container since openvpn is disallowed by Travis-CI, don't NAT
|
||||
# the host as it confuses itself:
|
||||
# "Incoming packet rejected from [AF_INET]172.17.42.1:1194[2], expected peer address: [AF_INET]10.240.118.86:1194"
|
||||
#
|
||||
docker run --rm --net=host --privileged --volume $PWD/client:/client $IMG /client/wait-for-connect.sh
|
||||
docker run --rm --net=host --privileged --volume $CLIENT_DIR:/client $IMG /client/wait-for-connect.sh
|
||||
|
||||
#
|
||||
# Client either connected or timed out, kill server
|
194
test/tests/conf_options/container.sh
Normal file
194
test/tests/conf_options/container.sh
Normal file
@ -0,0 +1,194 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Function to fail
|
||||
abort() { cat <<< "$@" 1>&2; exit 1; }
|
||||
|
||||
|
||||
#
|
||||
# Generate openvpn.config file
|
||||
#
|
||||
read -d '' MULTILINE_EXTRA_SERVER_CONF << EOF
|
||||
management localhost 7505
|
||||
max-clients 10
|
||||
EOF
|
||||
|
||||
SERV_IP=$(ip -4 -o addr show scope global | awk '{print $4}' | sed -e 's:/.*::' | head -n1)
|
||||
ovpn_genconfig -u udp://$SERV_IP -f 1400 -e "$MULTILINE_EXTRA_SERVER_CONF" -e 'duplicate-cn' -e 'topology subnet' -p 'route 172.22.22.0 255.255.255.0'
|
||||
|
||||
#
|
||||
# grep for config lines from openvpn.conf
|
||||
# add more tests for more configs as required
|
||||
#
|
||||
|
||||
# 1. verb config
|
||||
CONFIG_REQUIRED_VERB="verb 3"
|
||||
CONFIG_MATCH_VERB=$(busybox grep verb /etc/openvpn/openvpn.conf)
|
||||
|
||||
# 2. fragment config
|
||||
CONFIG_REQUIRED_FRAGMENT="fragment 1400"
|
||||
CONFIG_MATCH_FRAGMENT=$(busybox grep fragment /etc/openvpn/openvpn.conf)
|
||||
|
||||
## Tests for extra configs
|
||||
# 3. management config
|
||||
CONFIG_REQUIRED_MANAGEMENT="^management localhost 7505"
|
||||
CONFIG_MATCH_MANAGEMENT=$(busybox grep management /etc/openvpn/openvpn.conf)
|
||||
|
||||
# 4. max-clients config
|
||||
CONFIG_REQUIRED_MAX_CLIENTS="^max-clients 10"
|
||||
CONFIG_MATCH_MAX_CLIENTS=$(busybox grep max-clients /etc/openvpn/openvpn.conf)
|
||||
|
||||
# 5. duplicate-cn config
|
||||
CONFIG_REQUIRED_DUPCN="^duplicate-cn"
|
||||
CONFIG_MATCH_DUPCN=$(busybox grep duplicate-cn /etc/openvpn/openvpn.conf)
|
||||
|
||||
# 6. topology config
|
||||
CONFIG_REQUIRED_TOPOLOGY="^topology subnet"
|
||||
CONFIG_MATCH_TOPOLOGY=$(busybox grep 'topology subnet' /etc/openvpn/openvpn.conf)
|
||||
|
||||
## Tests for push config
|
||||
# 7. push route
|
||||
CONFIG_REQUIRED_PUSH_ROUTE="^push route 172.22.22.0 255.255.255.0"
|
||||
CONFIG_MATCH_PUSH_ROUTE=$(busybox grep 'push route 172.22.22.0 255.255.255.0' /etc/openvpn/openvpn.conf)
|
||||
|
||||
## Test for default
|
||||
# 8. Should see default route if none provided
|
||||
CONFIG_REQUIRED_DEFAULT_ROUTE="^route 192.168.254.0 255.255.255.0"
|
||||
CONFIG_MATCH_DEFAULT_ROUTE=$(busybox grep 'route 192.168.254.0 255.255.255.0' /etc/openvpn/openvpn.conf)
|
||||
|
||||
# 9. Should see a push of 'block-outside-dns' by default
|
||||
CONFIG_REQUIRED_DEFAULT_ROUTE="^push block-outside-dns"
|
||||
CONFIG_MATCH_DEFAULT_ROUTE=$(busybox grep 'push block-outside-dns' /etc/openvpn/openvpn.conf)
|
||||
|
||||
# 10. Should see a push of 'dhcp-option DNS' by default
|
||||
CONFIG_REQUIRED_DEFAULT_DNS_1="^push dhcp-option DNS 8.8.8.8"
|
||||
CONFIG_MATCH_DEFAULT_DNS_1=$(busybox grep 'push dhcp-option DNS 8.8.8.8' /etc/openvpn/openvpn.conf)
|
||||
CONFIG_REQUIRED_DEFAULT_DNS_2="^push dhcp-option DNS 8.8.4.4"
|
||||
CONFIG_MATCH_DEFAULT_DNS_2=$(busybox grep 'push dhcp-option DNS 8.8.4.4' /etc/openvpn/openvpn.conf)
|
||||
|
||||
|
||||
#
|
||||
# Tests
|
||||
#
|
||||
|
||||
if [[ $CONFIG_MATCH_VERB =~ $CONFIG_REQUIRED_VERB ]]
|
||||
then
|
||||
echo "==> Config match found: $CONFIG_REQUIRED_VERB == $CONFIG_MATCH_VERB"
|
||||
else
|
||||
abort "==> Config match not found: $CONFIG_REQUIRED_VERB != $CONFIG_MATCH_VERB"
|
||||
fi
|
||||
|
||||
if [[ $CONFIG_MATCH_FRAGMENT =~ $CONFIG_REQUIRED_FRAGMENT ]]
|
||||
then
|
||||
echo "==> Config match found: $CONFIG_REQUIRED_FRAGMENT == $CONFIG_MATCH_FRAGMENT"
|
||||
else
|
||||
abort "==> Config match not found: $CONFIG_REQUIRED_FRAGMENT != $CONFIG_MATCH_FRAGMENT"
|
||||
fi
|
||||
|
||||
if [[ $CONFIG_MATCH_MANAGEMENT =~ $CONFIG_REQUIRED_MANAGEMENT ]]
|
||||
then
|
||||
echo "==> Config match found: $CONFIG_REQUIRED_MANAGEMENT == $CONFIG_MATCH_MANAGEMENT"
|
||||
else
|
||||
abort "==> Config match not found: $CONFIG_REQUIRED_MANAGEMENT != $CONFIG_MATCH_MANAGEMENT"
|
||||
fi
|
||||
|
||||
|
||||
if [[ $CONFIG_MATCH_MAX_CLIENTS =~ $CONFIG_REQUIRED_MAX_CLIENTS ]]
|
||||
then
|
||||
echo "==> Config match found: $CONFIG_REQUIRED_MAX_CLIENTS == $CONFIG_MATCH_MAX_CLIENTS"
|
||||
else
|
||||
abort "==> Config match not found: $CONFIG_REQUIRED_MAX_CLIENTS != $CONFIG_MATCH_MAX_CLIENTS"
|
||||
fi
|
||||
|
||||
if [[ $CONFIG_MATCH_DUPCN =~ $CONFIG_REQUIRED_DUPCN ]]
|
||||
then
|
||||
echo "==> Config match found: $CONFIG_REQUIRED_DUPCN == $CONFIG_MATCH_DUPCN"
|
||||
else
|
||||
abort "==> Config match not found: $CONFIG_REQUIRED_DUPCN != $CONFIG_MATCH_DUPCN"
|
||||
fi
|
||||
|
||||
if [[ $CONFIG_MATCH_TOPOLOGY =~ $CONFIG_REQUIRED_TOPOLOGY ]]
|
||||
then
|
||||
echo "==> Config match found: $CONFIG_REQUIRED_TOPOLOGY == $CONFIG_MATCH_TOPOLOGY"
|
||||
else
|
||||
abort "==> Config match not found: $CONFIG_REQUIRED_TOPOLOGY != $CONFIG_MATCH_TOPOLOGY"
|
||||
fi
|
||||
|
||||
if [[ $CONFIG_MATCH_PUSH_ROUTE =~ $CONFIG_REQUIRED_PUSH_ROUTE ]]
|
||||
then
|
||||
echo "==> Config match found: $CONFIG_REQUIRED_PUSH_ROUTE == $CONFIG_MATCH_PUSH_ROUTE"
|
||||
else
|
||||
abort "==> Config match not found: $CONFIG_REQUIRED_PUSH_ROUTE != $CONFIG_MATCH_PUSH_ROUTE"
|
||||
fi
|
||||
|
||||
if [[ $CONFIG_MATCH_DEFAULT_ROUTE =~ $CONFIG_REQUIRED_DEFAULT_ROUTE ]]
|
||||
then
|
||||
echo "==> Config match found: $CONFIG_REQUIRED_DEFAULT_ROUTE == $CONFIG_MATCH_DEFAULT_ROUTE"
|
||||
else
|
||||
abort "==> Config match not found: $CONFIG_REQUIRED_DEFAULT_ROUTE != $CONFIG_MATCH_DEFAULT_ROUTE"
|
||||
fi
|
||||
|
||||
if [[ $CONFIG_MATCH_DEFAULT_DNS_1 =~ $CONFIG_REQUIRED_DEFAULT_DNS_1 ]]
|
||||
then
|
||||
echo "==> Config match found: $CONFIG_REQUIRED_DEFAULT_DNS_1 == $CONFIG_MATCH_DEFAULT_DNS_1"
|
||||
else
|
||||
abort "==> Config match not found: $CONFIG_REQUIRED_DEFAULT_DNS_1 != $CONFIG_MATCH_DEFAULT_DNS_1"
|
||||
fi
|
||||
|
||||
if [[ $CONFIG_MATCH_DEFAULT_DNS_2 =~ $CONFIG_REQUIRED_DEFAULT_DNS_2 ]]
|
||||
then
|
||||
echo "==> Config match found: $CONFIG_REQUIRED_DEFAULT_DNS_2 == $CONFIG_MATCH_DEFAULT_DNS_2"
|
||||
else
|
||||
abort "==> Config match not found: $CONFIG_REQUIRED_DEFAULT_DNS_2 != $CONFIG_MATCH_DEFAULT_DNS_2"
|
||||
fi
|
||||
|
||||
SERV_IP=$(ip -4 -o addr show scope global | awk '{print $4}' | sed -e 's:/.*::' | head -n1)
|
||||
ovpn_genconfig -u udp://$SERV_IP -r "172.33.33.0/24" -r "172.34.34.0/24"
|
||||
|
||||
CONFIG_REQUIRED_ROUTE_1="^route 172.33.33.0 255.255.255.0"
|
||||
CONFIG_MATCH_ROUTE_1=$(busybox grep 'route 172.33.33.0 255.255.255.0' /etc/openvpn/openvpn.conf)
|
||||
|
||||
CONFIG_REQUIRED_ROUTE_2="^route 172.34.34.0 255.255.255.0"
|
||||
CONFIG_MATCH_ROUTE_2=$(busybox grep 'route 172.34.34.0 255.255.255.0' /etc/openvpn/openvpn.conf)
|
||||
|
||||
if [[ $CONFIG_MATCH_ROUTE_1 =~ $CONFIG_REQUIRED_ROUTE_1 ]]
|
||||
then
|
||||
echo "==> Config match found: $CONFIG_REQUIRED_ROUTE_1 == $CONFIG_MATCH_ROUTE_1"
|
||||
else
|
||||
abort "==> Config match not found: $CONFIG_REQUIRED_ROUTE_1 != $CONFIG_MATCH_ROUTE_1"
|
||||
fi
|
||||
|
||||
if [[ $CONFIG_MATCH_ROUTE_2 =~ $CONFIG_REQUIRED_ROUTE_2 ]]
|
||||
then
|
||||
echo "==> Config match found: $CONFIG_REQUIRED_ROUTE_2 == $CONFIG_MATCH_ROUTE_2"
|
||||
else
|
||||
abort "==> Config match not found: $CONFIG_REQUIRED_ROUTE_2 != $CONFIG_MATCH_ROUTE_2"
|
||||
fi
|
||||
|
||||
# Test generated client config
|
||||
|
||||
# gen udp client with tcp fallback
|
||||
ovpn_genconfig -u udp://$SERV_IP -E "remote $SERV_IP 443 tcp" -E "remote vpn.example.com 443 tcp"
|
||||
# nopass is insecure
|
||||
EASYRSA_BATCH=1 EASYRSA_REQ_CN="Travis-CI Test CA" ovpn_initpki nopass
|
||||
easyrsa build-client-full client-fallback nopass
|
||||
ovpn_getclient client-fallback | tee /etc/openvpn/config-fallback.ovpn
|
||||
|
||||
CONFIG_REQUIRED_TCP_REMOTE="^remote $SERV_IP 443 tcp"
|
||||
CONFIG_MATCH_TCP_REMOTE=$(busybox grep "remote $SERV_IP 443 tcp" /etc/openvpn/config-fallback.ovpn)
|
||||
|
||||
CONFIG_REQUIRED_TCP_REMOTE_2="^remote vpn.example.com 443 tcp"
|
||||
CONFIG_MATCH_TCP_REMOTE_2=$(busybox grep "remote vpn.example.com 443 tcp" /etc/openvpn/config-fallback.ovpn)
|
||||
|
||||
if [[ $CONFIG_MATCH_TCP_REMOTE =~ $CONFIG_REQUIRED_TCP_REMOTE ]]
|
||||
then
|
||||
echo "==> Config match found: $CONFIG_REQUIRED_TCP_REMOTE == $CONFIG_MATCH_TCP_REMOTE"
|
||||
else
|
||||
abort "==> Config match not found: $CONFIG_REQUIRED_TCP_REMOTE != $CONFIG_MATCH_TCP_REMOTE"
|
||||
fi
|
||||
|
||||
if [[ $CONFIG_MATCH_TCP_REMOTE_2 =~ $CONFIG_REQUIRED_TCP_REMOTE_2 ]]
|
||||
then
|
||||
echo "==> Config match found: $CONFIG_REQUIRED_TCP_REMOTE_2 == $CONFIG_MATCH_TCP_REMOTE_2"
|
||||
else
|
||||
abort "==> Config match not found: $CONFIG_REQUIRED_TCP_REMOTE_2 != $CONFIG_MATCH_TCP_REMOTE_2"
|
||||
fi
|
1
test/tests/conf_options/run.sh
Symbolic link
1
test/tests/conf_options/run.sh
Symbolic link
@ -0,0 +1 @@
|
||||
../run-bash-in-container.sh
|
39
test/tests/docker-build.sh
Executable file
39
test/tests/docker-build.sh
Executable file
@ -0,0 +1,39 @@
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
# wrapper around "docker build" that creates a temporary directory and copies files into it first so that arbitrary host directories can be copied into containers without bind mounts, but accepts a Dockerfile on stdin
|
||||
|
||||
# usage: ./docker-build.sh some-host-directory some-new-image:some-tag <<EOD
|
||||
# FROM ...
|
||||
# COPY dir/... /.../
|
||||
# EOD
|
||||
# ie: ./docker-build.sh .../hylang-hello-world librarytest/hylang <<EOD
|
||||
# FROM hylang
|
||||
# COPY dir/container.hy /dir/
|
||||
# CMD ["hy", "/dir/container.hy"]
|
||||
# EOD
|
||||
|
||||
dir="$1"; shift
|
||||
[ -d "$dir" ]
|
||||
|
||||
imageTag="$1"; shift
|
||||
|
||||
tmp="$(mktemp -t -d docker-library-test-build-XXXXXXXXXX)"
|
||||
trap "rm -rf '$tmp'" EXIT
|
||||
|
||||
cat > "$tmp/Dockerfile"
|
||||
|
||||
from="$(awk -F '[ \t]+' 'toupper($1) == "FROM" { print $2; exit }' "$tmp/Dockerfile")"
|
||||
onbuilds="$(docker inspect -f '{{len .Config.OnBuild}}' "$from")"
|
||||
if [ "$onbuilds" -gt 0 ]; then
|
||||
# crap, the image we want to build has some ONBUILD instructions
|
||||
# those are kind of going to ruin our day
|
||||
# let's do some hacks to strip those bad boys out in a new fake layer
|
||||
"$(dirname "$(readlink -f "$BASH_SOURCE")")/remove-onbuild.sh" "$from" "$imageTag"
|
||||
awk -F '[ \t]+' 'toupper($1) == "FROM" { $2 = "'"$imageTag"'" } { print }' "$tmp/Dockerfile" > "$tmp/Dockerfile.new"
|
||||
mv "$tmp/Dockerfile.new" "$tmp/Dockerfile"
|
||||
fi
|
||||
|
||||
cp -RL "$dir" "$tmp/dir"
|
||||
|
||||
docker build -t "$imageTag" "$tmp" > /dev/null
|
70
test/tests/dual-proto/run.sh
Executable file
70
test/tests/dual-proto/run.sh
Executable file
@ -0,0 +1,70 @@
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
[ -n "${DEBUG+x}" ] && set -x
|
||||
|
||||
OVPN_DATA=dual-data
|
||||
CLIENT_UDP=travis-client
|
||||
CLIENT_TCP=travis-client-tcp
|
||||
IMG=kylemanna/openvpn
|
||||
CLIENT_DIR="$(readlink -f "$(dirname "$BASH_SOURCE")/../../client")"
|
||||
|
||||
ip addr ls
|
||||
SERV_IP=$(ip -4 -o addr show scope global | awk '{print $4}' | sed -e 's:/.*::' | head -n1)
|
||||
|
||||
# get temporary TCP config
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm $IMG ovpn_genconfig -u tcp://$SERV_IP:443
|
||||
|
||||
# nopass is insecure
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm -it -e "EASYRSA_BATCH=1" -e "EASYRSA_REQ_CN=Travis-CI Test CA" $IMG ovpn_initpki nopass
|
||||
|
||||
# gen TCP client
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm -it $IMG easyrsa build-client-full $CLIENT_TCP nopass
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm $IMG ovpn_getclient $CLIENT_TCP | tee $CLIENT_DIR/config-tcp.ovpn
|
||||
|
||||
# switch to UDP config and gen UDP client
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm $IMG ovpn_genconfig -u udp://$SERV_IP
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm -it $IMG easyrsa build-client-full $CLIENT_UDP nopass
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm $IMG ovpn_getclient $CLIENT_UDP | tee $CLIENT_DIR/config.ovpn
|
||||
|
||||
#Verify client configs
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm $IMG ovpn_listclients | grep $CLIENT_TCP
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm $IMG ovpn_listclients | grep $CLIENT_UDP
|
||||
|
||||
#
|
||||
# Fire up the server
|
||||
#
|
||||
sudo iptables -N DOCKER || echo 'Firewall already configured'
|
||||
sudo iptables -I FORWARD -j DOCKER || echo 'Forward already configured'
|
||||
|
||||
# run in shell bg to get logs
|
||||
docker run --name "ovpn-test-udp" -v $OVPN_DATA:/etc/openvpn --rm -p 1194:1194/udp --privileged $IMG &
|
||||
docker run --name "ovpn-test-tcp" -v $OVPN_DATA:/etc/openvpn --rm -p 443:1194/tcp --privileged $IMG ovpn_run --proto tcp &
|
||||
|
||||
#
|
||||
# Fire up a clients in a containers since openvpn is disallowed by Travis-CI, don't NAT
|
||||
# the host as it confuses itself:
|
||||
# "Incoming packet rejected from [AF_INET]172.17.42.1:1194[2], expected peer address: [AF_INET]10.240.118.86:1194"
|
||||
#
|
||||
docker run --rm --net=host --privileged --volume $CLIENT_DIR:/client $IMG /client/wait-for-connect.sh
|
||||
docker run --rm --net=host --privileged --volume $CLIENT_DIR:/client $IMG /client/wait-for-connect.sh "/client/config-tcp.ovpn"
|
||||
|
||||
#
|
||||
# Client either connected or timed out, kill server
|
||||
#
|
||||
kill %1 %2
|
||||
|
||||
#
|
||||
# Celebrate
|
||||
#
|
||||
cat <<EOF
|
||||
____________ ___________
|
||||
< it worked! > < both ways! >
|
||||
------------ ------------
|
||||
\ ^__^ ^__^ /
|
||||
\ (oo)\______/(oo) /
|
||||
(__)\ /(__)
|
||||
||w---w||
|
||||
|| ||
|
||||
EOF
|
||||
|
10
test/tests/image-name.sh
Executable file
10
test/tests/image-name.sh
Executable file
@ -0,0 +1,10 @@
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
# usage: ./image-name.sh librarytest/something some/image:some-tag
|
||||
# output: librarytest/something:some-image-some-tag
|
||||
|
||||
base="$1"; shift
|
||||
tag="$1"; shift
|
||||
|
||||
echo "$base:$(echo "$tag" | sed 's![:/]!-!g')"
|
38
test/tests/iptables/run.sh
Executable file
38
test/tests/iptables/run.sh
Executable file
@ -0,0 +1,38 @@
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
[ -n "${DEBUG+x}" ] && set -x
|
||||
OVPN_DATA=basic-data
|
||||
IMG="kylemanna/openvpn"
|
||||
NAME="ovpn-test"
|
||||
SERV_IP=$(ip -4 -o addr show scope global | awk '{print $4}' | sed -e 's:/.*::' | head -n1)
|
||||
|
||||
# generate server config including iptables nat-ing
|
||||
docker volume create --name $OVPN_DATA
|
||||
docker run --rm -v $OVPN_DATA:/etc/openvpn $IMG ovpn_genconfig -u udp://$SERV_IP -N
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm -it -e "EASYRSA_BATCH=1" -e "EASYRSA_REQ_CN=Travis-CI Test CA" $IMG ovpn_initpki nopass
|
||||
|
||||
# Fire up the server
|
||||
docker run -d --name $NAME -v $OVPN_DATA:/etc/openvpn --cap-add=NET_ADMIN $IMG
|
||||
|
||||
# check default iptables rules
|
||||
docker exec -ti $NAME bash -c 'source /etc/openvpn/ovpn_env.sh; eval iptables -t nat -C POSTROUTING -s $OVPN_SERVER -o eth0 -j MASQUERADE'
|
||||
|
||||
# append new setupIptablesAndRouting function to config
|
||||
docker exec -ti $NAME bash -c 'echo function setupIptablesAndRouting { iptables -t nat -A POSTROUTING -m comment --comment "test"\;} >> /etc/openvpn/ovpn_env.sh'
|
||||
|
||||
# kill server in preparation to modify config
|
||||
docker kill $NAME
|
||||
docker rm $NAME
|
||||
|
||||
# check that overridden function exists and that test iptables rules is active
|
||||
docker run -d --name $NAME -v $OVPN_DATA:/etc/openvpn --cap-add=NET_ADMIN $IMG
|
||||
docker exec -ti $NAME bash -c 'source /etc/openvpn/ovpn_env.sh; type -t setupIptablesAndRouting && iptables -t nat -C POSTROUTING -m comment --comment "test"'
|
||||
|
||||
#
|
||||
# kill server
|
||||
#
|
||||
|
||||
docker kill $NAME
|
||||
docker rm $NAME
|
||||
docker volume rm $OVPN_DATA
|
@ -1,44 +1,50 @@
|
||||
#!/bin/bash
|
||||
set -ex
|
||||
set -e
|
||||
|
||||
[ -n "${DEBUG+x}" ] && set -x
|
||||
|
||||
OVPN_DATA=basic-data-otp
|
||||
CLIENT=travis-client
|
||||
IMG=kylemanna/openvpn
|
||||
OTP_USER=otp
|
||||
CLIENT_DIR="$(readlink -f "$(dirname "$BASH_SOURCE")/../../client")"
|
||||
|
||||
# Function to fail
|
||||
abort() { cat <<< "$@" 1>&2; exit 1; }
|
||||
|
||||
#
|
||||
# Create a docker container with the config data
|
||||
#
|
||||
docker run --name $OVPN_DATA -v /etc/openvpn busybox
|
||||
|
||||
ip addr ls
|
||||
SERV_IP=$(ip -4 -o addr show scope global | awk '{print $4}' | sed -e 's:/.*::' | head -n1)
|
||||
# Configure server with two factor authentication
|
||||
docker run --volumes-from $OVPN_DATA --rm $IMG ovpn_genconfig -u udp://$SERV_IP -2
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm $IMG ovpn_genconfig -u udp://$SERV_IP -2
|
||||
|
||||
# Ensure reneg-sec 0 in server config when two factor is enabled
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm $IMG cat /etc/openvpn/openvpn.conf | grep 'reneg-sec 0' || abort 'reneg-sec not set to 0 in server config'
|
||||
|
||||
# nopass is insecure
|
||||
docker run --volumes-from $OVPN_DATA --rm -it -e "EASYRSA_BATCH=1" -e "EASYRSA_REQ_CN=Travis-CI Test CA" $IMG ovpn_initpki nopass
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm -it -e "EASYRSA_BATCH=1" -e "EASYRSA_REQ_CN=Travis-CI Test CA" $IMG ovpn_initpki nopass
|
||||
|
||||
docker run --volumes-from $OVPN_DATA --rm -it $IMG easyrsa build-client-full $CLIENT nopass
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm -it $IMG easyrsa build-client-full $CLIENT nopass
|
||||
|
||||
# Generate OTP credentials for user named test, should return QR code for test user
|
||||
docker run --volumes-from $OVPN_DATA --rm -it $IMG ovpn_otp_user $OTP_USER | tee client/qrcode.txt
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm -it $IMG ovpn_otp_user $OTP_USER | tee $CLIENT_DIR/qrcode.txt
|
||||
# Ensure a chart link is printed in client OTP configuration
|
||||
grep 'https://www.google.com/chart' client/qrcode.txt || abort 'Link to chart not generated'
|
||||
grep 'Your new secret key is:' client/qrcode.txt || abort 'Secret key is missing'
|
||||
grep 'https://www.google.com/chart' $CLIENT_DIR/qrcode.txt || abort 'Link to chart not generated'
|
||||
grep 'Your new secret key is:' $CLIENT_DIR/qrcode.txt || abort 'Secret key is missing'
|
||||
# Extract an emergency code from textual output, grepping for line and trimming spaces
|
||||
OTP_TOKEN=$(grep -A1 'Your emergency scratch codes are' client/qrcode.txt | tail -1 | tr -d '[[:space:]]')
|
||||
OTP_TOKEN=$(grep -A1 'Your emergency scratch codes are' $CLIENT_DIR/qrcode.txt | tail -1 | tr -d '[[:space:]]')
|
||||
# Token should be present
|
||||
if [ -z $OTP_TOKEN ]; then
|
||||
abort "QR Emergency Code not detected"
|
||||
fi
|
||||
|
||||
# Store authentication credentials in config file and tell openvpn to use them
|
||||
echo -e "$OTP_USER\n$OTP_TOKEN" > client/credentials.txt
|
||||
echo -e "$OTP_USER\n$OTP_TOKEN" > $CLIENT_DIR/credentials.txt
|
||||
|
||||
# Override the auth-user-pass directive to use a credentials file
|
||||
docker run --volumes-from $OVPN_DATA --rm $IMG ovpn_getclient $CLIENT | sed 's/auth-user-pass/auth-user-pass \/client\/credentials.txt/' | tee client/config.ovpn
|
||||
docker run -v $OVPN_DATA:/etc/openvpn --rm $IMG ovpn_getclient $CLIENT | sed 's/auth-user-pass/auth-user-pass \/client\/credentials.txt/' | tee $CLIENT_DIR/config.ovpn
|
||||
|
||||
# Ensure reneg-sec 0 in client config when two factor is enabled
|
||||
grep 'reneg-sec 0' $CLIENT_DIR/config.ovpn || abort 'reneg-sec not set to 0 in client config'
|
||||
|
||||
#
|
||||
# Fire up the server
|
||||
@ -46,20 +52,20 @@ docker run --volumes-from $OVPN_DATA --rm $IMG ovpn_getclient $CLIENT | sed 's/a
|
||||
sudo iptables -N DOCKER || echo 'Firewall already configured'
|
||||
sudo iptables -I FORWARD -j DOCKER || echo 'Forward already configured'
|
||||
# run in shell bg to get logs
|
||||
docker run --name "ovpn-test" --volumes-from $OVPN_DATA --rm -p 1194:1194/udp --privileged $IMG &
|
||||
docker run --name "ovpn-test" -v $OVPN_DATA:/etc/openvpn --rm -p 1194:1194/udp --privileged $IMG &
|
||||
|
||||
#for i in $(seq 10); do
|
||||
# SERV_IP=$(docker inspect --format '{{ .NetworkSettings.IPAddress }}')
|
||||
# test -n "$SERV_IP" && break
|
||||
#done
|
||||
#sed -ie s:SERV_IP:$SERV_IP:g client/config.ovpn
|
||||
#sed -ie s:SERV_IP:$SERV_IP:g $CLIENT_DIR/config.ovpn
|
||||
|
||||
#
|
||||
# Fire up a client in a container since openvpn is disallowed by Travis-CI, don't NAT
|
||||
# the host as it confuses itself:
|
||||
# "Incoming packet rejected from [AF_INET]172.17.42.1:1194[2], expected peer address: [AF_INET]10.240.118.86:1194"
|
||||
#
|
||||
docker run --rm --net=host --privileged --volume $PWD/client:/client $IMG /client/wait-for-connect.sh
|
||||
docker run --rm --net=host --privileged --volume $CLIENT_DIR:/client $IMG /client/wait-for-connect.sh
|
||||
|
||||
#
|
||||
# Client either connected or timed out, kill server
|
22
test/tests/paranoid/container.sh
Normal file
22
test/tests/paranoid/container.sh
Normal file
@ -0,0 +1,22 @@
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
SERV_IP=$(ip -4 -o addr show scope global | awk '{print $4}' | sed -e 's:/.*::' | head -n1)
|
||||
|
||||
#
|
||||
# Generate a simple configuration, returns nonzero on error
|
||||
#
|
||||
ovpn_genconfig -u udp://$SERV_IP 2>/dev/null
|
||||
|
||||
export EASYRSA_BATCH=1
|
||||
export EASYRSA_REQ_CN="Travis-CI Test CA"
|
||||
|
||||
#
|
||||
# Initialize the certificate PKI state, returns nonzero on error
|
||||
#
|
||||
ovpn_initpki nopass 2>/dev/null
|
||||
|
||||
#
|
||||
# Test back-up
|
||||
#
|
||||
ovpn_copy_server_files
|
1
test/tests/paranoid/run.sh
Symbolic link
1
test/tests/paranoid/run.sh
Symbolic link
@ -0,0 +1 @@
|
||||
../run-bash-in-container.sh
|
7
test/tests/run-bash-in-container.sh
Executable file
7
test/tests/run-bash-in-container.sh
Executable file
@ -0,0 +1,7 @@
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
testDir="$(readlink -f "$(dirname "$BASH_SOURCE")")"
|
||||
runDir="$(dirname "$(readlink -f "$BASH_SOURCE")")"
|
||||
|
||||
source "$runDir/run-in-container.sh" "$testDir" "$1" bash ./container.sh
|
46
test/tests/run-in-container.sh
Executable file
46
test/tests/run-in-container.sh
Executable file
@ -0,0 +1,46 @@
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
# NOT INTENDED TO BE USED AS A TEST "run.sh" DIRECTLY
|
||||
# SEE OTHER "run-*-in-container.sh" SCRIPTS FOR USAGE
|
||||
|
||||
testDir="$1"
|
||||
shift
|
||||
|
||||
image="$1"
|
||||
shift
|
||||
entrypoint="$1"
|
||||
shift
|
||||
|
||||
# do some fancy footwork so that if testDir is /a/b/c, we mount /a/b and use c as the working directory (so relative symlinks work one level up)
|
||||
thisDir="$(dirname "$(readlink -f "$BASH_SOURCE")")"
|
||||
testDir="$(readlink -f "$testDir")"
|
||||
testBase="$(basename "$testDir")"
|
||||
hostMount="$(dirname "$testDir")"
|
||||
containerMount="/tmp/test-dir"
|
||||
workdir="$containerMount/$testBase"
|
||||
# TODO should we be doing something fancy with $BASH_SOURCE instead so we can be arbitrarily deep and mount the top level always?
|
||||
|
||||
newImage="$("$thisDir/image-name.sh" librarytest/run-in-container "$image--$testBase")"
|
||||
"$thisDir/docker-build.sh" "$hostMount" "$newImage" <<EOD
|
||||
FROM $image
|
||||
COPY dir $containerMount
|
||||
WORKDIR $workdir
|
||||
ENTRYPOINT ["$entrypoint"]
|
||||
EOD
|
||||
|
||||
args=( --rm )
|
||||
|
||||
# there is strong potential for nokogiri+overlayfs failure
|
||||
# see https://github.com/docker-library/ruby/issues/55
|
||||
gemHome="$(docker inspect -f '{{range .Config.Env}}{{println .}}{{end}}' "$newImage" | awk -F '=' '$1 == "GEM_HOME" { print $2; exit }')"
|
||||
if [ "$gemHome" ]; then
|
||||
# must be a Ruby image
|
||||
driver="$(docker info | awk -F ': ' '$1 == "Storage Driver" { print $2; exit }')"
|
||||
if [ "$driver" = 'overlay' ]; then
|
||||
# let's add a volume (_not_ a bind mount) on GEM_HOME to work around nokogiri+overlayfs issues
|
||||
args+=( -v "$gemHome" )
|
||||
fi
|
||||
fi
|
||||
|
||||
exec docker run "${args[@]}" "$newImage" "$@"
|
@ -1,55 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
OVPN_DATA=opvn-data
|
||||
|
||||
IMG=kylemanna/openvpn
|
||||
|
||||
# Function to fail
|
||||
abort() { cat <<< "$@" 1>&2; exit 1; }
|
||||
|
||||
#
|
||||
# Create a docker container with the config data
|
||||
#
|
||||
sudo docker run --name $OVPN_DATA -v /etc/openvpn busybox
|
||||
|
||||
#
|
||||
# Generate openvpn.config file
|
||||
#
|
||||
SERV_IP=$(ip -4 -o addr show scope global | awk '{print $4}' | sed -e 's:/.*::' | head -n1)
|
||||
sudo docker run --volumes-from $OVPN_DATA --rm $IMG ovpn_genconfig -u udp://$SERV_IP -f 1400
|
||||
|
||||
#
|
||||
# grep for config lines from openvpn.conf
|
||||
# add more tests for more configs as required
|
||||
#
|
||||
|
||||
# 1. verb config
|
||||
CONFIG_REQUIRED_VERB="verb 3"
|
||||
CONFIG_MATCH_VERB=$(sudo docker run --rm -it --volumes-from $OVPN_DATA busybox grep verb /etc/openvpn/openvpn.conf)
|
||||
|
||||
# 2. fragment config
|
||||
CONFIG_REQUIRED_FRAGMENT="fragment 1400"
|
||||
CONFIG_MATCH_FRAGMENT=$(sudo docker run --rm -it --volumes-from $OVPN_DATA busybox grep fragment /etc/openvpn/openvpn.conf)
|
||||
|
||||
#
|
||||
# Clean up
|
||||
#
|
||||
# sudo docker rm -f $OVPN_DATA
|
||||
|
||||
#
|
||||
# Tests
|
||||
#
|
||||
|
||||
if [[ $CONFIG_MATCH_VERB =~ $CONFIG_REQUIRED_VERB ]]
|
||||
then
|
||||
echo "==> Config match found: $CONFIG_REQUIRED_VERB == $CONFIG_MATCH_VERB"
|
||||
else
|
||||
abort "==> Config match not found: $CONFIG_REQUIRED_VERB != $CONFIG_MATCH_VERB"
|
||||
fi
|
||||
|
||||
if [[ $CONFIG_MATCH_FRAGMENT =~ $CONFIG_REQUIRED_FRAGMENT ]]
|
||||
then
|
||||
echo "==> Config match found: $CONFIG_REQUIRED_FRAGMENT == $CONFIG_MATCH_FRAGMENT"
|
||||
else
|
||||
abort "==> Config match not found: $CONFIG_REQUIRED_FRAGMENT != $CONFIG_MATCH_FRAGMENT"
|
||||
fi
|
@ -1,22 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
set -ex
|
||||
|
||||
IMG=${IMG:-kylemanna/openvpn}
|
||||
|
||||
temp=$(mktemp -d)
|
||||
|
||||
pushd $temp
|
||||
|
||||
SERV_IP=$(ip -4 -o addr show scope global | awk '{print $4}' | sed -e 's:/.*::' | head -n1)
|
||||
|
||||
docker run --net=none --rm -t -i -v $PWD:/etc/openvpn $IMG ovpn_genconfig -u udp://$SERV_IP
|
||||
|
||||
docker run --net=none --rm -t -i -v $PWD:/etc/openvpn -e "EASYRSA_BATCH=1" -e "EASYRSA_REQ_CN=Travis-CI Test CA" kylemanna/openvpn ovpn_initpki nopass
|
||||
|
||||
docker run --net=none --rm -t -i -v $PWD:/etc/openvpn $IMG ovpn_copy_server_files
|
||||
|
||||
popd
|
||||
# Can't delete the temp directory as docker creates some files as root.
|
||||
# Just let it die with the test instance.
|
||||
rm -rf $temp || true
|
Reference in New Issue
Block a user