Certificates

If you need instructions to create demo certificates or extract certificates to the required formats, see Create or extract certificates for SSL and SAML.

To integrate Identity Manager with SAML SSO, the SAML authentication profile must be used.

1. In Identity Manager Admin, go to Authentication Profiles, and add a new profile with the type SAML SSO Core Object. See Set up authentication profile in Identity Manager.
2. Open the created authentication profile for editing.

3. Insert excerpt
   Set up authentication profile in Identity Manager Set up authentication profile in Identity Manager nopanel true

The defined keystore file must contain the certificates and the private key used for signing and decryption.

A keystore is mandatory to configure. Trying to save a configuration without a keystore, triggers an error message. 

1. Go to the SAML Configuration tab.  
2. Under Keystore configuration, click the upload symbol, browse for the keystore file and select it. 
3. In Password, enter the keystore password. If objects in the key store are protected with a password, then they must have the same password as the keystore. 
   
   When the keystore configuration has been uploaded, then Available key aliases shows a list of the aliases of all available private keys in the key store.

Each SAML federation can have multiple service providers, for example Identity Manager, Smart ID Self-Service and any other application to be included in the federation. Each service provider must have a metadata file. 

For each service provider, do the following to create a metadata file: 

1. Create a metadata file in .xml format, and give it a file name such as IdM_saml_metadata.xml.
2. Open the file for editing. Copy and paste the example file content from below.
3. Do the following changes:
   1. In entityID: enter a meaningful name for the service provider, for example https://<idmhost>/sp.
   2. Replace certificate data with the base64 encoded SAML certificate, for example idm.saml.pem.
   3. In Location: enter the location like this: http://<idmhost>/<application>/saml/SSO/alias/<alias>where <application> is for example, prime_explorer or selfservice.
      For example:
      http://<idmhost>/prime_explorer/saml/SSO/alias/explorer
      http://<idmhost>/saml/SSO/alias/self-service 
      Or if both applications are on the same machine:
      http://<idmhost>/idm/saml/SSO/alias/explorer
      http://<idmhost>/selfservice/saml/SSO/alias/self-service 

<?xml version="1.0" encoding="UTF-8"?>
<md:EntityDescriptor entityID="sp.example" xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata">
    <md:SPSSODescriptor protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol" AuthnRequestsSigned="true" WantAssertionsSigned="false">
        <md:KeyDescriptor use="signing">
            <ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
                <ds:X509Data>
                    <ds:X509Certificate>certificate data</ds:X509Certificate>
                </ds:X509Data>
            </ds:KeyInfo>
        </md:KeyDescriptor>
        <md:KeyDescriptor use="encryption">
            <ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
                <ds:X509Data>
                    <ds:X509Certificate>certificate data</ds:X509Certificate>
                </ds:X509Data>
            </ds:KeyInfo>
        </md:KeyDescriptor>
        <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</md:NameIDFormat>
        <md:NameIDFormat>urn:oasis:names:tc:SAML:2.0:nameid-format:transient</md:NameIDFormat>
        <md:NameIDFormat>urn:oasis:names:tc:SAML:2.0:nameid-format:persistent</md:NameIDFormat>
        <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat>
        <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName</md:NameIDFormat>
        <md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="http://<idmhost>/prime_explorer/saml/SSO/alias/explorer" index="0"/>
    </md:SPSSODescriptor>
</md:EntityDescriptor>

This table describes some elements and attributes of the Service Provider metadata xml file: 

After the metadata files have been created they must be uploaded to the authentication profile in Identity Manager Admin. Multiple service providers can be configured, for example for the different Identity Manager applications and any other applications to be included in the federation. 

1. Open the SAML SSO authentication profile that was created earlier.
2. Go to the SAML Configuration tab.  
3. Under Service Provider Configuration, do the following for each service provider:
   1. Click on the + button to add a service provider. 
   2. In Service Provider Details, define the service provider as follows: 
      1. In Configuration file, click on the upload symbol and select the metadata file. 
      2. In Alias, enter a name to define the service provider. This must match the <alias> in the Location in the metadata file. If needed, multiple aliases can be given to the same application.
         Example: explorer or self-service.  
      3. In Alias for Signing Key and Alias for Encryption Key, enter the names of the private keys for signing and encryption that must be available in Available Key Aliases. 

Configure SAML in Smart ID Self-Service

Smart ID Self-Service has additional configuration options directly in the program. 

• Multiple Self-Service instances with the same tenant, but different authentication methods, are allowed. If, for example, there are two Self-Service instances and both of them use the same tenant, one instance can use SAML whereas the other one doesn't.
• Also, you can configure a button "Sign In with Single Sign-On" on the login page instead of automatically redirecting to the Identity Provider.

SAML and automatically redirecting are enabled by default, you can change this behavior in config.json.

