Issues in Application.php (master) - Issues in master - DonUrks/phrest - Measure and Improve Code Quality continuously with Scrutinizer

Issues (4)

Security Analysis no request data

File Inclusion

File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.

Regex Injection

Regex Injection enables an attacker to execute arbitrary code in your PHP process.

SQL Injection

SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.

Response Splitting

Response Splitting can be used to send arbitrary responses.

File Manipulation

File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.

Object Injection

Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.

File Exposure

File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.

XML Injection

XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.

Code Injection

Code Injection enables an attacker to execute arbitrary code on the server.

Variable Injection

Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.

XPath Injection

XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.

Other Vulnerability

This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.

Command Injection

Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.

LDAP Injection

LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.

Cross-Site Scripting

Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.

Header Injection

Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.

src/Phrest/Application.php (1 issue)

Labels

Deprecated Code 1

Severity

Minor 1

<?php

namespace Phrest;

use Zend\ConfigAggregator\PhpFileProvider;
use Zend\ConfigAggregator\ArrayProvider;
use Zend\ConfigAggregator\ConfigAggregator;

use Zend\ServiceManager\Config;
use Zend\ServiceManager\ServiceManager;

class Application
{
    const DEFAULT_CONFIG_DIRECTORY_PATTERN = 'config/{{,*.}global,{,*.}local}.php';
    const USER_CONFIG = 'phrest_user_config';

    const CONFIG_SWAGGER_SCAN_DIRECTORY = 'phrest_config_swagger_scan_directory';
    const CONFIG_ENABLE_CACHE = 'phrest_config_enable_cache';
    const CONFIG_CACHE_DIRECTORY = 'phrest_config_cache_directory';
    const CONFIG_MONOLOG_HANDLER = 'phrest_config_monolog_handler';
    const CONFIG_MONOLOG_PROCESSOR = 'phrest_config_monolog_processor';
    const CONFIG_PRE_ROUTING_MIDDLEWARE = 'phrest_config_pre_routing_middleware';
    const CONFIG_PRE_DISPATCHING_MIDDLEWARE = 'phrest_config_pre_dispatching_middleware';
    const CONFIG_ROUTES = 'phrest_config_routes';
    const CONFIG_DEPENDENCIES = 'phrest_config_dependencies';
    const CONFIG_ERROR_CODES = 'phrest_config_error_codes';

    const ACTION_SWAGGER = 'phrest_action_swagger';
    const ACTION_ERROR_CODES = 'phrest_action_error_codes';

    const SERVICE_LOGGER = 'phrest_service_logger';
    const SERVICE_ROUTER = 'phrest_service_router';
    const SERVICE_SWAGGER = 'phrest_service_swagger';
    const SERVICE_HATEOAS = 'phrest_service_hateoas';
    const SERVICE_HATEOAS_RESPONSE_GENERATOR = 'phrest_service_hateoas_response_generator';
    const SERVICE_REQUEST_SWAGGER_VALIDATOR = 'phrest_service_request_swagger_validator';

