4b8b0358eb
The RESTBase team has requested the ability to check the validity of a
CSRF token and to interface with Title::userCan().
The former is accomplished by the new action=checktoken module. The
latter by a new parameter ('testactions') to the existing prop=info.
Bug: T88010
Change-Id: I2530f1315ec93f5be9fb437137992150fdc305f2
81 lines
2.3 KiB
PHP
81 lines
2.3 KiB
PHP
<?php
|
|
/**
|
|
* Created on Jan 29, 2015
|
|
*
|
|
* Copyright © 2015 Brad Jorsch bjorsch@wikimedia.org
|
|
*
|
|
* 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
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
/**
|
|
* @since 1.25
|
|
* @ingroup API
|
|
*/
|
|
class ApiCheckToken extends ApiBase {
|
|
|
|
public function execute() {
|
|
$params = $this->extractRequestParams();
|
|
$token = $params['token'];
|
|
$maxage = $params['maxtokenage'];
|
|
$request = $this->getRequest();
|
|
$salts = ApiQueryTokens::getTokenTypeSalts();
|
|
$salt = $salts[$params['type']];
|
|
|
|
$res = array();
|
|
|
|
if ( $this->getUser()->matchEditToken( $token, $salt, $request, $maxage ) ) {
|
|
$res['result'] = 'valid';
|
|
} elseif ( $maxage !== null && $this->getUser()->matchEditToken( $token, $salt, $request ) ) {
|
|
$res['result'] = 'expired';
|
|
} else {
|
|
$res['result'] = 'invalid';
|
|
}
|
|
|
|
$ts = User::getEditTokenTimestamp( $token );
|
|
if ( $ts !== null ) {
|
|
$mwts = new MWTimestamp();
|
|
$mwts->timestamp->setTimestamp( $ts );
|
|
$res['generated'] = $mwts->getTimestamp( TS_ISO_8601 );
|
|
}
|
|
|
|
$this->getResult()->addValue( null, $this->getModuleName(), $res );
|
|
}
|
|
|
|
public function getAllowedParams() {
|
|
return array(
|
|
'type' => array(
|
|
ApiBase::PARAM_TYPE => array_keys( ApiQueryTokens::getTokenTypeSalts() ),
|
|
ApiBase::PARAM_REQUIRED => true,
|
|
),
|
|
'token' => array(
|
|
ApiBase::PARAM_TYPE => 'string',
|
|
ApiBase::PARAM_REQUIRED => true,
|
|
),
|
|
'maxtokenage' => array(
|
|
ApiBase::PARAM_TYPE => 'integer',
|
|
),
|
|
);
|
|
}
|
|
|
|
protected function getExamplesMessages() {
|
|
return array(
|
|
'action=checktoken&type=csrf&token=123ABC'
|
|
=> 'apihelp-checktoken-example-simple',
|
|
);
|
|
}
|
|
}
|