Security configuration: options

The tables below describe the configuration of everything about security.

Setting Description
X-Frame options (Requires restart)

The content of the HTTP-header X-Frame-Options. This is set on all rendered pages and is used to avoid clickjacking attacks. By default, only pages with the same origin can use the rendered pages in a frame.

Limit user sessions
  • True: A user can only open one session.
  • False (default): A user can open multiple sessions.

Office research guest access

  • True: The Office research integration is always allowed guest access via REST, regardless of the general Guest access setting.
  • False (default): The general Guest access setting is kept.

Note Currently, The Office research integration is only available when Collibra Data Intelligence Cloud is publicly available, which is why this override setting is necessary.

Prevent advanced html features in text dashboard

Text widgets can contain full HTML. However, this means an attacker could potentially execute an XSS attack by injecting malicious HTML. For more information, see the Troubleshooting section.

  • True: Potentially dangerous HTML elements are removed from text attributes when you save the text field.
  • False (default): No HTML elements are removed from text attributes when you save the text field.

Note 

If you enable this setting, the following HTML elements are deleted when you save:

  • script (including JavaScript)
  • svg
  • frame
  • frameset
  • iframe
  • any event handlers

Guest access

This setting requires the SUPER role.

  • True: Anyone that can access the URL, has viewing rights to the system.
  • False (default): The user is asked to sign in before having access to any data.
Enable schema introspection
  • True: Schema fields are shown during an introspection.
  • False (default): Schema fields are hidden during an introspection.
Enable customer validation functions
  • True (default): Groovy scripts with custom validation functions can be loaded.
  • False: Groovy scripts with custom validation functions cannot be loaded.

LDAP

DGC can connect to an LDAP server to handle the authentication.

Setting Description
Enable LDAP integration (Requires restart)
  • True: The LDAP integration is enabled.
  • False (default): The LDAP integration is disabled.
Sync after restore
  • True (default): LDAP data is synchronized with Collibra when an initial data set is bootstrapped.
  • False: LDAP data is synchronized with Collibra only when the LDAP synchronization job is triggered.
User page size

The page size that is used when retrieving users during synchronization.

The default value is 500. You can set it to 0 to disable paging.

Note This is a global setting. If you are working with multiple LDAP servers, only the value for the main server is taken into account.

Group page size

The page size that is used when retrieving groups.

You can set it to 0 to disable paging.

Note This is a global setting. If you are working with multiple LDAP servers, only the value for the main server is taken into account.

Time limit

Specifies the time limit in milliseconds for all LDAP searches.

The default value is 120,000.

You can set it to 0 to disable the time limit.

Tip 
  • If you get Time limit Exceeded error messages, increase the default value or check why the LDAP search takes too long.
  • We recommend that you modify the User page size and Group page size settings before you modify this setting.
Sync job enabled
  • True (default): The synchronization job is enabled.
  • False: The synchronization job is disabled.
Sync job cron

The schedule to perform an LDAP synchronization (CRON).

The default value for this setting is daily at midnight.

If you create an invalid Cron pattern, Collibra Data Intelligence Cloud stops responding.

User field mapping The configuration mapping of all the user fields. This determines which LDAP field ismapped to which user field. Empty fields are ignored during the synchronization.
  Username
The unique user ID in the LDAP, typically UID. This is a mandatory field.
  Email
The corresponding email field in the LDAP directory. This is a mandatory field.
  First name
The first name field in the LDAP directory.
  Last name
The last name field in the LDAP directory.
  Middle name

The middle name field of the LDAP directory, this is usually givenName.

  Enabled
Indication whether a user is active or inactive in LDAP.
  Language

The language and locale of the user. It has to contain a language code and may contain a country code.

Examples: pl, en_US, nl_BE.

  Group

The LDAP property that defines to which groups the user belongs. If there is a group entry in the LDAP directory, use the Group field mapping settings.

  Additional email list

An additional email list.

  Instant messaging fields
The mapping for the user's IM locations.
  AIM
The mapping for the user's AOL IM account.
  Google Talk
The mapping for the user's Google Talk IM account.
  Icq
The mapping for the user's ICQ IM account.
  Jabber
The mapping for the user's Jabber IM account.
  Messenger
The mapping for the user's Live Messenger IM account.
  Skype
The mapping for the user's Skype IM account.
  Yahoo Messenger
The mapping for the user's Yahoo Messenger IM account.
  Website map
