22835066665

Committed 09 Mar 2026 01:50AM UTC coverage: 92.466%. Remained the same

Build Type

push

github

Committed by

Commit Message

added CLAUDE.md

Run Details

540 of 584 relevant lines covered (92.47%)

0.92 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

92.77

/src/Security/User.php

<?php declare(strict_types=1);

/**
 * This file is part of the Nette Framework (https://nette.org)
 * Copyright (c) 2004 David Grudl (https://davidgrudl.com)
 */

namespace Nette\Security;

use Nette;
use Nette\Utils\Arrays;
use function func_get_args;


/**
 * User authentication and authorization.
 *
 * @property-read bool $loggedIn
 * @property-read ?IIdentity $identity
 * @property-read string|int|null $id
 * @property-read string[] $roles
 * @property-read ?int $logoutReason
 * @property   IAuthenticator $authenticator
 * @property   Authorizator $authorizator
 */
class User
{
        use Nette\SmartObject;

        /** Log-out reason */
        public const
                LogoutManual = 1,
                LogoutInactivity = 2;

        /** @deprecated use User::LogoutManual */
        public const LOGOUT_MANUAL = self::LogoutManual;

        /** @deprecated use User::LogoutManual */
        public const MANUAL = self::LogoutManual;

        /** @deprecated use User::LogoutInactivity */
        public const LOGOUT_INACTIVITY = self::LogoutInactivity;

        /** @deprecated use User::LogoutInactivity */
        public const INACTIVITY = self::LogoutInactivity;

        /** default role for unauthenticated user */
        public string $guestRole = 'guest';

        /** default role for authenticated user without own identity */
        public string $authenticatedRole = 'authenticated';

        /** @var array<callable(self): void>  Occurs when the user is successfully logged in */
        public array $onLoggedIn = [];

        /** @var array<callable(self): void>  Occurs when the user is logged out */
        public array $onLoggedOut = [];

        private ?IIdentity $identity = null;
        private ?bool $authenticated = null;
        private ?int $logoutReason = null;


        public function __construct(
                private UserStorage $storage,
                private ?IAuthenticator $authenticator = null,
                private ?Authorizator $authorizator = null,
        ) {
        }


        final public function getStorage(): UserStorage
        {
                return $this->storage;
        }


        /********************* Authentication ****************d*g**/


        /**
         * Authenticates the user. Accepts username and password, or an IIdentity directly.
         * @param  string|IIdentity  $username  username or identity
         * @throws AuthenticationException if authentication was not successful
         */
        public function login(
                string|IIdentity $username,
                #[\SensitiveParameter]
                ?string $password = null,
        ): void
        {
                $this->logout(clearIdentity: true);
                if ($username instanceof IIdentity) {
                        $this->identity = $username;
                } else {
                        $authenticator = $this->getAuthenticator();
                        $this->identity = $authenticator instanceof Authenticator
                                ? $authenticator->authenticate(...func_get_args())
                                : $authenticator->authenticate(func_get_args());
                }

                $id = $this->authenticator instanceof IdentityHandler
                        ? $this->authenticator->sleepIdentity($this->identity)
                        : $this->identity;

                $this->storage->saveAuthentication($id);
                $this->authenticated = true;
                $this->logoutReason = null;
                Arrays::invoke($this->onLoggedIn, $this);
        }


        /**
         * Logs out the user from the current session.
         */
        final public function logout(bool $clearIdentity = false): void
        {
                $logged = $this->isLoggedIn();
                $this->storage->clearAuthentication($clearIdentity);
                $this->authenticated = false;
                $this->logoutReason = self::LogoutManual;
                if ($logged) {
                        Arrays::invoke($this->onLoggedOut, $this);
                }

                $this->identity = $clearIdentity ? null : $this->identity;
        }


        /**
         * Checks whether the user is authenticated.
         */
        final public function isLoggedIn(): bool
        {
                if ($this->authenticated === null) {
                        $this->getStoredData();
                }

                return (bool) $this->authenticated;
        }


        /**
         * Returns the current user identity, or null if not authenticated.
         */
        final public function getIdentity(): ?IIdentity
        {
                if ($this->authenticated === null) {
                        $this->getStoredData();
                }

                return $this->identity;
        }


