Authentication with ADFS

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Security definition > Work Portal Security > Authentication > SAML authentication >

Authentication with ADFS

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 Microsoft ADFS.

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

 

SAML_ADFS_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 ADFS, 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.

 

Recall that if you will be encrypting assertions as well, then the above is also needed for another certificate.

 

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

Bizagi supports ADFS version 3.0.

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 ADFS:

 

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

2. Configuring Bizagi as Service Provider in ADFS.

 

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: You may tick this checkbox (set to On). If doing so, ensure you configure Encryption certificate and Encryption certificate password.

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: Use the Browse button to upload the digital certificate (in P12 format, containing the public and private key) that will be used to encrypt the assertions generated by Bizagi.

Encryption certificate password: Type the password of the digital certificate used for the encryption of assertions.

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

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 ADFS metadata file is located. This location is typically an URL, such as the default

https://[my_federateserver]/FederationMetadata/2007-06/FederationMetadata.xml

Notice that you should consider the appropriate value for [my_federateserver].

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 ADFS you will need to consider that the default one is set to SHA256. Wanting to use SHA1 will imply that you need to configure such algorithm when defining the relying party trust at the ADFS directly.

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

 

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 ADFS

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

 

2.1. In your ADFS server, open the console for its administration.

 

2.2. Launch the creation of a relying party trust.

You may do this from the Relying party trust options which allows you to use its configuration wizard from a right-click:

 

SSO_idp0

 

Click Start.

 

ADFS_2

 

2.3. Select the data source.

To configure the relying party as described in this guide, select the Import data about the relying party from a file option to browse for the the metadata file as generated by Bizagi.

 

ADFS_3

 

2.4. Select the metadata file.

When clicking Browse make sure you locate Bizagi's metadata.xml file.

 

ADFS_4

 

Click Next when done.

 

2.5. Enter a unique name.

Give a display name to this configuration and for your convenience.

 

ADFS_5

 

Click Next when done.

 

2.6. Skip multi-factor authentication.

Select the I do not want to configure multi-factor authentication settings for this relying party trust at this time option and click Next when done.

 

ADFS_6

 

Click Next when done.

 

2.7. Choose issuance authorization.

Select the Permit all users to access this relying party option and click Next when done.

 

ADFS_7

 

You will be presented with a summary of the information to set for this relying party trust, including that one coming from Bizagi's metadata file.

You may click Next when done.

You may also check that the algorithm set for this use (either SHA1 or SHA256), matches that one configured in Bizagi (this can be reviewed in Advanced view).

 

2.8. Open the Claim rules editor.

Before you close the actual configuration window, ensure you tick the Open the Edit Claim Rules dialog for this relying party trust when the wizard closes checkbox.

 

ADFS_8

 

Then, you may click Close.

 

2.9. Define a new claim rule by clicking Add Rule.

 

ADFS_9

 

 

2.10. Select the Transform an Incoming Claim template.

 

ADFS_10

 

Click Next when done.

 

2.10. Fill out the following details:

Claim rule name: Type NameID

Incoming claim type: Select E-mail Address

Outgoing claim type: Select Name ID

Outgoing name ID format: Select E-mail

 

ADFS_11

 

Ensure that the Pass through all claim values option is selected and click Finish.

You may want to review that the Claim rule has been created successfully. Review explicitly that the Claim rule has been persisted as described above.

Once this is so, you may exit the use of the ADFS console.

 

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

You will need to carry out the below next part only if you have employed self-signed certificates.

 

Additional step for self-signed certificates

If you have issued and installed a self-signed certificate for your ADFS (for signing and encrypting purposes), then you will need to perform the following:

1.Access your ADFS server and open a PowerShell console.

2.Enter the following command:

Get-AdfsRelyingPartyTrust -Identifier [relying_party_trust] | Set-AdfsRelyingPartyTrust

-SigningCertificateRevocationCheck None -EncryptionCertificateRevocationCheck None

Consider that you will need to replace [relying_party_trust] accordingly to the unique name given at the configuration above (when registering Bizagi's relying party trust).