silverstripe / silverstripe-mfa

src/Extension/MemberExtension.php

<?php declare(strict_types=1);

namespace SilverStripe\MFA\Extension;

use SilverStripe\Control\Controller;
use SilverStripe\Forms\FieldList;
use SilverStripe\MFA\Authenticator\ChangePasswordHandler;
use SilverStripe\MFA\Exception\InvalidMethodException;
use SilverStripe\MFA\FormField\RegisteredMFAMethodListField;
use SilverStripe\MFA\Method\MethodInterface;
use SilverStripe\MFA\Model\RegisteredMethod;
use SilverStripe\ORM\DataExtension;
use SilverStripe\ORM\HasManyList;
use SilverStripe\Security\Member;
use SilverStripe\Security\Permission;
use SilverStripe\Security\PermissionProvider;
use SilverStripe\Security\Security;

/**
 * Extend Member to add relationship to registered methods and track some specific preferences
 *
 * @method RegisteredMethod[]|HasManyList RegisteredMFAMethods
 * @property MethodInterface DefaultRegisteredMethod
 * @property string DefaultRegisteredMethodID
 * @property bool HasSkippedMFARegistration
 * @property Member|MemberExtension owner
 */
class MemberExtension extends DataExtension implements PermissionProvider
{
    const MFA_ADMINISTER_REGISTERED_METHODS = 'MFA_ADMINISTER_REGISTERED_METHODS';

    private static $has_many = [

The private property $has_many is not used, and could be removed.

        'RegisteredMFAMethods' => RegisteredMethod::class,
    ];

    private static $db = [

The private property $db is not used, and could be removed.

        'DefaultRegisteredMethodID' => 'Int',
        'HasSkippedMFARegistration' => 'Boolean',
    ];

    /**
     * Accessor for the `DefaultRegisteredMethod` property.
     *
     * This is replicating the usual functionality of a has_one relation but does it like this so we can ensure the same
     * instance of the MethodInterface is provided regardless if you access it through the has_one or the has_many.
     *
     * @return RegisteredMethod|null
     */
    public function getDefaultRegisteredMethod(): ?RegisteredMethod
    {
        return $this->owner->RegisteredMFAMethods()->byId($this->owner->DefaultRegisteredMethodID);

The expression return $this->owner->RegisteredMFAMethods()->byId($this->owner->DefaultRegisteredMethodID) returns the type SilverStripe\ORM\DataObject which includes types incompatible with the type-hinted return SilverStripe\MFA\Model\RegisteredMethod|null.

It seems like $this->owner->DefaultRegisteredMethodID can also be of type string; however, parameter $id of SilverStripe\ORM\DataList::byID() does only seem to accept integer, maybe add an additional type check?

    }

    /**
     * Set the default registered method for the current member. Does not write the owner record.
     *
     * @param RegisteredMethod $registeredMethod
     * @return Member
     * @throws InvalidMethodException
     */
    public function setDefaultRegisteredMethod(RegisteredMethod $registeredMethod): Member
    {
        if ($registeredMethod->Member()->ID != $this->owner->ID) {

The property ID does not exist on SilverStripe\MFA\Extension\MemberExtension. Did you maybe forget to declare it?

            throw new InvalidMethodException('The provided method does not belong to this member');
        }
        $this->owner->DefaultRegisteredMethodID = $registeredMethod->ID;
        return $this->owner;

The expression return $this->owner could return the type SilverStripe\MFA\Extension\MemberExtension which is incompatible with the type-hinted return SilverStripe\Security\Member. Consider adding an additional type-check to rule them out.

    }

    public function updateCMSFields(FieldList $fields): FieldList
    {
        $fields->removeByName(['DefaultRegisteredMethodID', 'HasSkippedMFARegistration', 'RegisteredMFAMethods']);

        if (!$this->owner->exists() || !$this->currentUserCanViewMFAConfig()) {

The method exists() does not exist on SilverStripe\MFA\Extension\MemberExtension.

            return $fields;
        }

        $fields->addFieldToTab(
            'Root.Main',
            $methodListField = RegisteredMFAMethodListField::create(
                'MFASettings',
                _t(__CLASS__ . '.MFA_SETTINGS_FIELD_LABEL', 'Multi-factor authentication settings (MFA)'),
                $this->owner
            )
        );

        if (!$this->currentUserCanEditMFAConfig()) {
            $methodListField->setReadonly(true);
        }

        return $fields;
    }

    /**
     * Determines whether the logged in user has sufficient permission to see the MFA config for this Member.
     *
     * @return bool
     */
    public function currentUserCanViewMFAConfig(): bool
    {
        return (Permission::check(self::MFA_ADMINISTER_REGISTERED_METHODS)
            || $this->currentUserCanEditMFAConfig());
    }

    /**
     * Determines whether the logged in user has sufficient permission to modify the MFA config for this Member.
     * Note that this is different from being able to _reset_ the config (which administrators can do).
     *
     * @return bool
     */
    public function currentUserCanEditMFAConfig(): bool
    {
        return (Security::getCurrentUser() && Security::getCurrentUser()->ID === $this->owner->ID);

The property ID does not exist on SilverStripe\MFA\Extension\MemberExtension. Did you maybe forget to declare it?

    }

    /**
     * Provides the MFA view/reset permission for selection in the permission list in the CMS.
     *
     * @return array
     */
    public function providePermissions(): array
    {
        $label = _t(
            __CLASS__ . '.MFA_PERMISSION_LABEL',
            'View/reset MFA configuration for other members'
        );

        $category = _t(
            'SilverStripe\\Security\\Permission.PERMISSIONS_CATEGORY',
            'Roles and access permissions'
        );

        $description = _t(
            __CLASS__ . '.MFA_PERMISSION_DESCRIPTION',
            'Ability to view and reset registered MFA methods for other members.'
            . ' Requires the "Access to \'Security\' section" permission.'
        );

        return [
            self::MFA_ADMINISTER_REGISTERED_METHODS => [
                'name' => $label,
                'category' => $category,
                'help' => $description,
                'sort' => 200,
            ],
        ];
    }

    /**
     * Clear any temporary multi-factor authentication related session keys when a member is successfully logged in.
     */
    public function afterMemberLoggedIn(): void
    {
        if (!Controller::has_curr()) {
            return;
        }

        Controller::curr()
            ->getRequest()
            ->getSession()
            ->clear(ChangePasswordHandler::MFA_VERIFIED_ON_CHANGE_PASSWORD);
    }
}