Issues in PhpRenderer.php (master) - Issues in master - GermaniaKG/Renderer - Measure and Improve Code Quality continuously with Scrutinizer

Issues (6)

Security Analysis no request data

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.

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.

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.

Code Injection

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

Response Splitting

Response Splitting can be used to send arbitrary responses.

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.

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.

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.

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.

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.

Header Injection

Other Vulnerability

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

Regex Injection

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

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.

Variable Injection

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

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/PhpRenderer.php (1 issue)

Labels

Severity

Major 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
namespace Germania\Renderer;

use \Psr\Log\LoggerInterface;
use \Psr\Log\LoggerAwareTrait;
use \Psr\Log\LoggerAwareInterface;
use \Psr\Log\NullLogger;
use Psr\Http\Message\ResponseInterface;



class PhpRenderer implements RendererInterface, LoggerAwareInterface {

    use LoggerAwareTrait;

    /**
     * @var string[]
     */
    public $base_path;


    /**
     * @param string|string[]|null $base_path Optional: Base path. Defaults to PHP's getcwd()'.
     * @param LoggerInterface|null $logger Optional: PSR-3 Logger
     */
    public function __construct ( $base_path = null, LoggerInterface $logger = null )
    {

        if (is_string($base_path) or !$base_path):
            $this->base_path = array($base_path ?: getcwd());
        else:
            $this->base_path = $base_path;
        endif;

        $this->setLogger( $logger ?: new NullLogger );
    }


    /**
     * Returns parsed template output.
     *
     * @param  string   $template The template file
     * @param  array    $context  Associative tempalte variables array
     * @param  Callable $callable Optional Callback handler for output buffering
     *
     * @return string|ResponseInterface   Template output or ResponseInterface instance
     *
     * @throws RuntimeException when include file is not readable somehow.
     */
    public function __invoke( $inc, array $context = array(), Callable $callback = null)
    {
        $this->logger->info("Render PHP include file: " . $inc, [
            'context'   => $context,
            'callback'  => $callback ?: "(not set)",
            'base_path' => $this->base_path
        ]);


        // Blank message
        $error_message = false;

        // Build path based on base path
        $path = $this->buildPath( $inc );

        if (is_readable( $path )):

            $this->logger->debug("Extract variables to include scope", $context);
            extract( $context );

            $this->logger->debug("Start output buffer");
            ob_start( $callback );

            $this->logger->debug("Include PHP file " . $inc);
            $result = include $path;


            $content_length = ob_get_length();


            if ($result instanceOf ResponseInterface):

                $this->logger->debug("Included PHP file returned ResponseInterface instance", [
                    'file' => $inc,
                    'ResponseInterface' => get_class( $result )
                ]);

                if ($echo_result = ob_get_clean()):
                    $this->logger->warning("Include file should not fill output buffer (echo et.al.) when returning ResponseInterface instance. To avoid data loss, content from output buffer is appended to ResponseInterface instance's body stream.", [
                        'file' => $inc,
                        'content_length' => $content_length
                    ]);
                    $result->getBody()->write( $echo_result );
                endif;


                // Return ResponseInterface
                $this->logger->info("Return ResponseInterface instance", [
                    'file' => $inc,
                    'ResponseInterface' => get_class( $result )
                ]);
                return $result;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            endif;



            // Return string
            $this->logger->info("Return include file output from output buffer", [
                'file' => $inc,
                'content_length' => $content_length
            ]);
            return ob_get_clean();

        elseif ($path === false):
            $error_message  = "PhpRenderer: Could not find include in any base path.";
        elseif (!is_file($path)):
            $error_message  = "PhpRenderer: Include file does not exist: " . ($path ?: "(none)");
        else:
            $error_message = "PhpRenderer: Include file not readable: " . ($path ?: "(none)");
        endif;

        if (!empty($error_message) and is_string( $error_message )):
            $this->logger->error( $error_message );
            throw new \RuntimeException( $error_message );
        endif;

    }


    /**
     * @param  string $inc The file to locate
     * @return string      Full path
     */
    public function buildPath( $inc )
    {
        foreach($this->base_path as $path):
            if ($file = realpath(join(\DIRECTORY_SEPARATOR, [$path, $inc ]))) {
                return $file;
            }
        endforeach;

        return false;
    }
}


