Page MenuHomeWickedGov Phorge

VerifyOATHForUser.php
No OneTemporary

Size
4 KB
Referenced Files
None
Subscribers
None

VerifyOATHForUser.php

<?php
namespace MediaWiki\Extension\OATHAuth\Special;
use ManualLogEntry;
use MediaWiki\CheckUser\Hooks as CheckUserHooks;
use MediaWiki\Config\ConfigException;
use MediaWiki\Extension\OATHAuth\OATHUserRepository;
use MediaWiki\HTMLForm\HTMLForm;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\Registration\ExtensionRegistry;
use MediaWiki\SpecialPage\FormSpecialPage;
use MediaWiki\User\User;
use MediaWiki\User\UserFactory;
use MWException;
use UserBlockedError;
use UserNotLoggedIn;
class VerifyOATHForUser extends FormSpecialPage {
private const OATHAUTH_IS_ENABLED = 'enabled';
private const OATHAUTH_NOT_ENABLED = 'disabled';
private OATHUserRepository $userRepo;
private UserFactory $userFactory;
/** @var string */
private $enabledStatus;
/** @var string */
private $targetUser;
/**
* @param OATHUserRepository $userRepo
* @param UserFactory $userFactory
*/
public function __construct( $userRepo, $userFactory ) {
// messages used: verifyoathforuser (display "name" on Special:SpecialPages),
// right-oathauth-verify-user, action-oathauth-verify-user
parent::__construct( 'VerifyOATHForUser', 'oathauth-verify-user' );
$this->userRepo = $userRepo;
$this->userFactory = $userFactory;
}
/**
* @inheritDoc
*/
protected function getGroupName() {
return 'users';
}
public function doesWrites() {
return true;
}
/**
* @return string
*/
protected function getLoginSecurityLevel() {
return $this->getName();
}
/**
* @param HTMLForm $form
*/
public function alterForm( HTMLForm $form ) {
$form->setMessagePrefix( 'oathauth' );
$form->getOutput()->setPageTitleMsg( $this->msg( 'oathauth-verify-for-user' ) );
}
/**
* @return string
*/
protected function getDisplayFormat() {
return 'ooui';
}
/**
* @return bool
*/
public function requiresUnblock() {
return true;
}
/**
* @param User $user
* @throws UserBlockedError
* @throws UserNotLoggedIn
*/
protected function checkExecutePermissions( User $user ) {
$this->requireNamedUser();
parent::checkExecutePermissions( $user );
}
/**
* @param string $par
*/
public function execute( $par ) {
$this->getOutput()->disallowUserJs();
parent::execute( $par );
}
/**
* @return array[]
*/
protected function getFormFields() {
return [
'user' => [
'type' => 'user',
'default' => '',
'label-message' => 'oathauth-enteruser',
'name' => 'user',
'required' => true,
],
'reason' => [
'type' => 'text',
'default' => '',
'label-message' => 'oathauth-enterverifyreason',
'name' => 'reason',
'required' => true,
],
];
}
/**
* @param array $formData
* @return array|true
* @throws ConfigException
* @throws MWException
*/
public function onSubmit( array $formData ) {
$this->targetUser = $formData['user'];
$user = $this->userFactory->newFromName( $this->targetUser );
if ( !$user || $user->getId() === 0 ) {
return [ 'oathauth-user-not-found' ];
}
$oathUser = $this->userRepo->findByUser( $user );
$this->enabledStatus = $oathUser->isTwoFactorAuthEnabled()
? self::OATHAUTH_IS_ENABLED
: self::OATHAUTH_NOT_ENABLED;
// messages used: logentry-oath-verify, log-action-oath-verify
$logEntry = new ManualLogEntry( 'oath', 'verify' );
$logEntry->setPerformer( $this->getUser() );
$logEntry->setTarget( $user->getUserPage() );
$logEntry->setComment( $formData['reason'] );
$logEntry->insert();
if ( ExtensionRegistry::getInstance()->isLoaded( 'CheckUser' ) ) {
CheckUserHooks::updateCheckUserData( $logEntry->getRecentChange() );
}
LoggerFactory::getInstance( 'authentication' )->info(
'OATHAuth status checked for {usertarget} by {user} from {clientip}', [
'user' => $this->getUser()->getName(),
'usertarget' => $this->targetUser,
'clientip' => $this->getRequest()->getIP(),
]
);
return true;
}
/**
* @throws MWException
*/
public function onSuccess() {
switch ( $this->enabledStatus ) {
case self::OATHAUTH_IS_ENABLED:
$msg = 'oathauth-verify-enabled';
break;
case self::OATHAUTH_NOT_ENABLED:
$msg = 'oathauth-verify-disabled';
break;
default:
throw new MWException(
'Verification was successful but status is unknown'
);
}
$out = $this->getOutput();
$out->addBacklinkSubtitle( $this->getPageTitle() );
$out->addWikiMsg( $msg, $this->targetUser );
}
}

File Metadata

Mime Type
text/x-php
Expires
Oct 5 2026, 10:21 (6 w, 1 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
33/26/467a0421c1e0a8fc1b071be8e878
Default Alt Text
VerifyOATHForUser.php (4 KB)

Event Timeline