Enter the field value and field key to map a social media website.
  Phone
The mapping for the user's phone.
  Fax
The mapping for the user's fax number.
  Mobile
The mapping for the user's mobile number.
  Pager
The mapping for the user's pager number.
  Private
The mapping for the user's private number.
  Work
The mapping for the user's work number.
  Other
The mapping for any other phone number for this user.
  Home address
The mapping for the user's home address.
  Street
The mapping for the user's street.
  Number
The mapping for the user's number.
  City
The mapping for the user's city.
  Post code
The mapping for the user's postal code.
  State
The mapping for the user's state.
  Country
The mapping for the user's country.
  Work address
The mapping for the user's work address.
  Street
The mapping for the user's street.
  Number
The mapping for the user's number.
  City
The mapping for the user's city.
  Post code
The mapping for the user's postal code.
  State
The mapping for the user's state.
  Country
The mapping for the user's country.
  Gender
The mapping information for the user's gender.
  Mapping
The attribute key for the gender value. If the content equals one of the male or female mappings, the user will be saved as male or female. Otherwise a default of UNKNOWN will be used.
  Male value
The value for male users.
  Female value
The value for female users.
Group field mapping Groups can be defined as a separate structure or as a userField. The following section allows you to sync with a group structure that is unrelated to the user structure.
  Group name field

The name of the group to use in the application.

  Users field
The user DNs that are member of the group.
Servers

The Collibra parameters to map with your LDAP server parameters.

  LDAP server URL
The URL or IP address to the LDAP server, for example ldap://ldap.yourcompany.com:389 or ldaps://ldap.yourcompany.com:636.
  Bind DN
The DN of the administrator user that is used for authentication, for example admin.
  Bind password
The password of the administrator user.
  Base DN
The base DN for when you are working with relative DNs. This base DN is used for all LDAP look-ups.
  User base
The base DN of where the LDAP users for Collibra are located. If a base has been specified, it is used as a prefix for this user base. Subtree search is used, so all DNs located below are searched for matching users.
  Authentication user LDAP filter
The filter that specifies which users can authenticate in the application. By default, all the objects found in the user base are selected, including the root.
  Synchronization user LDAP filter

The filter that specifies which users are imported by the synchronization job. The users have to be the same as, or a subset of, the Authentication user LDAP filter.

If you provide no value for this setting, the same filter as specified for the Authentication user LDAP filter setting is used. That allows you to synchronize only the users that have to have access to the application, even if they have not logged in yet. Users in the Authentication user LDAP filter are synchronized each time they authenticate and are only available after the first sign-in to the application. This is the default setting.

  Authentication type

The authentication mechanism for authenticating users on the LDAP servers.

Authentication type Explanation
none No authentication is performed.
simple Simple authentication is performed, using the Bind DN and Bind password as credentials. The credentials are sent as plain text.
DIGEST-MD5 Simple authentication is performed, using the Bind DN and Bind Password as credentials. The Bind password is hashed with the MD5 algorithm.
TLS-SIMPLE A temporary secured TLS connection is set up before the credentials are sent as plain text. SSL must be configured.
TLS-EXTERNAL A temporary secured TLS connection with external SASL authentication using a client certificate. SSL must be configured.
  Shutdown gracefully
  • True: The LDAP context is destroyed immediately. When using TLS, some servers require the connection to be shut down by the client before the LDAP context is destroyed.
  • False (default): The LDAP context is not destroyed immediately.
  Referral Setting

Specifies what to do with referrals. Possible values:

Referral setting Explanation
throw

Throws an exception if a referral is encountered.

ignore (default)

All referrals are ignored.

follow

Follows the referral to the actual location of the entry on another server.

This is recommended when using Microsoft Active Directory.

Note If you are experiencing slow searches on Microsoft Active Directory with the follow value for the Referral setting, try using the Global Catalog as Active Directory domain controller. The Global Catalog enables searching for Active Directory objects in any domain in the forest without the need for subordinate referrals. This can dramatically speed up searching. However, the Global Catalog only contains a subset of the attributes of an object. This solution is only viable if the attributes requested for the search results are stored in the global catalog. Note that the Global Catalog is accessible on port 3268/3269, not the standard 389/636 LDAP ports.

  Group base DN
The base DN of where all the groups are located. If a base has been specified, that base is used as the prefix for this group base.
  Group LDAP filter
