ilBcryptPasswordEncoderTest Class Reference

Inheritance diagram for ilBcryptPasswordEncoderTest:

Collaboration diagram for ilBcryptPasswordEncoderTest:

Public Member Functions
	getTestDirectory ()
	setTestDirectory ($test_directory)
	getTestDirectoryUrl ()
	setTestDirectoryUrl ($test_directory_url)
	costsProvider ()
	testInstanceCanBeCreated ()
	testCostsCanBeRetrievedWhenCostsAreSet (ilBcryptPasswordEncoder $encoder)
	@depends testInstanceCanBeCreated More...
	testCostsCannotBeSetAboveRange (ilBcryptPasswordEncoder $encoder)
	@depends testInstanceCanBeCreated @expectedException ilPasswordException More...
	testCostsCannotBeSetBelowRange (ilBcryptPasswordEncoder $encoder)
	@depends testInstanceCanBeCreated @expectedException ilPasswordException More...
	testCostsCanBeSetInRange ($costs, ilBcryptPasswordEncoder $encoder)
	@depends testInstanceCanBeCreated @dataProvider costsProvider More...
	testPasswordShouldBeCorrectlyEncodedAndVerified (ilBcryptPasswordEncoder $encoder)
	@depends testInstanceCanBeCreated More...
	testExceptionIsRaisedIfThePasswordExceedsTheSupportedLengthOnEncoding (ilBcryptPasswordEncoder $encoder)
	@depends testInstanceCanBeCreated @expectedException ilPasswordException More...
	testPasswordVerificationShouldFailIfTheRawPasswordExceedsTheSupportedLength (ilBcryptPasswordEncoder $encoder)
	@depends testInstanceCanBeCreated More...
	testEncoderReliesOnSalts (ilBcryptPasswordEncoder $encoder)
	@depends testInstanceCanBeCreated More...
	testEncoderDoesNotSupportReencoding (ilBcryptPasswordEncoder $encoder)
	@depends testInstanceCanBeCreated More...
	testNameShouldBeBcrypt (ilBcryptPasswordEncoder $encoder)
	@depends testInstanceCanBeCreated More...
	testExceptionIsRaisedIfSaltIsMissingIsOnEncoding ()
	@expectedException ilPasswordException More...
	testExceptionIsRaisedIfSaltIsMissingIsOnVerification ()
	@expectedException ilPasswordException More...
	testInstanceCanBeCreatedAndInitializedWithClientSalt ()
	testClientSaltIsGeneratedWhenNoClientSaltExistsYet ()
	testExceptionIsRaisedWhenClientSaltCouldNotBeGeneratedInCaseNoClientSaltExistsYet ()
	@expectedException ilPasswordException More...
	testBackwardCompatibilityCanBeRetrievedWhenBackwardCompatibilityIsSet ()
	testBackwardCompatibility ()
	testExceptionIsRaisedIfTheRawPasswordContainsA8BitCharacterAndBackwardCompatibilityIsEnabled ()
	@expectedException ilPasswordException More...
	testExceptionIsNotRaisedIfTheRawPasswordContainsA8BitCharacterAndBackwardCompatibilityIsEnabledWithIgnoredSecurityFlaw ()

Data Fields
const	VALID_COSTS = '08'
const	PASSWORD = 'password'
const	WRONG_PASSWORD = 'wrong_password'
const	CLIENT_SALT = 'homer!12345_/'
const	PASSWORD_SALT = 'salt'

Protected Member Functions
	setUp ()
	Setup. More...
Protected Member Functions inherited from ilPasswordBaseTest
	assertException ($exception_class)

Protected Attributes
	$test_directory
	$test_directory_url

Private Member Functions
	skipIfPhpVersionIsNotSupported ()
	getInstanceWithConfiguredDataDirectory ()

Detailed Description

Definition at line 14 of file ilBcryptPasswordEncoderTest.php.

Member Function Documentation

costsProvider()

ilBcryptPasswordEncoderTest::costsProvider

(

)

Returns

array

Definition at line 108 of file ilBcryptPasswordEncoderTest.php.

    {
        $data = array();
        for ($i = 4; $i <= 31; $i++) {
            $data[] = array($i);
        }
        return $data;
    }

References $data, and $i.

