class UserAuth in Drupal 9

Validates user authentication credentials.

Hierarchy

• class \Drupal\user\UserAuth implements UserAuthInterface

1 file declares its use of UserAuth

UserAuthTest.php in core/modules/user/tests/src/Unit/UserAuthTest.php

1 string reference to 'UserAuth'

user.services.yml in core/modules/user/user.services.yml

core/modules/user/user.services.yml

1 service uses UserAuth

user.auth in core/modules/user/user.services.yml

Drupal\user\UserAuth

File

core/modules/user/src/UserAuth.php, line 11

Namespace

Drupal\user

class UserAuth implements UserAuthInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The password hashing service.
   *
   * @var \Drupal\Core\Password\PasswordInterface
   */
  protected $passwordChecker;

  /**
   * Constructs a UserAuth object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Password\PasswordInterface $password_checker
   *   The password service.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, PasswordInterface $password_checker) {
    $this->entityTypeManager = $entity_type_manager;
    $this->passwordChecker = $password_checker;
  }

  /**
   * {@inheritdoc}
   */
  public function authenticate($username, $password) {
    $uid = FALSE;
    if (!empty($username) && strlen($password) > 0) {
      $account_search = $this->entityTypeManager
        ->getStorage('user')
        ->loadByProperties([
        'name' => $username,
      ]);
      if ($account = reset($account_search)) {
        if ($this->passwordChecker
          ->check($password, $account
          ->getPassword())) {

          // Successful authentication.
          $uid = $account
            ->id();

          // Update user to new password scheme if needed.
          if ($this->passwordChecker
            ->needsRehash($account
            ->getPassword())) {
            $account
              ->setPassword($password);
            $account
              ->save();
          }
        }
      }
    }
    return $uid;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
UserAuth::$entityTypeManager	protected	property	The entity type manager.
UserAuth::$passwordChecker	protected	property	The password hashing service.
UserAuth::authenticate	public	function	Validates user authentication credentials. Overrides UserAuthInterface::authenticate
UserAuth::__construct	public	function	Constructs a UserAuth object.