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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
<?php
namespace MediaWiki\Extensions\OAuth\Rest\Handler;
use Config;
use League\OAuth2\Server\Exception\OAuthServerException;
use MediaWiki\Extensions\OAuth\AuthorizationProvider\AccessToken as AccessTokenProvider;
use MediaWiki\Extensions\OAuth\AuthorizationProvider\Grant\AuthorizationCodeAuthorization;
use MediaWiki\Extensions\OAuth\Backend\Utils;
use MediaWiki\Extensions\OAuth\Response;
use MediaWiki\MediaWikiServices;
use MediaWiki\Rest\Handler;
use MediaWiki\Rest\HttpException;
use MediaWiki\Rest\Response as RestResponse;
use MediaWiki\Rest\StringStream;
use MediaWiki\Rest\Validator\Validator;
use Psr\Http\Message\ResponseInterface;
use RequestContext;
use User;
abstract class AuthenticationHandler extends Handler {
/**
* @var User
*/
protected $user;
/**
* @var Config
*/
protected $config;
/**
* @var OAuthServerException|null
*/
protected $queuedError;
/**
* @return AuthenticationHandler
*/
public static function factory() {
$centralId = Utils::getCentralIdFromLocalUser( RequestContext::getMain()->getUser() );
$user = $centralId ? Utils::getLocalUserFromCentralId( $centralId ) : User::newFromId( 0 );
$config = MediaWikiServices::getInstance()->getConfigFactory()->makeConfig( 'mwoauth' );
// @phan-suppress-next-line PhanTypeInstantiateAbstractStatic
return new static( $user, $config );
}
/**
* @param User $user
* @param Config $config
*/
protected function __construct( User $user, Config $config ) {
$this->user = $user;
$this->config = $config;
}
/**
* We do not want any permission checks
*
* @return bool
*/
public function needsReadAccess() {
return false;
}
/**
* We do not want any permission checks
*
* @return bool
*/
public function needsWriteAccess() {
return false;
}
/**
* @throws HttpException
* @return AccessTokenProvider|AuthorizationCodeAuthorization
*/
protected function getAuthorizationProvider() {
$grantKey = $this->getGrantKey();
$validated = $this->getValidatedParams();
$grantKeyValue = $validated[$grantKey];
$class = $this->getGrantClass( $grantKeyValue );
if ( !$class || !is_callable( [ $class, 'factory' ] ) ) {
throw new HttpException( 'invalid_request', 400 );
}
/** @var AccessTokenProvider|AuthorizationCodeAuthorization $authProvider */
$authProvider = $class::factory();
'@phan-var AccessTokenProvider|AuthorizationCodeAuthorization $authProvider';
return $authProvider;
}
public function validate( Validator $restValidator ) {
try {
parent::validate( $restValidator );
} catch ( HttpException $exception ) {
// Catch and store any validation errors, so they can be thrown
// during the execution, and get caught by appropriate error handling code
$type = $exception->getErrorData()['error'] ?? 'parameter-validation-failed';
if ( $type === 'parameter-validation-failed' ) {
$missingParam = $exception->getErrorData()['name'] ?? '';
return $this->queueError( OAuthServerException::invalidRequest( $missingParam ) );
}
$this->queueError( OAuthServerException::serverError( $exception->getMessage() ) );
}
}
/**
* @param OAuthServerException $ex
*/
protected function queueError( OAuthServerException $ex ) {
// If already set, do not override, since we cannot throw more than one error,
// and it will probably be more useful to throw first error that occurred
if ( !$this->queuedError ) {
$this->queuedError = $ex;
}
}
/**
* @param array $query
* @return string
*/
protected function getQueryParamsCgi( $query = [] ) {
$queryParams = $this->getRequest()->getQueryParams();
unset( $queryParams['title'] );
$queryParams = array_merge( $queryParams, $query );
return wfArrayToCgi( $queryParams );
}
/**
* @param OAuthServerException $exception
* @param Response|null $response
* @return ResponseInterface|RestResponse
*/
protected function errorResponse( $exception, $response = null ) {
$response = $response ?? new Response();
$response = $exception->generateHttpResponse( $response );
if ( $exception->hasRedirect() || $this->getRequest()->getMethod() === 'POST' ) {
return $response;
}
$out = RequestContext::getMain()->getOutput();
// TODO: Should we include message/hint eventhough they are not localized?
$out->showErrorPage(
'mwoauth-error',
$this->getLocalizedErrorMessage( $exception->getErrorType() )
);
ob_start();
$out->output();
$html = ob_get_clean();
$response = $this->getResponseFactory()->create();
$stream = new StringStream( $html );
$response->setHeader( 'Content-Type', 'text/html' );
$response->setBody( $stream );
return $response;
}
/**
* @param string $type
* @return string
*/
private function getLocalizedErrorMessage( $type ) {
$map = [
'invalid_client' => 'mwoauth-oauth2-error-invalid-client',
'server_error' => 'mwoauth-oauth2-error-server-error',
'invalid_request' => 'mwoauth-oauth2-error-invalid-request',
'unauthorized_client' => 'mwoauth-oauth2-error-unauthorized-client',
'access_denied' => 'mwoauth-oauth2-error-access-denied',
'unsupported_response_type' => 'mwoauth-oauth2-error-unsupported-response-type',
'invalid_scope' => 'mwoauth-oauth2-error-invalid-scope',
'temporarily_unavailable' => 'mwoauth-oauth2-error-temporarily-unavailable'
];
if ( isset( $map[$type] ) ) {
return $map[$type];
}
return 'mwoauth-oauth2-error-server-error';
}
/**
* @return string
*/
abstract protected function getGrantKey();
/**
* @param string $grantKey
* @return string|false
*/
abstract protected function getGrantClass( $grantKey );
}
|
GitWeb