Page MenuHomeWickedGov Phorge
Files F5975633

RequestClient.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

RequestClient.php
View Options

<?php
namespace MediaWiki\Extension\OAuth\Rest\Handler;
use MediaWiki\Extension\OAuth\Repository\ScopeRepository;
use MediaWiki\Json\FormatJson;
use MediaWiki\Rest\LocalizedHttpException;
use MediaWiki\Rest\Validator\Validator;
use MWRestrictions;
use Wikimedia\Message\MessageValue;
use Wikimedia\ParamValidator\ParamValidator;
/**
* Handles the oauth2/client endpoint, which creates
* a new consumer for the user
*/
class RequestClient extends AbstractClientHandler {
/**
* @inheritDoc
*/
protected function getFixedParams(): array {
return [
'oauthVersion' => '2.0',
'agreement' => true,
'action' => 'propose',
'granttype' => 'normal',
'rsaKey' => '',
'restrictions' => MWRestrictions::newDefault(),
];
}
/**
* @inheritDoc
*/
public function getBodyParamSettings(): array {
$scopeRepo = new ScopeRepository();
return [
'name' => [
self::PARAM_SOURCE => 'body',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
],
'version' => [
self::PARAM_SOURCE => 'body',
ParamValidator::PARAM_TYPE => [ '1.0', '2.0' ],
ParamValidator::PARAM_REQUIRED => false,
ParamValidator::PARAM_DEFAULT => '1.0',
],
'description' => [
self::PARAM_SOURCE => 'body',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
],
'wiki' => [
self::PARAM_SOURCE => 'body',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => false,
ParamValidator::PARAM_DEFAULT => '*',
],
'owner_only' => [
self::PARAM_SOURCE => 'body',
ParamValidator::PARAM_TYPE => 'boolean'
],
'callback_url' => [
self::PARAM_SOURCE => 'body',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => false,
ParamValidator::PARAM_DEFAULT => ''
],
'callback_is_prefix' => [
self::PARAM_SOURCE => 'body',
ParamValidator::PARAM_TYPE => 'boolean',
ParamValidator::PARAM_REQUIRED => false,
ParamValidator::PARAM_DEFAULT => false,
],
'email' => [
self::PARAM_SOURCE => 'body',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
],
'is_confidential' => [
self::PARAM_SOURCE => 'body',
ParamValidator::PARAM_TYPE => 'boolean',
ParamValidator::PARAM_REQUIRED => true,
],
'grant_types' => [
self::PARAM_SOURCE => 'body',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
ParamValidator::PARAM_ISMULTI => true
],
'scopes' => [
self::PARAM_SOURCE => 'body',
ParamValidator::PARAM_TYPE => $scopeRepo->getAllowedScopes(),
ParamValidator::PARAM_REQUIRED => true,
ParamValidator::PARAM_ISMULTI => true
]
];
}
/**
* @inheritDoc
*/
protected function getUnifiedParams(): array {
$params = parent::getUnifiedParams();
return $this->adjustScopes( $params );
}
/**
* This is needed to adjust OAuth2 scope array to old grant/granttype params
*
* @param array $finalParams
* @return array
*/
private function adjustScopes( array $finalParams ): array {
$scopeRepo = new ScopeRepository();
$allowedScopes = $scopeRepo->getAllowedScopes();
$scopes = array_filter( $finalParams['grants'], static function ( $scope ) use ( $allowedScopes ) {
return in_array( $scope, $allowedScopes );
} );
if ( $this->findAndRemoveScope( 'mwoauth-authonly', $scopes ) ) {
$finalParams['granttype'] = 'authonly';
}
if ( $this->findAndRemoveScope( 'mwoauth-authonlyprivate', $scopes ) ) {
$finalParams['granttype'] = 'authonlyprivate';
}
if ( !in_array( 'basic', $scopes ) ) {
$scopes[] = 'basic';
}
$finalParams['grants'] = FormatJson::encode( $scopes );
return $finalParams;
}
/**
* @param string $searchKey
* @param array &$values
* @return bool
*/
private function findAndRemoveScope( $searchKey, array &$values ): bool {
$index = array_search( $searchKey, $values );
if ( $index === false ) {
return false;
}
array_splice( $values, $index, 1 );
return true;
}
/**
* @inheritDoc
*/
public function validate( Validator $restValidator ) {
parent::validate( $restValidator );
$params = $this->getValidatedBody();
if (
( isset( $params['owner_only'] ) && !$params['owner_only'] ) &&
( isset( $params['callback_url'] ) && !$params['callback_url'] )
) {
throw new LocalizedHttpException(
new MessageValue( 'mwoauth-error-missing-callback-url-non-owner', [] ), 400
);
}
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 18:23 (49 m, 22 s)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
65/0f/f2105a4797a185d3d872f41d4058
Default Alt Text
RequestClient.php (4 KB)

Event Timeline