Configure SAML SSO in the configuration files
This topic explains how to set up SSO for SAMLv2 using configuration files:
web.confin Splunk Enterprise
- Configure your identity provider
Configure the following stanza in
[authentication] authSettings = saml_settings authType = SAML [rolemap_SAML] admin = Super Admin; power = Power Admin; user = <list roles> Admin;Employee; [saml_settings] entityId = <entityid> idpAttributeQueryUrl = <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 = true attributeQueryResponseSigned = true attributeQuerySoapPassword = <your password> attributeQuerySoapUsername = <your username>
Working with users not assigned to a role
if SAML users do not have assigned roles, you can still include them by configuring the
defaultRoleIfMissing settings to include those users. For example:
defaultRoleIfMissing = user1,user2,user3 skipAttributeQueryRequestForUsers=user1,user2,user3
defaultRoleMissing cannot be used in lieu of the
skipAttributeQueryForUsers. These attributes work in tandem and you must configure both attributes.
Attribute Query Request for Ping Identity
The following is a workaround for the Attribute Query Request field and should be included in your stanza. This is because the existing SSL configuration is too strong to work with Ping Identity, causing the attribute query to fail. You can add the following workaround to accommodate Ping Identity.
#cipherSuite = TLSv1+MEDIUM:@STRENGTH cipherSuite = ALL:!aNULL:!eNULL:!LOW:!EXP:RC4+RSA:+HIGH:+MEDIUM defaultRoleIfMissing = user skipAttributeQueryRequestForUsers=admin,username,anotherusername sslKeysfile = <path_to_saml_signing_cert_and_keys> sslKeysfilePassword = <password_for_saml_keys>
web.conf and optionally add a failure redirect address
Add the following values to your settings stanza in
[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 metadata. To import Splunk Enterprise metadata on your IdP, make sure that
AuthnRequest signing and
AttributeQuery request signing setting is compatible on Splunk Enterprise and IdP:
1. Export the IdP certificate onto a file in your Splunk Enterprise instance.
2. Make sure that
authentication.conf points to this certificate in the SAML configuration stanzas.
3. Import the Splunk Enterprise server certificate (
server.pem) into the IdP for signature verification.
Note that Splunk metadata can be exported by hitting
/saml/spmetadata endpoint on SplunkWeb. You can also access the
SAML-sp-metadata endpoint on
splunkd. These endpoints are only available if SAML is already configured.
Map groups to roles
Troubleshoot SAML SSO
This documentation applies to the following versions of Splunk® Enterprise: 6.3.0, 6.3.1, 6.3.2, 6.3.3, 6.3.4, 6.3.5, 6.3.6, 6.3.7, 6.3.8, 6.3.9, 6.3.10, 6.3.11, 6.3.12, 6.3.13, 6.3.14