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
|
<?php
declare(strict_types=1);
/**
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
*
* Two-factor TOTP
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OCA\TwoFactorTOTP\Provider;
use OCA\TwoFactorTOTP\AppInfo\Application;
use OCA\TwoFactorTOTP\Service\ITotp;
use OCA\TwoFactorTOTP\Settings\Personal;
use OCP\AppFramework\IAppContainer;
use OCP\AppFramework\Services\IInitialState;
use OCP\Authentication\TwoFactorAuth\IActivatableAtLogin;
use OCP\Authentication\TwoFactorAuth\IDeactivatableByAdmin;
use OCP\Authentication\TwoFactorAuth\ILoginSetupProvider;
use OCP\Authentication\TwoFactorAuth\IPersonalProviderSettings;
use OCP\Authentication\TwoFactorAuth\IProvider;
use OCP\Authentication\TwoFactorAuth\IProvidesIcons;
use OCP\Authentication\TwoFactorAuth\IProvidesPersonalSettings;
use OCP\IL10N;
use OCP\IURLGenerator;
use OCP\IUser;
use OCP\Template;
class TotpProvider implements IProvider, IProvidesIcons, IProvidesPersonalSettings, IDeactivatableByAdmin, IActivatableAtLogin {
/** @var ITotp */
private $totp;
/** @var IL10N */
private $l10n;
/** @var IAppContainer */
private $container;
/** @var IInitialState */
private $initialState;
/** @var IURLGenerator */
private $urlGenerator;
public function __construct(ITotp $totp,
IL10N $l10n,
IAppContainer $container,
IInitialState $initialStateService,
IURLGenerator $urlGenerator) {
$this->totp = $totp;
$this->l10n = $l10n;
$this->container = $container;
$this->initialState = $initialStateService;
$this->urlGenerator = $urlGenerator;
}
/**
* Get unique identifier of this 2FA provider
*/
public function getId(): string {
return 'totp';
}
/**
* Get the display name for selecting the 2FA provider
*/
public function getDisplayName(): string {
return 'TOTP (Authenticator app)';
}
/**
* Get the description for selecting the 2FA provider
*/
public function getDescription(): string {
return $this->l10n->t('Authenticate with a TOTP app');
}
/**
* Get the template for rending the 2FA provider view
*/
public function getTemplate(IUser $user): Template {
return new Template('twofactor_totp', 'challenge');
}
/**
* Verify the given challenge
*/
public function verifyChallenge(IUser $user, string $challenge): bool {
$challenge = preg_replace('/[^0-9]/', '', $challenge);
return $this->totp->validateSecret($user, $challenge);
}
/**
* Decides whether 2FA is enabled for the given user
*/
public function isTwoFactorAuthEnabledForUser(IUser $user): bool {
return $this->totp->hasSecret($user);
}
public function getLightIcon(): String {
return $this->urlGenerator->imagePath(Application::APP_ID, 'app.svg');
}
public function getDarkIcon(): String {
return $this->urlGenerator->imagePath(Application::APP_ID, 'app-dark.svg');
}
public function getPersonalSettings(IUser $user): IPersonalProviderSettings {
$this->initialState->provideInitialState('state', $this->totp->hasSecret($user) ? ITotp::STATE_ENABLED : ITotp::STATE_DISABLED);
return new Personal();
}
/**
* Disable this provider for the given user.
*
* @param IUser $user the user to deactivate this provider for
*/
public function disableFor(IUser $user) {
$this->totp->deleteSecret($user, true);
}
public function getLoginSetup(IUser $user): ILoginSetupProvider {
return $this->container->query(AtLoginProvider::class);
}
}
|