        private function getStoredData(): void
        {
                (function (bool $state, ?IIdentity $id, ?int $reason) use (&$identity) {
                        $identity = $id;
                        $this->authenticated = $state;
                        $this->logoutReason = $reason;
                })(...$this->storage->getState());

                $this->identity = $identity && $this->authenticator instanceof IdentityHandler
                        ? $this->authenticator->wakeupIdentity($identity)
                        : $identity;
                $this->authenticated = $this->authenticated && $this->identity !== null;
        }


        /**
         * Returns current user ID, if any.
         */
        public function getId(): string|int|null
        {
                $identity = $this->getIdentity();
                return $identity ? $identity->getId() : null;
        }


        /**
         * Discards cached authentication state, forcing a reload from storage on next access.
         */
        final public function refreshStorage(): void
        {
                $this->identity = $this->authenticated = $this->logoutReason = null;
        }


        /**
         * Sets authentication handler.
         */
        public function setAuthenticator(IAuthenticator $handler): static
        {
                $this->authenticator = $handler;
                return $this;
        }


        /**
         * Returns authentication handler.
         */
        final public function getAuthenticator(): IAuthenticator
        {
                if (!$this->authenticator) {
                        throw new Nette\InvalidStateException('Authenticator has not been set.');
                }

                return $this->authenticator;
        }


        /**
         * Returns authentication handler, or null if none is set.
         */
        final public function getAuthenticatorIfExists(): ?IAuthenticator
        {
                return $this->authenticator;
        }


        /** @deprecated */
        final public function hasAuthenticator(): bool
        {
                return (bool) $this->authenticator;
        }


        /**
         * Enables log out after inactivity (like '20 minutes').
         */
        public function setExpiration(?string $expire, bool $clearIdentity = false): static
        {
                $this->storage->setExpiration($expire, $clearIdentity);
                return $this;
        }


        /**
         * Returns the logout reason: LogoutManual or LogoutInactivity, or null if not applicable.
         */
        final public function getLogoutReason(): ?int
        {
                return $this->logoutReason;
        }


        /********************* Authorization ****************d*g**/


        /**
         * Returns effective roles of the user. Unauthenticated users get the guest role.
         * @return string[]
         */
        public function getRoles(): array
        {
                if (!$this->isLoggedIn()) {
                        return [$this->guestRole];
                }

                $identity = $this->getIdentity();
                return $identity?->getRoles() ?? [$this->authenticatedRole];
        }


        /**
         * Checks whether the user has the specified effective role.
         */
        final public function isInRole(string $role): bool
        {
                foreach ($this->getRoles() as $r) {
                        if ($role === ($r instanceof Role ? $r->getRoleId() : $r)) {
                                return true;
                        }
                }

                return false;
        }


        /**
         * Checks whether the user has access to the given resource and privilege.
         * Null means all resources or all privileges.
         */
        public function isAllowed(mixed $resource = Authorizator::All, mixed $privilege = Authorizator::All): bool
        {
                foreach ($this->getRoles() as $role) {
                        if ($this->getAuthorizator()->isAllowed($role, $resource, $privilege)) {
                                return true;
                        }
                }

                return false;
        }


        /**
         * Sets authorization handler.
         */
        public function setAuthorizator(Authorizator $handler): static
        {
                $this->authorizator = $handler;
                return $this;
        }


        /**
         * Returns current authorization handler.
         */
        final public function getAuthorizator(): Authorizator
        {
                if (!$this->authorizator) {
                        throw new Nette\InvalidStateException('Authorizator has not been set.');
                }

                return $this->authorizator;
        }


        /**
         * Returns authorization handler, or null if none is set.
         */
        final public function getAuthorizatorIfExists(): ?Authorizator
        {
                return $this->authorizator;
        }


        /** @deprecated */
        final public function hasAuthorizator(): bool
        {
                return (bool) $this->authorizator;
        }
}