    static public function run(
        string $applicationName = 'phrest-application',
        string $configDirectoryPattern = self::DEFAULT_CONFIG_DIRECTORY_PATTERN,
        ?\Psr\Http\Message\ServerRequestInterface $request = null
    )
    {
        $logger = new \Monolog\Logger($applicationName, [new \Monolog\Handler\StreamHandler('php://stdout')]);
        \Monolog\ErrorHandler::register($logger);

        $userConfigAggregator = new ConfigAggregator([
            new PhpFileProvider($configDirectoryPattern),
        ]);
        $userConfig = $userConfigAggregator->getMergedConfig();

        $swaggerScanDirectory = (string)($userConfig[\Phrest\Application::CONFIG_SWAGGER_SCAN_DIRECTORY] ?? null);

        $enableCache = (boolean)($userConfig[\Phrest\Application::CONFIG_ENABLE_CACHE] ?? false);
        $cacheDirectory = $userConfig[\Phrest\Application::CONFIG_CACHE_DIRECTORY] ?? null;

        $monologHandler = $userConfig[\Phrest\Application::CONFIG_MONOLOG_HANDLER] ?? [];
        $monologProcessor = $userConfig[\Phrest\Application::CONFIG_MONOLOG_PROCESSOR] ?? [];

        $errorCodes = $userConfig[\Phrest\Application::CONFIG_ERROR_CODES] ?? null;

        $cache = self::createCache($enableCache, $cacheDirectory);

        $internalConfigAggregator = new ConfigAggregator([
            new ArrayProvider([
                'dependencies' => $userConfig[\Phrest\Application::CONFIG_DEPENDENCIES] ?? []
            ]),
            new ArrayProvider([
                ConfigAggregator::ENABLE_CACHE => $enableCache,
                'zend-expressive' => [
                    'programmatic_pipeline' => true,
                ],
                'dependencies' => [
                    'factories' => [
                        \Zend\Expressive\Helper\UrlHelper::class => \Zend\Expressive\Helper\UrlHelperFactory::class,

                        \Phrest\Application::SERVICE_LOGGER => function (\Interop\Container\ContainerInterface $container) use ($logger, $monologHandler, $monologProcessor) {
                            $handlers = [];
                            foreach ($monologHandler as $handler) {
                                $handlers[] = $container->get($handler);
                            }
                            foreach ($monologProcessor as $processor) {
                                $logger->pushProcessor($container->get($processor));
                            }
                            $logger->setHandlers($handlers);
                            return $logger;
                        },

                        \Phrest\Application::SERVICE_SWAGGER => function () use ($cache, $swaggerScanDirectory) {
                            return new \Phrest\Swagger($cache, $swaggerScanDirectory);
                        },

                        \Phrest\Application::SERVICE_HATEOAS => function (\Interop\Container\ContainerInterface $container) use ($enableCache, $cacheDirectory) {
                            /** @var \Zend\Expressive\Router\RouterInterface $router */
                            $router = $container->get(\Zend\Expressive\Router\RouterInterface::class);

                            /** @var \Zend\Expressive\Helper\ServerUrlHelper $serverUrlHelper */
                            $serverUrlHelper = $container->get(\Zend\Expressive\Helper\ServerUrlHelper::class);

                            /* @todo registerLoader is deprecated! */
                            \Doctrine\Common\Annotations\AnnotationRegistry::registerLoader('class_exists');
                            /** @scrutinizer ignore-deprecated */ \Doctrine\Common\Annotations\AnnotationRegistry::registerLoader('class_exists');
                            $hateoasBuilder = \Hateoas\HateoasBuilder::create();
                            if ($enableCache) {
                                $hateoasBuilder->setCacheDir($cacheDirectory);
                            }
                            $hateoasBuilder->setUrlGenerator(
                                null,
                                new \Hateoas\UrlGenerator\CallableUrlGenerator(
                                    function ($route, array $parameters, $absolute) use ($router, $serverUrlHelper) {
                                        $uri = $router->generateUri($route, $parameters);
                                        if ($absolute) {
                                            return $serverUrlHelper($uri);
                                        }
                                        return $uri;
                                    }
                                )
                            );
                            return $hateoasBuilder->build();
                        },

                        \Phrest\Application::ACTION_SWAGGER => function (\Interop\Container\ContainerInterface $container) {
                            return new \Phrest\API\Action\Swagger($container->get(\Phrest\Application::SERVICE_SWAGGER));
                        },

                        \Phrest\Application::ACTION_ERROR_CODES => function (\Interop\Container\ContainerInterface $container) use ($cache, $errorCodes) {
                            if ($errorCodes) {
                                $errorCodesInstance = $container->get($errorCodes);
                            } else {
                                $errorCodesInstance = new API\ErrorCodes();
                            }
                            return new \Phrest\API\Action\ErrorCodes($cache, $errorCodesInstance);
                        },

                        \Phrest\Application::SERVICE_HATEOAS_RESPONSE_GENERATOR => function (\Interop\Container\ContainerInterface $container) {
                            return new \Phrest\API\HateoasResponseGenerator(
                                $container->get(\Phrest\Application::SERVICE_HATEOAS)
                            );
                        },

                        \Phrest\Application::SERVICE_REQUEST_SWAGGER_VALIDATOR => function (\Interop\Container\ContainerInterface $container) {
                            /** @var \Phrest\Swagger $swagger */
                            $swagger = $container->get(\Phrest\Application::SERVICE_SWAGGER);
                            $jsonValidator = new \JsonSchema\Validator(
                                new \JsonSchema\Constraints\Factory($swagger->getSchemaStorage())
                            );
                            return new \Phrest\API\RequestSwaggerValidator($swagger, $jsonValidator);
                        },

                        \Phrest\Application::SERVICE_ROUTER => function () {
                            return new \Zend\Expressive\Router\FastRouteRouter();
                        },

                        \Zend\Expressive\Router\RouterInterface::class => function (\Interop\Container\ContainerInterface $container) {
                            return $container->get(\Phrest\Application::SERVICE_ROUTER);
                        }
                    ],
                    'invokables' => [
                        \Zend\Expressive\Helper\ServerUrlHelper::class => \Zend\Expressive\Helper\ServerUrlHelper::class
                    ],
                    'initializers' => [
                        \Psr\Log\LoggerAwareInterface::class => function (\Interop\Container\ContainerInterface $container, $service) {
                            if ($service instanceof \Psr\Log\LoggerAwareInterface) {
                                $service->setLogger(
                                    $container->get(\Phrest\Application::SERVICE_LOGGER)
                                );
                            }
                        },
                        API\RequestSwaggerValidatorAwareInterface::class => function (\Interop\Container\ContainerInterface $container, $service) {
                            if ($service instanceof API\RequestSwaggerValidatorAwareInterface) {
                                $service->setRequestSwaggerValidator(
                                    $container->get(\Phrest\Application::SERVICE_REQUEST_SWAGGER_VALIDATOR)
                                );
                            }
                        },
                        API\HateoasResponseGeneratorAwareInterface::class => function (\Interop\Container\ContainerInterface $container, $service) {
                            if ($service instanceof API\HateoasResponseGeneratorAwareInterface) {
                                $service->setHateoasResponseGenerator(
                                    $container->get(\Phrest\Application::SERVICE_HATEOAS_RESPONSE_GENERATOR)
                                );
                            }
                        },
                    ]
                ]
            ]),
        ]);

        $container = self::createContainer(
            $internalConfigAggregator->getMergedConfig(),
            $userConfig
        );

        // Register logging handler / processors - can only happen after loaded user dependencies
        $container->get(\Phrest\Application::SERVICE_LOGGER);

        $app = new \Zend\Expressive\Application($container->get(\Zend\Expressive\Router\RouterInterface::class), $container);

        self::registerRoutes($app, $userConfig[\Phrest\Application::CONFIG_ROUTES] ?? []);
        self::pipeMiddleware(
            $app,
            $userConfig[\Phrest\Application::CONFIG_PRE_ROUTING_MIDDLEWARE] ?? [],
            $userConfig[\Phrest\Application::CONFIG_PRE_DISPATCHING_MIDDLEWARE] ?? []
        );

        $logger->debug('application init completed', ['userConfig' => $userConfig]);

        $app->run($request);
    }

