Merge branch 'v2.x'

# Conflicts:
#	src/Lib/Authenticate.php
#	src/Middleware/HeaderAuthenticationMiddleware.php
#	src/Middleware/PostRequestAuthenticationMiddleware.php
This commit is contained in:
mcndave committed 2026-10-20 08:21:12 -04:00
commit 1e1d6e1ce3
19 files changed
+261 -105

No files matched your search

+1 -1
View File
@@ -7,7 +7,7 @@ use Ulmus\User\Entity\UserInterface;
interface AuthorizeMethodInterface
{
public function connect(ServerRequestInterface $request, UserInterface $user) : bool;
public function connect(ServerRequestInterface $request) : ServerRequestInterface;
public function catchRequest(ServerRequestInterface $request) : bool;
}
+3 -3
View File
@@ -70,12 +70,12 @@ class JsonWebTokenDecoder
public function isJWT() : bool
{
try {
return $this->parse();
return strlen($this->encoded) > 23 && count(explode('.', $this->encoded)) === 3;
}
catch(\Throwable $t) {}
catch(\Throwable $t) {
return false;
}
}
public function getPayload() : array
{
@@ -53,7 +53,7 @@ abstract class JsonWebTokenValidate
if ( ($compare ?? null) !== $decodedSignature) {
throw new JsonWebTokenDecodingError(
sprintf("Given signature (%s) do not match computed signature (%s)", $encodedSignature, JsonWebTokenEncoder::base64url_encode($compare))
sprintf("Given signature (%s) do not match computed signature", $encodedSignature)
);
}
}
+33
View File
@@ -0,0 +1,33 @@
<?php
namespace Ulmus\User\Authorize;
use DI\Attribute\Inject;
use Psr\Http\Message\ServerRequestInterface;
use Storage\Cookie;
use Ulmus\User\Lib\Authenticate;
use Ulmus\User\Lib\HeaderAuthenticationTypeEnum;
class CookieAuthentication implements AuthorizeMethodInterface
{
public function __construct(
protected Authenticate $authorize,
protected Cookie $cookie,
) { }
public function connect(ServerRequestInterface $request): ServerRequestInterface
{
$methodObj = new Header\BearerMethod($this->cookie->get('jwt'));
if (isset($methodObj)) {
$request = $methodObj->execute($request);
}
return $request;
}
public function catchRequest(ServerRequestInterface $request) : bool
{
return $this->cookie->has('jwt');
}
}
+7 -13
View File
@@ -3,37 +3,31 @@
namespace Ulmus\User\Authorize\Header;
use Psr\Http\Message\ServerRequestInterface;
use Ulmus\User\Entity\BasicAuthUserInterface;
use Ulmus\User\Entity\UserInterface;
use Ulmus\User\Lib\Authenticate;
use Ulmus\User\Lib\Authorize;
use Ulmus\User\Lib\AuthenticationMethodEnum;
class BasicMethod implements MethodInterface
{
public function __construct(
protected Authenticate $authorize,
protected BasicAuthUserInterface $user,
protected string|array $arguments
) {}
public function execute(ServerRequestInterface $request) : bool
public function execute(ServerRequestInterface $request) : ServerRequestInterface
{
if ( false === $decoded = base64_decode($this->arguments) ) {
throw new \RuntimeException("Base64 decoding of given username:password failed");
}
list($userName, $password) = explode(':', $decoded) + [ null, null ];
list($username, $password) = explode(':', $decoded) + [ null, null ];
if ( empty($userName) ) {
if ( empty($username) ) {
throw new \RuntimeException("A username must be provided");
}
elseif ( empty($password) ) {
throw new \RuntimeException("A password must be provided");
}
$this->authorize->user = $this->user;
$this->authorize->authenticate([ $this->user->usernameField() => $userName ], $password);
return $this->user->loggedIn();
return $request->withAttribute('authentication_middleware:method', AuthenticationMethodEnum::UsernamePassword)
->withAttribute('authentication_middleware:username', $username)
->withAttribute('authentication_middleware:password', $password);
}
}
+16 -19
View File
@@ -3,37 +3,35 @@
namespace Ulmus\User\Authorize\Header;
use Psr\Http\Message\ServerRequestInterface;
use Ulmus\User\Authorize\Bearer\JsonWebToken;
use Ulmus\User\Authorize\Bearer\JsonWebTokenDecoder;
use Ulmus\User\Entity\UserInterface;
use Ulmus\User\Lib\Authenticate;
use Ulmus\User\Lib\Authorize;
use Ulmus\User\Lib\AuthenticationMethodEnum;
class BearerMethod implements MethodInterface
{
protected JsonWebTokenDecoder $jwt;
public function __construct(
protected Authenticate $authorize,
protected UserInterface $user,
protected string $token
) {}
public function execute(ServerRequestInterface $request) : bool
public function execute(ServerRequestInterface $request) : ServerRequestInterface
{
$this->authorize->user = $this->user;
switch($this->autodetectTokenType()) {
case BearerTokenTypeEnum::JsonWebToken:
$this->jwt->decode();
$payload = $this->jwt->getPayload();
if ( $payload['sub'] ?? false) {
if ( ! $this->authorize->logUser($payload['sub']) ) {
throw new \Exception("Given user id do not match with an existing/active user");
}
$request = $request
->withAttribute('authentication_middleware:method', AuthenticationMethodEnum::ForceLogin)
->withAttribute('authentication_middleware:jwt', $payload)
->withAttribute('authentication_middleware:user_id', $payload['sub']);
}
else {
throw new \InvalidArgumentException("Given JsonWebToken is missing a 'sub' key (which concords to user id)");
throw new \InvalidArgumentException("Given JsonWebToken is missing a 'sub' key (which match with a user's id)");
}
break;
@@ -41,25 +39,24 @@ class BearerMethod implements MethodInterface
case BearerTokenTypeEnum::UniqueKey:
# @TODO
break;
default:
}
return $this->user->loggedIn();
return $request;
}
public function autodetectTokenType() : BearerTokenTypeEnum
{
$this->jwt = new JsonWebTokenDecoder($this->token, getenv('LEAN_RANDOM'));
try {
$this->jwt = new JsonWebTokenDecoder($this->token, hash('sha512', getenv('LEAN_RANDOM')));
if ( $this->jwt->isJWT() ) {
return BearerTokenTypeEnum::JsonWebToken;
}
}
catch(\Throwable $ex) {/* Not a JWT */}
return BearerTokenTypeEnum::UniqueKey;
}
protected function userFromJWT() : UserInterface
{
}
}
+11 -5
View File
@@ -9,12 +9,12 @@ use Ulmus\User\Lib\Authenticate;
class DigestMethod implements MethodInterface
{
public function __construct(
protected Authenticate $authorize,
protected DigestAuthUserInterface $user,
# protected Authenticate $authorize,
# protected DigestAuthUserInterface $user,
protected string|array $arguments
) {}
public function execute(ServerRequestInterface $request) : bool
public function execute(ServerRequestInterface $request) : ServerRequestInterface
{
$arguments = $this->parseDigestArguments($this->arguments);
@@ -28,7 +28,7 @@ class DigestMethod implements MethodInterface
$arguments['nc'] = str_pad($arguments['nc'] ?? "1", 8, '0', STR_PAD_LEFT);
$ha1 = $this->getSecretHash();
$ha1 = "@TODO !@"; # $this->authorize->user->getSecretHash();
if ($isSess) {
$ha1 = hash($hashMethod, implode(':', [
@@ -62,7 +62,13 @@ class DigestMethod implements MethodInterface
]));
}
return $response === $arguments['response'];
if ($response === $arguments['response']) {
$request = $request->withAttribute('authentication_middleware:user_id', $arguments['username']);
# @TODO ! Add Type here to match login with Username Only
}
return $request;
}
+1 -1
View File
@@ -6,5 +6,5 @@ use Psr\Http\Message\ServerRequestInterface;
interface MethodInterface
{
public function execute(ServerRequestInterface $request) : bool;
public function execute(ServerRequestInterface $request) : ServerRequestInterface;
}
+27 -22
View File
@@ -6,6 +6,7 @@ use Psr\Http\Message\ServerRequestInterface;
use Ulmus\User\Common\AuthorizeContentTypeEnum;
use Ulmus\User\Entity\{ DigestAuthUserInterface, UserInterface };
use Ulmus\User\Lib\Authenticate;
use Ulmus\User\Lib\HeaderAuthenticationTypeEnum;
class HeaderAuthentication implements AuthorizeMethodInterface
{
@@ -13,51 +14,55 @@ class HeaderAuthentication implements AuthorizeMethodInterface
protected Authenticate $authorize,
) { }
public function connect(ServerRequestInterface $request, UserInterface $user): bool
public function connect(ServerRequestInterface $request): ServerRequestInterface
{
if (null !== ( $auth = $request->getHeaderLine('Authorization') )) {
list($method, $value) = explode(' ', $auth, 2) + [ null, null ];
$type = HeaderAuthenticationTypeEnum::fromRequest($request);
switch(strtolower($method)) {
case "basic":
$methodObj = new Header\BasicMethod($this->authorize, $user, $value);
if ( null !== $type ) {
list(, $value) = explode(' ', $request->getHeaderLine('Authorization'), 2) + [ null, null ];
switch($type) {
case HeaderAuthenticationTypeEnum::Basic:
$methodObj = new Header\BasicMethod($value);
break;
case "digest":
if (! $user instanceof DigestAuthUserInterface) {
throw new \RuntimeException("Your user entity must provide a valid hash of `user:realm:password` ");
}
case HeaderAuthenticationTypeEnum::Digest:
#if (! $user instanceof DigestAuthUserInterface) {
# throw new \RuntimeException("Your user entity must provide a valid hash of `user:realm:password` ");
#}
$methodObj = new Header\DigestMethod($this->authorize, $user, $value);
$methodObj = new Header\DigestMethod($value);
break;
case "bearer":
$methodObj = new Header\BearerMethod($this->authorize, $user, $value);
case HeaderAuthenticationTypeEnum::Bearer:
$methodObj = new Header\BearerMethod($value);
break;
case "token":
case HeaderAuthenticationTypeEnum::Token:
// @TODO !
break;
default:
throw new \InvalidArgumentException("An authentication method must be provided");
}
}
return isset($methodObj) && $methodObj->execute($request);
if (isset($methodObj)) {
$request = $methodObj->execute($request);
}
return $request;
}
public function catchRequest(ServerRequestInterface $request) : bool
{
foreach(array_merge($request->getHeader('Accept'), $request->getHeader('Content-Type')) as $accept) {
# Previously only catched from JSON content-type ; now accepts every connections
/*foreach(array_merge($request->getHeader('Accept'), $request->getHeader('Content-Type')) as $accept) {
foreach(explode(',', $accept) as $contentType) {
if ( AuthorizeContentTypeEnum::tryFrom(strtolower($contentType)) ) {
return true;
}
}
}
}*/
return false;
return $request->hasHeader('authorization');
}
}
+5 -3
View File
@@ -5,21 +5,23 @@ namespace Ulmus\User\Authorize;
use Psr\Http\Message\ServerRequestInterface;
use Ulmus\User\Entity\UserInterface;
use Ulmus\User\Lib\Authenticate;
use Ulmus\User\Lib\AuthenticationMethodEnum;
class PostRequestAuthentication implements AuthorizeMethodInterface
{
public function __construct(
public Authenticate $authenticate,
protected string $fieldUser = "email",
protected string $postFieldUser = "email",
protected string $postFieldPassword = "password",
) {}
public function connect(ServerRequestInterface $request, UserInterface $user): bool
public function connect(ServerRequestInterface $request) : ServerRequestInterface
{
$post = $request->getParsedBody();
return $this->authenticate->authenticate([ $this->fieldUser => $post[$this->postFieldUser] ], $post[$this->postFieldPassword]);
return $request->withAttribute('authentication_middleware:method', AuthenticationMethodEnum::UsernamePassword)
->withAttribute('authentication_middleware:username', [ $this->fieldUser => $post[$this->postFieldUser] ])
->withAttribute('authentication_middleware:password', $post[$this->postFieldPassword]);
}
public function catchRequest(ServerRequestInterface $request): bool
+3 -3
View File
@@ -48,12 +48,12 @@ abstract class User implements UserInterface {
#[Field]
public string $password;
#[Field\UpdatedAt(name: "updated_at", readonly: true)]
public ? Datetime $updatedAt;
#[Field\CreatedAt(name: "created_at", readonly: true)]
public Datetime $createdAt;
#[Field\UpdatedAt(name: "updated_at", readonly: true)]
public ? Datetime $updatedAt;
public bool $logged = false;
public function __toString() : string
+5
View File
@@ -0,0 +1,5 @@
<?php
namespace Ulmus\User\Exception;
class InvalidUserException extends \Exception {}
+23 -3
View File
@@ -43,10 +43,14 @@ class Authenticate {
$this->session->destroy();
}
public function authenticate(array $userLogin, string $password) : bool
public function authenticate(string|array $userLogin, string $password) : bool
{
$repository = $this->user::repository();
if (is_string($userLogin)) {
$userLogin = [ $this->user->usernameField() => $userLogin ];
}
foreach($userLogin as $field => $value) {
$repository->or($field, $value);
}
@@ -101,8 +105,8 @@ class Authenticate {
$this->session->set("user.id", $this->user->id);
}
if ( $this->cookie ) {
$this->cookie->set("user.id", $this->user->id);
if ( $this->cookie && ! $this->cookie->has('user.id')) {
$this->cookie->set("user.id", $this->user->id, samesite: "none");
}
}
@@ -121,6 +125,22 @@ class Authenticate {
return $this;
}
public function loadUser(?int $id) : ? UserInterface
{
try {
if ($id === null || null === ($entity = $this->user::repository()->loadFromPk($id))) {
return null;
}
}
catch(\Exception $ex) {
return null;
}
$this->user->fromArray($entity);
return $this->user;
}
public function logUser(null|int|object $id) : ? UserInterface
{
if (! is_object($id)) {
+9
View File
@@ -0,0 +1,9 @@
<?php
namespace Ulmus\User\Lib;
enum AuthenticationMethodEnum
{
case ForceLogin;
case UsernamePassword;
}
+24
View File
@@ -0,0 +1,24 @@
<?php
namespace Ulmus\User\Lib;
use Psr\Http\Message\ServerRequestInterface;
enum HeaderAuthenticationTypeEnum : string
{
case Basic = "basic";
case Digest = "digest";
case Bearer = "bearer";
case Token = "token";
public static function fromRequest(ServerRequestInterface $request) : ? static
{
if ($request->hasHeader('authorization')) {
list($method, ) = explode(' ', $request->getHeaderLine('authorization'), 2);
return static::tryFrom(strtolower($method));
}
return null;
}
}
@@ -0,0 +1,57 @@
<?php
namespace Ulmus\User\Middleware;
use Psr\Http\{
Message\ResponseInterface,
Message\ServerRequestInterface,
Server\MiddlewareInterface,
Server\RequestHandlerInterface
};
use Ulmus\User\Entity\UserInterface;
use Ulmus\User\Authorize\PostRequestAuthentication;
use Ulmus\User\Exception\InvalidUserException;
use Ulmus\User\Lib\Authenticate;
use Ulmus\User\Lib\AuthenticationMethodEnum;
class AuthenticationMiddleware implements MiddlewareInterface
{
public function __construct(
protected Authenticate $authenticator,
protected \Closure $loginFailedResponse,
) {}
public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
{
try {
$this->launchAuthentication($request);
}
catch(InvalidUserException $e) {
return call_user_func($this->loginFailedResponse, [ 'api.error_message' => $e->getMessage() ]);
}
return $handler->handle($request);
}
protected function launchAuthentication(ServerRequestInterface $request) : void
{
if (null !== $id = $request->getAttribute('authentication_middleware:user_id')) {
$this->authenticator->loadUser($id);
if ( ! $this->authenticator->user->isLoaded() ) {
throw new InvalidUserException("Given user id do not match with an existing/active user");
}
}
switch($request->getAttribute('authentication_middleware:method')) {
case AuthenticationMethodEnum::ForceLogin:
$this->authenticator->login();
break;
case AuthenticationMethodEnum::UsernamePassword:
$this->authenticator->authenticate($request->getAttribute('authentication_middleware:username'), $request->getAttribute('authentication_middleware:password'));
break;
}
}
}
@@ -0,0 +1,30 @@
<?php
namespace Ulmus\User\Middleware;
use DI\Attribute\Inject;
use Psr\Http\{
Message\ResponseInterface,
Message\ServerRequestInterface,
Server\MiddlewareInterface,
Server\RequestHandlerInterface
};
use Ulmus\User\Authorize\CookieAuthentication;
class CookieAuthenticationMiddleware implements MiddlewareInterface
{
public function __construct(
#[Inject]
protected CookieAuthentication $authenticator,
) { }
public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
{
if ( $this->authenticator->catchRequest($request) ) {
$request = $this->authenticator->connect($request);
}
return $handler->handle($request);
}
}
@@ -14,28 +14,14 @@ use Ulmus\User\Lib\Authenticate;
class HeaderAuthenticationMiddleware implements MiddlewareInterface
{
protected HeaderAuthentication $authenticator;
public function __construct(
protected Authenticate $authorize,
protected UserInterface $entity,
protected \Closure $loginFailedResponse,
? HeaderAuthentication $authenticator = null,
) {
$this->authenticator = $authenticator ?: new HeaderAuthentication($authorize);
}
protected HeaderAuthentication $authenticator,
) { }
public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
{
try {
if ( $this->authenticator->catchRequest($request) ) {
if ( ! $this->authenticator->connect($request, $this->entity) ) {
return call_user_func($this->loginFailedResponse, [ 'api.process' => "Auth failed" ]);
}
}
}
catch(\Exception $e) {
return call_user_func($this->loginFailedResponse, [ 'api.error_message' => $e->getMessage() ]);
$request = $this->authenticator->connect($request);
}
return $handler->handle($request);
@@ -14,27 +14,15 @@ use Ulmus\User\Lib\Authenticate;
class PostRequestAuthenticationMiddleware implements MiddlewareInterface
{
protected PostRequestAuthentication $authenticator;
public function __construct(
protected UserInterface $entity,
protected \Closure $loginFailedResponse,
? PostRequestAuthentication $authenticator = null,
protected PostRequestAuthentication $authenticator,
) {
$this->authenticator = $authenticator ?: new PostRequestAuthentication(new Authenticate($entity));
}
public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
{
$this->authenticator->authenticate->rememberMe();
if ( $this->authenticator->catchRequest($request) ) {
if ( ! $this->authenticator->connect($request, $this->entity) ) {
# Adds random sleep after a bad login attempts
sleep(random_int(2,8));
return call_user_func($this->loginFailedResponse, "Login failed");
}
$request = $this->authenticator->connect($request);
}
return $handler->handle($request);