ilSecuritySettings Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilSecuritySettings:

Public Member Functions
	setPasswordCharsAndNumbersEnabled (bool $a_chars_and_numbers_enabled)
	set if the passwords have to contain characters and numbers More...
	isPasswordCharsAndNumbersEnabled ()
	get boolean if the passwords have to contain characters and numbers More...
	setPasswordSpecialCharsEnabled (bool $a_password_special_chars_enabled)
	set if the passwords have to contain special characters More...
	isPasswordSpecialCharsEnabled ()
	get boolean if the passwords have to contain special characters More...
	setPasswordMinLength (int $a_password_min_length)
	set the minimum length for passwords More...
	getPasswordMinLength ()
	get the minimum length for passwords More...
	setPasswordMaxLength (int $a_password_max_length)
	set the maximum length for passwords More...
	getPasswordMaxLength ()
	get the maximum length for passwords More...
	setPasswordMaxAge (int $a_password_max_age)
	set the maximum password age More...
	getPasswordMaxAge ()
	get the maximum password age More...
	setLoginMaxAttempts (int $a_login_max_attempts)
	set the maximum count of login attempts More...
	getLoginMaxAttempts ()
	get the maximum count of login attempts More...
	setHTTPSEnabled (bool $value)
	Enable https for certain scripts. More...
	isHTTPSEnabled ()
	read access to https enabled property More...
	setPasswordChangeOnFirstLoginEnabled (bool $a_password_change_on_first_login_enabled)
	set if the passwords have to be changed by users on first login More...
	isPasswordChangeOnFirstLoginEnabled ()
	get boolean if the passwords have to be changed by users on first login More...
	isAdminRoleProtected ()
	protectedAdminRole (bool $a_stat)
	checkAdminRoleAccessible (int $a_usr_id)
	Check if the administrator role is accessible for a specific user. More...
	save ()
	Save settings. More...
	validate (ilPropertyFormGUI $a_form=null)
	validate settings More...
	isPreventionOfSimultaneousLoginsEnabled ()
	Prevention of simultaneous logins with the same account. More...
	setPreventionOfSimultaneousLogins (bool $value)
	Enable/Disable prevention of simultaneous logins with the same account. More...
	setPasswordNumberOfUppercaseChars (int $password_ucase_chars_num)
	Set number of uppercase characters required. More...
	getPasswordNumberOfUppercaseChars ()
	Returns number of uppercase characters required. More...
	setPasswordNumberOfLowercaseChars (int $password_lcase_chars_num)
	Set number of lowercase characters required. More...
	getPasswordNumberOfLowercaseChars ()
	Returns number of lowercase characters required. More...
	setPasswordMustNotContainLoginnameStatus ($status)
	Set whether the password must not contain the loginname or not. More...
	getPasswordMustNotContainLoginnameStatus ()
	Return whether the password must not contain the loginname or not. More...

Static Public Member Functions
static	_getInstance ()
	Get instance of ilSecuritySettings. More...

Data Fields
const	SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MIN_LENGTH = 4
const	SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MAX_LENGTH = 5
const	SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MAX_AGE = 6
const	SECURITY_SETTINGS_ERR_CODE_INVALID_LOGIN_MAX_ATTEMPTS = 7
const	SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN1 = 11
const	SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN2 = 8
const	SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN3 = 9
const	SECURITY_SETTINGS_ERR_CODE_PASSWORD_MAX_LENGTH_LESS_MIN_LENGTH = 10
const	DEFAULT_PASSWORD_CHARS_AND_NUMBERS_ENABLED = true
const	DEFAULT_PASSWORD_SPECIAL_CHARS_ENABLED = false
const	DEFAULT_PASSWORD_MIN_LENGTH = 8
const	DEFAULT_PASSWORD_MAX_LENGTH = 0
const	DEFAULT_PASSWORD_MAX_AGE = 90
const	DEFAULT_LOGIN_MAX_ATTEMPTS = 5
const	DEFAULT_PASSWORD_CHANGE_ON_FIRST_LOGIN_ENABLED = false
const	DEFAULT_PREVENT_SIMULTANEOUS_LOGINS = false

Static Public Attributes
static int	$SECURITY_SETTINGS_ERR_CODE_AUTO_HTTPS = 1
static int	$SECURITY_SETTINGS_ERR_CODE_HTTP_NOT_AVAILABLE = 2
static int	$SECURITY_SETTINGS_ERR_CODE_HTTPS_NOT_AVAILABLE = 3

Protected Attributes
ilHTTPS	$https

Private Member Functions
	__construct ()
	Private constructor: use _getInstance() More...
	read ()
	read settings @access private More...

