1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/** |
4
|
|
|
* Platine Webauth |
5
|
|
|
* |
6
|
|
|
* Platine Webauthn is the implementation of webauthn specifications |
7
|
|
|
* |
8
|
|
|
* This content is released under the MIT License (MIT) |
9
|
|
|
* |
10
|
|
|
* Copyright (c) 2020 Platine Webauth |
11
|
|
|
* Copyright (c) Jakob Bennemann <[email protected]> |
12
|
|
|
* |
13
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy |
14
|
|
|
* of this software and associated documentation files (the "Software"), to deal |
15
|
|
|
* in the Software without restriction, including without limitation the rights |
16
|
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
17
|
|
|
* copies of the Software, and to permit persons to whom the Software is |
18
|
|
|
* furnished to do so, subject to the following conditions: |
19
|
|
|
* |
20
|
|
|
* The above copyright notice and this permission notice shall be included in all |
21
|
|
|
* copies or substantial portions of the Software. |
22
|
|
|
* |
23
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
24
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
25
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
26
|
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
27
|
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
28
|
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
29
|
|
|
* SOFTWARE. |
30
|
|
|
*/ |
31
|
|
|
|
32
|
|
|
declare(strict_types=1); |
33
|
|
|
|
34
|
|
|
namespace Platine\Webauthn\Entity; |
35
|
|
|
|
36
|
|
|
use JsonSerializable; |
37
|
|
|
use Platine\Webauthn\Enum\UserVerificationType; |
38
|
|
|
|
39
|
|
|
/** |
40
|
|
|
* @class AuthenticatorSelection |
41
|
|
|
* @package Platine\Webauthn\Entity |
42
|
|
|
*/ |
43
|
|
|
class AuthenticatorSelection implements JsonSerializable |
44
|
|
|
{ |
45
|
|
|
/** |
46
|
|
|
* The authenticator attachment |
47
|
|
|
* @var string |
48
|
|
|
*/ |
49
|
|
|
protected string $authenticatorAttachment = 'platform'; |
50
|
|
|
|
51
|
|
|
/** |
52
|
|
|
* The resident key type |
53
|
|
|
* @var string |
54
|
|
|
*/ |
55
|
|
|
protected string $residentKey; |
56
|
|
|
|
57
|
|
|
/** |
58
|
|
|
* require resident key |
59
|
|
|
* @var bool |
60
|
|
|
*/ |
61
|
|
|
protected bool $requireResidentKey = false; |
62
|
|
|
|
63
|
|
|
/** |
64
|
|
|
* The user verification type |
65
|
|
|
* @var string |
66
|
|
|
*/ |
67
|
|
|
protected string $userVerification; |
68
|
|
|
|
69
|
|
|
/** |
70
|
|
|
* Create new instance |
71
|
|
|
* @param string $userVerificationType |
72
|
|
|
* @param bool $requireResidentKey |
73
|
|
|
* @param bool $crossPlatform |
74
|
|
|
*/ |
75
|
|
|
public function __construct( |
76
|
|
|
string $userVerificationType, |
77
|
|
|
bool $requireResidentKey = false, |
78
|
|
|
bool $crossPlatform = false |
79
|
|
|
) { |
80
|
|
|
$this->requireResidentKey = $requireResidentKey; |
81
|
|
|
$this->residentKey = UserVerificationType::DISCOURAGED; |
82
|
|
|
|
83
|
|
|
$this->userVerification = $userVerificationType; |
84
|
|
|
if ($requireResidentKey) { |
85
|
|
|
$this->residentKey = $userVerificationType; |
86
|
|
|
} |
87
|
|
|
|
88
|
|
|
if ($crossPlatform) { |
89
|
|
|
$this->authenticatorAttachment = 'cross-platform'; |
90
|
|
|
} |
91
|
|
|
} |
92
|
|
|
|
93
|
|
|
/** |
94
|
|
|
* |
95
|
|
|
* @return string |
96
|
|
|
*/ |
97
|
|
|
public function getAuthenticatorAttachment(): string |
98
|
|
|
{ |
99
|
|
|
return $this->authenticatorAttachment; |
100
|
|
|
} |
101
|
|
|
|
102
|
|
|
/** |
103
|
|
|
* |
104
|
|
|
* @return string |
105
|
|
|
*/ |
106
|
|
|
public function getResidentKey(): string |
107
|
|
|
{ |
108
|
|
|
return $this->residentKey; |
109
|
|
|
} |
110
|
|
|
|
111
|
|
|
/** |
112
|
|
|
* |
113
|
|
|
* @return bool |
114
|
|
|
*/ |
115
|
|
|
public function isRequireResidentKey(): bool |
116
|
|
|
{ |
117
|
|
|
return $this->requireResidentKey; |
118
|
|
|
} |
119
|
|
|
|
120
|
|
|
/** |
121
|
|
|
* |
122
|
|
|
* @return string |
123
|
|
|
*/ |
124
|
|
|
public function getUserVerification(): string |
125
|
|
|
{ |
126
|
|
|
return $this->userVerification; |
127
|
|
|
} |
128
|
|
|
|
129
|
|
|
/** |
130
|
|
|
* {@inheritdoc} |
131
|
|
|
* @return mixed |
132
|
|
|
*/ |
133
|
|
|
public function jsonSerialize() |
134
|
|
|
{ |
135
|
|
|
return get_object_vars($this); |
136
|
|
|
} |
137
|
|
|
} |
138
|
|
|
|