AuthManagerSpecialPage.php

Go to the documentation of this file.

<?php

use MediaWiki\Auth\AuthenticationRequest;
use MediaWiki\Auth\AuthenticationResponse;
use MediaWiki\Auth\AuthManager;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\Session\Token;

abstract class AuthManagerSpecialPage extends SpecialPage {
    protected static $allowedActions = [
        AuthManager::ACTION_LOGIN, AuthManager::ACTION_LOGIN_CONTINUE,
        AuthManager::ACTION_CREATE, AuthManager::ACTION_CREATE_CONTINUE,
        AuthManager::ACTION_LINK, AuthManager::ACTION_LINK_CONTINUE,
        AuthManager::ACTION_CHANGE, AuthManager::ACTION_REMOVE, AuthManager::ACTION_UNLINK,
    ];

    protected static $messages = [];

    protected $authAction;

    protected $authRequests;

    protected $subPage;

    protected $isReturn;

    protected $savedRequest;

    public function onAuthChangeFormFields(
        array $requests, array $fieldInfo, array &$formDescriptor, $action
    ) {
        return true;
    }

    protected function getLoginSecurityLevel() {
        return $this->getName();
    }

    public function getRequest() {
        return $this->savedRequest ?: $this->getContext()->getRequest();
    }

    protected function setRequest( array $data, $wasPosted = null ) {
        $request = $this->getContext()->getRequest();
        if ( $wasPosted === null ) {
            $wasPosted = $request->wasPosted();
        }
        $this->savedRequest = new DerivativeRequest( $request, $data + $request->getQueryValues(),
            $wasPosted );
    }

    protected function beforeExecute( $subPage ) {
        $this->getOutput()->disallowUserJs();

        return $this->handleReturnBeforeExecute( $subPage )
            && $this->handleReauthBeforeExecute( $subPage );
    }

    protected function handleReturnBeforeExecute( $subPage ) {
        $authManager = AuthManager::singleton();
        $key = 'AuthManagerSpecialPage:return:' . $this->getName();

        if ( $subPage === 'return' ) {
            $this->loadAuth( $subPage );
            $preservedParams = $this->getPreservedParams( false );

            // FIXME save POST values only from request
            $authData = array_diff_key( $this->getRequest()->getValues(),
                $preservedParams, [ 'title' => 1 ] );
            $authManager->setAuthenticationSessionData( $key, $authData );

            $url = $this->getPageTitle()->getFullURL( $preservedParams, false, PROTO_HTTPS );
            $this->getOutput()->redirect( $url );
            return false;
        }

        $authData = $authManager->getAuthenticationSessionData( $key );
        if ( $authData ) {
            $authManager->removeAuthenticationSessionData( $key );
            $this->isReturn = true;
            $this->setRequest( $authData, true );
        }

        return true;
    }

    protected function handleReauthBeforeExecute( $subPage ) {
        $authManager = AuthManager::singleton();
        $request = $this->getRequest();
        $key = 'AuthManagerSpecialPage:reauth:' . $this->getName();

        $securityLevel = $this->getLoginSecurityLevel();
        if ( $securityLevel ) {
            $securityStatus = AuthManager::singleton()
                ->securitySensitiveOperationStatus( $securityLevel );
            if ( $securityStatus === AuthManager::SEC_REAUTH ) {
                $queryParams = array_diff_key( $request->getQueryValues(), [ 'title' => true ] );

                if ( $request->wasPosted() ) {
                    // unique ID in case the same special page is open in multiple browser tabs
                    $uniqueId = MWCryptRand::generateHex( 6 );
                    $key = $key . ':' . $uniqueId;

                    $queryParams = [ 'authUniqueId' => $uniqueId ] + $queryParams;
                    $authData = array_diff_key( $request->getValues(),
                            $this->getPreservedParams( false ), [ 'title' => 1 ] );
                    $authManager->setAuthenticationSessionData( $key, $authData );
                }

                $title = SpecialPage::getTitleFor( 'Userlogin' );
                $url = $title->getFullURL( [
                    'returnto' => $this->getFullTitle()->getPrefixedDBkey(),
                    'returntoquery' => wfArrayToCgi( $queryParams ),
                    'force' => $securityLevel,
                ], false, PROTO_HTTPS );

                $this->getOutput()->redirect( $url );
                return false;
            } elseif ( $securityStatus !== AuthManager::SEC_OK ) {
                throw new ErrorPageError( 'cannotauth-not-allowed-title', 'cannotauth-not-allowed' );
            }
        }

        $uniqueId = $request->getVal( 'authUniqueId' );
        if ( $uniqueId ) {
            $key = $key . ':' . $uniqueId;
            $authData = $authManager->getAuthenticationSessionData( $key );
            if ( $authData ) {
                $authManager->removeAuthenticationSessionData( $key );
                $this->setRequest( $authData, true );
            }
        }

        return true;
    }

