Section | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Integrating Live Forms with 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.
- The root distinguished names for both group and user searches.
Configuration Steps
- Stop .
- In a text editor, open <frevvo-home>/tomcat/conf/Catalina/localhost/frevvo.xml.
- You can edit the LDAP Configuration Properties. Alternatively, you can start off from one of the sample configurations and provide only the key information listed above.
- Log into your LDAP Server and add a new group, frevvo.TenantAdmin
- Assign the frevvo.tenantadmin group to one or more users for tenant admin privilege.
- Start
- Login to as a 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 sign (+) to add a new tenant.
- Configure the new tenant:
- In the drop down Security Manager Class choose LDAP/Active Directory Security Manager. If your version does not have a drop down, enter the following in the in the text box: com.frevvo.security.ldap.LDAPSecurityManager.
- Give it a tenant id. For the sake of this document lets assume you call it MYLDAP. Provide the 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.
Note |
---|
There are four special roles in : frevvo.Designer, frevvo.Publisher, frevvo.ReadOnly . Groups for each role must be specified on your LDAP/AD Server if you have users that will be assigned these roles. The group names must be frevvo.Designer, frevvo.Publisher, frevvo.ReadOnly . Upper/lower case may be a factor for Open LDAP systems. |
Check if the configuration is correct
Here are some quick tests to check if the LDAP configuration is correct:
- Login as the admin or the tenant admin for the LDAP tenant.
- Click on the icon manage users/roles for the LDAP tenant you created.
- Click Manage Users.
- Click All. You should see a list of LDAP users.
- Now, click Back To Manage Tenant.
- Click Manage Roles. You should see a list of groups.
- Log out from (you should be currently logged in as admin)
- 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 you should log in as john@MYLDAP. The password would be john's password in LDAP.
Info |
---|
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 |
Live Forms and LDAP Use Cases
Single Sign On with Live Forms, IIS and Active Directory
In this scenario, a user authenticates to his windows account and tries to use . Since the user is already authenticated to the network, will recognize his credentials and automatically forward the user to his account, if he is a designer, or allow the user to use a form/flow if those resources are available to the tenant.
The basic deployment is IIS fronting and the authentication is done against LDAP. For that to work you need:
- Install Live Forms
- Configure Live Forms to work with IIS
- Configure Windows Authentication
- In IIS, Make sure that Anonymous Authentication or Basic Authentication is NOT configured in the Web Application (Default Web) that will be used to proxy requests to .
- Go though the LDAP configurations described in the beginning of this document.
Please also refer to the force auth property for forms and flows. Force auth lets you override SSO for an individual form or flow.
Once all is configured and running it is possible to test these scenarios:
Signing in from within the network
In this case the user is already authenticated to the windows network and points the browser to:
Code Block | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||
|
Prerequisites
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
Warning |
---|
Active Directory Customers using LDAP must ensure that frevvo.User, 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.
|
Integrating Live Forms with 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.
- The root distinguished names for both group and user searches.
Configuration Steps
- Stop .
- In a text editor, open <frevvo-home>/tomcat/conf/Catalina/localhost/frevvo.xml.
- You can edit the LDAP Configuration Properties. Alternatively, you can start off from one of the sample configurations and provide only the key information listed above.
- Log into your LDAP Server and add a new group, frevvo.TenantAdmin (case sensitive)
- Assign the frevvo.TenantAdmin group to one or more users for tenant admin privilege.
- Start
- Login to as a 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 sign (+) to add a new tenant.
- Configure the new tenant:
- In the drop down Security Manager Class choose LDAP/Active Directory Security Manager. If your version does not have a drop down, enter the following in the in the text box: com.frevvo.security.ldap.LDAPSecurityManager.
- Give it a tenant id. For the sake of this document lets assume you call it MYLDAP. Provide the 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.
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. |
Check if the configuration is correct
Here are some quick tests to check if the LDAP configuration is correct:
- Login as the admin or the tenant admin for the LDAP tenant.
- Click on the icon manage users/roles for the LDAP tenant you created.
- Click Manage Users.
- Click All. You should see a list of LDAP users.
- Now, click Back To Manage Tenant.
- Click Manage Roles. You should see a list of groups.
- Log out from (you should be currently logged in as admin)
- 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 you should log in as john@MYLDAP. The password would be john's password in LDAP.
Info |
---|
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 |
Live Forms and LDAP Use Cases
Single Sign On with Live Forms, IIS and Active Directory
In this scenario, a user authenticates to his windows account and tries to use . Since the user is already authenticated to the network, will recognize his credentials and automatically forward the user to his account, if he is a designer, or allow the user to use a form/flow if those resources are available to the tenant.
The basic deployment is IIS fronting and the authentication is done against LDAP. For that to work you need:
- Install Live Forms
- Configure Live Forms to work with IIS
- Configure Windows Authentication
- In IIS, Make sure that Anonymous Authentication or Basic Authentication is NOT configured in the Web Application (Default Web) that will be used to proxy requests to .
- Go though the LDAP configurations described in the beginning of this document.
Please also refer to the force auth property for forms and flows. Force auth lets you override SSO for an individual form or flow.
Once all is configured and running it is possible to test these scenarios:
Signing in from within the network
In this case, the server and the Active Directory server are running on the same machine. The user is already authenticated to the windows network and points the browser to:
Code Block | ||
---|---|---|
| ||
http://[server]/frevvo/web/tn/[LDAP tenant]/login |
Substitute LDAP tenant above with the tenant name you configured with the LDAP Security Manager. The server variable should be the ip address of the machine where IIS is installed .
The user will automatically authenticate to . It is crucial that the LDAP user is known to , in other words, the user should be one of the entries retrieved by the LDAP expression configured in the property com.frevvo.security.ldap.allUsersFilter in frevvo.xml.
Signing in from outside the network
In this case, the server and the Active Directory server are running on different machines. The user is trying to hit the URL below from outside the network.
Code Block | ||
---|---|---|
| ||
http://[server]/frevvo/web/tn/[LDAP tenant]/login |
Substitute Substitute LDAP tenant above with the tenant name you configured with the LDAP Security Manager and the server variable with the ip address of the machine where IIS is installed.
The user will automatically authenticate to . It is crucial that the LDAP user is known to , in other words, the user should be one of the entries retrieved by the LDAP expression configured in the property com.frevvo.security.ldap.allUsersFilter in frevvo.xml.
Signing in from outside the network
Very similar to the case above but in this case the user is trying to hit the URL below from outside the network.
Code Block | ||
---|---|---|
| ||
http://[server]/frevvo/web/tn/[LDAP tenant]/login |
Since the user is not authenticated in the windows Network, he will be prompted by the browser for credentials. IIS will authenticate the user in the network and forward the request to . The user will be automatically redirected to his initial page without having to re-enter his credentials.
Configure frevvo.internal.baseurl in frevvo.xml for LDAP SSO
This parameter is needed in frevvo.xml for various activities like accessing ACL page , publishing templates , resetting tasks etc. Let's say you have a browser signed in via SSO to machine m1 (port 80). IIS is running on m1 (port 80) redirecting /frevvo/web to frevvo running on m2:8082. The browser submits form to m1, IIS redirects to m2:8082. The doc action is a frevvo:// URI which gets resolved to http://m1/frevvo/... POSTs to this URI but m1 rejects the POST since it is not authenticated.
To avoid situations such as these, set frevvo.internal.baseurl to the actual host:port of the server. Follow these steps:
- edit <frevvo-home>/tomcat/conf/catalina/localhost/frevvo.xml
- Add the parameter shown below with your information: Save the changes to the file.
Code Block |
---|
Parameter name="frevvo.internal.baseurl" value="http://<ip of the m/c where frevvo server is hosted>:<port>" override="false"/>
|
Since the user is not authenticated in the windows Network, he will be prompted by the browser for credentials. IIS will authenticate the user in the network and forward the request to . The user will be automatically redirected to his initial page without having to re-enter his credentials.
Configure frevvo.internal.baseurl in frevvo.xml for LDAP SSO
This parameter is needed in frevvo.xml for various activities like accessing ACL page , publishing templates , resetting tasks etc. Let's say you have a browser signed in via SSO to machine m1 (port 80). IIS is running on m1 (port 80) redirecting /frevvo/web to frevvo running on m2:8082. The browser submits form to m1, IIS redirects to m2:8082. The doc action is a frevvo:// URI which gets resolved to http://m1/frevvo/... POSTs to this URI but m1 rejects the POST since it is not authenticated.
To avoid situations such as these, set frevvo.internal.baseurl to the actual host:port of the server. Follow these steps:
- edit <frevvo-home>/tomcat/conf/catalina/localhost/frevvo.xml
- Add the parameter shown below with your information: Save the changes to the file.
Code Block |
---|
Parameter name="frevvo.internal.baseurl" value="http:// <ip of the m/c where frevvo server is hosted>:<port>" override="false"/> |
Upload and Video Control Behavior
If your system is configured for LDAP SSO, the upload and video controls exhibit the following behaviors:
- The "uploading...." snake image displays continuously when uploading an image to an upload control in a form, accessed from a space, on a mobile device.
- The video control will ask for credentials again in use/design mode if you are using the FireFox browser. In IE9, you will see the message: " The Web-page wants to run the following add-on: 'Windows Media Player' from 'Microsoft Corporation'. What's the risk?" Enter your credentials or run the add-on to proceed.
To workaround this issue, configure IIS so that it does not require re-authentication for every single request.
Live Forms login page authenticating against LDAP
...
Can't login via the Live Forms login page
A common cause is that the distinguished name attribute is incorrect. That attribute is defined by the property com.frevvo.security.ldap.distinguishedNameAttribute. If you can't determine the distinguished name attribute for your system you can try the fall back strategy described here. Some common distinguished name attributes can be found here
Problems with Mixed or Uppercase User Names
Info |
---|
user names are case sensitive; the user name johndoe'' is not the same as JohnDoe. Several LDAP systems are case insensitive. Thus the two user names would resolve to the same LDAP account but to different user accounts. To avoid case issues follow these three steps described in more detail below:
|
The first issue is cased by the user login 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, set the property is that the distinguished name attribute is incorrect. That attribute is defined by the property com.frevvo.security.ldap.distinguishedNameAttribute. If you can't determine the distinguished name attribute for your system you can try the fall back strategy described here. Some common distinguished name attributes can be found here
Problems with Mixed or Uppercase User Names
Info |
---|
user names are case sensitive; the user name johndoe'' is not the same as JohnDoe. Several LDAP systems are case insensitive. Thus the two user names would resolve to the same LDAP account but to different user accounts. To avoid case issues follow these three steps described in more detail below:
|
...
|
...
Code Block | ||
---|---|---|
| ||
<context-param>
<param-name>frevvo.login.userid.case</param-name>
<param-value>lower</param-value>
<description>Force all login user ids to upper or lower case</description> </context-param> |
The second problem is in directing tasks to frevvo 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.
A user types a name (regardless of case) into the EmployeeMixedCase control. The hidden Employee control has a business rule that takes the value of the visible control and converts it to lowercase.
Code Block |
---|
Employee.value = EmployeeMixedCase.value.toLowerCase(); |
The form or workflow routing can then use {Employee} rather than the control that may be mixed case.
Configure frevvo.internal.baseurl in frevvo.xml for LDAP SSO
This parameter is needed in frevvo.xml for various activities like accessing ACL page , publishing templates , resetting tasks etc. Let's say you have a browser signed in via SSO to machine m1 (port 80). IIS is running on m1 (port 80) redirecting /frevvo/web to frevvo running on m2:8082. Browser submits form to m1, IIS redirects to m2:8082. The doc action is a frevvo:// URI which gets resolved to h ttp://m1/frevvo/... POSTs to this URI but m1 rejects the POST since it is not authenticated.
To avoid situations such as these, set frevvo.internal.baseurl to the actual host:port of the server. Follow these steps:
- edit <frevvo-home>/tomcat/conf/cstalina/localhost/frevvo.xml
- Add the parameter shown below with your information: Save the changes to the file.
Code Block |
---|
Parameter name="frevvo.internal.baseurl" value="http://<ip of the m/c where frevvo server is hosted>:<port>" override="false"/>
|
The first issue is cased by the user login 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, set the property com.frevvo.security.ldap.ignoreCase to true.
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. To force this configure 's web.xml parameter frevvo.login.userid.case by adding the <context-param> lines you see below. You can specify a value of either lower or upper.
Code Block | ||
---|---|---|
| ||
<context-param>
<param-name>frevvo.login.userid.case</param-name>
<param-value>lower</param-value>
<description>Force all login user ids to upper or lower case</description>
</context-param> |
The second problem is in directing tasks to frevvo 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.
A user types a name (regardless of case) into the EmployeeMixedCase control. The hidden Employee control has a business rule that takes the value of the visible control and converts it to lowercase.
Code Block |
---|
Employee.value = EmployeeMixedCase.value.toLowerCase(); |
The form or workflow routing can then use {Employee} rather than the control that may be mixed case.
Admin Search for a task locked by a user does not show all LDAP users
Although the user list from the LDAP appears correct, the user does not appear in the admin search for a task locked by a user.
- Verify that your LDAP configuration is correct.
- Check if the MaxPageSize property is set in Active Directory. Look for "MaxPageSize" on this Microsoft Support Page for reference. The default value is 1000.
Active Directory Sample Configuration
...
Code Block | ||
---|---|---|
| ||
<Parameter name="com.frevvo.security.ldap.connection.url" value="ldap://[your server]:[port, typically the default is 389 ]" override="false"/>
<Parameter name="com.frevvo.security.ldap.connection.name" value="cn=admin,dc=test,dc=frevvo,dc=com" override="false"/>
<Parameter name="com.frevvo.security.ldap.connection.password" value="[user password]" override="false"/>
<Parameter name="com.frevvo.security.ldap.usersBase" value="DC=test,DC=frevvo,DC=com" override="false"/>
<Parameter name="com.frevvo.security.ldap.groupsBase" value="DC=test,DC=frevvo,DC=com" override="false"/>
<Parameter name="com.frevvo.security.ldap.userIdDisplayAttribute" value="uid" override="false"/>
<Parameter name="com.frevvo.security.ldap.groupIdDislayAttribute" value="entryDN" override="false"/>
<Parameter name="com.frevvo.security.ldap.notifications" value="true" override="false"/>
<Parameter name="com.frevvo.security.ldap.allGroupsFilter" value="(|(objectClass=groupOfUniqueNames)(objectClass=organizationalRole))" override="false"/>
<Parameter name="com.frevvo.security.ldap.allUsersFilter" value="(objectClass=person)" override="false"/>
<Parameter name="com.frevvo.security.ldap.distinguishedNameAttribute" value="entryDN" override="false"/>
<Parameter name="com.frevvo.security.ldap.groupMemberAttribute" value="uniqueMember" override="false"/>
<Parameter name="com.frevvo.security.ldap.userMemberOfAttribute" value="" override="false"/>
<Parameter name="com.frevvo.security.ldap.firstNameAttribute" value="cn" override="false"/>
<Parameter name="com.frevvo.security.ldap.lastNameAttribute" value="sn" override="false"/>
<Parameter name="com.frevvo.security.ldap.emailAttribute" value="mail" override="false"/> |
...
LDAP Configuration Properties
These are the properties used to configure the LDAP connector. The properties in bold are required.
Property | Description |
---|---|
com.frevvo.security.ldap.connection.url | ldap server url |
com.frevvo.security.ldap.connection.name | 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. |
com.frevvo.security.ldap.connection.password | Password for the user defined in com.frevvo.security.ldap.connection.name. |
com.frevvo.security.ldap.usersBase | 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. |
com.frevvo.security.ldap.groupsBase | 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 |
com.frevvo.security.ldap.userIdDisplayAttribute | 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. |
com.frevvo.security.ldap.groupIdDisplayAttribute | 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. |
com.frevvo.security.ldap.notifications | Notifications are emails sent by frevvo to workflows participants. If ''true'', notifications will be sent. (default=true) |
com.frevvo.security.ldap.allGroupsFilter | 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 |
com.frevvo.security.ldap.allUsersFilter | 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 |
com.frevvo.security.ldap.frevvoDesignersFilter Deprecated in 4.5 | The expected value is an LDAP filter expression. This expression needs to return a list of users (not groups) that will be considered frevvo designers. Microsoft Active directory Default groups (Domain Users etc.) are not supported. |
com.frevvo.security.ldap.frevvoTenantAdminFilter Deprecated in 4.5 | The expected value is an LDAP filter expression. This expression needs to return a list of users (not groups) that will be considered frevvo tenant admins. Microsoft Active directory Default groups (Domain Users etc.) are not supported. |
com.frevvo.security.ldap.distinguishedNameAttribute Deprecated in 4.1.3 | Deprecated in 4.1.3. Name of the ''distinguished name'' attribute. |
com.frevvo.security.ldap.userMemberOfAttribute | |
com.frevvo.security.ldap.groupMemberAttribute | |
com.frevvo.security.ldap.firstNameAttribute | NameName of the user ''first name'' attribute |
com com.frevvo.security.ldap.lastNameAttribute | Name of the user ''last name'' attribute. |
com.frevvo.security.ldap.emailAttribute | Name of the user ''email'' attribute in the LDAP server. This is used in email notifications |
com.frevvo.security.ldap.managerAttribute | |
com.frevvo.security.ldap.cache - Deprecated | Enable or disable the caching of users and groups. The default value is 'true'. This property is no longer needed and can be removed. It has been deprecated. |
com.frevvo.security.ldap.ignoreCase | This makes frevvo ignore the case stored in LDAP systems, primarily for the purpose of determining roles. |