Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Configuring the LDAP/Active Directory Security Manager

The connection to your LDAP server is configured at the tenant level. Existing

Frevvoproduct
in-house customers using LDAP should refer to the  Upgrade Guide for a quick way to import your current LDAP configuration parameters before migrating.
Frevvoproduct
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

Frevvoproduct
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

Before configuring the LDAP/Active Directory Security Manager, you will need the following information:
  • 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 
    Frevvoproduct
     designers. These users will be able to create forms and flows in frevvo.
  • LDAP groups and users that will be considered 
    Frevvoproduct
    administrators.
  • LDAP groups and users that will be considered 
    Frevvoproduct
    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

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.
  • Log into your LDAP Server and add a new group, frevvo.TenantAdmin (case sensitive)
  • 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

    Frevvoproduct
    : 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. 

  • In-house customers:
  • Login to 
    Frevvoproduct
    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 Image Removed plus icon to add a new tenant.
  • Configure the new tenant: Choose LDAP/Active Directory Security Manager.from the Security Manager Class drop down.
    Image Removed
  • 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

    Frevvoproduct
    to ignore or follow referrals.

    Setting the java.naming.referral property to a value of "ignore" in the Name/Value table configures

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

  • 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.
  • Cloud customers:
      1. Contact frevvo to create an LDAP/Active Directory tenant. Login with the id and password information provided by frevvo.
      2. Click on the Edit tenant link
      3. Edit the LDAP Configuration Properties. Replace the default values with values for your LDAP server.
      4. 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.

     

    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:
     
    Image Removed
    Here is another example if the connection password is incorrect:
    Image Removed

    Check if the configuration is correct

    Here are some quick tests to check if the LDAP configuration is correct:

    1. Login as the 
      Frevvoproduct
      tenant admin for the LDAP tenant.
    2. Click on the Manage Users link.
    3. Click All. You should see a list of LDAP users which were assigned one of these
      Frevvoproduct
      roles on the LDAP server: frevvo.TenantAdmin, frevvo.Designer, frevvo.Publisher, frevvo.ReadOnly
    4. Now, click Back To Manage Tenant.
    5. Click Manage Roles. You should see a list of groups from your LDAP server.
    6. Log out from 
      Frevvoproduct
       (you should be currently logged in as the tenantadmin)
    7. 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

    Frevvoproduct
    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

    Frevvoproduct
    will be connecting to your LDAP server over the network. Here are two methods to secure the LDAP connection:

    1. 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.
    2. 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

    Frevvoproduct
    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 

    Frevvoproduct
     can access and trust. Follow the instructions for your keystore. If 
    Frevvoproduct
     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 URLldap 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 PasswordPassword for the user defined in com.frevvo.security.ldap.connection.name.
    Users BaseSearches 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 BaseSearches 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 checkboxNotifications 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 OfAttribute on a user object storing the groups the user is a member of.
    Group MemberAttribute on a group object storing the users that are a member of this group.
    First Name

    Name of the user ''first name'' attribute

    Last NameName 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
    ManagerAttribute 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
    Frevvoproduct
    .
    Ignore Case checkboxIf checked, 
    Frevvoproduct
    ignores the case stored in LDAP systems, primarily for the purpose of determining roles.
    CustomThis is a a comma separated list of attribute names to be retrieved from the LDAP Server.
    TLSThis 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

     Email

    mail

    mail

    Manager

    manager

    manager 

    Ignore CasCheck the Ignore Case checkboxCheck the Ignore Case checkbox
    CustomcarLicense, employeeNamecarLicense
    TLSCheck to secure the connection using TLSCheck to secure the connection using TLS

    ...

    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 Azure SAML Security Manager

    Creating/editing the Azure SAML tenant is performed by the superuser (on-premise) or the tenant admin (cloud). Refer to Configuring the Azure SAML Security Manager for the details.

    ...