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
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*/
/**
* Validate an OATH token.
*
* @ingroup API
* @ingroup Extensions
*/
class ApiOATHValidate extends ApiBase {
public function execute() {
// Be extra paranoid about the data that is sent
$this->requirePostedParameters( [ 'totp', 'token' ] );
$params = $this->extractRequestParams();
if ( $params['user'] === null ) {
$params['user'] = $this->getUser()->getName();
}
$this->checkUserRightsAny( 'oathauth-api-all' );
$user = User::newFromName( $params['user'] );
if ( $user === false ) {
$this->dieWithError( 'noname' );
}
// Don't increase pingLimiter, just check for limit exceeded.
if ( $user->pingLimiter( 'badoath', 0 ) ) {
$this->dieWithError( 'apierror-ratelimited' );
}
$result = [
ApiResult::META_BC_BOOLS => [ 'enabled', 'valid' ],
'enabled' => false,
'valid' => false,
];
if ( !$user->isAnon() ) {
$oathUser = OATHAuthHooks::getOATHUserRepository()
->findByUser( $user );
if ( $oathUser ) {
$key = $oathUser->getKey();
if ( $key !== null ) {
$result['enabled'] = true;
$result['valid'] = $key->verifyToken(
$params['totp'], $oathUser ) !== false;
}
}
}
$this->getResult()->addValue( null, $this->getModuleName(), $result );
}
public function getCacheMode( $params ) {
return 'private';
}
public function isInternal() {
return true;
}
public function needsToken() {
return 'csrf';
}
public function getAllowedParams() {
return [
'user' => [
ApiBase::PARAM_TYPE => 'user',
],
'totp' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_REQUIRED => true,
],
];
}
protected function getExamplesMessages() {
return [
'action=oathvalidate&totp=123456&token=123ABC'
=> 'apihelp-oathvalidate-example-1',
'action=oathvalidate&user=Example&totp=123456&token=123ABC'
=> 'apihelp-oathvalidate-example-2',
];
}
}
|
