LDAP Account Manager

LAMCfgMain

in package

• configuration

This class manages config.cfg.

Table of Contents

DATABASE_FILE_SYSTEM  = 'files'

store configuration on local file system

DATABASE_MYSQL  = 'mysql'

store configuration in MySQL database

ERROR_REPORTING_ALL  = 'all'

PHP error reporting setting as E_ALL

ERROR_REPORTING_DEFAULT  = 'default'

PHP error reporting setting as E_ALL & ~E_NOTICE

ERROR_REPORTING_SYSTEM  = 'system'

PHP error reporting setting from php.ini

LICENSE_WARNING_ALL  = 'all'

send license warnings via email + display on screen

LICENSE_WARNING_EMAIL  = 'email'

send license warnings via email

LICENSE_WARNING_NONE  = 'none'

no license warning

LICENSE_WARNING_SCREEN  = 'screen'

display license warnings on screen

MAIL_ATTRIBUTE_DEFAULT  = 'mail'

MAIL_BACKUP_ATTRIBUTE_DEFAULT  = 'passwordselfresetbackupmail'

SMS_ATTRIBUTES_DEFAULT  = 'mobileTelephoneNumber;mobile'

SMTP_NONE  = 'NONE'

No encryption for mail sending

SMTP_SSL  = 'SSL'

SSL encryption for mail sending

SMTP_TLS  = 'TLS'

TLS encryption for mail sending

$allowedHosts  : string

list of hosts which may access LAM

$allowedHostsSelfService  : string

list of hosts which may access LAM Pro self-service

$auditLogTarget  : string

target of audit log

$auditLogType  : string

type of audit log

$checkedRulesCount  : int

number of password rules that must match (-1 = all)

$configDatabaseName  : string

database name

$configDatabasePassword  : string

database password

$configDatabasePort  : string

database port

$configDatabaseServer  : string

database server name

$configDatabaseSSLCA  : string

database options

$configDatabaseType  : string

database type

$configDatabaseUser  : string

database user

$default  : string|null

Default profile

$errorReporting  : string

error reporting

$externalPwdCheckUrl  : string|null

external URL for password checking (e.g. https://domain.com/url/{SHA1})

$hideLoginErrorDetails  : string

$licenseEmailDateSent  : string

the license warning email was last sent for this expiration date

$licenseEmailFrom  : string

license warning email from address

$licenseEmailTo  : string

license warning email TO address(es) separated by ";"

$licenseWarningType  : string

type of license warning (email/screen/both/none)

$logDestination  : string

log destination ("SYSLOG":syslog, "/...":file, "NONE":none, "REMOTE":server:port)

$logLevel  : int

log level

$mailAttribute  : string

$mailBackupAttribute  : string

$mailEncryption  : string

$mailPassword  : string

mail server password

$mailServer  : string

mail server (server:port)

$mailUser  : string

mail server user

$passwordMinClasses  : int

minimum character classes (upper, lower, numeric, symbols)

$passwordMinLength  : int

minimum length for passwords

$passwordMinLower  : int

minimum lowercase characters

$passwordMinNumeric  : int

minimum numeric characters

$passwordMinSymbol  : int

minimum symbol characters

$passwordMinUpper  : int

minimum uppercase characters

$passwordMustNotContain3Chars  : string

password may contain more than 2 characters of user/first/last name

$passwordMustNotContainUser  : string

password may contain the user name

$sessionTimeout  : int

Time of inactivity before session times out (minutes)

$smsAccountId  : string

$smsApiKey  : string

$smsAttributes  : string

$smsDefaultCountryPrefix  : string

$smsFrom  : string

$smsProvider  : string

$smsRegion  : string

$smsSubject  : string

$smsToken  : string

$conffile  : string

path to config file

$delSSLCaCert  : bool

SSL certificate should be deleted on save()

$license  : string

license data

$moduleSettings  : string

database password

$password  : string|null

Password to change config.cfg

$persistenceSettings  : array<string|int, mixed>

$settings  : array<string|int, mixed>

$uploadedSSLCaCert  : string|null

uploaded SSL certificate that is stored to disk on save()

__construct()  : mixed

Loads preferences from config file

checkPassword()  : bool

Checks if the given password matches.

deleteSSLCaCert()  : void

Marks a single or all SSL CA certificate files for deletion.

exportCertificates()  : null|string

Returns the content of the server certificates file

exportData()  : array<string, string|string[]|int|bool|null>

Exports the configuration data.

getLicenseLines()  : array<string|int, string>

Returns the license key as multiple lines.

getLicenseWarningType()  : string

Returns the license warning type (screen/email/both/none).

getMailAttribute()  : string

Returns the mail attribute.

getMailBackupAttribute()  : string

Returns the mail backup attribute.

getModuleSettings()  : array<string, array<string, string>>

Returns a list of module settings.

getSmsAttributes()  : array<string|int, string>

Returns the SMS attributes.

getSSLCaCertificates()  : array<int, array<string, array<string|int, array<string|int, string>>>>

Returns a list of all CA certificates.

getSSLCaCertPath()  : string|null

Returns the path to the SSL CA certificate file that overrides the system certificates.

getSSLCaCertTempFileName()  : string|null

Returns the name of a temporary file in tmp that contains the SSL certificate.

hasPasswordSet()  : bool

Returns if the main config has a password set.

importCertificates()  : void

Imports the server certificates.

importData()  : void

Imports configuration data.

installSampleConfig()  : bool

Tries to copy the config file from sample config.

isConfigFileExisting()  : bool

Returns if the configuration file is existing.

isHideLoginErrorDetails()  : bool

Hide error details for failed logins.

isValidLogFilename()  : bool

Checks if the log filename is valid.

isWritable()  : bool

Returns if the configuration file is writable.

save()  : void

Saves the configuration to the persistence layer.

saveLocal()  : void

Saves preferences to config file config.cfg

sendLicenseWarningByEmail()  : bool

Returns if the license warning should be sent via email.

setLicenseLines()  : void

Sets the license key as multiple lines.

setModuleSettings()  : void

Sets the module settings.

setPassword()  : void

Sets a new config password.

showLicenseWarningOnScreen()  : bool

Returns if the license warning should be shown on screen.

uploadSSLCaCert()  : true|string

Uploads a new SSL CA cert.

wasLicenseWarningSent()  : bool

Returns if the license warning was already sent.

exportPersistenceData()  : array<string, string|string[]|int|bool|null>

Exports the configuration data, persistence settings only.

getInternalSSLCaCertFileName()  : string

Returns the file name that will be used internally to store the CA file.

getSSLCaCertificateContent()  : string|null

Returns the content of the certificate file or uploaded data.

hashPassword()  : string

Returns the hashed password.

loadFromDb()  : void

Loads the settings from the database.

reload()  : void

Reloads preferences from config file config.cfg

saveDb()  : void

Saves the config data to the database.

splitSSLCaCertificateContent()  : array<int, string>

Splits the certificate content into single PEM data chunks.