SAML 2.0 Terminology

• Identity Provider (IdP) – Software that provides Authentication Service and uses SAML 2.0 protocol to assert valid users.
• Service Provider (SP) – Software that trusts an Identity Provider and consumes the services provided by the Identity Provider.
• SAML Metadata XML – An XML document containing SAML2.0 configuration data.
• SAML Assertion XML – An XML document that provides information about a user authenticated by an IdP.

Set

Up SAML 2.0 SSO

The following highlights the steps needed to integrate any SAML 2.0 IdP with an

Note:

Prerequisites

Anchor
configureagiloft configureagiloft

Configure

Companyname

Follow these steps in

1. Log in to your

   Companyname

   knowledgebase as an admin user and navigate to Setup > Access.
2. Click the Setup gear in the top-right corner and click Access.
3. Click Configure SAML 2.0 Single Sign-on to open the SAML Configuration wizard.
4. On the General tab:In the pop-up window...
   1. Select the Enable SAML SSO checkbox. 
   2. Optionally, select the checkbox to "Create SAML IdP Authenticated user in

      Companyname

      " checkbox. This will create creates users in

      Companyname

       from those in the SAML system when the connection is first established. If this or the next option is selected, the User Field(s) Mapping tab will appearappears when you click Next. 
   3. Optionally, select "Update User fields on subsequent logins by an existing user." This will update updates the mapped user fields from SAML whenever the user logs in. If this option is selected, the User Field(s) Mapping tab will appearappears. 
   4. If the "Create SAML IdP Authenticated user" or "Update User fields on subsequent logins by an existing user" options were selected, choose a Persons table or subtable to map user fields from SAML to 

      Companyname

      . 
5. User Group Mapping tab: Select any default Groups for the new SAML user, or map the user's group from an attribute in their SAML profile, at creation and on subsequent logins. You can set up user mapping after the initial configuration, too.
6. User Team Mapping tab: Select any default Team for the user, or use IdP or SAML attributes to define the team, at creation and on subsequent logins. 
7. User Field(s) Mapping tab: If this tab is open, create the mappings between the SAML attributes and the field names of the Persons table in 

   Companyname

   .  By default, this tab shows all of the field names of a user's record which can be mapped to SAML attributes. If you only want a specific set of field names to appear for mapping, you can restrict which fields appear using the List of fields from 'contact' table/subtable to be used in SAML configuration global variable.

8. Anchor
   serviceprovidertab serviceprovidertab

   The Service Provider Detailstab contains information to connect to 

   Companyname

   as the Service Provider. Hosted customers must contact support to enter the provider details on this tab. Enter thefollowing information:

   1. Companyname

      (SP)
   AnchorserviceprovidertabserviceprovidertabThe Service Provider Detailstab contains information to connect to 

   Companyname

   as the Service Provider. Hosted customers must contact support to enter the provider details on this tab. Enter thefollowing information:

   1. Companyname

      (SP) Entity Id: Enter a unique identifier string for the

      Companyname

      KB. Use the same identifier when configuring the Identify Provider. The system will automatically populate populates this field with a value of {server}/{KBName}, e.g. example.agiloft.example.com/mykb. Replace any spaces in the Entity Id with the plus (+) symbol.

   2. SAML V2 SAML V2 Assertion Consumer Service (ACS) Endpoint: The value in this field should be in the form:

      Code Block
      http(s)://{server}/gui2/spsamlsso?project={KBName}

      Write down these two values—they will be used to configure your Identity Provider (IdP). Make sure to use the domain name for your server, such as example.agiloft.com, rather than the specific server hostname, such as ps108.agiloft.com. 

   3. Java Key Store (JKS) details. The Private Keys for HTTPS communication with

      Companyname

      are stored in the Java Key Store (JKS) file on the

      Companyname

      Server. The same Key pair will be used to digitally sign the SAML XML exchanged between the

      Companyname

      server and IdP. For more assistance, see: Generate a Keystore File. Enter the following values:

      1. Java Keystore (.jks) file path on the

         Companyname

         Server. Configurations vary by server. The default path for

         Companyname

         servers is /opt/server/Agiloft/etc/certs/agiloft.keystore

      2. Java KeyStore Password.

      3. Alias used to add certificate to Java KeyStore.

   4. Name identifier in SAML Assertion sent by IdP: In SAML 2.0 protocol, the NameID XML tag is used to send the details of the authenticated user in the SAML Assertion XML sent by an IdP to the service provider. From the drop-down, specify which format your IdP uses: User Name, Email, or Federation ID.

      

      Then, select the field name in the People table that will be matched to match against the NameID value. If the NameID value in the XML assertion matches the value of the chosen field, then the user will be is allowed to log in to

      Companyname

      .
      Below is an example of a NameID TAG in SAML Assertion XML, which provides the email address of the authenticated user:

      Code Block
      <saml:NameID Format="urn:oasis:names:tc:SAML:1.1:nameid-format:email">salesuser1@mydomain.com</saml:NameID>

      If your IdP sends a Federation Id for authenticated users, be sure to create a corresponding field in the People table and populate it with the correct value for the users accessing

      Companyname

      via SAML.

   5. Name Identifier location in SAML Assertion: Choose the XML tag - NameID or Attribute - used by the IdP to send user information. NameID is the most commonly used XML tag.
      If your IdP sends user details in the Attribute TAG, enter the value of the Name or FriendlyName attribute. In the example below, USERID_ATTRIB_NAME is the value of the Name attribute:

      Code Block
      <saml:Attribute FriendlyName="fooAttrib" Name="USERID_ATTRIB_NAME" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified"> <saml:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string"> salesuser1@mydomain.com </saml:AttributeValue> </saml:Attribute>

      

   6. SAML Authentication Profile:

      • This option determines how

        Companyname

        will interact  interacts with the IdP when a user tries to access

        Companyname

        .

      • Select Passive Web Single Sign On with IdP to allow users who are already authenticated by the IdP to access

        Companyname

        directly. If the user is not already authenticated,

        Companyname

        will display  shows an error message.

      • Select Forced Authentication to require a user name and password every time, even if the user has a valid login session with the IdP.

      • The Default behavior lets users who are already authenticated by the IdP to access

        Companyname

        . If the user is not authenticated, the IdP will prompt prompts a login screen for the user.

   7. Click Next.
