Abiquo OpenID Connect integration

Introduction

This page describes the Abiquo integration with OpenID Connect available in Abiquo.
This integration allows Abiquo to leverage single sign on authentication and federated authorization features.
The integration targets the core spec, but also implements some optional features such as the RP-Initiated-Logout from the optional Session Management spec.
Discovery, dynamic registration, and other optional features are out of the scope of this integration.

Changes to the OpenID integration

Abiquo 5.1.2 - Added to abiquo.properties: abiquo.login.samesite

Abiquo 4.6.0 - Added to abiquo.properties: abiquo.openid.cookie.maxage and abiquo.openid.cookie.refreshtoken.include

Abiquo 3.10.7 and 4.0.4 - To retrieve the user's phone number from the OpenID system, add phone to the value list of the abiquo.openid.client.scopes property.

Basic workflow

In the OpenID basic workflow, the user interacts with Abiquo (the Application), which is also a client of the OpenID Connect server (the Identity Server)

The following diagram shows the basic authentication and authorization workflow when using the OpenID Connect integration.

Users will access the Abiquo portal, and will be redirected to the OpenID Connect server
Users will enter their credentials to log in to the OpenID Connect server (note that the credentials are never exposed to Abiquo).
It will display the consent screen that describes the permissions that Abiquo is requesting and the information it needs to access.
Upon successful authentication and consent grant, the OpenID Connect server issues the following tokens and redirects the user back to the application:
1. ID token - A JWT token containing the information about the user.
2. Access token - An OAuth2 token that provides access to the application resources on behalf of the user.
3. Refresh token - An optional token that can be used to refresh the access token when it expires.
Abiquo will use the access token to request information about the logged user (permissions, etc) and will create the corresponding user in the Abiquo database.
Users will use the access token to access the Abiquo platform, including the Abiquo API

At any time, users with the refresh_token will be able to perform a call to the Abiquo API to refresh the access token.
If the global logout is configured, when users log out from the Abiquo platform they will be signed out from the OpenID Connect server.

ACR validation

In an OpenID Connect Integration, the authorization request could contain a list of authentication modes that the server should show to the user.
This is a list of acr-values and it's a configuration of the OpenID Connect Server.

So Abiquo could request that using the acr-values system property.

Also, the response tokens could contain the acr-values used by the user to authenticate.
Abiquo can validate that these acr-values are the requested ones if the acr-validation system property enables this and fail the authentication process if they aren't.

OpenID Connect authentication mode

When Abiquo is in normal authentication mode, Abiquo authenticates and obtains user authorization from the Abiquo database.
In contrast, when the platform is in OpenID Connect mode, Abiquo authenticates and obtains user authorization from the OpenID Connect server.
In OpenID mode, Abiquo behaves as follows:

Abiquo creates an Abiquo OpenID user automatically when the following conditions are met
- The user successfully authenticates through the OpenID Connect server; AND
- Abiquo finds an Abiquo tenant and user role that matches the one specified through the OpenID user data
Every time the user logs in, Abiquo synchronizes user data with the OpenID Connect server, which may overwrite any changes you make to the Abiquo user account
- A user that has switched enterprises will be returned to their assigned enterprise when they log in
Abiquo disables login for users with non-OpenID accounts
- This includes the main cloud admin user
Abiquo disables features associated with normal authentication, e.g. Abiquo two-factor authentication, Abiquo password reset
- The OpenID Connect server should provide this type of feature when authenticating users

OpenID Connect configuration steps

This is an overview of the steps to configure the OpenID Connect Integration

Configure the cloud admin user with Abiquo in normal auth mode
Map OpenID users to Abiquo enterprises and roles with Abiquo in normal auth mode
Register Abiquo as a client application on the OpenID Connect server and obtain OpenID client credentials
Configure the OpenID Connect server in abiquo.properties
Register the Abiquo Outbound API as an OAuth application and configure abiquo.properties
Configure the OpenID Connect logout
Configure Abiquo UI properties
Start the Abiquo Server
Configure API and Outbound API clients to work with an access token

Configure the cloud admin user

Configure the cloud admin user with Abiquo in normal authentication mode.
Remember that Abiquo will disable this user when you enable OpenID Connect authentication mode.

Map OpenID Connect users to Abiquo enterprises and roles

In OpenID Connect authentication mode, when a user successfully authenticates through the OpenID Connect server, Abiquo will receive OpenID user data.
Abiquo will try to match the user data to the following in Abiquo:

A user role (e.g. cloud admin, tenant admin, cloud user)
An enterprise (cloud tenant) that the user will belong to

To enable Abiquo to match the user, you must work in Abiquo to map the Abiquo enterprise and role to the OpenID user data.
Work in normal authentication mode as the cloud admin user. If Abiquo cannot find the role and enterprise, it will not create the OpenID user.

How Abiquo determines which role to assign to an OpenID user

The OpenID Connect server will return user data, including a list of the external roles/permissions for the user, which is called a role claim.
Abiquo will identify the role claim in the OpenID user data using the name you configure with the abiquo.openid.role-claim property.
Abiquo will try to find an existing Abiquo role with the same LDAP attribute data as the role claim.

Map external roles to Abiquo roles

To map OpenID roles to an Abiquo role:

Create, clone or edit an Abiquo role
In the External Roles field, enter the same list of external roles/permissions as the OpenID user's role claim

Remember that a user's external roles must map to one local role in their enterprise and/or one global role.

How Abiquo determines which enterprise an OpenID user should belong to

The OpenID Connect server will return user data, including the tenant that a user should belong to, which is called an enterprise claim.
Abiquo can look up this enterprise in Abiquo by enterprise name or by enterprise property.
If Abiquo cannot find the enterprise, it will not allow the user to log in. If the user account does not exist, Abiquo will create it in the enterprise.
If the user account exists in another enterprise, Abiquo will move it to the one assigned by the OpenID Connect server.

Abiquo will obtain the enterprise claim defined by the abiquo.openid.enterprise-claim property.
Abiquo will try to match the enterprise claim to the enterprise name if the abiquo.openid.enterprise-property property IS NOT SET in abiquo properties.
Otherwise, it will try to match the value of the enterprise claim to the value of the enterprise property specified by the abiquo.openid.enterprise-property property.

Map external enterprises to Abiquo enterprises

Map external enterprises to Abiquo enterprises according to the lookup method you configured for your platform.

To map an OpenID enterprise to an Abiquo enterprise by enterprise name, just name the enterprise with the value in the enterprise claim.

To map an OpenID enterprise to an Abiquo enterprise by enterprise property:

Create or edit an Abiquo enterprise
Create an enterprise property with the key configured in the abiquo.openid.enterprise-property in abiquo.properties.
For example, for "abiquo.openid.enterprise-property = domain", create an enterprise property called domain.
Set the value of this property to the value of the enterprise claim for this tenant.

When the authorization server returns the enterprise claim, Abiquo will look for all enterprises with a "domain" property.
It will find the one with the value that matches the value returned by the OpenID Connect server.
In this example, when the OpenID Connect server returns the value "abiquo.com" in the enterprise claim, Abiquo will select this enterprise.

Register Abiquo as a client application in the OpenID Connect server

Register Abiquo as a client application in the OpenID system and obtain the client credentials: client name, client id and client secret.
You will need to configure these in abiquo.properties in the next step.

Configure Abiquo properties

To configure OpenID Connect in abiquo.properties:

Configure OpenID Connect server details (endpoints, claims, etc.)
Configure OpenID client credentials from the previous step of registering Abiquo as a client application
Activate OpenID in abiquo.properties, by setting abiquo.auth.module to openid

If your OpenID Connect provider implements the Discovery extension, you might be able to get the value of the different endpoints,
by going to the well-known configuration endpoint, as described in the provider configuration section.

The following sequence diagram shows how the different endpoints are used from a user and relying party perspective.
The diagram depicts the interactions between all parties involved in the OpenID Connect protocol.

Table of Abiquo OpenID Connect properties

To enable the OpenID Connect mode, configure the following properties in Abiquo:

Property	Description