Private Attributes
ilDBInterface	$db
ilSetting	$settings
ilRbacReview	$review
bool	$https_enable
bool	$password_chars_and_numbers_enabled = self::DEFAULT_PASSWORD_CHARS_AND_NUMBERS_ENABLED
bool	$password_special_chars_enabled = self::DEFAULT_PASSWORD_SPECIAL_CHARS_ENABLED
int	$password_min_length = self::DEFAULT_PASSWORD_MIN_LENGTH
int	$password_max_length = self::DEFAULT_PASSWORD_MAX_LENGTH
int	$password_max_age = self::DEFAULT_PASSWORD_MAX_AGE
int	$password_ucase_chars_num = 0
int	$password_lcase_chars_num = 0
int	$login_max_attempts = self::DEFAULT_LOGIN_MAX_ATTEMPTS
bool	$password_must_not_contain_loginname = false
bool	$password_change_on_first_login_enabled = self::DEFAULT_PASSWORD_CHANGE_ON_FIRST_LOGIN_ENABLED
bool	$prevent_simultaneous_logins = self::DEFAULT_PREVENT_SIMULTANEOUS_LOGINS
bool	$protect_admin_role = false

Static Private Attributes
static self	$instance = null

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too. If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Singleton class that stores all security settings

Author

Roland Küstermann rolan.nosp@m.d@ku.nosp@m.ester.nosp@m.mann.nosp@m..com

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e /

Definition at line 24 of file class.ilSecuritySettings.php.

Constructor & Destructor Documentation

__construct()

ilSecuritySettings::__construct ( )

private

Private constructor: use _getInstance()

Definition at line 75 of file class.ilSecuritySettings.php.

    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->settings = $DIC->settings();
        $this->review = $DIC->rbac()->review();
        $this->https = $DIC['https'];
 
        $this->read();
    }

