Files
sysPass/lib/SP/Bootstrap.php
Rubén D ebe58282f6 * [ADD] Test API module without using a real sysPass instance.
* [MOD] Improve module loading.
* [MOD] Improve backup file regex.
* [MOD] Minor code tweaks.

Signed-off-by: Rubén D <nuxsmin@syspass.org>
2021-10-17 16:26:39 +02:00

534 lines
16 KiB
PHP

<?php
/*
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2021, 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 Closure;
use DI\Container;
use DI\DependencyException;
use DI\NotFoundException;
use Klein\Klein;
use Klein\Response;
use PHPMailer\PHPMailer\Exception;
use Psr\Container\ContainerInterface;
use RuntimeException;
use SP\Config\ConfigDataInterface;
use SP\Config\ConfigUtil;
use SP\Core\Exceptions\InitializationException;
use SP\Core\Exceptions\SessionTimeout;
use SP\Core\Language;
use SP\Core\PhpExtensionChecker;
use SP\Http\Request;
use SP\Modules\Api\Init as InitApi;
use SP\Modules\Cli\Init as InitCli;
use SP\Modules\Web\Init as InitWeb;
use SP\Plugin\PluginManager;
use SP\Services\Api\ApiRequest;
use SP\Services\Api\JsonRpcResponse;
use SP\Services\Upgrade\UpgradeConfigService;
use SP\Services\Upgrade\UpgradeUtil;
use SP\Util\Checks;
use SP\Util\Filter;
use SP\Util\VersionUtil;
use Symfony\Component\Debug\Debug;
use Throwable;
defined('APP_ROOT') || die();
/**
* Class Bootstrap
*
* @package SP
*/
final class Bootstrap
{
private const OOPS_MESSAGE = "Oops, it looks like this content does not exist...";
/**
* @var string The current request path relative to the sysPass root (e.g. files/index.php)
*/
public static string $WEBROOT = '';
/**
* @var string The full URL to reach sysPass (e.g. https://sub.example.com/syspass/)
*/
public static string $WEBURI = '';
/**
* @var string
*/
public static string $SUBURI = '';
/**
* @var mixed
*/
public static $LOCK;
/**
* @var bool Indica si la versión de PHP es correcta
*/
public static bool $checkPhpVersion = false;
private static ContainerInterface $container;
private Klein $router;
private Request $request;
private ConfigDataInterface $configData;
/**
* Bootstrap constructor.
*/
public function __construct(ContainerInterface $container)
{
self::$container = $container;
// Set the default language
Language::setLocales('en_US');
$this->configData = $container->get(ConfigDataInterface::class);
$this->router = $container->get(Klein::class);
$this->request = $container->get(Request::class);
$this->initRouter();
}
protected function initRouter(): void
{
$this->router->onError(function ($router, $err_msg, $type, $err) {
logger('Routing error: ' . $err_msg);
/** @var Exception|Throwable $err */
logger('Routing error: ' . $err->getTraceAsString());
/** @var Klein $router */
$router->response()->body(__($err_msg));
});
// Manage requests for options
$this->router->respond(
'OPTIONS',
null,
$this->manageCorsRequest()
);
// Manage requests for api module
$this->router->respond(
'POST',
'@/api\.php',
$this->manageApiRequest()
);
// Manage requests for web module
$this->router->respond(
['GET', 'POST'],
'@(?!/api\.php)',
$this->manageWebRequest()
);
}
private function manageCorsRequest(): Closure
{
return function ($request, $response) {
/** @var \Klein\Request $request */
/** @var \Klein\Response $response */
$this->setCors($response);
};
}
private function setCors(Response $response): void
{
$response->header(
'Access-Control-Allow-Origin',
$this->configData->getApplicationUrl()
?? $this->request->getHttpHost()
);
$response->header(
'Access-Control-Allow-Headers',
'X-Requested-With, Content-Type, Accept, Origin, Authorization'
);
$response->header('Access-Control-Allow-Methods', 'GET, POST, OPTIONS');
}
private function manageApiRequest(): Closure
{
return function ($request, $response, $service) {
try {
logger('API route');
$apiRequest = self::$container->get(ApiRequest::class);
[$controllerName, $action] = explode('/', $apiRequest->getMethod());
$controllerClass = self::getControllerClass($controllerName);
$method = $action . 'Action';
if (!method_exists($controllerClass, $method)) {
logger($controllerClass . '::' . $method);
/** @var Response $response */
$response->headers()
->set(
'Content-type',
'application/json; charset=utf-8'
);
return $response->body(
JsonRpcResponse::getResponseError(
self::OOPS_MESSAGE,
JsonRpcResponse::METHOD_NOT_FOUND,
$apiRequest->getId()
)
);
}
$this->initializeCommon();
self::$container->get(InitApi::class)
->initialize($controllerName);
logger('Routing call: ' . $controllerClass . '::' . $method);
return call_user_func([new $controllerClass(self::$container, $method), $method]);
} catch (\Exception $e) {
processException($e);
/** @var Response $response */
$response->headers()->set('Content-type', 'application/json; charset=utf-8');
return $response->body(JsonRpcResponse::getResponseException($e, 0));
} finally {
$this->router->skipRemaining();
}
};
}
private static function getControllerClass(string $controllerName): string
{
return sprintf(
'SP\Modules\%s\Controllers\%sController',
ucfirst(APP_MODULE),
ucfirst($controllerName)
);
}
/**
* @throws \SP\Core\Exceptions\CheckException
* @throws \SP\Core\Exceptions\ConfigException
* @throws \SP\Core\Exceptions\InitializationException
* @throws \SP\Services\Upgrade\UpgradeException
* @throws \SP\Storage\File\FileException
*/
protected function initializeCommon(): void
{
logger(__FUNCTION__);
self::$checkPhpVersion = Checks::checkPhpVersion();
// Initialize authentication variables
$this->initAuthVariables();
// Initialize logging
$this->initPHPVars();
// Set application paths
$this->initPaths();
self::$container->get(PhpExtensionChecker::class)->checkMandatory();
if (!self::$checkPhpVersion) {
throw new InitializationException(
sprintf(__('Required PHP version >= %s <= %s'), '7.4', '8.0'),
Core\Exceptions\SPException::ERROR,
__u('Please update the PHP version to run sysPass')
);
}
// Check and intitialize configuration
$this->initConfig();
}
/**
* Establecer variables de autentificación
*/
private function initAuthVariables(): void
{
$server = $this->router->request()->server();
// Copiar la cabecera http de autentificación para apache+php-fcgid
if ($server->get('HTTP_XAUTHORIZATION') !== null
&& $server->get('HTTP_AUTHORIZATION') === null) {
$server->set('HTTP_AUTHORIZATION', $server->get('HTTP_XAUTHORIZATION'));
}
// Establecer las cabeceras de autentificación para apache+php-cgi
// Establecer las cabeceras de autentificación para que apache+php-cgi funcione si la variable es renombrada por apache
if (($server->get('HTTP_AUTHORIZATION') !== null
&& preg_match(
'/Basic\s+(.*)$/i',
$server->get('HTTP_AUTHORIZATION'),
$matches))
|| ($server->get('REDIRECT_HTTP_AUTHORIZATION') !== null
&& preg_match(
'/Basic\s+(.*)$/i',
$server->get('REDIRECT_HTTP_AUTHORIZATION'),
$matches))
) {
[$name, $password] = explode(':',
base64_decode($matches[1]),
2);
$server->set('PHP_AUTH_USER', strip_tags($name));
$server->set('PHP_AUTH_PW', strip_tags($password));
}
}
/**
* Establecer el nivel de logging
*/
public function initPHPVars(): void
{
if (defined('DEBUG') && DEBUG) {
/** @noinspection ForgottenDebugOutputInspection */
Debug::enable();
} else if (!defined('DEBUG')
&& ($this->router->request()->cookies()->get('XDEBUG_SESSION')
|| $this->configData->isDebug())
) {
define('DEBUG', true);
/** @noinspection ForgottenDebugOutputInspection */
Debug::enable();
} else {
error_reporting(E_ALL & ~(E_DEPRECATED | E_STRICT | E_NOTICE));
if (!headers_sent()) {
ini_set('display_errors', 0);
}
}
if (!file_exists(LOG_FILE)
&& touch(LOG_FILE)
&& chmod(LOG_FILE, 0600)
) {
logger('Setup log file: ' . LOG_FILE);
}
if (date_default_timezone_get() === 'UTC') {
date_default_timezone_set('UTC');
}
if (!headers_sent()) {
// Avoid PHP session cookies from JavaScript
ini_set('session.cookie_httponly', '1');
ini_set('session.save_handler', 'files');
}
}
/**
* Establecer las rutas de la aplicación.
* Esta función establece las rutas del sistema de archivos y web de la aplicación.
* Las variables de clase definidas son $SERVERROOT, $WEBROOT y $SUBURI
*/
private function initPaths(): void
{
self::$SUBURI = '/' . basename($this->request->getServer('SCRIPT_FILENAME'));
$uri = $this->request->getServer('REQUEST_URI');
$pos = strpos($uri, self::$SUBURI);
if ($pos > 0) {
self::$WEBROOT = substr($uri, 0, $pos);
}
self::$WEBURI = $this->request->getHttpHost() . self::$WEBROOT;
}
/**
* Cargar la configuración
*
* @throws \SP\Core\Exceptions\ConfigException
* @throws \SP\Services\Upgrade\UpgradeException
*/
private function initConfig(): void
{
$this->checkConfigVersion();
ConfigUtil::checkConfigDir();
}
/**
* Comprobar la versión de configuración y actualizarla
*
* @throws \SP\Services\Upgrade\UpgradeException
*/
private function checkConfigVersion(): void
{
// Do not check config version when testing
if (IS_TESTING) {
return;
}
if (defined('OLD_CONFIG_FILE')
&& file_exists(OLD_CONFIG_FILE)) {
$upgradeConfigService = self::$container->get(UpgradeConfigService::class);
$upgradeConfigService->upgradeOldConfigFile(VersionUtil::getVersionStringNormalized());
}
$configVersion = UpgradeUtil::fixVersionNumber($this->configData->getConfigVersion());
if ($this->configData->isInstalled()
&& UpgradeConfigService::needsUpgrade($configVersion)
) {
$upgradeConfigService = self::$container->get(UpgradeConfigService::class);
$upgradeConfigService->upgrade($configVersion, $this->configData);
}
}
private function manageWebRequest(): Closure
{
return function ($request, $response, $service) {
/** @var \Klein\Request $request */
/** @var \Klein\Response $response */
try {
logger('WEB route');
/** @var \Klein\Request $request */
$route = Filter::getString($request->param('r', 'index/index'));
if (!preg_match_all(
'#(?P<controller>[a-zA-Z]+)(?:/(?P<action>[a-zA-Z]+))?(?P<params>(/[a-zA-Z\d.]+)+)?#',
$route,
$matches
)) {
throw new RuntimeException(self::OOPS_MESSAGE);
}
$controllerName = $matches['controller'][0];
$methodName = empty($matches['action'][0])
? 'indexAction'
: $matches['action'][0] . 'Action';
$methodParams = empty($matches['params'][0])
? []
: Filter::getArray(explode(
'/',
trim($matches['params'][0],
'/')
));
$controllerClass = self::getControllerClass($controllerName);
$this->initializePluginClasses();
if (!method_exists($controllerClass, $methodName)) {
logger($controllerClass . '::' . $methodName);
$response->code(404);
throw new RuntimeException(self::OOPS_MESSAGE);
}
$this->setCors($response);
$this->initializeCommon();
if (APP_MODULE === 'web') {
self::$container->get(InitWeb::class)
->initialize($controllerName);
}
logger(sprintf(
'Routing call: %s::%s::%s',
$controllerClass,
$methodName,
print_r($methodParams, true)
));
$controller = new $controllerClass(self::$container, $methodName);
return call_user_func_array([$controller, $methodName], $methodParams);
} catch (SessionTimeout $sessionTimeout) {
logger('Session timeout');
} catch (\Exception $e) {
processException($e);
/** @var Response $response */
if ($response->status()->getCode() !== 404) {
$response->code(503);
}
return __($e->getMessage());
}
};
}
protected function initializePluginClasses(): void
{
PluginManager::getPlugins();
}
public static function getContainer(): ContainerInterface
{
return self::$container;
}
/**
* @throws InitializationException
* @throws DependencyException
* @throws NotFoundException
* @throws Core\Context\ContextException
*/
public static function run(
Container $container,
string $module = APP_MODULE
): void
{
switch ($module) {
case 'web':
logger('------------');
logger('Boostrap:web');
$bs = new Bootstrap($container);
$bs->router->dispatch($bs->request->getRequest());
break;
case 'api':
logger('------------');
logger('Boostrap:api');
$bs = new Bootstrap($container);
$bs->router->dispatch($bs->request->getRequest());
break;
case 'cli':
logger('------------');
logger('Boostrap:cli');
$cli = $container->get(InitCli::class);
$cli->initialize('');
break;
default;
throw new InitializationException('Unknown module');
}
}
public function getRouter(): Klein
{
return $this->router;
}
}