MediaWiki  1.28.1
Go to the documentation of this file.
1 <?php
29 class ApiCheckToken extends ApiBase {
31  public function execute() {
32  $params = $this->extractRequestParams();
33  $token = $params['token'];
34  $maxage = $params['maxtokenage'];
37  $res = [];
39  $tokenObj = ApiQueryTokens::getToken(
40  $this->getUser(), $this->getRequest()->getSession(), $salts[$params['type']]
41  );
42  if ( $tokenObj->match( $token, $maxage ) ) {
43  $res['result'] = 'valid';
44  } elseif ( $maxage !== null && $tokenObj->match( $token ) ) {
45  $res['result'] = 'expired';
46  } else {
47  $res['result'] = 'invalid';
48  }
51  if ( $ts !== null ) {
52  $mwts = new MWTimestamp();
53  $mwts->timestamp->setTimestamp( $ts );
54  $res['generated'] = $mwts->getTimestamp( TS_ISO_8601 );
55  }
57  $this->getResult()->addValue( null, $this->getModuleName(), $res );
58  }
60  public function getAllowedParams() {
61  return [
62  'type' => [
65  ],
66  'token' => [
67  ApiBase::PARAM_TYPE => 'string',
70  ],
71  'maxtokenage' => [
72  ApiBase::PARAM_TYPE => 'integer',
73  ],
74  ];
75  }
77  protected function getExamplesMessages() {
78  return [
79  'action=checktoken&type=csrf&token=123ABC'
80  => 'apihelp-checktoken-example-simple',
81  ];
82  }
83 }
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
Get the result object.
Definition: ApiBase.php:584
(boolean) Is the parameter required?
Definition: ApiBase.php:112
static getTimestamp($token)
Decode the timestamp from a token string.
Definition: Token.php:61
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:685
const TS_ISO_8601
ISO 8601 format with no timezone: 1986-02-09T20:00:00Z.
Definition: defines.php:28
Get the WebRequest object.
Definition: database.txt:21
Get the name of the module being executed by this instance.
Definition: ApiBase.php:464
(boolean) Is the parameter sensitive? Note 'password'-type fields are always sensitive regardless of ...
Definition: ApiBase.php:179
static getTokenTypeSalts()
Get the salts for known token types.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
static getToken(User $user, MediaWiki\Session\Session $session, $salt)
Get a token from a salt.
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:39
Get the User object.
Library for creating and parsing MW-style timestamps.
Definition: MWTimestamp.php:31