319 lines
8.4 KiB
PHP
319 lines
8.4 KiB
PHP
<?php
|
|
/**
|
|
* ---------------------------------------------------------------------
|
|
* GLPI - Gestionnaire Libre de Parc Informatique
|
|
* Copyright (C) 2015-2020 Teclib' and contributors.
|
|
*
|
|
* http://glpi-project.org
|
|
*
|
|
* based on GLPI - Gestionnaire Libre de Parc Informatique
|
|
* Copyright (C) 2003-2014 by the INDEPNET Development Team.
|
|
*
|
|
* ---------------------------------------------------------------------
|
|
*
|
|
* LICENSE
|
|
*
|
|
* This file is part of GLPI.
|
|
*
|
|
* GLPI is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* GLPI is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with GLPI. If not, see <http://www.gnu.org/licenses/>.
|
|
* ---------------------------------------------------------------------
|
|
*/
|
|
|
|
if (!defined('GLPI_ROOT')) {
|
|
die("Sorry. You can't access this file directly");
|
|
}
|
|
|
|
/**
|
|
* GLPI security key
|
|
**/
|
|
class GLPIKey {
|
|
/**
|
|
* Key file path.
|
|
*
|
|
* @var string
|
|
*/
|
|
private $keyfile;
|
|
|
|
/**
|
|
* Legacy key file path.
|
|
*
|
|
* @var string
|
|
*/
|
|
private $legacykeyfile;
|
|
|
|
/**
|
|
* List of crypted DB fields.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $fields = [
|
|
'glpi_mailcollectors.passwd',
|
|
'glpi_authldaps.rootdn_passwd'
|
|
];
|
|
|
|
/**
|
|
* List of crypted configuration values.
|
|
* Each key corresponds to a configuration context, and contains list of configs names.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $configs = [
|
|
'core' => [
|
|
'glpinetwork_registration_key',
|
|
'proxy_passwd',
|
|
'smtp_passwd',
|
|
]
|
|
];
|
|
|
|
public function __construct() {
|
|
$this->keyfile = GLPI_CONFIG_DIR . '/glpicrypt.key';
|
|
$this->legacykeyfile = GLPI_CONFIG_DIR . '/glpi.key';
|
|
}
|
|
|
|
/**
|
|
* Returns expected key path for given GLPI version.
|
|
* Will return null for GLPI versions that was not yet handling a custom security key.
|
|
*
|
|
* @param string $glpi_version
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getExpectedKeyPath(string $glpi_version): ?string {
|
|
if (version_compare($glpi_version, '9.4.6', '<')) {
|
|
return null;
|
|
} else if (version_compare($glpi_version, '9.5.x', '<')) {
|
|
return $this->legacykeyfile;
|
|
} else {
|
|
return $this->keyfile;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check if GLPI security key used for decryptable passwords exists
|
|
*
|
|
* @return string
|
|
*/
|
|
public function keyExists() {
|
|
return file_exists($this->keyfile) && !empty($this->get());
|
|
}
|
|
|
|
/**
|
|
* Get GLPI security key used for decryptable passwords
|
|
*
|
|
* @throw \RuntimeException if key file is missing
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get() {
|
|
if (!file_exists($this->keyfile)) {
|
|
throw new \RuntimeException('You must create a security key, see glpi:security:change_key command.');
|
|
}
|
|
//load key from existing config file
|
|
$key = file_get_contents($this->keyfile);
|
|
return $key;
|
|
}
|
|
|
|
/**
|
|
* Get GLPI security legacy key that was used for decryptable passwords.
|
|
* Usage of this key should only be used during migration from GLPI < 9.5 to GLPI >= 9.5.0.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getLegacyKey() {
|
|
if (!file_exists($this->legacykeyfile)) {
|
|
return GLPIKEY;
|
|
}
|
|
//load key from existing config file
|
|
$key = file_get_contents($this->legacykeyfile);
|
|
return $key;
|
|
}
|
|
|
|
/**
|
|
* Generate GLPI security key used for decryptable passwords
|
|
* and update values in DB if necessary.
|
|
* @return boolean
|
|
*/
|
|
public function generate() {
|
|
global $DB;
|
|
|
|
// Fetch old key before generating the new one (but only if DB exists and there is something to migrate)
|
|
$sodium_key = null;
|
|
$old_key = false;
|
|
if ($DB instanceof DBmysql) {
|
|
try {
|
|
$sodium_key = $this->get();
|
|
} catch (\RuntimeException $e) {
|
|
$sodium_key = null;
|
|
$old_key = $this->getLegacyKey();
|
|
}
|
|
}
|
|
|
|
$key = sodium_crypto_aead_chacha20poly1305_ietf_keygen();
|
|
$success = (bool)file_put_contents($this->keyfile, $key);
|
|
if (!$success) {
|
|
return false;
|
|
}
|
|
|
|
if ($DB instanceof DBmysql) {
|
|
return $this->migrateFieldsInDb($sodium_key, $old_key)
|
|
&& $this->migrateConfigsInDb($sodium_key, $old_key);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Get fields
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getFields() :array {
|
|
global $PLUGIN_HOOKS;
|
|
|
|
$fields = $this->fields;
|
|
if (isset($PLUGIN_HOOKS['secured_fields'])) {
|
|
foreach ($PLUGIN_HOOKS['secured_fields'] as $plugfields) {
|
|
$fields = array_merge($fields, $plugfields);
|
|
}
|
|
}
|
|
|
|
return $fields;
|
|
}
|
|
|
|
/**
|
|
* Get configs
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getConfigs() :array {
|
|
global $PLUGIN_HOOKS;
|
|
|
|
$configs = $this->configs;
|
|
|
|
if (isset($PLUGIN_HOOKS['secured_configs'])) {
|
|
foreach ($PLUGIN_HOOKS['secured_configs'] as $plugin => $plugconfigs) {
|
|
$configs['plugin:' . $plugin] = $plugconfigs;
|
|
}
|
|
}
|
|
|
|
return $configs;
|
|
}
|
|
|
|
/**
|
|
* Migrate fields in database
|
|
*
|
|
* @param string $sodium_key Current key
|
|
* @param string|false $old_key Old key, if any
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function migrateFieldsInDb($sodium_key, $old_key = false) {
|
|
global $DB;
|
|
|
|
$success = true;
|
|
|
|
foreach ($this->getFields() as $field) {
|
|
list($table, $column) = explode('.', $field);
|
|
|
|
$iterator = $DB->request([
|
|
'SELECT' => ['id', $column],
|
|
'FROM' => $table,
|
|
['NOT' => [$column => null]],
|
|
]);
|
|
|
|
while ($success && $row = $iterator->next()) {
|
|
$value = (string)$row[$column];
|
|
if ($old_key === false) {
|
|
$pass = Toolbox::sodiumEncrypt(Toolbox::sodiumDecrypt($value, $sodium_key));
|
|
} else {
|
|
$pass = Toolbox::sodiumEncrypt($this->decryptUsingLegacyKey($value, $old_key));
|
|
}
|
|
$success = $DB->update(
|
|
$table,
|
|
[$field => $pass],
|
|
['id' => $row['id']]
|
|
);
|
|
}
|
|
}
|
|
|
|
return $success;
|
|
}
|
|
|
|
/**
|
|
* Migrate configurations in database
|
|
*
|
|
* @param string $sodium_key Current key
|
|
* @param string|false $old_key Old key, if any
|
|
*
|
|
* @return boolean
|
|
*/
|
|
protected function migrateConfigsInDb($sodium_key, $old_key = false) {
|
|
global $DB;
|
|
|
|
$success = true;
|
|
|
|
foreach ($this->getConfigs() as $context => $names) {
|
|
$iterator = $DB->request([
|
|
'FROM' => Config::getTable(),
|
|
'WHERE' => [
|
|
'context' => $context,
|
|
'name' => $names,
|
|
['NOT' => ['value' => null]],
|
|
]
|
|
]);
|
|
|
|
while ($success && $row = $iterator->next()) {
|
|
$value = (string)$row['value'];
|
|
if ($old_key === false) {
|
|
$pass = Toolbox::sodiumEncrypt(Toolbox::sodiumDecrypt($value, $sodium_key));
|
|
} else {
|
|
$pass = Toolbox::sodiumEncrypt($this->decryptUsingLegacyKey($value, $old_key));
|
|
}
|
|
$success = $DB->update(
|
|
Config::getTable(),
|
|
['value' => $pass],
|
|
['id' => $row['id']]
|
|
);
|
|
}
|
|
}
|
|
|
|
return $success;
|
|
}
|
|
|
|
/**
|
|
* Decrypt a string using a legacy key.
|
|
* This method does the same as deprecated Toolbox::decrypt() and is only here
|
|
* to handle migration from GLPI < 9.5 to GLPI >= 9.5.0.
|
|
*
|
|
* @param string $string
|
|
* @param string $key
|
|
*
|
|
* @return string
|
|
*/
|
|
public function decryptUsingLegacyKey(string $string, string $key): string {
|
|
|
|
$result = '';
|
|
$string = base64_decode($string);
|
|
|
|
for ($i=0; $i<strlen($string); $i++) {
|
|
$char = substr($string, $i, 1);
|
|
$keychar = substr($key, ($i % strlen($key))-1, 1);
|
|
$char = chr(ord($char)-ord($keychar));
|
|
$result .= $char;
|
|
}
|
|
|
|
return Toolbox::unclean_cross_side_scripting_deep($result);
|
|
}
|
|
}
|