getInstanceWithConfiguredDataDirectory()

ilBcryptPasswordEncoderTest::getInstanceWithConfiguredDataDirectory ( )

private

Returns

ilBcryptPasswordEncoder

Definition at line 120 of file ilBcryptPasswordEncoderTest.php.

    {
        $encoder = new ilBcryptPasswordEncoder(array(
            'data_directory' => $this->getTestDirectoryUrl()
        ));
 
        return $encoder;
    }

References getTestDirectoryUrl().

Referenced by testBackwardCompatibility(), testBackwardCompatibilityCanBeRetrievedWhenBackwardCompatibilityIsSet(), testClientSaltIsGeneratedWhenNoClientSaltExistsYet(), testExceptionIsNotRaisedIfTheRawPasswordContainsA8BitCharacterAndBackwardCompatibilityIsEnabledWithIgnoredSecurityFlaw(), testExceptionIsRaisedIfSaltIsMissingIsOnEncoding(), testExceptionIsRaisedIfSaltIsMissingIsOnVerification(), testExceptionIsRaisedIfTheRawPasswordContainsA8BitCharacterAndBackwardCompatibilityIsEnabled(), testExceptionIsRaisedWhenClientSaltCouldNotBeGeneratedInCaseNoClientSaltExistsYet(), and testInstanceCanBeCreatedAndInitializedWithClientSalt().

Here is the call graph for this function:

Here is the caller graph for this function:

getTestDirectory()

ilBcryptPasswordEncoderTest::getTestDirectory

(

)

Returns

vfs\vfsStreamDirectory

Definition at line 54 of file ilBcryptPasswordEncoderTest.php.

    {
        return $this->test_directory;
    }

References $test_directory.

Referenced by testClientSaltIsGeneratedWhenNoClientSaltExistsYet(), testExceptionIsRaisedWhenClientSaltCouldNotBeGeneratedInCaseNoClientSaltExistsYet(), and testInstanceCanBeCreatedAndInitializedWithClientSalt().

Here is the caller graph for this function:

getTestDirectoryUrl()

ilBcryptPasswordEncoderTest::getTestDirectoryUrl

(

)

Returns

string

Definition at line 70 of file ilBcryptPasswordEncoderTest.php.

    {
        return $this->test_directory_url;
    }

References $test_directory_url.

Referenced by getInstanceWithConfiguredDataDirectory(), and testInstanceCanBeCreated().

Here is the caller graph for this function:

setTestDirectory()

ilBcryptPasswordEncoderTest::setTestDirectory

(

$test_directory

)

Parameters

vfs\vfsStreamDirectory

$test_directory

Definition at line 62 of file ilBcryptPasswordEncoderTest.php.

    {
        $this->test_directory = $test_directory;
    }

References $test_directory.

Referenced by setUp().

Here is the caller graph for this function:

setTestDirectoryUrl()

ilBcryptPasswordEncoderTest::setTestDirectoryUrl

(

$test_directory_url

)

Parameters

string

$test_directory_url

Definition at line 78 of file ilBcryptPasswordEncoderTest.php.

    {
        $this->test_directory_url = $test_directory_url;
    }

References $test_directory_url.

Referenced by setUp().

Here is the caller graph for this function:

setUp()

ilBcryptPasswordEncoderTest::setUp ( )

protected

Setup.

Definition at line 86 of file ilBcryptPasswordEncoderTest.php.

    {
        vfs\vfsStream::setup();
        $this->setTestDirectory(vfs\vfsStream::newDirectory('tests')->at(vfs\vfsStreamWrapper::getRoot()));
        $this->setTestDirectoryUrl(vfs\vfsStream::url('root/tests'));
 
        parent::setUp();
    }

References setTestDirectory(), and setTestDirectoryUrl().

Here is the call graph for this function:

skipIfPhpVersionIsNotSupported()

ilBcryptPasswordEncoderTest::skipIfPhpVersionIsNotSupported ( )

private

Definition at line 98 of file ilBcryptPasswordEncoderTest.php.

    {
        if (version_compare(phpversion(), '5.3.7', '<')) {
            $this->markTestSkipped('Requires PHP >= 5.3.7');
        }
    }

Referenced by testBackwardCompatibility().

Here is the caller graph for this function:

testBackwardCompatibility()

