SpecialOATHEnable.php

Go to the documentation of this file.

<?php
class SpecialOATHEnable extends FormSpecialPage {
    private $OATHRepository;
 
    private $OATHUser;
 
    public function __construct( OATHUserRepository $repository, OATHUser $user ) {
        parent::__construct( 'OATH', 'oathauth-enable', false );
 
        $this->OATHRepository = $repository;
        $this->OATHUser = $user;
    }
 
    public function doesWrites() {
        return true;
    }
 
    public function alterForm( HTMLForm $form ) {
        $form->setMessagePrefix( 'oathauth' );
        $form->setWrapperLegend( false );
        $form->getOutput()->setPageTitle( $this->msg( 'oathauth-enable' ) );
        $form->getOutput()->addModules( 'ext.oath.showqrcode' );
        $form->getOutput()->addModuleStyles( 'ext.oath.showqrcode.styles' );
    }
 
    protected function getDisplayFormat() {
        return 'ooui';
    }
 
    public function requiresUnblock() {
        return false;
    }
 
    protected function checkExecutePermissions( User $user ) {
        parent::checkExecutePermissions( $user );
 
        $this->requireLogin();
    }
 
    public function execute( $par ) {
        $this->getOutput()->disallowUserJs();
        parent::execute( $par );
    }
 
    protected function getFormFields() {
        $key = $this->getRequest()->getSessionData( 'oathauth_key' );
 
        if ( $key === null ) {
            $key = OATHAuthKey::newFromRandom();
            $this->getRequest()->setSessionData( 'oathauth_key', $key );
        }
 
        $secret = $key->getSecret();
        $label = "{$this->OATHUser->getIssuer()}:{$this->OATHUser->getAccount()}";
        $qrcodeUrl = "otpauth://totp/"
            . rawurlencode( $label )
            . "?secret="
            . rawurlencode( $secret )
            . "&issuer="
            . rawurlencode( $this->OATHUser->getIssuer() );
 
        $qrcodeElement = Html::element( 'div', [
            'data-mw-qrcode-url' => $qrcodeUrl,
            'class' => 'mw-display-qrcode',
            // Include width/height, so js won't re-arrange layout
            // And non-js users will have this hidden with CSS
            'style' => 'width: 256px; height: 256px;'
        ] );
 
        return [
            'app' => [
                'type' => 'info',
                'default' => $this->msg( 'oathauth-step1-test' )->escaped(),
                'raw' => true,
                'section' => 'step1',
            ],
            'qrcode' => [
                'type' => 'info',
                'default' => $qrcodeElement,
                'raw' => true,
                'section' => 'step2',
            ],
            'manual' => [
                'type' => 'info',
                'label-message' => 'oathauth-step2alt',
                'default' =>
                    '<strong>' . $this->msg( 'oathauth-account' )->escaped() . '</strong><br/>'
                    . $this->OATHUser->getAccount() . '<br/><br/>'
                    . '<strong>' . $this->msg( 'oathauth-secret' )->escaped() . '</strong><br/>'
                    . '<kbd>' . $this->getSecretForDisplay( $key ) . '</kbd><br/>',
                'raw' => true,
                'section' => 'step2',
            ],
            'scratchtokens' => [
                'type' => 'info',
                'default' =>
                    $this->msg( 'oathauth-scratchtokens' )
                    . $this->createResourceList( $this->getScratchTokensForDisplay( $key ) ),
                'raw' => true,
                'section' => 'step3',
            ],
            'token' => [
                'type' => 'text',
                'default' => '',
                'label-message' => 'oathauth-entertoken',
                'name' => 'token',
                'section' => 'step4',
            ],
            'returnto' => [
                'type' => 'hidden',
                'default' => $this->getRequest()->getVal( 'returnto' ),
                'name' => 'returnto',
            ],
            'returntoquery' => [
                'type' => 'hidden',
                'default' => $this->getRequest()->getVal( 'returntoquery' ),
                'name' => 'returntoquery',
            ]
        ];
    }
 
    public function onSubmit( array $formData ) {
        $key = $this->getRequest()->getSessionData( 'oathauth_key' );
 
        if ( $key->isScratchToken( $formData['token'] ) ) {
            // A scratch token is not allowed for enrollement
            \MediaWiki\Logger\LoggerFactory::getInstance( 'authentication' )->info(
                'OATHAuth {user} attempted to enable 2FA using a scratch token from {clientip}', [
                    'user' => $this->getUser()->getName(),
                    'clientip' => $this->getRequest()->getIP(),
                ]
            );
            return [ 'oathauth-noscratchforvalidation' ];
        }
        if ( !$key->verifyToken( $formData['token'], $this->OATHUser ) ) {
            \MediaWiki\Logger\LoggerFactory::getInstance( 'authentication' )->info(
                'OATHAuth {user} failed to provide a correct token while enabling 2FA from {clientip}', [
                    'user' => $this->getUser()->getName(),
                    'clientip' => $this->getRequest()->getIP(),
                ]
            );
            return [ 'oathauth-failedtovalidateoath' ];
        }
 
        $this->getRequest()->setSessionData( 'oathauth_key', null );
        $this->OATHUser->setKey( $key );
        $this->OATHRepository->persist( $this->OATHUser, $this->getRequest()->getIP() );
 
        return true;
    }
 
    public function onSuccess() {
        $this->getOutput()->addWikiMsg( 'oathauth-validatedoath' );
        $this->getOutput()->returnToMain();
    }
 
    private function createResourceList( $resources ) {
        $resourceList = '';
        foreach ( $resources as $resource ) {
            $resourceList .= Html::rawElement( 'li', [], Html::rawElement( 'kbd', [], $resource ) );
        }
        return Html::rawElement( 'ul', [], $resourceList );
    }
 
    protected function getSecretForDisplay( OATHAuthKey $key ) {
        return $this->tokenFormatterFunction( $key->getSecret() );
    }
 
    protected function getScratchTokensForDisplay( OATHAuthKey $key ) {
        return array_map( [ $this, 'tokenFormatterFunction' ], $key->getScratchTokens() );
    }
 
    private function tokenFormatterFunction( $token ) {
        return implode( ' ', str_split( $token, 4 ) );
    }
}