class UserAuthentication

Same name and namespace in other branches
  1. 11.x core/modules/user/src/UserAuthentication.php \Drupal\user\UserAuthentication

Validates user authentication credentials.

Hierarchy

Expanded class hierarchy of UserAuthentication

1 string reference to 'UserAuthentication'
user.services.yml in core/modules/user/user.services.yml
core/modules/user/user.services.yml
1 service uses UserAuthentication
user.auth in core/modules/user/user.services.yml
Drupal\user\UserAuthentication

File

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

Namespace

Drupal\user
View on git.drupalcode.org
View source 
class UserAuthentication implements UserAuthInterface, UserAuthenticationInterface {
  
  /**
   * 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, #[\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->authenticateAccount($account, $password)) {
          $uid = $account->id();
        }
      }
    }
    return $uid;
  }
  
  /**
   * {@inheritdoc}
   */
  public function lookupAccount($identifier) : UserInterface|false {
    if (!empty($identifier)) {
      $account_search = $this->entityTypeManager
        ->getStorage('user')
        ->loadByProperties([
        'name' => $identifier,
      ]);
      if ($account = reset($account_search)) {
        return $account;
      }
    }
    return FALSE;
  }
  
  /**
   * {@inheritdoc}
   */
  public function authenticateAccount(UserInterface $account, #[\SensitiveParameter] string $password) : bool {
    if ($this->passwordChecker
      ->check($password, $account->getPassword())) {
      // Update user to new password scheme if needed.
      if ($this->passwordChecker
        ->needsRehash($account->getPassword())) {
        $account->setPassword($password);
        $account->save();
      }
      return TRUE;
    }
    return FALSE;
  }

}

Members

Title Modifiers Object type Summary Overriden Title
UserAuthentication::$entityTypeManager protected property The entity type manager.
UserAuthentication::$passwordChecker protected property The password hashing service.
UserAuthentication::authenticate public function Validates user authentication credentials. Overrides UserAuthInterface::authenticate
UserAuthentication::authenticateAccount public function Validates user authentication credentials for an account. Overrides UserAuthenticationInterface::authenticateAccount
UserAuthentication::lookupAccount public function Validates user authentication credentials. Overrides UserAuthenticationInterface::lookupAccount
UserAuthentication::__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.