ilBcryptPasswordEncoderTest::testBackwardCompatibility

(

)

Definition at line 325 of file ilBcryptPasswordEncoderTest.php.

    {
        $this->skipIfPhpVersionIsNotSupported();
 
        $encoder = $this->getInstanceWithConfiguredDataDirectory();
        $encoder->setClientSalt(self::CLIENT_SALT);
        $encoder->setBackwardCompatibility(true);
        $encoded_password = $encoder->encodePassword(self::PASSWORD, self::PASSWORD_SALT);
        $this->assertTrue($encoder->isPasswordValid($encoded_password, self::PASSWORD, self::PASSWORD_SALT));
        $this->assertEquals('$2a$', substr($encoded_password, 0, 4));
 
        $another_encoder = $this->getInstanceWithConfiguredDataDirectory();
        $another_encoder->setClientSalt(self::CLIENT_SALT);
        $another_encoder->setBackwardCompatibility(false);
        $another_encoded_password = $another_encoder->encodePassword(self::PASSWORD, self::PASSWORD_SALT);
        $this->assertEquals('$2y$', substr($another_encoded_password, 0, 4));
        $this->assertTrue($another_encoder->isPasswordValid($encoded_password, self::PASSWORD, self::PASSWORD_SALT));
    }

References getInstanceWithConfiguredDataDirectory(), and skipIfPhpVersionIsNotSupported().

Here is the call graph for this function:

testBackwardCompatibilityCanBeRetrievedWhenBackwardCompatibilityIsSet()

ilBcryptPasswordEncoderTest::testBackwardCompatibilityCanBeRetrievedWhenBackwardCompatibilityIsSet

(

)

Definition at line 313 of file ilBcryptPasswordEncoderTest.php.

    {
        $encoder = $this->getInstanceWithConfiguredDataDirectory();
        $encoder->setBackwardCompatibility(true);
        $this->assertTrue($encoder->isBackwardCompatibilityEnabled());
        $encoder->setBackwardCompatibility(false);
        $this->assertFalse($encoder->isBackwardCompatibilityEnabled());
    }

References getInstanceWithConfiguredDataDirectory().

Here is the call graph for this function:

testClientSaltIsGeneratedWhenNoClientSaltExistsYet()

ilBcryptPasswordEncoderTest::testClientSaltIsGeneratedWhenNoClientSaltExistsYet

(

)

Definition at line 291 of file ilBcryptPasswordEncoderTest.php.

    {
        $this->getTestDirectory()->chmod(0777);
 
        $encoder = $this->getInstanceWithConfiguredDataDirectory();
        $this->assertNotNull($encoder->getClientSalt());
    }

References getInstanceWithConfiguredDataDirectory(), and getTestDirectory().

Here is the call graph for this function:

testCostsCanBeRetrievedWhenCostsAreSet()

ilBcryptPasswordEncoderTest::testCostsCanBeRetrievedWhenCostsAreSet

(

ilBcryptPasswordEncoder

$encoder

)

@depends testInstanceCanBeCreated

Definition at line 161 of file ilBcryptPasswordEncoderTest.php.

    {
        $encoder->setCosts(4);
        $this->assertEquals(4, $encoder->getCosts());
    }

References ilBcryptPhpPasswordEncoder\getCosts(), and ilBcryptPhpPasswordEncoder\setCosts().

Here is the call graph for this function:

testCostsCanBeSetInRange()

ilBcryptPasswordEncoderTest::testCostsCanBeSetInRange	(		$costs,
		ilBcryptPasswordEncoder	$encoder
	)

@depends testInstanceCanBeCreated @dataProvider costsProvider

Definition at line 191 of file ilBcryptPasswordEncoderTest.php.

    {
        $encoder->setCosts($costs);
    }

References ilBcryptPhpPasswordEncoder\setCosts().

Here is the call graph for this function:

testCostsCannotBeSetAboveRange()

ilBcryptPasswordEncoderTest::testCostsCannotBeSetAboveRange

(

ilBcryptPasswordEncoder

$encoder

)

@depends testInstanceCanBeCreated @expectedException ilPasswordException

Definition at line 171 of file ilBcryptPasswordEncoderTest.php.

    {
        $this->assertException(ilPasswordException::class);
        $encoder->setCosts(32);
    }

