SAML2 Configuration with NetIQ

<< Click to Display Table of Contents >>

Navigation:  Low-code Process Automation > Studio Cloud - Authoring environment > Bizagi Studio > Security definition > Work Portal Security > Work Portal Authentication > SAML2 authentication > Examples >

SAML2 Configuration with NetIQ

Overview

Bizagi supports integration with Identity and Access Management systems (i.e, Identity Managers or Identity Providers) which are SAML 2.0 compliant, such as NetIQ Access Manager.

This section is a step-by-step guide to the configuration you need to do, both in NetIQ and in Bizagi, to have an integrated authentication in Bizagi against NetIQ Access Manager.

 

SAML_NetIQ_OV

 

SAML 2.0, requires that both your Identity Provider and your Bizagi project are set up to support HTTPS.

For introductory information about SAML 2.0, refer to Authentication via SAML.

 

note_pin

If you plan on using an authentication method different than Bizagi and you are performing a deployment to an environment with no users on it (normally this would only be the case for a project's first deployment), follow these steps so that you can correctly configure your users and authentication without getting locked out of the Work Portal:

1.Perform the deployment with the authentication method set to Bizagi. This lets you access the Work Portal as the Admon user without providing any credentials.

2.Once in the Work Portal you can manually enter your users, or alternatively you can rely on the method of your choice to synchronize your users' information into the WFUser table (SOAP, Excel file, LDAP Synchronization, or performing a Data Synchronization procedure).

3.After having your users registered in the Work Portal, use the Management Console to set the authentication method to your preferred one.

 

If you plan on using LDAP authentication with periodic users synchronization, you may ignore the previous steps since you will only need to wait until the next synchronization happens for your users to be able to log into the Work Portal.

 

1. Generate certificates to sign assertions (mandatory)

The following explains how to generate the security certificate from the Customer Portal:

 

note_pin

You will need to be in charge of managing your installed certificates (keep track of its expiration date and other relevant maintenance aspects such as changes in your Identity Provider's endpoints).

 

Create Authentication Certificates

You can generate security certificates for the Authentication Protocols within the Customer Portal. This feature allows you to create and configure a new certificate or upload an existing one in the Customer Portal. To setup the Single Sing On and access the Customer Portal, sign on to your account role as a Company Administrator. This user role can this user can create users in the company user's pool, and manage users in all the company subscriptions. For additional information about Managing Customer Portal and roles refer to:

 

To create a security certificate inside the Customer Portal follow these steps:

1.Select the Settings icon located in the left panel menu.

 

SettingsIcon01

 

2.A panel expands from the left with all the security related topics. Select the Authentication certificates option.

 

AuthCert01

 

3.Inside this section, there is a list of certificates with details like Name, Description, Expiration date, Owner and Creation date and its creation source. In the top right corner, select the Add certificate button.

 

AuthCert02

 

4.The Add new authentication certificate window opens for you to create the new security certificate and you must fill out the five different required fields:

a.Display Name.

b.Description.

c.Either select the Generate (to create a new certificate) or Upload (to upload a existing certificate) option for the toggle button.

d.Expiration date.

e.Certificate password.

 

When you select the Generate option, set the Expiration date and assign a Certificate password. If you select the Upload option, you are required to upload digital certificates files in a PFX or a P12 format and then, select the type of algorithm to implement between SHA256 and SHA1. For last, enter the password from the certificate.

 

AuthCert03

 

5.After all the required fields have been entered, click Save in the top right corner.

 

AuthCert04

 

After the certificate is created a message will appear in the right bottom corner indicating it has successfully been saved.

 

AuthCert05

 

To manage the generated security certificate in the Customer Portal refer to the Managing Authentication Certificates documentation.

 

2. Configure your IdP in Bizagi

After you configure the application in Entra ID, now you must access the Bizagi Studio or the Management Console and register the Identity Provider. Follow the steps in Configure a SAML 2.0 IdP in Bizagi.

 

3. Download the Bizagi metadata file

After you configure the identity provider in Bizagi, you must generate the metadata file. Refer to Download the metadata file.

 

4. Configure Bizagi as Service Provider in NetIQ Access Manager

You do this in the NetIQ Access Manager admin options.

 

4.1. Log in to the NetIQ Access Manager Access Manager.

 

4.2. From the menu select Devices -> Identity Servers -> <YOUR_SERVER>.

Replace <YOUR_SERVER> with the name of your configured NetIQ Access Manager server/cluster.

 

4.3. Enable the SAML 2.0 protocol for your NetIQ Access Manager server (or servers/clusters).

Check the SAML 2.0 checkbox found in Enabled protocols:

 

NetIQ_1

 

Click OK when done.

 

4.4. Click new on the enabled SAML 2.0 tab menu.

Select Service Provider from the drop-down options to register Bizagi so that its connection is trusted:

 

NetIQ_2

 

4.5. Fill in:

Provider type: General

Source: Metadata Text

Name: Provide a unique identifier that is clear and describes the purpose of the service. Using Bizagi's URL is good.

Text: Paste the content of Bizagi's metadata.xml file as produced in step #3.

 

NetIQ_3

 

Click Next when done.

 

2.6. Confirm the certificate.

Review the certificate's details to make sure they are accurate (the metadata.xml file has the certificate employed by Bizagi). Then click Finish.

 

NetIQ_4

 

4.7. Locate the recently-added Service Provider (Bizagi), and click it.

You can specify which information (attributes) is returned within a response (assertion).

 

NetIQ_5

 

4.8. Locate the Attributes tab. For its Attribute set, select Email.

Use the arrow icons to pass this attribute into the Available list on the right:

 

NetIQ_6

 

Click Apply when done.

 

4.9. In the Authentication Response tab, select POST for Binding.

Check the Email checkbox and confirm that its Value shows the corresponding email attribute configuration you selected.

 

NetIQ_7

 

Click Apply when done.

 

4.10. In the upper menu, select the Security -> Trusted Roots tab.

In that tab, import the certificate so that these are localizable at NetIQ Access Manager's trusted key store.

These steps are not always needed if you are not working with self-signed certificates. If this is you case, then you may skip or simply review steps 2.10 through 2.15.

 

4.11. Click Import... to install the certificate (.cer, or .crt file):

 

NetIQ_8

 

4.12. Use the Choose File button to locate the certificate. Give it a meaningful name in the Certificate name field:

 

NetIQ_9

 

Click OK when done.

 

4.13. Click Add Trusted Roots to Trusted Store... and select the certificate you just imported to add it to the root trusted store:

 

NetIQ_10

 

4.14. Select your certificate and trusted stores:

 

NetIQ_11

 

4.15. Click OK when done.

You may need to restart your NetIQ Access Manager services.

 

NetIQ_12

 

4.16. In the upper menu, select Devices -> Identity servers -> <YOUR_SERVER>.

You should replace <YOUR_SERVER> with the name of your configured NetIQ Access Manager server/cluster.

 

NetIQ_13

 

4.17. In the SAML 2.0 tab, check the Encrypt assertions checkbox to have NetIQ Access Manager encrypt messages it sends to Bizagi.

 

NetIQ_14

 

Do not check the Encrypt name identifiers checkbox.

Save your changes and exit when done.

You have now configured your NetIQ Access Manager Access Manager to rely on SAML 2.0 for an integrated authentication with Bizagi!

 

Now when you run the Work Portal, Bizagi displays the IdP log-in page and users can be authenticated with your Identity Provider.

 

note_pin

Remember to do this configuration in all your environments, or to deploy security configurations in your target environments, for example, test or production environments.


Last Updated 9/11/2024 10:24:54 AM