Splunk® Enterprise

Securing the Splunk Platform

Acrobat logo Download manual as PDF

Acrobat logo Download topic as PDF

Configure single sign-on with SAML

You can configure the Splunk Platform to use Security Assertion Markup Language (SAML) as an authentication scheme for single sign-on (SSO), using information that your supported identity provider (IdP) supplies.

The Splunk platform supports many different types of identity provider for logins using SAML authentication. You can configure the platform with settings that are specific to your IdP. You can also configure certificates and encryption for Splunk Enterprise so that communication between Splunk Enterprise and the IdP is secure. Splunk Enterprise supports the decryption of assertions that it receives from the IdP when you configure the IdP to encrypt those assertions.

Prerequisites for configuring SAML as an authentication scheme for single sign-on

Before you can configure SAML as an authentication scheme for single sign-on, you must have the following:

  • A running Splunk platform instance that has access to the supported IdP
    • You must have administrator access to this instance to configure the SAML authentication scheme for SSO
    • The Splunk platform instance must be able to contact the IdP over the network
  • An IdP that is SAML v2-compliant
    • The IdP must be able to provide the role, realName, and mail attributes in an assertion
    • There is native support for IdPs that have support for Attribute Query Requests (AQR)
    • There is support through authentication extensions for some IdPs that do not have support for AQR
    • Supported IdPs include but are not limited to PingIdentity, Okta, Microsoft Azure, Active Directory Federation Services, OneLogin, Optimal, and CA Siteminder

Configure the Splunk Platform to authenticate into your IdP using SAML

The following instructions are high level, and presume that you have access to Splunk Web. If you prefer, you can also configure SAML SSO using configuration files, see Configure SAML SSO using configuration files.

You might need to perform additional configuration for your IdP, or use the procedures for a specific IdP instead. If you are unsure as to what values are appropriate for your IdP, file a support case if you have an entitlement with Splunk, or ask a question on Splunk Answers if you do not.

Splunk Enterprise always outputs usernames in lowercase in communications with an IdP. If your IdP requires case preservation in in usernames, you can change the username to lowercase in the IdP or configure the IdP to accept the lowercase version of a username.

When you configure a search head to use SAML as an authentication scheme, you must re-enter your credentials to access saved searches after a restart of the search head.

Configure single sign-on using SAML as an authentication scheme

  1. Log into the Splunk platform as an administrator level user.
  2. From the system bar, click Settings > Authentication Methods.
  3. Under External, click SAML. A link Configure Splunk to use SAML appears.
  4. Click Configure Splunk to use SAML. The SAML configuration dialog box appears.
  5. In the General Settings section of the "SAML configuration" dialog box, supply the appropriate information to access your IdP. You must supply at least the following values in the "General Settings" section:
    1. Single Sign-on (SSO) URL
    2. IdP Certificate Chains
    3. Issuer ID
    4. Entity ID
  6. (Optional) In the Alias section, supply the three aliases as provided by your IdP, if your IdP provides those aliases:
    1. Role alias
    2. RealName alias
    3. Mail alias


Configure single-sign-on using SAML as an authentication scheme for specific IdPs

Splunk has written instructions on how to configure single-sign on with SAML on various identity providers. These instructions are helpful for customers who use these IdPs, but this list not represent the full list of IdPs that Splunk supports for authentication using SAML. The Splunk platform can authenticate using any IdP that is compliant with SAML version 2.0.

  1. See the following links for instructions on how to configure the Splunk platform to use SAML authentication for a specific IdP:
  2. Map SAML groups to Splunk roles. See Map SAML groups to Splunk Enterprise roles for instructions.

Configure automatic decryption of SAML assertions from an IdP

If you want to ensure secure communication between your IdP and your Splunk platform instance, you can enable encrypted SAML assertions. When the Splunk platform receives an encrypted assertion from an IdP, it automatically decrypts the assertion and processes the login based on the information in the assertion, provided that you supply a public key to the IdP and enable encrypted assertions on the IdP.

You can configure automatic decryption of SAML assertions using the default server certificate only. Currently, there is no support for this option with other certificates.

  1. Open a shell or command prompt.
  2. On your Splunk platform instance, change to the $SPLUNK_HOME/etc/auth directory.
  3. Export the public key from the default server certificate using the openssl command:
    ./splunk cmd openssl x509 -outform der -in server.pem -out publicKey.crt
    
  4. Using the configuration interface of your IdP, enable encrypted assertions on your IdP.

    This setup differs based on the IdP you use. Some IdPs might not support encrypted assertions.

  5. Using the configuration interface of your IdP, upload the publicKey.crt file to your IdP
  6. Follow the instructions earlier in this topic to configure the Splunk platform to authenticate using your IdP.
  7. Log into the Splunk platform with a user on your IdP. If login succeeds, you have configured SAML assertion correctly.
Last modified on 28 October, 2020
PREVIOUS
User experience when logging into a Splunk instance configured with RSA multifactor authentication
  NEXT
Configure SSO with PingIdentity as your SAML identity provider

This documentation applies to the following versions of Splunk® Enterprise: 8.0.6, 8.0.7, 8.1.0


Was this documentation topic helpful?

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters