class UserAuth

Same name and namespace in other branches
  1. 9 core/modules/user/src/UserAuth.php \Drupal\user\UserAuth
  2. 8.9.x core/modules/user/src/UserAuth.php \Drupal\user\UserAuth
  3. 11.x core/modules/user/src/UserAuth.php \Drupal\user\UserAuth

Validates user authentication credentials.

Hierarchy

Expanded class hierarchy of UserAuth

1 file declares its use of UserAuth
UserAuthTest.php in core/modules/user/tests/src/Unit/UserAuthTest.php

File

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

Namespace

Drupal\user
View source
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) {
    @trigger_error(__CLASS__ . ' is deprecated in drupal:10.3.0 and will be removed from drupal:12.0.0. Implement \\Drupal\\user\\UserAuthenticationInterface instead. See https://www.drupal.org/node/3411040');
    $this->entityTypeManager = $entity_type_manager;
    $this->passwordChecker = $password_checker;
  }
  
  /**
   * {@inheritdoc}
   */
  public function authenticate($username, #[\SensitiveParameter] $password) {
    @trigger_error(__METHOD__ . ' is deprecated in drupal:10.3.0 and will be removed from drupal:12.0.0. Implement \\Drupal\\user\\UserAuthenticationInterface instead. See https://www.drupal.org/node/3411040');
    $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

Title Sort descending Modifiers Object type Summary Overriden Title
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.