Files
iTop/tests/php-unit-tests/unitary-tests/datamodels/2.x/authent-local/UserLocalTest.php
Benjamin DALSASS 0703469465 N°8933 - Change password default length
- adjust unitary test
2026-02-18 09:38:57 +01:00

452 lines
14 KiB
PHP

<?php
/**
* Created by Bruno DA SILVA, working for Combodo
* Date: 21/11/2019
* Time: 09:14
*/
namespace Combodo\iTop\Test\UnitTest\Module\AuthentLocal;
use AttributeDate;
use Combodo\iTop\Test\UnitTest\ItopDataTestCase;
use Config;
use DBObjectSearch;
use DBObjectSet;
use Dict;
use MetaModel;
use ormLinkSet;
use URP_UserProfile;
use User;
use UserLocal;
use UserRights;
use utils;
/**
* test class for UserLocal class
*/
class UserLocalTest extends ItopDataTestCase
{
public function setUp(): void
{
parent::setUp();
$this->RequireOnceUnitTestFile('./UserLocalTest/UserLocalPasswordPolicyMock.php');
$this->RequireOnceItopFile('env-production/authent-local/model.authent-local.php');
}
/**
* @dataProvider ProviderValidatePassword
*/
public function testValidatePassword($sPassword, $aValidatorNames, $aConfigValueMap, $bExpectedCheckStatus, $expectedCheckIssues = null, $sUserLanguage = null)
{
$configMock = $this->createMock(Config::class);
$configMock
->method('GetModuleSetting')
->willReturnMap($aConfigValueMap);
restore_error_handler();
if (isset($sUserLanguage)) {
Dict::SetUserLanguage($sUserLanguage);
}
/** @var UserLocal $oUserLocal */
$oUserLocal = MetaModel::NewObject(UserLocal::class, ['login' => 'john']);
/** @var ormLinkSet $oProfileSet */
$oProfileSet = $oUserLocal->Get('profile_list');
$oProfileSet->AddItem(
MetaModel::NewObject(URP_UserProfile::class, ['profileid' => 1])
);
$aValidatorCollection = [];
foreach ($aValidatorNames as $class) {
$aValidatorCollection[] = new $class();
}
$oUserLocal->ValidatePassword($sPassword, $configMock, $aValidatorCollection);
list($bCheckStatus, $aCheckIssues, $aSecurityIssues) = $oUserLocal->CheckToWrite();
$this->assertSame($bExpectedCheckStatus, $bCheckStatus);
if (isset($expectedCheckIssues)) {
$this->assertContains($expectedCheckIssues, $aCheckIssues);
}
}
public function ProviderValidatePassword()
{
return [
'validPattern' => [
'password' => 'foo',
'aValidatorCollection' => [
'UserPasswordPolicyRegex',
],
'valueMap' => [
['authent-local', 'password_validation.pattern', null, '.{1,10}'],
],
'expectedCheckStatus' => true,
],
'notValidPattern' => [
'password' => 'foo',
'aValidatorCollection' => [
'UserPasswordPolicyRegex',
],
'valueMap' => [
['authent-local', 'password_validation.pattern', null, '.{6,10}'],
],
'expectedCheckStatus' => false,
],
'noPattern' => [
'password' => 'foo',
'aValidatorCollection' => [
'UserPasswordPolicyRegex',
],
'valueMap' => [
['authent-local', 'password_validation.pattern', null, ''],
],
'expectedCheckStatus' => true,
],
'validClass' => [
'password' => 'foo',
'aValidatorCollection' => [
'UserLocalPasswordPolicyMockValid',
],
'valueMap' => [],
'expectedCheckStatus' => true,
],
'notValidClass' => [
'password' => 'foo',
'aValidatorCollection' => [
'UserLocalPasswordPolicyMockNotValid',
],
'valueMap' => [],
'expectedCheckStatus' => false,
],
'validation_composition_10' => [
'password' => 'foo',
'aValidatorCollection' => [
'UserLocalPasswordPolicyMockValid',
'UserLocalPasswordPolicyMockNotValid',
],
'valueMap' => [],
'expectedCheckStatus' => false,
'expectedCheckIssues' => 'UserLocalPasswordPolicyMockNotValid',
],
'validation_composition_01' => [
'password' => 'foo',
'aValidatorCollection' => [
'UserLocalPasswordPolicyMockNotValid',
'UserLocalPasswordPolicyMockValid',
],
'valueMap' => [],
'expectedCheckStatus' => false,
'expectedCheckIssues' => 'UserLocalPasswordPolicyMockNotValid',
],
'validation_composition_11' => [
'password' => 'foo',
'aValidatorCollection' => [
'UserLocalPasswordPolicyMockValid',
'UserLocalPasswordPolicyMockValidBis',
],
'valueMap' => [],
'expectedCheckStatus' => true,
],
'validation_composition_00' => [
'password' => 'foo',
'aValidatorCollection' => [
'UserLocalPasswordPolicyMockNotValid',
'UserLocalPasswordPolicyMockNotValidBis',
],
'valueMap' => [],
'expectedCheckStatus' => false,
'expectedCheckIssues' => 'UserLocalPasswordPolicyMockNotValid',
],
'notValidPattern custom message FR' => [
'password' => 'foo',
'aValidatorCollection' => [
'UserPasswordPolicyRegex',
],
'valueMap' => [
['authent-local', 'password_validation.pattern', null, '.{6,10}'],
['authent-local', 'password_validation.message', null, ['FR FR' => 'fr message', 'EN US' => 'en message']],
],
'expectedCheckStatus' => false,
'expectedCheckIssues' => 'fr message',
'userLanguage' => 'FR FR',
],
'notValidPattern custom message EN' => [
'password' => 'foo',
'aValidatorCollection' => [
'UserPasswordPolicyRegex',
],
'valueMap' => [
['authent-local', 'password_validation.pattern', null, '.{6,10}'],
['authent-local', 'password_validation.message', null, ['FR FR' => 'fr message', 'EN US' => 'en message']],
],
'expectedCheckStatus' => false,
'expectedCheckIssues' => 'en message',
'userLanguage' => 'EN US',
],
'notValidPattern custom message Fallback' => [
'password' => 'foo',
'aValidatorCollection' => [
'UserPasswordPolicyRegex',
],
'valueMap' => [
['authent-local', 'password_validation.pattern', null, '.{6,10}'],
['authent-local', 'password_validation.message', null, ['EN US' => 'en message']],
],
'expectedCheckStatus' => false,
'expectedCheckIssues' => 'en message',
'userLanguage' => 'FR FR',
],
'notValidPattern custom message empty array' => [
'password' => 'foo',
'aValidatorCollection' => [
'UserPasswordPolicyRegex',
],
'valueMap' => [
['authent-local', 'password_validation.pattern', null, '.{6,10}'],
['authent-local', 'password_validation.message', null, []],
],
'expectedCheckStatus' => false,
'expectedCheckIssues' => 'Password must be at least 12 characters and include uppercase, lowercase, numeric and special characters.',
'userLanguage' => 'EN US',
],
'notValidPattern custom message string not array' => [
'password' => 'foo',
'aValidatorCollection' => [
'UserPasswordPolicyRegex',
],
'valueMap' => [
['authent-local', 'password_validation.pattern', null, '.{6,10}'],
['authent-local', 'password_validation.message', null, 'not an array'],
],
'expectedCheckStatus' => false,
'expectedCheckIssues' => 'not an array',
'userLanguage' => 'EN US',
],
];
}
/**
* @dataProvider ProviderPasswordRenewal
*
*/
public function testPasswordRenewal($sBefore, $sExpectedAfter)
{
$sDateFormat = AttributeDate::GetInternalFormat();
$oBefore = is_null($sBefore) ? null : date($sDateFormat, strtotime($sBefore));
$oNow = date($sDateFormat);
$oExpectedAfter = is_null($sExpectedAfter) ? null : date($sDateFormat, strtotime($sExpectedAfter));
$aUserLocalValues = ['login' => 'john'];
if (!is_null($oBefore)) {
$aUserLocalValues['password_renewed_date'] = $oBefore;
}
/** @var UserLocal $oUserLocal */
$oUserLocal = MetaModel::NewObject(UserLocal::class, $aUserLocalValues);
/** @var ormLinkSet $oProfileSet */
$oProfileSet = $oUserLocal->Get('profile_list');
$oProfileSet->AddItem(
MetaModel::NewObject(URP_UserProfile::class, ['profileid' => 1])
);
$this->assertEquals($oBefore, $oUserLocal->Get('password_renewed_date'));
//INSERT
$oUserLocal->Set('password', 'fooBar1???');
$oUserLocal->DBWrite();
$this->assertEquals($oNow, $oUserLocal->Get('password_renewed_date'), 'INSERT sets the "password_renewed_date" to the current date');
//UPDATE password_renewed_date
$oUserLocal = MetaModel::GetObject(UserLocal::class, $oUserLocal->GetKey());
$oUserLocal->Set('password_renewed_date', $oBefore);
$oUserLocal->DBWrite();
$this->assertEquals($oBefore, $oUserLocal->Get('password_renewed_date'), 'UPDATE can target and change the "password_renewed_date"');
//UPDATE password
$oUserLocal = MetaModel::GetObject(UserLocal::class, $oUserLocal->GetKey());
$oUserLocal->Set('password', 'fooBar1???1');
$oUserLocal->DBWrite();
$this->assertEquals($oExpectedAfter, $oUserLocal->Get('password_renewed_date'), 'UPDATE "password" fields trigger automatic change of the "password_renewed_date" field');
//UPDATE both password & password_renewed_date
$oUserLocal = MetaModel::GetObject(UserLocal::class, $oUserLocal->GetKey());
$oUserLocal->Set('password', 'fooBar1???2');
$oUserLocal->Set('password_renewed_date', $oBefore);
$oUserLocal->DBWrite();
$this->assertEquals($oBefore, $oUserLocal->Get('password_renewed_date'), 'UPDATE can target and change both "password" and "password_renewed_date"');
}
public function ProviderPasswordRenewal()
{
return [
'nominal case' => [
'oExpectedBefore' => null,
'oExpectedAfter' => 'now',
],
'date initiated' => [
'oBefore' => '-1 day',
'oExpectedAfter' => 'now',
],
'date initiated in the future' => [
'oBefore' => '+1 day',
'oExpectedAfter' => 'now',
],
];
}
/**
* @dataProvider CanExpireFixProvider
*
*/
public function testCanExpireFix($sExpirationMode, $sBefore, bool $bRenewedDateTouched)
{
$oBefore = is_null($sBefore) ? null : date(AttributeDate::GetInternalFormat(), strtotime($sBefore));
$oNow = date(AttributeDate::GetInternalFormat());
$oExpectedAfter = $bRenewedDateTouched ? $oNow : $oBefore;
$aUserLocalValues = ['login' => 'john'];
if (!is_null($oBefore)) {
$aUserLocalValues['password_renewed_date'] = $oBefore;
}
/** @var UserLocal $oUserLocal */
$oUserLocal = MetaModel::NewObject(UserLocal::class, $aUserLocalValues);
/** @var ormLinkSet $oProfileSet */
$oProfileSet = $oUserLocal->Get('profile_list');
$oProfileSet->AddItem(
MetaModel::NewObject(URP_UserProfile::class, ['profileid' => 1])
);
$this->assertEquals($oBefore, $oUserLocal->Get('password_renewed_date'));
//INSERT
$oUserLocal->Set('password', 'fooBar1???');
$oUserLocal->DBWrite();
$this->assertEquals($oNow, $oUserLocal->Get('password_renewed_date'), 'INSERT sets the "password_renewed_date" to the current date');
$oUserLocal = MetaModel::GetObject(UserLocal::class, $oUserLocal->GetKey());
$oUserLocal->Set('password_renewed_date', $oBefore);
$oUserLocal->DBWrite();
$this->assertEquals($oBefore, $oUserLocal->Get('password_renewed_date'), 'UPDATE can target and change the "password_renewed_date"');
//UPDATE password
$oUserLocal = MetaModel::GetObject(UserLocal::class, $oUserLocal->GetKey());
$oUserLocal->Set('expiration', $sExpirationMode);
$oUserLocal->DBWrite();
$this->assertEquals($oExpectedAfter, $oUserLocal->Get('password_renewed_date'), 'UPDATE "password" fields trigger automatic change of the "password_renewed_date" field');
}
public function CanExpireFixProvider()
{
return [
'EXPIRE_CAN: nominal case' => [
'sExpirationMode' => 'can_expire',
'oExpectedBefore' => null,
'bRenewedDateTouched' => true,
],
'EXPIRE_NEVER (default mode): nothing changed on UserLocal' => [
'sExpirationMode' => 'never_expire',
'oExpectedBefore' => null,
'bRenewedDateTouched' => false,
],
'EXPIRE_FORCE: nominal case' => [
'sExpirationMode' => 'force_expire',
'oExpectedBefore' => null,
'bRenewedDateTouched' => true,
],
'EXPIRE_ONE_TIME_PWD: nominal case' => [
'sExpirationMode' => 'otp_expire',
'oExpectedBefore' => null,
'bRenewedDateTouched' => true,
],
'date initiated' => [
'sExpirationMode' => 'can_expire',
'oBefore' => '-1 day',
'bRenewedDateTouched' => false,
],
'date initiated in the future' => [
'sExpirationMode' => 'can_expire',
'oBefore' => '+1 day',
'bRenewedDateTouched' => false,
],
];
}
/**
* @runInSeparateProcess Otherwise, and only in the CI, test fails asserting $oProfilesSet->Count() == 0
*/
public function testGetUserProfileList()
{
utils::GetConfig()->SetModuleSetting('authent-local', 'password_validation.pattern', '');
$sAdminLogin = 'admin';
$oExistingAdminUser = MetaModel::GetObjectByColumn(User::class, 'login', $sAdminLogin, false);
if (\is_null($oExistingAdminUser)) {
$sAdministratorProfileId = 1;
$this->CreateContactlessUser($sAdminLogin, $sAdministratorProfileId);
}
// By default should see all profiles
$oProfilesSet = $this->GetAdminUserProfileList();
$this->assertIsObject($oProfilesSet);
$this->assertInstanceOf(ormLinkSet::class, $oProfilesSet);
$this->assertGreaterThan(0, $oProfilesSet->Count());
// non admin user : seeing profiles depends on the security.hide_administrators config param value
$sSupportAgentProfileId = 5;
$sSupportAgentLogin = 'support_agent';
$this->CreateContactlessUser($sSupportAgentLogin, $sSupportAgentProfileId);
UserRights::Login($sSupportAgentLogin);
MetaModel::GetConfig()->Set('security.hide_administrators', true);
$oProfilesSet = $this->GetAdminUserProfileList();
$this->assertIsObject($oProfilesSet);
$this->assertInstanceOf(ormLinkSet::class, $oProfilesSet);
$this->assertEquals(0, $oProfilesSet->Count());
MetaModel::GetConfig()->Set('security.hide_administrators', false);
$oProfilesSet = $this->GetAdminUserProfileList();
$this->assertIsObject($oProfilesSet);
$this->assertInstanceOf(ormLinkSet::class, $oProfilesSet);
$this->assertGreaterThan(0, $oProfilesSet->Count());
// admin user : will always see profiles whatever the security.hide_administrators config param value is
UserRights::Login($sAdminLogin);
MetaModel::GetConfig()->Set('security.hide_administrators', true);
$oProfilesSet = $this->GetAdminUserProfileList();
$this->assertIsObject($oProfilesSet);
$this->assertInstanceOf(ormLinkSet::class, $oProfilesSet);
$this->assertGreaterThan(0, $oProfilesSet->Count());
MetaModel::GetConfig()->Set('security.hide_administrators', false);
$oProfilesSet = $this->GetAdminUserProfileList();
$this->assertIsObject($oProfilesSet);
$this->assertInstanceOf(ormLinkSet::class, $oProfilesSet);
$this->assertGreaterThan(0, $oProfilesSet->Count());
}
private function GetAdminUserProfileList(): ormLinkSet
{
$oSearch = new DBObjectSearch(UserLocal::class);
$oSearch->AllowAllData();
$oSearch->AddCondition('login', 'admin', '=');
$oObjectSet = new DBObjectSet($oSearch);
/** @noinspection OneTimeUseVariablesInspection */
$oUser = $oObjectSet->Fetch();
return $oUser->Get('profile_list');
}
}