|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* Copyright 2014 SURFnet bv |
|
5
|
|
|
* |
|
6
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); |
|
7
|
|
|
* you may not use this file except in compliance with the License. |
|
8
|
|
|
* You may obtain a copy of the License at |
|
9
|
|
|
* |
|
10
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0 |
|
11
|
|
|
* |
|
12
|
|
|
* Unless required by applicable law or agreed to in writing, software |
|
13
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS, |
|
14
|
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
15
|
|
|
* See the License for the specific language governing permissions and |
|
16
|
|
|
* limitations under the License. |
|
17
|
|
|
*/ |
|
18
|
|
|
|
|
19
|
|
|
namespace Surfnet\Stepup\Identity\Event; |
|
20
|
|
|
|
|
21
|
|
|
use Surfnet\Stepup\Identity\AuditLog\Metadata; |
|
22
|
|
|
use Surfnet\Stepup\Identity\Value\IdentityId; |
|
23
|
|
|
use Surfnet\Stepup\Identity\Value\Institution; |
|
24
|
|
|
use Surfnet\Stepup\Identity\Value\SecondFactorId; |
|
25
|
|
|
use Surfnet\Stepup\Identity\Value\SecondFactorIdentifier; |
|
26
|
|
|
use Surfnet\Stepup\Identity\Value\SecondFactorIdentifierFactory; |
|
27
|
|
|
use Surfnet\StepupBundle\Value\SecondFactorType; |
|
28
|
|
|
use Surfnet\StepupMiddleware\CommandHandlingBundle\SensitiveData\Forgettable; |
|
29
|
|
|
use Surfnet\StepupMiddleware\CommandHandlingBundle\SensitiveData\RightToObtainDataInterface; |
|
30
|
|
|
use Surfnet\StepupMiddleware\CommandHandlingBundle\SensitiveData\SensitiveData; |
|
31
|
|
|
|
|
32
|
|
|
abstract class SecondFactorRevokedEvent extends IdentityEvent implements Forgettable, RightToObtainDataInterface |
|
33
|
|
|
{ |
|
34
|
|
|
/** |
|
35
|
|
|
* @var string[] |
|
36
|
|
|
*/ |
|
37
|
|
|
private array $allowlist = [ |
|
38
|
|
|
'identity_id', |
|
39
|
|
|
'identity_institution', |
|
40
|
|
|
'second_factor_id', |
|
41
|
|
|
'second_factor_type', |
|
42
|
|
|
'second_factor_identifier', |
|
43
|
|
|
]; |
|
44
|
|
|
|
|
45
|
|
|
final public function __construct( |
|
46
|
|
|
IdentityId $identityId, |
|
47
|
|
|
Institution $identityInstitution, |
|
48
|
|
|
public SecondFactorId $secondFactorId, |
|
49
|
|
|
public SecondFactorType $secondFactorType, |
|
50
|
|
|
public SecondFactorIdentifier $secondFactorIdentifier, |
|
51
|
|
|
) { |
|
52
|
|
|
parent::__construct($identityId, $identityInstitution); |
|
53
|
|
|
} |
|
54
|
|
|
|
|
55
|
|
|
public function getAuditLogMetadata(): Metadata |
|
56
|
|
|
{ |
|
57
|
|
|
$metadata = new Metadata(); |
|
58
|
|
|
$metadata->identityId = $this->identityId; |
|
59
|
|
|
$metadata->identityInstitution = $this->identityInstitution; |
|
60
|
|
|
$metadata->secondFactorId = $this->secondFactorId; |
|
61
|
|
|
$metadata->secondFactorType = $this->secondFactorType; |
|
62
|
|
|
$metadata->secondFactorIdentifier = $this->secondFactorIdentifier; |
|
63
|
|
|
|
|
64
|
|
|
return $metadata; |
|
65
|
|
|
} |
|
66
|
|
|
|
|
67
|
|
|
final public static function deserialize(array $data): self |
|
68
|
|
|
{ |
|
69
|
|
|
$secondFactorType = new SecondFactorType($data['second_factor_type']); |
|
70
|
|
|
|
|
71
|
|
|
return new static( |
|
72
|
|
|
new IdentityId($data['identity_id']), |
|
73
|
|
|
new Institution($data['identity_institution']), |
|
74
|
|
|
new SecondFactorId($data['second_factor_id']), |
|
75
|
|
|
$secondFactorType, |
|
76
|
|
|
SecondFactorIdentifierFactory::unknownForType($secondFactorType), |
|
77
|
|
|
); |
|
78
|
|
|
} |
|
79
|
|
|
|
|
80
|
|
|
/** |
|
81
|
|
|
* The data ending up in the event_stream, be careful not to include sensitive data here! |
|
82
|
|
|
*/ |
|
83
|
|
|
final public function serialize(): array |
|
84
|
|
|
{ |
|
85
|
|
|
return [ |
|
86
|
|
|
'identity_id' => (string)$this->identityId, |
|
87
|
|
|
'identity_institution' => (string)$this->identityInstitution, |
|
88
|
|
|
'second_factor_id' => (string)$this->secondFactorId, |
|
89
|
|
|
'second_factor_type' => (string)$this->secondFactorType, |
|
90
|
|
|
]; |
|
91
|
|
|
} |
|
92
|
|
|
|
|
93
|
|
|
public function getSensitiveData(): SensitiveData |
|
94
|
|
|
{ |
|
95
|
|
|
return (new SensitiveData) |
|
|
|
|
|
|
96
|
|
|
->withSecondFactorIdentifier($this->secondFactorIdentifier, $this->secondFactorType); |
|
97
|
|
|
} |
|
98
|
|
|
|
|
99
|
|
|
public function setSensitiveData(SensitiveData $sensitiveData): void |
|
100
|
|
|
{ |
|
101
|
|
|
$this->secondFactorIdentifier = $sensitiveData->getSecondFactorIdentifier(); |
|
102
|
|
|
} |
|
103
|
|
|
|
|
104
|
|
|
public function obtainUserData(): array |
|
105
|
|
|
{ |
|
106
|
|
|
$serializedPublicUserData = $this->serialize(); |
|
107
|
|
|
$serializedSensitiveUserData = $this->getSensitiveData()->serialize(); |
|
108
|
|
|
return array_merge($serializedPublicUserData, $serializedSensitiveUserData); |
|
109
|
|
|
} |
|
110
|
|
|
|
|
111
|
|
|
/** |
|
112
|
|
|
* @return string[] |
|
113
|
|
|
*/ |
|
114
|
|
|
public function getAllowlist(): array |
|
115
|
|
|
{ |
|
116
|
|
|
return $this->allowlist; |
|
117
|
|
|
} |
|
118
|
|
|
} |
|
119
|
|
|
|
OpenConext /
Stepup-Middleware
Loading history...