mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/OATHAuth
synced 2024-09-24 10:49:57 +00:00
f338a1489e
To make clear from the message name which module it belongs to, two example messages should be renamed. Change-Id: Idd329e77d5c7082eb8097309fb89f82c7a37cf68
102 lines
2.6 KiB
PHP
102 lines
2.6 KiB
PHP
<?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',
|
|
];
|
|
}
|
|
}
|