Issues (6)

Security Analysis    no request data  

This project does not seem to handle request data directly as such no vulnerable execution paths were found.

  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/HttpTrait.php (5 issues)

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

1
<?php
2
3
namespace PiHole;
4
5
use ErrorException;
6
use GuzzleHttp\RequestOptions;
7
use Psr\Http\Message\ResponseInterface;
8
use PiHole\Exceptions\EmptyResults;
9
10
/**
11
 * @author  Paul Rock <[email protected]>
12
 * @link    https://drteam.rocks
13
 * @license MIT
14
 * @package PiHole
15
 */
16
trait HttpTrait
17
{
18
    /**
19
     * Initial state of some variables
20
     *
21
     * @var \GuzzleHttp\Client
22
     */
23
    private $client;
24
25
    /**
26
     * Object of main config
27
     *
28
     * @var \PiHole\Config
29
     */
30
    protected $config;
31
32
    /**
33
     * Request executor with timeout and repeat tries
34
     *
35
     * @param string     $type     Request method
36
     * @param array      $params   List of parameters
37
     * @param array|null $endpoint endpoint url
38
     * @param bool       $auth
39
     *
40
     * @return null|\Psr\Http\Message\ResponseInterface
41
     * @throws \GuzzleHttp\Exception\GuzzleException
42
     * @throws \ErrorException
43
     */
44
    private function repeatRequest(string $type, array $endpoint = null, array $params = null, bool $auth = false): ?ResponseInterface
45
    {
46
        $type = strtoupper($type);
47
48
        for ($i = 1; $i < $this->config->get('tries'); $i++) {
49
50
            if ($params === null) {
51
                // Execute the request to server
52
                $result = $this->client->request($type, $this->config->getBaseUrl($endpoint, $auth));
53
            } else {
54
                // Execute the request to server
55
                $result = $this->client->request($type, $this->config->getBaseUrl($endpoint, $auth), [RequestOptions::FORM_PARAMS => $params]);
56
            }
57
58
            // Check the code status
59
            $code   = $result->getStatusCode();
60
            $reason = $result->getReasonPhrase();
61
62
            // If success response from server
63
            if ($code === 200 || $code === 201) {
64
                return $result;
65
            }
66
67
            // If not "too many requests", then probably some bug on remote or our side
68
            if ($code !== 429) {
69
                throw new ErrorException($code . ' ' . $reason);
70
            }
71
72
            // Waiting in seconds
73
            sleep($this->config->get('seconds'));
74
        }
75
76
        // Return false if loop is done but no answer from server
77
        return null;
78
    }
79
80
    /**
81
     * Execute request and return response
82
     *
83
     * @return null|object Array with data or NULL if error
84
     * @throws \GuzzleHttp\Exception\GuzzleException
85
     * @throws \ErrorException
86
     * @throws \PiHole\Exceptions\EmptyResults
87
     */
88
    public function exec()
89
    {
90
        return $this->doRequest($this->type, $this->endpoint, $this->params, false, $this->auth);
0 ignored issues
show
The property type does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
The property endpoint does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
The property params does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
The property auth does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
91
    }
92
93
    /**
94
     * Execute query and return RAW response from remote API
95
     *
96
     * @return null|\Psr\Http\Message\ResponseInterface RAW response or NULL if error
97
     * @throws \GuzzleHttp\Exception\GuzzleException
98
     * @throws \ErrorException
99
     * @throws \PiHole\Exceptions\EmptyResults
100
     */
101
    public function raw(): ?ResponseInterface
102
    {
103
        return $this->doRequest($this->type, $this->endpoint, $this->params, true, $this->auth);
104
    }
105
106
    /**
107
     * Make the request and analyze the result
108
     *
109
     * @param string $type     Request method
110
     * @param array  $endpoint Api request endpoint
111
     * @param array  $params   List of parameters
112
     * @param bool   $raw      Return data in raw format
113
     * @param bool   $auth
114
     *
115
     * @return null|object|ResponseInterface Array with data, RAW response or NULL if error
116
     * @throws \GuzzleHttp\Exception\GuzzleException
117
     * @throws \ErrorException
118
     * @throws \PiHole\Exceptions\EmptyResults
119
     */
120
    private function doRequest(string $type, array $endpoint = null, array $params = null, bool $raw = false, bool $auth = false)
121
    {
122
        // Null by default
123
        $response = null;
0 ignored issues
show
$response is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
124
125
        // Execute the request to server
126
        $result = $this->repeatRequest($type, $endpoint, $params, $auth);
127
128
        if (null === $result) {
129
            throw new EmptyResults('Empty results returned from Pi-Hole API');
130
        }
131
132
        // Return RAW result if required
133
        return $raw ? $result : json_decode($result->getBody(), false);
134
    }
135
136
}
137