Splunk® Enterprise

Securing Splunk Enterprise

Download manual as PDF

This documentation does not apply to the most recent version of Splunk. Click here for the latest version.
Download topic as PDF

Configure SAML SSO in the configuration files

This topic explains how to set up SSO for SAML v2 using configuration files:

  • Configure authentication.conf and web.conf in Splunk Enterprise
  • Configure your identity provider
  • Secure your SAML configuration

Configure authentication.conf

Configure the following stanza in authentication.conf

[authentication]
authSettings = saml_settings
authType = SAML
[roleMap_SAML]
admin = Super Admin;
power = Power Admin;
user = <list roles> Admin;Employee;  
[saml_settings]
entityId = <entityid>
idpAttributeQueryUrl = <optional path to the Attribute query> https://your path/idp/attrsvc.ssaml2
idpCertPath = <path to the idp cert in Splunk> /home/user/splunk/saml-install/etc/auth/ping_idp.crt.>
idpSSOUrl = <path to the sso url> https://your path/idp/SSO.saml2. 
idpSLOUrl = <Logout url. If not specified, this will be treated as a typical sso and the logout button will be disabled. 
https://your path/idp/SLO.saml2 # 
redirectPort=443
attributeQueryTTL = 3600
signAuthnRequest = true
signedAssertion = true
attributeQueryRequestSigned = <Set to true if using optional idpAttributeQuerySSL>
attributeQueryResponseSigned = <Set to true if using optional idpAttributeQuerySSL>
attributeQuerySoapPassword = <your password>
attributeQuerySoapUsername = <your username> 

To configure single sign-on with Azure AD or ADFS, add the following additional attributes:

nameIDFormat = (optional) Specify the format of the subject that is returned in the SAML response. AzureAD returns a string to identify the subject and this attribute lets you optionally specify a different format (we recommend email address). This can be useful for auditing and saved searches. To specify email address as the format, use: urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress

role = Populate this field if you use Azure AD for SSO or ADFS. This value tells Splunk Enterprise the attribute that supplies role information in the SAML response returned. For Azure AD, use: http://schemas.microsoft.com/ws/2008/06/identity/claims/groups

mail = This value maps the alias to the user email addresses in the SAML response returned. For Azure AD, use: http://schemas.microsoft.com/identity/claims/displayname

realName = This tells Splunk Enterprise where to map the real name in the SAML response returned. For Azure AD use: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress.

</pre>

Configure web.conf and optionally add a failure redirect address

Add the following values to your settings stanza in web.conf

[settings]
appServerPorts = 7065 <make sure this attribute is enabled>
ssoAuthFailureRedirect = http://10.140.31.19:7000/ui/en-us/account/sso_error <this is your custom user redirect for failed logins>

Configure your identity provider

Now you must configure your IdP to import Splunk software metadata. To import Splunk software metadata on your IdP, make sure that the AuthnRequest signing and AttributeQuery request signing setting is compatible on Splunk software and the IdP:

1. Export the IdP certificate onto a file in your Splunk software instance.

2. Make sure that authentication.conf points to this certificate in the SAML configuration stanzas.

3. Import the Splunk software server certificate (server.pem) into the IdP for signature verification.

Note that you can export Splunk software metadata using the /saml/spmetadata endpoint on Splunk Web. You can also access the SAML-sp-metadata endpoint on splunkd.

Secure your SAML configuration

SAML attributequery service supports all of the standard SSL settings for Splunk Enterprise to perform TLS verification between Splunk Instance and SOAP instance providing AttributeQuery service.

In general, the following settings will work only for an IdP that supports attribute queries. However, the sslKeysFile and sslKeysFilePassword attributes will work for any IdPs.

Edit authentication.conf to configure certificate authentication:

sslVersions = <recommended settings tls1.1 and tls1.2>
sslCommonNameToCheck = <commonName> If this value is set, and 'sslVerifyServerCert' is set to true, splunkd will limit most outbound HTTPS connections to hosts which use a cert with this common name. If not set, Splunk uses the setting specified in server.conf.
sslAltNameToCheck = <alternateName1>, <alternateName2> If this value is set, and 'sslVerifyServerCert' is set to true, splunkd will also be willing to verify certificates which have a so-called "Subject Alternate Name" that matches any of the alternate names in this list. If not set, Splunk uses the setting specified in server.conf.
ecdhCurveName = <string> ECDH curve to use for ECDH key negotiation. If not set, Splunk uses the setting specified in server.conf.
sslKeysfile = <server certificate file>. Certificates are auto-generated by splunkd upon starting Splunk but you can replace the default cert with your own PEM format file. Default is server.pem. If not set, Splunk uses the setting specified in server.conf. This setting is valid for all IdPs.
sslKeysfilePassword = <server certificate password> This setting is valid for all IdPs.
caCertFile = <fPublic key of the signing authority, default is cacert.pem> If not set, Splunk uses the setting specified in server.conf.
caPath = <path where all these certs are stored, the default is $SPLUNK_HOME/etc/auth>
sslVerifyServerCert = [ true | false ] Used by distributed search: when making a search request to another server in the search cluster. If not set, Splunk uses the setting specified in server.conf.
PREVIOUS
Modify or remove role mappings
  NEXT
Troubleshoot SAML SSO

This documentation applies to the following versions of Splunk® Enterprise: 6.4.0, 6.4.1, 6.4.2, 6.4.3, 6.4.4, 6.4.5, 6.4.6, 6.4.7, 6.4.8, 6.4.9, 6.4.10, 6.4.11


Comments

Dfqobvbkmnpi, Gabrielsroka, thanks for the feedback, I've updated the topic accordingly.

Cheers,
Jen

Jworthington splunk, Splunker
October 9, 2017

In the "Secure your SAML configuration" section: http://docs.splunk.com/Documentation/Splunk/6.4.3/Security/ConfigureSAMLSSO#Secure_your_SAML_configuration

It says:
"Edit server.conf to configure certificate authentication:"

I'm fairly certain that should be "authentication.conf" instead of "server.conf".

Dfqobvbkmnpi
October 6, 2017

Where it says:
"email = This value maps the alias to the user email addresses"
Should that be "mail= " instead of "email =" ?

Gabrielsroka
July 4, 2016

Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

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