Property	Description
OpenID Connect server configuration
abiquo.auth.module	The Abiquo authentication module. Must be: openid
abiquo.openid.cookie.maxage	After OpenID authentication flow, the API redirect adds a cookie with the access_token and the id_token. The expiry of the OpenID authentication cookie in seconds. A negative value means that the cookie is not stored persistently and will be deleted when the web browser exits. A zero value causes the cookie to be deleted Default: 30
abiquo.openid.cookie.refreshtoken.include	If true, the OpenID authentication cookie will also contain the refresh token. Default: false
abiquo.openid.target	The URL where the user will be redirected from the Identity Server upon successful authentication. Something like http://<abiquo ui host>/ui/#/dashboard
abiquo.openid.role-claim	The name of the claim returned by the authorization server that contains the names used to map the user permissions to an Abiquo role
abiquo.openid.enterprise-claim	The name of the claim returned by the authorization server that contains the names used to map the Abiquo enterprise where the user belongs
abiquo.openid.enterprise-property	(Optional) If present, Abiquo will try to find an enterprise that has a property with the name configured in this property. It will use its value to match the "enterprise claim" when resolving the user's enterprise. If absent, Abiquo will just look for an enterprise with the name returned in the "enterprise claim".
abiquo.openid.issuer	The OpenID Connect authorization issuer.
abiquo.openid.authorization.endpoint	The OpenID Connect authorization endpoint. This endpoint must be accessible from the user's browser
abiquo.openid.token.endpoint	The OpenID Connect token endpoint. This endpoint must be accessible from the Abiquo server.
abiquo.openid.userinfo.endpoint	The OpenID Connect user info endpoint. This endpoint must be accessible from the Abiquo server.
abiquo.openid.jwks.endpoint	The OpenID Connect JWKS endpoint. This endpoint must be accessible from the Abiquo server.
abiquo.openid.endsession.endpoint	(Optional) If configured, Abiquo will attempt to perform a global logout performing a request to this endpoint. This is part of the Session Management optional spec. This endpoint must be accessible from the user's browser.
OpenID Connect client configuration
abiquo.openid.client.name	The name of the client that has been registered in the OpenID Connect server for the Abiquo platform.
abiquo.openid.client.id	The ID of the client that has been registered in the OpenID Connect server for the Abiquo platform.
abiquo.openid.client.secret	The secret of the client that has been registered in the OpenID Connect server for the Abiquo platform.
abiquo.openid.client.scopes	Comma separated list of scopes to request during authentication. Must have, at least: openid,profile,email. Also supports: phone.
abiquo.openid.client.redirect-uris	Comma separated list of allowed redirect (callback) URIs used during the authentication flow. Must be: http://<api endpoint>/api/openid_connect_login
abiquo.openid.client.acr-values	Space separated values for the acr values to send to OpenID Connect Server when authenticating. They will be validated if 'acr-validation' property is true (default value).
abiquo.openid.client.acr-validation	Activates the acr values validation. Default value is true

Configure Abiquo outbound API module

Register the Outbound API as an OAuth application (for Outbound API user or admin user) and use the tool to obtain the OAuth access token.
Configure credentials in abiquo.properties and remove any old credentials properties

In OpenID Connect mode, the normal authentication (using HTTP Basic Authentication) is disabled, so you must configure the Outbound API credentials as OAuth tokens. To do this:

Create a new application for the "default api outbound user" as explained in the "Manage OAuth Applications" guide, and set all the privileges for that user; OR
Create the application in the administrator account, and select only the permissions for the "default api outbound user"
Get the OAuth access tokens. You can use an unsupported Abiquo tool to obtain the access tokens.
Please contact Abiquo Support to obtain the Abiquo tool.
In the abiquo.properties file of the Abiquo Server
1. Configure the following OAuth properties
  1. abiquo.m.consumerKey
  2. abiquo.m.consumerSecret
  3. abiquo.m.accessToken
  4. abiquo.m.accessTokenSecret
2. And remove the following properties
  1. abiquo.m.identity
  2. abiquo.m.credential

Configure OpenID Connect logout

If the OpenID Connect server implements the Session Management extension, you can configure the Abiquo platform to issue a logout to the OpenID Connect server when the user logs out from the platform.
This is optional because users might not want to be logged out from all services when logging out from Abiquo.

To enable the global logout, configure the abiquo.openid.endsession.endpoint property to point to the end session endpoint, as defined by the RP-Initiated Logout spec.

Configure OpenID Connect client UI properties

Configure the OpenID Connect client UI properties in the client-config-custom.json file.

Property	Description

Property	Description
client.openid.enabled	Deprecated in Abiquo 4.7.1
client.openid.skip.login.view	Deprecated in Abiquo 4.7.1 for UI 5. By default, when in OpenID mode, Abiquo shows an initial screen with a link to the Authentication portal. If this property is set to true, then Abiquo will not display the initial screen and will redirect users directly to the Authentication portal.
client.skip.login.view	By default, when in OpenID mode, Abiquo shows an initial screen with a link to the Authentication portal. If this property is set to true, then Abiquo will not display the initial screen and will redirect users directly to the Authentication portal.
client.auth.module	Abiquo login modules to use with options for Basic Auth (default), Open ID, and SAML. See client-config-default.json for examples

Configure API and outbound clients

In OpenID Connect mode, Abiquo disables Basic Authentication, so in order to authenticate with the API (or against the Outbound API endpoint), you can use an access token.

To obtain an access token:

Manually log in to the platform
When you are redirected back to the Abiquo console, you'll find the access token and refresh token in the URI.

Once you have the token, you can issue requests to the API by providing the following HTTP header:

Authorization: Bearer <the access token>

Optional SameSite cookie flag configuration

On the Abiquo Server, optionally set the abiquo.login.samesite property to control the value of the SameSite flag of the login cookie. See Abiquo Configuration Properties#samesite

