How to configure OpenID Connect for Authentication
- Overview
- Integrating with specific Identity Providers
Overview
By default, a vFunction Server allows users to authenticate with a built-in OAuth username and password workflow. But, the vFunction Server’s authentication workflow can be modified to use third-party OpenID Direct Connect configurations.
Note that this authentication change does not authorize users to be able to access the applications on the vFunction Server. Before switching the authentication method, it is advisable to add the desired users to the vFunction server so these users are authorized. To add users to the vFunction Server:
- Create a CSV with the following formatting
| app1 | charlott@mycompany.com | Charlotte | user | Password1! |
| * | admin@mycompany.com | Admin | admin | Password1! |
| app1,app2 | nikhil@mycompany.com | Nikhil | user | Password1! |
- Log into YOUR_VFUNCTION_SERVER/organization/team
- Select Import Users from the left-hand sidebar
- Click the blue Choose CSV File button
- Select the CSV that you created
- Open the file to import the users
Take the following steps to change the authentication workflow from this built-in OAuth username and password to integrate with an OpenID Connect identity provider:
- SSH to the vFunction Server
- Open the server-installation.yaml:
vi /etc/sysconfig/vfunction/installation/server-installation.yaml
- Uncomment and modify the server.authentication keys using the samples in the sections below as a guide
- Save and close the file.
- Run the install.sh script if configuring a new vFunction Server or the upgrade.sh script if modifying an existing vFunction Server:
### Installation Workflow
bash /opt/vfunction/server-installation/install.sh
### Upgrade Workflow
bash /opt/vfunction/server-installation/upgrade.sh
Note: Some values for the identity provider, such as the JWKS_URL, can be retrieved from the identity provider’s OpenID Connect Metadata Configuration Endpoint at https://<base_url>/.well-known/openid-configuration.
Azure Active Directory OIDC
Create a vFunction Application in Azure’s Portal
Take the following steps to configure a vFunction Application in Azure’s Portal:
- Login into the Azure Portal
- From the Menu Bar, select Add > App Registration
- In the text box, select a name for the Azure OIDC Application, such as, “vfunction”
- Under Supported Account Types, select who can use the new Azure OIDC Application, e.g. “Accounts in this organizational directory only”
- Under the Redirect URI (optional) header, select Single-page Application (SPA) in the Select a platform dropdown
- Type https:// $YOUR_VF_SERVER_ADDRESS/oauth/redirect in the text box next to Single-page application (SPA)
- Click the blue Register button
- In the left-hand sidebar, select API permissions under Manage
- Select the three-horizontal-dot submenu button next to user.read and select Remove permission
- Select Add a permission in the center pane
- Select Microsoft Graph from the right-hand dialog box under the Microsoft APIs header
- Select Delegated permissions
- Check the boxes next to email, openid, and profile
- Click the blue Add permissions button at the bottom of the dialog box
- Click the checkbox icon on the Configured Permissions Menu Bar to Add admin consent for $organizationName
- Click Yes in the confirmation dialog box
- In the left-hand sidebar, select Authentication under Manage
- Under Front-channel logout URL, input your vFunction Server’s address followed by /signout, e.g https:// $VF_SERVER_ADDRESS/signout
- Click the blue Save button
- Select Overview from the left-hand sidebar to gather the Tenant ID and Client ID
Configure the vFunction Server to use Azure OpenID
Replace the values “tenantID” and “clientId” below with the organization’s unique values.
Please note that, in most circumstances, Azure will not function properly if the clientSecret is added to an external connection like vFunction. Please start without a value in this field and, if required, add the clientSecret on the second attempt if the first attempt generates an error indicating that the clientSecret is missing.
server:
authentication:
authority: 'https://login.microsoftonline.com/tenantId/v2.0'
client_id: 'clientId'
client_secret: '' #Leave this field empty
jwks_url: 'https://login.microsoftonline.com/tenantId/discovery/v2.0/keys'
issuer: 'https://login.microsoftonline.com/tenantId/v2.0'
Google OpenID Connect (OIDC)
Note that the values below are an example. The values below are provided by Google.
The client_id and client_secret will be unique to each environment.
server:
authentication:
authority: 'https://accounts.google.com'
client_id: 'clientID-xyz'
client_secret: 'clientSecret-xyz'
jwks_url: 'https://www.googleapis.com/oauth2/v3/certs'
issuer: 'https://accounts.google.com'
KeyCloak OpenID Connect (OIDC)
Create a vFunction Application in Keycloak Admin Console
- Log into the Keycloak Admin Console
- In the General Settings, select Clients from the left-hand sidebar
- Select Create client blue button on the menu bar
- Select OpenID Connect in the Client Type dropdown
- Type a Client ID such as qa-vfunction
- Type a Name for the vFunction Client
- Click the Next blue button in the bottom center
- In the Capability Config, ensure Client authentication is toggled to Off
- Check Standard Flow checkbox in the Authentication Flow section
- Select S256 in the PKCE Method dropdown
- Click the Next blue button in the bottom center
- In the Login Settings, type the VF Server Address in the Root URL text box, e.g. https://vfunction.myorg.com
- Type the VF Server Address in the Home URL text box, e.g. https://vfunction.myorg.com
- Type $VF_SERVER_ADDRESS/oauth/redirect in the Valid redirect URIs text box
- Type $VF_SERVER_ADDRESS/signout in the Valid post logout redirect URIs text box
- Click the Save blue button in the bottom center
- Select Client scopes from the left-hand sidebar
- Confirm basic, email, and profile are set to Default in the Assigned type column
- Select Users from the left-hand sidebar
- Select a test user from the table
- Confirm the test user has a value in the Email field that matches the user authorized to the vFunction Server
- Add the Keycloak vFunction Client to the vFunction Server’s server-installation.yaml following the steps below
Add the Keycloak Client Details to the vFunction Server-installation.yaml
Note that the values below are an example. The values below are provided by KeyCloak.
The client_id and client_secret will be unique to each environment.
server:
authentication:
authority: 'https://{keycloak_base_url}/realms/{realm}'
client_id: 'clientID-xyz'
client_secret: '' # Do not add Client Secret
jwks_url: 'https://{keycloak_base_url}/realms/{realm}/protocol/openid-connect/certs'
issuer: 'https://{keycloak_base_url}/realms/{realm}'
Okta OpenID Connect
Create the vFunction App in the Okta Admin Console
In the steps below, replace the values, “yourOktaDomain” and “yourVFunctionServerAddress” with your organization’s values.
- In a browser, open https://${yourOktaDomain}/admin/apps/active
- Click the blue Create App Integration button at the top of the center pane
- Select the OIDC - OpenID Connect radio button for Sign-in method
- Select the Single-Page Application radio button for Application type
- Type vFunction in the text box for App integration name
- Check the boxes for both Authorization Code and Refresh Token for Grant type
- Type ${yourVFunctionServerAddress}/oauth/redirect for Sign-in redirect URIs
- Type ${yourVFunctionServerAddress} for Sign-out redirect URIs
- Set access as desired, e.g. Everyone in the organization
- Save the App
- Copy the Client ID to be able to use it in the vFunction server-installation.yaml
Create the vFunction App in the Okta Admin Console
The Okta examples below are taken from Okta’s documentation. Replace the values “yourOktaDomain”, “clientId” with your organization’s values.
server:
authentication:
authority: 'https://yourOktaDomain'
client_id: 'clientId'
### Do not add the Client Secret. This field can be left blank
client_secret: ''
jwks_url: 'https://yourOktaDomain/oauth2/v1/keys'
issuer: 'https://yourOktaDomain'
PingFederate OpenID Connect (OIDC)
Note that the values below are an example. The values below are provided by PingIdentity
The client_id and client_secret will be unique to each environment.
server:
authentication:
authority: 'https://<base_url>'
client_id: 'clientID-xyz'
client_secret: 'clientSecret-xyz'
jwks_url: 'https://<base_url>/pf/JWKS'
issuer: 'https://<base_url>'
Debugging
Take the following steps to debug an issue with OpenID Direct Connect:
- Create the vFunction App in the OIDC Provider
- Add the OIDC Provider’s Configuration Settings to the vFunction Server-Installation.yaml
- Run the vFunction Server’s upgrade.sh script
- Open a browser with the F12 Network Console open
- Visit your vFunction Server
- The vFunction Server visits the site ISSUER/.well-known/openid-configuration to gather the URL for the authorization_endpoint. If you are never redirected to the login page of your OIDC provider, it’s most likely because the Issuer field is incorrect in the server-installation.yaml
- After logging in to your Identity Provider, you should be redirected back to the vFunction Server. If you are caught in a loop at this stage being bounced back and forth between the vFunction Server and your Identity Provider, it is probably due to a setting in the Identity Provider’s vFunction App. If you are redirected back to the vFunction Server and an error is generated on the vFunction Server, find the /token API call
- Copy the Encoded Token from the F12 Network Console
- Paste the Encoded Token into https://www.jwt.io to see the Decoded Headers. Look for unexpected values in the JSON to further debug