ocserv/ocserv.conf

517 lines
20 KiB
Plaintext
Raw Normal View History

# User authentication method. Could be set multiple times and in
# that case all should succeed. To enable multiple methods use
# multiple auth directives. Available options: certificate,
# plain, pam, radius, gssapi.
#
# Note that authentication methods cannot be changed with reload.
2013-12-06 13:24:37 +00:00
2015-01-22 10:41:49 +00:00
# certificate:
# This indicates that all connecting users must present a certificate.
#
# pam[gid-min=1000]:
# This enabled PAM authentication of the user. The gid-min option is used
# by auto-select-group option, in order to select the minimum valid group ID.
2015-01-22 10:41:49 +00:00
#
# plain[passwd=/etc/ocserv/ocpasswd]
2015-01-22 10:41:49 +00:00
# The plain option requires specifying a password file which contains
2014-05-02 11:59:37 +00:00
# entries of the following format.
2015-01-22 10:41:49 +00:00
# "username:groupname1,groupname2:encoded-password"
# One entry must be listed per line, and 'ocpasswd' should be used
2014-05-02 11:59:37 +00:00
# to generate password entries.
2015-01-22 10:41:49 +00:00
#
# radius[config=/etc/radiusclient/radiusclient.conf,groupconfig=true,nas-identifier=name]:
2015-01-22 10:41:49 +00:00
# The radius option requires specifying freeradius-client configuration
# file. If the groupconfig option is set, then config-per-user will be overriden,
# and all configuration will be read from radius. The supported atributes for
# radius configuration are:
# Group-Name, Framed-IPv6-Address, Framed-IPv6-Prefix, DNS-Server-IPv6-Address,
# Framed-IP-Address, Framed-IP-Netmask, MS-Primary-DNS-Server, MS-Secondary-DNS-Server
#
# gssapi[keytab=/etc/key.tab,require-local-user-map=false]
# The gssapi option allows to use authentication methods supported by GSSAPI,
# such as Kerberos tickets with ocserv. It should be best used as an alternative
# to PAM (i.e., have pam in auth and gssapi in enable-auth), to allow users with
# tickets and without tickets to login. The default value for require-local-user-map
# is true.
2015-01-22 10:41:49 +00:00
auth = "pam"
#auth = "pam[gid-min=1000]"
#auth = "plain[passwd=./sample.passwd]"
#auth = "certificate"
#auth = "radius[config=/etc/radiusclient/radiusclient.conf,groupconfig=true]"
# Specify alternative authentication methods that are sufficient
# for authentication. That is, if set, any of the methods enabled
# will be sufficient to login.
#enable-auth = certificate
#enable-auth = gssapi
#enable-auth = "gssapi[keytab=/etc/key.tab,require-local-user-map=true]"
# Accounting methods available:
# pam: can only be combined with PAM authentication method, it provides
# a session opened using PAM.
#
# radius: can be combined with any authentication method, it provides
# radius accounting to available users (see also stats-report-time).
#
# Only one accounting method can be specified.
#acct = "pam"
#acct = "radius[config=/etc/radiusclient/radiusclient.conf]"
# Use listen-host to limit to specific IPs or to the IPs of a provided
# hostname.
#listen-host = [IP|HOSTNAME]
# When the server has a dynamic DNS address (that may change),
# should set that to true to ask the client to resolve again on
# reconnects.
#listen-host-is-dyndns = true
# TCP and UDP port number
tcp-port = 443
udp-port = 443
# Accept connections using a socket file. It accepts HTTP
# connections (i.e., without SSL/TLS unlike its TCP counterpart),
# and uses it as the primary channel. That option cannot be
# combined with certificate authentication.
#listen-clear-file = /var/run/ocserv-conn.socket
# The user the worker processes will be run as. It should be
# unique (no other services run as this user).
run-as-user = ocserv
run-as-group = ocserv
# socket file used for IPC with occtl. You only need to set that,
# if you use more than a single servers.
#occtl-socket-file = /var/run/occtl.socket
# socket file used for server IPC (worker-main), will be appended with .PID
# It must be accessible within the chroot environment (if any), so it is best
# specified relatively to the chroot directory.
socket-file = ocserv.sock
# The default server directory. Does not require any devices present.
chroot-dir = /var/lib/ocserv
### All configuration options below this line are reloaded on a SIGHUP.
### The options above, will remain unchanged.
2014-05-02 11:59:37 +00:00
2015-01-22 10:41:49 +00:00
# Whether to enable seccomp/Linux namespaces worker isolation. That restricts the number of
2014-12-11 12:34:08 +00:00
# system calls allowed to a worker process, in order to reduce damage from a
# bug in the worker process. It is available on Linux systems at a performance cost.
2015-01-22 10:41:49 +00:00
# The performance cost is roughly 2% overhead at transfer time (tested on a Linux 3.17.8).
isolate-workers = true
2014-12-11 12:34:08 +00:00
2013-12-06 13:24:37 +00:00
# A banner to be displayed on clients
#banner = "Welcome"
# Limit the number of clients. Unset or set to zero for unlimited.
#max-clients = 1024
max-clients = 16
2014-05-02 11:59:37 +00:00
# Limit the number of identical clients (i.e., users connecting
# multiple times). Unset or set to zero for unlimited.
2013-12-06 13:24:37 +00:00
max-same-clients = 2
2014-12-11 12:34:08 +00:00
# When the server has a dynamic DNS address (that may change),
# should set that to true to ask the client to resolve again on
# reconnects.
#listen-host-is-dyndns = true
# 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
2015-01-22 10:41:49 +00:00
# Stats report time. The number of seconds after which each
# worker process will report its usage statistics (number of
# bytes transferred etc). This is useful when accounting like
# radius is in use.
#stats-report-time = 360
2014-12-11 12:34:08 +00:00
2013-12-06 13:24:37 +00:00
# Keepalive in seconds
keepalive = 32400
2014-05-02 11:59:37 +00:00
# Dead peer detection in seconds.
2015-01-22 10:41:49 +00:00
# Note that when the client is behind a NAT this value
# needs to be short enough to prevent the NAT disassociating
# his UDP session from the port number. Otherwise the client
# could have his UDP connection stalled, for several minutes.
2014-05-02 11:59:37 +00:00
dpd = 90
2014-02-17 07:27:55 +00:00
2015-01-22 10:41:49 +00:00
# Dead peer detection for mobile clients. That needs to
# be higher to prevent such clients being awaken too
2014-05-02 11:59:37 +00:00
# often by the DPD messages, and save battery.
2015-01-22 10:41:49 +00:00
# The mobile clients are distinguished from the header
# 'X-AnyConnect-Identifier-DeviceType'.
mobile-dpd = 1800
2013-12-06 13:24:37 +00:00
# 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)
#
2015-01-22 10:41:49 +00:00
# The server-cert file may contain a single certificate, or
# a sorted certificate chain.
#
# There may be multiple server-cert and server-key directives,
# but each key should correspond to the preceding certificate.
2014-01-27 09:43:16 +00:00
server-cert = /etc/pki/ocserv/public/server.crt
server-key = /etc/pki/ocserv/private/server.key
2013-12-06 13:24:37 +00:00
# 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
2014-05-02 11:59:37 +00:00
# in files. The srk-pin-file is applicable to TPM keys only, and is the
# storage root key.
2013-12-06 13:24:37 +00:00
#pin-file = /path/to/pin.txt
#srk-pin-file = /path/to/srkpin.txt
2014-05-02 11:59:37 +00:00
# The Certificate Authority that will be used to verify
# client certificates (public keys) if certificate authentication
2013-12-06 13:24:37 +00:00
# is set.
2014-01-27 09:43:16 +00:00
ca-cert = /etc/pki/ocserv/cacerts/ca.crt
2013-12-06 13:24:37 +00:00
2014-05-02 11:59:37 +00:00
# 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
2013-12-06 13:24:37 +00:00
# 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
2013-12-06 13:24:37 +00:00
2014-05-02 11:59:37 +00:00
# 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:
2013-12-06 13:24:37 +00:00
# OU (organizational unit) = 2.5.4.11
#cert-group-oid = 2.5.4.11
2014-05-02 11:59:37 +00:00
# The revocation list of the certificates issued by the 'ca-cert' above.
2015-01-22 10:41:49 +00:00
# See the manual to generate an empty CRL initially.
2013-12-06 13:24:37 +00:00
#crl = /path/to/crl.pem
2015-01-22 10:41:49 +00:00
# Uncomment this to enable compression negotiation (LZS, LZ4).
#compression = true
# Set the minimum size under which a packet will not be compressed.
# That is to allow low-latency for VoIP packets. The default size
# is 256 bytes. Modify it if the clients typically use compression
# as well of VoIP with codecs that exceed the default value.
#no-compress-limit = 256
# GnuTLS priority string; note that SSL 3.0 is disabled by default
# as there are no openconnect (and possibly anyconnect clients) using
# that protocol. The string below does not enforce perfect forward
# secrecy, in order to be compatible with legacy clients.
#
# Note that the most performant ciphersuites are the moment are the ones
# involving AES-GCM. These are very fast in x86 and x86-64 hardware, and
# in addition require no padding, thus taking full advantage of the MTU.
# For that to be taken advantage of, the openconnect client must be
# used, and the server must be compiled against GnuTLS 3.2.7 or later.
# Use "gnutls-cli --benchmark-tls-ciphers", to see the performance
# difference with AES_128_CBC_SHA1 (the default for anyconnect clients)
# in your system.
#tls-priorities = "NORMAL:%SERVER_PRECEDENCE:%COMPAT:-VERS-SSL3.0"
tls-priorities = "@SYSTEM"
2013-12-06 13:24:37 +00:00
2015-01-22 10:41:49 +00:00
# More combinations in priority strings are available, check
# http://gnutls.org/manual/html_node/Priority-Strings.html
# E.g., the string below enforces perfect forward secrecy (PFS)
# on the main channel.
2014-12-11 12:34:08 +00:00
#tls-priorities = "NORMAL:%SERVER_PRECEDENCE:%COMPAT:-RSA:-VERS-SSL3.0:-ARCFOUR-128"
2013-12-06 13:24:37 +00:00
# The time (in seconds) that a client is allowed to stay connected prior
# to authentication
auth-timeout = 40
2014-05-02 11:59:37 +00:00
# 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
2013-12-06 13:24:37 +00:00
# The time (in seconds) that a client is not allowed to reconnect after
# a failed authentication attempt.
min-reauth-time = 300
# Banning clients in ocserv works with a point system. IP addresses
# that get a score over that configured number are banned for
# min-reauth-time seconds. By default a wrong password attempt is 10 points,
# a KKDCP POST is 1 point, and a connection is 1 point. Note that
# due to difference processes being involved the count of points
# will not be real-time precise.
#
# Score banning cannot be reliably used when receiving proxied connections
# locally from an HTTP server (i.e., when listen-clear-file is used).
#
# Set to zero to disable.
max-ban-score = 50
# The time (in seconds) that all score kept for a client is reset.
ban-reset-time = 300
# In case you'd like to change the default points.
#ban-points-wrong-password = 10
#ban-points-connection = 1
#ban-points-kkdcp = 1
2013-12-06 13:24:37 +00:00
2014-06-02 07:10:26 +00:00
# Cookie timeout (in seconds)
2014-12-11 12:34:08 +00:00
# Once a client is authenticated he's provided a cookie with
# which he can reconnect. That cookie will be invalided if not
# used within this timeout value. On a user disconnection, that
# cookie will also be active for this time amount prior to be
# invalid. That should allow a reasonable amount of time for roaming
# between different networks.
cookie-timeout = 300
# Whether roaming is allowed, i.e., if true a cookie is
# restricted to a single IP address and cannot be re-used
# from a different IP.
deny-roaming = false
2014-05-02 11:59:37 +00:00
# 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
2013-12-06 13:24:37 +00:00
2015-01-22 10:41:49 +00:00
# Script to call when a client connects and obtains an IP.
# The following parameters are passed on the environment.
2013-12-06 13:24:37 +00:00
# REASON, USERNAME, GROUPNAME, HOSTNAME (the hostname selected by client),
# DEVICE, IP_REAL (the real IP of the client), IP_LOCAL (the local IP
2014-05-02 11:59:37 +00:00
# in the P-t-P connection), IP_REMOTE (the VPN IP of the client),
2015-01-22 10:41:49 +00:00
# IPV6_LOCAL (the IPv6 local address if there are both IPv4 and IPv6
# assigned), IPV6_REMOVE (the IPv6 remote address), and
2014-05-02 11:59:37 +00:00
# ID (a unique numeric ID); REASON may be "connect" or "disconnect".
2015-01-22 10:41:49 +00:00
# The disconnect script will receive the additional values: STATS_BYTES_IN,
# STATS_BYTES_OUT, STATS_DURATION that contain a 64-bit counter of the bytes
# output from the tun device, and the duration of the session in seconds.
2014-12-11 12:40:49 +00:00
#connect-script = /usr/bin/ocserv-script
#disconnect-script = /usr/bin/ocserv-script
2013-12-06 13:24:37 +00:00
2014-05-02 11:59:37 +00:00
# UTMP
2015-01-22 10:41:49 +00:00
# Register the connected clients to utmp. This will allow viewing
# the connected clients using the command 'who'.
#use-utmp = true
2014-05-02 11:59:37 +00:00
2014-05-26 11:06:37 +00:00
# Whether to enable support for the occtl tool (i.e., either through D-BUS,
# or via a unix socket).
use-occtl = true
2014-05-02 11:59:37 +00:00
# PID file. It can be overriden in the command line.
pid-file = /var/run/ocserv.pid
2013-12-06 13:24:37 +00:00
2013-12-16 09:32:18 +00:00
# Set the protocol-defined priority (SO_PRIORITY) for packets to
# be sent. That is a number from 0 to 6 with 0 being the lowest
# priority. Alternatively this can be used to set the IP Type-
# Of-Service, by setting it to a hexadecimal number (e.g., 0x20).
# This can be set per user/group or globally.
#net-priority = 3
# Set the VPN worker process into a specific cgroup. This is Linux
# specific and can be set per user/group or globally.
#cgroup = "cpuset,cpu:test"
2014-05-02 11:59:37 +00:00
#
2013-12-06 13:24:37 +00:00
# Network settings
2014-05-02 11:59:37 +00:00
#
2013-12-06 13:24:37 +00:00
2015-01-22 10:41:49 +00:00
# The name to use for the tun device
2013-12-06 13:24:37 +00:00
device = vpns
2014-05-26 11:06:37 +00:00
# Whether the generated IPs will be predictable, i.e., IP stays the
# same for the same user when possible.
predictable-ips = true
2013-12-06 13:24:37 +00:00
# The default domain to be advertised
2014-05-02 11:59:37 +00:00
default-domain = example.com
2013-12-06 13:24:37 +00:00
2015-02-16 09:45:16 +00:00
# The pool of addresses that leases will be given from. If the leases
# are given via Radius, or via the explicit-ip? per-user config option then
2015-02-16 09:45:16 +00:00
# these network values should contain a network with at least a single
# address that will remain under the full control of ocserv (that is
# to be able to assign the local part of the tun device address).
2015-01-22 10:41:49 +00:00
#ipv4-network = 192.168.1.0
#ipv4-netmask = 255.255.255.0
# An alternative way of specifying the network:
#ipv4-network = 192.168.1.0/24
2014-05-02 11:59:37 +00:00
2015-02-16 09:45:16 +00:00
# The IPv6 subnet that leases will be given from.
#ipv6-network = fda9:4efe:7e3b:03ea::/64
2014-05-02 11:59:37 +00:00
# The advertized DNS server. Use multiple lines for
# multiple servers.
# dns = fc00::4be0
2015-01-22 10:41:49 +00:00
#dns = 192.168.1.2
2013-12-06 13:24:37 +00:00
# The NBNS server (if any)
2014-05-02 11:59:37 +00:00
#nbns = 192.168.1.3
# The domains over which the provided DNS should be used. Use
# multiple lines for multiple domains.
#split-dns = example.com
2013-12-06 13:24:37 +00:00
# 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.
2015-01-22 10:41:49 +00:00
# Only set to true, if there can be occupied addresses in the
# IP range for leases.
2013-12-06 13:24:37 +00:00
ping-leases = false
2015-01-22 10:41:49 +00:00
# Use this option to enforce an MTU value to the incoming
# connections. Unset to use the default MTU of the TUN device.
#mtu = 1420
2013-12-06 13:24:37 +00:00
# Unset to enable bandwidth restrictions (in bytes/sec). The
# setting here is global, but can also be set per user or per group.
2014-05-02 11:59:37 +00:00
#rx-data-per-sec = 40000
#tx-data-per-sec = 40000
2013-12-06 13:24:37 +00:00
# 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.
2014-05-02 11:59:37 +00:00
#output-buffer = 10
2013-12-06 13:24:37 +00:00
2014-05-02 11:59:37 +00:00
# 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
2015-01-22 10:41:49 +00:00
# comment out all routes from the server, or use the special keyword
# 'default'.
#route = 10.10.10.0/255.255.255.0
#route = 192.168.0.0/255.255.0.0
2014-05-02 11:59:37 +00:00
#route = fef4:db8:1000:1001::/64
2013-12-06 13:24:37 +00:00
# Subsets of the routes above that will not be routed by
# the server.
#no-route = 192.168.5.0/255.255.255.0
2015-01-22 10:41:49 +00:00
# Groups that a client is allowed to select from.
# A client may belong in multiple groups, and in certain use-cases
# it is needed to switch between them. For these cases the client can
# select prior to authentication. Add multiple entries for multiple groups.
# The group may be followed by a user-friendly name in brackets.
#select-group = group1
#select-group = group2[My special group]
# The name of the (virtual) group that if selected it would assign the user
# to its default group.
#default-select-group = DEFAULT
# Instead of specifying manually all the allowed groups, you may instruct
# ocserv to scan all available groups and include the full list.
#auto-select-group = true
2013-12-06 13:24:37 +00:00
# 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.
2014-02-17 07:42:45 +00:00
# The options allowed in the configuration files are dns, nbns,
2015-01-22 10:41:49 +00:00
# ipv?-network, ipv4-netmask, rx/tx-per-sec, iroute, route,
# net-priority, deny-roaming, no-udp, user-profile, and cgroup.
2013-12-06 13:24:37 +00:00
#
# 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
2015-01-22 10:41:49 +00:00
# by the commands route-add-cmd and route-del-cmd (see below). The no-udp
# is a boolean option (e.g., no-udp = true), and will prevent a UDP session
# for that specific user or group.
2013-12-06 13:24:37 +00:00
#config-per-user = /etc/ocserv/config-per-user/
#config-per-group = /etc/ocserv/config-per-group/
2014-05-26 11:06:37 +00:00
# When config-per-xxx is specified and there is no group or user that
# matches, then utilize the following configuration.
#default-user-config = /etc/ocserv/defaults/user.conf
#default-group-config = /etc/ocserv/defaults/group.conf
2014-12-11 12:34:08 +00:00
# The system command to use to setup a route. %{R} will be replaced with the
# route/mask and %{D} with the (tun) device.
2013-12-06 13:24:37 +00:00
#
2015-01-22 10:41:49 +00:00
# The following example is from linux systems. %R should be something
# like 192.168.2.0/24 (the argument of iroute).
2013-12-06 13:24:37 +00:00
#route-add-cmd = "ip route add %{R} dev %{D}"
#route-del-cmd = "ip route delete %{R} dev %{D}"
2014-12-11 12:34:08 +00:00
2015-01-22 10:41:49 +00:00
# This option allows to forward a proxy. The special keywords '%{U}'
2014-12-11 12:34:08 +00:00
# and '%{G}', if present will be replaced by the username and group name.
#proxy-url = http://example.com/
2015-01-22 10:41:49 +00:00
#proxy-url = http://example.com/%{U}/
2013-12-06 13:24:37 +00:00
# This option allows you to specify a URL location where a client can
# post using MS-KKDCP, and the message will be forwarded to the provided
# KDC server. That is a translation URL between HTTP and Kerberos.
# In MIT kerberos you'll need to add in realms:
# EXAMPLE.COM = {
# kdc = https://ocserv.example.com/kerberos
# http_anchors = FILE:/etc/ocserv-ca.pem
# }
# This option is available if ocserv is compiled with GSSAPI support.
#kkdcp = SERVER-PATH KERBEROS-REALM PROTOCOL@SERVER:PORT
#kkdcp = /kerberos EXAMPLE.COM udp@127.0.0.1:88
#kkdcp = /kerberos-tcp EXAMPLE.COM tcp@127.0.0.1:88
2013-12-06 13:24:37 +00:00
#
# The following options are for (experimental) AnyConnect client
# compatibility.
2015-01-22 10:41:49 +00:00
# This option must be set to true to support legacy CISCO clients.
# A side effect of this option is that it will no longer be required
# for clients to present their certificate on every connection.
# That is they may resume a cookie without presenting a certificate
# (when certificate authentication is used).
cisco-client-compat = true
2013-12-06 13:24:37 +00:00
# Client profile xml. A sample file exists in doc/profile.xml.
2015-01-22 10:41:49 +00:00
# It is required by some of the CISCO clients.
2013-12-06 13:24:37 +00:00
# This file must be accessible from inside the worker's chroot.
2014-02-17 14:52:29 +00:00
user-profile = profile.xml
2013-12-06 13:24:37 +00:00
2014-05-02 11:59:37 +00:00
# Binary files that may be downloaded by the CISCO client. Must
2015-01-22 10:41:49 +00:00
# be within any chroot environment. Normally you don't need
# to use this option.
2014-05-02 11:59:37 +00:00
#binary-files = /path/to/binaries
#Advanced options
# Option to allow sending arbitrary custom headers to the client after
2015-01-22 10:41:49 +00:00
# authentication and prior to VPN tunnel establishment. You shouldn't
# need to use this option normally; if you do and you think that
# this may help others, please send your settings and reason to
# the openconnect mailing list. The special keywords '%{U}'
# and '%{G}', if present will be replaced by the username and group name.
2014-05-02 11:59:37 +00:00
#custom-header = "X-My-Header: hi there"
2015-01-22 10:41:49 +00:00