Page MenuHomeWickedGov Phorge
Files F4144841

createOAuthConsumer.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

createOAuthConsumer.php
View Options

<?php
/**
* Example:
*
* createOAuthConsumer.php
* --callbackIsPrefix
* --callbackUrl="https://foourl"
* --description="Application description"
* --grants="editprotected"
* --grants="createaccount"
* --name="Application name"
* --user="Admin"
* --version="0.2"
* --wiki=default
* --approve
*
* You can optionally output successful results as json using --jsonOnSuccess
*/
namespace MediaWiki\Extension\OAuth;
use MediaWiki\Context\RequestContext;
use MediaWiki\Extension\OAuth\Backend\Consumer;
use MediaWiki\Extension\OAuth\Backend\Utils;
use MediaWiki\Extension\OAuth\Control\ConsumerSubmitControl;
use MediaWiki\Maintenance\Maintenance;
use MediaWiki\User\User;
use MWRestrictions;
/**
* @ingroup Maintenance
*/
// @codeCoverageIgnoreStart
if ( getenv( 'MW_INSTALL_PATH' ) ) {
$IP = getenv( 'MW_INSTALL_PATH' );
} else {
$IP = __DIR__ . '/../../..';
}
require_once "$IP/maintenance/Maintenance.php";
// @codeCoverageIgnoreEnd
class CreateOAuthConsumer extends Maintenance {
public function __construct() {
parent::__construct();
$this->addDescription( "Create an OAuth consumer" );
$this->addOption(
'oauthVersion',
'OAuth version (' . Consumer::OAUTH_VERSION_1 . ' or ' . Consumer::OAUTH_VERSION_2 .
', default ' . Consumer::OAUTH_VERSION_1 . ')',
false,
true
);
$this->addOption( 'user', 'User to run the script as', true, true );
$this->addOption( 'name', 'Application name', true, true );
$this->addOption( 'description', 'Application description', true, true );
$this->addOption( 'version', 'Application version', true, true );
$this->addOption( 'callbackUrl', 'Callback URL', true, true );
$this->addOption(
'callbackIsPrefix',
'Allow a consumer to specify a callback in requests (OAuth 1 only)'
);
$this->addOption( 'grants', 'Grants', true, true, false, true );
$this->addOption( 'jsonOnSuccess', 'Output successful results as JSON' );
$this->addOption( 'approve', 'Accept the consumer' );
$this->addOption(
'ownerOnly',
'Make the consumer only usable by the given user; see ' .
'https://www.mediawiki.org/wiki/OAuth/Owner-only_consumers.'
);
$this->addOption(
'oauth2IsNotConfidential',
'Mark the client as *not* confidential (OAuth 2 only). By default, clients are confidential.'
);
$this->addOption(
'oauth2GrantTypes',
'The OAuth 2 grant types: authorization_code, refresh_token, and/or client_credentials.',
false,
true,
false,
true
);
$this->requireExtension( "OAuth" );
}
public function execute() {
$user = User::newFromName( $this->getOption( 'user' ) );
if ( !$user->isNamed() ) {
$this->fatalError( 'User must be registered' );
}
if ( $user->getEmail() === '' ) {
$this->fatalError( 'User must have an email' );
}
$oauthVersion = (int)$this->getOption( 'oauthVersion', Consumer::OAUTH_VERSION_1 );
if ( !in_array( $oauthVersion, [ Consumer::OAUTH_VERSION_1, Consumer::OAUTH_VERSION_2 ], true ) ) {
$this->fatalError(
'Invalid oauthVersion, must be ' . Consumer::OAUTH_VERSION_1 .
' or ' . Consumer::OAUTH_VERSION_2 . '!'
);
}
if ( $oauthVersion === Consumer::OAUTH_VERSION_2 ) {
if ( $this->hasOption( 'callbackIsPrefix' ) ) {
$this->fatalError( 'callbackIsPrefix is only available in oauthVersion 1' );
}
} else {
if ( $this->hasOption( 'oauth2IsNotConfidential' ) ) {
$this->fatalError( 'oauth2IsNotConfidential is only available in oauthVersion 2' );
}
if ( $this->hasOption( 'oauth2GrantTypes' ) ) {
$this->fatalError( 'oauth2GrantTypes is only available in oauthVersion 2' );
}
}
$data = [
'action' => 'propose',
'name' => $this->getOption( 'name' ),
'version' => $this->getOption( 'version' ),
'description' => $this->getOption( 'description' ),
'callbackUrl' => $this->getOption( 'callbackUrl' ),
'oauthVersion' => $oauthVersion,
'callbackIsPrefix' => $this->hasOption( 'callbackIsPrefix' ),
'grants' => '["' . implode( '","', $this->getOption( 'grants' ) ) . '"]',
'granttype' => 'normal',
'ownerOnly' => $this->hasOption( 'ownerOnly' ),
'oauth2IsConfidential' => !$this->hasOption( 'oauth2IsNotConfidential' ),
'oauth2GrantTypes' => $this->getOption( 'oauth2GrantTypes', [ 'authorization_code', 'refresh_token' ] ),
'email' => $user->getEmail(),
// All wikis
'wiki' => '*',
// Generate a key
'rsaKey' => '',
'agreement' => true,
'restrictions' => MWRestrictions::newDefault(),
];
$context = RequestContext::getMain();
$context->setUser( $user );
$dbw = Utils::getCentralDB( DB_PRIMARY );
$control = new ConsumerSubmitControl( $context, $data, $dbw );
$status = $control->submit();
if ( !$status->isGood() ) {
$this->fatalError( $status->getMessage()->text() );
}
/** @var Consumer $cmr */
$cmr = $status->value['result']['consumer'];
if ( $this->hasOption( 'approve' ) ) {
$data = [
'action' => 'approve',
'consumerKey' => $cmr->getConsumerKey(),
'reason' => 'Approved by maintenance script',
'changeToken' => $cmr->getChangeToken( $context ),
];
$control = new ConsumerSubmitControl( $context, $data, $dbw );
$approveStatus = $control->submit();
}
$outputData = [
'created' => true,
'id' => $cmr->getId(),
'name' => $cmr->getName(),
'key' => $cmr->getConsumerKey(),
'secret' => Utils::hmacDBSecret( $cmr->getSecretKey() ),
];
if ( isset( $approveStatus ) ) {
$outputData['approved'] = $approveStatus->isGood() ?
1 : $approveStatus->getWikiText( false, false, 'en' );
}
if ( $this->hasOption( 'jsonOnSuccess' ) ) {
$this->output( json_encode( $outputData ) );
} else {
foreach ( $outputData as $key => $value ) {
$this->output( $key . ': ' . $value . PHP_EOL );
}
}
}
}
// @codeCoverageIgnoreStart
$maintClass = CreateOAuthConsumer::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd

File Metadata

Mime Type
text/x-php
Expires
Aug 19 2026, 17:23 (4 w, 6 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
7b/53/5f92a9088cc036fa2ec596dc219b
Default Alt Text
createOAuthConsumer.php (5 KB)

Event Timeline