SecurityExtension::resetaccount() - Code Metrics - Inspection of "WIP: Group AccountReset extensions, implement full..." - silverstripe/silverstripe-mfa - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#165)

by Garion

created 2019-06-10 00:00 UTC

SecurityExtension::resetaccount() A

↳ Parent: SecurityExtension

Complexity

Conditions	4
Paths	3

Size

Total Lines	55
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	32
nc	3
nop	1
dl	0
loc	55
rs	9.408
c	0
b	0
f	0

How to fix Long Method

<?php declare(strict_types=1);

namespace SilverStripe\MFA\Extension\AccountReset;

use SilverStripe\Control\HTTPRequest;
use SilverStripe\Control\HTTPResponse;
use SilverStripe\Core\Extensible;
use SilverStripe\Core\Extension;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\Form;
use SilverStripe\Forms\FormAction;
use SilverStripe\Forms\PasswordField;
use SilverStripe\Forms\RequiredFields;
use SilverStripe\MFA\JSONResponse;
use SilverStripe\MFA\RequestHandler\BaseHandlerTrait;
use SilverStripe\ORM\FieldType\DBDatetime;
use SilverStripe\ORM\ValidationResult;
use SilverStripe\Security\Member;
use SilverStripe\Security\Security;

/**
 * Extends the Security controller to support Account Resets. This extension can
 * itself be extended to add procedures to the reset action (such as removing
 * additional authentication factors, sending alerts, etc.)
 *
 * @package SilverStripe\MFA\Extension
 * @property Security owner
 */
class SecurityExtension extends Extension
{
    use BaseHandlerTrait;
    use Extensible;

    private static $url_handlers = [

        'GET reset-account' => 'resetaccount',
    ];

    private static $allowed_actions = [

        'resetaccount',
        'ResetAccountForm',
    ];

    public function resetaccount(HTTPRequest $request)
    {
        if (Security::getCurrentUser()) {
            $output = $this->owner->renderWith(
                'Security',
                [
                    'Title' => _t(
                        __CLASS__ . '.ALREADYAUTHENTICATEDTITLE',
                        'Already authenticated'
                    ),
                    'Content' => _t(
                        __CLASS__ . '.ALREADYAUTHENTICATEDBODY',
                        'You must be logged out to reset your account.'
                    ),
                ]
            );
            return $this->owner->getResponse()->setBody($output)->setStatusCode(400);
        }

        $vars = $request->getVars();

        /** @var Member|MemberExtension $member */
        $member = Member::get()->byID(intval($vars['m'] ?? 0));

        if (is_null($member) || $member->verifyAccountResetToken($vars['t'] ?? '') === false) {
            $output = $this->owner->renderWith(
                'Security',
                [
                    'Title' => _t(
                        __CLASS__ . '.INVALIDTOKENTITLE',
                        'Invalid member or token'
                    ),
                    'Content' => _t(
                        __CLASS__ . '.INVALIDTOKENBODY',
                        'Your account reset token may have expired. Please contact an administrator.'
                    )
                ]
            );
            return $this->owner->getResponse()->setBody($output)->setStatusCode(400);
        }

        $request->getSession()->set('MemberID', $member->ID);

        return $this->owner->getResponse()->setBody($this->owner->renderWith(
            'Security',
            [
                'Title' => _t(
                    __CLASS__ . '.ACCOUNT_RESET_TITLE',
                    'Reset Account'
                ),
                'Message' => _t(
                    __CLASS__ . '.ACCOUNT_RESET_DESCRIPTION',
                    'Your password will be changed, and any registered MFA methods will be removed.'
                ),
                'Form' => $this->ResetAccountForm(),
            ]
        ));
    }

    public function ResetAccountForm(): Form
    {
        $fields = FieldList::create([
            PasswordField::create(
                'NewPassword1',
                _t(
                    'SilverStripe\\Security\\Member.NEWPASSWORD',
                    'New Password'
                )
            ),
            PasswordField::create(
                'NewPassword2',
                _t(
                    'SilverStripe\\Security\\Member.CONFIRMNEWPASSWORD',
                    'Confirm New Password'
                )
            ),
        ]);

        $actions = FieldList::create([
            FormAction::create('doResetAccount', 'Reset Account'),
        ]);

        $validation = RequiredFields::create(['NewPassword1', 'NewPassword2']);

        $form = Form::create($this->owner, 'ResetAccountForm', $fields, $actions, $validation);

        $this->owner->extend('updateResetAccountForm', $form);

        return $form;
    }

