Merge pull request #5224 from diizzyy/patch-109
[feed/packages.git] / net / openconnect / README
1 The openconnect client expects to be configured using the uci interface.
2
3 To setup a VPN connection, add the following to /etc/config/network:
4
5 config interface 'MYVPN'
6 option proto 'openconnect'
7 option interface 'wan'
8 option server 'vpn.example.com'
9 option port '4443'
10 option username 'test'
11 option password 'secret'
12 option serverhash 'AE7FF6A0426F0A0CD0A02EB9EC3C5066FAEB0B25'
13 option defaultroute '0'
14 option authgroup 'DEFAULT'
15
16 # For second factor auth:
17
18 # when a fixed 2FA password can be used
19 #option password2 'my-fixed-2fa-password'
20
21 # RSA tokens, must be built with stoken support
22 #option token_mode 'rsa'
23 #option token_secret 'secret'
24
25 # HOTP/TOTP tokens
26 #option token_mode 'hotp'
27 #option token_secret '00'
28
29 # tokens from script
30 #option token_mode 'script'
31 #option token_script '/lib/custom/getocpass.sh'
32
33 # Juniper vpn support
34 #option juniper '1'
35
36 The additional files are also used:
37 /etc/openconnect/user-cert-vpn-MYVPN.pem: The user certificate
38 /etc/openconnect/user-key-vpn-MYVPN.pem: The user private key
39 /etc/openconnect/ca-vpn-MYVPN.pem: The CA certificate (instead of serverhash)
40
41 After these are setup you can initiate the VPN using "ifup MYVPN", and
42 deinitialize it using ifdown. You may also use the luci web interface
43 (Network -> Interfaces -> MYVPN Connect).
44
45 Note that you need to configure the firewall to allow communication between
46 the MYVPN interface and lan.
47
48 There is a luci plugin to allow configuring an openconnect interface from
49 the web environment; see the luci-proto-openconnect package.