added Authenticator, successor for IAuthenticator

Author: dg

src/Security/Authenticator.php

@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * This file is part of the Nette Framework (https://nette.org)
+ * Copyright (c) 2004 David Grudl (https://davidgrudl.com)
+ */
+
+declare(strict_types=1);
+
+namespace Nette\Security;
+
+
+/**
+ * Performs authentication.
+ */
+interface Authenticator extends IAuthenticator
+{
+	/**
+	 * Performs an authentication.
+	 * @throws AuthenticationException
+	 */
+	function authenticate(string $user, string $password): IIdentity;
+}

src/Security/IAuthenticator.php

@@ -11,7 +11,8 @@
 
 
 /**
- * Performs authentication.
+ * @deprecated  update to Nette\Security\Authenticator
+ * @method IIdentity authenticate(array $credentials)
  */
 interface IAuthenticator
 {
@@ -32,5 +33,5 @@ interface IAuthenticator
 	 * and returns IIdentity on success or throws AuthenticationException
 	 * @throws AuthenticationException
 	 */
-	function authenticate(array $credentials): IIdentity;
+	//function authenticate(array $credentials): IIdentity;
 }

src/Security/User.php

@@ -89,7 +89,10 @@ public function login($user, string $password = null): void
 	{
 		$this->logout(true);
 		if (!$user instanceof IIdentity) {
-			$user = $this->getAuthenticator()->authenticate(func_get_args());
+			$authenticator = $this->getAuthenticator();
+			$user = $authenticator instanceof Authenticator
+				? $authenticator->authenticate($user, $password)
+				: $authenticator->authenticate(func_get_args());
 		}
 		$this->storage->setIdentity($user);
 		$this->storage->setAuthenticated(true);

tests/Security/User.authentication.legacy.phpt

@@ -0,0 +1,117 @@
+<?php
+
+/**
+ * Test: Nette\Security\User authentication.
+ */
+
+declare(strict_types=1);
+
+use Nette\Security\IAuthenticator;
+use Nette\Security\SimpleIdentity;
+use Tester\Assert;
+
+
+require __DIR__ . '/../bootstrap.php';
+require __DIR__ . '/MockUserStorage.php';
+
+// Setup environment
+$_COOKIE = [];
+ob_start();
+
+
+class Authenticator implements IAuthenticator
+{
+	public function authenticate(array $credentials): Nette\Security\IIdentity
+	{
+		[$username, $password] = $credentials;
+		if ($username !== 'john') {
+			throw new Nette\Security\AuthenticationException('Unknown user', self::IDENTITY_NOT_FOUND);
+
+		} elseif ($password !== 'xxx') {
+			throw new Nette\Security\AuthenticationException('Password not match', self::INVALID_CREDENTIAL);
+
+		} else {
+			return new SimpleIdentity('John Doe', 'admin');
+		}
+	}
+}
+
+
+$user = new Nette\Security\User(new MockUserStorage);
+
+$counter = (object) [
+	'login' => 0,
+	'logout' => 0,
+];
+
+$user->onLoggedIn[] = function () use ($counter) {
+	$counter->login++;
+};
+
+$user->onLoggedOut[] = function () use ($counter) {
+	$counter->logout++;
+};
+
+
+Assert::false($user->isLoggedIn());
+Assert::null($user->getIdentity());
+Assert::null($user->getId());
+
+
+// authenticate
+Assert::exception(function () use ($user) {
+	// login without handler
+	$user->login('jane', '');
+}, Nette\InvalidStateException::class, 'Authenticator has not been set.');
+
+$handler = new Authenticator;
+$user->setAuthenticator($handler);
+
+Assert::exception(function () use ($user) {
+	// login as jane
+	$user->login('jane', '');
+}, Nette\Security\AuthenticationException::class, 'Unknown user');
+
+Assert::exception(function () use ($user) {
+	// login as john
+	$user->login('john', '');
+}, Nette\Security\AuthenticationException::class, 'Password not match');
+
+// login as john#2
+$user->login('john', 'xxx');
+Assert::same(1, $counter->login);
+Assert::true($user->isLoggedIn());
+Assert::equal(new SimpleIdentity('John Doe', 'admin'), $user->getIdentity());
+Assert::same('John Doe', $user->getId());
+
+// login as john#3
+$user->logout(true);
+Assert::same(1, $counter->logout);
+$user->login(new SimpleIdentity('John Doe', 'admin'));
+Assert::same(2, $counter->login);
+Assert::true($user->isLoggedIn());
+Assert::equal(new SimpleIdentity('John Doe', 'admin'), $user->getIdentity());
+
+
+// log out
+// logging out...
+$user->logout(false);
+Assert::same(2, $counter->logout);
+
+Assert::false($user->isLoggedIn());
+Assert::equal(new SimpleIdentity('John Doe', 'admin'), $user->getIdentity());
+
+
+// logging out and clearing identity...
+$user->logout(true);
+Assert::same(2, $counter->logout); // not logged in -> logout event not triggered
+
+Assert::false($user->isLoggedIn());
+Assert::null($user->getIdentity());
+
+
+// namespace
+// login as john#2?
+$user->login('john', 'xxx');
+Assert::same(3, $counter->login);
+Assert::true($user->isLoggedIn());

tests/Security/User.authentication.phpt

@@ -6,7 +6,7 @@
 
 declare(strict_types=1);
 
-use Nette\Security\IAuthenticator;
+use Nette\Security\IIdentity;
 use Nette\Security\SimpleIdentity;
 use Tester\Assert;
 
@@ -19,11 +19,10 @@ $_COOKIE = [];
 ob_start();
 
 
-class Authenticator implements IAuthenticator
+class Authenticator implements Nette\Security\Authenticator
 {
-	public function authenticate(array $credentials): Nette\Security\IIdentity
+	public function authenticate(string $username, string $password): IIdentity
 	{
-		[$username, $password] = $credentials;
 		if ($username !== 'john') {
 			throw new Nette\Security\AuthenticationException('Unknown user', self::IDENTITY_NOT_FOUND);
 

tests/Security/User.authorization.phpt

@@ -6,8 +6,8 @@
 
 declare(strict_types=1);
 
-use Nette\Security\IAuthenticator;
-use Nette\Security\Identity;
+use Nette\Security\IIdentity;
+use Nette\Security\SimpleIdentity;
 use Tester\Assert;
 
 
@@ -20,19 +20,18 @@ $_COOKIE = [];
 ob_start();
 
 
-class Authenticator implements IAuthenticator
+class Authenticator implements Nette\Security\Authenticator
 {
-	public function authenticate(array $credentials): Nette\Security\IIdentity
+	public function authenticate(string $username, string $password): IIdentity
 	{
-		[$username, $password] = $credentials;
 		if ($username !== 'john') {
 			throw new Nette\Security\AuthenticationException('Unknown user', self::IDENTITY_NOT_FOUND);
 
 		} elseif ($password !== 'xxx') {
 			throw new Nette\Security\AuthenticationException('Password not match', self::INVALID_CREDENTIAL);
 
 		} else {
-			return new Identity('John Doe', ['admin']);
+			return new SimpleIdentity('John Doe', 'admin');
 		}
 	}
 }