Difference between revisions of "HowTo:Integrate UBIK in an SSO Environment"

Revision as of 13:37, 13 February 2023

Single Sign On (SSO) allows an end-user to interact with multiple services without logging in more than once.

This page shows how to integrate UBIK^® into such an SSO environment.

Instructions
Studio
Client

Instructions

The customer's Identity Provider must know UBIK^® as a Service Provider. In case of SAML, we need to provide an SSO mediator server in order to relay SAML responses for the client; this is our ACS (Assertion Consumer Service). In case of OIDC, the client app interacts with the OIDC provider directly.

There are two major use-cases for SSO:

Authentication: Establishing or re-using an SSO session (logging in)
Authorization: Interaction with external systems (interfacing)

In order to configure UBIK^® for SSO integration, we need to address both.

Authentication

In the UBIK^® client profile, adjust the SSO relevant settings (enabling SSO and specifying the Identity Provider Endpoint URL for an IdP-initiated flow).
On the server side, make sure that an SSO Processor is configured able to process the responses from the Identity Provider.

Authorization

When a UBIK^® object is synchronized between client and server, the UBIK^® customizing can interact with external systems. There, we might require authorization, and we need to make sure the client provides a respective token. In order to do so, we have to identify the specific authorization use-cases:

For which types of objects (meta classes) do I need to interact with external systems, requiring SSO authorization?
For which synchronization operations (e.g., update, commit, create, etc.) do I need authorization?
Which SSO client configurations (identity provider base URL, scopes, etc.) are used in this case?

For each resulting combination we have to create an External Auth Config object and give it to the client in the infrastructure list.

Further, we have to make sure the authorization tokens can be transported to the server. Therefore, add the External Entity Classification to all meta classes of objects that need external authorization.

Studio

Add External Auth Config objects to the client's infrastructure
Add the External Entity Classification to all affected meta classes

Client

OIDC

Set up an identity provider if necessary
Assemble a client configuration JSON string, .e.g.:

{'AuthorityURL' : 'https://xamarinoidc-app.azurewebsites.net',
'ClientID' : 'gnabbermobileclient',
'ClientSecret' : null,
'RedirectURL' : 'oidcxamarin101:/authenticated',
'Scope' : 'openid profile',
'IsPivotEnabled' : 'false'}

Integrate client configuration in profile:

SAML

Set up an identity provider if necessary
Set up an SSO mediator backend server to relay SSO responses to the client

To set up an Authentication Mediator Server first go to http://release.augmensys.com/ and download the provided Zip File. After you downloaded the Zip create a new IIS applicatio (https://docs.microsoft.com/en-us/iis/configuration/system.applicationhost/sites/site/application/). Open the just created app in your file explorer, unpack the downloaded ZIP file and copy all files of that ZIP into the app-folder. If IIS prohibites you to copy files you need to first stop the server. After successfully copying the Files you need to Restart/Start the IIS server again. Now you have set up the Authentication-Backend and it is ready to use.

Assemble a client configuration JSON string, .e.g.:

{"AuthUser": "user", "AuthUserPw": "test", "BackendURL": "https://ubik.test.com/UBIK/DEV/AUTH_SERVICE/", "IdpURL": "https://idp.com/idpssoinit?metaAlias=ubik;spEntityID=ubik", "IdpLogoutURL": "", "IsPivotEnabled": false, "Env_Broadcast" : null, "Env_Data": null}

Integrate client configuration in profile:

@@ Line 8: / Line 8: @@
 <!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED -->
-The customer's Identity Provider must know {{UBIK}} as a Service Provider. We need to provide an SSO mediator server in order to relay SSO responses for the client; this is our ACS (Assertion Consumer Service).
+The customer's Identity Provider must know {{UBIK}} as a Service Provider.
+In case of SAML, we need to provide an SSO mediator server in order to relay SAML responses for the client; this is our ACS (Assertion Consumer Service). In case of OIDC, the client app interacts with the OIDC provider directly.
 There are two major use-cases for SSO: