Section | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Column | ||||||||||||||||
| ||||||||||||||||
Section | ||||||||||||||||
|
Prerequisite Tasks
These instructions assume that you have an in-house installation of Live Forms up and running or . Refer to Configuring LDAP(s) for Cloud tenants if you have signed up for an LDAP tenant on the cloud server.
Active Directory Customers using LDAP must ensure frevvo.TenantAdmin and frevvo.Designer groups are specified on your LDAP/AD server. The group names must be spelled as shown. Upper/lower case may be a factor for Open LDAP systems. .
- Tenant admin users must be assigned to the frevvo.TenantAdmin group.
- Designer users must be assigned to the frevvo.Designer group.
- Users with the frevvo.publishers role must be assigned to the frevvo.Publisher group.
- Users with the frevvo.ReadOnly role must be assigned to frevvo.ReadOnly group.
Warning |
---|
Warning |
|
Configuring and LDAP/Active Directory
users and groups can be maintained externally in systems such as Active Directory or Open LDAP. Follow these steps to integrate and your LDAP server:
- Collect the key information listed below and verify the Prerequisite Tasks have been performed.
- Create a tenant with the LDAP/Active Directory Security Manager class.
- Once you have your tenant successfully connecting with your LDAP server, review the available options regarding the authentication process.
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.
- LDAP user and groups base filters
- LDAP all users and all groups filters
LDAP the attribute names in your Active Directory for UserId Display, GroupId Display, User Member Of, Group Member, First Name, Last Name, Email and Manager (optional)
Create/Edit a tenant with 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 /wiki/spaces/frevvo80/pages/975572152for a quick way to import your current LDAP configuration parameters before migrating. The /wiki/spaces/frevvo80/pages/975572152 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.
- New in-house customers can add an LDAP tenant and configure the LDAP parameters via the Add Tenant screen. LDAP properties can be updated at anytime via 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. These instructions assume that you have an in-house installation of Live Forms up and running or you have signed up for an LDAP tenant on the cloud server.
In-house customers:
- Login to as an administrator (user:admin and password:admin if you have not changed it)
- Click on Manage and then Manage Tenants
- You will see a page where the current tenants are listed. If this is a new installation you will only see the default tenant d
- Click on the plus icon to add a new tenant.
- Configure the new tenant - Choose LDAP/Active Directory Security Manager.from the Security Manager Class drop down.
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Enter your LDAP Configuration Properties and Sample Configurations. 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 Oracle 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 to ignore referrals. Consult your LDAP Administrator for the details.
- If you are creating a new tenant:
- Enter a tenant id, a tenant name and description.
- The Max Concurrent Users is the maximum allowed by your license or less.
- Specify the LDAP User ID that will have the tenant admin permission.
- Click Submit. You will see your new tenant in the tenant list if the connection to your LDAP server is successful.
Warning |
---|
The Ignore Case and Notify checkboxes are checked by default. It is recommended that you leave them checked. Refer to Mixed or Upper case User Names topic for an explanation of the Ignore Case option. The Notify checkbox determines whether the task notification emails setup in flows are sent or not. |
...
...
...
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.
Configuring LDAPs for your Cloud tenant
Once your Online cloud hosted tenant has been provisioned for production use, follow the steps below to configure your tenant to use the frevvo LDAP/Active Directory Security Manager to integrate with your company's AD server:
...
- It is likely your LDAP/AD server already has a CA certificate installed. But if not, this Microsoft KB article tells you how to do this: https://support.microsoft.com/en-us/kb/321051
Your LDAP/AD server must be running LDAPs with a third-party certification authority BEFORE performing Step 4.
- NOTE: Self signed certificates are not supported for Live Forms Online tenants
...
Email your frevvo Security Manager resource.
Provide frevvo with the IP Address or range of IP Addresses (in the case where your LDAP config is fault tolerant) of the machine(s) hosting your AD server.
...
- Wait for a reply email from your frevvo Security Manager resource letting you know that the frevvo infrastructure team has completed the white listing of your IP(s) on port 636 (ssl) in our firewall and verified connectivity.
...
|
Configuring and LDAP/Active Directory
users and groups can be maintained externally in systems such as Active Directory or Open LDAP. Follow these steps to integrate and your LDAP server:
- Collect the key information listed below and verify the Prerequisite Tasks have been performed.
- Create a tenant with the LDAP Security Manager class.
- Once you have your tenant successfully connecting with your LDAP server, review the available options regarding the authentication process.
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.
- LDAP user and groups base filters
- LDAP all users and all groups filters
LDAP the attribute names in your Active Directory for UserId Display, GroupId Display, User Member Of, Group Member, First Name, Last Name, Email and Manager (optional)
Create/Edit a tenant with 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 /wiki/spaces/frevvo80/pages/975572152for a quick way to import your current LDAP configuration parameters before migrating. The /wiki/spaces/frevvo80/pages/975572152 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.
- New in-house customers can add an LDAP tenant and configure the LDAP parameters via the Add Tenant screen. LDAP properties can be updated at anytime via 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. These instructions assume that you have an in-house installation of Live Forms up and running or you have signed up for an LDAP tenant on the cloud server.
In-house customers:
- Login to as an administrator (user:admin and password:admin if you have not changed it)
- Click on Manage and then Manage Tenants
- You will see a page where the current tenants are listed. If this is a new installation you will only see the default tenant d
- Click on the plus icon to add a new tenant.
- Configure the new tenant - Choose LDAP Security Manager.from the Security Manager Class drop down.
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Enter your LDAP Configuration Properties and Sample Configurations. 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 Oracle 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 to ignore referrals. Consult your LDAP Administrator for the details.
- If you are creating a new tenant:
- Enter a tenant id, a tenant name and description.
- The Max Concurrent Users is the maximum allowed by your license or less.
- Specify the LDAP User ID that will have the tenant admin permission.
- Click Submit. You will see your new tenant in the tenant list if the connection to your LDAP server is successful.
Warning |
---|
The Ignore Case and Notify checkboxes are checked by default. It is recommended that you leave them checked. Refer to Mixed or Upper case User Names topic for an explanation of the Ignore Case option. The Notify checkbox determines whether the task notification emails setup in flows are sent or not. |
Clicking the submit button tests the connection. Any errors are displayed at the top of the form. Here is an example of an error when there is a typo in the LDAP server name:
Here is another example if the connection password is not correct
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 and Sample Configurations
These are the properties used to configure the LDAP/Active Directory security manager. The properties in bold are required.
Property | Description | Active Directory Sample Configuration | OpenLDAP Sample Configuration |
---|---|---|---|
Connection URL | ldap server url | In-house ldap://[your server]:[port, typically the default is 389 ] Cloud - SSL installed on your LDAP server ldaps://[your server]:[port, typically the default is 636] | In-house ldap://[your server]:[port, typically the default is 389] Cloud -SSL installed on your LDAP server ldaps://[your server]:[port, typically the default is 636] |
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. Ex: an entry of TEST\Administrator refers to the user Administrator in the TEST domain. | [user name] | cn=admin,dc=test,dc=frevvo,dc=com |
Connection Password | Password for the Connection user. | [user password] | [user password] |
Users Base | Searches for users will start from the ldap node specified by this property.I f the value is empty the searches will start from the root domain. | CN=Users,DC=test,DC=windows,DC=frevvo,DC=com | DC=test,DC=frevvo,DC=com |
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 | CN=Users,DC=test,DC=windows,DC=frevvo,DC=com | DC=test,DC=frevvo,DC=com |
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. | sAMAccountName | uid |
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. | sAMAccountName | entryDN |
Notify checkbox | Notifications are emails sent by frevvo to workflows participants. If checked, notifications will be sent. | Check the Notifications checkbox | Check the Notifications checkbox |
All Groups Filter | The expected value is an LDAP filter expression. The expression should return the groups that will have access to frevvo forms and workflows. | (objectClass=group) | ( | (objectClass=groupOfUniqueNames)(objectClass=organizationalRole)) |
All Users Filter | The expected value is an LDAP filter expression. The expression should return the users that will have access to frevvo forms and work flows. | (objectClass=user) | (objectClass=person) |
User Member Of | Attribute on a user object storing the groups the user is a member of. | memberOf | " " |
Group Member | Attribute on a group object storing the users that are a member of this group. | member | uniqueMember |
First Name | Name of the user ''first name'' attribute | givenName | cn |
Last Name | Name of the user ''last name'' attribute. | sn | sn |
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. It can also be used in flow navigation using the subject.reports.to data available in . | manager | manager |
Ignore Case checkbox | If checked, ignores the case stored in LDAP systems. This is primarily for the purpose of determining roles. | Check the Ignore Case checkbox | Check the Ignore Case checkbox |
Custom | This is a a comma separated list of attribute names to be retrieved from the LDAP Server. | Ex: carLicense,employeeNumber | Ex: carLicense,employeeNumber |
TLS | This enables simple authentication over TLS. If checked, a trusted certificate for the LDAP server is required. Refer to the secure the connection topic for details. | Check if you are using TLS to secure the connection. | Check if you are using TLS to secure the connection |
...
In this case, the server and the Active Directory server are running on the same machinenetwork. The user is already authenticated to the windows network and points the browser to:
...
In this case, the server and the Active Directory server are running on different machinesnetworks. The user is trying to hit the URL below from outside the network.
...
The first issue occurs when the user logs in. For instance, John Stevens LDAP account is JStevens but he logs in as jstevens, he will be recognized by case insensitive LDAP and thus granted access but will not be recognized as a designer or as a tenant admin by . To solve this, check the Ignore Case checkbox on the LDAP Configuration screen. To prevent issues you could always login to using lower case jstevens. LDAP will grant access as it is case insensitive and will know that you may have the designer or admin special permission. However users can forget to do this. Setting Ignore Case in your LDAP security configuration will solve this.
The second problem is in directing tasks to users if your LDAP user names are mixed case. One solution is to use hidden controls on your forms with rules to convert the case of user names to lower case. The example below shows two text controls on a form, one visible, EmployeeMixedCase, and the other hidden, Employee.
...