    protected function getDefaultAction( $subPage ) {
        throw new BadMethodCallException( 'Subclass did not implement getDefaultAction' );
    }

    protected function messageKey( $defaultKey ) {
        return array_key_exists( $defaultKey, static::$messages )
            ? static::$messages[$defaultKey] : $defaultKey;
    }

    protected function getRequestBlacklist() {
        return [];
    }

    protected function loadAuth( $subPage, $authAction = null, $reset = false ) {
        // Do not load if already loaded, to cut down on the number of getAuthenticationRequests
        // calls. This is important for requests which have hidden information so any
        // getAuthenticationRequests call would mean putting data into some cache.
        if (
            !$reset && $this->subPage === $subPage && $this->authAction
            && ( !$authAction || $authAction === $this->authAction )
        ) {
            return;
        }

        $request = $this->getRequest();
        $this->subPage = $subPage;
        $this->authAction = $authAction ?: $request->getText( 'authAction' );
        if ( !in_array( $this->authAction, static::$allowedActions, true ) ) {
            $this->authAction = $this->getDefaultAction( $subPage );
            if ( $request->wasPosted() ) {
                $continueAction = $this->getContinueAction( $this->authAction );
                if ( in_array( $continueAction, static::$allowedActions, true ) ) {
                    $this->authAction = $continueAction;
                }
            }
        }

        $allReqs = AuthManager::singleton()->getAuthenticationRequests(
            $this->authAction, $this->getUser() );
        $this->authRequests = array_filter( $allReqs, function ( $req ) use ( $subPage ) {
            return !in_array( get_class( $req ), $this->getRequestBlacklist(), true );
        } );
    }

    protected function isContinued() {
        return in_array( $this->authAction, [
            AuthManager::ACTION_LOGIN_CONTINUE,
            AuthManager::ACTION_CREATE_CONTINUE,
            AuthManager::ACTION_LINK_CONTINUE,
        ], true );
    }

    protected function getContinueAction( $action ) {
        switch ( $action ) {
            case AuthManager::ACTION_LOGIN:
                $action = AuthManager::ACTION_LOGIN_CONTINUE;
                break;
            case AuthManager::ACTION_CREATE:
                $action = AuthManager::ACTION_CREATE_CONTINUE;
                break;
            case AuthManager::ACTION_LINK:
                $action = AuthManager::ACTION_LINK_CONTINUE;
                break;
        }
        return $action;
    }

    protected function isActionAllowed( $action ) {
        $authManager = AuthManager::singleton();
        if ( !in_array( $action, static::$allowedActions, true ) ) {
            throw new InvalidArgumentException( 'invalid action: ' . $action );
        }

        // calling getAuthenticationRequests can be expensive, avoid if possible
        $requests = ( $action === $this->authAction ) ? $this->authRequests
            : $authManager->getAuthenticationRequests( $action );
        if ( !$requests ) {
            // no provider supports this action in the current state
            return false;
        }

        switch ( $action ) {
            case AuthManager::ACTION_LOGIN:
            case AuthManager::ACTION_LOGIN_CONTINUE:
                return $authManager->canAuthenticateNow();
            case AuthManager::ACTION_CREATE:
            case AuthManager::ACTION_CREATE_CONTINUE:
                return $authManager->canCreateAccounts();
            case AuthManager::ACTION_LINK:
            case AuthManager::ACTION_LINK_CONTINUE:
                return $authManager->canLinkAccounts();
            case AuthManager::ACTION_CHANGE:
            case AuthManager::ACTION_REMOVE:
            case AuthManager::ACTION_UNLINK:
                return true;
            default:
                // should never reach here but makes static code analyzers happy
                throw new InvalidArgumentException( 'invalid action: ' . $action );
        }
    }

