silverstripe-framework/tests/php/Security/MemberAuthenticatorTest.php

<?php

namespace SilverStripe\Security\Tests;

use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\FieldType\DBDatetime;
use SilverStripe\ORM\ValidationResult;
use SilverStripe\Security\PasswordEncryptor;
use SilverStripe\Security\PasswordEncryptor_PHPHash;
use SilverStripe\Security\Security;
use SilverStripe\Security\Member;
use SilverStripe\Security\MemberAuthenticator;
use SilverStripe\Security\MemberLoginForm;
use SilverStripe\Security\CMSMemberLoginForm;
use SilverStripe\Core\Config\Config;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\Form;

class MemberAuthenticatorTest extends SapphireTest
{

    protected $usesDatabase = true;

    protected $defaultUsername = null;
    protected $defaultPassword = null;

    protected function setUp()
    {
        parent::setUp();

        $this->defaultUsername = Security::default_admin_username();
        $this->defaultPassword = Security::default_admin_password();
        Security::clear_default_admin();
        Security::setDefaultAdmin('admin', 'password');
    }

    protected function tearDown()
    {
        Security::setDefaultAdmin($this->defaultUsername, $this->defaultPassword);
        parent::tearDown();
    }

    public function testLegacyPasswordHashMigrationUponLogin()
    {
        $member = new Member();

        $field=Member::config()->unique_identifier_field;

        $member->$field = 'test1@test.com';
        $member->PasswordEncryption = "sha1";
        $member->Password = "mypassword";
        $member->write();

        $data = array(
            'Email' => $member->$field,
            'Password' => 'mypassword'
        );
        MemberAuthenticator::authenticate($data);

        /**
 * @var Member $member
*/
        $member = DataObject::get_by_id(Member::class, $member->ID);
        $this->assertEquals($member->PasswordEncryption, "sha1_v2.4");
        $result = $member->checkPassword('mypassword');
        $this->assertTrue($result->isValid());
    }

    public function testNoLegacyPasswordHashMigrationOnIncompatibleAlgorithm()
    {
        Config::inst()->update(
            PasswordEncryptor::class,
            'encryptors',
            array('crc32' => array(PasswordEncryptor_PHPHash::class => 'crc32'))
        );
        $field=Member::config()->unique_identifier_field;

        $member = new Member();
        $member->$field = 'test2@test.com';
        $member->PasswordEncryption = "crc32";
        $member->Password = "mypassword";
        $member->write();

        $data = array(
            'Email' => $member->$field,
            'Password' => 'mypassword'
        );
        MemberAuthenticator::authenticate($data);

        $member = DataObject::get_by_id(Member::class, $member->ID);
        $this->assertEquals($member->PasswordEncryption, "crc32");
        $result = $member->checkPassword('mypassword');
        $this->assertTrue($result->isValid());
    }

    public function testCustomIdentifierField()
    {

        $origField = Member::config()->unique_identifier_field;
        Member::config()->unique_identifier_field = 'Username';

        $label=singleton(Member::class)->fieldLabel(Member::config()->unique_identifier_field);

        $this->assertEquals($label, 'Username');

        Member::config()->unique_identifier_field = $origField;
    }

    public function testGenerateLoginForm()
    {
        $controller = new Security();

        // Create basic login form
        $frontendForm = MemberAuthenticator::get_login_form($controller);
        $this->assertTrue($frontendForm instanceof MemberLoginForm);

        // Supports cms login form
        $this->assertTrue(MemberAuthenticator::supports_cms());
        $cmsForm = MemberAuthenticator::get_cms_login_form($controller);
        $this->assertTrue($cmsForm instanceof CMSMemberLoginForm);
    }

    /**
     * Test that a member can be authenticated via their temp id
     */
    public function testAuthenticateByTempID()
    {
        $member = new Member();
        $member->Email = 'test1@test.com';
        $member->PasswordEncryption = "sha1";
        $member->Password = "mypassword";
        $member->write();

        // Make form
        $controller = new Security();
        /**
 * @skipUpgrade
*/
        $form = new Form($controller, 'Form', new FieldList(), new FieldList());

        // If the user has never logged in, then the tempid should be empty
        $tempID = $member->TempIDHash;
        $this->assertEmpty($tempID);

        // If the user logs in then they have a temp id
        $member->logIn(true);
        $tempID = $member->TempIDHash;
        $this->assertNotEmpty($tempID);

        // Test correct login
        $result = MemberAuthenticator::authenticate(
            array(
            'tempid' => $tempID,
            'Password' => 'mypassword'
            ),
            $form
        );
        $form->restoreFormState();
        $this->assertNotEmpty($result);
        $this->assertEquals($result->ID, $member->ID);
        $this->assertEmpty($form->getMessage());

        // Test incorrect login
        $form->clearMessage();
        $result = MemberAuthenticator::authenticate(
            array(
            'tempid' => $tempID,
            'Password' => 'notmypassword'
            ),
            $form
        );
        $form->restoreFormState();
        $this->assertEmpty($result);
        $this->assertEquals(
            _t('SilverStripe\\Security\\Member.ERRORWRONGCRED', 'The provided details don\'t seem to be correct. Please try again.'),
            $form->getMessage()
        );
        $this->assertEquals(ValidationResult::TYPE_ERROR, $form->getMessageType());
        $this->assertEquals(ValidationResult::CAST_TEXT, $form->getMessageCast());
    }

    /**
     * Test that the default admin can be authenticated
     */
    public function testDefaultAdmin()
    {
        // Make form
        $controller = new Security();
        /**
 * @skipUpgrade
*/
        $form = new Form($controller, 'Form', new FieldList(), new FieldList());

        // Test correct login
        $result = MemberAuthenticator::authenticate(
            array(
            'Email' => 'admin',
            'Password' => 'password'
            ),
            $form
        );
        $form->restoreFormState();
        $this->assertNotEmpty($result);
        $this->assertEquals($result->Email, Security::default_admin_username());
        $this->assertEmpty($form->getMessage());

        // Test incorrect login
        $form->clearMessage();
        $result = MemberAuthenticator::authenticate(
            array(
            'Email' => 'admin',
            'Password' => 'notmypassword'
            ),
            $form
        );
        $form->restoreFormState();
        $this->assertEmpty($result);
        $this->assertEquals(
            'The provided details don\'t seem to be correct. Please try again.',
            $form->getMessage()
        );
        $this->assertEquals(ValidationResult::TYPE_ERROR, $form->getMessageType());
        $this->assertEquals(ValidationResult::CAST_TEXT, $form->getMessageCast());
    }

    public function testDefaultAdminLockOut()
    {
        Config::inst()->update(Member::class, 'lock_out_after_incorrect_logins', 1);
        Config::inst()->update(Member::class, 'lock_out_delay_mins', 10);
        DBDatetime::set_mock_now('2016-04-18 00:00:00');
        $controller = new Security();
        /** @skipUpgrade */
        $form = new Form($controller, 'Form', new FieldList(), new FieldList());

        // Test correct login
        MemberAuthenticator::authenticate(
            [
                'Email' => 'admin',
                'Password' => 'wrongpassword'
            ],
            $form
        );

        $this->assertTrue(Member::default_admin()->isLockedOut());
        $this->assertEquals('2016-04-18 00:10:00', Member::default_admin()->LockedOutUntil);
    }
}