1. To disable SAML for a Self-Service instance, add "enabled": false to its config.json. By default it is enabled. 

2. To turn of automatic redirecting to the Identity Provider, add "enforced": false to its config.json. By default it is enforced. This means that this instance of Self-Service will show a button "Sign In with Single Sign-On" on the login page. If SAML is disabled for this instance of Self-Service this property has no effect. With this option you can use Pre-Login Processes while having SAML enabled.

/prime-ussp/assets/config/config.json
 
...
{
  ...
 
  "saml": {
    "enabled": true
    "enforced": true
  }
}

Set up communication between Smart ID Self-Service and Identity Manager

1. Open the file \prime_ussp\WEB-INF\classes\application.yaml.
2. Adapt the baseUrl so that it points to where the Identity Manager main client is deployed. If you use HTTPS instead of HTTP you must ensure that the SSL server certificate of Identity Manager is trusted by the java environment that runs the Smart ID Self-Service (tomcat).
3. Make sure that cookie forwarding is activated, that is, that there are empty values for the property sensitiveHeaders for the SAML routes in the configuration file.

   This is the default configuration.
   
   

   Code Block
   title Example: application.yaml
   prime: … baseUrl: http://localhost:8080/idm … zuul: … routes: … saml: path: /saml/** sensitiveHeaders: url: ${prime.baseUrl}/saml/

   
   

To have a secure communication between the identity provider and Identity Manager, server certificates must be provided by each server. 

Example - Add server certificate in Digital Access component: 

1. Log in to Digital Access Admin.
2. Go to Manage System > Certificates.
3. In Server Certificates, click Add Server Certificate… 

4. Enter a Display Name and browse for the files, to define Certificate and Key:
   

   Panel
   title Example: Add server certificate
   Display Name: hag.local Certificate: hag.local.pem Key: key.pem

   
   

5. Click Next > to finish the wizard. 

Private keys are used to digitally sign SAML messages and encrypt their content. Both parties need their own key-pair that could be created in self-signed mode (for testing purpose) or received from a public key infrastructure (for productive systems). 

Example - Enable Digital Access to use the SAML certificate for signing:

1. Log in to Digital Access Admin.
2. Go to Manage System > Certificates.
3. In Server Certificates, click Add Server Certificate… 

4. Enter a Display Name and browse for the files, to define Certificate and Key:

   Panel
   title Example: Add SAML certificate
   Display Name: SAML IdP Signing Certificate: hag.saml.pem Key: hag.saml.key.pem

   
   

   Note

   The Digital Access SAML certificate must be trusted by the Java installation that runs Identity Manager to have a secure communication between them. To allow SSL communication between Identity Manager and Smart ID Self-Service, the SSL certificate needs to be trusted as well by the Java installation. The SSL certificate can be exported from the Java Key Store with the following command: Code Block title Example: java keytool command keytool -export -keystore idm.jks -alias selfsigned -file idm.cer

   
   

5. Click Next > to finish the wizard.

As identity provider, you can use any SAML2 compliant system. Follow the instructions of that software in order to configure it as SAML IdP. If you use Digital Access as identity provider, follow the steps here to create a DNS name.

Example - Create a DNS name for the Digital Access access point:

1. Log in to Digital Access Admin.
2. Go to Manage Resource Access > Global Resource Settings.
3. Go to the DNS Name Pool tab.
4. Add a new DNS name for the access point. Give the DNS name, for example idp.hag.local, and select the corresponding Digital Access server certificate, for example hag.local.pem.
   
5. Click Add and then Save.  

After the service provider was configured successfully in the identity provider, the SAML metadata must be downloaded and uploaded in Identity Manager.

Example - Download the metadata from Digital Access: 

1. Go to Manage Resource Access > SAML Federation.
2. Click on the created service provider, to open it.
3. Go to the tab Export.
4. Click Download metadata.

5. Upload the metadata file to the SAML Authentication Profile in Identity Manager and select the Type as METADATA. No File Properties needs to be configured for the identity provider meta-data.

After the metadata files have been created they must be uploaded to the authentication profile in Identity Manager Admin. This section describes how to upload the identity provider metadata files. 

1. Open the SAML SSO authentication profile that was created earlier.
2. Go to the SAML Configuration tab.  
3. Under Identity Provider Configuration, do the following:
   1. In Configuration File, click the upload symbol to browse for and select the metadata file that has been provided from the identity provider, for example downloaded from Digital Access. 
   2. In Attribute Type, select either option for where the authentication information shall be communicated: 
      1. NameID refers to the subject of a SAML response. Use an appropriate value that matches the desired field in the CoreObject.
      2. Attribute Statement refers to attributes associated with the subject of a SAML response.
         
   3. If Attribute Statement was selected, then also enter one or more names in Attribute Name.