1	<?php declare(strict_types=1);	1✔
2
3	/**
4	* This file is part of the Nette Framework (https://nette.org)
5	* Copyright (c) 2004 David Grudl (https://davidgrudl.com)
6	*/
7
8	namespace Nette\Security;
9
10	use Nette;
11	use Nette\Utils\Arrays;
12	use function func_get_args;
13
14
15	/**
16	* User authentication and authorization.
17	*
18	* @property-read bool $loggedIn
19	* @property-read ?IIdentity $identity
20	* @property-read string\|int\|null $id
21	* @property-read string[] $roles
22	* @property-read ?int $logoutReason
23	* @property IAuthenticator $authenticator
24	* @property Authorizator $authorizator
25	*/
26	class User
27	{
28	use Nette\SmartObject;
29
30	/** Log-out reason */
31	public const
32	LogoutManual = 1,
33	LogoutInactivity = 2;
34
35	/** @deprecated use User::LogoutManual */
36	public const LOGOUT_MANUAL = self::LogoutManual;
37
38	/** @deprecated use User::LogoutManual */
39	public const MANUAL = self::LogoutManual;
40
41	/** @deprecated use User::LogoutInactivity */
42	public const LOGOUT_INACTIVITY = self::LogoutInactivity;
43
44	/** @deprecated use User::LogoutInactivity */
45	public const INACTIVITY = self::LogoutInactivity;
46
47	/** default role for unauthenticated user */
48	public string $guestRole = 'guest';
49
50	/** default role for authenticated user without own identity */
51	public string $authenticatedRole = 'authenticated';
52
53	/** @var array<callable(self): void> Occurs when the user is successfully logged in */
54	public array $onLoggedIn = [];
55
56	/** @var array<callable(self): void> Occurs when the user is logged out */
57	public array $onLoggedOut = [];
58
59	private ?IIdentity $identity = null;
60	private ?bool $authenticated = null;
61	private ?int $logoutReason = null;
62
63
64	public function __construct(	1✔
65	private UserStorage $storage,
66	private ?IAuthenticator $authenticator = null,
67	private ?Authorizator $authorizator = null,
68	) {
69	}	1✔
70
71
72	final public function getStorage(): UserStorage
73	{
74	return $this->storage;	×
75	}
76
77
78	/******************* Authentication *************dg**/
79
80
81	/**
82	* Authenticates the user. Accepts username and password, or an IIdentity directly.
83	* @param string\|IIdentity $username username or identity
84	* @throws AuthenticationException if authentication was not successful
85	*/
86	public function login(	1✔
87	string\|IIdentity $username,
88	#[\SensitiveParameter]
89	?string $password = null,
90	): void
91	{
92	$this->logout(clearIdentity: true);	1✔
93	if ($username instanceof IIdentity) {	1✔
94	$this->identity = $username;	1✔
95	} else {
96	$authenticator = $this->getAuthenticator();	1✔
97	$this->identity = $authenticator instanceof Authenticator	1✔
98	? $authenticator->authenticate(...func_get_args())	1✔
99	: $authenticator->authenticate(func_get_args());	×
100	}
101
102	$id = $this->authenticator instanceof IdentityHandler	1✔
103	? $this->authenticator->sleepIdentity($this->identity)	1✔
104	: $this->identity;	1✔
105
106	$this->storage->saveAuthentication($id);	1✔
107	$this->authenticated = true;	1✔
108	$this->logoutReason = null;	1✔
109	Arrays::invoke($this->onLoggedIn, $this);	1✔
110	}	1✔
111
112
113	/**
114	* Logs out the user from the current session.
115	*/
116	final public function logout(bool $clearIdentity = false): void	1✔
117	{
118	$logged = $this->isLoggedIn();	1✔
119	$this->storage->clearAuthentication($clearIdentity);	1✔
120	$this->authenticated = false;	1✔
121	$this->logoutReason = self::LogoutManual;	1✔
122	if ($logged) {	1✔
123	Arrays::invoke($this->onLoggedOut, $this);	1✔
124	}
125
126	$this->identity = $clearIdentity ? null : $this->identity;	1✔
127	}	1✔
128
129
130	/**
131	* Checks whether the user is authenticated.
132	*/
133	final public function isLoggedIn(): bool
134	{
135	if ($this->authenticated === null) {	1✔
136	$this->getStoredData();	1✔
137	}
138
139	return (bool) $this->authenticated;	1✔
140	}
141
142
143	/**
144	* Returns the current user identity, or null if not authenticated.
145	*/
146	final public function getIdentity(): ?IIdentity
147	{
148	if ($this->authenticated === null) {	1✔
149	$this->getStoredData();	1✔
150	}
151
152	return $this->identity;	1✔
153	}
154
155
156	private function getStoredData(): void
157	{
158	(function (bool $state, ?IIdentity $id, ?int $reason) use (&$identity) {	1✔
159	$identity = $id;	1✔
160	$this->authenticated = $state;	1✔
161	$this->logoutReason = $reason;	1✔
162	})(...$this->storage->getState());	1✔
163
164	$this->identity = $identity && $this->authenticator instanceof IdentityHandler	1✔
165	? $this->authenticator->wakeupIdentity($identity)	1✔
166	: $identity;	1✔
167	$this->authenticated = $this->authenticated && $this->identity !== null;	1✔
168	}	1✔
169
170
171	/**
172	* Returns current user ID, if any.
173	*/
174	public function getId(): string\|int\|null
175	{
176	$identity = $this->getIdentity();	1✔
177	return $identity ? $identity->getId() : null;	1✔
178	}
179
180
181	/**
182	* Discards cached authentication state, forcing a reload from storage on next access.
183	*/
184	final public function refreshStorage(): void
185	{
186	$this->identity = $this->authenticated = $this->logoutReason = null;	1✔
187	}	1✔
188
189
190	/**
191	* Sets authentication handler.
192	*/
193	public function setAuthenticator(IAuthenticator $handler): static	1✔
194	{
195	$this->authenticator = $handler;	1✔
196	return $this;	1✔
197	}
198
199
200	/**
201	* Returns authentication handler.
202	*/
203	final public function getAuthenticator(): IAuthenticator
204	{
205	if (!$this->authenticator) {	1✔
206	throw new Nette\InvalidStateException('Authenticator has not been set.');	1✔
207	}
208
209	return $this->authenticator;	1✔
210	}
211
212
213	/**
214	* Returns authentication handler, or null if none is set.
215	*/
216	final public function getAuthenticatorIfExists(): ?IAuthenticator
217	{
218	return $this->authenticator;	×
219	}
220
221
222	/** @deprecated */
223	final public function hasAuthenticator(): bool
224	{
225	return (bool) $this->authenticator;	×
226	}
227
228
229	/**
230	* Enables log out after inactivity (like '20 minutes').
231	*/
232	public function setExpiration(?string $expire, bool $clearIdentity = false): static	1✔
233	{
234	$this->storage->setExpiration($expire, $clearIdentity);	1✔
235	return $this;	1✔
236	}
237
238
239	/**
240	* Returns the logout reason: LogoutManual or LogoutInactivity, or null if not applicable.
241	*/
242	final public function getLogoutReason(): ?int
243	{
244	return $this->logoutReason;	1✔
245	}
246
247
248	/******************* Authorization *************dg**/
249
250
251	/**
252	* Returns effective roles of the user. Unauthenticated users get the guest role.
253	* @return string[]
254	*/
255	public function getRoles(): array
256	{
257	if (!$this->isLoggedIn()) {	1✔
258	return [$this->guestRole];	1✔
259	}
260
261	$identity = $this->getIdentity();	1✔
262	return $identity?->getRoles() ?? [$this->authenticatedRole];	1✔
263	}
264
265
266	/**
267	* Checks whether the user has the specified effective role.
268	*/
269	final public function isInRole(string $role): bool	1✔
270	{
271	foreach ($this->getRoles() as $r) {	1✔
272	if ($role === ($r instanceof Role ? $r->getRoleId() : $r)) {	1✔
273	return true;	1✔
274	}
275	}
276
277	return false;	1✔
278	}
279
280
281	/**
282	* Checks whether the user has access to the given resource and privilege.
283	* Null means all resources or all privileges.
284	*/
285	public function isAllowed(mixed $resource = Authorizator::All, mixed $privilege = Authorizator::All): bool	1✔
286	{
287	foreach ($this->getRoles() as $role) {	1✔
288	if ($this->getAuthorizator()->isAllowed($role, $resource, $privilege)) {	1✔
289	return true;	1✔
290	}
291	}
292
293	return false;	1✔
294	}
295
296
297	/**
298	* Sets authorization handler.
299	*/
300	public function setAuthorizator(Authorizator $handler): static	1✔
301	{
302	$this->authorizator = $handler;	1✔
303	return $this;	1✔
304	}
305
306
307	/**
308	* Returns current authorization handler.
309	*/
310	final public function getAuthorizator(): Authorizator
311	{
312	if (!$this->authorizator) {	1✔
313	throw new Nette\InvalidStateException('Authorizator has not been set.');	1✔
314	}
315
316	return $this->authorizator;	1✔
317	}
318
319
320	/**
321	* Returns authorization handler, or null if none is set.
322	*/
323	final public function getAuthorizatorIfExists(): ?Authorizator
324	{
325	return $this->authorizator;	×
326	}
327
328
329	/** @deprecated */
330	final public function hasAuthorizator(): bool
331	{
332	return (bool) $this->authorizator;	×
333	}
334	}

nette / security / 22835066665

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous