M ACL.md => ACL.md +0 -15
@@ 32,21 32,6 @@ The configuration is done in two locations:
- `/etc/vpn-server-api/config.php`: configure which profiles are
restricted by access control.
-## Cache
-
-The permission cache is configured in `/etc/vpn-user-portal/config.php`
-using the `sessionExpiry` option. The default is 90 days, `P90D`. The following
-is a list of common values you can use:
-
-- `PT8H` (8 hours)
-- `PT12H` (12 hours)
-- `P1D` (1 day)
-- `P7D` (7 days)
-- `P1Y` (1 year)
-
-If you modify this value, it will only take effect the next time the user is
-forced to authenticate/authorize.
-
## SAML
We assume [SAML](SAML.md) is already configured and working.
A SESSION_EXPIRY.md => SESSION_EXPIRY.md +55 -0
@@ 0,0 1,55 @@
+# Session Expiry
+
+The VPN server has the concept of "Session Expiry". This configures the
+interval with which users have to again perform application authorization,
+when using the eduVPN/Let's Connect! apps, or have to go back to the portal to
+download a new configuration file.
+
+This will mean that the users have to authenticate as well as part of this
+authorization, and possibly provide their 2FA credentials/token as well.
+
+The default on installation of the server is 90 days.
+
+# What to Choose?
+
+The default of 90 days, but you may want to deviate from this. Either by
+setting it to a (much) shorter interval, for example if you want your users to
+authenticate every day, or possibly much longer.
+
+Generally it is not recommended to lower this value too much if you have VPN
+users that can't use the eduVPN / Let's Connect! applications. This can lead
+to frustration by the users and possibly lead to creative solutions by them to
+work around the VPN and thus decreasing security.
+
+On the other hand, setting this _too_ high, requires discipline to disable the
+users that are no longer eligible to use the VPN from the portal.
+
+It is a bit of a judgment call. We know of organizations that set it to 12
+hours, and also organizations that set it to 3 years.
+
+## Changing Session Expiry
+
+You can change the session expiry by modifying
+`/etc/vpn-user-portal/config.php` and set `sessionExpiry` to the value you
+wish. Some examples:
+
+- `P3Y` (1 year)
+- `P1Y` (1 year)
+- `P90D` (90 days)
+- `P1M` (1 month)
+- `P7D` (7 days)
+- `P1D` (1 day)
+- `P12H` (12 hours)
+
+**NOTE**: if you modify this value, it will only take effect the next time the
+user is forced to authenticate/authorize.
+
+It is *highly* recommended to choose your `sessionExpiry` and then "reset" the
+server in order to make sure that all VPN users/clients will use the same
+session expiry from then on. **NOTE**: this will delete all _data_, but not the
+configuration. It will force everyone to reauthorize the VPN apps and/or
+download a new configuration through the portal.
+
+```
+$ sudo vpn-maint-reset-system
+```