93 lines
3.1 KiB
PHP
Executable File
93 lines
3.1 KiB
PHP
Executable File
<?php
|
|
namespace SimpleSAML\Utils;
|
|
|
|
/**
|
|
* Utility class for SimpleSAMLphp configuration management and manipulation.
|
|
*
|
|
* @package SimpleSAMLphp
|
|
*/
|
|
class Config
|
|
{
|
|
|
|
/**
|
|
* Resolves a path that may be relative to the cert-directory.
|
|
*
|
|
* @param string $path The (possibly relative) path to the file.
|
|
*
|
|
* @return string The file path.
|
|
* @throws \InvalidArgumentException If $path is not a string.
|
|
*
|
|
* @author Olav Morken, UNINETT AS <olav.morken@uninett.no>
|
|
*/
|
|
public static function getCertPath($path)
|
|
{
|
|
if (!is_string($path)) {
|
|
throw new \InvalidArgumentException('Invalid input parameters.');
|
|
}
|
|
|
|
$globalConfig = \SimpleSAML_Configuration::getInstance();
|
|
$base = $globalConfig->getPathValue('certdir', 'cert/');
|
|
return System::resolvePath($path, $base);
|
|
}
|
|
|
|
|
|
/**
|
|
* Retrieve the secret salt.
|
|
*
|
|
* This function retrieves the value which is configured as the secret salt. It will check that the value exists
|
|
* and is set to a non-default value. If it isn't, an exception will be thrown.
|
|
*
|
|
* The secret salt can be used as a component in hash functions, to make it difficult to test all possible values
|
|
* in order to retrieve the original value. It can also be used as a simple method for signing data, by hashing the
|
|
* data together with the salt.
|
|
*
|
|
* @return string The secret salt.
|
|
* @throws \InvalidArgumentException If the secret salt hasn't been configured.
|
|
*
|
|
* @author Olav Morken, UNINETT AS <olav.morken@uninett.no>
|
|
*/
|
|
public static function getSecretSalt()
|
|
{
|
|
$secretSalt = \SimpleSAML_Configuration::getInstance()->getString('secretsalt');
|
|
if ($secretSalt === 'defaultsecretsalt') {
|
|
throw new \InvalidArgumentException('The "secretsalt" configuration option must be set to a secret value.');
|
|
}
|
|
|
|
return $secretSalt;
|
|
}
|
|
|
|
/**
|
|
* Returns the path to the config dir
|
|
*
|
|
* If the SIMPLESAMLPHP_CONFIG_DIR environment variable has been set, it takes precedence over the default
|
|
* $simplesamldir/config directory.
|
|
*
|
|
* @return string The path to the configuration directory.
|
|
*/
|
|
public static function getConfigDir()
|
|
{
|
|
$configDir = dirname(dirname(dirname(__DIR__))) . '/config';
|
|
/** @var string|false $configDirEnv */
|
|
$configDirEnv = getenv('SIMPLESAMLPHP_CONFIG_DIR');
|
|
|
|
if($configDirEnv === false) {
|
|
$configDirEnv = getenv('REDIRECT_SIMPLESAMLPHP_CONFIG_DIR');
|
|
}
|
|
|
|
if ($configDirEnv !== false) {
|
|
if (!is_dir($configDirEnv)) {
|
|
throw new \InvalidArgumentException(
|
|
sprintf(
|
|
'Config directory specified by environment variable SIMPLESAMLPHP_CONFIG_DIR is not a ' .
|
|
'directory. Given: "%s"',
|
|
$configDirEnv
|
|
)
|
|
);
|
|
}
|
|
$configDir = $configDirEnv;
|
|
}
|
|
|
|
return $configDir;
|
|
}
|
|
}
|