Splunk® Enterprise

Securing the Splunk Platform

Acrobat logo Download manual as PDF


Splunk Enterprise version 7.3 will no longer be supported as of October 22, 2021. See the Splunk Software Support Policy for details. For information about upgrading to a supported version, see How to upgrade Splunk Enterprise.
Acrobat logo Download topic as PDF

Configure a Splunk Enterprise password policy using the Authentication.conf configuration file

On Splunk Enterprise only, the authentication.conf file lets you create a password policy for users of your Splunk platform instance or deployment. Password policies set standards and minimum requirements for password complexity. The authentication.conf file is not applicable to Splunk Cloud, as you cannot configure the file on Splunk Cloud instances. Instead, use Splunk Web to configure passwords.

The policy you create with the file works with the native authentication scheme for Splunk Enterprise only. Password policies do not apply when you configure the instance to use the Lightweight Directory Access Protocol (LDAP) or Security Assertion Markup Language (SAML) authentication schemes.

Procedure for creating a password policy using configuration files

  1. Using a text editor, open the $SPLUNK_HOME/etc/system/local/authentication.conf file or editing.
  2. Make edits to the [splunk_auth] section of the file to set the password policy, using information in the table that follows this procedure.
  3. Save the file and close it.
  4. Restart Splunk Enterprise. The password policy comes into effect immediately.

The following table describes the details of each setting:

Setting Description Recommended value Default value
minPasswordLength Specify the minimum ASCII-based alphanumeric or special characters required when a user creates a new password. Splunk Enterprise supports values between 1 and 256 characters. At least 8 characters 8 characters
minPasswordUppercase The number of uppercase letters required for user passwords. At least one uppercase letter Zero uppercase characters
minPasswordLowercase The number of lowercase letters required for user passwords. At least one lowercase letter Zero lowercase characters
minPasswordSpecial The number of special characters required for user passwords. When this setting is populated, a user can enter any special character except a semicolon. At least one special character Zero special characters
minPasswordDigit The number of numeric characters required for user passwords. Value can be 0 through the length of the password. The total allowed length of the password is 256. Do not create a password comprised of only number. At least one number Zero numbers
expirePasswordDays The number of days before the password expires. Allowed values are 0 to 3650 days. 90 days 90 days
expireAlertDays The number of days in advance of password expiration that Splunk software issues user alerts. Allowed values are 0 to 120 days. 15 days 15 days
expireUserAccounts Set to true to enable password expiration. True False
forceWeakPasswordChange Set to true to force users to change a weak password the next time they log in. True False
lockoutUsers Specifies whether the system locks users out after a number of failed login attempts. When this setting is enabled, user lockout is local to each search head peer in a search cluster configuration and is not replicated to other peers. True True
lockoutMins The number of minutes that a user must wait before attempting to log in again after a lockout. The user is locked out after entering an incorrect password more times than specified in the lockoutAttempts value in the lockoutThresholdMins setting. Supported values are 1 - 1440 minutes.

When this setting is enabled on members of a search head cluster, user lockout is applied to individual members, not the entire cluster.

At least 30 minutes 30 minutes
lockoutAttempts The number of unsuccessful logins a user can attempt before they are locked out. The unsuccessful login attempts must occur within lockoutThresholdMins minutes. Supported values are 1 - 64 login attempts.

When enabled on members of a search head cluster, user lockout is applied to the single search head peer, the rest of the cluster is unaffected.

At least 5 attempts 5 attempts
lockoutThresholdMins The number of minutes that must pass from the time of the first failed login before the failed login attempt counter resets. Supported values are 1 - 120 minutes.

When this setting is enabled on members of a search head cluster, user lockout is applied to the single search head peer, the rest of the cluster is unaffected.

At least 5 minutes 5 minutes.
enablePasswordHistory Set to true to keep a user's password history. If you disable this value and and enable it later, previously saved password history is preserved. Delete $SPLUNK_HOME/etc/opasswd to remove the password history. True False
passwordHistoryCount The number of passwords that are stored in history. If you enable password history and provide a number such as 25, then the user is not able to reuse their previous 25 passwords. Supported values are 1 - 128 stored passwords. 24 stored passwords 24 stored passwords
Last modified on 28 July, 2021
PREVIOUS
Configure Splunk password policies
  NEXT
Password best practices for users

This documentation applies to the following versions of Splunk® Enterprise: 7.1.0, 7.1.1, 7.1.2, 7.1.3, 7.1.4, 7.1.5, 7.1.6, 7.1.7, 7.1.8, 7.1.9, 7.1.10, 7.2.0, 7.2.1, 7.2.2, 7.2.3, 7.2.4, 7.2.5, 7.2.6, 7.2.7, 7.2.8, 7.2.9, 7.2.10, 7.3.0, 7.3.1, 7.3.2, 7.3.3, 7.3.4, 7.3.5, 7.3.6, 7.3.7, 7.3.8, 7.3.9, 8.0.0, 8.0.1, 8.0.2, 8.0.3, 8.0.4, 8.0.5, 8.0.6, 8.0.7, 8.0.8, 8.0.9, 8.0.10, 8.1.0, 8.1.1, 8.1.2, 8.1.3, 8.1.4, 8.1.5, 8.1.6, 8.2.0, 8.2.1, 8.2.2


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