References ilPasswordBaseTest\assertException(), and ilBcryptPhpPasswordEncoder\setCosts().

Here is the call graph for this function:

testCostsCannotBeSetBelowRange()

ilBcryptPasswordEncoderTest::testCostsCannotBeSetBelowRange

(

ilBcryptPasswordEncoder

$encoder

)

@depends testInstanceCanBeCreated @expectedException ilPasswordException

Definition at line 181 of file ilBcryptPasswordEncoderTest.php.

    {
        $this->assertException(ilPasswordException::class);
        $encoder->setCosts(3);
    }

References ilPasswordBaseTest\assertException(), and ilBcryptPhpPasswordEncoder\setCosts().

Here is the call graph for this function:

testEncoderDoesNotSupportReencoding()

ilBcryptPasswordEncoderTest::testEncoderDoesNotSupportReencoding

(

ilBcryptPasswordEncoder

$encoder

)

@depends testInstanceCanBeCreated

Definition at line 239 of file ilBcryptPasswordEncoderTest.php.

    {
        $this->assertFalse($encoder->requiresReencoding('hello'));
    }

References ilBcryptPasswordEncoder\requiresReencoding().

Here is the call graph for this function:

testEncoderReliesOnSalts()

ilBcryptPasswordEncoderTest::testEncoderReliesOnSalts

(

ilBcryptPasswordEncoder

$encoder

)

@depends testInstanceCanBeCreated

Definition at line 231 of file ilBcryptPasswordEncoderTest.php.

    {
        $this->assertTrue($encoder->requiresSalt());
    }

References ilBcryptPasswordEncoder\requiresSalt().

Here is the call graph for this function:

testExceptionIsNotRaisedIfTheRawPasswordContainsA8BitCharacterAndBackwardCompatibilityIsEnabledWithIgnoredSecurityFlaw()

ilBcryptPasswordEncoderTest::testExceptionIsNotRaisedIfTheRawPasswordContainsA8BitCharacterAndBackwardCompatibilityIsEnabledWithIgnoredSecurityFlaw

(

)

Definition at line 359 of file ilBcryptPasswordEncoderTest.php.

    {
        $encoder = $this->getInstanceWithConfiguredDataDirectory();
        $encoder->setClientSalt(self::CLIENT_SALT);
        $encoder->setBackwardCompatibility(true);
        $encoder->setIsSecurityFlawIgnored(true);
        $encoder->encodePassword(self::PASSWORD . chr(195), self::PASSWORD_SALT);
    }

References getInstanceWithConfiguredDataDirectory().

Here is the call graph for this function:

testExceptionIsRaisedIfSaltIsMissingIsOnEncoding()

ilBcryptPasswordEncoderTest::testExceptionIsRaisedIfSaltIsMissingIsOnEncoding

(

)

@expectedException ilPasswordException

Definition at line 255 of file ilBcryptPasswordEncoderTest.php.

    {
        $this->assertException(ilPasswordException::class);
        $encoder = $this->getInstanceWithConfiguredDataDirectory();
        $encoder->setClientSalt(null);
        $encoder->setCosts(self::VALID_COSTS);
        $encoder->encodePassword(self::PASSWORD, self::PASSWORD_SALT);
    }

References ilPasswordBaseTest\assertException(), and getInstanceWithConfiguredDataDirectory().

Here is the call graph for this function:

testExceptionIsRaisedIfSaltIsMissingIsOnVerification()

ilBcryptPasswordEncoderTest::testExceptionIsRaisedIfSaltIsMissingIsOnVerification

(

)

@expectedException ilPasswordException

Definition at line 267 of file ilBcryptPasswordEncoderTest.php.

    {
        $this->assertException(ilPasswordException::class);
        $encoder = $this->getInstanceWithConfiguredDataDirectory();
        $encoder->setClientSalt(null);
        $encoder->setCosts(self::VALID_COSTS);
        $encoder->isPasswordValid('12121212', self::PASSWORD, self::PASSWORD_SALT);
    }

References ilPasswordBaseTest\assertException(), and getInstanceWithConfiguredDataDirectory().

Here is the call graph for this function:

testExceptionIsRaisedIfThePasswordExceedsTheSupportedLengthOnEncoding()

