Configuration Reference
The server settings that change what the app's SoftEther VPN profiles do, what each field of a profile does on the wire, and the settings the app always uses. SoftEther VPN Server builds the server this page refers to; Test results has the cases named in the tables.
Our SoftEther VPN Server 4.44 test server was set up as SoftEther VPN Server describes, and its settings were read back with vpncmd. The cases named in the tables connected both phones to it with the profile settings in their rows; where a row names TCP connections, UDP acceleration or NAT-T, the server's SessionGet showed it for the phone's session while the case ran. The case names are the rows of Test results. Settings this page describes without a case were left as SoftEther sets them, or were not part of our tests. What each profile field does comes from the source code of both apps and, where a case covers it, from that case.
Server settings (vpncmd)
Settings are made with vpncmd, at the VPN Server> prompt that vpncmd localhost /SERVER opens. A command for a hub acts on the hub chosen before it with Hub <name>. Our server has the users of every login method in both its hubs, DEFAULT and TEST-HUB. While a phone is connected, SessionList in the hub shows its session, and SessionGet <SESSION_NAME> the session's TCP connections, UDP acceleration and underlying protocol.
Listeners and certificate
| Setting | What it does for the app | Cases |
|---|---|---|
Listeners on TCP 443, 992, 1194 and 5555 (ListenerList) | The profile's Port is one of them: the app connected on 443, its default, and on 992 and 5555. On a port where another service answers, the app ends with The TLS handshake with the server failed. Check the Server and Port fields. On a port nothing listens on, with NAT-T off, it ends with Cannot reach the server (DNS lookup or TCP connection failed). Check the Server field for typos and the network connection. Left as SoftEther sets them. | sev-pass-download, sev-port-992, sev-port-5555, sev-port-other-service, sev-natt-off-closed-tcp-port |
ServerCertSet /LOADCERT:…/fullchain.pem /LOADKEY:…/privkey.pem | The certificate the app checks with TLS Server Verification on. Ours is from Let's Encrypt for the server's name, so a profile with that name in Server connects. With the server's IP address in Server the app shows its certificate warning: declined, it does not connect; accepted, it does. With the name in Hostname, or with verification off, the same profile connects. A name the certificate is not for in Hostname ends on iPhone with The server certificate name does not match the server. Check the Hostname field.; on Android the certificate warning comes first. | sev-pass-download, sev-verify-ip-declined, sev-verify-ip-accepted, sev-hostname-override-ip, sev-allow-untrusted-ip, sev-hostname-override-wrong |
| TLS versions and ciphers | Our server and the app use TLS 1.3 on both phones; SessionGet shows TLS_AES_256_GCM_SHA384. Left as SoftEther sets them. |
Virtual Hubs and addresses
| Setting | What it does for the app | Cases |
|---|---|---|
The hub DEFAULT | A new server has it. The app logs in to it when Virtual Hub is empty. | sev-pass-download |
HubCreate TEST-HUB /PASSWORD:<HUB_ADMIN_PASSWORD> | A second hub, with its own users. A profile with Virtual Hub TEST-HUB logs in to it. A name the server has no hub for ends with Virtual Hub not found. Check the Virtual Hub field. | sev-hub-test-hub, sev-wrong-hub |
SecureNatEnable in each hub | SoftEther's built-in DHCP and NAT, the hub's way out. The phone gets an address from 192.168.30.10 on, with the gateway and DNS server 192.168.30.1, and its IPv4 traffic leaves from the server's address: in every case that moved traffic, our test server on the internet saw it arrive from there. SecureNAT hands out IPv4 addresses only. | sev-pass-download, sev-pass-upload, sev-hub-test-hub |
| A Local Bridge with Linux NAT | The other way out for a hub's clients, instead of SecureNAT. The SoftEther page of the SSTP section describes it: Local Bridge with Linux NAT. Not part of our tests. |
Users and logins
Each user is made in its hub with UserCreate <name> /GROUP:none /REALNAME:none /NOTE:none and then given one kind of login, which the profile's Method must match. Every refusal below, a wrong password, a method that does not match the user's kind or a certificate the hub does not accept, ends with Authentication failed. Check the username, password and authentication method.
| Setting | What it does for the app | Cases |
|---|---|---|
UserPasswordSet vpnuser /PASSWORD:<PASSWORD> | Password authentication, for Method Standard Password. A wrong password is refused, and so is Method Anonymous with this user's name. | sev-pass-download, sev-wrong-password, sev-anon-on-password-user |
UserAnonymousSet guest | Anonymous authentication, for Method Anonymous: the app logs in with the user's name and no password. | sev-anon-download |
RadiusServerSet 127.0.0.1:1812 /SECRET:<RADIUS_SECRET> /RETRY_INTERVAL:500UserRadiusSet radiususer /ALIAS:none | RADIUS authentication, for Method RADIUS / NT Domain. The app sends the password inside TLS, and the hub asks the RADIUS server, here FreeRADIUS on the same host, which keeps the password. Version 4.44 takes the port as part of the address. A wrong password is refused, and so is this user with Method Standard Password. | sev-radius-download, sev-radius-wrong-password, sev-radius-user-standard-method |
| NT Domain authentication | Checks the password against a Windows domain, for the same Method, RADIUS / NT Domain. Only SoftEther VPN Server on Windows offers it; our server runs on Linux. Not part of our tests. | |
CAAdd ca.crtUserSignedSet certuser /CN:certuser /SERIAL:noneUserCertSet certuser2 /LOADCERT:/root/certuser2.crt | Certificate users, for Method Certificate. Signed certificate: the hub trusts the authority added with CAAdd, and any certificate it signed with the user's common name logs in as the user. Individual certificate: the server keeps the user's own certificate. The app logged in as both kinds with the client certificate imported in the profile. A certificate signed by another authority is refused. | sev-cert-signed-download, sev-cert-individual-download, sev-cert-rogue-ca |
UDP acceleration and NAT traversal
Both are on by default on the server, and both need incoming UDP: SoftEther picks its UDP ports itself, and our server's firewall lets all incoming UDP through. The app uses them only when its switches are on.
| Setting | What it does for the app | Cases |
|---|---|---|
Hub option DisableUdpAcceleration not set | With Enable UDP Acceleration on, once the TLS connection is up, the app and the server also exchange the VPN's packets over UDP. SessionGet showed UDP Acceleration is Active | Yes with the profile's Connections at 1 and at 4. Left as SoftEther sets it. | sev-udp-accel, sev-udp-accel-conns-4 |
DisableNatTraversal not set in vpn_server.config | The server takes part in NAT traversal through the NAT-T servers of SoftEther Corporation. With Enable NAT Traversal (NAT-T) on, a profile whose Port the server does not listen on connected over UDP through them; SessionGet showed Physical Underlay Protocol | VPN over UDP with NAT-T (IPv4). With NAT-T off the same profile ends with Cannot reach the server (DNS lookup or TCP connection failed). Check the Server field for typos and the network connection. With NAT-T Hint set to the server's own address the app connected over NAT-T; with an address no server has, it ends with the same message. Left as SoftEther sets it. | sev-natt-closed-tcp-port, sev-natt-off-closed-tcp-port, sev-natt-hint-server, sev-natt-hint-wrong |
Sessions
| Setting | What it does for the app | Cases |
|---|---|---|
| VoIP / QoS function on | A session uses at least two TCP connections even when the profile's Connections is 1: SessionGet counted 2 for a profile with the defaults, on both phones. Left as SoftEther sets it. | sev-pass-download, sev-pass-full-duplex, sev-pass-upload |
SessionDisconnect … | Ends the phone's session on the server. With Auto Reconnect on, the app connects again; with it off, the VPN ends with Connection lost (auto reconnect is off). | sev-life-peer-drop-reconnect, sev-life-peer-drop-no-reconnect |
| The SoftEther service stopped | With Auto Reconnect on, the app keeps trying while the server is away: when the service stopped for 8 seconds and started again, the app connected again. With Retry Times 2 and the service left stopped, the VPN ends after two failed attempts with Could not reconnect after N attempts. (…), the last attempt's reason in the brackets. | sev-life-outage-reconnect, sev-life-retry-exhausted |
What each profile field does
The fields in the order the editor shows them. Setting up the app has the screens and the defaults, and Troubleshooting what each message means.
| Field | On the wire |
|---|---|
| Server, Port | The app opens a TCP connection to Server on Port, directly or through the proxy, and starts TLS; inside TLS it names the Virtual Hub and logs in. Server is a DNS name, such as vpn.example.com, or an IP address. An empty Port is 443. |
| Hostname | Optional. The name the app sends in the TLS handshake (SNI) and checks the server's certificate against, while the connection still goes to Server. Use it when Server is an IP address and the certificate names the server. |
| TLS Server Verification | On, the default: before it connects, the app checks the server's certificate. It must chain to a root the phone trusts and be valid for Hostname, or for Server when Hostname is empty. When it is not, the app shows DANGEROUS! with each certificate of the chain: Continue connects this once without the check, Save and Continue turns verification off in the profile and connects, Cancel does not connect. Off skips the check. |
| Virtual Hub | The hub the app names inside TLS when it logs in. Empty means DEFAULT. |
| Connections | How many TCP connections carry one session: 1 to 32, default 1. After the first, the app opens one more per second until it has them all. With the server's VoIP / QoS function on, a session uses at least two. |
| Enable UDP Acceleration | Off by default. On: once the TLS connection is up, the app and the server also exchange the VPN's packets over UDP, when the server accepts it. It is not used through a proxy; there the session stays on TCP. |
| Enable NAT Traversal (NAT-T), NAT-T Hint | Off by default. On: when the server cannot be reached over TCP, the app reaches it over UDP through the NAT-T servers of SoftEther Corporation, which receive the connection's details. Off: the app never contacts those servers. NAT-T Hint, shown when NAT-T is on, is optional: the server's private IP address when several VPN servers share one public address. With a hint the app connects over NAT-T only. |
| Method, Username, Password / Certificate | Standard Password, the default: SoftEther's own password login, which sends only a proof of the password, never the password itself. RADIUS / NT Domain: the password goes to the server inside TLS, and the server checks it with its RADIUS server (or a Windows domain, on SoftEther for Windows; we tested RADIUS). Certificate: the app logs in with the client certificate imported from a .p12 or .pfx file, which it keeps in the iPhone's Keychain or, on Android, encrypted with a key in the Android Keystore. Anonymous: the user's name, no password. Username is always needed, Password for the first two methods. Method Certificate without a certificate the app can read stops before connecting: Certificate authentication requires a client certificate in the profile. on iPhone, The client certificate could not be read. Re-import it in the profile. on Android. |
| Proxy None or Manual: Address, Port, Type, Username, Password | The proxy carries only the connection to the server; the traffic inside the VPN does not use it. None, the default, connects directly. Manual uses the proxy at Address and Port as an HTTP CONNECT proxy (Type HTTP) or a SOCKS5 proxy (Type SOCKS5); Username and Password are optional and go to the proxy. A proxy that refuses them ends with Proxy authentication failed.; one that does not take the connection, with Cannot connect to the proxy server. |
| Proxy Auto: PAC URL, Username, Password | The app loads the PAC file at PAC URL, over http or https, and runs its FindProxyForURL for the server: PROXY is used as HTTP CONNECT, SOCKS and SOCKS5 as SOCKS5, and DIRECT connects directly. When an entry cannot be reached, the app tries the next one. The username and password go to the proxy the script picks. A PAC URL that does not answer with a file ends with Unable to download PAC configuration. |
| Auto Reconnect, Retry Times | Auto Reconnect, on by default, connects again 2 seconds after a connection that was up is lost, and keeps trying while the server is away. Retry Times limits the failed attempts in a row; empty means no limit. When they run out, the VPN ends with Could not reconnect after N attempts. (…). A login the server refused is never retried. With Auto Reconnect off, a lost connection ends the VPN with Connection lost (auto reconnect is off). |
| Switch to Wi-Fi When Available | On by default: when Wi-Fi appears while the VPN is up, the app moves the connection to it. Not part of our tests. |
| On Sleep | Stay, the default, keeps the connection while the device sleeps. Pause closes it and connects again on wake. Off closes it; on wake the app connects again only with Auto Reconnect on, otherwise the VPN ends with The connection was closed while the device slept. |
| Log Level | Normal: the milestones, such as connecting, the session, the network settings and errors. Expert adds the states the connection goes through and the virtual adapter's DHCP and ARP lines. Debug adds the SoftEther core's own lines, such as each TCP connection it opens. No level writes TLS session secrets. When the app gives up on a connection, a line starting with SoftEther: closing with reason: names the reason. |
| TLS Fragmentation, First Chunk, Following Chunks | Splits the outgoing bytes of the TLS handshake into small TCP writes; the TLS data itself is unchanged. Auto sends the first 43 bytes on their own, so that the server name lands in a later write, then 256 bytes per write (128 on cellular) a few milliseconds apart. Manual takes First Chunk and Following Chunks, 32 and 256 bytes by default. Our server saw the iPhone's ClientHello, 324 bytes in one piece with TLS Fragmentation off, arrive as 43 + 256 + 25 bytes with Auto, and as 20 + 100 + 100 + 100 + 4 bytes with First Chunk 20 and Following Chunks 100. |
Settings the app always uses
- Both apps connect with the same SoftEther client core.
- The session is a virtual Ethernet cable into the hub. The app asks the hub for an address with DHCP, shows Connected once it has one, and sends all of the phone's IPv4 traffic through the tunnel.
- It gives the connection to the server 30 seconds to come up; then it ends with Connection timed out. The server did not respond.
- The Android app routes IPv4 only and writes a line to the log when the hub offers IPv6; the iPhone app takes an IPv6 address the hub announces. Our hubs' SecureNAT hands out IPv4 only, so IPv6 inside the tunnel was not part of our tests.