ilBcryptPasswordEncoderTest Class Reference

Inheritance diagram for ilBcryptPasswordEncoderTest:

Collaboration diagram for ilBcryptPasswordEncoderTest:

Public Member Functions
	getTestDirectory ()
	setTestDirectory ($test_directory)
	costsProvider ()
	testInstanceCanBeCreated ()
	testCostsCanBeRetrievedWhenCostsAreSet (ilBcryptPasswordEncoder $encoder)
	testInstanceCanBeCreated More...
	testCostsCannotBeSetAboveRange (ilBcryptPasswordEncoder $encoder)
	testInstanceCanBeCreated ilPasswordException More...
	testCostsCannotBeSetBelowRange (ilBcryptPasswordEncoder $encoder)
	testInstanceCanBeCreated ilPasswordException More...
	testCostsCanBeSetInRange ($costs, ilBcryptPasswordEncoder $encoder)
	testInstanceCanBeCreated costsProvider More...
	testPasswordShouldBeCorrectlyEncodedAndVerified (ilBcryptPasswordEncoder $encoder)
	testInstanceCanBeCreated More...
	testExceptionIsRaisedIfThePasswordExceedsTheSupportedLengthOnEncoding (ilBcryptPasswordEncoder $encoder)
	testInstanceCanBeCreated ilPasswordException More...
	testPasswordVerificationShouldFailIfTheRawPasswordExceedsTheSupportedLength (ilBcryptPasswordEncoder $encoder)
	testInstanceCanBeCreated More...
	testEncoderReliesOnSalts (ilBcryptPasswordEncoder $encoder)
	testInstanceCanBeCreated More...
	testEncoderDoesNotSupportReencoding (ilBcryptPasswordEncoder $encoder)
	testInstanceCanBeCreated More...
	testNameShouldBeBcrypt (ilBcryptPasswordEncoder $encoder)
	testInstanceCanBeCreated More...
	testExceptionIsRaisedIfSaltIsMissingIsOnEncoding ()
	ilPasswordException More...
	testExceptionIsRaisedIfSaltIsMissingIsOnVerification ()
	ilPasswordException More...
	testInstanceCanBeCreatedAndInitializedWithClientSalt ()
	testClientSaltIsGeneratedWhenNoClientSaltExistsYet ()
	testExceptionIsRaisedWhenClientSaltCouldNotBeGeneratedInCaseNoClientSaltExistsYet ()
	ilPasswordException More...
	testBackwardCompatibilityCanBeRetrievedWhenBackwardCompatibilityIsSet ()
	testBackwardCompatibility ()
	testExceptionIsRaisedIfTheRawPasswordContainsA8BitCharacterAndBackwardCompatibilityIsEnabled ()
	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

Private Member Functions
	skipIfPhpVersionIsNotSupported ()

Detailed Description

Definition at line 14 of file ilBcryptPasswordEncoderTest.php.

Member Function Documentation

costsProvider()

ilBcryptPasswordEncoderTest::costsProvider

(

)

Returns

array

Definition at line 92 of file ilBcryptPasswordEncoderTest.php.

References $data, and array.

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

getTestDirectory()

ilBcryptPasswordEncoderTest::getTestDirectory

(

)

Returns

vfs

Definition at line 49 of file ilBcryptPasswordEncoderTest.php.

References $test_directory.

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

        {
                return $this->test_directory;
        }

Here is the caller graph for this function:

setTestDirectory()

ilBcryptPasswordEncoderTest::setTestDirectory

(

$test_directory

)

Parameters

vfs\vfsStreamDirectory

$test_directory

Definition at line 57 of file ilBcryptPasswordEncoderTest.php.

References $test_directory.

Referenced by setUp().

        {
                $this->test_directory = $test_directory;
        }

Here is the caller graph for this function:

setUp()

ilBcryptPasswordEncoderTest::setUp ( )

protected

Setup.

Definition at line 65 of file ilBcryptPasswordEncoderTest.php.

References defined, and setTestDirectory().

        {
                vfs\vfsStream::setup();
                $this->setTestDirectory(vfs\vfsStream::newDirectory('tests')->at(vfs\vfsStreamWrapper::getRoot()));

                if(!defined('CLIENT_DATA_DIR'))
                {
                        define('CLIENT_DATA_DIR', vfs\vfsStream::url('root/tests'));
                }

                parent::setUp();
        }

Here is the call graph for this function:

skipIfPhpVersionIsNotSupported()

ilBcryptPasswordEncoderTest::skipIfPhpVersionIsNotSupported ( )

private

Definition at line 81 of file ilBcryptPasswordEncoderTest.php.

Referenced by testBackwardCompatibility().

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

Here is the caller graph for this function:

testBackwardCompatibility()

ilBcryptPasswordEncoderTest::testBackwardCompatibility

(

)

Definition at line 294 of file ilBcryptPasswordEncoderTest.php.

References skipIfPhpVersionIsNotSupported().

        {
                $this->skipIfPhpVersionIsNotSupported();

                $encoder = new ilBcryptPasswordEncoder();
                $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 = new ilBcryptPasswordEncoder();
                $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));
        }

Here is the call graph for this function:

testBackwardCompatibilityCanBeRetrievedWhenBackwardCompatibilityIsSet()

ilBcryptPasswordEncoderTest::testBackwardCompatibilityCanBeRetrievedWhenBackwardCompatibilityIsSet

(

)

Definition at line 282 of file ilBcryptPasswordEncoderTest.php.

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

testClientSaltIsGeneratedWhenNoClientSaltExistsYet()

ilBcryptPasswordEncoderTest::testClientSaltIsGeneratedWhenNoClientSaltExistsYet

(

)

Definition at line 260 of file ilBcryptPasswordEncoderTest.php.

References getTestDirectory().

        {
                $this->getTestDirectory()->chmod(0777);

                $encoder = new ilBcryptPasswordEncoder();
                $this->assertNotNull($encoder->getClientSalt());
        }

Here is the call graph for this function:

testCostsCanBeRetrievedWhenCostsAreSet()

ilBcryptPasswordEncoderTest::testCostsCanBeRetrievedWhenCostsAreSet

(

ilBcryptPasswordEncoder

$encoder

)

testInstanceCanBeCreated

Definition at line 130 of file ilBcryptPasswordEncoderTest.php.

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

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

Here is the call graph for this function:

testCostsCanBeSetInRange()

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

testInstanceCanBeCreated costsProvider

Definition at line 160 of file ilBcryptPasswordEncoderTest.php.

References ilBcryptPhpPasswordEncoder\setCosts().

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

Here is the call graph for this function:

testCostsCannotBeSetAboveRange()

ilBcryptPasswordEncoderTest::testCostsCannotBeSetAboveRange

(

ilBcryptPasswordEncoder

$encoder

)

testInstanceCanBeCreated ilPasswordException

Definition at line 140 of file ilBcryptPasswordEncoderTest.php.

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

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

Here is the call graph for this function:

testCostsCannotBeSetBelowRange()

ilBcryptPasswordEncoderTest::testCostsCannotBeSetBelowRange

(

ilBcryptPasswordEncoder

$encoder

)

testInstanceCanBeCreated ilPasswordException

Definition at line 150 of file ilBcryptPasswordEncoderTest.php.

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

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

Here is the call graph for this function:

testEncoderDoesNotSupportReencoding()

ilBcryptPasswordEncoderTest::testEncoderDoesNotSupportReencoding

(

ilBcryptPasswordEncoder

$encoder

)

testInstanceCanBeCreated

Definition at line 208 of file ilBcryptPasswordEncoderTest.php.

References ilBcryptPasswordEncoder\requiresReencoding().

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

Here is the call graph for this function:

testEncoderReliesOnSalts()

ilBcryptPasswordEncoderTest::testEncoderReliesOnSalts

(

ilBcryptPasswordEncoder

$encoder

)

testInstanceCanBeCreated

Definition at line 200 of file ilBcryptPasswordEncoderTest.php.

References ilBcryptPasswordEncoder\requiresSalt().

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

Here is the call graph for this function:

testExceptionIsNotRaisedIfTheRawPasswordContainsA8BitCharacterAndBackwardCompatibilityIsEnabledWithIgnoredSecurityFlaw()

ilBcryptPasswordEncoderTest::testExceptionIsNotRaisedIfTheRawPasswordContainsA8BitCharacterAndBackwardCompatibilityIsEnabledWithIgnoredSecurityFlaw

(

)

Definition at line 328 of file ilBcryptPasswordEncoderTest.php.

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

testExceptionIsRaisedIfSaltIsMissingIsOnEncoding()

ilBcryptPasswordEncoderTest::testExceptionIsRaisedIfSaltIsMissingIsOnEncoding

(

)

ilPasswordException

Definition at line 224 of file ilBcryptPasswordEncoderTest.php.

References ilPasswordBaseTest\assertException().

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

Here is the call graph for this function:

testExceptionIsRaisedIfSaltIsMissingIsOnVerification()

ilBcryptPasswordEncoderTest::testExceptionIsRaisedIfSaltIsMissingIsOnVerification

(

)

ilPasswordException

Definition at line 236 of file ilBcryptPasswordEncoderTest.php.

References ilPasswordBaseTest\assertException().

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

Here is the call graph for this function:

testExceptionIsRaisedIfThePasswordExceedsTheSupportedLengthOnEncoding()

ilBcryptPasswordEncoderTest::testExceptionIsRaisedIfThePasswordExceedsTheSupportedLengthOnEncoding

(

ilBcryptPasswordEncoder

$encoder

)

testInstanceCanBeCreated ilPasswordException

Definition at line 181 of file ilBcryptPasswordEncoderTest.php.

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

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

Here is the call graph for this function:

testExceptionIsRaisedIfTheRawPasswordContainsA8BitCharacterAndBackwardCompatibilityIsEnabled()

ilBcryptPasswordEncoderTest::testExceptionIsRaisedIfTheRawPasswordContainsA8BitCharacterAndBackwardCompatibilityIsEnabled

(

)

ilPasswordException

Definition at line 316 of file ilBcryptPasswordEncoderTest.php.

References ilPasswordBaseTest\assertException().

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

Here is the call graph for this function:

testExceptionIsRaisedWhenClientSaltCouldNotBeGeneratedInCaseNoClientSaltExistsYet()

ilBcryptPasswordEncoderTest::testExceptionIsRaisedWhenClientSaltCouldNotBeGeneratedInCaseNoClientSaltExistsYet

(

)

ilPasswordException

Definition at line 271 of file ilBcryptPasswordEncoderTest.php.

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

        {
                $this->assertException(ilPasswordException::class);
                $this->getTestDirectory()->chmod(0000);

                $encoder = new ilBcryptPasswordEncoder();
        }

Here is the call graph for this function:

testInstanceCanBeCreated()

ilBcryptPasswordEncoderTest::testInstanceCanBeCreated

(

)

Returns

ilBcryptPasswordEncoder

Definition at line 105 of file ilBcryptPasswordEncoderTest.php.

References array.

        {
                $security_flaw_ignoring_encoder = new ilBcryptPasswordEncoder(array(
                        'ignore_security_flaw' => true
                ));
                $this->assertTrue($security_flaw_ignoring_encoder->isSecurityFlawIgnored());

                $security_flaw_respecting_encoder = new ilBcryptPasswordEncoder(array(
                        'ignore_security_flaw' => false
                ));
                $this->assertFalse($security_flaw_respecting_encoder->isSecurityFlawIgnored());

                $encoder = new ilBcryptPasswordEncoder(array(
                        'cost' => self::VALID_COSTS
                ));
                $this->assertInstanceOf('ilBcryptPasswordEncoder', $encoder);
                $this->assertEquals(self::VALID_COSTS, $encoder->getCosts());
                $this->assertFalse($encoder->isSecurityFlawIgnored());
                $encoder->setClientSalt(self::CLIENT_SALT);
                return $encoder;
        }

testInstanceCanBeCreatedAndInitializedWithClientSalt()

ilBcryptPasswordEncoderTest::testInstanceCanBeCreatedAndInitializedWithClientSalt

(

)

Definition at line 248 of file ilBcryptPasswordEncoderTest.php.

References getTestDirectory(), and ilBcryptPasswordEncoder\SALT_STORAGE_FILENAME.

        {
                $this->getTestDirectory()->chmod(0777);
                vfs\vfsStream::newFile(ilBcryptPasswordEncoder::SALT_STORAGE_FILENAME)->withContent(self::CLIENT_SALT)->at($this->getTestDirectory());

                $encoder = new ilBcryptPasswordEncoder();
                $this->assertEquals(self::CLIENT_SALT, $encoder->getClientSalt());
        }

Here is the call graph for this function:

testNameShouldBeBcrypt()

ilBcryptPasswordEncoderTest::testNameShouldBeBcrypt

(

ilBcryptPasswordEncoder

$encoder

)

testInstanceCanBeCreated

Definition at line 216 of file ilBcryptPasswordEncoderTest.php.

References ilBcryptPasswordEncoder\getName().

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

Here is the call graph for this function:

testPasswordShouldBeCorrectlyEncodedAndVerified()

ilBcryptPasswordEncoderTest::testPasswordShouldBeCorrectlyEncodedAndVerified

(

ilBcryptPasswordEncoder

$encoder

)

testInstanceCanBeCreated

Definition at line 168 of file ilBcryptPasswordEncoderTest.php.

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

        {
                $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;
        }

Here is the call graph for this function:

testPasswordVerificationShouldFailIfTheRawPasswordExceedsTheSupportedLength()

ilBcryptPasswordEncoderTest::testPasswordVerificationShouldFailIfTheRawPasswordExceedsTheSupportedLength

(

ilBcryptPasswordEncoder

$encoder

)

testInstanceCanBeCreated

Definition at line 191 of file ilBcryptPasswordEncoderTest.php.

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

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

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().

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