The LDAP filter to which each group has to comply to be synchronized.
Batch synchronization The synchronization of the users with the LDAP server happens in batches.
  Batch size

The number of users in each batch. If a batch fails, none of the users in that batch is updated and the user names are listed in the DGC service log. Other batches are processed as normal. After processing all batches, Collibra disables users that are no longer in LDAP, unless one ore more batches failed.

Set the value to 0 to disable batch processing.

Password

Configure how strong a users password should be.

Setting Description
Minimum length (Requires restart)

The minimum length of passwords.

The default minimum length is 12.

Maximum length (Requires restart)

The maximum length of passwords.

The default maximum length is 1,024.

Digits required (Requires restart)
  • True (default): Passwords have to contain one or more digits.
  • False: Passwords do not have to contain digits.
Non alphanumeric required (Requires restart)
  • True (default): Passwords have to contain one or more non-alphanumeric (special) characters.
  • False: Passwords do not have to contain non-alphanumeric characters.
Uppercase required (Requires restart)
  • True (default): Passwords have to contain one or more upper-case characters.
  • False: Passwords do not have to contain upper-case characters.
Lowercase required (Requires restart)
  • True (default): Passwords have to contain one or more lower-case characters.
  • False: Passwords do not have to contain lower-case characters.
Username disallowed (Requires restart)
  • True (default): Passwords cannot be the username.
  • False: Passwords can be the username.

Expiration interval (months)

The number of months before users have to change their passwords.

Set it to 0 if users never have to change their passwords.

The default interval is 6 months.

Allowed login failures

The number of consecutive failed login attempts that are allowed before the user account is disabled.

Set it to 0 for unlimited attempts.

The default is 3 login failures.

No reuse count

The number of previous passwords users cannot reuse. The default is 1: the user cannot change his password to what it currently is.

Set this to 0 to allow using the same password.

Password reset link validity period

The number of minutes that a link to reset a password remains valid. Beyond this time, the user has to request a new password reset link.

The default value is 60 minutes.

The minimum value is 15 minutes, the maximum value is 1,440 minutes (24 hours).

Account lock-out duration

The number of minutes that a user cannot sign in after too many failed sign-in attempts. If the number of minutes is set to 0, a Collibra administrator must reset the password to unlock the account. This setting is only applicable if the "Allowed sign-in failures" setting is defined.

A locked-out account does not mean that your account is disabled.

REST

The section about security for the REST interface.

Setting Description
CSRF token enabled
  • True: The validity of a request is checked with a CSRF token.
  • False (default): The validity of a request is not checked with a CSRF token.
Referrer enabled
  • True: The HTTP referrer header is used to identify the origin of the request.
  • False (default): The HTTP referrer header is not used to identify the origin of the request. It is recommended to leave this option disabled.
Referrer checking allow empty
  • True (default): The HTTP referrer header can be empty.
  • False: The HTTP referrer header cannot be empty.

SSL

SSL Configuration.

Setting Description
Key store name The name of the keystore file. The file is expected to be in the <collibra_data>/dgc/security folder.
Key store password The password of the keystore.
Key store type The type of the keystore file. For example, JKS or PKCS12.
Trust store name The name of the truststore file. The file is expected to be in the <collibra_data>/dgc/security folder.
Trust store password The password of the truststore.
Trust store type The type of the truststore file. For example, JKS or PKCS12.

SSO

The section about SSO (Single Sign On) authentication. See the SSO Documentation for more details.

Setting Description
Mode

The SSO mode of Collibra.

The possible values are:

  • SAML_ATTRIBUTES
  • SAML_LDAP
  • SSO_HEADER
  • SSO_HEADER_LDAP
  • DISABLED
Header

The name of the header to be checked. The contents of this header is used for the search query, which is SSO_HEADER = username.

The value of the actual query depends on DN and possibly Attribute.

DN

If the SSO mode is SSO_HEADER_LDAP or SAML_LDAP, this field determines whether the distinguished name (DN) or attribute is used:

  • True: The header has to contain the distinguished name (DN) of the user in the LDAP.
  • False (default): The header has to contain the value of Attribute.

If the SSO mode is DISABLED, SSO_HEADER or SAML_ATTRIBUTES, this field is ignored.

Attribute

This field is only used if the SSO mode is SSO_HEADER_LDAP or SAML_LDAP, and if DN is False.

If the above criteria are met, the LDAP has to contain this value.

Disable automatic user creation when signing in via SSO

