| Section | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Column | |||||||||||||
| Section | |||||||||||||
|
...
- The Http Auth Credentials section is at the bottom of the Edit/Add tenant screens and is initially collapsed. Click the
icon to expand it.
- Enter the scheme from the dropdown. The admin may enter multiple credentials by clicking the
Basic - a common HTTP Authentication protocol that assumes that client credentials consist of a username and a password where the latter is a secret known only to you and the server
NTLM - a Windows network authentication protocol that allows a client to prove its identity without sending a password to the server.
Scheme, host, user name and password are required.
Port is optional and may be left blank. Either blank or -1 equates to any port and the system will alter blank to be -1.
All fields are specified in plain text and not encoded in any way.
Domain is only generally used for NTLM.
Configuring the LDAP/Active Directory Security Manager
The connection to your LDAP server is configured at the tenant level. Existing in-house customers using LDAP should refer to the Upgrade Guide for a quick way to import your current LDAP configuration parameters before migrating. in-house customers can add an LDAP tenant and configure the LDAP paramaters via the Add Tenant screen. LDAP properties can be updated at anytime via the Edit Tenant screen.
| Info |
|---|
If you are a new in-house LDAP customer, use the Add Tenant screen to configure the LDAP tenant. If you are an existing LDAP customer, the migration process copies any existing LDAP configuration from the frevvo.xml or config properties files to the tenant. Once migrated, updating frevvo.xml has no effect on the tenant configuration. Make changes using the Edit Tenant screen. |
Cloud customers must request an LDAP tenant from frevvo customer support. Cloud customers will receive a default tenant login from frevvo and then they can edit the LDAP configuration properties using the Edit Tenant screen to connect to their LDAP server.
In all cases, follow these steps to configure LDAP:
Key Information to Collect
...
- LDAP server name or ip
- LDAP server port
- User name and password with proper permissions to access and browse LDAP.
- LDAP groups and/or users that will be considered designers. These users will be able to create forms and flows in frevvo.
- LDAP groups and users that will be considered administrators.
- LDAP groups and users that will be considered publishers. This role gives a user the permission to go to the home page of every other tenant user.
- LDAP groups and users that will be considered ReadOnly.
Configuration Steps
...
Assign the frevvo.TenantAdmin group to one or more users to give them the privileges of a tenant admin.
| Note |
|---|
There are four special roles in : frevvo.TenantAdmin, frevvo.Designer, frevvo.Publisher, frevvo.ReadOnly, that must be specified on your LDAP/AD Server if you have users that will be assigned these roles. The group names must be frevvo.TenantAdmin, frevvo.Designer, frevvo.Publisher, frevvo.ReadOnly . Upper/lower case may be a factor for Open LDAP systems. |
...
Enter your LDAP Configuration Properties. Alternatively, you can start off from one of the sample configurations and provide only the key information listed above. See below for information on the TLS checkbox.
| Note |
|---|
The Name/value table highlighted in the image allows you to configure up to 10 additional LDAP properties. See this website for a complete list of all available LDAP properties. For example, you can configure to ignore or follow referrals. Setting the java.naming.referral property to a value of "ignore" in the Name/Value table configures Consult your LDAP Administrator for the details.You will have to set the ‘java.naming.referral’ property to value ‘ignore’ in the Name/Value table of your Edit Tenant page. |
...
- Contact frevvo to create an LDAP/Active Directory tenant. Login with the id and password information provided by frevvo.
- Click on the Edit tenant link
- Edit the LDAP Configuration Properties. Replace the default values with values for your LDAP server.
- Click Submit.
| Warning |
|---|
It is recommended that you check the Ignore Case checkbox when configuring LDAP. Refer to Mixed or Upper case User Names topic for more details. |
...
Check if the configuration is correct
Here are some quick tests to check if the LDAP configuration is correct:
- Login as the tenant admin for the LDAP tenant.
- Click on the Manage Users link.
- Click All. You should see a list of LDAP users which were assigned one of these roles on the LDAP server: frevvo.TenantAdmin, frevvo.Designer, frevvo.Publisher, frevvo.ReadOnly
- Now, click Back To Manage Tenant.
- Click Manage Roles. You should see a list of groups from your LDAP server.
- Log out from (you should be currently logged in as the tenantadmin)
- Try to login with the user name and password of a user in LDAP. You need to specify the proper tenant when logging in. For instance, if john is a valid LDAP user and the name of the LDAP tenant is MYLDAP, you should log in as john@MYLDAP. The password would be john's password in LDAP.
Since you are using LDAP to define users and roles (i.e., groups), you do not see an Add User icon or Add Role icon on the Manage Users or Manage Roles pages.
Secure LDAP Configuration
will be connecting to your LDAP server over the network. Here are two methods to secure the LDAP connection:
- Simple authentication over SSL - To enable SSL use the ldaps scheme in your LDAP tenant configuration in place of ldap and use port 636. This is supported by older LDAP products such as AD 2000. It is important that the hostname in the certificate matches the hostname in your ldaps url.
- Simple or external SASL authentication over TLS (Transport Layer Security) - To enable this method check the TLS checkbox in your LDAP tenant configuration. TLS is used by the LDAP v3 standard in products such as AD 2003 and above. TLS uses the standard LDAP port 389.
When using either of these two methods, the recommended approach is to use a CA signed certificate. If you do not have a CA signed certificate then you can use a self-signed certificate.
| Note |
|---|
Self signed certificates are not supported for Live Forms Online. Although they are supported for in-house, use of self-signed certificates is not recommended. |
Finally you need to install your signed or self-signed certificate. You can import the certificate into a keystore that can access and trust. Follow the instructions for your keystore. If is installed in a tomcat server, the tomcat keystore can be used. Refer to this Apache Tomcat website for instructions .
External SASL and pooling are currently not supported. This is planned for a later release.
LDAP Configuration Properties
These are the properties used to configure the LDAP/Active Directory security manager. The properties in bold are required.
| Property | Description |
|---|---|
| Connection URL | ldap server url |
| Connection User | User to connect to LDAP. This user must have the proper permissions to read and run queries in the ldap server. If using Active Directory, it is common to specify the domain. For instance, TEST\Administrator refers to the user Administrator in the TEST domain. |
| Connection Password | Password for the user defined in com.frevvo.security.ldap.connection.name. |
| Users Base | Searches for users will start from the ldap node specified by this property.If the value is empty the searches will start from the root domain. |
| Groups Base | Searches for the groups will start from the ldap node specified by this property. If the value is empty, searches will start from the root domain |
| UserId Display | User attribute that will be visible in frevvo. This is what will be displayed in the list of users a tenant admin sees and has to be unique in the server. Another restriction is that the values for the attribute configured here cannot have spaces. For instance, don't configure CN as the value since it can contain spaces in most systems. |
| GroupId Display | Group attribute that will be visible in frevvo. This is, for instance, what will be displayed in the list of groups a tenant admin sees or the groups used in workflows. This attribute has to be unique in the server.
|
| Notify checkbox | Notifications are emails sent by frevvo to workflows participants. If checked, notifications will be sent. |
| All Groups Filter | The expected value is an LDAP filter expression. The expression should return the groups that will be available to be used in frevvo workflows. com.frevvo.security.ldap.groupIdDisplayAttribute |
| All Users Filter | The expected value is an LDAP filter expression. The expression should return the users that will be available to be used in frevvo work flows and authentication. com.frevvo.security.ldap.groupIdDisplayAttribute |
| User Member Of | Attribute on a user object storing the groups the user is a member of. |
| Group Member | Attribute on a group object storing the users that are a member of this group. |
| First Name | Name of the user ''first name'' attribute |
| Last Name | Name of the user ''last name'' attribute. |
| Email | Name of the user ''email'' attribute in the LDAP server. This value can be used in a rule is used in email notifications |
| Manager | Attribute on a user object storing the DN of the user’s manager. This value can be retrieved in a rule or used in flow navigation using the subject.reports.to data available in . |
| Ignore Case checkbox | If checked, ignores the case stored in LDAP systems, primarily for the purpose of determining roles. |
| Custom | This is a a comma separated list of attribute names to be retrieved from the LDAP Server. |
| TLS | This enables simple authentication over TLS. If checked, a trusted certificate for the LDAP server is required. |
Sample Configurations
| Property | Active Directory Sample Configuration | OpenLDAP Sample Configuration |
|---|---|---|
| Connection URL | ldap://[your server]:[port, typically the default is 389 ] | ldap://[your server]:[port, typically the default is 389 ] |
| Connection User | [user name] | cn=admin,dc=test,dc=frevvo,dc=com |
| Connection Password | [user password] | [user password] |
| Users Base | CN=Users,DC=test,DC=windows,DC=frevvo,DC=com | DC=test,DC=frevvo,DC=com |
| Groups Base | CN=Users,DC=test,DC=windows,DC=frevvo,DC=com | DC=test,DC=frevvo,DC=com |
| UserId Display | sAMAccountName | uid |
| GroupId Display | sAMAccountName | entryDN |
| Notify checkbox | Check the Notifications checkbox | |
| All Groups Filter | (objectClass=group) | ( | (objectClass=groupOfUniqueNames)(objectClass=organizationalRole)) |
| All Users Filter | (objectClass=user) | (objectClass=person) |
| Group Member | member | uniqueMember |
| User Member Of | memberOf | " " |
| First Name | givenName | cn |
| Last Name | sn | sn |
| Manager | manager | manager |
| Ignore Cas | Check the Ignore Case checkbox | Check the Ignore Case checkbox |
| Custom | carLicense, employeeName | carLicense |
| TLS | Check to secure the connection using TLS | Check to secure the connection using TLS |
...
.
Configuring the LDAP/Active Directory Security Manager
Creating/editing the LDAP tenant is performed by the superuser (on-premise) or the tenant admin (cloud). Refer to this documentation for configuration details and here for some troubleshooting tips.
Configuring the LDAP Container Security Manager
...
Configuring the SAML Security Manager
Creating/editing the SAML tenant is performed by the superuser (on-premise) or the tenant admin (cloud). Refer to the SAML Security Manager topic for the details.
Configuring the Azure SAML Security Manager
...