    protected function performAuthenticationStep( $action, array $requests ) {
        if ( !in_array( $action, static::$allowedActions, true ) ) {
            throw new InvalidArgumentException( 'invalid action: ' . $action );
        }

        $authManager = AuthManager::singleton();
        $returnToUrl = $this->getPageTitle( 'return' )
            ->getFullURL( $this->getPreservedParams( true ), false, PROTO_HTTPS );

        switch ( $action ) {
            case AuthManager::ACTION_LOGIN:
                return $authManager->beginAuthentication( $requests, $returnToUrl );
            case AuthManager::ACTION_LOGIN_CONTINUE:
                return $authManager->continueAuthentication( $requests );
            case AuthManager::ACTION_CREATE:
                return $authManager->beginAccountCreation( $this->getUser(), $requests,
                    $returnToUrl );
            case AuthManager::ACTION_CREATE_CONTINUE:
                return $authManager->continueAccountCreation( $requests );
            case AuthManager::ACTION_LINK:
                return $authManager->beginAccountLink( $this->getUser(), $requests, $returnToUrl );
            case AuthManager::ACTION_LINK_CONTINUE:
                return $authManager->continueAccountLink( $requests );
            case AuthManager::ACTION_CHANGE:
            case AuthManager::ACTION_REMOVE:
            case AuthManager::ACTION_UNLINK:
                if ( count( $requests ) > 1 ) {
                    throw new InvalidArgumentException( 'only one auth request can be changed at a time' );
                } elseif ( !$requests ) {
                    throw new InvalidArgumentException( 'no auth request' );
                }
                $req = reset( $requests );
                $status = $authManager->allowsAuthenticationDataChange( $req );
                Hooks::run( 'ChangeAuthenticationDataAudit', [ $req, $status ] );
                if ( !$status->isGood() ) {
                    return AuthenticationResponse::newFail( $status->getMessage() );
                }
                $authManager->changeAuthenticationData( $req );
                return AuthenticationResponse::newPass();
            default:
                // should never reach here but makes static code analyzers happy
                throw new InvalidArgumentException( 'invalid action: ' . $action );
        }
    }

    protected function trySubmit() {
        $status = false;

        $form = $this->getAuthForm( $this->authRequests, $this->authAction );
        $form->setSubmitCallback( [ $this, 'handleFormSubmit' ] );

        if ( $this->getRequest()->wasPosted() ) {
            // handle tokens manually; $form->tryAuthorizedSubmit only works for logged-in users
            $requestTokenValue = $this->getRequest()->getVal( $this->getTokenName() );
            $sessionToken = $this->getToken();
            if ( $sessionToken->wasNew() ) {
                return Status::newFatal( $this->messageKey( 'authform-newtoken' ) );
            } elseif ( !$requestTokenValue ) {
                return Status::newFatal( $this->messageKey( 'authform-notoken' ) );
            } elseif ( !$sessionToken->match( $requestTokenValue ) ) {
                return Status::newFatal( $this->messageKey( 'authform-wrongtoken' ) );
            }

            $form->prepareForm();
            $status = $form->trySubmit();

            // HTMLForm submit return values are a mess; let's ensure it is false or a Status
            // FIXME this probably should be in HTMLForm
            if ( $status === true ) {
                // not supposed to happen since our submit handler should always return a Status
                throw new UnexpectedValueException( 'HTMLForm::trySubmit() returned true' );
            } elseif ( $status === false ) {
                // form was not submitted; nothing to do
            } elseif ( $status instanceof Status ) {
                // already handled by the form; nothing to do
            } elseif ( $status instanceof StatusValue ) {
                // in theory not an allowed return type but nothing stops the submit handler from
                // accidentally returning it so best check and fix
                $status = Status::wrap( $status );
            } elseif ( is_string( $status ) ) {
                $status = Status::newFatal( new RawMessage( '$1', $status ) );
            } elseif ( is_array( $status ) ) {
                if ( is_string( reset( $status ) ) ) {
                    $status = call_user_func_array( 'Status::newFatal', $status );
                } elseif ( is_array( reset( $status ) ) ) {
                    $status = Status::newGood();
                    foreach ( $status as $message ) {
                        call_user_func_array( [ $status, 'fatal' ], $message );
                    }
                } else {
                    throw new UnexpectedValueException( 'invalid HTMLForm::trySubmit() return value: '
                        . 'first element of array is ' . gettype( reset( $status ) ) );
                }
            } else {
                // not supposed to happen but HTMLForm does not actually verify the return type
                // from the submit callback; better safe then sorry
                throw new UnexpectedValueException( 'invalid HTMLForm::trySubmit() return type: '
                    . gettype( $status ) );
            }

            if ( ( !$status || !$status->isOK() ) && $this->isReturn ) {
                // This is awkward. There was a form validation error, which means the data was not
                // passed to AuthManager. Normally we would display the form with an error message,
                // but for the data we received via the redirect flow that would not be helpful at all.
                // Let's just submit the data to AuthManager directly instead.
                LoggerFactory::getInstance( 'authentication' )
                    ->warning( 'Validation error on return', [ 'data' => $form->mFieldData,
                        'status' => $status->getWikiText() ] );
                $status = $this->handleFormSubmit( $form->mFieldData );
            }
        }

        $changeActions = [
            AuthManager::ACTION_CHANGE, AuthManager::ACTION_REMOVE, AuthManager::ACTION_UNLINK
        ];
        if ( in_array( $this->authAction, $changeActions, true ) && $status && !$status->isOK() ) {
            Hooks::run( 'ChangeAuthenticationDataAudit', [ reset( $this->authRequests ), $status ] );
        }

        return $status;
    }

    public function handleFormSubmit( $data ) {
        $requests = AuthenticationRequest::loadRequestsFromSubmission( $this->authRequests, $data );
        $response = $this->performAuthenticationStep( $this->authAction, $requests );

        // we can't handle FAIL or similar as failure here since it might require changing the form
        return Status::newGood( $response );
    }

    protected function getPreservedParams( $withToken = false ) {
        $params = [];
        if ( $this->authAction !== $this->getDefaultAction( $this->subPage ) ) {
            $params['authAction'] = $this->getContinueAction( $this->authAction );
        }
        if ( $withToken ) {
            $params[$this->getTokenName()] = $this->getToken()->toString();
        }
        return $params;
    }

    protected function getAuthFormDescriptor( $requests, $action ) {
        $fieldInfo = AuthenticationRequest::mergeFieldInfo( $requests );
        $formDescriptor = $this->fieldInfoToFormDescriptor( $requests, $fieldInfo, $action );

        $this->addTabIndex( $formDescriptor );

        return $formDescriptor;
    }

    protected function getAuthForm( array $requests, $action ) {
        $formDescriptor = $this->getAuthFormDescriptor( $requests, $action );
        $context = $this->getContext();
        if ( $context->getRequest() !== $this->getRequest() ) {
            // We have overridden the request, need to make sure the form uses that too.
            $context = new DerivativeContext( $this->getContext() );
            $context->setRequest( $this->getRequest() );
        }
        $form = HTMLForm::factory( 'ooui', $formDescriptor, $context );
        $form->setAction( $this->getFullTitle()->getFullURL( $this->getPreservedParams() ) );
        $form->addHiddenField( $this->getTokenName(), $this->getToken()->toString() );
        $form->addHiddenField( 'authAction', $this->authAction );
        $form->suppressDefaultSubmit( !$this->needsSubmitButton( $requests ) );

        return $form;
    }

    protected function displayForm( $status ) {
        if ( $status instanceof StatusValue ) {
            $status = Status::wrap( $status );
        }
        $form = $this->getAuthForm( $this->authRequests, $this->authAction );
        $form->prepareForm()->displayForm( $status );
    }

    protected function needsSubmitButton( array $requests ) {
        $customSubmitButtonPresent = false;

        // Secondary and preauth providers always need their data; they will not care what button
        // is used, so they can be ignored. So can OPTIONAL buttons createdby primary providers;
        // that's the point in being optional. Se we need to check whether all primary providers
        // have their own buttons and whether there is at least one button present.
        foreach ( $requests as $req ) {
            if ( $req->required === AuthenticationRequest::PRIMARY_REQUIRED ) {
                if ( $this->hasOwnSubmitButton( $req ) ) {
                    $customSubmitButtonPresent = true;
                } else {
                    return true;
                }
            }
        }
        return !$customSubmitButtonPresent;
    }

    protected function hasOwnSubmitButton( AuthenticationRequest $req ) {
        foreach ( $req->getFieldInfo() as $field => $info ) {
            if ( $info['type'] === 'button' ) {
                return true;
            }
        }
        return false;
    }