Refreshing access tokens

Access tokens have an expiration, so at a certain point in time they will stop working.
When this happens, the user can use a refresh token if it was returned during authentication to request a new access token.
Refresh tokens also expire, but have a significantly higher expiration (default is one week).
Some OpenID Connect providers issue new refresh tokens every time an access token is refreshed, so the refresh mechanism can be used without limit.

To request a new access token using a refresh token, an HTTP request must be issued to the "openid_conect_refresh" Abiquo API endpoint, passing the refresh token as a query parameter:

curl -v "http://<abiquo api host>/api/openid_connect_refresh?refresh_token=<refresh token value>" -H "Accept: application/vnd.abiquo.oidctokens+json"

{
   "scope" : "openid profile email abiquo",
   "id_token" : "eyAidHlwIjogIkpXVCIsICJraWQiOiAiemhCb2ZiWncraSIsICJhbGciOiAiUlMyNTYiIH0.eyAiYXRfaGFzaCI6ICJoVmJBZ2t2NGRBalh5bFFQZGNYVFR3IiwgInN1YiI6ICJvcGVuaWQtYWRtaW4iLCAiYXVkaXRUcmFja2luZ0lkIjogIjcxN2I3YWY0LTNmMGQtNGU2NS1iZWJmLWE3MWIzODg4MWE1My05NTcwIiwgImlzcyI6ICJodHRwOi8vb3BlbmFtLmJjbi5hYmlxdW8uY29tOjgwL29wZW5hbS9vYXV0aDIvZGV2ZWxvcGVycyIsICJ0b2tlbk5hbWUiOiAiaWRfdG9rZW4iLCAiZ3JvdXBzIjogWyAiaWQ9YWRtaW5zLG91PWdyb3VwLG89ZGV2ZWxvcGVycyxvdT1zZXJ2aWNlcyxkYz1vcGVuYW0sZGM9Zm9yZ2Vyb2NrLGRjPW9yZyIgXSwgImdpdmVuX25hbWUiOiAiT3BlbklEIiwgImF1ZCI6ICJhYmlxdW8iLCAib3JnLmZvcmdlcm9jay5vcGVuaWRjb25uZWN0Lm9wcyI6ICJhNWExMDNlYS05MmQyLTQxZDgtOGJkYi0xMWNjZTJmMGZlYjMiLCAiYXpwIjogImFiaXF1byIsICJhdXRoX3RpbWUiOiAxNDczOTU5Njk2LCAiZG9tYWluIjogIkFiaXF1byIsICJuYW1lIjogIk9wZW5JRCBBZG1pbiIsICJyZWFsbSI6ICIvZGV2ZWxvcGVycyIsICJleHAiOiAxNDczOTYzMjk2LCAidG9rZW5UeXBlIjogIkpXVFRva2VuIiwgImlhdCI6IDE0NzM5NTk2OTYsICJmYW1pbHlfbmFtZSI6ICJBZG1pbiIsICJlbWFpbCI6ICJvcGVuaWQtYWRtaW5AYWJpcXVvLmNvbSIgfQ.JL3yUCtn4VnGewANcD2SbqX5RZfxKqNQG_p2vc5UldRIxdr4BNg3u-C219-XA8dfnrLvBL6CmrJoItIy7XDP7qX8DJO7a9pea8QCugXT9NdepdQh-SEPdQ3d-acm4M5_1bALIjvItDW7pWVnqppYUyjVzQY_oX385CccUuYaYh-9Glj-9VPdnr9pZXZFkb07K0ab2iQtfu7sshS6-iZ0mF6unF2pWvsJHfeUSYb1X9yRfehhRgTXltlVno7uNEfPopM6MbISr-Bhb7zxiJ-Zte_peaiZKjrU7QEQFDIj13M6YQ",
   "refresh_token" : "78ecb72e-fd0e-4825-ae0a-635159c461ff",
   "token_type" : "Bearer",
   "links" : [],
   "expires_in" : 3599,
   "access_token" : "a381c059-654f-4c03-852b-cf507c5372ec"
}

Note that the refresh token request does not require authentication.
This is because it is meant to be used when the access token is expired.
So the Abiquo API just passes the refresh token to the authorization server and lets it verify the validity of the token and the identity associated with it.

Troubleshooting

The OpenID login process may return an error message for example due to a delayed login or timeout.
To prevent this, for Internet Explorer cookies, in server.xml on Abiquo Tomcat, the <Host> section should contain an <Alias> section with the domain of the web server (where users access the UI).
And the default Java session timeout was changed to 30 minutes to ensure user delays during OpenID login will not result in further errors.