Versions Compared

Old Version 4

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

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

supports the creation of a tenant using the SAML (Security Assertion Markup Language) Security Manager. Users in this tenant can log into via  (SAML) version 2.0. SAML enables internet single sign-on by allowing users to authenticate at an identity provider and then access service providers without additional authentication.

The SAML Security manager can be used in on-premise installations but it is primarily meant for cloud tenants who use LDAP but do not want to expose it over the internet.

SAML requires the configuration and installation of an identify provider that supports SAML 2.0. Some examples are Shibboleth, OpenSSO, ADFS, and PingFederate.

In a SAMLenvironment, integration with an LDAP server for authentication is common. In general, here's how it works:

  • User A attempts to access Live forms by typing the URL into the browser
  • Live forms sends a SAML request for authentication to the Identity Provider
  • The Identity Provider requires more information. The Identify Provider login screen is displayed.
  • User A logs into the Identity Provider.
  • The Identity Provider may communicate with your LDAP server if you are using Active Directory for authentication.
  • The Identity Provider builds and sends a SAML token to Live Forms containing the security information for User A.
  • Live forms processes the information. If User A has been authenticated, Live forms establishes a session and redirects User A to the correct Live Forms screen depending on User A's authorization level.
Column
width400px

On this page:

Table of Contents
maxLevel2


Prerequisites

Authentication Only mode:

...


Info

frevvo only supports/certifies the SAML Security Manager when is running in the tomcat container. Refer to our Supported Platforms for the list of Application Servers supported/certified by frevvo.

Prerequisites

Authentication Only mode:

When you create your  SAML tenant, you can select Authentication Only mode..This is done by checking a checkbox when you configure your SAML tenant.

If Authentication Only is selected, SAML is used only for authentication. Authorization depends on the roles defined in .  SAML will authenticate the user but not retrieve any of the attributes.
You may choose to use this mode if you:

...

  •  Active Directory:
    • Customers using LDAP must ensure that the frevvo.User, frevvo.TenantAdmin and frevvo.Designer roles are specified on their LDAP/AD server. 
        • All users requiring access to  must be assigned to the frevvo.User group. 
        • Tenant admin users must be assigned to the frevvo.User and frevvo.TenantAdmin groups,
        • Designer users must be assigned to the frevvo.User  and frevvo.Designer groups.

Note

The group names for these three special roles must be frevvo.User, frevvo.TenantAdmin, and frevvo.Designer. Upper/lower case may be a factor for Open LDAP systems. 

...

  1. In-house Customers Only
    1. Generate Your Certificate
    2. Install the Java Cryptography Extension API
  2. Create the frevvo Metadata file.
  3. Configure your Identity Provider
  4. Create/edit the SAML tenant
  5. Manage Users/Roles for your SAML tenant
  6. Logging into Live Forms in a SAML Tenant

Step 1 - In-house Customers Only

Cloud customers can skip the Generate Your Certificate and Install the Java Cryptography steps. These instructions are provided for On-premise customers only.

Generate Your Certificate

If you re using the frevvo tomcat bundle, the supplied keystore, frevvoKeystore.jks is located in the <frevvo-home>/tomcat/lib folder, The keystore contains a default certificate with alias=frevvo and password=p@ssw0rd. Replace this  with a certificate for your installation.

...

  1. Paste this URL into your browsr:

    1. Cloud Customers: https://app.frevvo.com:443/frevvo/web/saml/metadata/alias/{t} - replace {t} with the tenant id of your SAML tenant.

    2. On-premise customers: http://<server>:<port>/frevvo/web/saml/metadata/alias/{t} - replace <server> with the ip of your server, <port> with the port number (if applicable) and t with your tenant id).

  2. When the metadata displays, right click and select the browser option to View the Page source.



  3. Save the page as an xml file.
  4. Metadata must be generated for each SAML tenant. Each tenant will have a unique URL.

Step 3 - Configure Your Identity Provider

  1. Configure the Service Provider metadata for your Identity Provider. For example, the Shiboleth Identity provider requires modification of a file to provide the path to the tenant metadata xml file created above.
  2. Your Identity Provider must be configured to expose the attributes that requires. Attribute mapping is done when you create the SAML tenant. These are:
    1. User Id
    2. First Name
    3. Last Name
    4. Email
    5. Manager Id (optional)
    6. Groups
    7. Custom Attributes (optional)

