Authentication with NetIQ

<< Click to Display Table of Contents >>

Navigation:  Identity and access management > SAML authentication >

Authentication 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.

This section is a step-by-step guide about the configuration needed, both in NetIQ and in Bizagi, in order to have an integrated authentication in Bizagi against NetIQ.

 

SAML_NetIQ_OV

 

Notice that for SAML 2.0, it is required that both your Identity Provider and your Bizagi project are strictly set up to support HTTPS.

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

 

Prerequisites

In order to configure NetIQ, as with any Identity Provider supporting SAML 2.0, you will need:

 

1. To have previously generated and imported your own certificates.

Such certificates are employed in this integration for the purpose of signing assertions.

This step is not bound to Bizagi nor restricted by any special requirement of Bizagi (it is usually carried out on your own).

In case that you need some guidance or an example on this step, refer to Generating and installing certificates.

 

In order to proceed with the guided steps presented below, you will need to have already imported certificates the in your Identity Provider. From such exercise, the following resulting input is needed as well:

The certificate information (.p12 file).

The password for that .p12 file, as defined by you at the moment of exporting the public and private key.

 

note_pin

Consider that the above implies that you will need to be in charge of managing your installed certificates (and watching after its expiration date or any other relevant maintenance aspects such as watching after any changes in your Identity Provider's endpoints).

 

2. To have already imported and synchronized your users into Bizagi.

Recall that when integrating any Identity Manager (regardless of the chosen one), customers need to synchronize those accounts that are authorized to access Bizagi's Work portal.

Synchronizing means importing or updating the account's primary identifier only (domain plus username typically, and the e-mail).

Recall that passwords are not stored when integrating an Identity Manager.

 

Once you have verified that at least there is an initial import of your users into Bizagi, you may proceed (by relying on the Work portal and its admin menu):

 

125Users13

 

note_pin

In Bizagi, unique identifiers for users are either: e-mail, or the combination of domain and username.

The examples of SAML-based authentication provided below use e-mail as the unique identifier for users.

 

3. An installed and fully configured and supported version of NetIQ.

Bizagi supports NetIQ version 4.

The following example (and official certification) is worked on with version 4.4.

If you want to use a different version, which supports SAML 2.0, it is advisable to first check with our support team.

 

What you need to do

The following outline of steps describes what needs to be done, both at Bizagi and at NetIQ:

 

1. Configuring in Bizagi, the settings that make reference to the specification of your SAML setup.

2. Configuring Bizagi as Service Provider in NetIQ.

 

Procedure

Follow these steps:

 

1. Configuring in Bizagi, the settings that make reference to the specification of your SAML setup.

Do this by using Bizagi Management Console targeting the environment you want this configuration to apply to (e.g, development environment, testing environment, production environment).

Alternatively and only for the development environment, you may use Bizagi Studio.

 

1.1. Open Bizagi Management Console and open your Bizagi project.

 

UsingStudio01

 

1.2. Locate the Security module and click on the Authentication option found under the Security item.

Then select Federated authentication from the drop-down list in the panel to the right, and select SAML v2.0 from the drop-down right below:

 

SAML_Bizagiparams1

 

Click Update.

You will get a confirmation message and notice that additional parameters appear under the Authentication item.

 

note_pin

If you applied this change into an environment other than development, then you should also make sure such same changes are applied in your development environment as well.

To do this, follow the same procedure mentioned above while using the Bizagi Management Console.

 

1.3. Proceed to configure these additional parameters as described below, ensuring you click Update for each one that is modified.

Note that the parameter values are case-sensitive and therefore you will need to ensure you input these correctly.

 

Fill in or configure these settings as described:

Enable assertion encryption: Leave this checkbox unmarked (set to Off). NetIQ is not currently supporting the reception of encrypted assertions.

Enable authentication logging in database: You may tick this checkbox (set to On) to define if the web application must log every authentication event (viewed from the Work portal), according to your auditing requirements and expectations.

Encryption certificate: Disregard this setting (given that is Enable assertion encryption disabled).

Encryption certificate password: Disregard this setting (given that is Enable assertion encryption disabled).

Force authentication: You may tick this checkbox (set to On) to avoid SSO capabilities so that every time users attempt login at Bizagi, credentials are explicitly requested. Decide on this according to your authentication requirements and expectations.

Identity Provider Metadata File Path: Type the path where the NetIQ metadata file is located. This location is typically an URL, such as the default https://<YOUR_NETIQ_DOMAIN>/nidp/saml2/metadata

Idle sessions time-out: Define the minutes for which a session will expire, according to your authentication requirements and expectations (e.g, 5 minutes).

Organization name: Type the name of your organization. Such information is included within the request messages sent by Bizagi.

Organization URL: Type the URL of the website of your organization. Such information is included within the request messages sent by Bizagi.

SAML Protocol Binding for SLO: It is recommended to select POST so that there is support for much lengthier messages.

SAML Protocol Binding for SSO: It is recommended to select POST so that there is support for much lengthier messages.

Service provider URL: Type the full URL (including the project) of the Service Provider. This means entering the URL for Bizagi Work portal.

For Bizagi PaaS, such URL uses this format:

https://[environment]-[project]-[company].bizagi.com/

For on-premises projects, such URL uses this format:

https://[server]/[project]

Recall that the above URL is case-sensitive and that [environment]- should be disregarded (left as blank) while in a production environment.

Signature certificate password: Type the password of the digital certificate used for the signing of assertions.

This password should match the one defined by you at the moment of exporting a certificate information in P12 format.

Signing algorithm: Select either SHA1 or SHA256. With NetIQ you will need to consider that within the default installation, SHA256 is disabled.

In case you wish to use SHA256 with NetIQ, edit its configuration file found at <NETIQ_INSTALLATION_DIR>\Tomcat\webapps\nidp\WEB-INF\classes\nidpconfig.properties by adding the following line:

SAML2_SIGN_METHODDIGEST_SHA256=true

Signing certificate: Use the Browse button to upload the digital certificate (in P12 format, containing the public and private key) that will be used to sign the assertions generated by Bizagi.

Technical email contact address: Provide an e-mail address for contact with your corporation, regarding technical issues.

 

 

SAML_Bizagiparams2

 

Once you are done, review that changes have been applied.

 

note_pin

Authentication changes may not be reflected immediately; in which case, you may need to reset the Bizagi services.

 

1.4. Perform a reset on your Bizagi services.

For on-premises projects, this means executing an IISReset.

Recall that any change in the authentication type, or any of its settings, is not reflected immediately unless the cache of the application server is explicitly refreshed.

 

1.5. Proceed to browse for the location of a metadata file that Bizagi generates based on the previous configuration.

In order to configure NetIQ throughout the next steps in an easier way, such metadata file from Bizagi will be downloaded into a local path so that it is then employed as input in NetIQ.

 

Notice you may first view this metadata file by browsing it as:

https://[environment]-[project]-[company].bizagi.com/saml2/metadata.xml?mode=preview

 

 

Proceed to download the file by inputting in that browser:

https://[environment]-[project]-[company].bizagi.com/saml2/metadata.xml?mode=attachment

 

2. Configuring Bizagi as Service Provider in NetIQ

Do this by going into the admin options as provided by NetIQ.

 

2.1. Login to access the admin options available in NetIQ Access Manager.

 

2.2. Locate the menu and go into Devices -> Identity Servers -> <YOUR_SERVER>.

Consider that is <YOUR_SERVER> should be replaced by name of your configured NetIQ server/cluster.

 

2.3. Make sure you enable the SAML 2.0 protocol for your NetIQ server (or servers/clusters).

Tick the SAML 2.0 checkbox found in Enabled protocols:

 

NetIQ_1

 

Click Ok when done.

 

2.4. Locate the enabled SAML 2.0 tab menu and click on New in there.

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

 

NetIQ_2

2.5. Fill in the following details:

Provider type: General.

Source: Metadata Text.

Name: Input a unique identifier for your own best legibility and maintainability. Using Bizagi's URL is suggested for this purpose.

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

 

NetIQ_3

 

Click Next when done.

 

2.6. Confirm the certificate.

At this point you may view the certificate's details.

Confirm that this is accurate (it's the certificate employed by Bizagi as it can be seen within the metadata.xml file) by clicking Finish.

 

NetIQ_4

 

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

This will allow you to define which information (attributes) is returned within a response (assertion).

 

NetIQ_5

 

2.8. Locate the Attributes tab, and for its Attribute set, select Email.

Rely on the arrow icons to pass on this attribute into the Available list to the rightmost part:

 

NetIQ_6

 

Click Apply when done.

 

2.9. Go into the Authentication Response tab, and for its Binding, select POST.

Then, tick the E-mail checkbox and ensure that its Value shows the corresponding e-mail attribute configuration as selected in the very previous step.

 

NetIQ_7

 

Click Apply when done.

 

2.10. Go into the upper menu and locate the Security -> Trusted Roots tab.

In there, you will import the certificate so that these are localizable at NetIQ's trusted key store.

It is likely that these steps are not always needed when not working with self-signed certificates. If this is you case, then you may skip or simply review these steps (2.10 through 2.15).

 

2.11. Click Import... in order to install the certificate (.cer, or .crt file):

 

NetIQ_8

 

2.12. Browse the certificate by using the Choose File button and name it (Certificate name):

 

NetIQ_9

 

Click Ok when done.

 

2.13. Click on Add Trusted Roots to Trusted Store... and then ensure you select the recently-imported certificate to add it to the root trusted store:

 

NetIQ_10

 

2.14. Select your certificates and trusted store:

 

NetIQ_11

 

2.15. Click Ok when done.

You may need to restart your NetIQ services.

 

NetIQ_12

 

2.16. Go into the upper menu and locate the Devices -> Identity servers -> <YOUR_SERVER>.

Consider that is <YOUR_SERVER> should be replaced by name of your configured NetIQ server/cluster.

 

NetIQ_13

 

2.17. Go into the SAML 2.0 tab and enable the Encrypt assertions checkbox so that NetIQ encrypts the messages sent to Bizagi.

 

NetIQ_14

 

Do not enable the Encrypt name identifiers checkbox.

Save changes and exit when done.

At this point you have configured your NetIQ to rely on SAML 2.0 for an integrated authentication with Bizagi!