    /**
     * Resets the user's password, and triggers other account reset procedures
     *
     * @param array $data
     * @param Form $form
     * @return HTTPResponse
     */
    public function doResetAccount(array $data, Form $form): HTTPResponse
    {
        $memberID = $this->owner->getRequest()->getSession()->get('MemberID');

        // If the ID isn't in the session, politely assume the session has expired
        if (!$memberID) {
            $form->sessionMessage(
                _t(
                    __CLASS__ . '.RESETTIMEDOUT',
                    "The account reset process timed out. Please click the link in the email and try again."
                ),
                ValidationResult::TYPE_ERROR
            );

            return $this->owner->redirectBack();
        }

        /** @var Member&MemberExtension $member */
        $member = Member::get()->byID(intval($memberID));

        // Fail if passwords do not match
        if ($data['NewPassword1'] !== $data['NewPassword2']) {
            $form->sessionMessage(
                _t(
                    'SilverStripe\\Security\\Member.ERRORNEWPASSWORD',
                    'You have entered your new password differently, try again'
                ),
                ValidationResult::TYPE_ERROR
            );

            return $this->owner->redirectBack();
        }

        // Check if the new password is accepted
        $validationResult = $member->changePassword($data['NewPassword1']);
        if (!$validationResult->isValid()) {
            $form->setSessionValidationResult($validationResult);

            return $this->owner->redirectBack();
        }

        // Clear locked out status
        $member->LockedOutUntil = null;
        $member->FailedLoginCount = null;

        // Clear account reset data
        $member->AccountResetHash = null;
        $member->AccountResetExpired = DBDatetime::create()->now();
        $member->write();

        // Pass off to extensions to perform any additional reset actions
        $this->extend('handleAccountReset', $member);

        // Send the user along to the login form (allowing any additional factors to kick in as needed)
        $this->owner->setSessionMessage(
            _t(
                __CLASS__ . '.RESETSUCCESSMESSAGE',
                'Reset complete. Please log in with your new password.'
            ),
            ValidationResult::TYPE_GOOD
        );
        return $this->owner->redirect($this->owner->Link('login'));
    }
}