    protected function addTabIndex( &$formDescriptor ) {
        $i = 1;
        foreach ( $formDescriptor as $field => &$definition ) {
            $class = false;
            if ( array_key_exists( 'class', $definition ) ) {
                $class = $definition['class'];
            } elseif ( array_key_exists( 'type', $definition ) ) {
                $class = HTMLForm::$typeMappings[$definition['type']];
            }
            if ( $class !== 'HTMLInfoField' ) {
                $definition['tabindex'] = $i;
                $i++;
            }
        }
    }

    protected function getToken() {
        return $this->getRequest()->getSession()->getToken( 'AuthManagerSpecialPage:'
            . $this->getName() );
    }

    protected function getTokenName() {
        return 'wpAuthToken';
    }

    protected function fieldInfoToFormDescriptor( array $requests, array $fieldInfo, $action ) {
        $formDescriptor = [];
        foreach ( $fieldInfo as $fieldName => $singleFieldInfo ) {
            $formDescriptor[$fieldName] = self::mapSingleFieldInfo( $singleFieldInfo, $fieldName );
        }

        $requestSnapshot = serialize( $requests );
        $this->onAuthChangeFormFields( $requests, $fieldInfo, $formDescriptor, $action );
        \Hooks::run( 'AuthChangeFormFields', [ $requests, $fieldInfo, &$formDescriptor, $action ] );
        if ( $requestSnapshot !== serialize( $requests ) ) {
            LoggerFactory::getInstance( 'authentication' )->warning(
                'AuthChangeFormFields hook changed auth requests' );
        }

        // Process the special 'weight' property, which is a way for AuthChangeFormFields hook
        // subscribers (who only see one field at a time) to influence ordering.
        self::sortFormDescriptorFields( $formDescriptor );

        return $formDescriptor;
    }

    protected static function mapSingleFieldInfo( $singleFieldInfo, $fieldName ) {
        $type = self::mapFieldInfoTypeToFormDescriptorType( $singleFieldInfo['type'] );
        $descriptor = [
            'type' => $type,
            // Do not prefix input name with 'wp'. This is important for the redirect flow.
            'name' => $fieldName,
        ];

        if ( $type === 'submit' && isset( $singleFieldInfo['label'] ) ) {
            $descriptor['default'] = wfMessage( $singleFieldInfo['label'] )->plain();
        } elseif ( $type !== 'submit' ) {
            $descriptor += array_filter( [
                // help-message is omitted as it is usually not really useful for a web interface
                'label-message' => self::getField( $singleFieldInfo, 'label' ),
            ] );

            if ( isset( $singleFieldInfo['options'] ) ) {
                $descriptor['options'] = array_flip( array_map( function ( $message ) {
                    return $message->parse();
                }, $singleFieldInfo['options'] ) );
            }

            if ( isset( $singleFieldInfo['value'] ) ) {
                $descriptor['default'] = $singleFieldInfo['value'];
            }

            if ( empty( $singleFieldInfo['optional'] ) ) {
                $descriptor['required'] = true;
            }
        }

        return $descriptor;
    }

    protected static function sortFormDescriptorFields( array &$formDescriptor ) {
        $i = 0;
        foreach ( $formDescriptor as &$field ) {
            $field['__index'] = $i++;
        }
        uasort( $formDescriptor, function ( $first, $second ) {
            return self::getField( $first, 'weight', 0 ) - self::getField( $second, 'weight', 0 )
                ?: $first['__index'] - $second['__index'];
        } );
        foreach ( $formDescriptor as &$field ) {
            unset( $field['__index'] );
        }
    }

    protected static function getField( array $array, $fieldName, $default = null ) {
        if ( array_key_exists( $fieldName, $array ) ) {
            return $array[$fieldName];
        } else {
            return $default;
        }
    }

    protected static function mapFieldInfoTypeToFormDescriptorType( $type ) {
        $map = [
            'string' => 'text',
            'password' => 'password',
            'select' => 'select',
            'checkbox' => 'check',
            'multiselect' => 'multiselect',
            'button' => 'submit',
            'hidden' => 'hidden',
            'null' => 'info',
        ];
        if ( !array_key_exists( $type, $map ) ) {
            throw new \LogicException( 'invalid field type: ' . $type );
        }
        return $map[$type];
    }
}