ilBcryptPasswordEncoderTest::testExceptionIsRaisedIfThePasswordExceedsTheSupportedLengthOnEncoding

(

ilBcryptPasswordEncoder

$encoder

)

@depends testInstanceCanBeCreated @expectedException ilPasswordException

Definition at line 212 of file ilBcryptPasswordEncoderTest.php.

    {
        $this->assertException(ilPasswordException::class);
        $encoder->setCosts(self::VALID_COSTS);
        $encoder->encodePassword(str_repeat('a', 5000), self::PASSWORD_SALT);
    }

References ilPasswordBaseTest\assertException(), ilBcryptPasswordEncoder\encodePassword(), and ilBcryptPhpPasswordEncoder\setCosts().

Here is the call graph for this function:

testExceptionIsRaisedIfTheRawPasswordContainsA8BitCharacterAndBackwardCompatibilityIsEnabled()

ilBcryptPasswordEncoderTest::testExceptionIsRaisedIfTheRawPasswordContainsA8BitCharacterAndBackwardCompatibilityIsEnabled

(

)

@expectedException ilPasswordException

Definition at line 347 of file ilBcryptPasswordEncoderTest.php.

    {
        $this->assertException(ilPasswordException::class);
        $encoder = $this->getInstanceWithConfiguredDataDirectory();
        $encoder->setClientSalt(self::CLIENT_SALT);
        $encoder->setBackwardCompatibility(true);
        $encoder->encodePassword(self::PASSWORD . chr(195), self::PASSWORD_SALT);
    }

References ilPasswordBaseTest\assertException(), and getInstanceWithConfiguredDataDirectory().

Here is the call graph for this function:

testExceptionIsRaisedWhenClientSaltCouldNotBeGeneratedInCaseNoClientSaltExistsYet()

ilBcryptPasswordEncoderTest::testExceptionIsRaisedWhenClientSaltCouldNotBeGeneratedInCaseNoClientSaltExistsYet

(

)

@expectedException ilPasswordException

Definition at line 302 of file ilBcryptPasswordEncoderTest.php.

    {
        $this->assertException(ilPasswordException::class);
        $this->getTestDirectory()->chmod(0000);
 
        $encoder = $this->getInstanceWithConfiguredDataDirectory();
    }

References ilPasswordBaseTest\assertException(), getInstanceWithConfiguredDataDirectory(), and getTestDirectory().

Here is the call graph for this function:

testInstanceCanBeCreated()

ilBcryptPasswordEncoderTest::testInstanceCanBeCreated

(

)

Returns

ilBcryptPasswordEncoder

Definition at line 132 of file ilBcryptPasswordEncoderTest.php.

    {
        $security_flaw_ignoring_encoder = new ilBcryptPasswordEncoder(array(
            'ignore_security_flaw' => true,
            'data_directory'       => $this->getTestDirectoryUrl()
        ));
        $this->assertTrue($security_flaw_ignoring_encoder->isSecurityFlawIgnored());
 
        $security_flaw_respecting_encoder = new ilBcryptPasswordEncoder(array(
            'ignore_security_flaw' => false,
            'data_directory'       => $this->getTestDirectoryUrl()
        ));
        $this->assertFalse($security_flaw_respecting_encoder->isSecurityFlawIgnored());
 
        $encoder = new ilBcryptPasswordEncoder(array(
            'cost'           => self::VALID_COSTS,
            'data_directory' => $this->getTestDirectoryUrl()
        ));
        $this->assertInstanceOf('ilBcryptPasswordEncoder', $encoder);
        $this->assertEquals(self::VALID_COSTS, $encoder->getCosts());
        $this->assertFalse($encoder->isSecurityFlawIgnored());
        $encoder->setClientSalt(self::CLIENT_SALT);
 
        return $encoder;
    }

References getTestDirectoryUrl().

Here is the call graph for this function:

testInstanceCanBeCreatedAndInitializedWithClientSalt()

ilBcryptPasswordEncoderTest::testInstanceCanBeCreatedAndInitializedWithClientSalt

(

)