9. On the Identity Provider Details tab:

   1. If you have a SAML Metadata XML file, paste the contents in the box under SAML Metadata XML contents obtained from your IdP. Leave remaining fields blank and click Next.

      When the SAML configuration is saved, 

      Companyname

       will automatically populate  automatically populates the remaining fields based on the XML contents.

   2. Alternately, populate each field with the information previously obtained from the IdP. If you provide SAML Metadata XML in the first field and enter values in one or more of the remaining fields, the values entered in the individual fields override those obtained from the XML file.

      1. IdP Entity ID / Issuer: Enter the name or URL identifying the IdP.

      2. IdP Login URL: Enter the URL where 

         Companyname

          will  should forward login requests.

      3. IdP Logout URL: Enter the URL where 

         Companyname

          will  should forward logout assertions.

      4. IdP Provided X.509 Certificate Contents: If your IdP provides the X.509 certificate in a file, open the file with a text editor and paste the contents of the certificate file in the input box.

         If you provide SAML Metadata XML in the first field and enter values in one or more of the remaining fields, the values entered in the individual fields will override those obtained from the XML file.

         Image Removed

10. Click Finish to save and close the SAML configuration wizard.

11. 1. 1. Note

          These logout assertions can be used for Single Logout (SLO), which is to say they can not only log a user out of their current Agiloft session, but out of all sessions for the browser that initiated the logout, requiring that the user then log into SSO again before beginning a new session with  Companyname  or another SP.  It may be necessary to leave this field blank in order to enable these logout assertions.

       2. IdP Provided X.509 Certificate Contents: If your IdP provides the X.509 certificate in a file, open the file with a text editor and paste the contents of the certificate file in the input box.

12. Click Finish to save and close the SAML configuration wizardOn the Setup > Access screen, click Download X.509 Certificate. Save this file to use when configuring the IdP.
13. On the Setup > Access screen, click Download SAML 2.0 Service Provider MetadataX.509 Certificate. Save this file to use when configuring the IdP.
14. On the Setup > Access screen, click Download SAML 2.0 Service Provider Metadata. Save this file to use when configuring the IdP. Note that this file also contains the X.509 Certificate, and most IdPs will allow you to import this file to populate the fields in Configure the Identity Provider.

Generate a Keystore File

In cases where the Java Keystore file and corresponding private key are required for the SAML installation, which is typically needed when 

openssl pkcs12 -export -in [path to CA certificate] -inkey [path to private key] -certfile [path to CA certificate ] -out mykeystore.p12

<Agiloft_install_dir>/jre/bin/keytool -importkeystore -srckeystore mykeystore.p12 -srcstoretype pkcs12 -destkeystore mycompany.keystore    -deststoretype JKS

{server}/{KBName}

http(s)://{server}/gui2/spsamlsso?project={KBName}

http(s)://{server}/gui2/samlv2Logout.jsp

http(s)://{server}/gui2/spsamlssologout?project={KBName}