We know that your IDP software of choice is outside of the frevvo server software and that you have the expertise in house to install, configure and maintain your IDP software. But here are some tips we have found that may assist you.

Expand
titleClick here for some tips when configuring ADFS
Warning

The information below applies to ADFS v2.0. If you are using a different version, your ADFS expert must locate the equivalent functions for that version.

  1. Save the frevvo tenant metadata as an xml file. Add Relying Party Metadata Trust. Use the 'Import data about the relying party from a file' option to upload the saved xml file.

  2. In Edit Claim Rules, create a rule to map AD attributes to the outgoing claim type as shown below.  Information about creating rules to send LDAP attributes as Claims can be found on this Microsoft support website

    1. samAccountName to NameID - If you rather generate an opaque identifier, you would need to create custom rules as described here.
    2. samAccountName to Windows Account Name
    3. givenName to Given Name
    4. Surname to Surname
    5. emailAddresses to Email Address

    6. Group membership is added using the wizard. Select Token-Groups Unqualified Names and map it to the Group claim.

  3. Extract the Manager's samAccountName. This can be done using the following 3 custom claim rules. This rule assumes that the CN of the manager DN contains the samAccountName:

    Code Block
    c:[Type == "http://schemas.microsoft.com/ws/2008/06/identity/claims/windowsaccountname", Issuer == "AD AUTHORITY"]
=> add(store = "Active Directory", types = ("http://schemas.xmlsoap.org/ws/2005/05/identity/claims/ManagerDN"), query = ";Manager;{0}", param = c.Value); 

