Repository navigation
Expand file tree
/
Copy pathUser.php
More file actions
423 lines (354 loc) · 9.74 KB
/
Copy pathUser.php
File metadata and controls
423 lines (354 loc) · 9.74 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
<?php
namespace SyncEngine\Entity;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Scheb\TwoFactorBundle\Model\Email\TwoFactorInterface as EmailTwoFactorInterface;
use Scheb\TwoFactorBundle\Model\PreferredProviderInterface;
use Scheb\TwoFactorBundle\Model\Totp\TotpConfiguration;
use Scheb\TwoFactorBundle\Model\Totp\TotpConfigurationInterface;
use Scheb\TwoFactorBundle\Model\Totp\TwoFactorInterface as TotpTwoFactorInterface;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
use Symfony\Component\Security\Core\User\UserInterface;
use SyncEngine\Repository\UserRepository;
use SyncEngine\Security\Scope\ScopeRegistry;
#[ORM\Entity( repositoryClass: UserRepository::class )]
#[UniqueEntity( fields: [ 'email' ], message: 'There is already an account with this email' )]
class User implements UserInterface, PasswordAuthenticatedUserInterface, EmailTwoFactorInterface, TotpTwoFactorInterface, PreferredProviderInterface
{
#[ORM\Id]
#[ORM\GeneratedValue]
#[ORM\Column]
private ?int $id = null;
#[ORM\Column( length: 180, unique: true )]
private ?string $email = null;
/**
* @var string The hashed password
*/
#[ORM\Column]
private ?string $password = null;
#[ORM\Column( length: 255, unique: false )]
private ?string $name = null;
#[ORM\Column]
private array $roles = [];
#[ORM\Column( nullable: true )]
protected ?array $settings = [];
/**
* Master toggle for 2FA. True if user has enrolled at least one method.
*/
#[ORM\Column]
private bool $twoFactorEnabled = false;
/**
* @var Collection<int, TwoFactor>
*/
#[ORM\OneToMany( mappedBy: 'user', targetEntity: TwoFactor::class, cascade: [ 'persist', 'remove' ], orphanRemoval: true )]
private Collection $twoFactorMethods;
/** @var Collection<int, ApiToken> */
#[ORM\OneToMany( mappedBy: 'user', targetEntity: ApiToken::class, fetch: "EXTRA_LAZY", orphanRemoval: true )]
private Collection $apiTokens;
public function __construct()
{
$this->apiTokens = new ArrayCollection();
$this->twoFactorMethods = new ArrayCollection();
}
public function getId(): ?int
{
return $this->id;
}
public function getEmail(): ?string
{
return $this->email;
}
public function setEmail( string $email ): self
{
$this->email = $email;
return $this;
}
public function getName(): ?string
{
return $this->name;
}
public function setName( string $name ): self
{
$this->name = $name;
return $this;
}
/**
* A visual identifier that represents this user.
*
* @see UserInterface
*/
public function getUserIdentifier(): string
{
return (string) $this->email;
}
/**
* @see UserInterface
*/
public function getRoles(): array
{
$roles = $this->roles;
// guarantee every user at least has ROLE_USER
$roles[] = 'ROLE_USER';
return array_unique( $roles );
}
/**
* Role-to-scope mapping.
*
* Each role maps to a set of API scopes that users with that role
* can grant to their tokens. Roles are checked in priority order;
* the first match wins.
*/
private const ROLE_SCOPES = [
'ROLE_ADMIN' => [ '*' ],
'ROLE_EDITOR' => [
'automation:read', 'automation:create', 'automation:update', 'automation:delete', 'automation:run',
'routine:read', 'routine:create', 'routine:update', 'routine:delete',
'flow:read', 'flow:create', 'flow:update', 'flow:delete',
'connection:read', 'connection:create', 'connection:update', 'connection:delete',
'storage:read', 'storage:create', 'storage:update', 'storage:delete',
],
'ROLE_VIEWER' => [
'automation:read',
'routine:read',
'flow:read',
'connection:read',
'storage:read',
],
];
/**
* Get the scopes this user is allowed to grant to their API tokens.
*
* Scopes are resolved from roles in priority order. The first matching
* role determines the granted scopes. Wildcards are expanded so the
* full list of individual scopes is returned.
*
* @param bool $includeWildcard Whether to include the wildcard scope.
* Tokens never use wildcards — they must
* have explicitly defined scopes. The wildcard
* is only used internally for voter checks.
*/
public function getGrantedScopes( bool $includeWildcard = false ): array
{
foreach ( self::ROLE_SCOPES as $role => $scopes ) {
if ( in_array( $role, $this->roles, true ) ) {
$expanded = ScopeRegistry::expandAll( $scopes );
if ( ! $includeWildcard ) {
$wildcard = array_find_key( $expanded, fn( $s ) => $s === '*' );
if ( $wildcard !== null ) {
unset( $expanded[ $wildcard ] );
$expanded = ScopeRegistry::ALL;
unset( $expanded[ array_find_key( $expanded, fn( $s ) => $s === '*' ) ] );
}
}
return $expanded;
}
}
return [];
}
public function setRoles( array $roles ): self
{
$this->roles = $roles;
return $this;
}
/**
* @see PasswordAuthenticatedUserInterface
*/
public function getPassword(): string
{
return $this->password;
}
public function setPassword( string $password ): self
{
$this->password = $password;
return $this;
}
/**
* @see UserInterface
*/
public function eraseCredentials(): void
{
// If you store any temporary, sensitive data on the user, clear it here
// $this->plainPassword = null;
}
public function getSettings(): array
{
return (array) $this->settings;
}
public function setSettings( array $settings ): self
{
$this->settings = $settings;
return $this;
}
public function getSetting( string $key ): mixed
{
return $this->settings[ $key ] ?? null;
}
public function setSetting( string $key, mixed $value ): self
{
$this->settings[ $key ] = $value;
return $this;
}
public function unsetSetting( string $key ): self
{
unset( $this->settings[ $key ] );
return $this;
}
public function getLocale(): ?string
{
return $this->getSetting( 'locale' );
}
public function setLocale( ?string $locale ): static
{
$this->setSetting( 'locale', $locale );
return $this;
}
/**
* @return Collection<int, ApiToken>
*/
public function getApiTokens(): Collection
{
return $this->apiTokens;
}
public function addApiToken( ApiToken $apiToken ): static
{
if ( ! $this->apiTokens->contains( $apiToken ) ) {
$this->apiTokens->add( $apiToken );
$apiToken->setUser( $this );
}
return $this;
}
public function removeApiToken( ApiToken $apiToken ): static
{
if ( $this->apiTokens->removeElement( $apiToken ) ) {
// set the owning side to null (unless already changed)
if ( $apiToken->getUser() === $this ) {
$apiToken->setUser( null );
}
}
return $this;
}
/**
* Get the master 2FA toggle status.
*/
public function isTwoFactorEnabled(): bool
{
return $this->twoFactorEnabled;
}
/**
* Set the master 2FA toggle status.
*/
public function setTwoFactorEnabled( bool $twoFactorEnabled ): static
{
$this->twoFactorEnabled = $twoFactorEnabled;
return $this;
}
/**
* @return Collection<int, TwoFactor>
*/
public function getTwoFactorMethods(): Collection
{
return $this->twoFactorMethods;
}
public function addTwoFactorMethod( TwoFactor $twoFactorMethod ): static
{
if ( ! $this->twoFactorMethods->contains( $twoFactorMethod ) ) {
$type = $twoFactorMethod->getType();
if ( $this->twoFactorMethods->exists(
fn( $key, TwoFactor $method ) => $type === $method->getType()
) ) {
// Ensure only one TOTP method exists per user.
throw new \LogicException( "User already has a `{$type}` method. Remove it before adding a new one." );
}
$this->twoFactorMethods[] = $twoFactorMethod;
$twoFactorMethod->setUser( $this );
}
return $this;
}
public function removeTwoFactorMethod( TwoFactor $twoFactorMethod ): static
{
$this->twoFactorMethods->removeElement( $twoFactorMethod );
return $this;
}
public function getPreferredTwoFactorProvider(): string|null
{
if ( $this->isTotpAuthenticationEnabled() ) {
return 'totp';
}
return 'email';
}
/**
* @see EmailTwoFactorInterface
*/
public function isEmailAuthEnabled(): bool
{
return $this->isTwoFactorEnabled();
}
/**
* @see EmailTwoFactorInterface
*/
public function getEmailAuthRecipient(): string
{
return $this->getEmail();
}
/**
* @see EmailTwoFactorInterface
*/
public function getEmailAuthCode(): string|null
{
return $this->getSetting( '_email_2fa_code' );
}
/**
* @see EmailTwoFactorInterface
*/
public function setEmailAuthCode( string $authCode ): void
{
$this->setSetting( '_email_2fa_code', $authCode );
}
/**
* @see EmailTwoFactorInterface
*/
public function unsetEmailAuthCode(): void
{
$this->unsetSetting( '_email_2fa_code' );
}
/**
* @see TotpTwoFactorInterface
*/
public function isTotpAuthenticationEnabled(): bool
{
// Check if user has enabled 2FA globally AND has an active TOTP method
if ( ! $this->isTwoFactorEnabled() ) {
return false;
}
foreach ( $this->getTwoFactorMethods() as $method ) {
if ( $method->getType() === 'totp' && $method->isEnabled() ) {
return true;
}
}
return false;
}
/**
* @see TotpTwoFactorInterface
*/
public function getTotpAuthenticationUsername(): string
{
return $this->email;
}
/**
* @see TotpTwoFactorInterface
*/
public function getTotpAuthenticationConfiguration(): TotpConfigurationInterface|null
{
foreach ( $this->getTwoFactorMethods() as $method ) {
if ( $method->getType() === 'totp' && $method->isEnabled() ) {
// Compatible with Google Authenticator and other TOTP apps. Default values are used for period and digits.
$period = 30;
$digits = 6;
return new TotpConfiguration( $method->getSecret(), TotpConfiguration::ALGORITHM_SHA1, $period, $digits );
}
}
return null;
}
}