updated default config file

ocserv.conf

@@ -5,10 +5,18 @@
 #auth = "plain[./sample.passwd]"
 auth = "pam"
 
+# The plain option requires specifying a password file which contains
+# entries of the following format.
+# "username:groupname:encoded-password"
+# One entry must be listed per line, and 'ocpasswd' can be used
+# to generate password entries.
+#auth = "plain[/etc/ocserv/ocpasswd]"
+
 # 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.
+# Use listen-host to limit to specific IPs or to the IPs of a provided 
+# hostname.
 #listen-host = [IP|HOSTNAME]
 
 # Limit the number of clients. Unset or set to zero for unlimited.
@@ -19,22 +27,25 @@ max-clients = 16
 # (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)
+# Limit the number of identical clients (i.e., users connecting 
-# Unset or set to zero for unlimited.
+# multiple times). Unset or set to zero for unlimited.
 max-same-clients = 2
 
 # TCP and UDP port number
-tcp-port = 4443
+tcp-port = 443
-udp-port = 4443
+udp-port = 443
 
 # Keepalive in seconds
 keepalive = 32400
 
-# Rekey time in seconds
+# Dead peer detection in seconds.
-rekey-time 172800
+dpd = 90
 
-# Dead peer detection in seconds
+# Dead peer detection for mobile clients. The needs to
-dpd = 60
+# be much higher to prevent such clients being awaken too 
+# often by the DPD messages, and save battery.
+# (clients that send the X-AnyConnect-Identifier-DeviceType)
+#mobile-dpd = 1800
 
 # MTU discovery (DPD must be enabled)
 try-mtu-discovery = false
@@ -65,29 +76,30 @@ server-key = /etc/pki/ocserv/private/server.key
 #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
+# in files. The srk-pin-file is applicable to TPM keys only, and is the 
-# root key).
+# storage root key.
 #pin-file = /path/to/pin.txt
 #srk-pin-file = /path/to/srkpin.txt
 
-# The Certificate Authority that will be used
+# The Certificate Authority that will be used to verify
-# to verify clients if certificate authentication
+# client certificates (public keys) if certificate authentication
 # is set.
+#ca-cert = /path/to/ca.pem
 ca-cert = /etc/pki/ocserv/cacerts/ca.crt
 
-# The object identifier that will be used to read the user ID in the client certificate.
+# The object identifier that will be used to read the user ID in the client 
-# The object identifier should be part of the certificate's DN
+# 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 
+# The object identifier that will be used to read the user group in the 
-# certificate. The object identifier should be part of the certificate's DN
+# client  certificate. The object identifier should be part of the certificate's
-# Useful OIDs are: 
+# 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
+# The revocation list of the certificates issued by the 'ca-cert' above.
 #crl = /path/to/crl.pem
 
 # GnuTLS priority string
@@ -100,38 +112,60 @@ tls-priorities = "NORMAL:%SERVER_PRECEDENCE:%COMPAT"
 # 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 = 1200
+
+# The time (in seconds) that a mobile client is allowed to stay idle (no
+# traffic) before being disconnected. Unset to disable.
+#mobile-idle-timeout = 2400
+
 # The time (in seconds) that a client is not allowed to reconnect after 
 # a failed authentication attempt.
-min-reauth-time = 2
+#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
+cookie-validity = 86400
+
+# ReKey time (in seconds)
+# ocserv will ask the client to refresh keys periodically once
+# this amount of seconds is elapsed. Set to zero to disable.
+rekey-time = 172800
+
+# ReKey method
+# Valid options: ssl, new-tunnel
+#  ssl: Will perform an efficient rehandshake on the channel allowing
+#       a seamless connection during rekey.
+#  new-tunnel: Will instruct the client to discard and re-establish the channel.
+#       Use this option only if the connecting clients have issues with the ssl
+#       option.
+rekey-method = ssl
 
 # 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
+# in the P-t-P connection), IP_REMOTE (the VPN IP of the client),
-# may be "connect" or "disconnect".
+# ID (a unique numeric ID); REASON may be "connect" or "disconnect".
 #connect-script = /usr/bin/myscript
 #disconnect-script = /usr/bin/myscript
 
+# UTMP
+use-utmp = true
+
 # D-BUS usage. If disabled occtl tool cannot be used. If enabled
 # then ocserv must have access to register org.infradead.ocserv
 # D-BUS service. See doc/dbus/org.infradead.ocserv.conf
 use-dbus = true
 
-# UTMP
+# PID file. It can be overriden in the command line.
-use-utmp = true
-
-# PID file
 #pid-file = /var/run/ocserv.pid
 
 # The default server directory. Does not require any devices present.
-chroot-dir = /var/lib/ocserv/
+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)
@@ -153,51 +187,69 @@ run-as-group = ocserv
 # specific and can be set per user/group or globally.
 #cgroup = "cpuset,cpu:test"
 
-
+#
 # Network settings
+#
 
+# The name of the tun device
 device = vpns
 
 # The default domain to be advertised
-#default-domain = example.com
+default-domain = example.com
 
-#ipv4-network = 192.168.1.0
+# The pool of addresses that leases will be given from.
-#ipv4-netmask = 255.255.255.0
+ipv4-network = 192.168.1.0
-#dns = 192.168.2.1
+ipv4-netmask = 255.255.255.0
+
+# The advertized DNS server. Use multiple lines for
+# multiple servers.
+# dns = fc00::4be0
+dns = 192.168.1.2
 
 # The NBNS server (if any)
-#nbns = 192.168.2.3
+#nbns = 192.168.1.3
+
+# The IPv6 subnet that leases will be given from.
+#ipv6-network = fc00::
+#ipv6-prefix = 16
 
-# The IPv6 subnet
+# The domains over which the provided DNS should be used. Use
-#ipv6-network = 
+# multiple lines for multiple domains.
-#ipv6-prefix =
+#split-dns = example.com
-#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
+# Unset to assign the default MTU of the device
 # mtu = 
 
 # Unset to enable bandwidth restrictions (in bytes/sec). The
 # setting here is global, but can also be set per user or per group.
-#rx-data-per-sec = 40960
+#rx-data-per-sec = 40000
-#tx-data-per-sec = 40960
+#tx-data-per-sec = 40000
 
 # The number of packets (of MTU size) that are available in
 # the output buffer. The default is low to improve latency.
 # Setting it higher will improve throughput.
-output-buffer = 100
+#output-buffer = 10
 
-#route = 192.168.1.0/255.255.255.0
+# Routes to be forwarded to the client. If you need the
+# client to forward routes to the server, you may use the 
+# config-per-user/group or even connect and disconnect scripts.
+#
+# To set the server as the default gateway for the client just
+# comment out all routes from the server.
+route = 192.168.1.0/255.255.255.0
 #route = 192.168.5.0/255.255.255.0
+#route = fef4:db8:1000:1001::/64
 
 # Configuration files that will be applied per user connection or
 # per group. Each file name on these directories must match the username
 # or the groupname.
 # The options allowed in the configuration files are dns, nbns,
-#  ipv?-network, ipv4-netmask, ipv6-prefix, iroute and route.
+#  ipv?-network, ipv4-netmask, ipv6-prefix, rx/tx-per-sec, iroute, route,
+#  net-priority and cgroup.
 #
 # Note that the 'iroute' option allows to add routes on the server
 # based on a user or group. The syntax depends on the input accepted
@@ -210,7 +262,7 @@ output-buffer = 100
 # route/mask and %D with the (tun) device.
 #
 # The following example is from linux systems. %R should be something
-# like 192.168.2.0/24 (so iroute in this system has different syntax than route)
+# like 192.168.2.0/24
 
 route-add-cmd = "ip route add %R dev %D"
 route-del-cmd = "ip route delete %R dev %D"
@@ -221,12 +273,22 @@ route-del-cmd = "ip route delete %R dev %D"
 
 # 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.
+# It is not used by the openconnect client.
 user-profile = profile.xml
 
+# Binary files that may be downloaded by the CISCO client. Must
+# be within any chroot environment.
+#binary-files = /path/to/binaries
+
 # 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
+# cookie and complete their authentication in the same TCP connection.
-# should be set for them.
+# Legacy CISCO clients do not do that, and thus this option should be 
+# set for them.
 cisco-client-compat = true
 
+#Advanced options
+
+# Option to allow sending arbitrary custom headers to the client after
+# authentication and prior to VPN tunnel establishment.
+#custom-header = "X-My-Header: hi there"