authentication.conf
The following are the spec and example files for authentication.conf.
authentication.conf.spec
# Version 9.4.0 # # This file contains possible settings and values for configuring # authentication via authentication.conf. # # There is an authentication.conf file in $SPLUNK_HOME/etc/system/default/. To # set custom configurations, place an authentication.conf in # $SPLUNK_HOME/etc/system/local/. For examples, see # authentication.conf.example. You must restart the Splunk platform to enable # configurations. # # To learn more about configuration files, including precedence, see # http://docs.splunk.com/Documentation/Splunk/latest/Admin/Aboutconfigurationfiles.
GLOBAL SETTINGS
# Use the [default] stanza to define any global settings. # * You can also define global settings outside of any stanza, at the top # of the file. # * Each .conf file should have at most one default stanza. If there are # multiple default stanzas, settings are combined. In the case of # multiple definitions of the same setting, the last definition in the # file wins. # * If a setting is defined at both the global level and in a specific # stanza, the value in the specific stanza takes precedence. [authentication] * Follow this stanza name with any number of the following setting/value pairs. authType = [Splunk|LDAP|Scripted|SAML|ProxySSO] * Specify which authentication system to use. * Supported values: Splunk, LDAP, Scripted, SAML, ProxySSO. * Default: Splunk authTypePreferredForUserCollision = [Splunk|SAML] * The authentication scheme to use when the Splunk platform detects username collision between native authentication and SAML users. * A value of "Splunk" means the Splunk platform assumes native authentication user roles when the SAML username matches a native authentication user. * A value of "SAML" means the Splunk platform assigns roles mapped from SAML groups and ignores roles from native authentication users. * Default: Splunk authSettings = <authSettings-key>,<authSettings-key>,... * Key to look up the specific configurations of chosen authentication system. * <authSettings-key> is the name of a stanza header that specifies settings for scripted authentication, SAML, ProxySSO and for an LDAP strategy. Those stanzas are defined below. * For LDAP, specify the LDAP strategy name(s) here. If you want Splunk software to query multiple LDAP servers, provide a comma-separated list of all strategies. Each strategy must be defined in its own stanza. The order in which you specify the strategy names is the order Splunk software uses to query their servers when looking for a user. * For scripted authentication, <authSettings-key> should be a single stanza name. passwordHashAlgorithm = [SHA512-crypt|SHA256-crypt|SHA512-crypt-<num_rounds>|SHA256-crypt-<num_rounds>|MD5-crypt] * This controls how hashed passwords are stored in the $SPLUNK_HOME/etc/passwd file for the default "Splunk" authType. * "MD5-crypt" is an algorithm originally developed for FreeBSD in the early 1990s, which became a widely used standard among UNIX machines. Splunk Enterprise also used it through the 5.0.x releases. MD5-crypt runs the salted password through a sequence of 1000 MD5 operations. * "SHA256-crypt" and "SHA512-crypt" are newer versions that use 5000 rounds of the Secure Hash Algorithm-256 (SHA256) or SHA512 hash functions. This is slower than MD5-crypt and therefore more resistant to dictionary attacks. SHA512-crypt is used for system passwords on many versions of Linux. * These SHA-based algorithm can optionally be followed by a number of rounds to use. For example, "SHA512-crypt-10000" uses twice as many rounds of hashing as the default implementation. The number of rounds must be at least 1000. If you specify a very large number of rounds (i.e. more than 20x the default value of 5000), splunkd might become unresponsive and connections to splunkd (from Splunk Web or CLI) time out. * This setting only affects new password settings (either when a user is added or a user's password is changed). Existing passwords work but retain their previous hashing algorithm. * Default: SHA512-crypt defaultRoleIfMissing = <splunk role> * Applicable for LDAP authType. If the LDAP server does not return any groups, or if groups cannot be mapped to Splunk roles, then this value is used, if provided. * This setting is optional. * Default: empty string externalTwoFactorAuthVendor = <string> * A valid multifactor vendor string enables multifactor authentication and loads support for the corresponding vendor if supported by the the Splunk platform. * An empty string disables multifactor authentication in the the Splunk platform. * Currently Splunk supports Duo and RSA as multifactor authentication vendors. * This setting is optional. * No default. externalTwoFactorAuthSettings = <externalTwoFactorAuthSettings-key> * Key to look up the specific configuration of chosen multifactor authentication vendor. * This setting is optional. * No default.
LDAP settings
[<authSettings-key>]
* Follow this stanza name with the following setting/value pairs.
* For multiple strategies, specify multiple instances of
this stanza, each with its own stanza name and a separate set of
settings.
* The <authSettings-key> must be one of the values listed in the
authSettings setting, which must be specified in the previous [authentication]
stanza.
host = <string>
* The hostname of the LDAP server.
* Confirm that your Splunk server can resolve the host name through DNS.
* Required.
* No default.
SSLEnabled = [0|1]
* Specifies whether SSL is enabled.
* See the file $SPLUNK_HOME/etc/openldap/ldap.conf for SSL LDAP settings
* This setting is optional.
* Default: 0 (disabled)
port = <integer>
* The port that the Splunk platform should use to connect to your LDAP server.
* This setting is optional.
* Default (non-SSL): 389
* Default (SSL): 636
bindDN = <string>
* The LDAP Distinguished Name of the user that retrieves the LDAP entries.
* This user must have read access to all LDAP users and groups you wish to
use in the auth system.
* This setting is optional.
* Leave this setting blank to retrieve your LDAP entries using
anonymous bind (which must be supported by the LDAP server)
* No default.
bindDNpassword = <password>
* Password for the bindDN user.
* This setting is optional.
* Leave this blank if anonymous bind is sufficient.
* No default.
userBaseDN = <string>
* The distinguished names of LDAP entries whose subtrees contain the users.
* Enter a ';' delimited list to search multiple trees.
* Required.
* No default.
userBaseFilter = <string>
* The LDAP search filter to use when searching for users.
* Highly recommended, especially when there are many entries in your LDAP
user subtrees.
* When used properly, search filters can significantly speed up LDAP queries
* Here is an example that matches users in the IT or HR department:
* userBaseFilter = (|(department=IT)(department=HR))
* See RFC 2254 for more detailed information on search filter syntax
* This setting is optional.
* Default: empty string (no filtering)
userNameAttribute = <string>
* This is the username.
* NOTE: This setting should use case insensitive matching for its values,
and the values should not contain whitespace
* Usernames are case insensitive in the the Splunk platform
* In Active Directory, this is 'sAMAccountName'
* Required.
* A typical value is 'uid'.
* No default.
realNameAttribute = <string>
* The user's real, human readable name.
* Required.
* A typical value is 'cn'.
* No default.
emailAttribute = <string>
* The user's email address.
* This setting is optional.
* Default: mail
groupMappingAttribute = <string>
* The value that group entries use to declare membership.
* Groups are often mapped with user DN, so this defaults to 'dn'
* Set this if groups are mapped using a different setting
* Usually only needed for OpenLDAP servers.
* A typical setting is 'uid'
* For example, assume a group declares that one of its members is
'splunkuser' — every user with the 'uid' value 'splunkuser' is
mapped to that group.
* This setting is optional.
* No default.
groupBaseDN = [<string>;<string>;...]
* The LDAP Distinguished Names of LDAP entries whose subtrees contain
the groups.
* Required.
* Enter a semicolon (;) delimited list to search multiple trees.
* If your LDAP environment does not have group entries, there is a
configuration that can treat each user as its own group:
* Set groupBaseDN to the same as userBaseDN, which means you search
for groups in the same place as users.
* Next, set the groupMemberAttribute and groupMappingAttribute to the same
setting as userNameAttribute.
* This means the entry, when treated as a group, uses the username
value as its only member.
* For clarity, also set groupNameAttribute to the same
value as userNameAttribute.
* No default.
groupBaseFilter = <string>
* The LDAP search filter the Splunk platform uses when searching for static groups
* Like 'userBaseFilter', this is highly recommended to speed up LDAP queries
* See Request for Comments (RFC) 2254 on the Internet Engineering Task Force
(IETF) website for more information.
* This setting is optional.
* Default: empty string (no filtering).
dynamicGroupFilter = <string>
* The LDAP search filter the Splunk platform uses when searching for dynamic groups.
* Configure this setting only if you intend to retrieve dynamic groups
on your LDAP server.
* Example: '(objectclass=groupOfURLs)'
* This setting is optional.
* Default: empty string
dynamicMemberAttribute = <string>
* This setting contains the LDAP URL needed to retrieve members dynamically.
* Only configure this if you intend to retrieve dynamic groups on your
LDAP server.
* This setting is required if you want to retrieve dynamic groups.
* Otherwise, it is optional.
* Example: 'memberURL'
* No default.
groupNameAttribute = <string>
* This is the group entry setting whose value stores the group name.
* A typical setting for this is 'cn' (common name)
* Recall that if you are configuring LDAP to treat user entries as their own
group, user entries must have this setting
* Required.
* Default: empty string
groupMemberAttribute = <string>
* This is the group entry setting whose values are the groups members
* Typical setting for this are 'member' and 'memberUid'
* For example, consider the groupMappingAttribute example above using
groupMemberAttribute 'member'
* To declare 'splunkuser' as a group member, its setting 'member' must
have the value 'splunkuser'
* Required.
* Default: empty string
nestedGroups = <boolean>
* Controls whether the Splunk platform expands nested groups using the
'memberof' extension.
* Set to 1 if you have nested groups you want to expand and the 'memberof'
extension on your LDAP server.
* This setting is optional.
charset = <string>
* Only set this for an LDAP setup that returns non-UTF-8 encoded data. LDAP
is supposed to always return UTF-8 encoded data (See RFC 2251), but some
tools incorrectly return other encodings.
* Follows the same format as 'CHARSET' in props.conf (see props.conf.spec)
* An example value would be "latin-1"
* This setting is optional.
* Default: empty string
anonymous_referrals = [0|1]
* Set this to 0 to turn off referral chasing
* Set this to 1 to turn on anonymous referral chasing
* NOTE: the Splunk platform only chases referrals using anonymous bind.
It does not support rebinding using credentials.
* If you do not need referral support, set this to 0.
* If you wish to make referrals work, set this to 1 and confirm your server
allows anonymous searching
* This setting is optional.
* Default: 1
sizelimit = <integer>
* Limits the amount of entries that the Splunk platform requests in LDAP search.
* NOTE: The max entries returned is still subject to the maximum
imposed by your LDAP server.
* Example: If you set this to 5000 and the server limits it to 1000,
the software only returns 1000 entries.
* This setting is optional.
* Default: 1000
pagelimit = <integer>
* The maximum number of entries to return in each page.
* Enables result sets that exceed the maximum number of entries defined for the
LDAP server.
* If set to -1, ldap pagination is off.
* IMPORTANT: The maximum number of entries a page returns is subject to
the maximum page size limit of the LDAP server. For example: If you set 'pagelimit =
5000' and the server limit is 1000, you cannot receive more than 1000 entries in
a page.
* This setting is optional.
* Default: -1
enableRangeRetrieval = <boolean>
* The maximum number of values that can be retrieved from one attribute in a
single LDAP search request is determined by the LDAP server. If the number of
users in a group exceeds the LDAP server limit, enabling this setting fetches all
users by using the "range retrieval" mechanism.
* Enables result sets for a given attribute that exceed the maximum number of
values defined for the LDAP server.
* If set to false, ldap range retrieval is off.
* This setting is optional.
* Default: false
timelimit = <integer>
* The amount of time, in seconds, that the Splunk platform waits for an LDAP search
request to complete.
* If your searches finish quickly, lower this value from the default.
* Maximum value is 30.
* Default: 15
network_timeout = <integer>
* The amount of time, in seconds, that a network socket polls a connection
that has no activity.
* This is useful for determining if your Splunk platform instance cannot
reach your LDAP server.
* NOTE: As a connection could potentially be waiting for search results,
this value must be higher than 'timelimit'. If you set it lower, you could
terminate the connection to your server before an LDAP search completes.
* Like 'timelimit', if you have a fast connection to your LDAP server,
lower this value.
* Maximum value is -1 (unlimited)
* This setting is optional.
* Default: 20
ldap_negative_cache_timeout = <nonnegative decimal>
* The amount of time, in seconds, that the Splunk platform remembers that a non-existent
user on an LDAP provider does not exist.
* This setting is useful when you want to avoid frequent LDAP queries for users
that do not exist on the LDAP provider.
* This setting does not prevent LDAP queries on login. Login always queries the LDAP
provider to confirm that a user exists.
* Default: 86400
Map roles
[roleMap_<authSettings-key>] * The mapping of Splunk roles to LDAP groups for the LDAP strategy specified by <authSettings-key> * Follow this stanza name with several Role-to-Group(s) mappings as defined below. * NOTE: This role mapping ONLY applies to the specified strategy. * Importing groups for the same user from different strategies is not supported. <Splunk RoleName> = <semicolon-separated list> * Maps a Splunk role from the authorize.conf configuration file to one or more LDAP groups. * Separate multiple LDAP groups with semicolons, not spaces. * List several of these setting/value pairs to map several Splunk roles to LDAP Groups. * LDAP group names are case sensitive.
Scripted authentication
[<authSettings-key>]
* Follow this stanza name with the following setting/value pairs:
python.version = {default|python|python2|python3|python3.7|python3.9|latest}
* For Python scripts only, selects which Python version to use.
* Set to either "default" or "python" to use the system-wide default Python
version.
* Set to "python3" or "python3.7" to use the Python 3.7 version.
* Set to "python3.9" to use the Python 3.9 version.
* In the context of configuring apps, the "latest" value is not currently
supported. It is related to a feature that is still under development.
* Optional.
* Default: Not set; uses the system-wide Python version.
scriptSearchFilters = [1|0]
* Whether or not to call the script to add search filters.
* Set this to 1 to call the script to add search filters.
* Default: 0
[cacheTiming]
* Use these settings to adjust how long the Splunk platform uses the answers returned
from script functions before calling them again.
* All timeouts can be expressed in seconds or as a search-like time range
* Examples include "30" (30 seconds), "2mins" (2 minutes), "24h" (24 hours), etc.
* You can opt to use no caching for a particular function by setting the
value to "0".
* Be aware that this can severely hinder performance as a result of heavy
script invocation.
* Choosing the correct values for cache timing involves a tradeoff between
new information latency and general performance.
* High values yield better performance from calling the script less, but
introduces a latency in picking up changes.
* Low values pick up changes in your external auth system more
quickly, but can slow down performance due to increased script
invocations.
userLoginTTL = <time range string>
* The timeout for the 'userLogin' script function.
* These return values are cached on a per-user basis.
* Default: 0 (no caching)
userInfoTTL = <time range string>
* How long the auth system caches information that it retrieves with the
'getUserInfo' and 'getUsers' scripts.
* These return values are cached on a per-user basis.
* Default (if you have configured either 'getUserInfoTTL' or 'getUsersTTL'): the larger value of these settings
* Default (otherwise): 10s
getUserInfoTTL = <time range string>
* DEPRECATED; use 'userInfoTTL' instead.
* How long the auth system caches information that it retrieves with the
'getUserInfo' script.
* These return values are cached on a per-user basis.
* Default: 10s
getUsersTTL = <time range string>
* DEPRECATED; use 'userInfoTTL' instead.
* The timeout for the getUsers script function.
* There is only one global getUsers cache (it is not tied to a
specific user).
* Default: 10s
Settings for Splunk Authentication mode
[splunk_auth] * Settings for Splunk's internal authentication system. minPasswordLength = <positive integer> * Specifies the minimum permitted password length in characters when passwords are set or modified. * Password modification attempts which do not meet this requirement are * explicitly rejected. * Values less than 1 are ignored. * This setting is optional. * Default: 8 minPasswordUppercase = <positive integer> * Specifies the minimum permitted uppercase characters when passwords are set or modified. * The Splunk platform ignores negative values. * This setting is optional. * Password modification attempts which do not meet this requirement are explicitly rejected. * Default: 0 minPasswordLowercase = <positive integer> * Specifies the minimum permitted lowercase characters when passwords are set or modified. * The the Splunk platform ignores negative values. * This setting is optional. * Password modification attempts which do not meet this requirement are explicitly rejected. * Default: 0 minPasswordDigit = <positive integer> * Specifies the minimum permitted digit or number characters when passwords are set or modified. * The Splunk platform ignores negative values. * This setting is optional. * Password modification attempts which do not meet this requirement are explicitly rejected. * Default: 0 minPasswordSpecial = <positive integer> * Specifies the minimum permitted special characters when passwords are set or modified. * The semicolon character is not allowed. * The Splunk platform ignores negative values. * This setting is optional. * Password modification attempts which do not meet this requirement are explicitly rejected. * Default: 0 expirePasswordDays = <positive integer> * Specifies the number of days before the password expires after a reset. * Minimum value: 0 * Maximum value: 3650 * the Splunk platform ignores negative values. * This setting is optional. * Default: 90 expireAlertDays = <positive integer> * Specifies the number of days to issue alerts before password expires. * Minimum value: 0 * Maximum value: 120 * The Splunk platform ignores negative values. * This setting is optional. * Alerts appear in splunkd.log. * Default: 15 expireUserAccounts = <boolean> * Specifies whether password expiration is enabled. * This setting is optional. * Default: false (user passwords do not expire) forceWeakPasswordChange = <boolean> * Specifies whether users must change a weak password. * This setting is optional. * Default: false (users can keep weak password) lockoutUsers = <boolean> * Specifies whether locking out users is enabled. * This setting is optional. * If you enable this setting on members of a search head cluster, user lockout state applies only per SHC member, not to the entire cluster. * Default: true (users are locked out on incorrect logins) lockoutMins = <positive integer> * The number of minutes that a user is locked out after entering an incorrect password more than 'lockoutAttempts' times in 'lockoutThresholdMins' minutes. * Any value less than 1 is ignored. * Minimum value: 1 * Maximum value: 1440 * This setting is optional. * If you enable this setting on members of a search head cluster, user lockout state applies only per SHC member, not to the entire cluster. * Default: 30 lockoutAttempts = <positive integer> * The number of unsuccessful login attempts that can occur before a user is locked out. * The unsuccessful login attempts must occur within 'lockoutThresholdMins' minutes. * Any value less than 1 is ignored. * Minimum value: 1 * Maximum value: 64 * This setting is optional. * If you enable this setting on members of a search head cluster, user lockout state applies only per SHC member, not to the entire cluster. * Default: 5 lockoutThresholdMins = <positive integer> * Specifies the number of minutes that must pass from the time of the first failed login before the failed login attempt counter resets. * Any value less than 1 is ignored. * Minimum value: 1 * Maximum value: 120 * This setting is optional. * If you enable this setting on members of a search head cluster, user lockout state applies only per SHC member, not to the entire cluster. * Default: 5 enablePasswordHistory = <boolean> * Specifies whether password history is enabled. * When set to "true", the Splunk platform maintains a history of passwords that have been used previously. * This setting is optional. * Default: false passwordHistoryCount = <positive integer> * The number of passwords that are stored in history. If password history is enabled, on password change, user is not allowed to pick an old password. * This setting is optional. * Minimum value: 1 * Maximum value: 128 * Default: 24 constantLoginTime = <decimal> * The amount of time, in seconds, that the authentication manager waits before returning any kind of response to a login request. * This setting helps mitigate login timing attacks. If you want to use the setting, test it in your environment first to determine the appropriate value. * When you configure this setting, a login failure is guaranteed to take at least the amount of time you specify. The authentication manager adds a delay to the actual response time to keep this guarantee. * The values can use decimals. "0.025" would make responses take a consistent 25 milliseconds or slightly more. * This setting is optional. * Minimum value: 0 (Disables login time guarantee) * Maximum value: 5.0 * Default: 0 verboseLoginFailMsg = <boolean> * Specifies whether or not the login failure message explains the failure reason. * When set to true, the Splunk platform displays a message on login along with the failure reason. * When set to false, the Splunk platform displays a generic failure message without a specific failure reason. * This setting is optional. * Default: true
Security Assertion Markup Language (SAML) settings
[<saml-authSettings-key>]
* Follow this stanza name with the following setting/value pairs.
* The <authSettings-key> must be one of the values listed in the
* authSettings setting, specified above in the [authentication] stanza.
fqdn = <string>
* The fully qualified domain name where this splunk instance is running.
* If this value is not specified, the Splunk platform uses the value specified
in server.conf.
* If this value is specified and 'http://' or 'https://' prefix is not
present, the Splunk platform uses the SSL setting for Splunk Web.
* This setting is optional.
* the Splunk platform uses this information to populate the 'assertionConsumerServiceUrl'.
* Default: $HOSTNAME
redirectPort = <port number>
* The port where SAML responses are sent.
* Typically, this is the web port.
* If internal port redirection is needed, set this port and the
'assertionconsumerServiceUrl' in the AuthNRequest contains this port
instead of the Splunk Web port.
* To prevent any port information to be appended in the
'assertionConsumerServiceUrl' setting, set this to 0.
* Default: The value of 'httpport' in the web.conf file
idpSSOUrl = <url>
* The protocol endpoint on the IDP (Identity Provider) where the
AuthNRequests should be sent.
* Required.
* SAML requests fail if this information is missing.
* No default.
idpAttributeQueryUrl = <url>
* The protocol endpoint on the IDP (Identity Provider) where the setting
query requests should be sent.
* Attribute queries can be used to get the latest 'role' information,
if there is support for Attribute queries on the IDP.
* This setting is optional.
* When this setting is absent, the Splunk platform caches the role information
from the SAML assertion and use it to run saved searches.
* No default.
idpCertPath = <string>
* This value is relative to $SPLUNK_HOME/etc/auth/idpCerts.
* The value for this setting can be the name of the certificate file or a directory.
* If it is empty, the Splunk platform automatically verify with certificates in all
subdirectories present in $SPLUNK_HOME/etc/auth/idpCerts.
* If the SAML response is to be verified with a IdP (Identity Provider) certificate that
is self signed, then this setting holds the filename of the certificate.
* If the SAML response is to be verified with a certificate that is a part of a
certificate chain(root, intermediate(s), leaf), create a subdirectory and place the
certificate chain as files in the subdirectory.
* If there are multiple end certificates, create a subdirectory such that, one
subdirectory holds one certificate chain.
* If multiple such certificate chains are present, the assertion is considered verified,
if validation succeeds with any certificate chain.
* The file names within a certificate chain should be such that root certificate
is alphabetically before the intermediate which is alphabetically before of
the end cert.
ex. cert_1.pem has the root, cert_2.pem has the first intermediate cert,
cert_3.pem has the second intermediate certificate and cert_4.pem has the
end certificate.
* This setting is required if 'signedAssertion' is set to true.
* Otherwise, it is optional.
* No default.
idpCertExpirationWarningDays = <positive integer>
* The number of days before an identity provider certificate expires. During this period, when a
SAML login occurs, the Splunk platform generates a certificate expiration warning log.
* You can control how often the Splunk platform generates warning logs for the
same certificate with the 'IdpCertExpirationCheckInterval' setting.
* Minimum value: 1
* Maximum value: 365
* This setting is optional.
* If you enable this setting on members of a search head cluster, the instance that
processes the login request generates the certificate expiration warning log.
* Default: 90
idpCertExpirationCheckInterval = <interval><unit>
* How long a Splunk platform instance must wait, after generating a certificate
expiration warning log after a login, to generate another one.
* The Splunk platform caches the certificate fingerprint when a SAML user logs in.
If the client sends the same certificate on another login, the Splunk platform reviews the
cache. If at least 'idpCertExpirationCheckInterval' has not passed since the last time
it generated a log for a certificate that is in the cache, it won't generate another log.
* Default: 1d
idpSLOUrl = <string>
* The protocol endpoint on the IDP (Identity Provider) where a SP
(Service Provider) initiated Single logout request should be sent.
* This setting is optional.
* No default.
errorUrl = <string>
* The URL to be displayed for a SAML error.
* Errors may be due to erroneous or incomplete configuration in either
the IDP or the Splunk platform.
* This URL can be absolute or relative.
* Absolute URLs should follow the pattern
<protocol>:[//]<host> e.g. https://www.external-site.com.
* Relative URLs should start with '/'. A relative url shows up as an
internal link of the Splunk instance, for
example: https://splunkhost:port/relativeUrlWithSlash
* No default.
errorUrlLabel = <string>
* Label or title of the content pointed to by errorUrl.
* This setting is optional.
* No default.
entityId = <string>
* The entity ID for SP connection as configured on the IDP.
* Required.
* No default.
issuerId = <string>
* Required.
* The unique identifier of the identity provider.
The value of this setting corresponds to the setting "entityID" of
"EntityDescriptor" node in IdP metadata document.
* If you configure SAML using IdP metadata, this field is extracted from
the metadata.
* If you configure SAML manually, then you must configure this setting.
* When the Splunk platform tries to verify the SAML response, the issuerId
specified here must match the 'Issuer' field in the SAML response. Otherwise,
validation of the SAML response fails.
signAuthnRequest = <boolean>
* Whether or not the Splunk platform should sign AuthNRequests.
* This setting is optional.
* Default: true
signedAssertion = <boolean>
* Whether or not the SAML assertion has been signed by the IDP.
* If set to false, the Splunk platform does not verify the signature
of the assertion using the certificate of the IDP.
* The software accepts both signed and encrypted assertions.
* Changing this to false will not affect encrypted assertions.
* This setting is optional.
* Default: true
attributeQuerySoapPassword = <password>
* The password to be used when making an attribute query request.
* Attribute query requests are made using SOAP using basic authentication
* This setting is required if 'attributeQueryUrl' is specified.
* Otherwise, it is optional.
* This string is obfuscated upon splunkd startup.
* No default.
attributeQuerySoapUsername = <string>
* The username to be used when making an attribute query request.
* Attribute Query requests are made using SOAP using basic authentication
* This setting is required if 'attributeQueryUrl' is specified.
* Otherwise, it is optional.
* No default.
attributeQueryRequestSigned = <boolean>
* Whether or not to sign attribute query requests.
* Default: true
attributeQueryResponseSigned = <boolean>
* Specifies whether attribute query responses are signed.
* If set to false, the Splunk platform does not verify the signature in
the response using the certificate of the IDP.
* This setting is optional.
* Default: true
partialChainCertVerification = <boolean>
* Whether or not authentication uses the OpenSSL X509_V_FLAG_PARTIAL_CHAIN
* flag when performing validation on a SAML certificate chain.
* Configuring this setting to "true" lets verification of SAML certificates
* succeed even in cases where a complete certificate chain cannot be built
* back to a self-signed trust anchor certificate.
* When set to "true", intermediate certificates in the trust store are
* treated as trust-anchors in the same way as self-signed root certificate
* authority certificates.
* Uses X509_V_FLAG_PARTIAL_CHAIN flag during certificate verification.
* This setting is optional.
* Default: false
redirectAfterLogoutToUrl = <string>
* The user is redirected to this url after logging out of the Splunk platform.
* If this is not specified, and 'idpSLO' is also not set, the user is
redirected to splunk.com after logout.
* This setting is optional.
* No default.
defaultRoleIfMissing = <string>
* If the IdP does not return any AD groups or Splunk roles as a part of the
assertion, the Splunk platform uses this value if provided.
* This setting is required when you configure 'skipAttributeQueryRequestForUsers'. Otherwise, it is optional.
* The Splunk platform ignores this setting if 'enableAutoMappedRoles' has a value of "false".
* No default.
skipAttributeQueryRequestForUsers = <comma-separated list of users>
* To skip attribute query requests being sent to the IdP for certain users,
add them with this setting.
* By default, attribute query requests are skipped for local users.
* If you configure this setting for non-local users, you must also configure 'defaultRoleIfMissing'.
* No default.
maxAttributeQueryThreads = <integer>
* Number of threads to use to make attribute query requests.
* Changes to this setting require a restart to take effect.
* This setting is optional.
* Maximum value: 10
* Default: 2
maxAttributeQueryQueueSize = <integer>
* The number of attribute query requests to queue, set to 0 for infinite
size.
* Changes to this setting require a restart to take effect.
* This setting is optional.
* Default: 10000
attributeQueryTTL = <integer>
* Determines the time for which the Splunk platform caches the user and role
information (time to live).
* After the ttl expires, the Splunk platform makes an attribute query request to
retrieve the role information.
* This setting is optional.
* Default: 21600
saml_negative_cache_timeout = <nonnegative decimal>
* The amount of time, in seconds, that the Splunk platform remembers that a non-existent
user on a SAML provider does not exist.
* This setting is useful when you want to avoid frequent SAML queries for users
that do not exist on the SAML provider.
* This setting does not prevent SAML queries on login. Login always queries the SAML
provider to confirm that a user exists.
* Default: 3600
scriptPath = <string>
* The name of the authentication extension script to run.
* The auth system expects the script to be in Python version 3, and looks for
it in the $SPLUNK_HOME/etc/auth/scripts directory.
* No default.
python.version = {default|python|python2|python3|python3.7|python3.9|latest}
* For Python scripts only, selects which Python version to use.
* Set to either "default" or "python" to use the system-wide default Python
version.
* Set to "python3" or "python3.7" to use the Python 3.7 version.
* Set to "python3.9" to use the Python 3.9 version.
* In the context of configuring apps, the "latest" value is not currently
supported. It is related to a feature that is still under development.
* Optional.
* Default: Not set; uses the system-wide Python version.
scriptTimeout = <string>
* The maximum time the script can run before the auth system forcefully terminates it.
* If you set to zero, the auth system never kills the script.
* If you set to below 500ms, the auth system uses a minimum of 500 ms.
* Optional
* Default: 10s
scriptFunctions = <semicolon-separated list>
* Script functions to be enabled for authentication extensions.
* Expressed as a list.
* Supported values are 'getUsers', 'getUserInfo', and 'login'.
* To use the 'getUsers' function, you must also enable the 'getUserInfo' function.
* You must set this if you define 'scriptPath'.
* No default.
getUsersPrecacheLimit = <integer>
* The number of users to pre-cache on startup for the 'getUsers' script function.
* If you enable the 'getUsers' function, the script executes when splunkd starts up.
* As part of startup, splunkd caches user information that the 'getUsers' script returns,
and this setting specifies how many users to cache.
* If you set 'getUsersPrecacheLimit' to 0, splunkd caches all user information that
the 'getUsers' function returns.
* Default: 1000
getUserInfoTtl = <string>
* When you configure the auth system to use SAML as an authentication method,
it runs the 'getUserInfo' script function to retrieve information from the
SAML identity provider when users perform ad-hoc operations such as working
with tokens and saved searches.
* This setting controls how long the auth system caches information that it
retrieves with the 'getUserInfo' script function.
* This setting does not control how the method retrieves user information
when one logs in using the standard SAML login flow through a browser.
* These return values are cached on a per-user basis.
* This value also applies if users are retrieved en masse using the scripts
getUsers() function.
* If you configure both AQR and authentication extensions (meaning, you configure
both 'attributeQueryTTL' and 'getUserInfoTtl'), this setting takes precedence.
* This setting is optional.
* Default: 21600s
scriptSecureArguments = <key:value>;[<key:value>;]...
* A list of inputs, expressed as key-value pairs, that will be made available
in plaintext to the custom user information retrieval script.
* On startup, the auth system encrypts the values you specify here.
* Use this setting to safely store passwords, tokens, or other credentials
that the script needs to function.
* If you use the 'commonAuth.py' sample script to read in the inputs, these values
are available as normal arguments for all functions.
* This setting is optional.
* No default.
useAuthExtForTokenAuthOnly = <boolean>
* Whether authentication extension scripts run for all types of authentication,
or only for token based authentication.
* If set to "true", the 'getUserInfo' script only runs when making token based authentication calls.
* Other calls that rely on fetching SAML user information,
such as saved searches and displaying SAML users,
will use the persistent cache that is defined in the [userToRoleMap_<saml-authSettings-key>] stanza.
* This setting is optional.
* Default: true
cacheSAMLUserInfotoDisk = <boolean>
* Whether the Splunk auth system only keeps SAML user mapping
information in server memory or additionally caches the information
locally in the authentication.conf configuration file.
* Using this setting helps keep SAML users consistent in distributed
Splunk platform environments such as search head clusters.
* This setting is only valid in one of the following scenarios:
* When the SAML identity provider that you use supports Attribute
Query Responses (AQR), or
* When the SAML identity provider does not support AQR, and you
configure both authentication extensions and the 'useAuthExtForTokenAuthOnly'
setting with a value of "false".
* A value of "true" means that the auth system writes SAML user map
information to the authentication.conf file, under the '[userToRoleMap_SAML]' stanza.
For example: jdoe = admin,power::John Doe::jdoe@company.com
* A value of "false" means that the auth system keeps SAML user map
information in server memory only, and does not write information to
the authentication.conf file.
* If the SAML IdP does not support AQR, and you configure authentication
extensions and give 'useAuthExtforTokenAuthOnly' a value of "true", then
the auth system automatically caches SAML user info to disk, as if you
had configured this setting with a value of "true".
* This setting is optional.
* Default: false
assertionTimeSkew = <integer>
* The amount of clock skew, in seconds, that can occur between the Splunk platform and
an identity provider that presents SAML assertions that contain 'NotBefore'
and 'NotOnOrAfter' attributes.
* If you set this, the Splunk platform accepts a SAML assertion as valid if
the clock skew between the assertion validity interval and the system time on the
Splunk instance is not greater than the value of this setting.
* NOTE: Setting this to too high a value can allow for replay attacks and is a security risk.
* This setting is optional.
* Default: 120
allowSslCompression = <boolean>
* If set to true, the server allows clients to negotiate SSL-layer
data compression.
* This setting is optional.
* Default: The value of 'allowSslCompression' in the server.conf file
cipherSuite = <cipher suite string>
* If set, the Splunk platform uses the specified cipher string for the HTTP server.
* Attribute query requests might fail if the IDP requires a relaxed
ciphersuite.
* Use "openssl s_client -cipher 'TLSv1+HIGH:@STRENGTH' -host <IDP host> -port 443"
to determine if the Splunk platform can connect to the IDP.
* This setting is optional.
* Default: The value or 'cipherSuite' in the server.conf file
sslVersions = <versions_list>
* Comma-separated list of SSL versions to support.
* The versions available are "ssl3", "tls1.0", "tls1.1", and "tls1.2"
* Default: The value of 'sslVersions' in the server.conf file
sslCommonNameToCheck = <commonName>
* If set, and 'sslVerifyServerCert' is set to true,
splunkd limits most outbound HTTPS connections to hosts which use
a cert with this common name.
* This setting is optional.
* Default: The value of 'cipherSuite' in the server.conf file
sslAltNameToCheck = <alternateName1>, <alternateName2>, ...
* If this value is set, and 'sslVerifyServerCert' is set to true,
splunkd is also willing to verify certificates which have a so-called
"Subject Alternate Name" that matches any of the alternate names in this list.
* This setting is optional.
* Default: The value of 'sslAltNametoCheck' in the server.conf file
ecdhCurveName = <string>
* DEPRECATED; use 'ecdhCurves' instead.
* Elliptic Curve-Diffie Hellman (ECDH) curve to use for ECDH key negotiation.
* Default: The value of 'ecdhCurveName' in the server.conf file
ecdhCurves = <comma separated list>
* ECDH curves to use for ECDH key negotiation.
* The curves should be specified in the order of preference.
* The client sends these curves as a part of Client Hello.
* The server supports only the curves specified in the list.
* The Splunk platform only supports named curves that have been
specified by their SHORT names.
* The list of valid named curves by their short/long names can be obtained
by executing this CLI command:
$SPLUNK_HOME/bin/splunk cmd openssl ecparam -list_curves
* Example setting: ecdhCurves = prime256v1,secp384r1,secp521r1
* Default: The value of 'ecdhCurves' in the server.conf file
clientCert = <path>
* Full path to the client certificate Privacy-Enhanced Mail (PEM) format file.
* Certificates are auto-generated upon first starting the Splunk platform.
* You may replace the auto-generated certificate with your own.
* If not set, Splunk uses the setting specified in
server.conf/[sslConfig]/'serverCert'.
* Default: $SPLUNK_HOME/etc/auth/server.pem
sslKeysfile = <filename>
* DEPRECATED; use 'clientCert' instead.
* Location of the PEM file in the directory specified by 'caPath'.
* Default: server.pem
sslPassword = <password>
* The server certificate password.
* If not set, the Splunk platform uses the setting specified in server.conf.
* This setting is optional.
* Default: password
sslKeysfilePassword = <password>
* DEPRECATED; use 'sslPassword' instead.
caCertFile = <filename>
* The public key of the signing authority.
* If not set, the Splunk platform uses the setting specified in server.conf.
* This setting is optional.
* Default: cacert.pem
caPath = <path>
* DEPRECATED; use absolute paths for all certificate files.
* If certificate files given by other settings in this stanza are not absolute
paths, then they are relative to this path.
* Default: $SPLUNK_HOME/etc/auth
sslVerifyServerCert = <boolean>
* Used by distributed search: when making a search request to another
server in the search cluster.
* If not set, the Splunk platform uses the setting specified in server.conf.
* This setting is optional.
* No default.
sslVerifyServerName = <boolean>
* Whether or not splunkd, as a client, performs a TLS hostname validation check
on an SSL certificate that it receives upon an initial connection
to a server.
* A TLS hostname validation check ensures that a client
communicates with the correct server, and has not been redirected to
another by a machine-in-the-middle attack, where a malicious party inserts
themselves between the client and the target server, and impersonates
that server during the session.
* Specifically, the validation check forces splunkd to verify that either
the Common Name or the Subject Alternate Name in the certificate that the
server presents to the client matches the host name portion of the URL that
the client used to connect to the server.
* For this setting to have any effect, the 'sslVerifyServerCert' setting must
have a value of "true". If it doesn't, TLS hostname validation is not possible
because certificate verification is not on.
* A value of "true" for this setting means that splunkd performs a TLS hostname
validation check, in effect, verifying the server's name in the certificate.
If that check fails, splunkd terminates the SSL handshake immediately. This terminates
the connection between the client and the server. Splunkd logs this failure at
the ERROR logging level.
* A value of "false" means that splunkd does not perform the TLS hostname
validation check. If the server presents an otherwise valid certificate, the
client-to-server connection proceeds normally.
* Default: false
blacklistedAutoMappedRoles = <comma separated list>
* DEPRECATED; use 'excludedAutoMappedRoles' instead.
enableAutoMappedRoles = <boolean>
* Whether or not the Splunk platform maps SAML groups on an identity provider
to Splunk local roles with the same name automatically.
* A value of "true" means the Splunk platform tries to map IdP groups to
local roles with matching names.
* If the IdP groups are empty, the Splunk platform tries to
map 'defaultRoleIfMissing' if it has a value.
* A value of "false" means the Splunk platform uses predefined
SAML group mappings only, and ignores the 'defaultRoleIfMissing' setting.
* This setting is optional.
* Default: true
excludedAutoMappedRoles = <comma separated list>
* A list of Splunk roles for which the Splunk platform is not to
auto-map from the identity provider response.
* This setting is optional.
* Default: admin, power
blacklistedUsers = <comma separated list>
* DEPRECATED; use 'excludedUsers' instead.
excludedUsers = <comma separated list>
* Comma separated list of user names from the IDP response to be
excluded by splunk platform.
* This setting is optional.
* No default.
nameIdFormat = <string>
* If supported by IDP, while making SAML Authentication request this value can
be used to specify the format of the Subject returned in SAML Assertion.
* This setting is optional.
* No default.
ssoBinding = <string>
* The binding that is used when making a SP-initiated SAML request.
* Acceptable options are "HTTPPost" and "HTTPRedirect".
* This binding must match the one configured on the IDP.
* This setting is optional.
* Default: HTTPPost
sloBinding = <string>
* The binding that is used when making a logout request or sending a logout
response to complete the logout workflow.
* Acceptable options are "HTTPPost" and "HTTPRedirect".
* This binding must match the one configured on the IDP.
* This setting is optional.
* Default: HTTPPost
signatureAlgorithm = RSA-SHA1 | RSA-SHA256 | RSA-SHA384 | RSA-SHA512
* The signature algorithm that is used for outbound SAML messages,
for example, SP-initiated SAML request.
* This setting is only used when 'signAuthnRequest' is set to "true".
* This setting is applicable for both HTTP POST and HTTP Redirect binding.
* RSA-SHA1 corresponds to 'http://www.w3.org/2000/09/xmldsig#rsa-sha1'.
* RSA-SHA256, RSA-SHA384, and RSA-SHA512 correspond to 'http://www.w3.org/2001/04/xmldsig-more'.
* This algorithm is sent as a part of 'sigAlg'.
* For improved security, set to "RSA-SHA256", "RSA-SHA384", or "RSA-SHA512".
* This setting is optional.
* Default: RSA-SHA1
inboundSignatureAlgorithm = RSA-SHA1;RSA-SHA256;RSA-SHA384;RSA-SHA512
* A semicolon-separated list of signature algorithms for the SAML responses
that you want Splunk Web to accept.
* The Splunk platform rejects any SAML responses that are not signed by
any one of the specified algorithms.
* This setting is applicable for both HTTP POST and HTTP Redirect binding.
* For improved security, set to "RSA-SHA256", "RSA-SHA384", or "RSA-SHA512".
* This setting is optional.
* Default: RSA-SHA1;RSA-SHA256;RSA-SHA384;RSA-SHA512
inboundDigestMethod = SHA1;SHA256;SHA384;SHA512
* A semicolon-separated list of digest methods for the SAML responses
that you want Splunk Web to accept.
* The Splunk platform rejects any SAML responses that are not hashed by
any one of the specified methods.
* This setting is applicable for HTTP POST binding only.
* For improved security, set to "SHA256", "SHA384", or "SHA512".
* This setting is optional.
* Default: SHA1;SHA256;SHA384;SHA512
replicateCertificates = <boolean>
* If set to "true", IdP certificate files are replicated across search head cluster setup.
* If disabled, IdP certificate files need to be replicated manually across SHC,
otherwise verification of SAML-signed assertions fails.
* This setting has no effect if search head clustering is disabled.
* This setting is optional.
* Default: true
lockRoleToFullDN = <boolean>
* Determines how the auth system handles authentication when it receives a
Security Assertion Markup Language (SAML) assertion from an identity
provider (IdP) in specific cases.
* This setting applies only under the following conditions:
* You have configured a Common Name (CN) mapping to a Splunk role
under a [roleMap_SAML] stanza in authentication.conf. The auth system
ignores this setting if you have configured a full Distinguished Name (DN)
role mapping.
* The IdP returns a full DN as part of the SAML assertion. The auth system
ignores this setting if the IdP does not return a full DN in the assertion.
* If set to "false", the auth system uses the first part of the DN that the IdP
provides in the assertion, and ignores the rest of the DN.
* If set to "true", the auth system does the following:
* If you have configured a role mapping under the [roleMap_SAML] stanza that
contains the full DN, the auth system uses the DN and logs the user in.
* If you have configured a role mapping under the [roleMap_SAML] stanza that
contains the CN, but not the full DN, the auth system successfully logs in
the first user whose CN matches the role mapping, and records the full
DN into a [lockedRoleToFullDNMap_SAML] stanza in authentication.conf.
* The auth system then rejects subsequent authentication attempts by users
that have a matching CN but do not have a full DN. It logs such rejections
in splunkd.log.
* To stop authentication failures in this case, as a Splunk admin, you must
add the DN to the [roleMap_SAML] stanza in authentication.conf. Editing the
[lockedRoleToFullDNMap_SAML] stanza to have different DNs with identical CNs
map to different roles is not supported.
* Example: if this setting is "true" and you map a role in authentication.conf
as follows:
[roleMap_SAML]
power=CN=PowerUsers
and later, a SAML assertion arrives with the following DN:
CN=PowerUsers,OU=Americas,DC=splunkcorp,DC=com
then the auth system logs in the user who presented this assertion,
writes an entry to authentication.conf like the following:
[lockedRoleToFullDNMap_SAML]
power=CN=PowerUsers,OU=Americas,DC=splunkcorp,DC=com
and rejects further login attempts from users that present an assertion with
the same CN ("CN=PowerUsers"), that is part of a different DN (for example,
"CN=PowerUsers,OU=EMEA,DC=splunkcorp,DC=com",
rather than "CN=PowerUsers,OU=Americas,DC=splunkcorp,DC=com").
* Default: true
allowPartialSignatures = <boolean>
* OPTIONAL
* When enabled, the Splunk authentication system only requires the SAML assertion block to be
signed (but not necessarily the entire SAML response).
* When disabled, the entire SAML response must be signed for the login to succeed.
* Defaults to 'true'
allowEntities = <boolean>
* Whether or not the Splunk authentication system considers
SAML assertions with XML entity references as valid.
* A value of "true" means the Splunk authentication system
considers SAML assertions with XML entity references as
valid assertions.
* A value of "false" means the Splunk authentication system
considers SAML assertions with XML entity references as invalid
assertions.
* CAUTION: Changing this setting from its default value could
potentially pose a security risk. Do not change the value without
explicit permission from Splunk Support.
* Default: false
Map roles
[roleMap_<saml-authSettings-key>] * The mapping of Splunk roles to SAML groups for the SAML stanza specified by '<authSettings-key>'. * If a SAML group is not explicitly mapped to a Splunk role, but has the same name as a valid Splunk role then for ease of configuration, it is auto-mapped to that Splunk role. * Follow this stanza name with several Role-to-Group(s) mappings as defined below. <Splunk RoleName> = <SAML group string> * Maps a Splunk role (from authorize.conf) to SAML groups * This SAML group list is semicolon delimited (no spaces). * List several of these setting/value pairs to map several Splunk roles to SAML Groups. * If the role mapping is not specified, Splunk expects Splunk roles in the assertion and attribute query response returned from the IDP.
SAML User Roles Map
[userToRoleMap_<saml-authSettings-key>] * The mapping of SAML user to Splunk roles, real names, and emails, for the SAML stanza specified by '<authSettings-key>'. * Follow this stanza name with several User-to-Role::Realname::Email mappings as defined below. * The auth system uses this stanza only in the following scenarios: * The IdP that the auth system interacts with supports neither Attribute Query Requests nor authentication extension scripts. * The IdP does support authentication scripts, but the 'useAuthExtForTokenAuthOnly' setting has a value of "true". <SAML User> = <Splunk Roles string>::<Realname>::<Email> * Maps a SAML user to a Splunk role(from authorize.conf), real name, and email * The Splunk Roles string is semicolon delimited (no spaces). * The Splunk Roles string, Realname and Email are :: delimited (no spaces).
Locked up map of roles to SAML group DNs
[lockedRoleToFullDNMap_<saml-authSettings-key>]
* This stanza is an output stanza that the Splunk auth system creates
only under certain conditions.
* The stanza applies only if you have set 'lockRoleToFullDN' to "true".
Nothing happens if 'lockRoleToFullDN' is "false".
* See the 'lockRoleToFullDN' setting for information on the acronyms that
are used in this setting description.
* When the auth system receives a SAML assertion from an IdP that includes
a group DN, it performs several checks:
* First, it checks to see if the CN portion of the group DN that the IdP
provided in the assertion is a match to any CN that you have configured
in authentication.conf under the '[roleMap_SAML]' stanza.
* If a CN matches, and you have not previously performed a mapping
of SAML group DN to Splunk role, the auth system creates an entry underneath
this stanza, in the following format:
<Splunk role name> = <SAML group DN string>
* This means that the auth system has locked the Splunk role name that
you configured in the '[roleMap_SAML]' stanza to the DN that the IdP
provided in the assertion.
* After creating the entry, the auth system maps a user with the group
DN that the IdP provided to the corresponding Splunk role and lets this
user - and only this user - log in.
* It then rejects users that present the same CN, but that do not provide a
DN that exactly matches what was written under this stanza, for this
Splunk role, on future login attempts.
* It also writes a warning message to splunkd.log stating that the DN that
the IdP presented has already been locked to a Splunk role.
* Entries in this stanza map a Splunk role to a semicolon separated list of
group DNs. DNs referenced in this stanza are enforced to have unique CNs
(a CN cannot map to multiple DNs).
Authentication Response Attribute Map
[authenticationResponseAttrMap_SAML] * The Splunk platform expects emails, real names, and roles to be returned as SAML attributes in SAML assertion. This stanza can be used to map attribute names to what is expected. These are optional settings, and are only needed for certain IDPs. role = <string> * Attribute name to be used as role in SAML Assertion. * This setting is optional. * Default: role realName = <string> * Attribute name to be used as realName in SAML Assertion. * This setting is optional. * Default: realName mail = <string> * Attribute name to be used as email in SAML Assertion. * This setting is optional. * Default: mail
Settings for Proxy SSO mode
[roleMap_proxySSO] * The mapping of Splunk roles to groups passed in headers from the proxy server. * If a group is not explicitly mapped to a Splunk role, but has the same name as a valid Splunk role, then, for ease of configuration, it is auto-mapped to that Splunk role. * Follow this stanza name with several Role-to-Group(s) mappings as defined later in this section. <Splunk RoleName> = <Group string> * Maps a Splunk role (from authorize.conf) to one or more groups. * This group list is semicolon delimited (no spaces). * List several of these setting value pairs to map several Splunk roles to groups. * If role mapping is not specified, the user is logged in with the default User role. * No default. [userToRoleMap_proxySSO] * The mapping of ProxySSO user to Splunk roles * Follow this stanza name with several User-to-Role(s) mappings as defined later in this section. <ProxySSO User> = <Splunk Roles string> * Maps a ProxySSO user to Splunk role (from authorize.conf). * This Splunk Role list is semicolon delimited (no spaces). * No default. [proxysso-authsettings-key] * Follow this stanza name with the setting/value pairs listed below. defaultRoleIfMissing = <splunk role> * If Splunk roles cannot be determined based on role mapping, the Splunk platform uses the default configured splunk role. * This setting is optional. blacklistedAutoMappedRoles = <comma separated list> * DEPRECATED; use 'excludedAutoMappedRoles' instead. excludedAutoMappedRoles = <comma separated list> * Comma-separated list of Splunk roles that should be prevented from being auto-mapped by the Splunk platform from the proxy server headers. * This setting is optional. blacklistedUsers = <comma separated list> * DEPRECATED; use 'excludedUsers' instead. excludedUsers = <comma separated list> * Comma-separated list of user names from the proxy server headers to be excluded by the Splunk platform. * This setting is optional.
Secret Storage
[secrets]
disabled = <boolean>
* Toggles integration with platform-provided secret storage facilities.
* NOTE: Splunk plans to submit Splunk Enterprise for Common Criteria
evaluation. Splunk does not support using the product in Common
Criteria mode until it has been certified by NIAP. See the "Securing
Splunk Enterprise" manual for information on the status of Common
Criteria certification.
* Default (if Common Criteria mode is enabled): false
* Default (if Common Criteria mode is disabled): true
filename = <filename>
* Designates a Python script that integrates with platform-provided
secret storage facilities, like the GNOME keyring software for the
GNOME desktop manager.
* Set <filename> to the name of a Python script located in one of the
following directories:
$SPLUNK_HOME/etc/apps/*/bin
$SPLUNK_HOME/etc/system/bin
* Set <filename> to a basename. Do not user a name with path separators.
* Ensure <filename> ends with a .py file extension.
* No default.
namespace = <string>
* Use an instance-specific string as a namespace within secret storage.
* When using GNOME keyring, this namespace is used as a keyring name.
* If multiple Splunk instances must store separate sets of secrets within the
same storage backend, customize this value to be unique for each
Splunk instance.
* Default: splunk
Duo Multi-Factor Authentication (MFA) vendor settings
[<duo-externalTwoFactorAuthSettings-key>] * <duo-externalTwoFactorAuthSettings-key> must be the value listed in the 'externalTwoFactorAuthSettings' setting, specified in the [authentication] stanza. * This stanza contains Duo specific multifactor authentication settings and is activated only when you set 'externalTwoFactorAuthVendor' to "Duo". * All the following settings, except 'appSecretKey', are provided by Duo. universalPrompt = <boolean> * Whether or not the Splunk platform uses the Duo Universal Prompt experience for Duo multifactor authentication (MFA). * A value of "true" means the Splunk platform uses the Universal Prompt experience when you configure multifactor authentication with Duo. * A value of "false" means the Splunk platform uses the existing Traditional Prompt experience for Duo MFA. * NOTE: Duo has announced the deprecation of the Traditional Prompt as a method of authenticating using Duo MFA. Continued use of Traditional Prompt for MFA might result in authentication failure in the future. * Default: true apiHostname = <string> * The name of the server that hosts the Duo API endpoint which performs the multifactor authentication. * Example: apiHostname = api-xyz.duosecurity.com * For Duo MFA to work, you must specify a value for this setting. * No default. integrationKey = <string> * The Duo integration key or client ID for the Splunk platform. * Must be of size = 20. * For security reasons, the Splunk platform obfuscates the integration key before saving it into the authentication.conf configuration file. * Required. * No default. secretKey = <string> * The Duo secret key or client secret for the Splunk platform. * Must be of size = 40. * For security reasons, the Splunk platform obfuscates the secret key before saving it into the authentication.conf configuration file. * Required. * No default. appSecretKey = <string> * The Splunk application specific secret key which should be random and locally generated. * Must be at least of size = 40 or longer. * This secret key is not shared with Duo. * Application secret key is obfuscated before being saved here for security. * For Duo MFA to work, you must specify a value for this setting if the 'universalPrompt' setting has a value of "false". * No default. failOpen = <boolean> * If set to "true", the Splunk platform bypasses Duo multifactor authentication when the service is unavailable. * This setting is optional. * Default: false timeout = <integer> * The connection timeout, in seconds, for the outbound Duo HTTPS connection. * This setting is optional. * Default: The default Splunk HTTPS connection timeout sslVersions = <versions_list> * Comma-separated list of SSL versions to support for incoming connections. * The versions available are "ssl3", "tls1.0", "tls1.1", and "tls1.2". * This setting is optional. * Default: The value of 'sslVersions in the server.conf file cipherSuite = <cipher suite string> * The cipher string for the HTTP server. * This setting is optional. * Default: The value of 'cipherSuite' in the server.conf file ecdhCurves = <comma separated list of ec curves> * ECDH curves to use for ECDH key negotiation. * This setting is optional. * Default: The value of 'ecdhCurves' in the server.conf file sslVerifyServerCert = <boolean> * If set to true, the Splunk platform confirms the server that is being connected to is a valid server (authenticated). * Both the common name and the alternate name of the server are then checked for a match, if they are specified in this configuration file. * A certificate is considered verified if either is matched. * This setting is optional. * Default: false sslVerifyServerName = <boolean> * Whether or not splunkd, as a client, performs a TLS hostname validation check on an SSL certificate that it receives upon an initial connection to a server. * A TLS hostname validation check ensures that a client communicates with the correct server, and has not been redirected to another by a machine-in-the-middle attack, where a malicious party inserts themselves between the client and the target server, and impersonates that server during the session. * Specifically, the validation check forces splunkd to verify that either the Common Name or the Subject Alternate Name in the certificate that the server presents to the client matches the host name portion of the URL that the client used to connect to the server. * For this setting to have any effect, the 'sslVerifyServerCert' setting must have a value of "true". If it doesn't, TLS hostname validation is not possible because certificate verification is not on. * A value of "true" for this setting means that splunkd performs a TLS hostname validation check, in effect, verifying the server's name in the certificate. If that check fails, splunkd terminates the SSL handshake immediately. This terminates the connection between the client and the server. Splunkd logs this failure at the ERROR logging level. * A value of "false" means that splunkd does not perform the TLS hostname validation check. If the server presents an otherwise valid certificate, the client-to-server connection proceeds normally. * Default: false sslCommonNameToCheck = <commonName1>, <commonName2>, ... * If set, the Splunk platform limits outbound Duo HTTPS connections to a host which use a certificate with one of the listed common names. * 'sslVerifyServerCert' must be set to "true" for this setting to work. * This setting is optional. * No default. sslAltNameToCheck = <alternateName1>, <alternateName2>, ... * If set, the Splunk platform limits outbound duo HTTPS connections to host which use a certificate with one of the listed alternate names. * 'sslVerifyServerCert' must be set to true for this setting to work. * This setting is optional. * No default. sslRootCAPath = <path> * The full path of a PEM format file containing one or more root CA certificates concatenated together. * This Root CA must match the CA in the certificate chain of the SSL certificate returned by the Duo server. * This setting is optional. * No default. useClientSSLCompression = <boolean> * Whether or not compression is enabled between the Splunk instance and a Duo server. * If set to "true" on client side, compression is enabled between the server and client as long as the server also supports it. * If not set, the Splunk platform uses the client SSL compression setting provided in server.conf * This setting is optional. * Default: false enableMfaAuthRest = <boolean> * Determines whether splunkd requires Duo multifactor authentication against REST endpoints. * When Duo multifactor authentication is enabled for REST endpoints, you must log in to the Splunk platform instance with a valid Duo multifactor authentication factor to get a valid session key, or requests to those endpoints must include a valid session key in the following format: 'curl -k -H "Authorization:Splunk sessionKey" -X GET <resource>' * A value of "true" means splunkd requires Duo multifactor authentication against REST endpoints. * A value of "false" means splunkd does not require Duo multifactor authentication against REST endpoints. * Optional. * Default: false
RSA MFA vendor settings
[<rsa-externalTwoFactorAuthSettings-key>] * <rsa-externalTwoFactorAuthSettings-key> must be the value listed in the externalTwoFactorAuthSettings setting specified in the [authentication] stanza. * This stanza contains RSA-specific multifactor authentication settings and is activated only when you set 'externalTwoFactorAuthVendor' to "RSA". * All the following settings can be obtained from RSA Authentication Manager 8.2 SP1. authManagerUrl = <string> * URL of the REST endpoint of RSA Authentication Manager. * The Splunk platform sends authentication requests to this URL. * Specify a HTTPS-based URL. the Splunk platform does not support communication over HTTP. * Required. * No default. accessKey = <string> * Access key needed by the Splunk platform to communicate with RSA Authentication Manager. * Required. * No default. clientId = <string> * The clientId is the agent name created on RSA Authentication Manager. * Required. * No default. failOpen = <boolean> * Whether or not the Splunk platform allows login if the RSA MFA server is unavailable. * If set to "true", allow login in case authentication server is unavailable. * This setting is optional. * Default: false timeout = <integer> * The connection timeout, in seconds, for the outbound HTTPS connection to the RSA server. * This setting is optional. * Default: 5 messageOnError = <string> * The message that the Splunk platform shows to the user in the case of a login failure. * You can specify contact of admin or link to a diagnostic page. * This setting is optional. * No default. sslVersions = <versions_list> * Comma-separated list of SSL versions to support for incoming connections. * The versions available are "ssl3", "tls1.0", "tls1.1", and "tls1.2". * If not set, the Splunk platform uses the value of 'sslVersions' in server.conf. * This setting is optional. * Default: tls1.2 cipherSuite = <cipher suite string> * If set, the Splunk platform uses the specified cipher string for the HTTP server. * If not set, the Splunk platform uses the value for 'cipherSuite' specified in server.conf * This setting is optional. ecdhCurves = <comma separated list of ec curves> * ECDH curves to use for ECDH key negotiation. * This setting is optional. * Default: The value of 'ecdhCurves' in the server.conf file sslVerifyServerCert = <boolean> * Determines whether to verify the server being connected to is authenticated. * If this is set to true, you should make sure that the server that is being connected to is a valid one (authenticated). Both the common name and the alternate name of the server are then checked for a match if they are specified in this configuration file. A certificate is considered verified if either is matched. * This setting is optional. * Default: true sslVerifyServerName = <boolean> * Whether or not splunkd, as a client, performs a TLS hostname validation check on an SSL certificate that it receives upon an initial connection to a server. * A TLS hostname validation check ensures that a client communicates with the correct server, and has not been redirected to another by a machine-in-the-middle attack, where a malicious party inserts themselves between the client and the target server, and impersonates that server during the session. * Specifically, the validation check forces splunkd to verify that either the Common Name or the Subject Alternate Name in the certificate that the server presents to the client matches the host name portion of the URL that the client used to connect to the server. * For this setting to have any effect, the 'sslVerifyServerCert' setting must have a value of "true". If it doesn't, TLS hostname validation is not possible because certificate verification is not on. * A value of "true" for this setting means that splunkd performs a TLS hostname validation check, in effect, verifying the server's name in the certificate. If that check fails, splunkd terminates the SSL handshake immediately. This terminates the connection between the client and the server. Splunkd logs this failure at the ERROR logging level. * A value of "false" means that splunkd does not perform the TLS hostname validation check. If the server presents an otherwise valid certificate, the client-to-server connection proceeds normally. * Default: false sslCommonNameToCheck = <commonName1>, <commonName2>, ... * If this value is set, the Splunk platform limits outbound RSA HTTPS connections to host which use a cert with one of the listed common names. * 'sslVerifyServerCert' must be set to true for this setting to work. * This setting is optional. * No default. sslAltNameToCheck = <alternateName1>, <alternateName2>, ... * If this value is set, the Splunk platform limits outbound RSA HTTPS connections to host which use a cert with one of the listed alternate names. * 'sslVerifyServerCert' must be set to true for this setting to work. * This setting is optional. * No default. sslRootCAPath = <path> * The <path> must refer to full path of a PEM format file containing one or more root CA certificates concatenated together. * Required. * This Root CA must match the CA in the certificate chain of the SSL certificate returned by RSA server. * No default. sslVersionsForClient = <versions_list> * Comma-separated list of SSL versions to support for outgoing HTTP connections. * If not set, Splunk uses the value for 'sslVersionsForClient' in server.conf. * This setting is optional. * Default: tls1.2 replicateCertificates = <boolean> * Whether or not RSA certificate files are automatically replicated across search head cluster nodes. * If set to "true", RSA certificate files are replicated across nodes in a search head cluster. * If disabled, RSA certificate files need to be replicated manually across SHC or else MFA verification fails. * This setting has no effect if search head clustering is disabled. * Default: true enableMfaAuthRest = <boolean> * Determines whether splunkd requires RSA two-factor authentication against REST endpoints. * When two-factor authentication is enabled for REST endpoints, either you must log in to the Splunk instance with a valid RSA passcode, or requests to those endpoints must include a valid token in the following format: "curl -k -u <username>:<password>:<token> -X GET <resource>" * If set to "true", splunkd requires RSA REST two-factor authentication. * If set to "false", splunkd does not require REST two-factor authentication. * This setting is optional. * Default: false
authentication.conf.example
# Version 9.4.0 # # This is an example authentication.conf. authentication.conf is used to # configure LDAP, Scripted, SAML and Proxy SSO authentication in addition # to Splunk's native authentication. # # To use one of these configurations, copy the configuration block into # authentication.conf in $SPLUNK_HOME/etc/system/local/. You must reload # auth in manager or restart Splunk to enable configurations. # # To learn more about configuration files (including precedence) please see # the documentation located at # http://docs.splunk.com/Documentation/Splunk/latest/Admin/Aboutconfigurationfiles ##### Use just Splunk's built-in authentication (default): [authentication] authType = Splunk ##### LDAP examples #### Basic LDAP configuration example [authentication] authType = LDAP authSettings = ldaphost [ldaphost] host = ldaphost.domain.com port = 389 SSLEnabled = 0 bindDN = cn=Directory Manager bindDNpassword = password userBaseDN = ou=People,dc=splunk,dc=com userBaseFilter = (objectclass=splunkusers) groupBaseDN = ou=Groups,dc=splunk,dc=com groupBaseFilter = (objectclass=splunkgroups) userNameAttribute = uid realNameAttribute = givenName groupMappingAttribute = dn groupMemberAttribute = uniqueMember groupNameAttribute = cn timelimit = 10 network_timeout = 15 # This stanza maps roles you have created in authorize.conf to LDAP Groups [roleMap_ldaphost] admin = SplunkAdmins #### Example using the same server as 'ldaphost', but treating each user as #### their own group [authentication] authType = LDAP authSettings = ldaphost_usergroups [ldaphost_usergroups] host = ldaphost.domain.com port = 389 SSLEnabled = 0 bindDN = cn=Directory Manager bindDNpassword = password userBaseDN = ou=People,dc=splunk,dc=com userBaseFilter = (objectclass=splunkusers) groupBaseDN = ou=People,dc=splunk,dc=com groupBaseFilter = (objectclass=splunkusers) userNameAttribute = uid realNameAttribute = givenName groupMappingAttribute = uid groupMemberAttribute = uid groupNameAttribute = uid timelimit = 10 network_timeout = 15 [roleMap_ldaphost_usergroups] admin = admin_user1;admin_user2;admin_user3;admin_user4 power = power_user1;power_user2 user = user1;user2;user3 #### Sample Configuration for Active Directory (AD) [authentication] authSettings = AD authType = LDAP [AD] SSLEnabled = 1 bindDN = ldap_bind@splunksupport.kom bindDNpassword = ldap_bind_user_password groupBaseDN = CN=Groups,DC=splunksupport,DC=kom groupBaseFilter = groupMappingAttribute = dn groupMemberAttribute = member groupNameAttribute = cn host = ADbogus.splunksupport.kom port = 636 realNameAttribute = cn userBaseDN = CN=Users,DC=splunksupport,DC=kom userBaseFilter = userNameAttribute = sAMAccountName timelimit = 15 network_timeout = 20 anonymous_referrals = 0 [roleMap_AD] admin = SplunkAdmins power = SplunkPowerUsers user = SplunkUsers #### Sample Configuration for Sun LDAP Server [authentication] authSettings = SunLDAP authType = LDAP [SunLDAP] SSLEnabled = 0 bindDN = cn=Directory Manager bindDNpassword = Directory_Manager_Password groupBaseDN = ou=Groups,dc=splunksupport,dc=com groupBaseFilter = groupMappingAttribute = dn groupMemberAttribute = uniqueMember groupNameAttribute = cn host = ldapbogus.splunksupport.com port = 389 realNameAttribute = givenName userBaseDN = ou=People,dc=splunksupport,dc=com userBaseFilter = userNameAttribute = uid timelimit = 5 network_timeout = 8 [roleMap_SunLDAP] admin = SplunkAdmins power = SplunkPowerUsers user = SplunkUsers #### Sample Configuration for OpenLDAP [authentication] authSettings = OpenLDAP authType = LDAP [OpenLDAP] bindDN = uid=directory_bind,cn=users,dc=osx,dc=company,dc=com bindDNpassword = directory_bind_account_password groupBaseFilter = groupNameAttribute = cn SSLEnabled = 0 port = 389 userBaseDN = cn=users,dc=osx,dc=company,dc=com host = hostname_OR_IP userBaseFilter = userNameAttribute = uid groupMappingAttribute = uid groupBaseDN = dc=osx,dc=company,dc=com groupMemberAttribute = memberUid realNameAttribute = cn timelimit = 5 network_timeout = 8 dynamicGroupFilter = (objectclass=groupOfURLs) dynamicMemberAttribute = memberURL nestedGroups = 1 [roleMap_OpenLDAP] admin = SplunkAdmins power = SplunkPowerUsers user = SplunkUsers ##### Scripted Auth examples #### The following example is for RADIUS authentication: [authentication] authType = Scripted authSettings = script [script] scriptPath = "$SPLUNK_HOME/bin/python" "$SPLUNK_HOME/share/splunk/authScriptSamples/radiusScripted.py" # Cache results for 1 second per call [cacheTiming] userLoginTTL = 1 userInfoTTL = 1 #### The following example works with PAM authentication: [authentication] authType = Scripted authSettings = script [script] scriptPath = "$SPLUNK_HOME/bin/python" "$SPLUNK_HOME/share/splunk/authScriptSamples/pamScripted.py" # Cache results for different times per function [cacheTiming] userLoginTTL = 30s userInfoTTL = 1min ##### SAML auth example [authentication] authSettings = samlv2 authType = SAML [samlv2] attributeQuerySoapPassword = changeme attributeQuerySoapUsername = test entityId = test-splunk idpAttributeQueryUrl = https://exsso/idp/attrsvc.ssaml2 idpCertPath = /home/splunk/etc/auth/idp.crt idpSSOUrl = https://exsso/idp/SSO.saml2 idpSLOUrl = https://exsso/idp/SLO.saml2 signAuthnRequest = true signedAssertion = true attributeQueryRequestSigned = true attributeQueryResponseSigned = true redirectPort = 9332 cipherSuite = TLSv1 MEDIUM:@STRENGTH nameIdFormat = urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress [roleMap_SAML] admin = SplunkAdmins power = SplunkPowerUsers user = all [userToRoleMap_SAML] samluser = user::Saml Real Name::samluser@domain.com [authenticationResponseAttrMap_SAML] role = "http://schemas.microsoft.com/ws/2008/06/identity/claims/groups" mail = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" realName = "http://schemas.microsoft.com/identity/claims/displayname" # Multifactor authentication example [authentication] externalTwoFactorAuthVendor = duo externalTwoFactorAuthSettings = duo-mfa # Duo specific authentication setting example [duo-mfa] universalPrompt = true apiHostname = api-xyz.duosecurity.com appSecretKey = mustBeARandomStringOfSize40OrLonger integrationKey = mustBeADuoProvidedStringOfSize20 secretKey = mustBeADuoProvidedStringOfSize40 enableMfaAuthRest = true ##### Proxy SSO auth example [authentication] authSettings = my_proxy authType = ProxySSO [my_proxy] excludedUsers = user1,user2 excludedAutoMappedRoles = admin defaultRoleIfMissing = user [roleMap_proxySSO] admin = group1;group2 user = group1;group3 [userToRoleMap_proxySSO] proxy_user1 = user proxy_user2 = power;can_delete [splunk_auth] minPasswordLength = 8 minPasswordUppercase = 1 minPasswordLowercase = 1 minPasswordSpecial = 1 minPasswordDigit = 0 expirePasswordDays = 90 expireAlertDays = 15 expireUserAccounts = true forceWeakPasswordChange = false lockoutUsers = true lockoutAttempts = 5 lockoutThresholdMins = 5 lockoutMins = 30 enablePasswordHistory = false passwordHistoryCount = 24
Last modified on 02 December, 2024
| audit.conf | authorize.conf |
This documentation applies to the following versions of Splunk® Enterprise: 9.4.0
Download manual
Feedback submitted, thanks!