wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_salt › WordPress Function

Since2.5.0
Deprecatedn/a
wp_salt ( $scheme = 'auth' )
Parameters:
  • (string) $scheme Authentication scheme (auth, secure_auth, logged_in, nonce).
    Required: No
    Default: 'auth'
Links:
Returns:
  • (string) Salt value
Defined at:
Codex:

Returns a salt to add to hashes.

Salts are created using secret keys. Secret keys are located in two places: in the database and in the wp-config.php file. The secret key in the database is randomly generated and will be appended to the secret keys in wp-config.php. The secret keys in wp-config.php should be updated to strong, random keys to maximize security. Below is an example of how the secret key constants are defined. Do not paste this example directly into wp-config.php. Instead, have a {@link secret key created} just for you. define('AUTH_KEY', ' XakmM%G4Yt>fz]MON'); define('SECURE_AUTH_KEY', 'LzJ}op]mr|6+![P}Ak:uNdJCJZd>(Hx.-Mh#Tz)pCIU#uGEnfFz|f ;;eU%/U^O~'); define('LOGGED_IN_KEY', '|i|Ux9z7X>QYR0Z_XnZ@|'); define('AUTH_SALT', 'eZyT)-Naw]F8CwAVaW#q|.)g@o}||wf~@C-YSt}(dh_r6EbI#A,y|nU2{B#JBW'); define('SECURE_AUTH_SALT', '!=oLUTXh,QW=H }L|9/^4-3 STz},T(w}W.JjPi)<Bmf1v,HpGe}T1:Xt7n'); define('LOGGED_IN_SALT', '+XSqHc;@Q*K_b|Z?NC[3H!!EONbh.n<+=uKR:>*c(ug~EJBf#8u#R{mUEZrozmm'); define('NONCE_SALT', 'hGXHhD>SLWVfg1(1(N{;.V!MoE(SfbA_ksP@&+AycHcAV$+?@3q+rxV{%^VyKT'); Salting passwords helps against tools which has stored hashed values of common dictionary strings. The added values makes it harder to crack.


Source

function wp_salt( $scheme = 'auth' ) {
		static $cached_salts = array();
		if ( isset( $cached_salts[ $scheme ] ) ) {
			/**
			 * Filters the WordPress salt.
			 *
			 * @since 2.5.0
			 *
			 * @param string $cached_salt Cached salt for the given scheme.
			 * @param string $scheme      Authentication scheme. Values include 'auth',
			 *                            'secure_auth', 'logged_in', and 'nonce'.
			 */
			return apply_filters( 'salt', $cached_salts[ $scheme ], $scheme );
		}

		static $duplicated_keys;
		if ( null === $duplicated_keys ) {
			$duplicated_keys = array(
				'put your unique phrase here' => true,
			);

			/*
			 * translators: This string should only be translated if wp-config-sample.php is localized.
			 * You can check the localized release package or
			 * https://i18n.svn.wordpress.org/<locale code>/branches/<wp version>/dist/wp-config-sample.php
			 */
			$duplicated_keys[ __( 'put your unique phrase here' ) ] = true;

			foreach ( array( 'AUTH', 'SECURE_AUTH', 'LOGGED_IN', 'NONCE', 'SECRET' ) as $first ) {
				foreach ( array( 'KEY', 'SALT' ) as $second ) {
					if ( ! defined( "{$first}_{$second}" ) ) {
						continue;
					}
					$value                     = constant( "{$first}_{$second}" );
					$duplicated_keys[ $value ] = isset( $duplicated_keys[ $value ] );
				}
			}
		}

		/*
		 * Determine which options to prime.
		 *
		 * If the salt keys are undefined, use a duplicate value or the
		 * default `put your unique phrase here` value the salt will be
		 * generated via `wp_generate_password()` and stored as a site
		 * option. These options will be primed to avoid repeated
		 * database requests for undefined salts.
		 */
		$options_to_prime = array();
		foreach ( array( 'auth', 'secure_auth', 'logged_in', 'nonce' ) as $key ) {
			foreach ( array( 'key', 'salt' ) as $second ) {
				$const = strtoupper( "{$key}_{$second}" );
				if ( ! defined( $const ) || true === $duplicated_keys[ constant( $const ) ] ) {
					$options_to_prime[] = "{$key}_{$second}";
				}
			}
		}

		if ( ! empty( $options_to_prime ) ) {
			/*
			 * Also prime `secret_key` used for undefined salting schemes.
			 *
			 * If the scheme is unknown, the default value for `secret_key` will be
			 * used too for the salt. This should rarely happen, so the option is only
			 * primed if other salts are undefined.
			 *
			 * At this point of execution it is known that a database call will be made
			 * to prime salts, so the `secret_key` option can be primed regardless of the
			 * constants status.
			 */
			$options_to_prime[] = 'secret_key';
			wp_prime_site_option_caches( $options_to_prime );
		}

		$values = array(
			'key'  => '',
			'salt' => '',
		);
		if ( defined( 'SECRET_KEY' ) && SECRET_KEY && empty( $duplicated_keys[ SECRET_KEY ] ) ) {
			$values['key'] = SECRET_KEY;
		}
		if ( 'auth' === $scheme && defined( 'SECRET_SALT' ) && SECRET_SALT && empty( $duplicated_keys[ SECRET_SALT ] ) ) {
			$values['salt'] = SECRET_SALT;
		}

		if ( in_array( $scheme, array( 'auth', 'secure_auth', 'logged_in', 'nonce' ), true ) ) {
			foreach ( array( 'key', 'salt' ) as $type ) {
				$const = strtoupper( "{$scheme}_{$type}" );
				if ( defined( $const ) && constant( $const ) && empty( $duplicated_keys[ constant( $const ) ] ) ) {
					$values[ $type ] = constant( $const );
				} elseif ( ! $values[ $type ] ) {
					$values[ $type ] = get_site_option( "{$scheme}_{$type}" );
					if ( ! $values[ $type ] ) {
						$values[ $type ] = wp_generate_password( 64, true, true );
						update_site_option( "{$scheme}_{$type}", $values[ $type ] );
					}
				}
			}
		} else {
			if ( ! $values['key'] ) {
				$values['key'] = get_site_option( 'secret_key' );
				if ( ! $values['key'] ) {
					$values['key'] = wp_generate_password( 64, true, true );
					update_site_option( 'secret_key', $values['key'] );
				}
			}
			$values['salt'] = hash_hmac( 'md5', $scheme, $values['key'] );
		}

		$cached_salts[ $scheme ] = $values['key'] . $values['salt'];

		/** This filter is documented in wp-includes/pluggable.php */
		return apply_filters( 'salt', $cached_salts[ $scheme ], $scheme );
	}
endif;

if ( ! function_exists( 'wp_hash' ) ) :
	/**
	 * Gets hash of given string.
	 *
	 * @since 2.0.3
	 *
	 * @param string $data   Plain text to hash.
	 * @param string $scheme Authentication scheme (auth, secure_auth, logged_in, nonce).
	 * @return string Hash of $data.
	 */