Files
sysPass/lib/SP/Bootstrap.php
nuxsmin ff7e6e3519 * [ADD] Work in progress
* [ADD] Using URL routing
* [ADD] Using dependency injection
* [MOD] Big app structure changes
2017-10-17 02:00:53 +02:00

824 lines
25 KiB
PHP

<?php
/**
* sysPass
*
* @author nuxsmin
* @link http://syspass.org
* @copyright 2012-2017, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
*
* sysPass 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 3 of the License, or
* (at your option) any later version.
*
* sysPass 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 sysPass. If not, see <http://www.gnu.org/licenses/>.
*/
namespace SP;
use Defuse\Crypto\Exception\CryptoException;
use Klein\Klein;
use PHPMailer\PHPMailer\Exception;
use RuntimeException;
use SP\Account\AccountAcl;
use SP\Auth\Browser\Browser;
use SP\Config\Config;
use SP\Config\ConfigData;
use SP\Config\ConfigUtil;
use SP\Core\Session\Session;
use SP\Modules\Web\Controllers\MainController;
use SP\Core\Crypt\CryptSessionHandler;
use SP\Core\Crypt\SecureKeyCookie;
use SP\Core\Dic\DicInterface;
use SP\Core\Exceptions\SPException;
use SP\Core\Language;
use SP\Core\Plugin\PluginUtil;
use SP\Core\SessionFactory;
use SP\Core\SessionUtil;
use SP\Core\Template;
use SP\Core\Traits\InjectableTrait;
use SP\Core\UI\Theme;
use SP\Core\Upgrade\Upgrade;
use SP\Http\JsonResponse;
use SP\Http\Request;
use SP\Log\Email;
use SP\Log\Log;
use SP\Mgmt\Profiles\Profile;
use SP\Core\Exceptions\ConfigException;
use SP\Storage\DBUtil;
use SP\Util\Checks;
use SP\Util\HttpUtil;
use SP\Util\Json;
use SP\Util\Util;
use SP\Core\Crypt\Session as CryptSession;
defined('APP_ROOT') || die();
/**
* Class Bootstrap
*
* @package SP
*/
class Bootstrap
{
use InjectableTrait;
/**
* @var string The installation path on the server (e.g. /srv/www/syspass)
*/
public static $SERVERROOT = '';
/**
* @var string The current request path relative to the sysPass root (e.g. files/index.php)
*/
public static $WEBROOT = '';
/**
* @var string The full URL to reach sysPass (e.g. https://sub.example.com/syspass/)
*/
public static $WEBURI = '';
/**
* @var bool True if sysPass has been updated. Only for notices.
*/
public static $UPDATED = false;
/**
* @var int
*/
public static $LOCK = 0;
/**
* @var string
*/
private static $SUBURI = '';
/**
* @var bool Indica si la versión de PHP es correcta
*/
private static $checkPhpVersion;
/**
* @var bool Indica si el script requiere inicialización
*/
private static $checkInitSourceInclude;
/**
* @var string
*/
private static $sourceScript;
/**
* @var Upgrade
*/
protected $upgrade;
/**
* @var Session
*/
protected $session;
/**
* @var Theme
*/
protected $theme;
/**
* @var Klein
*/
protected $router;
/**
* @var Config
*/
private $config;
/**
* @var ConfigData
*/
private $configData;
/**
* Bootstrap constructor.
*/
public function __construct()
{
$this->injectDependencies();
}
/**
* @return DicInterface
*/
public static function getDic()
{
global $dic;
return $dic;
}
/**
* Comprobar si hay que ejecutar acciones de URL después de realizar login.
*
* @return bool
*/
public function checkPostLoginActions()
{
$action = Request::analyze('a');
if ($action === '') {
return false;
}
$Controller = new MainController();
$Controller->doAction('postlogin.' . $action);
return false;
}
/**
* @param Config $config
* @param Upgrade $upgrade
* @param Session $session
* @param Theme $theme
* @param Klein $router
*/
public function inject(Config $config, Upgrade $upgrade, Session $session, Theme $theme, Klein $router)
{
$this->config = $config;
$this->configData = $config->getConfigData();
$this->upgrade = $upgrade;
$this->session = $session;
$this->theme = $theme;
$this->router = $router;
}
/**
* Comprueba que la aplicación esté instalada
* Esta función comprueba si la aplicación está instalada. Si no lo está, redirige al instalador.
*/
private function checkInstalled()
{
// Redirigir al instalador si no está instalada
if (!$this->configData->isInstalled()) {
if (self::$SUBURI !== '/index.php') {
// FIXME
$this->router->response()->redirect('index.php?r=install');
$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
$url = $protocol . $_SERVER['SERVER_NAME'] . ':' . $_SERVER['SERVER_PORT'] . self::$WEBROOT . '/index.php';
header("Location: $url");
exit();
}
if ($this->session->getAuthCompleted()) {
session_destroy();
$this->initialize();
return;
}
// Comprobar si sysPass está instalada o en modo mantenimiento
$Controller = new MainController();
$Controller->getInstaller();
$Controller->view();
exit();
}
}
/**
* Inicializar la aplicación
*
* @throws \Psr\Container\ContainerExceptionInterface
*/
public function initialize()
{
self::$checkPhpVersion = Checks::checkPhpVersion();
self::$checkInitSourceInclude = $this->checkInitSourceInclude();
if (date_default_timezone_get() === 'UTC') {
date_default_timezone_set('UTC');
}
$this->initRouter();
// Inicializar autentificación
$this->initAuth();
// Inicializar logging
$this->initLogging();
// Cargar las extensiones
// self::loadExtensions();
// Establecer el lenguaje por defecto
Language::setLocales('en_US');
// Establecer las rutas de la aplicación
$this->initPaths();
if (!self::$checkPhpVersion && !self::$checkInitSourceInclude) {
self::initError(
__('Versión de PHP requerida >= ') . ' 5.6.0 <= 7.0',
__('Actualice la versión de PHP para que la aplicación funcione correctamente'));
}
// Comprobar la configuración
$this->initConfig();
// Iniciar la sesión de PHP
$this->initSession($this->configData->isEncryptSession());
// Volver a cargar la configuración si se recarga la página
if (!Request::checkReload()) {
// Cargar la configuración
$this->config->loadConfig();
// Cargar el lenguaje
Language::setLanguage();
} else {
// Cargar la configuración
$this->config->loadConfig(true);
// Restablecer el idioma y el tema visual
Language::setLanguage(true);
$this->theme->initTheme(true);
if ($this->session->isLoggedIn()) {
// Recargar los permisos del perfil de usuario
$this->session->setUserProfile(Profile::getItem()->getById($this->session->getUserData()->getUserProfileId()));
// Reset de los datos de ACL de cuentas
AccountAcl::resetData();
}
}
// Comprobar si es necesario cambiar a HTTPS
HttpUtil::checkHttps();
// Comprobar si es necesario inicialización
if (self::$checkInitSourceInclude ||
((defined('IS_INSTALLER') || defined('IS_UPGRADE')) && Checks::isAjax())
) {
return;
}
// Comprobar si está instalado
$this->checkInstalled();
// Comprobar si el modo mantenimiento está activado
$this->checkMaintenanceMode();
// Comprobar si la Base de datos existe
if (!DBUtil::checkDatabaseExist()) {
self::initError(__('Error en la verificación de la base de datos'));
}
// Comprobar si es necesario actualizar componentes
$this->checkUpgrade();
// Inicializar la sesión
$this->initUserSession();
// Cargar los plugins
PluginUtil::loadPlugins();
// Comprobar acciones en URL
$this->checkPreLoginActions();
if ($this->session->isLoggedIn() && $this->session->getAuthCompleted() === true) {
$AuthBrowser = new Browser();
// Comprobar si se ha identificado mediante el servidor web y el usuario coincide
if ($AuthBrowser->checkServerAuthUser($this->session->getUserData()->getUserLogin()) === false
&& $AuthBrowser->checkServerAuthUser($this->session->getUserData()->getUserSsoLogin()) === false
) {
$this->goLogout();
}
}
$this->router->dispatch();
// El usuario no está logado y no es una petición, redirigir al login
// $this->goLogin();
}
/**
* Comprobar el archivo que realiza el include necesita inicialización.
*
* @returns bool
*/
private function checkInitSourceInclude()
{
self::$sourceScript = pathinfo($_SERVER['SCRIPT_NAME'], PATHINFO_BASENAME);
$skipInit = ['js.php', 'css.php', 'api.php', 'ajax_getEnvironment.php', 'ajax_task.php'];
return in_array(self::$sourceScript, $skipInit, true);
}
/**
* Inicializar router
*/
protected function initRouter()
{
// Update request when we have a subdirectory
// $_SERVER['REQUEST_URI'] = self::$WEBROOT;
$self = $this;
// Manejar URLs con módulo indicado
$this->router->respond(['GET', 'POST'],
'/index.php',
function ($request, $response, $service) use ($self) {
$self->router->onError(function ($router, $err_msg, $type, $err) {
debugLog('Routing error: ' . $err_msg);
/** @var Exception|\Throwable $err */
debugLog('Routing error: ' . formatTrace($err->getTrace()));
});
try {
/** @var \Klein\Request $request */
$route = filter_var($request->param('r', 'index/index'), FILTER_SANITIZE_STRING);
if (!preg_match('/(?P<controller>[a-zA-Z]+)(\/(?P<method>[a-zA-Z]+))?(\/(?P<id>\d+))*/', $route, $components)) {
throw new RuntimeException("Oops, invalid route\n");
}
$controller = $components['controller'];
$method = isset($components['method']) ? $components['method'] . 'Action' : 'indexAction';
$id = isset($components['id']) ? (int)$components['id'] : 0;
$controllerClass = 'SP\\Modules\\' . ucfirst(APP_MODULE) . '\\Controllers\\' . ucfirst($controller) . 'Controller';
if (class_exists($controllerClass)) {
$callableMethod = [new $controllerClass, $method];
if (!is_callable($callableMethod)) {
throw new RuntimeException("Oops, it looks like this content doesn't exist...\n");
}
debugLog('Routing call: ' . $controllerClass . '::' . $method . '::' . $id);
return $callableMethod($id);
}
throw new RuntimeException("Oops, it looks like this content doesn't exist...\n");
} catch (RuntimeException $e) {
debugLog($e->getMessage(), true);
return $e->getMessage();
}
}
);
// Manejar URLs que no empiecen por '/admin'
// $this->Router->respond('GET', '!@^/(admin|public|service)',
// function ($request, $response) {
// /** @var Response $response */
// $response->redirect('index.php');
// }
// );
}
/**
* Establecer variables de autentificación
*/
private function initAuth()
{
// Copiar la cabecera http de autentificación para apache+php-fcgid
if (isset($_SERVER['HTTP_XAUTHORIZATION']) && !isset($_SERVER['HTTP_AUTHORIZATION'])) {
$_SERVER['HTTP_AUTHORIZATION'] = $_SERVER['HTTP_XAUTHORIZATION'];
}
// Establecer las cabeceras de autentificación para apache+php-cgi
if (isset($_SERVER['HTTP_AUTHORIZATION'])
&& preg_match('/Basic\s+(.*)$/i', $_SERVER['HTTP_AUTHORIZATION'], $matches)
) {
list($name, $password) = explode(':', base64_decode($matches[1]), 2);
$_SERVER['PHP_AUTH_USER'] = strip_tags($name);
$_SERVER['PHP_AUTH_PW'] = strip_tags($password);
}
// Establecer las cabeceras de autentificación para que apache+php-cgi funcione si la variable es renombrada por apache
if (isset($_SERVER['REDIRECT_HTTP_AUTHORIZATION'])
&& preg_match('/Basic\s+(.*)$/i', $_SERVER['REDIRECT_HTTP_AUTHORIZATION'], $matches)
) {
list($name, $password) = explode(':', base64_decode($matches[1]), 2);
$_SERVER['PHP_AUTH_USER'] = strip_tags($name);
$_SERVER['PHP_AUTH_PW'] = strip_tags($password);
}
}
/**
* Establecer el nivel de logging
*/
public function initLogging()
{
// Establecer el modo debug si una sesión de xdebug está activa
if (isset($_COOKIE['XDEBUG_SESSION']) && !defined('DEBUG')) {
define('DEBUG', true);
}
if (defined('DEBUG') && DEBUG) {
error_reporting(E_ALL);
ini_set('display_errors', 'On');
} else {
error_reporting(E_ALL & ~(E_DEPRECATED | E_STRICT | E_NOTICE));
ini_set('display_errors', 'Off');
}
if (!file_exists(LOG_FILE) && touch(LOG_FILE) && chmod(LOG_FILE, 0600)) {
debugLog('Setup log file: ' . LOG_FILE);
}
}
/**
* Establecer las rutas de la aplicación.
* Esta función establece las rutas del sistema de archivos y web de la aplicación.
* La variables de clase definidas son $SERVERROOT, $WEBROOT y $SUBURI
*/
private function initPaths()
{
// Calcular los directorios raíz
// $dir = substr(__DIR__, 0, strpos(__DIR__, str_replace('\\', '/', __NAMESPACE__)) - 1);
// self::$SERVERROOT = substr($dir, 0, strripos($dir, DIRECTORY_SEPARATOR));
self::$SERVERROOT = dirname(BASE_PATH);
self::$SUBURI = str_replace("\\", '/', substr(realpath($_SERVER['SCRIPT_FILENAME']), strlen(self::$SERVERROOT)));
$scriptName = isset($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : '';
if (substr($scriptName, -1) === '/') {
$scriptName .= 'index.php';
// Asegurar que suburi sigue las mismas reglas que scriptName
if (substr(self::$SUBURI, -9) !== 'index.php') {
if (substr(self::$SUBURI, -1) !== '/') {
self::$SUBURI .= '/';
}
self::$SUBURI .= 'index.php';
}
}
$pos = strpos($scriptName, self::$SUBURI);
if ($pos === false) {
$pos = strpos($scriptName, '?');
}
self::$WEBROOT = substr($scriptName, 0, $pos);
if (self::$WEBROOT !== '' && self::$WEBROOT[0] !== '/') {
self::$WEBROOT = '/' . self::$WEBROOT;
}
self::$WEBURI = HttpUtil::getHttpHost() . self::$WEBROOT;
}
/**
* Devuelve un error utilizando la plantilla de error o en formato JSON
*
* @param string $message con la descripción del error
* @param string $hint opcional, con una ayuda sobre el error
* @param bool $headers
*/
public static function initError($message, $hint = '', $headers = false)
{
debugLog(__FUNCTION__);
debugLog(__($message));
debugLog(__($hint));
if (Checks::isJson()) {
$JsonResponse = new JsonResponse();
$JsonResponse->setDescription($message);
$JsonResponse->addMessage($hint);
Json::returnJson($JsonResponse);
} elseif ($headers === true) {
header('HTTP/1.1 503 Service Temporarily Unavailable');
header('Status: 503 Service Temporarily Unavailable');
header('Retry-After: 120');
}
SessionUtil::cleanSession();
$Tpl = new Template();
$Tpl->append('errors', ['type' => SPException::SP_CRITICAL, 'description' => __($message), 'hint' => __($hint)]);
$Controller = new MainController($Tpl, 'error', !Checks::isAjax());
$Controller->getError();
}
/**
* Cargar la configuración
*/
private function initConfig()
{
// Comprobar si es una versión antigua
$this->checkConfigVersion();
try {
if (!self::$checkInitSourceInclude) {
ConfigUtil::checkConfigDir();
}
} catch (ConfigException $e) {
self::initError($e->getMessage(), $e->getHint());
}
}
/**
* Comprobar la versión de configuración y actualizarla
*/
private function checkConfigVersion()
{
$appVersion = Util::getVersionStringNormalized();
if (file_exists(CONFIG_FILE) && $this->upgrade->upgradeOldConfigFile($appVersion)) {
$this->logConfigUpgrade($appVersion);
self::$UPDATED = true;
return;
}
$configVersion = Upgrade::fixVersionNumber($this->configData->getConfigVersion());
if ($this->configData->isInstalled()
&& Util::checkVersion($configVersion, Util::getVersionArrayNormalized())
&& $this->upgrade->needConfigUpgrade($configVersion)
&& $this->upgrade->upgradeConfig($configVersion)
) {
$this->logConfigUpgrade($appVersion);
self::$UPDATED = true;
}
}
/**
* Registrar la actualización de la configuración
*
* @param $version
*/
private function logConfigUpgrade($version)
{
$Log = new Log();
$LogMessage = $Log->getLogMessage();
$LogMessage->setAction(__('Actualización', false));
$LogMessage->addDescription(__('Actualización de versión realizada.', false));
$LogMessage->addDetails(__('Versión', false), $version);
$LogMessage->addDetails(__('Tipo', false), 'config');
$Log->writeLog();
Email::sendEmail($LogMessage);
}
/**
* Iniciar la sesión PHP
*
* @param bool $encrypt Encriptar la sesión de PHP
*/
private function initSession($encrypt = false)
{
// Evita que javascript acceda a las cookies de sesion de PHP
ini_set('session.cookie_httponly', '1');
ini_set('session.save_handler', 'files');
if ($encrypt === true) {
$Key = SecureKeyCookie::getKey();
if ($Key !== false && self::$checkPhpVersion) {
session_set_save_handler(new CryptSessionHandler($Key), true);
}
}
// Si la sesión no puede ser iniciada, devolver un error 500
if (session_start() === false) {
Log::writeNewLog(__('Sesión', false), __('La sesión no puede ser inicializada', false));
header('HTTP/1.1 500 Internal Server Error');
self::initError(__('La sesión no puede ser inicializada'), __('Consulte con el administrador'));
}
}
/**
* Comprobar si el modo mantenimiento está activado
* Esta función comprueba si el modo mantenimiento está activado.
* Devuelve un error 503 y un reintento de 120s al cliente.
*
* @param bool $check sólo comprobar si está activado el modo
* @return bool
*/
public function checkMaintenanceMode($check = false)
{
if ($this->configData->isMaintenance()) {
self::$LOCK = Util::getAppLock();
if ($check === true
|| Checks::isAjax()
|| Request::analyze('nodbupgrade', 0) === 1
|| (Request::analyze('a') === 'upgrade' && Request::analyze('type') !== '')
|| (self::$LOCK > 0 && $this->session->isLoggedIn() && self::$LOCK === $this->session->getUserData()->getUserId())
) {
return true;
}
self::initError(__('Aplicación en mantenimiento'), __('En breve estará operativa'));
}
return false;
}
/**
* Comprobar si es necesario actualizar componentes
*
* @throws \Defuse\Crypto\Exception\EnvironmentIsBrokenException
*/
private function checkUpgrade()
{
return self::$SUBURI === '/index.php'
&& ($this->upgrade->checkDbVersion() || $this->upgrade->checkAppVersion());
}
/**
* Inicializar la sesión de usuario
*
*/
private function initUserSession()
{
$lastActivity = SessionFactory::getLastActivity();
$inMaintenance = $this->configData->isMaintenance();
// Timeout de sesión
if ($lastActivity > 0
&& !$inMaintenance
&& (time() - $lastActivity) > $this->getSessionLifeTime()
) {
if (isset($_COOKIE[session_name()])) {
setcookie(session_name(), '', time() - 42000, '/');
}
$this->wrLogoutInfo();
SessionUtil::restart();
return;
}
$sidStartTime = SessionFactory::getSidStartTime();
// Regenerar el Id de sesión periódicamente para evitar fijación
if ($sidStartTime === 0) {
// Intentar establecer el tiempo de vida de la sesión en PHP
@ini_set('session.gc_maxlifetime', $this->getSessionLifeTime());
SessionFactory::setSidStartTime(time());
SessionFactory::setStartActivity(time());
} else if (!$inMaintenance
&& time() - $sidStartTime > 120
&& $this->session->getUserData()->getUserId() > 0
) {
try {
CryptSession::reKey();
// Recargar los permisos del perfil de usuario
$this->session->setUserProfile(Profile::getItem()->getById($this->session->getUserData()->getUserProfileId()));
} catch (CryptoException $e) {
debugLog($e->getMessage());
SessionUtil::restart();
return;
}
}
SessionFactory::setLastActivity(time());
}
/**
* Obtener el timeout de sesión desde la configuración.
*
* @return int con el tiempo en segundos
*/
private function getSessionLifeTime()
{
$timeout = SessionFactory::getSessionTimeout();
if (null === $timeout) {
$configTimeout = $this->configData->getSessionTimeout();
SessionFactory::setSessionTimeout($configTimeout);
return $configTimeout;
}
return $timeout;
}
/**
* Escribir la información de logout en el registro de eventos.
*/
private function wrLogoutInfo()
{
$inactiveTime = abs(round((time() - SessionFactory::getLastActivity()) / 60, 2));
$totalTime = abs(round((time() - SessionFactory::getStartActivity()) / 60, 2));
$Log = new Log();
$LogMessage = $Log->getLogMessage();
$LogMessage->setAction(__('Finalizar sesión', false));
$LogMessage->addDetails(__('Usuario', false), $this->session->getUserData()->getUserLogin());
$LogMessage->addDetails(__('Tiempo inactivo', false), $inactiveTime . ' min.');
$LogMessage->addDetails(__('Tiempo total', false), $totalTime . ' min.');
$Log->writeLog();
}
/**
* Comprobar si hay que ejecutar acciones de URL antes de presentar la pantalla de login.
*
* @return bool
*/
public function checkPreLoginActions()
{
$action = Request::analyze('a');
if ($action === '') {
return false;
}
$Controller = new MainController();
$Controller->doAction('prelogin.' . $action);
return true;
}
/**
* Deslogar el usuario actual y eliminar la información de sesión.
*/
private function goLogout()
{
$this->wrLogoutInfo();
SessionUtil::cleanSession();
SessionFactory::setLoggedOut(true);
$Controller = new MainController();
$Controller->getLogout();
}
/**
* Comprobar si es necesario cerrar la sesión
*/
private function checkLogout()
{
if (Request::analyze('logout', false, true)) {
$this->goLogout();
}
}
/**
* Mostrar la página de login
*/
private function goLogin()
{
SessionUtil::cleanSession();
$Controller = new MainController();
$Controller->getLogin();
}
}