1			<?php declare(strict_types=1);
2
3			namespace SilverStripe\MFA\Extension\AccountReset;
4
5			use SilverStripe\Control\HTTPRequest;
6			use SilverStripe\Control\HTTPResponse;
7			use SilverStripe\Core\Extensible;
8			use SilverStripe\Core\Extension;
9			use SilverStripe\Forms\FieldList;
10			use SilverStripe\Forms\Form;
11			use SilverStripe\Forms\FormAction;
12			use SilverStripe\Forms\PasswordField;
13			use SilverStripe\Forms\RequiredFields;
14			use SilverStripe\MFA\JSONResponse;
15			use SilverStripe\MFA\RequestHandler\BaseHandlerTrait;
16			use SilverStripe\ORM\FieldType\DBDatetime;
17			use SilverStripe\ORM\ValidationResult;
18			use SilverStripe\Security\Member;
19			use SilverStripe\Security\Security;
20
21			/**
22			* Extends the Security controller to support Account Resets. This extension can
23			* itself be extended to add procedures to the reset action (such as removing
24			* additional authentication factors, sending alerts, etc.)
25			*
26			* @package SilverStripe\MFA\Extension
27			* @property Security owner
28			*/
29			class SecurityExtension extends Extension
30			{
31			use BaseHandlerTrait;
32			use Extensible;
33
34			private static $url_handlers = [
			0 ignored issues – show introduced 2019-06-07 01:45 UTC by Report Bug Copy Issue Report The private property `$url_handlers` is not used, and could be removed. Loading history...
35			'GET reset-account' => 'resetaccount',
36			];
37
38			private static $allowed_actions = [
			0 ignored issues – show introduced 2019-06-07 00:09 UTC by Report Bug Copy Issue Report The private property `$allowed_actions` is not used, and could be removed. Loading history...
39			'resetaccount',
40			'ResetAccountForm',
41			];
42
43			public function resetaccount(HTTPRequest $request)
44			{
45			if (Security::getCurrentUser()) {
46			$output = $this->owner->renderWith(
47			'Security',
48			[
49			'Title' => _t(
50			__CLASS__ . '.ALREADYAUTHENTICATEDTITLE',
51			'Already authenticated'
52			),
53			'Content' => _t(
54			__CLASS__ . '.ALREADYAUTHENTICATEDBODY',
55			'You must be logged out to reset your account.'
56			),
57			]
58			);
59			return $this->owner->getResponse()->setBody($output)->setStatusCode(400);
60			}
61
62			$vars = $request->getVars();
63
64			/** @var Member\|MemberExtension $member */
65			$member = Member::get()->byID(intval($vars['m'] ?? 0));
66
67			if (is_null($member) \|\| $member->verifyAccountResetToken($vars['t'] ?? '') === false) {
68			$output = $this->owner->renderWith(
69			'Security',
70			[
71			'Title' => _t(
72			__CLASS__ . '.INVALIDTOKENTITLE',
73			'Invalid member or token'
74			),
75			'Content' => _t(
76			__CLASS__ . '.INVALIDTOKENBODY',
77			'Your account reset token may have expired. Please contact an administrator.'
78			)
79			]
80			);
81			return $this->owner->getResponse()->setBody($output)->setStatusCode(400);
82			}
83
84			$request->getSession()->set('MemberID', $member->ID);
85
86			return $this->owner->getResponse()->setBody($this->owner->renderWith(
87			'Security',
88			[
89			'Title' => _t(
90			__CLASS__ . '.ACCOUNT_RESET_TITLE',
91			'Reset Account'
92			),
93			'Message' => _t(
94			__CLASS__ . '.ACCOUNT_RESET_DESCRIPTION',
95			'Your password will be changed, and any registered MFA methods will be removed.'
96			),
97			'Form' => $this->ResetAccountForm(),
98			]
99			));
100			}
101
102			public function ResetAccountForm(): Form
103			{
104			$fields = FieldList::create([
105			PasswordField::create(
106			'NewPassword1',
107			_t(
108			'SilverStripe\\Security\\Member.NEWPASSWORD',
109			'New Password'
110			)
111			),
112			PasswordField::create(
113			'NewPassword2',
114			_t(
115			'SilverStripe\\Security\\Member.CONFIRMNEWPASSWORD',
116			'Confirm New Password'
117			)
118			),
119			]);
120
121			$actions = FieldList::create([
122			FormAction::create('doResetAccount', 'Reset Account'),
123			]);
124
125			$validation = RequiredFields::create(['NewPassword1', 'NewPassword2']);
126
127			$form = Form::create($this->owner, 'ResetAccountForm', $fields, $actions, $validation);
128
129			$this->owner->extend('updateResetAccountForm', $form);
130
131			return $form;
132			}
133
134			/**
135			* Resets the user's password, and triggers other account reset procedures
136			*
137			* @param array $data
138			* @param Form $form
139			* @return HTTPResponse
140			*/
141			public function doResetAccount(array $data, Form $form): HTTPResponse
142			{
143			$memberID = $this->owner->getRequest()->getSession()->get('MemberID');
144
145			// If the ID isn't in the session, politely assume the session has expired
146			if (!$memberID) {
147			$form->sessionMessage(
148			_t(
149			__CLASS__ . '.RESETTIMEDOUT',
150			"The account reset process timed out. Please click the link in the email and try again."
151			),
152			ValidationResult::TYPE_ERROR
153			);
154
155			return $this->owner->redirectBack();
156			}
157
158			/** @var Member&MemberExtension $member */
159			$member = Member::get()->byID(intval($memberID));
160
161			// Fail if passwords do not match
162			if ($data['NewPassword1'] !== $data['NewPassword2']) {
163			$form->sessionMessage(
164			_t(
165			'SilverStripe\\Security\\Member.ERRORNEWPASSWORD',
166			'You have entered your new password differently, try again'
167			),
168			ValidationResult::TYPE_ERROR
169			);
170
171			return $this->owner->redirectBack();
172			}
173
174			// Check if the new password is accepted
175			$validationResult = $member->changePassword($data['NewPassword1']);
176			if (!$validationResult->isValid()) {
177			$form->setSessionValidationResult($validationResult);
178
179			return $this->owner->redirectBack();
180			}
181
182			// Clear locked out status
183			$member->LockedOutUntil = null;
184			$member->FailedLoginCount = null;
185
186			// Clear account reset data
187			$member->AccountResetHash = null;
188			$member->AccountResetExpired = DBDatetime::create()->now();
189			$member->write();
190
191			// Pass off to extensions to perform any additional reset actions
192			$this->extend('handleAccountReset', $member);
193
194			// Send the user along to the login form (allowing any additional factors to kick in as needed)
195			$this->owner->setSessionMessage(
196			_t(
197			__CLASS__ . '.RESETSUCCESSMESSAGE',
198			'Reset complete. Please log in with your new password.'
199			),
200			ValidationResult::TYPE_GOOD
201			);
202			return $this->owner->redirect($this->owner->Link('login'));
203			}
204			}
205

silverstripe / silverstripe-mfa

Pull Request — master (#165)

SecurityExtension::resetaccount() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like