Global Settings

Prev Next

Use Global Settings (Settings > Global Settings) to configure system-wide settings for the entire Collective.

The following sections describe each field on the Global Settings page.


Collective Details

  • Collective Name. Enter a meaningful name for the Collective.


Expiration Settings

  • SPA Token Expiration (seconds). Sets the lifetime of the Single Packet Authorization (SPA) packets used throughout the Collective. To prevent replay attacks, the system maintains a cache of accepted SPA packets for this duration. The system may dynamically reduce the time and cache size to conserve memory when memory runs low. The default on new systems is 3600 seconds.

  • Claims Token Expiration (minutes). Sets the lifetime of a user's claims token. The client attempts to renew the token during the five-minute window before it expires. Renewal behavior depends on your identity provider (IdP) and client configuration:

    • LDAP/RADIUS: The client caches user credentials in memory, so token renewal is transparent to the user.

    • SAML with auto sign-in enabled: The browser opens during renewal. The user experience depends on the operating system, browser, and SAML provider.

    • SAML with auto sign-in disabled: The client prompts the user to reauthenticate.

    • SAML with ForceAuthn enabled in the IdP: The user must complete SAML reauthentication.

    • MFA at Sign-in set to Always: The user must complete MFA in all situations.

If renewal does not complete within the five-minute window, Gateways block the user's traffic. The default is 1440 minutes (24 hours).

  • Entitlement Token Expiration (minutes). Sets the lifetime of a user's entitlement token. If you need to apply changes to a user's entitlements immediately, you can revoke entitlement tokens manually. Use Registered Devices (Usage > Registered Devices) to renew tokens. The default is 1440 minutes (24 hours). The maximum is 10080 minutes (7 days).

  • Administration Token Expiration (minutes). Sets the lifetime of an admin's token. The default is 1440 minutes (24 hours).

  • VPN Certificate Expiration (minutes). Sets the lifetime of a user's VPN certificate (or client certificate). The default is 525600 minutes (365 days).

  • Registered Device Expiration (days). Sets the number of days after which the system automatically purges registered devices that have not been seen. The default is 90 days.


Admin UI Settings

  • Inactivity Timeout. When enabled, the system automatically signs out users after the configured number of minutes without activity. The default is 60 minutes.

  • Administration Banner Message. This message appears on the sign-in form of the admin UI. Use this field to display warnings about improper use or monitoring.

  • Message Of The Day. This message appears to users after they sign in through the admin UI or client. To display a message to SSH users, configure this setting from the command line using SSH.

    The following HTML tags are supported: 'a', 'b', 'i', 'strike', 's', 'strong', 'small', 'del', 'sub', 'sup', 'br', 'code', 'ol', 'ul', 'li', 'dl', 'dt', 'dd'


General Appliance Settings

  • Global Client Profile DNS name. The DNS name used when creating client profiles. This name is typically shared across all Controllers and is generated when you create your first Controller.

  • SPA Use. SPA protects access to the system TLS connection on port 443. The appliance must receive a valid SPA packet before it establishes a connection. New systems have TCP SPA enabled by default. For best practice guidance, see System security - best practices, which recommends UDP-TCP SPA.

    The following SPA modes are available:

    • Check TCP SPA key before allowing connections. TCP port 443 remains open. Only connection attempts that include the special TLS ClientHello packet can establish a TLS connection. The TLS ClientHello packet uses a specially crafted custom extension. Verify that application-aware firewalls do not filter or remove this extension.

    • Check UDP (and TCP) SPA key before allowing connections. TCP port 443 is closed and opens for the connecting IP address only after the appliance receives a specially crafted UDP packet. The client then sends the TLS ClientHello packet to establish a TLS connection. DTLS tunnels use UDP 443 only.

The system sends the crafted UDP packet two ways: as a SPA-DTLS packet on port 443 and as a SPA-DNS packet on port 53. Only one packet needs to reach the appliance. On receipt, the appliance updates its firewall to allow UDP (for DTLS) or TCP (for TLS) access on port 443 from the client's IP address. Verify that your firewalls allow UDP traffic on ports 443 and 53.

  • Backup API. When enabled, allows an API to take appliance backups.

    • Backup Passphrase. Sets the passphrase used to encrypt backup files created through the Controller API. Backup files are always encrypted.

NOTE

Clearing this checkbox deletes existing passphrase.

  • Appliance Key Encryption. Select Enable encryption to use TPM2 for encryption of private keys. Keys on the appliance switch-partition remain unencrypted but are invalidated through the certificate renewal process.

NOTE

If you enable Appliance Key Encryption, you can only restore appliance backups on the same machine, because the TPM2 module used to encrypt the appliance key is tied to that specific machine. Only appliances with a TPM2 module are encrypted. The system raises appliance warnings for appliances without a TPM2 module.

  • Geolocation Updates. Configures the source of your geoIP database. The default is Disabled. Select Disabled, Default, or configure a Maxmind or IPinfo account. You can also enter a custom URL. For more information, see Geolocation database.

    • Maxmind account. Enter your account ID and license key.

    • IPinfo account. Select your database and enter your token.

    • Custom URL. Enter the URL.

NOTE

The geoIP database can be several gigabytes in size. To verify a new database before replacing the existing one, both must be on disk at the same time. Verify that Gateway and Controller appliances have enough free disk space for the database you plan to use.

  • Audit Log Persistence Mode. Log persistence affects system performance. Select the mode that best meets your needs. For more information, see Audit logs.