Definition at line 279 of file ilBcryptPasswordEncoderTest.php.

    {
        $this->getTestDirectory()->chmod(0777);
        vfs\vfsStream::newFile(ilBcryptPasswordEncoder::SALT_STORAGE_FILENAME)->withContent(self::CLIENT_SALT)->at($this->getTestDirectory());
 
        $encoder = $this->getInstanceWithConfiguredDataDirectory();
        $this->assertEquals(self::CLIENT_SALT, $encoder->getClientSalt());
    }

References getInstanceWithConfiguredDataDirectory(), getTestDirectory(), and ilBcryptPasswordEncoder\SALT_STORAGE_FILENAME.

Here is the call graph for this function:

testNameShouldBeBcrypt()

ilBcryptPasswordEncoderTest::testNameShouldBeBcrypt

(

ilBcryptPasswordEncoder

$encoder

)

@depends testInstanceCanBeCreated

Definition at line 247 of file ilBcryptPasswordEncoderTest.php.

    {
        $this->assertEquals('bcrypt', $encoder->getName());
    }

References ilBcryptPasswordEncoder\getName().

Here is the call graph for this function:

testPasswordShouldBeCorrectlyEncodedAndVerified()

ilBcryptPasswordEncoderTest::testPasswordShouldBeCorrectlyEncodedAndVerified

(

ilBcryptPasswordEncoder

$encoder

)

@depends testInstanceCanBeCreated

Definition at line 199 of file ilBcryptPasswordEncoderTest.php.

    {
        $encoder->setCosts(self::VALID_COSTS);
        $encoded_password = $encoder->encodePassword(self::PASSWORD, self::PASSWORD_SALT);
        $this->assertTrue($encoder->isPasswordValid($encoded_password, self::PASSWORD, self::PASSWORD_SALT));
        $this->assertFalse($encoder->isPasswordValid($encoded_password, self::WRONG_PASSWORD, self::PASSWORD_SALT));
        return $encoder;
    }

References ilBcryptPasswordEncoder\encodePassword(), ilBcryptPasswordEncoder\isPasswordValid(), and ilBcryptPhpPasswordEncoder\setCosts().

Here is the call graph for this function:

testPasswordVerificationShouldFailIfTheRawPasswordExceedsTheSupportedLength()

ilBcryptPasswordEncoderTest::testPasswordVerificationShouldFailIfTheRawPasswordExceedsTheSupportedLength

(

ilBcryptPasswordEncoder

$encoder

)

@depends testInstanceCanBeCreated

Definition at line 222 of file ilBcryptPasswordEncoderTest.php.

    {
        $encoder->setCosts(self::VALID_COSTS);
        $this->assertFalse($encoder->isPasswordValid('encoded', str_repeat('a', 5000), self::PASSWORD_SALT));
    }

References ilBcryptPasswordEncoder\isPasswordValid(), and ilBcryptPhpPasswordEncoder\setCosts().

Here is the call graph for this function:

Field Documentation

$test_directory

ilBcryptPasswordEncoderTest::$test_directory

protected

Definition at line 44 of file ilBcryptPasswordEncoderTest.php.

Referenced by getTestDirectory(), and setTestDirectory().

$test_directory_url

ilBcryptPasswordEncoderTest::$test_directory_url

protected

Definition at line 49 of file ilBcryptPasswordEncoderTest.php.

Referenced by getTestDirectoryUrl(), and setTestDirectoryUrl().

CLIENT_SALT

const ilBcryptPasswordEncoderTest::CLIENT_SALT = 'homer!12345_/'

Definition at line 34 of file ilBcryptPasswordEncoderTest.php.

PASSWORD

const ilBcryptPasswordEncoderTest::PASSWORD = 'password'

Definition at line 24 of file ilBcryptPasswordEncoderTest.php.

PASSWORD_SALT

const ilBcryptPasswordEncoderTest::PASSWORD_SALT = 'salt'

Definition at line 39 of file ilBcryptPasswordEncoderTest.php.

VALID_COSTS

const ilBcryptPasswordEncoderTest::VALID_COSTS = '08'

Definition at line 19 of file ilBcryptPasswordEncoderTest.php.

WRONG_PASSWORD

const ilBcryptPasswordEncoderTest::WRONG_PASSWORD = 'wrong_password'

Definition at line 29 of file ilBcryptPasswordEncoderTest.php.

---

The documentation for this class was generated from the following file:

• Services/Password/test/encoders/ilBcryptPasswordEncoderTest.php