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
141
142
143
144
145
146
147
148
149
150
151
|
<?php
/**
* Module to fetch tokens via action=query&meta=tokens
*
* Copyright © 2014 Wikimedia Foundation and contributors
*
* 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.24
*/
namespace MediaWiki\Api;
use MediaWiki\MediaWikiServices;
use MediaWiki\User\User;
use Wikimedia\ParamValidator\ParamValidator;
/**
* Module to fetch tokens via action=query&meta=tokens
*
* @ingroup API
* @since 1.24
*/
class ApiQueryTokens extends ApiQueryBase {
public function execute() {
$params = $this->extractRequestParams();
if ( $this->lacksSameOriginSecurity() ) {
$this->addWarning( [ 'apiwarn-tokens-origin' ] );
return;
}
$user = $this->getUser();
$session = $this->getRequest()->getSession();
$salts = self::getTokenTypeSalts();
$done = [];
$path = [ 'query', $this->getModuleName() ];
$this->getResult()->addArrayType( $path, 'assoc' );
foreach ( $params['type'] as $type ) {
$token = self::getToken( $user, $session, $salts[$type] )->toString();
$fit = $this->getResult()->addValue( $path, $type . 'token', $token );
if ( !$fit ) {
// Abuse type as a query-continue parameter and set it to all unprocessed types
$this->setContinueEnumParameter( 'type',
array_diff( $params['type'], $done ) );
break;
}
$done[] = $type;
}
}
/**
* Get the salts for known token types
* @return (string|array)[] Returning a string will use that as the salt
* for User::getEditTokenObject() to fetch the token, which will give a
* LoggedOutEditToken (always "+\\") for anonymous users. Returning an
* array will use it as parameters to MediaWiki\Session\Session::getToken(),
* which will always return a full token even for anonymous users.
*/
public static function getTokenTypeSalts() {
static $salts = null;
if ( !$salts ) {
$salts = [
'csrf' => '',
'watch' => 'watch',
'patrol' => 'patrol',
'rollback' => 'rollback',
'userrights' => 'userrights',
'login' => [ '', 'login' ],
'createaccount' => [ '', 'createaccount' ],
];
$hookContainer = MediaWikiServices::getInstance()->getHookContainer();
$hookRunner = new ApiHookRunner( $hookContainer );
$hookRunner->onApiQueryTokensRegisterTypes( $salts );
ksort( $salts );
}
return $salts;
}
/**
* Get a token from a salt
* @param User $user
* @param \MediaWiki\Session\Session $session
* @param string|array $salt A string will be used as the salt for
* User::getEditTokenObject() to fetch the token, which will give a
* LoggedOutEditToken (always "+\\") for anonymous users. An array will
* be used as parameters to MediaWiki\Session\Session::getToken(), which
* will always return a full token even for anonymous users. An array will
* also persist the session.
* @return \MediaWiki\Session\Token
*/
public static function getToken( User $user, \MediaWiki\Session\Session $session, $salt ) {
if ( is_array( $salt ) ) {
$session->persist();
return $session->getToken( ...$salt );
} else {
return $user->getEditTokenObject( $salt, $session->getRequest() );
}
}
public function getAllowedParams() {
return [
'type' => [
ParamValidator::PARAM_DEFAULT => 'csrf',
ParamValidator::PARAM_ISMULTI => true,
ParamValidator::PARAM_TYPE => array_keys( self::getTokenTypeSalts() ),
ParamValidator::PARAM_ALL => true,
],
];
}
protected function getExamplesMessages() {
return [
'action=query&meta=tokens'
=> 'apihelp-query+tokens-example-simple',
'action=query&meta=tokens&type=watch|patrol'
=> 'apihelp-query+tokens-example-types',
];
}
public function isReadMode() {
// So login tokens can be fetched on private wikis
return false;
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Tokens';
}
}
/** @deprecated class alias since 1.43 */
class_alias( ApiQueryTokens::class, 'ApiQueryTokens' );
|
