|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types = 1); |
|
4
|
|
|
|
|
5
|
|
|
/** |
|
6
|
|
|
* Copyright 2014 SURFnet bv |
|
7
|
|
|
* |
|
8
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); |
|
9
|
|
|
* you may not use this file except in compliance with the License. |
|
10
|
|
|
* You may obtain a copy of the License at |
|
11
|
|
|
* |
|
12
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0 |
|
13
|
|
|
* |
|
14
|
|
|
* Unless required by applicable law or agreed to in writing, software |
|
15
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS, |
|
16
|
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
17
|
|
|
* See the License for the specific language governing permissions and |
|
18
|
|
|
* limitations under the License. |
|
19
|
|
|
*/ |
|
|
|
|
|
|
20
|
|
|
|
|
21
|
|
|
namespace Surfnet\StepupSelfService\SelfServiceBundle\Service\YubikeySecondFactor; |
|
22
|
|
|
|
|
23
|
|
|
use Surfnet\StepupSelfService\SelfServiceBundle\Exception\InvalidArgumentException; |
|
24
|
|
|
|
|
25
|
|
|
final class ProofOfPossessionResult |
|
|
|
|
|
|
26
|
|
|
{ |
|
27
|
|
|
/** |
|
28
|
|
|
* The ID of the second factor that has been proven to be in possession of the registrant. |
|
29
|
|
|
* |
|
30
|
|
|
* @var string|null A UUID or null. |
|
31
|
|
|
*/ |
|
32
|
|
|
private ?string $secondFactorId = null; |
|
|
|
|
|
|
33
|
|
|
|
|
34
|
|
|
private bool $otpInvalid = false; |
|
|
|
|
|
|
35
|
|
|
|
|
36
|
|
|
private bool $otpVerificationFailed = false; |
|
|
|
|
|
|
37
|
|
|
|
|
38
|
|
|
private bool $proofOfPossessionFailed = false; |
|
|
|
|
|
|
39
|
|
|
|
|
40
|
|
|
private function __construct() |
|
|
|
|
|
|
41
|
|
|
{ |
|
42
|
|
|
} |
|
43
|
|
|
|
|
44
|
|
|
/** |
|
|
|
|
|
|
45
|
|
|
* @return ProofOfPossessionResult |
|
46
|
|
|
*/ |
|
47
|
|
|
public static function invalidOtp(): self |
|
48
|
|
|
{ |
|
49
|
|
|
$result = new self(); |
|
50
|
|
|
$result->otpInvalid = true; |
|
51
|
|
|
|
|
52
|
|
|
return $result; |
|
53
|
|
|
} |
|
54
|
|
|
|
|
55
|
|
|
/** |
|
|
|
|
|
|
56
|
|
|
* @return ProofOfPossessionResult |
|
57
|
|
|
*/ |
|
58
|
|
|
public static function otpVerificationFailed(): self |
|
59
|
|
|
{ |
|
60
|
|
|
$result = new self(); |
|
61
|
|
|
$result->otpVerificationFailed = true; |
|
62
|
|
|
|
|
63
|
|
|
return $result; |
|
64
|
|
|
} |
|
65
|
|
|
|
|
66
|
|
|
/** |
|
|
|
|
|
|
67
|
|
|
* @return ProofOfPossessionResult |
|
68
|
|
|
*/ |
|
69
|
|
|
public static function proofOfPossessionCommandFailed(): self |
|
70
|
|
|
{ |
|
71
|
|
|
$result = new self(); |
|
72
|
|
|
$result->proofOfPossessionFailed = true; |
|
73
|
|
|
|
|
74
|
|
|
return $result; |
|
75
|
|
|
} |
|
76
|
|
|
|
|
77
|
|
|
/** |
|
|
|
|
|
|
78
|
|
|
* @param string $secondFactorId |
|
|
|
|
|
|
79
|
|
|
* @return ProofOfPossessionResult |
|
|
|
|
|
|
80
|
|
|
*/ |
|
81
|
|
|
public static function secondFactorCreated($secondFactorId): self |
|
82
|
|
|
{ |
|
83
|
|
|
if (!is_string($secondFactorId)) { |
|
|
|
|
|
|
84
|
|
|
throw InvalidArgumentException::invalidType('string', 'secondFactorId', $secondFactorId); |
|
85
|
|
|
} |
|
86
|
|
|
|
|
87
|
|
|
$result = new self(); |
|
88
|
|
|
$result->secondFactorId = $secondFactorId; |
|
89
|
|
|
|
|
90
|
|
|
return $result; |
|
91
|
|
|
} |
|
92
|
|
|
|
|
93
|
|
|
/** |
|
|
|
|
|
|
94
|
|
|
* @return bool |
|
95
|
|
|
*/ |
|
96
|
|
|
public function isSuccessful(): bool |
|
97
|
|
|
{ |
|
98
|
|
|
return $this->secondFactorId !== null; |
|
99
|
|
|
} |
|
100
|
|
|
|
|
101
|
|
|
/** |
|
|
|
|
|
|
102
|
|
|
* @return string |
|
103
|
|
|
*/ |
|
104
|
|
|
public function getSecondFactorId(): ?string |
|
105
|
|
|
{ |
|
106
|
|
|
return $this->secondFactorId; |
|
107
|
|
|
} |
|
108
|
|
|
|
|
109
|
|
|
/** |
|
|
|
|
|
|
110
|
|
|
* @return bool |
|
111
|
|
|
*/ |
|
112
|
|
|
public function isOtpInvalid(): bool |
|
113
|
|
|
{ |
|
114
|
|
|
return $this->otpInvalid; |
|
115
|
|
|
} |
|
116
|
|
|
|
|
117
|
|
|
/** |
|
|
|
|
|
|
118
|
|
|
* @return boolean |
|
119
|
|
|
*/ |
|
120
|
|
|
public function didOtpVerificationFail(): bool |
|
121
|
|
|
{ |
|
122
|
|
|
return $this->otpVerificationFailed; |
|
123
|
|
|
} |
|
124
|
|
|
|
|
125
|
|
|
/** |
|
|
|
|
|
|
126
|
|
|
* @return boolean |
|
127
|
|
|
*/ |
|
128
|
|
|
public function didProofOfPossessionCommandFail(): bool |
|
129
|
|
|
{ |
|
130
|
|
|
return $this->proofOfPossessionFailed; |
|
131
|
|
|
} |
|
132
|
|
|
} |
|
133
|
|
|
|
OpenConext /
Stepup-SelfService
Loading history...