References $DIC, read(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

_getInstance()

static ilSecuritySettings::_getInstance ( )

static

Get instance of ilSecuritySettings.

Returns

ilSecuritySettings instance @access public

Definition at line 92 of file class.ilSecuritySettings.php.

                                         : ilSecuritySettings
    {
        if (!self::$instance instanceof self) {
            self::$instance = new self();
        }
        return self::$instance;
    }

References $instance.

Referenced by ilObjRoleFolderGUI\addToExternalSettingsForm(), ilObjUserFolderGUI\addToExternalSettingsForm(), ilAuthFrontend\checkExceededLoginAttempts(), ilObjUserFolderGUI\generalSettingsObject(), ilSecuritySettingsChecker\generatePasswords(), ilSecuritySettingsChecker\getPasswordRequirementsInfo(), ilAuthFrontend\handleAuthenticationFail(), ilAuthFrontend\handleAuthenticationSuccess(), ilObjRoleFolderGUI\initSettingsForm(), ilSecuritySettingsChecker\isPassword(), ilObjUser\isPasswordChangeDemanded(), ilObjUser\isPasswordExpired(), ilRoleAssignmentTableGUI\parse(), ilObjUserFolderGUI\saveGeneralSettingsObject(), ilObjRoleFolderGUI\saveSettingsObject(), ilObjPrivacySecurityGUI\showSecurity(), and ilObjRoleGUI\userassignmentObject().

Here is the caller graph for this function:

checkAdminRoleAccessible()

ilSecuritySettings::checkAdminRoleAccessible

(

int

$a_usr_id

)

Check if the administrator role is accessible for a specific user.

Definition at line 247 of file class.ilSecuritySettings.php.

                                                           : bool
    {
        if (!$this->isAdminRoleProtected()) {
            return true;
        }
        if ($this->review->isAssigned($a_usr_id, SYSTEM_ROLE_ID)) {
            return true;
        }
        return false;
    }

References isAdminRoleProtected(), and SYSTEM_ROLE_ID.

Here is the call graph for this function:

getLoginMaxAttempts()

ilSecuritySettings::getLoginMaxAttempts

(

)

get the maximum count of login attempts

Definition at line 195 of file class.ilSecuritySettings.php.

                                         : int
    {
        return $this->login_max_attempts;
    }

References $login_max_attempts.

Referenced by save(), and validate().

Here is the caller graph for this function:

getPasswordMaxAge()

ilSecuritySettings::getPasswordMaxAge

(

)

get the maximum password age

Definition at line 179 of file class.ilSecuritySettings.php.

                                       : int
    {
        return $this->password_max_age;
    }

References $password_max_age.

Referenced by save(), and validate().

Here is the caller graph for this function:

getPasswordMaxLength()

ilSecuritySettings::getPasswordMaxLength

(

)

get the maximum length for passwords

Definition at line 163 of file class.ilSecuritySettings.php.

                                          : int
    {
        return $this->password_max_length;
    }

References $password_max_length.

Referenced by ilObjUserFolderGUI\getPasswordPolicySettingsMap(), save(), and validate().

Here is the caller graph for this function:

getPasswordMinLength()

ilSecuritySettings::getPasswordMinLength

(

)

get the minimum length for passwords

Definition at line 147 of file class.ilSecuritySettings.php.

                                          : int
    {
        return $this->password_min_length;
    }

References $password_min_length.

Referenced by ilObjUserFolderGUI\getPasswordPolicySettingsMap(), save(), and validate().

Here is the caller graph for this function:

getPasswordMustNotContainLoginnameStatus()

ilSecuritySettings::getPasswordMustNotContainLoginnameStatus

(

)

Return whether the password must not contain the loginname or not.

Definition at line 519 of file class.ilSecuritySettings.php.

                                                              : bool
    {
        return $this->password_must_not_contain_loginname;
    }

References $password_must_not_contain_loginname.

Referenced by ilObjUserFolderGUI\getPasswordPolicySettingsMap(), and save().

Here is the caller graph for this function:

getPasswordNumberOfLowercaseChars()

ilSecuritySettings::getPasswordNumberOfLowercaseChars

(

)

Returns number of lowercase characters required.

Definition at line 503 of file class.ilSecuritySettings.php.

                                                       : int
    {
        return $this->password_lcase_chars_num;
    }

References $password_lcase_chars_num.

Referenced by ilObjUserFolderGUI\getPasswordPolicySettingsMap(), save(), and validate().

Here is the caller graph for this function:

getPasswordNumberOfUppercaseChars()

ilSecuritySettings::getPasswordNumberOfUppercaseChars

(

)

Returns number of uppercase characters required.

Definition at line 487 of file class.ilSecuritySettings.php.

                                                       : int
    {
        return $this->password_ucase_chars_num;
    }

References $password_ucase_chars_num.

Referenced by ilObjUserFolderGUI\getPasswordPolicySettingsMap(), save(), and validate().

Here is the caller graph for this function:

isAdminRoleProtected()

ilSecuritySettings::isAdminRoleProtected

(

)

Definition at line 234 of file class.ilSecuritySettings.php.

                                          : bool
    {
        return (bool) $this->protect_admin_role;
    }

References $protect_admin_role.

Referenced by checkAdminRoleAccessible(), and save().

Here is the caller graph for this function:

isHTTPSEnabled()

ilSecuritySettings::isHTTPSEnabled

(

)

read access to https enabled property

Definition at line 211 of file class.ilSecuritySettings.php.

                                    : bool
    {
        return $this->https_enable;
    }

References $https_enable.

Referenced by save(), and validate().

Here is the caller graph for this function:

isPasswordChangeOnFirstLoginEnabled()

ilSecuritySettings::isPasswordChangeOnFirstLoginEnabled

(

)

get boolean if the passwords have to be changed by users on first login

Definition at line 229 of file class.ilSecuritySettings.php.

                                                         : bool
    {
        return $this->password_change_on_first_login_enabled;
    }

References $password_change_on_first_login_enabled.

Referenced by save().

Here is the caller graph for this function:

isPasswordCharsAndNumbersEnabled()

ilSecuritySettings::isPasswordCharsAndNumbersEnabled

(

)

get boolean if the passwords have to contain characters and numbers

Definition at line 113 of file class.ilSecuritySettings.php.

                                                      : bool
    {
        return $this->password_chars_and_numbers_enabled;
    }

References $password_chars_and_numbers_enabled.

Referenced by ilObjUserFolderGUI\getPasswordPolicySettingsMap(), save(), and validate().

Here is the caller graph for this function:

isPasswordSpecialCharsEnabled()

ilSecuritySettings::isPasswordSpecialCharsEnabled

(

)

get boolean if the passwords have to contain special characters

Definition at line 131 of file class.ilSecuritySettings.php.

                                                   : bool
    {
        return $this->password_special_chars_enabled;
    }

References $password_special_chars_enabled.

Referenced by ilObjUserFolderGUI\getPasswordPolicySettingsMap(), save(), and validate().

Here is the caller graph for this function:

isPreventionOfSimultaneousLoginsEnabled()

ilSecuritySettings::isPreventionOfSimultaneousLoginsEnabled

(

)

Prevention of simultaneous logins with the same account.

Returns

bool true, if prevention of simultaneous logins with the same account is enabled, false otherwise

Definition at line 463 of file class.ilSecuritySettings.php.

                                                             : bool
    {
        return $this->prevent_simultaneous_logins;
    }

References $prevent_simultaneous_logins.

Referenced by save().

Here is the caller graph for this function:

protectedAdminRole()

ilSecuritySettings::protectedAdminRole

(

bool

$a_stat

)

Definition at line 239 of file class.ilSecuritySettings.php.

                                                    : void
    {
        $this->protect_admin_role = $a_stat;
    }

read()

ilSecuritySettings::read ( )

private

read settings @access private

Parameters

Definition at line 291 of file class.ilSecuritySettings.php.

                           : void
    {
        $query = "SELECT object_reference.ref_id FROM object_reference,tree,object_data " .
            "WHERE tree.parent = " . $this->db->quote(SYSTEM_FOLDER_ID, 'integer') . " " .
            "AND object_data.type = 'ps' " .
            "AND object_reference.ref_id = tree.child " .
            "AND object_reference.obj_id = object_data.obj_id";
        $res = $this->db->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
 
        $this->https_enable = (bool) $this->settings->get('https', null);
 
        $this->password_chars_and_numbers_enabled = (bool) $this->settings->get(
            'ps_password_chars_and_numbers_enabled',
            (string) self::DEFAULT_PASSWORD_CHARS_AND_NUMBERS_ENABLED
        );
        $this->password_special_chars_enabled = (bool) $this->settings->get(
            'ps_password_special_chars_enabled',
            (string) self::DEFAULT_PASSWORD_SPECIAL_CHARS_ENABLED
        );
        $this->password_min_length = (int) $this->settings->get(
            'ps_password_min_length',
            (string) self::DEFAULT_PASSWORD_MIN_LENGTH
        );
        $this->password_max_length = (int) $this->settings->get(
            'ps_password_max_length',
            (string) self::DEFAULT_PASSWORD_MAX_LENGTH
        );
        $this->password_max_age = (int) $this->settings->get('ps_password_max_age', (string) self::DEFAULT_PASSWORD_MAX_AGE);
        $this->login_max_attempts = (int) $this->settings->get(
            'ps_login_max_attempts',
            (string) self::DEFAULT_LOGIN_MAX_ATTEMPTS
        );
        $this->password_ucase_chars_num = (int) $this->settings->get('ps_password_uppercase_chars_num', "0");
        $this->password_lcase_chars_num = (int) $this->settings->get('ps_password_lowercase_chars_num', "0");
        $this->password_must_not_contain_loginname = (bool) $this->settings->get(
            'ps_password_must_not_contain_loginame',
            null
        );
        $this->password_change_on_first_login_enabled = (bool) $this->settings->get(
            'ps_password_change_on_first_login_enabled',
            (string) self::DEFAULT_PASSWORD_CHANGE_ON_FIRST_LOGIN_ENABLED
        );
        $this->prevent_simultaneous_logins = (bool) $this->settings->get(
            'ps_prevent_simultaneous_logins',
            (string) self::DEFAULT_PREVENT_SIMULTANEOUS_LOGINS
        );
        $this->protect_admin_role = (bool) $this->settings->get('ps_protect_admin', (string) $this->protect_admin_role);
    }

References $protect_admin_role, $query, $res, DEFAULT_LOGIN_MAX_ATTEMPTS, DEFAULT_PASSWORD_CHANGE_ON_FIRST_LOGIN_ENABLED, DEFAULT_PASSWORD_CHARS_AND_NUMBERS_ENABLED, DEFAULT_PASSWORD_MAX_AGE, DEFAULT_PASSWORD_MAX_LENGTH, DEFAULT_PASSWORD_MIN_LENGTH, DEFAULT_PASSWORD_SPECIAL_CHARS_ENABLED, DEFAULT_PREVENT_SIMULTANEOUS_LOGINS, ilDBConstants\FETCHMODE_ASSOC, ILIAS\Repository\int(), ILIAS\Repository\settings(), and SYSTEM_FOLDER_ID.

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilSecuritySettings::save

(

)

Save settings.

Definition at line 261 of file class.ilSecuritySettings.php.

                          : void
    {
        $this->settings->set('https', (string) $this->isHTTPSEnabled());
 
        $this->settings->set('ps_password_chars_and_numbers_enabled', (string) $this->isPasswordCharsAndNumbersEnabled());
        $this->settings->set('ps_password_special_chars_enabled', (string) $this->isPasswordSpecialCharsEnabled());
        $this->settings->set('ps_password_min_length', (string) $this->getPasswordMinLength());
        $this->settings->set('ps_password_max_length', (string) $this->getPasswordMaxLength());
        $this->settings->set('ps_password_max_age', (string) $this->getPasswordMaxAge());
        $this->settings->set('ps_login_max_attempts', (string) $this->getLoginMaxAttempts());
        $this->settings->set('ps_password_uppercase_chars_num', (string) $this->getPasswordNumberOfUppercaseChars());
        $this->settings->set('ps_password_lowercase_chars_num', (string) $this->getPasswordNumberOfLowercaseChars());
        $this->settings->set(
            'ps_password_must_not_contain_loginame',
            (string) $this->getPasswordMustNotContainLoginnameStatus()
        );
 
        $this->settings->set(
            'ps_password_change_on_first_login_enabled',
            (string) $this->isPasswordChangeOnFirstLoginEnabled()
        );
        $this->settings->set('ps_prevent_simultaneous_logins', (string) $this->isPreventionOfSimultaneousLoginsEnabled());
        $this->settings->set('ps_protect_admin', (string) $this->isAdminRoleProtected());
    }

References getLoginMaxAttempts(), getPasswordMaxAge(), getPasswordMaxLength(), getPasswordMinLength(), getPasswordMustNotContainLoginnameStatus(), getPasswordNumberOfLowercaseChars(), getPasswordNumberOfUppercaseChars(), isAdminRoleProtected(), isHTTPSEnabled(), isPasswordChangeOnFirstLoginEnabled(), isPasswordCharsAndNumbersEnabled(), isPasswordSpecialCharsEnabled(), isPreventionOfSimultaneousLoginsEnabled(), and ILIAS\Repository\settings().

Here is the call graph for this function:

setHTTPSEnabled()

ilSecuritySettings::setHTTPSEnabled

(

bool

$value

)

Enable https for certain scripts.

Definition at line 203 of file class.ilSecuritySettings.php.

                                                : void
    {
        $this->https_enable = $value;
    }

setLoginMaxAttempts()

ilSecuritySettings::setLoginMaxAttempts

(

int

$a_login_max_attempts

)

set the maximum count of login attempts

Definition at line 187 of file class.ilSecuritySettings.php.

                                                                  : void
    {
        $this->login_max_attempts = $a_login_max_attempts;
    }

setPasswordChangeOnFirstLoginEnabled()

ilSecuritySettings::setPasswordChangeOnFirstLoginEnabled

(

bool

$a_password_change_on_first_login_enabled

)

set if the passwords have to be changed by users on first login

Definition at line 220 of file class.ilSecuritySettings.php.

                                                                                                        : void
    {
        $this->password_change_on_first_login_enabled = $a_password_change_on_first_login_enabled;
    }

setPasswordCharsAndNumbersEnabled()

ilSecuritySettings::setPasswordCharsAndNumbersEnabled

(

bool

$a_chars_and_numbers_enabled

)

set if the passwords have to contain characters and numbers

Definition at line 104 of file class.ilSecuritySettings.php.

                                                                                        : void
    {
        $this->password_chars_and_numbers_enabled = $a_chars_and_numbers_enabled;
    }

setPasswordMaxAge()

ilSecuritySettings::setPasswordMaxAge

(

int

$a_password_max_age

)

set the maximum password age

Definition at line 171 of file class.ilSecuritySettings.php.

                                                              : void
    {
        $this->password_max_age = $a_password_max_age;
    }

setPasswordMaxLength()

ilSecuritySettings::setPasswordMaxLength

(

int

$a_password_max_length

)

set the maximum length for passwords

Definition at line 155 of file class.ilSecuritySettings.php.

                                                                    : void
    {
        $this->password_max_length = $a_password_max_length;
    }

setPasswordMinLength()

ilSecuritySettings::setPasswordMinLength

(

int

$a_password_min_length

)

set the minimum length for passwords

Definition at line 139 of file class.ilSecuritySettings.php.

                                                                    : void
    {
        $this->password_min_length = $a_password_min_length;
    }

setPasswordMustNotContainLoginnameStatus()

ilSecuritySettings::setPasswordMustNotContainLoginnameStatus

(

$status

)

Set whether the password must not contain the loginname or not.

Definition at line 511 of file class.ilSecuritySettings.php.

                                                                     : void
    {
        $this->password_must_not_contain_loginname = (bool) $status;
    }

setPasswordNumberOfLowercaseChars()

ilSecuritySettings::setPasswordNumberOfLowercaseChars

(

int

$password_lcase_chars_num

)

Set number of lowercase characters required.

Definition at line 495 of file class.ilSecuritySettings.php.

                                                                                    : void
    {
        $this->password_lcase_chars_num = $password_lcase_chars_num;
    }

References $password_lcase_chars_num.

setPasswordNumberOfUppercaseChars()

ilSecuritySettings::setPasswordNumberOfUppercaseChars

(

int

$password_ucase_chars_num

)

Set number of uppercase characters required.

Definition at line 479 of file class.ilSecuritySettings.php.

                                                                                    : void
    {
        $this->password_ucase_chars_num = $password_ucase_chars_num;
    }

References $password_ucase_chars_num.

setPasswordSpecialCharsEnabled()

ilSecuritySettings::setPasswordSpecialCharsEnabled

(

bool

$a_password_special_chars_enabled

)

set if the passwords have to contain special characters

Definition at line 122 of file class.ilSecuritySettings.php.

                                                                                          : void
    {
        $this->password_special_chars_enabled = $a_password_special_chars_enabled;
    }

setPreventionOfSimultaneousLogins()

ilSecuritySettings::setPreventionOfSimultaneousLogins

(

bool

$value

)

Enable/Disable prevention of simultaneous logins with the same account.

Definition at line 471 of file class.ilSecuritySettings.php.

                                                                  : void
    {
        $this->prevent_simultaneous_logins = $value;
    }

validate()

ilSecuritySettings::validate

(

ilPropertyFormGUI

$a_form = null

)

validate settings

Parameters

ilPropertyFormGUI | null

$a_form

Returns

int|null 0, if everything is ok, an error code otherwise

Definition at line 346 of file class.ilSecuritySettings.php.

                                                              : ?int
    {
        $code = null;
 
        if ($this->isHTTPSEnabled()) {
            if (!$this->https->checkHTTPS()) {
                $code = ilSecuritySettings::$SECURITY_SETTINGS_ERR_CODE_HTTPS_NOT_AVAILABLE;
                if (!$a_form) {
                    return $code;
                } else {
                    $a_form->getItemByPostVar('https_enabled')
                           ->setAlert(ilObjPrivacySecurityGUI::getErrorMessage($code));
                }
            }
        }
 
        if ($this->getPasswordMinLength() < 0) {
            $code = self::SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MIN_LENGTH;
            if (!$a_form) {
                return $code;
            } else {
                $a_form->getItemByPostVar('password_min_length')
                       ->setAlert(ilObjPrivacySecurityGUI::getErrorMessage($code));
            }
        }
 
        if ($this->getPasswordMaxLength() < 0) {
            $code = self::SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MAX_LENGTH;
            if (!$a_form) {
                return $code;
            } else {
                $a_form->getItemByPostVar('password_max_length')
                       ->setAlert(ilObjPrivacySecurityGUI::getErrorMessage($code));
            }
        }
 
        $password_min_length = 1;
        $password_min_length_error_code = null;
 
        if ($this->getPasswordNumberOfUppercaseChars() > 0 || $this->getPasswordNumberOfLowercaseChars() > 0) {
            $password_min_length = 0;
            if ($this->getPasswordNumberOfUppercaseChars() > 0) {
                $password_min_length += $this->getPasswordNumberOfUppercaseChars();
            }
            if ($this->getPasswordNumberOfLowercaseChars() > 0) {
                $password_min_length += $this->getPasswordNumberOfLowercaseChars();
            }
            $password_min_length_error_code = self::SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN1;
        }
 
        if ($this->isPasswordCharsAndNumbersEnabled()) {
            $password_min_length++;
            $password_min_length_error_code = self::SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN2;
 
            if ($this->isPasswordSpecialCharsEnabled()) {
                $password_min_length++;
                $password_min_length_error_code = self::SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN3;
            }
        } elseif ($password_min_length > 1 && $this->isPasswordSpecialCharsEnabled()) {
            $password_min_length++;
            $password_min_length_error_code = self::SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN3;
        }
 
        if ($this->getPasswordMinLength() > 0 && $this->getPasswordMinLength() < $password_min_length) {
            $code = $password_min_length_error_code;
            if (!$a_form) {
                return $code;
            } else {
                $a_form->getItemByPostVar('password_min_length')
                       ->setAlert(sprintf(ilObjPrivacySecurityGUI::getErrorMessage($code), $password_min_length));
            }
        }
        if ($this->getPasswordMaxLength() > 0 && $this->getPasswordMaxLength() < $this->getPasswordMinLength()) {
            $code = self::SECURITY_SETTINGS_ERR_CODE_PASSWORD_MAX_LENGTH_LESS_MIN_LENGTH;
            if (!$a_form) {
                return $code;
            } else {
                $a_form->getItemByPostVar('password_max_length')
                       ->setAlert(ilObjPrivacySecurityGUI::getErrorMessage($code));
            }
        }
        if ($this->getPasswordMaxAge() < 0) {
            $code = self::SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MAX_AGE;
            if (!$a_form) {
                return $code;
            } else {
                $a_form->getItemByPostVar('password_max_age')
                       ->setAlert(ilObjPrivacySecurityGUI::getErrorMessage($code));
            }
        }
 
        if ($this->getLoginMaxAttempts() < 0) {
            $code = self::SECURITY_SETTINGS_ERR_CODE_INVALID_LOGIN_MAX_ATTEMPTS;
            if (!$a_form) {
                return $code;
            } else {
                $a_form->getItemByPostVar('login_max_attempts')
                       ->setAlert(ilObjPrivacySecurityGUI::getErrorMessage($code));
            }
        }
 
        /*
         * todo: have to check for local auth if first login password change is enabled??
         * than: add errorcode
         */
 
        if (!$a_form) {
            return 0;
        } else {
            return $code;
        }
    }

References $password_min_length, $SECURITY_SETTINGS_ERR_CODE_HTTPS_NOT_AVAILABLE, ilObjPrivacySecurityGUI\getErrorMessage(), getLoginMaxAttempts(), getPasswordMaxAge(), getPasswordMaxLength(), getPasswordMinLength(), getPasswordNumberOfLowercaseChars(), getPasswordNumberOfUppercaseChars(), isHTTPSEnabled(), isPasswordCharsAndNumbersEnabled(), isPasswordSpecialCharsEnabled(), SECURITY_SETTINGS_ERR_CODE_INVALID_LOGIN_MAX_ATTEMPTS, SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MAX_AGE, SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MAX_LENGTH, SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MIN_LENGTH, SECURITY_SETTINGS_ERR_CODE_PASSWORD_MAX_LENGTH_LESS_MIN_LENGTH, SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN1, SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN2, and SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN3.

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilSecuritySettings::$db

private

Definition at line 40 of file class.ilSecuritySettings.php.

$https

ilHTTPS ilSecuritySettings::$https

protected

Definition at line 43 of file class.ilSecuritySettings.php.

$https_enable

bool ilSecuritySettings::$https_enable

private

Definition at line 45 of file class.ilSecuritySettings.php.

Referenced by isHTTPSEnabled().

$instance

self ilSecuritySettings::$instance = null

staticprivate

Definition at line 39 of file class.ilSecuritySettings.php.

Referenced by _getInstance().

$login_max_attempts

int ilSecuritySettings::$login_max_attempts = self::DEFAULT_LOGIN_MAX_ATTEMPTS

private

Definition at line 64 of file class.ilSecuritySettings.php.

Referenced by getLoginMaxAttempts().

$password_change_on_first_login_enabled

bool ilSecuritySettings::$password_change_on_first_login_enabled = self::DEFAULT_PASSWORD_CHANGE_ON_FIRST_LOGIN_ENABLED

private

Definition at line 67 of file class.ilSecuritySettings.php.

Referenced by isPasswordChangeOnFirstLoginEnabled().

$password_chars_and_numbers_enabled

bool ilSecuritySettings::$password_chars_and_numbers_enabled = self::DEFAULT_PASSWORD_CHARS_AND_NUMBERS_ENABLED

private

Definition at line 57 of file class.ilSecuritySettings.php.

Referenced by isPasswordCharsAndNumbersEnabled().

$password_lcase_chars_num

int ilSecuritySettings::$password_lcase_chars_num = 0

private

Definition at line 63 of file class.ilSecuritySettings.php.

Referenced by getPasswordNumberOfLowercaseChars(), and setPasswordNumberOfLowercaseChars().

$password_max_age

int ilSecuritySettings::$password_max_age = self::DEFAULT_PASSWORD_MAX_AGE

private

Definition at line 61 of file class.ilSecuritySettings.php.

Referenced by getPasswordMaxAge().

$password_max_length

int ilSecuritySettings::$password_max_length = self::DEFAULT_PASSWORD_MAX_LENGTH

private

Definition at line 60 of file class.ilSecuritySettings.php.

Referenced by getPasswordMaxLength().

$password_min_length

int ilSecuritySettings::$password_min_length = self::DEFAULT_PASSWORD_MIN_LENGTH

private

Definition at line 59 of file class.ilSecuritySettings.php.

Referenced by getPasswordMinLength(), and validate().

$password_must_not_contain_loginname

bool ilSecuritySettings::$password_must_not_contain_loginname = false

private

Definition at line 65 of file class.ilSecuritySettings.php.

Referenced by getPasswordMustNotContainLoginnameStatus().

$password_special_chars_enabled

bool ilSecuritySettings::$password_special_chars_enabled = self::DEFAULT_PASSWORD_SPECIAL_CHARS_ENABLED

private

Definition at line 58 of file class.ilSecuritySettings.php.

Referenced by isPasswordSpecialCharsEnabled().

$password_ucase_chars_num

int ilSecuritySettings::$password_ucase_chars_num = 0

private

Definition at line 62 of file class.ilSecuritySettings.php.

Referenced by getPasswordNumberOfUppercaseChars(), and setPasswordNumberOfUppercaseChars().

$prevent_simultaneous_logins

bool ilSecuritySettings::$prevent_simultaneous_logins = self::DEFAULT_PREVENT_SIMULTANEOUS_LOGINS

private

Definition at line 68 of file class.ilSecuritySettings.php.

Referenced by isPreventionOfSimultaneousLoginsEnabled().

$protect_admin_role

bool ilSecuritySettings::$protect_admin_role = false

private

Definition at line 70 of file class.ilSecuritySettings.php.

Referenced by isAdminRoleProtected(), and read().

$review

ilRbacReview ilSecuritySettings::$review

private

Definition at line 42 of file class.ilSecuritySettings.php.

$SECURITY_SETTINGS_ERR_CODE_AUTO_HTTPS

int ilSecuritySettings::$SECURITY_SETTINGS_ERR_CODE_AUTO_HTTPS = 1

static

Definition at line 26 of file class.ilSecuritySettings.php.

Referenced by ilObjPrivacySecurityGUI\initErrorMessages().

$SECURITY_SETTINGS_ERR_CODE_HTTP_NOT_AVAILABLE

int ilSecuritySettings::$SECURITY_SETTINGS_ERR_CODE_HTTP_NOT_AVAILABLE = 2

static

Definition at line 27 of file class.ilSecuritySettings.php.

Referenced by ilObjPrivacySecurityGUI\initErrorMessages().

$SECURITY_SETTINGS_ERR_CODE_HTTPS_NOT_AVAILABLE

int ilSecuritySettings::$SECURITY_SETTINGS_ERR_CODE_HTTPS_NOT_AVAILABLE = 3

static

Definition at line 28 of file class.ilSecuritySettings.php.

Referenced by ilObjPrivacySecurityGUI\initErrorMessages(), and validate().

$settings

ilSetting ilSecuritySettings::$settings

private

Definition at line 41 of file class.ilSecuritySettings.php.

DEFAULT_LOGIN_MAX_ATTEMPTS

const ilSecuritySettings::DEFAULT_LOGIN_MAX_ATTEMPTS = 5

Definition at line 52 of file class.ilSecuritySettings.php.

Referenced by read().

DEFAULT_PASSWORD_CHANGE_ON_FIRST_LOGIN_ENABLED

const ilSecuritySettings::DEFAULT_PASSWORD_CHANGE_ON_FIRST_LOGIN_ENABLED = false

Definition at line 54 of file class.ilSecuritySettings.php.

Referenced by read().

DEFAULT_PASSWORD_CHARS_AND_NUMBERS_ENABLED

const ilSecuritySettings::DEFAULT_PASSWORD_CHARS_AND_NUMBERS_ENABLED = true

Definition at line 47 of file class.ilSecuritySettings.php.

Referenced by read().

DEFAULT_PASSWORD_MAX_AGE

const ilSecuritySettings::DEFAULT_PASSWORD_MAX_AGE = 90

Definition at line 51 of file class.ilSecuritySettings.php.

Referenced by read().

DEFAULT_PASSWORD_MAX_LENGTH

const ilSecuritySettings::DEFAULT_PASSWORD_MAX_LENGTH = 0

Definition at line 50 of file class.ilSecuritySettings.php.

Referenced by read().

DEFAULT_PASSWORD_MIN_LENGTH

const ilSecuritySettings::DEFAULT_PASSWORD_MIN_LENGTH = 8

Definition at line 49 of file class.ilSecuritySettings.php.

Referenced by read().

DEFAULT_PASSWORD_SPECIAL_CHARS_ENABLED

const ilSecuritySettings::DEFAULT_PASSWORD_SPECIAL_CHARS_ENABLED = false

Definition at line 48 of file class.ilSecuritySettings.php.

Referenced by read().

DEFAULT_PREVENT_SIMULTANEOUS_LOGINS

const ilSecuritySettings::DEFAULT_PREVENT_SIMULTANEOUS_LOGINS = false

Definition at line 55 of file class.ilSecuritySettings.php.

Referenced by read().

SECURITY_SETTINGS_ERR_CODE_INVALID_LOGIN_MAX_ATTEMPTS

const ilSecuritySettings::SECURITY_SETTINGS_ERR_CODE_INVALID_LOGIN_MAX_ATTEMPTS = 7

Definition at line 33 of file class.ilSecuritySettings.php.

Referenced by ilObjPrivacySecurityGUI\initErrorMessages(), and validate().

SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MAX_AGE

const ilSecuritySettings::SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MAX_AGE = 6

Definition at line 32 of file class.ilSecuritySettings.php.

Referenced by ilObjPrivacySecurityGUI\initErrorMessages(), and validate().

SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MAX_LENGTH

const ilSecuritySettings::SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MAX_LENGTH = 5

Definition at line 31 of file class.ilSecuritySettings.php.

Referenced by ilObjPrivacySecurityGUI\initErrorMessages(), and validate().

SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MIN_LENGTH

const ilSecuritySettings::SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MIN_LENGTH = 4

Definition at line 30 of file class.ilSecuritySettings.php.

Referenced by ilObjPrivacySecurityGUI\initErrorMessages(), and validate().

SECURITY_SETTINGS_ERR_CODE_PASSWORD_MAX_LENGTH_LESS_MIN_LENGTH

const ilSecuritySettings::SECURITY_SETTINGS_ERR_CODE_PASSWORD_MAX_LENGTH_LESS_MIN_LENGTH = 10

Definition at line 37 of file class.ilSecuritySettings.php.

Referenced by ilObjPrivacySecurityGUI\initErrorMessages(), and validate().

SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN1

const ilSecuritySettings::SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN1 = 11

Definition at line 34 of file class.ilSecuritySettings.php.

Referenced by ilObjPrivacySecurityGUI\initErrorMessages(), and validate().

SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN2

const ilSecuritySettings::SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN2 = 8

Definition at line 35 of file class.ilSecuritySettings.php.

Referenced by ilObjPrivacySecurityGUI\initErrorMessages(), and validate().

SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN3

const ilSecuritySettings::SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN3 = 9

Definition at line 36 of file class.ilSecuritySettings.php.

Referenced by ilObjPrivacySecurityGUI\initErrorMessages(), and validate().

---

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

• Services/PrivacySecurity/classes/class.ilSecuritySettings.php