    static function createCache(bool $enableCache, ?string $cacheDirectory): \Zend\Cache\Storage\StorageInterface
    {
        $cache = new \Zend\Cache\Storage\Adapter\BlackHole();
        if ($enableCache) {
            $cache = new \Zend\Cache\Storage\Adapter\Filesystem();
            $cache->setOptions([
                'cache_dir' => $cacheDirectory,
                'ttl' => 0
            ]);
        }
        return $cache;
    }

    static function createContainer(array $internalConfig, array $userConfig): \Interop\Container\ContainerInterface
    {
        $container = new ServiceManager();
        (new Config($internalConfig['dependencies'] ?? []))->configureServiceManager($container);
        $container->setService(self::USER_CONFIG, $userConfig);
        return $container;
    }

    static private function registerRoutes(\Zend\Expressive\Application $app, array $routes)
    {
        foreach ($routes as $name => $routeConfig) {
            $route = $app->route($routeConfig['path'], $routeConfig['action'], ['GET', 'POST', 'PUT', 'DELETE', 'PATCH'], $name);
            $route->setOptions([
                'operationIds' => $routeConfig['operationIds'] ?? []
            ]);
        }
    }

    static private function pipeMiddleware(\Zend\Expressive\Application $app, array $preRoutingMiddleware, array $preDispatchingMiddleware)
    {
        $container = $app->getContainer();
        $logger = $container->get(\Phrest\Application::SERVICE_LOGGER);

        $app->pipe(array_merge(
            [
                new \Phrest\Middleware\Error($logger),
                new \Phrest\Middleware\HttpException($logger),
                new \Zend\Expressive\Helper\ServerUrlMiddleware($container->get(\Zend\Expressive\Helper\ServerUrlHelper::class)),
                new \Phrest\Middleware\JsonRequestBody()
            ],
            $preRoutingMiddleware,
            [
                \Zend\Expressive\Application::ROUTING_MIDDLEWARE,
                new \Zend\Expressive\Helper\UrlHelperMiddleware($container->get(\Zend\Expressive\Helper\UrlHelper::class))
            ],
            $preDispatchingMiddleware,
            [
                \Zend\Expressive\Application::DISPATCH_MIDDLEWARE,
                new \Phrest\Middleware\NotFound()
            ]
        ));
    }

    static public function createRoute(string $path, string $action, array $operationIds = []): array
    {
        return [
            'path' => $path,
            'action' => $action,
            'operationIds' => $operationIds
        ];
    }
}


DonUrks / phrest

Issues (4)

Security Analysis no request data

src/Phrest/Application.php (1 issue)

Labels

Severity

Introduced By

Duplication Side-by-Side

Filter issues like