tests: verify environment under Apple clients

Signed-off-by: Nikos Mavrogiannopoulos <n.mavrogiannopoulos@gmail.com>

.gitlab-ci.yml

@@ -265,10 +265,8 @@ Centos6:
   - schedules
   artifacts:
     expire_in: 1 week
+    untracked: true
     when: on_failure
-    paths:
-      - ./*.log
-      - ./tests/*.log
 
 minimal:
   stage: testing

tests/Makefile.am

@@ -36,7 +36,8 @@ EXTRA_DIST = certs/ca-key.pem certs/ca.pem ns.sh common.sh certs/server-cert.pem
 	data/radiusclient/servers data/radius.config data/radius-group.config data/radius-otp.config \
 	data/test-udp-listen-host.config data/pam-kerberos/passdb.templ \
 	data/test-max-same-1.config data/test-script-multi-user.config \
-	sleep-connect-script data/test-psk-negotiate.config
+	sleep-connect-script data/test-psk-negotiate.config \
+	connect-ios-script data/apple-ios.config
 
 SUBDIRS = docker-ocserv
 
@@ -61,7 +62,7 @@ dist_check_SCRIPTS += test-iroute test-multi-cookie test-pass-script \
 	test-cookie-timeout test-cookie-timeout-2 test-explicit-ip \
 	test-cookie-invalidation test-user-config test-append-routes test-ban \
 	multiple-routes haproxy-connect radius-group radius-otp json test-udp-listen-host \
-	test-max-same-1 test-script-multi-user
+	test-max-same-1 test-script-multi-user apple-ios
 
 #other tests requiring nuttcp for traffic
 if ENABLE_NUTTCP_TESTS

tests/apple-ios

@@ -0,0 +1,126 @@
+#!/bin/bash
+#
+# Copyright (C) 2013-2020 Nikos Mavrogiannopoulos
+#
+# This file is part of ocserv.
+#
+# ocserv is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation; either version 2 of the License, or (at
+# your option) any later version.
+#
+# ocserv is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with GnuTLS; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+SERV="${SERV:-../src/ocserv}"
+srcdir=${srcdir:-.}
+builddir=${builddir:-.}
+PORT=4358
+VPNNET=172.23.115.0/24
+TMPFILE=ios.$$.tmp
+VERBOSE=1
+
+. `dirname $0`/common.sh
+
+echo "Testing environment under apple ios client"
+
+function finish {
+  echo " * Cleaning up..."
+  rm -f ${builddir}/connect.ios.ok
+  rm -f ${builddir}/disconnect.ios.ok
+  test -n "${PID}" && kill ${PID} >/dev/null 2>&1
+  rm -f ${TMPFILE}
+}
+trap finish EXIT
+
+rm -f ${builddir}/connect.ios.ok
+rm -f ${builddir}/disconnect.ios.ok
+
+OPENCONNECT="$OPENCONNECT --os=apple-ios"
+
+echo " * Testing connection with username-password... "
+
+update_config apple-ios.config
+launch_server -d 1 -f -c "${CONFIG}" & PID=$!
+wait_server $PID
+
+sleep 2
+
+echo " * Connecting to obtain cookie... "
+( echo "!@#$%^&*()<>" | $OPENCONNECT localhost:$PORT -u "sp@c/al" --servercert=d66b507ae074d03b02eafca40d35f87dd81049d3 --cookieonly >/dev/null ) ||
+	fail $PID "Could not receive cookie from server"
+
+echo " * Re-connect to force script run with platform... "
+echo "!@#$%^&*()<>" | timeout 7 $OPENCONNECT --verbose localhost:$PORT -u "sp@c/al" --servercert=d66b507ae074d03b02eafca40d35f87dd81049d3 -s /bin/true >${TMPFILE} 2>&1
+
+sleep 5
+
+if ! test -f ${builddir}/connect.ios.ok;then
+	cat ${TMPFILE}
+	echo "Connect script was not run (1)"
+	exit 1
+fi
+
+if ! test -f ${builddir}/disconnect.ios.ok;then
+	cat ${TMPFILE}
+	echo "Disconnect script was not run properly (1)"
+	exit 1
+fi
+
+rm -f ${builddir}/connect.ios.ok
+rm -f ${builddir}/disconnect.ios.ok
+
+grep 'X-CSTP-Split-Include-IP6: 2000::/3' ${TMPFILE} >/dev/null
+if test $? != 0;then
+	cat ${TMPFILE}
+	echo "Did not find the expected route"
+	exit 1
+fi
+
+rm -f ${TMPFILE}
+
+echo " * Re-connecting to force script run with user agent... "
+echo "!@#$%^&*()<>" | timeout 7 $OPENCONNECT --verbose --useragent="Cisco AnyConnect VPN Agent for Apple" localhost:$PORT -u "sp@c/al" --servercert=d66b507ae074d03b02eafca40d35f87dd81049d3 -s /bin/true >${TMPFILE} 2>&1
+
+sleep 5
+
+if ! test -f ${builddir}/connect.ios.ok;then
+	echo "Connect script was not run (2)"
+	exit 1
+fi
+
+if ! test -f ${builddir}/disconnect.ios.ok;then
+	echo "Disconnect script was not run properly (2)"
+	exit 1
+fi
+
+rm -f ${builddir}/connect.ios.ok
+rm -f ${builddir}/disconnect.ios.ok
+
+grep 'X-CSTP-Split-Include-IP6: 2000::/3' ${TMPFILE} >/dev/null
+if test $? != 0;then
+	cat ${TMPFILE}
+	echo "Did not find the expected route"
+	exit 1
+fi
+
+sleep 5
+echo " - Check server status"
+
+( echo "!@#$%^&*()<>" | $OPENCONNECT localhost:$PORT -u "sp@c/al" --servercert=d66b507ae074d03b02eafca40d35f87dd81049d3 --cookieonly >/dev/null 2>&1 ) ||
+	fail $PID "Could not receive cookie from server"
+
+echo " - Killing server"
+kill $PID
+PID=""
+wait
+
+echo "Script tests were successful"
+
+exit 0

tests/connect-ios-script

@@ -0,0 +1,36 @@
+#!/bin/bash
+
+#echo $USERNAME : $REASON : $DEVICE
+
+env >apple-ios.$REASON.tmp
+
+verify_env_set() {
+	if test -z "${!1}";then
+		echo "Fail: $1 environment variable was not set" >>apple-ios.$REASON.tmp
+		exit 1
+	fi
+}
+
+verify_env_set "IP_REMOTE"
+verify_env_set "REASON"
+
+case "$REASON" in
+  connect)
+	verify_env_set "USERNAME"
+	verify_env_set "USER_AGENT"
+	verify_env_set "DEVICE"
+	verify_env_set "DEVICE_PLATFORM"
+	verify_env_set "DEVICE_TYPE"
+
+	echo "${IP_REMOTE}" > connect.ios.ok
+	;;
+  disconnect)
+	if ! test -z "$DEVICE";then
+		echo "${IP_REMOTE}" > disconnect.ios.ok
+	fi
+	;;
+  "host-update")
+	;;
+esac
+
+exit 0

tests/connect-script

@@ -2,11 +2,10 @@
 
 #echo $USERNAME : $REASON : $DEVICE
 
-env >/tmp/out.$REASON.tmp
-
 verify_env_set() {
 	if test -z "${!1}";then
-		echo "$1 environment variable was not set" > /tmp/out.$REASON.fail.tmp
+		env >out.$REASON.fail.tmp
+		echo "$1 environment variable was not set" >>out.$REASON.fail.tmp
 		exit 1
 	fi
 }

tests/data/apple-ios.config

@@ -0,0 +1,191 @@
+# User authentication method. Could be set multiple times and in that case
+# all should succeed.
+# Options: certificate, pam. 
+#auth = "certificate"
+auth = "plain[@SRCDIR@/data/test1.passwd]"
+#auth = "pam"
+
+isolate-workers = @ISOLATE_WORKERS@
+
+# A banner to be displayed on clients
+#banner = "Welcome"
+
+# Use listen-host to limit to specific IPs or to the IPs of a provided hostname.
+#listen-host = [IP|HOSTNAME]
+
+use-dbus = no
+
+# Limit the number of clients. Unset or set to zero for unlimited.
+#max-clients = 1024
+max-clients = 16
+
+# Limit the number of client connections to one every X milliseconds 
+# (X is the provided value). Set to zero for no limit.
+#rate-limit-ms = 100
+
+# Limit the number of identical clients (i.e., users connecting multiple times)
+# Unset or set to zero for unlimited.
+max-same-clients = 4
+
+# TCP and UDP port number
+tcp-port = @PORT@
+udp-port = @PORT@
+
+# Keepalive in seconds
+keepalive = 32400
+
+# Dead peer detection in seconds
+dpd = 20
+
+# MTU discovery (DPD must be enabled)
+try-mtu-discovery = false
+
+# The key and the certificates of the server
+# The key may be a file, or any URL supported by GnuTLS (e.g., 
+# tpmkey:uuid=xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx;storage=user
+# or pkcs11:object=my-vpn-key;object-type=private)
+#
+# There may be multiple certificate and key pairs and each key
+# should correspond to the preceding certificate.
+server-cert = @SRCDIR@/certs/server-cert.pem
+server-key = @SRCDIR@/certs/server-key.pem
+
+# Diffie-Hellman parameters. Only needed if you require support
+# for the DHE ciphersuites (by default this server supports ECDHE).
+# Can be generated using:
+# certtool --generate-dh-params --outfile /path/to/dh.pem
+#dh-params = /path/to/dh.pem
+
+# If you have a certificate from a CA that provides an OCSP
+# service you may provide a fresh OCSP status response within
+# the TLS handshake. That will prevent the client from connecting
+# independently on the OCSP server.
+# You can update this response periodically using:
+# ocsptool --ask --load-cert=your_cert --load-issuer=your_ca --outfile response
+# Make sure that you replace the following file in an atomic way.
+#ocsp-response = /path/to/ocsp.der
+
+# In case PKCS #11 or TPM keys are used the PINs should be available
+# in files. The srk-pin-file is applicable to TPM keys only (It's the storage
+# root key).
+#pin-file = /path/to/pin.txt
+#srk-pin-file = /path/to/srkpin.txt
+
+# The Certificate Authority that will be used
+# to verify clients if certificate authentication
+# is set.
+#ca-cert = /path/to/ca.pem
+
+# The object identifier that will be used to read the user ID in the client certificate.
+# The object identifier should be part of the certificate's DN
+# Useful OIDs are: 
+#  CN = 2.5.4.3, UID = 0.9.2342.19200300.100.1.1
+#cert-user-oid = 0.9.2342.19200300.100.1.1
+
+# The object identifier that will be used to read the user group in the client 
+# certificate. The object identifier should be part of the certificate's DN
+# Useful OIDs are: 
+#  OU (organizational unit) = 2.5.4.11 
+#cert-group-oid = 2.5.4.11
+
+# A revocation list of ca-cert is set
+#crl = /path/to/crl.pem
+
+# GnuTLS priority string
+tls-priorities = "PERFORMANCE:%SERVER_PRECEDENCE:%COMPAT"
+
+# To enforce perfect forward secrecy (PFS) on the main channel.
+#tls-priorities = "NORMAL:%SERVER_PRECEDENCE:%COMPAT:-RSA"
+
+# The time (in seconds) that a client is allowed to stay connected prior
+# to authentication
+auth-timeout = 40
+
+# The time (in seconds) that a client is allowed to stay idle (no traffic)
+# before being disconnected. Unset to disable.
+#idle-timeout = 5
+
+# The time (in seconds) that a client is not allowed to reconnect after 
+# a failed authentication attempt.
+#min-reauth-time = 2
+
+# Cookie validity time (in seconds)
+# Once a client is authenticated he's provided a cookie with
+# which he can reconnect. This option sets the maximum lifetime
+# of that cookie.
+cookie-validity = 172800
+
+# Script to call when a client connects and obtains an IP
+# Parameters are passed on the environment.
+# REASON, USERNAME, GROUPNAME, HOSTNAME (the hostname selected by client), 
+# DEVICE, IP_REAL (the real IP of the client), IP_LOCAL (the local IP
+# in the P-t-P connection), IP_REMOTE (the VPN IP of the client). REASON
+# may be "connect" or "disconnect".
+connect-script = ./connect-ios-script
+disconnect-script = ./connect-ios-script
+
+# UTMP
+#use-utmp = true
+
+# PID file
+pid-file = /var/run/ocserv.pid
+
+# The default server directory. Does not require any devices present.
+#chroot-dir = /path/to/chroot
+
+# socket file used for IPC, will be appended with .PID
+# It must be accessible within the chroot environment (if any)
+socket-file = /var/run/ocserv-socket
+
+# The user the worker processes will be run as. It should be
+# unique (no other services run as this user).
+run-as-user = @USERNAME@
+run-as-group = @GROUP@
+
+# Network settings
+
+device = vpns
+
+# The default domain to be advertised
+default-domain = example.com
+
+ipv4-network = @VPNNET@
+#ipv4-netmask = 255.255.255.0
+# Use the keywork local to advertize the local P-t-P address as DNS server
+#ipv4-dns = 192.168.1.1
+#ipv4-dns = 192.168.5.1
+
+# The NBNS server (if any)
+#ipv4-nbns = 192.168.2.3
+
+ipv6-network = fd69:7016:8d15:b5a5::/64
+#ipv6-mask = 
+#ipv6-dns = 
+
+# Prior to leasing any IP from the pool ping it to verify that
+# it is not in use by another (unrelated to this server) host.
+ping-leases = false
+
+# Leave empty to assign the default MTU of the device
+# mtu = 
+
+#route = 192.168.1.0/255.255.255.0
+#route = 192.168.5.0/255.255.255.0
+
+#
+# The following options are for (experimental) AnyConnect client 
+# compatibility. They are only available if the server is built 
+# with --enable-anyconnect
+#
+
+# Client profile xml. A sample file exists in doc/profile.xml.
+# This file must be accessible from inside the worker's chroot. 
+# The profile is ignored by the openconnect client.
+#user-profile = profile.xml
+
+# Unless set to false it is required for clients to present their
+# certificate even if they are authenticating via a previously granted
+# cookie. Legacy CISCO clients do not do that, and thus this option
+# should be set for them.
+#always-require-cert = false
+