If users try to sign in via SSO, they still need a user account in Collibra. You can either create the user accounts automatically when they sign in, or create the user accounts manually or via LDAP synchronization

  • True: User accounts are not created automatically.
  • False (default): User accounts are created automatically.

Disable the Collibra signin page

When SSO is enabled, a user can still navigate to the /signin page and try to log in via that page. However, you can disable that page.

  • True: Users cannot access the Collibra signin page.
  • False (default): Users can access the Collibra signin page
SAML The configuration of SAML.
  Metadata HTTP
The URL of the SAML metadata file to be used. The URL always has to be reachable by the Collibra environment.
  Entity Provider Entity ID

The entity ID inside the metadata to be referenced.

Note A metadata file can describe multiple entity IDs, make sure to use in the entity ID from the correct metadata file.

  Attribute fields

The mappings of attributes in the SAML response. The values are used as keys to look for in the SAML response.

Examples of attribute fields are first name, last name, address information, phone numbers and so on.

  First name

The mapping for the user's first name.

This attribute is optional. The value can be empty.

  Last name

The mapping for the user's last name.

This attribute is optional. The value can be empty.

  Email

The mapping for the user's email address.

This attribute is optional for existing users, but mandatory for new users.

Warning If the email address is invalid when you synchronize, the user is deactivated and the user information is not updated.

  Enabled
The mapping that indicates whether the account of the incoming user is enabled.
  Group

The mapping (attribute) which indicates to which Collibra groups the user should be added. If the groups don't exist yet, they will be created. This attribute can have multiple values (groups) or the groups can be sent as a comma-separated list of groups.

If passing groups in this attribute, you must set Groups DGC Managed to False.

  Phone
The mapping for the user's phone.
  Fax
The mapping for the user's fax number.
  Mobile
The mapping for the user's mobile number.
  Pager
The mapping for the user's pager number.
  Private
The mapping for the user's private number.
  Work
The mapping for the user's work number.
  Other
The mapping for any other phone number for this user.
  Home address
The mapping for the user's home address.
  Street
The mapping for the user's street.
  Number
The mapping for the user's number.
  City
The mapping for the user's city.
  Post code
The mapping for the user's postal code.
  State
The mapping for the user's state.
  Country
The mapping for the user's country.
  Work address
The mapping for the user's work address.
  Street
The mapping for the user's street.
  Number
The mapping for the user's number.
  City
The mapping for the user's city.
  Post code
The mapping for the user's postal code.
  State
The mapping for the user's state.
  Country
The mapping for the user's country.
  Instant messaging
The mapping for the user's IM locations.
  AIM
The mapping for the user's AOL IM account.
  Google Talk
The mapping for the user's Google Talk IM account.
  Icq
The mapping for the user's ICQ IM account.
  Jabber
The mapping for the user's Jabber IM account.
  Messenger
The mapping for the user's Live Messenger IM account.
  Skype
The mapping for the user's Skype IM account.
  Yahoo Messenger
The mapping for the user's Yahoo Messenger IM account.
  Gender
The mapping information for the user's gender.
  Mapping
The attribute key for the gender value. If the content equals one of the male or female mappings, the user will be saved as male or female. Otherwise a default of UNKNOWN will be used.
  Male value
The value for male users.
  Female value
The value for female users.
  Groups DGC managed

Option to configure that groups should be managed by Collibra, or that groups should be set by the SAML assertion (SAML+Attributes mode).

This option is only relevant if Mode is SAML_ATTRIBUTES.

  • True: The groups are fully managed by Collibra. In the UI the admin has the option to assign groups to users, without it being overwritten by SAML.
  • False (default): The groups are managed by the SAML assertions. In this case the groups are managed by the SAML IDP. Be sure to configure the Group attribute in the Attribute Fields section.
  Service Provider Entity ID

Field that determines the value of the Entity ID parameter in the service provider metadata returned by Collibra. The default value is empty, in which case Collibra uses the value of the Base URL field.

Enter a custom value if the base URL does not match the audience configured in your SAML identity provider.

Warning The value of the audience restriction in the SAML response has to be exactly the same as the value of this field.