1			<?php
2			namespace Germania\Renderer;
3
4			use \Psr\Log\LoggerInterface;
5			use \Psr\Log\LoggerAwareTrait;
6			use \Psr\Log\LoggerAwareInterface;
7			use \Psr\Log\NullLogger;
8			use Psr\Http\Message\ResponseInterface;
9
10
11
12			class PhpRenderer implements RendererInterface, LoggerAwareInterface {
13
14			use LoggerAwareTrait;
15
16			/**
17			* @var string[]
18			*/
19			public $base_path;
20
21
22			/**
23			* @param string\|string[]\|null $base_path Optional: Base path. Defaults to PHP's getcwd()'.
24			* @param LoggerInterface\|null $logger Optional: PSR-3 Logger
25			*/
26			public function __construct ( $base_path = null, LoggerInterface $logger = null )
27			{
28
29			if (is_string($base_path) or !$base_path):
30			$this->base_path = array($base_path ?: getcwd());
31			else:
32			$this->base_path = $base_path;
33			endif;
34
35			$this->setLogger( $logger ?: new NullLogger );
36			}
37
38
39			/**
40			* Returns parsed template output.
41			*
42			* @param string $template The template file
43			* @param array $context Associative tempalte variables array
44			* @param Callable $callable Optional Callback handler for output buffering
45			*
46			* @return string\|ResponseInterface Template output or ResponseInterface instance
47			*
48			* @throws RuntimeException when include file is not readable somehow.
49			*/
50			public function __invoke( $inc, array $context = array(), Callable $callback = null)
51			{
52			$this->logger->info("Render PHP include file: " . $inc, [
53			'context' => $context,
54			'callback' => $callback ?: "(not set)",
55			'base_path' => $this->base_path
56			]);
57
58
59			// Blank message
60			$error_message = false;
61
62			// Build path based on base path
63			$path = $this->buildPath( $inc );
64
65			if (is_readable( $path )):
66
67			$this->logger->debug("Extract variables to include scope", $context);
68			extract( $context );
69
70			$this->logger->debug("Start output buffer");
71			ob_start( $callback );
72
73			$this->logger->debug("Include PHP file " . $inc);
74			$result = include $path;
75
76
77			$content_length = ob_get_length();
78
79
80			if ($result instanceOf ResponseInterface):
81
82			$this->logger->debug("Included PHP file returned ResponseInterface instance", [
83			'file' => $inc,
84			'ResponseInterface' => get_class( $result )
85			]);
86
87			if ($echo_result = ob_get_clean()):
88			$this->logger->warning("Include file should not fill output buffer (echo et.al.) when returning ResponseInterface instance. To avoid data loss, content from output buffer is appended to ResponseInterface instance's body stream.", [
89			'file' => $inc,
90			'content_length' => $content_length
91			]);
92			$result->getBody()->write( $echo_result );
93			endif;
94
95
96			// Return ResponseInterface
97			$this->logger->info("Return ResponseInterface instance", [
98			'file' => $inc,
99			'ResponseInterface' => get_class( $result )
100			]);
101			return $result;
			0 ignored issues – show Bug Best Practice introduced 2017-08-31 08:19 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type of `return $result;` (`Psr\Http\Message\ResponseInterface`) is incompatible with the return type declared by the interface `Germania\Renderer\RendererInterface::__invoke` of type `string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
102			endif;
103
104
105
106			// Return string
107			$this->logger->info("Return include file output from output buffer", [
108			'file' => $inc,
109			'content_length' => $content_length
110			]);
111			return ob_get_clean();
112
113			elseif ($path === false):
114			$error_message = "PhpRenderer: Could not find include in any base path.";
115			elseif (!is_file($path)):
116			$error_message = "PhpRenderer: Include file does not exist: " . ($path ?: "(none)");
117			else:
118			$error_message = "PhpRenderer: Include file not readable: " . ($path ?: "(none)");
119			endif;
120
121			if (!empty($error_message) and is_string( $error_message )):
122			$this->logger->error( $error_message );
123			throw new \RuntimeException( $error_message );
124			endif;
125
126			}
127
128
129			/**
130			* @param string $inc The file to locate
131			* @return string Full path
132			*/
133			public function buildPath( $inc )
134			{
135			foreach($this->base_path as $path):
136			if ($file = realpath(join(\DIRECTORY_SEPARATOR, [$path, $inc ]))) {
137			return $file;
138			}
139			endforeach;
140
141			return false;
142			}
143			}
144

GermaniaKG / Renderer

Issues (6)

Security Analysis no request data

src/PhpRenderer.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like