Manager SAM1
c:[Type == "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/ManagerDN"]
=> add(Type = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/ManagerSam", Value = RegExReplace(c.Value, ",[^\n]*", ""));

ManagerAccountName
c:[Type == "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/ManagerSam"]
=> issue(Type = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/manageraccountname", Value = RegExReplace(c.Value, "^CN=", ""));

  4. In the tenant, map the attributes as shown: Refer to this website for more information about Claims.
     

    AttributeValue
    User Idhttp://schemas.microsoft.com/ws/2008/06/identity/claims/windowsaccountname

    First Name 

    		http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname
    Last Namehttp://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname
    Emailhttp://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
    Manager User Idhttp://schemas.xmlsoap.org/ws/2005/05/identity/claims/manageraccountname
    Roleshttp://schemas.xmlsoap.org/claims/Group
  5. It is recommended that you turn on tracing in ADFS, so that the SAML response is visible. Compare the names of the attributes contained in the response to the names of the attributes configured on the tenant screen. If turning on ADFS tracing is not an option, the frevvo log can be searched for the name attribute values.

Configure Custom Attributes

Active directory attributes other than the standard First Name, Last Name or Email are considered custom attributes. You can retrieve custom attributes in addition to the standard ones from Active Directory and pull the data into your form/flow using Live Forms business rules.
For example,let's say you want to extract the custom attribute, StaffId, from LDAP and populate fields in your form/flow using a business rule.

Perform these general steps:

  1. Make sure the custom attribute, in our example StaffID, is configured in Active Directory and assigned to the correct users.
  2. Expose StaffID as a SAML attribute by writing an ADFS claim rule.
    1. During this process, you assign the attribute a name, e.g. http://schemas.xmlsoap.org/ws/2005/05/identity/claims/staffid
  3. Map the attribute with this name in the Custom section of the tenant setup screen. Save the tenant configuration.



  4. Here is an example of a business rule that references the custom attribute, Staff Id, and populates a field in a form named StaffID.

    Code Block
    if (form.load) {
  StaffID.value =  _data.getParameter('subject.http://schemas.xmlsoap.org/ws/2005/05/identity/claims/staffid');
}


    Refer to Retrieving Custom Attributes from LDAP in a SAML Tenant for another example.

Expand
titleClick here for instructions to configure Google Apps as the SAML IDP

Follow these steps to setup Google as the Identity Provider and Live Forms as the Service Provider to configure Single Sign On. These instructions are for Cloud. On-Premise customers follow the same steps with one additional step to generate a certificate:

  1. On - Premise customers ONLY: Generate a certificate. 
  2. Configure Google as the Identity Provider
    1. Login to your Google domain as an admin, go to the admin portal and click through to Apps > SAML Apps. If you have any existing SAML apps, you’ll see them here. Click the big PLUS (+) sign at bottom right to add a new one. A wizard will appear.
    2. Click the “Setup My Own Custom App” link at the bottom of the screen.



    3. Choose Option 2 and Download the IDP metadata file.



    4. Provide a name for your application, a description and a logo.



    5. Enter the Service Provider () details.
      1. For ACS URL, type https://app.frevvo.com:443/frevvo/web/saml/SSO/alias/{tenant} - replace {tenant} with your cloud tenant.
      2. For Entity Id, type https://app.frevvo.com:443/frevvo/web/alias/{tenant} - replace {tenant} with your cloud tenant.
         
      For example, https://app.frevvo.com:443/frevvo/web/saml/SSO/alias/ashish-saml.com
    6. Leave the built-in Name Id attribute configuration alone.



    7. Add a new Attribute Mapping: User Id | Basic Information | Primary Email



    8. Click Finish. The Setup Complete screen displays.
    9. Click OK.
    10. Your new SAML App will be displayed. Click the three dots at right and turn ON SSO. You can choose to turn it ON for everyone in your domain or for specific sub-domains.



  3. Create users in Google:
    1. Create your users in Google or move existing users into the appropriate sub-organization if you are limiting access to your SAML app in Google. You won’t have to create new users or move existing users if you enabled the SAML app for everyone in your Google domain.
    2. you’ll need a user in your Google domain to serve as the tenant administrator. Either, create a new one or choose an existing one (there’s nothing to do as long as you choose someone).

  4. Create users in :

    1. You need to ensure that the user you chose/created as the tenant admin exists in frevvo. Once we switch over to SAML, all authentication will use Google Apps credentials and you won’t be able to login using your current tenant admin or other users. We’ll use CSV upload. The file syntax looks like this:

      Code Block
      userId,tenant,password,firstName,lastName,email,enabled,reportsTo,roles,transaction
 {user}@{domain},{tenant},123,{first},{last},{email},true,,frevvo.Designer|frevvo.TenantAdmin,

      The fields are your Google login (e.g. prajakta.deshmukh@frevvo.com), your frevvo tenant id (e.g. ashish-saml.com), any password (it is not used), the first name, last name and email address. In the roles field, use the roles indicated above.

    2. Login as the current tenant admin user.
    3. Click on Manage Users.
    4. Click on Download CSV users file.
    5. Edit the file to setup at least one Google User (the one you chose/created as the tenant admin).
    6. Click on CSV Upload (the Excel looking icon) and upload the file to create this user.

  5. Configure  as the Service Provider:
    1. Generate the SP metadata file from frevvo. Visit the URL: https://app.frevvo.com:443/frevvo/web/saml/metadata/alias/{tenant} in your browser. Replace {tenant} with your cloud tenant. Right click to View Page Source and save as an XML file.
    2. Login to your Cloud account as tenant admin and click the Edit Tenant button.
    3. In the Security Manager section, click the Change button, choose SAML in the drop down that appears and click Ok. NOTE: Free Trial accounts do not show the Change button. If the Change button is not visible in your tenant, please contact customer support.
    4. The SAML configuration section will appear. In the Service Provider section, we must paste the SP metadata file we generated in Step 1 above. Unfortunately, the file contains an XML prolog (highlighted in the image below) which must be removed. Paste the contents of this SP metadata file without the prolog into the Service Provider text area of the configuration form.
    5. In the Identity Provider section, paste the IDP metadata file we generated and saved in the Google setup above. Once again, the file contains an XML prolog. Paste the contents of this IDP metadata file without the prolog into the Identity Provider text area of the configuration form.
    6. Check Authentication Only. This means SAML will authenticate the user but not retrieve any of the attributes. Users are not automatically discovered upon first login. Therefore, you must create users & roles using CSV upload.
      • If you do not wish to select the Authentication Only option, you’ll need to map other attributes in Google first before you can assign them in Frevvo. First Name, Last Name, and Email should be pretty straight forward since these attributes are surfaced by the Google SAML IdP app. The other attributes may be more difficult.
    7. With the Authentication Only option, attribute mapping only includes one attribute, the User Id. Since we mapped the email address to the User Id attribute in Google while setting up the SAML app, we can simply map the frevvo attribute to User Id in the configuration form.

    8. Submit the form and we’re done.

      Section
      Column
      width25%

      Edit tenant.

      Column
      width25%


      Setup SAML

      Column
      width25%


      SP Metadata (paste without XML Prolog)

      Column
      width25%

      IDP Metadata (paste without XML prolog)

  6. How to use your new SAML tenant
    1. Logout of all your Google accounts to test.
    2. Go to the tenant URL: https://app.frevvo.com:443/frevvo/web/tn/{tenant}/login. Replace {tenant} with your tenant id.
    3. You will be redirected to the Google login page.
    4. Login to Google as the Google user you chose/created as the tenant admin.
    5. You will be redirected to frevvo to the Manage Tenant screen.

    The user id displayed in frevvo at the top will look like {user}@{domain}@{tenant} which is a bit confusing but is purely cosmetic.




  7. Load other users in frevvo

    Before your other Google users can login to  using their Google Apps credentials, they must first be created in frevvo. You can download users from Google Apps as a CSV file (uncheck the create a Google Sheet option), modify it to follow frevvo’s syntax as shown above and upload it. You can also login as the tenant admin Google user and create users and roles using the UI.

    Once the user exists in frevvo, he/she can login using Google credentials and the system will behave as expected according to the roles assigned to the user.

Step 4 - Create/edit the SAML tenant

To successfully create a tenant using the SAML Security manager, you will need the following:

  metadata file

  • The metadata for your Identity Provider
  • Attribute mapping information  

cloud customers, migrating your tenant to the SAML Security Manager, will make the changes via the Edit Tenant screen. Once accessed, follow these steps beginning with step 2.

 Log onto as the superuser (on-premise) or the tenant admin (cloud).

  1. Access the Add Tenant (on-premise) or Edit Tenant (cloud) screen.
  2. Select SAML Security Manager from the Security Manager Class dropdown.
  3. Copy the Service Provider (frevvo) metadata into the Service Provider field. The xml should be pasted without the prolog. For example, the image shows an example of the frevvo metadata file before pasting:



  4. Retrieve the metadata for your Identity Provider. For example, for the Shiboleth product the metadata is located in the idp-metadata file.

  5. Paste the metadata into the Identity Provider field. This metadata should also be pasted without the prolog.
    Image Removed
    Image Added

  6. Check the Ignore Case checkbox if you are using LDAP for authentication and you want to ignore the case stored in LDAP systems for users/roles. It is checked by default. Refer to the Mixed or Upper case User Names topic for more information.

  7. Check the Authentication Only checkbox if you want SAML to handle authentication and provide user identification but all other user attributes come from the  database.

    When checked, the screen display changes as attribute mapping, other than the mapping for the user id and custom attributes, is no longer necessary.

    Image Modified

    Note

    Authentication Only:

    • If Authentication Only is checked:
      • SAML will authenticate the user but not retrieve any of the attributes. Authorization depends on the roles defined in . Changes made in the UI will not be overridden if the user logs out and then logs in again.
      • Manual creation of users & roles in the SAML tenant is required. This can be done with a csv upload.

    • If Authentication Only is unchecked:

      • All users requiring access to must be assigned to the frevvo.User group in Active Directory. Tenant Admins must be assigned to the frevvo.User and frevvo.TenantAdmin groups. Designer users must be assigned to the frevvo.User and frevvo.Designer groups.

      • Users are added (discovered) when they log in. 
      • It is important to know that a SAML tenant in this mode (SAML/LDAP handles authentication and authorization) that users and tenant admins can modify user information in the UI. If user information/role assignment is changed in the UI, the changes will be overwritten by the information in SAML the next time the user logs out and then logs back in again. In this case, make the changes in your Active Directory to make them permanent.

  8. Map the attributes configured in your Identity Provider by entering the name for each attribute in the corresponding field on the screen. Be sure to provide the attribute name - not the friendly name. For example, if you are using Shibboleth for your Identity Provider the attribute information is located in the attribute-resolver.xml file. The image shows the section of the file where the attributes are defined.


    The image below shows the attribute mapping on the screen with the attribute names from the Shibboleth file:



    Note

    If Authentication Only mode is enabled for your tenant, mapping is only required for the User Id. Refer to step 8 for the details

  9. Custom attributes can be mapped by typing the attribute names in the Custom field separated by a comma.
  10. Configure a tenant admin account. This account  does not require SAML authentication. This tenant admin can log directly into providing a default security manager backdoor.
    1. The tenant admin id, password and email fields are required.
    2. When this tenant admin performs a form based login i.e. /frevvo/web/login, the password entered on this screen is used for authentication. This is also the URL used by the API.
    3. If the tenant based login url is used i.e. /frevvo/web/tn/{t}/login then SAML login is used.



    The forgot password function works for a SAML tenant admin user. For all others, it will display the error message about not being supported for the tenant.



  11. Configure the Business Calendar for your tenant and HTTP Authorization Credentials if required.
  12. Click Submit.

...

SAML Tenant backdoor admin user

Just a reminder that the tenant admin account can login directly into or use the SAML login.

When you create a new tenant you are prompted to set up a tenant admin user id and password. If you are using a SAML IDP, this tenant admin does not authenticate via your SAML IDP. It only exists in . If you experience an issue with your SAML configuration such that you can't login as a SAML authenticated user, this account provides a backdoor you can use to login to your tenant as a tenant admin in order to fix your SAML configuration issue. Only one backdoor tenant admin account is supported.

Image Modified

If your tenant originally used the Default Security Manager and then you changed to the SAML Security Manager, this tenant admin account has already been setup. If you have forgotten the password, you can change it by :

  • Using the Forgot Password? feature for the tenant admin account.
  • Logging in as a SAML authenticated tenant admin and changing the password via Manage Users.

What if you do not remember the userid of your original tenant admin? Follow these steps:

...

Accessing a Space in a SAML tenant on a mobile device will not display a logout button.

Session Timeout

Session timeouts are configured in and in your IDP. If a user's session ends before the IDP timeout is reached, they will automatically be logged back into if they try to access it again. It is recommended that the session timeout and the IDP session timeout be configured for the same value.

Embedding Forms/Flows in your website

Embedding forms and flows into your website when using the SAML Security Manager, will work in the following scenarios :

Info

Embedding forms and flows into your website is NOT supported if the the visibility of the form is set to Public in Tenant and the user is NOT already authenticated to SAML. This is because frevvo must direct the user to the IDP login screen and the browser will not allow loading the IDP login page in frevvo's form iframe.

Troubleshooting Tips

Login fails with illegal Key Size Error

...

  1. Make sure Authentication Only is unchecked in your SAML tenant.
  2. Make sure the custom attribute(s) are configured in Active Directory and assigned to the correct users.

  3. Configure and release the custom attributes as SAML attributes in your IDP.  

    Tip

    The procedure to expose custom attributes will differ depending on the IDP you have selected. Refer to your IDP documentation or your on-staff IDP expert to complete this step.

  4. Map the attribute with this name in the Custom section of the tenant setup screen.
    1. You can do this when you are creating your SAML tenant or by accessing the Edit Tenant link, after signing on as the tenant admin of your existing SAML tenant.
  5. Save the tenant configuration.
  6. Write a business rule to populate controls in your form/flow with the information.

Example:

Let's take a look at a installation using a SAML tenant, Shibboleth as the IDP and Active Directory for authentication. When the user logs into the SAML tenant, you want to populate these fields in your form with the information from the LDAP server:

These attributes must be configured and released in your IDP. The process to expose the attributes varies for each Identity Provider. In our example, which uses the Shibboleth IDP, configuration and release of the attributes is done in two files, attribute-resolver.xml and attribute-filter.xml. You may need to confer with your on-staff IDP expert to complete this step.

...