Note SSO does not work if the Service Provider Entity ID field contains the base URL with trailing forward slash (for example www.collibra.com/), and the audience of your IDP contains the base URL without a trailing forward slash (for example www.collibra.com).
Both values need to be exactly the same. In this case, you can resolve the issue by changing the value in the configuration of your IDP, or the value of this field. It does not matter whether both have a trailing forward slash or not, as long as they contain the same value.

  Sign authentication requests (Requires restart)
  • True: Authentication requests have to be signed.
  • False (default): Authentication request don't have to be signed.
  Force authn
  • True (default): The SP authentication request forces re-authentication.
  • False: The SP authentication request does not force re-authentication.
  Force passive
  • True: The reauthentication has to happen in the background.
  • False (default): The reauthentication does not have to happen in the background.

This is only relevant if Force authn is True.

  Name ID

Name ID that is used in the SP authentication. The default value is urn:oasis:names:tc:SAML:2.0:nameid-format:persistent.

The Name ID value is mandatory.

  Name ID allow create
  • True (default): The IDP can create a name ID to fulfill the SP authentication request.
  • False: The IDP cannot create a name ID to fulfill the SP authentication request.
  Disable client address
  • True: The validation of the client IP address in the assertion message is disabled.
  • False (default): The validation of the client IP address in the assertion message is enabled.
  SAML Requested authentication context

Settings for the SAML requested authentication context. The IDP uses the authentication context to authenticate the user. By default, the authentication context mandates user/password authentication over HTTPS.

  Disable
  • True: The requested authentication context section is not sent in the SAML request.
  • False (default): The requested authentication context section is sent in the SAML request.
  Comparison type

The comparison type that is transmitted in the requested authentication context.

Possible values:

  • minimum
  • maximum
  • better
  • exact (default value)

For more information about the comparison type values, refer to the SAML specifications.

  Reference list

The list of class references in the requested authentication context. You can separate list items with the pipe character (|).

For more information about this list, refer to the SAML specifications.

  Declaration list

The list of class declarations in the requested authentication context. You can separate list items with the pipe character (|).

For more information about this list, refer to the SAML specifications.

  Response decryption mode

Enable the support for encrypted SAML responses.

  • DISABLED: Collibra only accepts plain-text SAML responses.
  • OPTIONAL: Collibra can handle both encrypted and plain-text SAML responses.
  • FORCED: Collibra only accepts encrypted SAML responses.

Once OPTIONAL or FORCED is selected, the encryption key pair is generated and added to the Collibra SAML keystore. A self-signed certificate is generated and works in most situations. If your IdP rejects self-signed certificates, you will have to add a certificate that is signed by a trusted 3rd party.

  Validity period of the SAML certificate

The SAML certificate expiry date in years.

By default, the SAML certificate expires after 20 years.

Signout

The section about signout redirect changes.

Setting Description
Override signout URL (Requires restart)
  • True: Redirect the user to a specific website after signing out.
  • False (default): Redirect the user to the sign-in page after signing out.
Signout redirect URL (Requires restart) The URL to be redirected to when signing out.

JWT

This section helps you configure the JSON Web Token authentication.

Setting Description
JSON Web Key Set URL

The URL to retrieve public key information needed to verify the authenticity of JSON Web Tokens (JWTs), issued by an authorization server.

This setting is required to enable JWT authentication.

JWT Token Types

A case-insensitive comma-separated list of accepted JWT media types coming in the typ header parameter.

Leave blank if the authorization server does not provide a media type parameter.

The default values is at+jwt,jwt.

JWT Algorithms

A comma-separated list of accepted JWT algorithms coming in the alg header parameter. See https://tools.ietf.org/html/rfc7518#section-3.1 for details.

Leave blank to accept all digital signature algorithms.

JWT Issuer

The accepted issuer coming in the iss JWT claim.

Leave blank if the authorization server does not provide an issuer claim.

JWT Audience

A comma-separated list of accepted audience values for the aud claim.

The value for this field is a configuration setting in your authorization server, which identifies your Collibra environment as the intended recipient of the JWT.

Leave blank if the authorization server does not provide an audience claim.

JWT Principal ID Claim Name.

The name of the JWT claim containing the principal's identity. See https://tools.ietf.org/html/rfc7519#section-4.1.2 for details.

Defaults to the standard subject claim, sub.

Change this setting only if your authorization server has other means of identifying the principal, for example, a client_id claim.

This setting is required if JWT authentication is enabled.

JWT Maximum Clock Skew

The maximum acceptable difference in seconds between the clocks of the machines running the authorization server and Collibra.

Differences smaller than the given amount are ignored when performing time comparisons for token validation.

The default value is 60 seconds if left blank.