Configuring OpenVPN Cloud user authentication to use SAML
The administrator can configure OpenVPN Cloud to authenticate access to User Portal, download of VPN profile, and VPN connections using a SAML 2.0 compliant Identity Provider.
The administrator needs to follow the steps below. The steps below use OneLogin as the Identity Provider. Basic configuration guides for some of the other popular Identity as a Service (IDaaS) providers are provided separately.
- Login to OpenVPN Cloud Administration portal and do the following:
- Navigate to Settings section and click on the User Authentication tab.
- Click on the Edit button positioned on the top right
- Click on the Configure button under the SAML option
- The SAML Configuration webpage opens in a new browser window/tab and show the information needed to configure OpenVPN Cloud as a Service Provider in your Identity Provider.
- Login to the administration console of the Identity Provider to configure OpenVPN Cloud as a SAML Service Provider. The steps for OneLogin are below:
- Navigate to Applications tab and click on the Add App button
- Enter SAML Test Connector (Advanced) in the search bar to find the application and click on it
- Provide a Display Name and click on the Save buttonto add the application and start configuring it
- Navigate to Configuration
- Enter the Issuer Name displayed in the SAML Configuration webpageof OpenVPN Cloud into Audience (Entity ID) input field of OneLogin
- Enter the SSO URL displayed in the SAML Configuration webpage of OpenVPN Cloud into both the ACS (Consumer) URL Validator and ACS (Consumer) URL input fields of OneLogin
- Select Assertion as the drop-down list value for the SAML signature element field and click on the Save button
- OneLogin will only provide the NameID value to the Service Provider by default which OpenVPN Cloud will map to the username of the User. If you want OpenVPN Cloud to have more information about the user and to use the value of a specific user attribute to map the user into an OpenVPN Cloud User Group, you need to configure additional parameters to be sent by navigating to the Parameters tab and clicking on the Add (+ icon)
- Click on the Include in SAML assertion checkbox, provide a Field Name, and click on the Save button
- Choose and select a Value which is one of the attributes of the user. You can search for the attribute too.
- Click on the Include in SAML assertion checkboxand click on the Save button
- Repeat the above process for adding more parameters that will correspond to the username, email, first name, last name, and user group of OpenVPN Cloud User. Once done, navigate to the SSO tab
- Click on the copy/paste icon next to the Issuer URL in order to copy the value in the field. This will be used later in the OpenVPN Cloud configuration.
- Now that OpenVPN Cloud has been setup as an application, you need to provide applicable users access to OpenVPN Cloud application. One of the ways to do this is to:
- Select the user and click on the Applications tab
- Click on the Add (+ icon) to add an Application for the user
- Select the newly configured OpenVPN Cloud application and click on the Continue button
- Go back to the browser tab/window displaying the OpenVPN Cloud and take the following actions:
- Click on the Next button
- Provide an IdP Name and paste the Issuer URL value copied earlier in step ‘2.m’ into the IdP Metadata URL
- If earlier in step ‘2.h’ you had setup additional parameters to map into OpenVPN Cloud User information, do the following or else click on the Next button:
- Expand the Advanced settings section
- In the Attribute Mapping section provide the Identity Provider parameter names corresponding to the OpenVPN Cloud User information fields that you want to be populated with information from the Identity Provider’s parameters (SAML attributes) and click on the Next button when done
- Click on the Finish button after reviewing the SAML configuration
- Now that the SAML configuration is done, we need to enable SAML as the user authentication method by clicking on the Edit button in the User Authentication tab
- Select the SAML option
- If earlier in step ‘2.h’ you had setup an additional parameter with the intention to map the value of that parameter to OpenVPN Cloud User Group, do the following or else click on the Update Settings button:
- Click on the Add Rule button
- Enter in SAML IdP User Group(s) field one or more of the values that will present in the IDP provided parameter that you had mapped to the Group attribute in step ‘3.c.ii’and select the corresponding you want those values to map into. For example, the IdP user’s department value of ‘DEV’ could map to OpenVPN Cloud User Group ‘Dev’ which has been configured to provide access to resources for developers. Repeat the step to add more rules as desired and click on the Update Settings button when done
- Click the Confirm button on the confirmation dialog
- SAML is now enabled
Login to User Portal
Now that SAML is enabled for the VPN when a User wants to sign in to the User Portal to download Connect Client or manage devices etc., the user will sign in using SSO credentials. When the user visits the User Portal (for example, at https://test8.openvpn.cloud), the user will see the Identity Provider’s login screen
On successful first authentication, the Administrator will see the user details show up in the administration portal.
In the screenshot above, you can see that the user1 has been added after SAML authentication because the Auth Source is shown as SAML.
Authentication during profile download
Now that SAML is enabled for the VPN when a User wants to add the VPN profile using Connect Client, the user will sign in using SSO credentials.
Authentication during VPN connection
Now that SAML is enabled for the VPN when a User belonging to a User Group whose Authentication Type parameter is set as Password and Profile wants to connect to the VPN using Connect Client, the user will sign in using SSO credentials.