Issues (20)

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/Api/HttpApi.php (3 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
declare(strict_types=1);
4
5
/*
6
 * This software may be modified and distributed under the terms
7
 * of the MIT license. See the LICENSE file for details.
8
 */
9
10
namespace FAPI\Boilerplate\Api;
11
12
use FAPI\Boilerplate\Exception\Domain as DomainExceptions;
13
use FAPI\Boilerplate\Exception\DomainException;
14
use FAPI\Boilerplate\Hydrator\NoopHydrator;
15
use Http\Client\HttpClient;
16
use FAPI\Boilerplate\Hydrator\Hydrator;
17
use FAPI\Boilerplate\RequestBuilder;
18
use Psr\Http\Message\ResponseInterface;
19
20
/**
21
 * @author Tobias Nyholm <[email protected]>
22
 */
23
abstract class HttpApi
24
{
25
    /**
26
     * @var HttpClient
27
     */
28
    protected $httpClient;
29
30
    /**
31
     * @var Hydrator
32
     */
33
    protected $hydrator;
34
35
    /**
36
     * @var RequestBuilder
37
     */
38
    protected $requestBuilder;
39
40
    /**
41
     * @param HttpClient     $httpClient
42
     * @param RequestBuilder $requestBuilder
43
     * @param Hydrator       $hydrator
44
     */
45
    public function __construct(HttpClient $httpClient, Hydrator $hydrator, RequestBuilder $requestBuilder)
46
    {
47
        $this->httpClient = $httpClient;
48
        $this->requestBuilder = $requestBuilder;
49
        if (!$hydrator instanceof NoopHydrator) {
50
            $this->hydrator = $hydrator;
51
        }
52
    }
53
54
    /**
55
     * Send a GET request with query parameters.
56
     *
57
     * @param string $path           Request path
58
     * @param array  $params         GET parameters
59
     * @param array  $requestHeaders Request Headers
60
     *
61
     * @return ResponseInterface
62
     */
63
    protected function httpGet(string $path, array $params = [], array $requestHeaders = []): ResponseInterface
64
    {
65
        if (count($params) > 0) {
66
            $path .= '?'.http_build_query($params);
67
        }
68
69
        return $this->httpClient->sendRequest(
70
            $this->requestBuilder->create('GET', $path, $requestHeaders)
71
        );
72
    }
73
74
    /**
75
     * Send a POST request with JSON-encoded parameters.
76
     *
77
     * @param string $path           Request path
78
     * @param array  $params         POST parameters to be JSON encoded
79
     * @param array  $requestHeaders Request headers
80
     *
81
     * @return ResponseInterface
82
     */
83
    protected function httpPost(string $path, array $params = [], array $requestHeaders = []): ResponseInterface
84
    {
85
        return $this->httpPostRaw($path, $this->createJsonBody($params), $requestHeaders);
86
    }
87
88
    /**
89
     * Send a POST request with raw data.
90
     *
91
     * @param string       $path           Request path
92
     * @param array|string $body           Request body
93
     * @param array        $requestHeaders Request headers
94
     *
95
     * @return ResponseInterface
96
     */
97
    protected function httpPostRaw(string $path, $body, array $requestHeaders = []): ResponseInterface
98
    {
99
        return $response = $this->httpClient->sendRequest(
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...
100
            $this->requestBuilder->create('POST', $path, $requestHeaders, $body)
101
        );
102
    }
103
104
    /**
105
     * Send a PUT request with JSON-encoded parameters.
106
     *
107
     * @param string $path           Request path
108
     * @param array  $params         POST parameters to be JSON encoded
109
     * @param array  $requestHeaders Request headers
110
     *
111
     * @return ResponseInterface
112
     */
113
    protected function httpPut(string $path, array $params = [], array $requestHeaders = []): ResponseInterface
114
    {
115
        return $this->httpClient->sendRequest(
116
            $this->requestBuilder->create('PUT', $path, $requestHeaders, $this->createJsonBody($params))
117
        );
118
    }
119
120
    /**
121
     * Send a DELETE request with JSON-encoded parameters.
122
     *
123
     * @param string $path           Request path
124
     * @param array  $params         POST parameters to be JSON encoded
125
     * @param array  $requestHeaders Request headers
126
     *
127
     * @return ResponseInterface
128
     */
129
    protected function httpDelete(string $path, array $params = [], array $requestHeaders = []): ResponseInterface
130
    {
131
        return $this->httpClient->sendRequest(
132
            $this->requestBuilder->create('DELETE', $path, $requestHeaders, $this->createJsonBody($params))
133
        );
134
    }
135
136
    /**
137
     * Create a JSON encoded version of an array of parameters.
138
     *
139
     * @param array $params Request parameters
140
     *
141
     * @return null|string
142
     */
143
    private function createJsonBody(array $params)
144
    {
145
        return (count($params) === 0) ? null : json_encode($params, empty($params) ? JSON_FORCE_OBJECT : 0);
146
    }
147
148
    /**
149
     * Handle HTTP errors.
150
     *
151
     * Call is controlled by the specific API methods.
152
     *
153
     * @param ResponseInterface $response
154
     *
155
     * @throws DomainException
156
     */
157
    protected function handleErrors(ResponseInterface $response)
158
    {
159
        switch ($response->getStatusCode()) {
160
            case 404:
161
                throw new DomainExceptions\NotFoundException();
162
                break;
0 ignored issues
show
break; does not seem to be reachable.

This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed.

Unreachable code is most often the result of return, die or exit statements that have been added for debug purposes.

function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}

In the above example, the last return false will never be executed, because a return statement has already been met in every possible execution path.

Loading history...
163
164
            default:
165
                throw new DomainExceptions\UnknownErrorException();
166
                break;
0 ignored issues
show
break; does not seem to be reachable.

This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed.

Unreachable code is most often the result of return, die or exit statements that have been added for debug purposes.

function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}

In the above example, the last return false will never be executed, because a return statement has already been met in every possible execution path.

Loading history...
167
        }
168
    }
169
}
170