Issues in JiraClient.php (master) - Issues in master - Dragonqos/php-jira-rest-client - Measure and Improve Code Quality continuously with Scrutinizer

Issues (37)

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

Labels

Bug 1

Severity

Critical 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 JiraRestApi;

use GuzzleHttp\ClientInterface;
use GuzzleHttp\Exception\ConnectException;
use GuzzleHttp\Exception\RequestException;
use GuzzleHttp\RequestOptions;
use JiraRestApi\Interfaces\ConfigurationInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Log\LoggerInterface;
use Symfony\Component\HttpFoundation\Request;

/**
 * Interact jira server with REST API.
 */
class JiraClient
{
    /**
     * Json Mapper.
     *
     * @var \JsonMapper
     */
    protected $json_mapper;

    /**
     * JIRA REST API URI.
     *
     * @var string
     */
    protected $api_uri = '/rest/api/2';

    /**
     * Logger instance.
     *
     * @var \Psr\Log\LoggerInterface
     */
    protected $log;

    /**
     * @var ClientInterface string
     */
    protected $transport;

    /**
     * Jira Rest API Configuration.
     *
     * @var ConfigurationInterface
     */
    protected $configuration;

    /**
     * JiraClient constructor.
     *
     * @param ConfigurationInterface|null $configuration
     * @param ClientInterface             $transport
     * @param LoggerInterface             $log
     */
    public function __construct(ConfigurationInterface $configuration = null, ClientInterface $transport, LoggerInterface $log)
    {
        $this->configuration = $configuration;

        $this->json_mapper = new \JsonMapper();
        $this->json_mapper->bEnforceMapType = false;
        $this->json_mapper->setLogger($log);
        $this->json_mapper->undefinedPropertyHandler = function ($obj, $val) {
            $this->log->debug('Handle undefined property', [$val, $obj]);
        };

        $this->log = $log;
        $this->transport = $transport;
    }

    /**
     * Execute REST request.
     *
     * @param string $context RestAPI context (ex.:issue, search, etc..)
     * @param null   $post_data
     * @param string $httpMethod
     *
     * @return string
     *
     * @throws JiraException
     */
    public function exec($context, $post_data = null, $httpMethod = Request::METHOD_GET)
    {
        $url = $this->createUrlByContext($context);

        $options = [
            RequestOptions::HEADERS => [
                'Accept' => '*/*',
                'Content-Type' => 'application/json',
                'charset' => 'UTF-8'
            ]
        ];

        if ($httpMethod == Request::METHOD_GET) {
            $options[RequestOptions::QUERY] = $post_data;
        }

        if (in_array($httpMethod, [Request::METHOD_POST, Request::METHOD_PUT, Request::METHOD_DELETE])) {
            $options[RequestOptions::JSON] = $post_data;
        }

        try {
            $this->log->info('JiraRestApi request: ', [$httpMethod, $url, $options]);
            $response = $this->transport->request($httpMethod, $url, $options);
            $this->log->info('JiraRestApi response: ', [$response->getHeaders(), (string)$response->getBody()]);
        } catch (ConnectException $e) {
            $this->log->critical('JiraRestApi connection exception: ', [$e->getMessage()]);
        } catch (RequestException $e) {
            $this->log->error('JiraRestApi response fail with code : ' . $e->getCode(), [
                $httpMethod, $url, $options,
                (string)$e->getRequest()->getBody(),
                $e->getRequest()->getHeaders(),
                (string)$e->getResponse()->getBody()
            ]);g
            $response = $e->getResponse();

        }

        return isset($response) && $response instanceof ResponseInterface
            ? $this->parseResponse($response)
            : false;
    }

    /**
     * File upload.
     *
     * @param string $context       url context
     * @param array  $filePathArray upload file path.
     *
     * @return array
     *
     * @throws JiraException
     */
    public function upload($context, array $filePathArray)
    {
        $url = $this->createUrlByContext($context);

        $options = [
            RequestOptions::HEADERS => [
                'X-Atlassian-Token' => 'no-check'
            ]
        ];

        $promises = [];

        if(!empty($filePathArray)) {

            foreach ($filePathArray as $filename => $filePath) {
                // load each files separately
                if (file_exists($filePath) == false) {
                    // Ignore if file not found
                    $this->log->error('JiraRestApi: Unable to upload file "' . $filePath . '". File not Found');
                    continue;
                }

                $ex = explode("/", $filePath);
                $options[RequestOptions::MULTIPART] = [
                    [
                        'name'     => 'file',
                        'contents' => fopen($filePath, 'r'),
                        'filename' => is_numeric($filename) ? end($ex) : $filename
                    ]
                ];

                $this->log->info('JiraRestApi requestAsync: ', [Request::METHOD_POST, $url, $options]);
                $promises[] = $this->transport
                    ->requestAsync(Request::METHOD_POST, $url, $options)
                    ->then(function (ResponseInterface $response) {
                        $this->log->info('JiraRestApi responseAsync: ', [$response->getHeaders(), (string) $response->getBody()]);
                        return $response;
                    }, function (RequestException $e) {
                        if($e instanceof ConnectException) {
                            $this->log->critical('JiraRestApi connection exception: ', [$e->getMessage()]);
                            return false;
                        } else {
                            $this->log->error('JiraRestApi responseAsync fail with code : ' . $e->getCode(), [(string) $e->getRequest()->getBody(), $e->getRequest()->getHeaders(), (string) $e->getResponse()->getBody()]);
                            return $e->getResponse();
                        }
                    });
            }

            $responses = \GuzzleHttp\Promise\settle($promises)->wait();

            $result = [];
            foreach ($responses as $response) {
                if (isset($response['value']) && $response['value'] instanceof ResponseInterface) {
                    $result[] = $this->parseResponse($response['value']);
                }
            }

            return $result;
        }

        return false;
    }

    /**
     * Access to JiraResources using JiraCredentials
     * @param $fromUrl
     * @param $toResource
     *
     * @return mixed
     */
    public function download($fromUrl, $toResource = null)
    {
        $options = is_null($toResource)
            ? [RequestOptions::STREAM => true]
            : [RequestOptions::SINK => $toResource];

        try {
            $this->log->info('JiraRestApi request: ', ['GET', $fromUrl, $options]);
            $response = $this->transport->get($fromUrl, $options);
            $this->log->info('JiraRestApi response: ', [$response->getHeaders()]);
        } catch (ConnectException $e) {
            $this->log->critical('JiraRestApi connection exception: ', [$e->getMessage()]);
        } catch (RequestException $e) {
            $this->log->error('JiraRestApi response fail with code : ' . $e->getCode(), [(string) $e->getRequest()->getBody(), $e->getRequest()->getHeaders()]);
            $response = $e->getResponse();
        }

        return isset($response) && $response instanceof ResponseInterface
            ? $response
            : false;
    }

    /**
     * @param               $array
     * @param callable|null $callback
     *
     * @return mixed
     */
    protected function filterNullVariable($array, callable $callback = null)
    {
        $array = json_decode(json_encode($array), true); // toArray

        $array = is_callable($callback) ? array_filter($array, $callback) : array_filter((array)$array);
        foreach ($array as &$value) {
            if (is_array($value)) {
                $value = call_user_func([$this, 'filterNullVariable'], $value, $callback);
            }
        }

        return $array;
    }

    /**
     * @param $rawResponse
     *
     * @return mixed
     */
    public function parseResponse(ResponseInterface $rawResponse)
    {
        return (new JiraClientResponse($rawResponse, $this->log))->parse();
    }

    /**
     * @param          $result
     * @param array    $responseCodes
     * @param \Closure $callback
     *
     * @return mixed
     */
    protected function extractErrors($result, array $responseCodes = [200], \Closure $callback)
    {
        if ($result instanceof JiraClientResponse &&
            !$result->hasErrors() &&
            in_array($result->getCode(), $responseCodes)
        ) {
            return $callback();
        }

        if ($result && !in_array($result->getCode(), $responseCodes)) {
            $result->setError('Unexpected response code, expected "' . implode(', ', $responseCodes) . '", ' . $result->getCode() . ' given');
        }

        return $result;
    }

    /**
     * Get URL by context.
     *
     * @param string $context
     *
     * @return string
     */
    protected function createUrlByContext($context)
    {
        return $this->api_uri . '/' . preg_replace('/\//', '', $context, 1);
    }

    /**
     * Jira Rest API Configuration.
     *
     * @return ConfigurationInterface
     */
    public function getConfiguration()
    {
        return $this->configuration;
    }

    /**
     * @return \JsonMapper
     */
    public function getJsonMapper()
    {
        return $this->json_mapper;
    }
}


GitHub Access Token became invalid

Issues (37)

Security Analysis no request data

src/JiraClient.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

1			<?php
2
3			namespace JiraRestApi;
4
5			use GuzzleHttp\ClientInterface;
6			use GuzzleHttp\Exception\ConnectException;
7			use GuzzleHttp\Exception\RequestException;
8			use GuzzleHttp\RequestOptions;
9			use JiraRestApi\Interfaces\ConfigurationInterface;
10			use Psr\Http\Message\ResponseInterface;
11			use Psr\Log\LoggerInterface;
12			use Symfony\Component\HttpFoundation\Request;
13
14			/**
15			* Interact jira server with REST API.
16			*/
17			class JiraClient
18			{
19			/**
20			* Json Mapper.
21			*
22			* @var \JsonMapper
23			*/
24			protected $json_mapper;
25
26			/**
27			* JIRA REST API URI.
28			*
29			* @var string
30			*/
31			protected $api_uri = '/rest/api/2';
32
33			/**
34			* Logger instance.
35			*
36			* @var \Psr\Log\LoggerInterface
37			*/
38			protected $log;
39
40			/**
41			* @var ClientInterface string
42			*/
43			protected $transport;
44
45			/**
46			* Jira Rest API Configuration.
47			*
48			* @var ConfigurationInterface
49			*/
50			protected $configuration;
51
52			/**
53			* JiraClient constructor.
54			*
55			* @param ConfigurationInterface\|null $configuration
56			* @param ClientInterface $transport
57			* @param LoggerInterface $log
58			*/
59			public function __construct(ConfigurationInterface $configuration = null, ClientInterface $transport, LoggerInterface $log)
60			{
61			$this->configuration = $configuration;
62
63			$this->json_mapper = new \JsonMapper();
64			$this->json_mapper->bEnforceMapType = false;
65			$this->json_mapper->setLogger($log);
66			$this->json_mapper->undefinedPropertyHandler = function ($obj, $val) {
67			$this->log->debug('Handle undefined property', [$val, $obj]);
68			};
69
70			$this->log = $log;
71			$this->transport = $transport;
72			}
73
74			/**
75			* Execute REST request.
76			*
77			* @param string $context RestAPI context (ex.:issue, search, etc..)
78			* @param null $post_data
79			* @param string $httpMethod
80			*
81			* @return string
82			*
83			* @throws JiraException
84			*/
85			public function exec($context, $post_data = null, $httpMethod = Request::METHOD_GET)
86			{
87			$url = $this->createUrlByContext($context);
88
89			$options = [
90			RequestOptions::HEADERS => [
91			'Accept' => '/',
92			'Content-Type' => 'application/json',
93			'charset' => 'UTF-8'
94			]
95			];
96
97			if ($httpMethod == Request::METHOD_GET) {
98			$options[RequestOptions::QUERY] = $post_data;
99			}
100
101			if (in_array($httpMethod, [Request::METHOD_POST, Request::METHOD_PUT, Request::METHOD_DELETE])) {
102			$options[RequestOptions::JSON] = $post_data;
103			}
104
105			try {
106			$this->log->info('JiraRestApi request: ', [$httpMethod, $url, $options]);
107			$response = $this->transport->request($httpMethod, $url, $options);
108			$this->log->info('JiraRestApi response: ', [$response->getHeaders(), (string)$response->getBody()]);
109			} catch (ConnectException $e) {
110			$this->log->critical('JiraRestApi connection exception: ', [$e->getMessage()]);
111			} catch (RequestException $e) {
112			$this->log->error('JiraRestApi response fail with code : ' . $e->getCode(), [
113			$httpMethod, $url, $options,
114			(string)$e->getRequest()->getBody(),
115			$e->getRequest()->getHeaders(),
116			(string)$e->getResponse()->getBody()
117			]);g
118			$response = $e->getResponse();
			0 ignored issues – show Bug introduced 2018-03-26 10:35 UTC by Report Bug Copy Issue Report Show Similar Issues like this This code did not parse for me. Apparently, there is an error somewhere around this line: Syntax error, unexpected T_VARIABLE Loading history...
119			}
120
121			return isset($response) && $response instanceof ResponseInterface
122			? $this->parseResponse($response)
123			: false;
124			}
125
126			/**
127			* File upload.
128			*
129			* @param string $context url context
130			* @param array $filePathArray upload file path.
131			*
132			* @return array
133			*
134			* @throws JiraException
135			*/
136			public function upload($context, array $filePathArray)
137			{
138			$url = $this->createUrlByContext($context);
139
140			$options = [
141			RequestOptions::HEADERS => [
142			'X-Atlassian-Token' => 'no-check'
143			]
144			];
145
146			$promises = [];
147
148			if(!empty($filePathArray)) {
149
150			foreach ($filePathArray as $filename => $filePath) {
151			// load each files separately
152			if (file_exists($filePath) == false) {
153			// Ignore if file not found
154			$this->log->error('JiraRestApi: Unable to upload file "' . $filePath . '". File not Found');
155			continue;
156			}
157
158			$ex = explode("/", $filePath);
159			$options[RequestOptions::MULTIPART] = [
160			[
161			'name' => 'file',
162			'contents' => fopen($filePath, 'r'),
163			'filename' => is_numeric($filename) ? end($ex) : $filename
164			]
165			];
166
167			$this->log->info('JiraRestApi requestAsync: ', [Request::METHOD_POST, $url, $options]);
168			$promises[] = $this->transport
169			->requestAsync(Request::METHOD_POST, $url, $options)
170			->then(function (ResponseInterface $response) {
171			$this->log->info('JiraRestApi responseAsync: ', [$response->getHeaders(), (string) $response->getBody()]);
172			return $response;
173			}, function (RequestException $e) {
174			if($e instanceof ConnectException) {
175			$this->log->critical('JiraRestApi connection exception: ', [$e->getMessage()]);
176			return false;
177			} else {
178			$this->log->error('JiraRestApi responseAsync fail with code : ' . $e->getCode(), [(string) $e->getRequest()->getBody(), $e->getRequest()->getHeaders(), (string) $e->getResponse()->getBody()]);
179			return $e->getResponse();
180			}
181			});
182			}
183
184			$responses = \GuzzleHttp\Promise\settle($promises)->wait();
185
186			$result = [];
187			foreach ($responses as $response) {
188			if (isset($response['value']) && $response['value'] instanceof ResponseInterface) {
189			$result[] = $this->parseResponse($response['value']);
190			}
191			}
192
193			return $result;
194			}
195
196			return false;
197			}
198
199			/**
200			* Access to JiraResources using JiraCredentials
201			* @param $fromUrl
202			* @param $toResource
203			*
204			* @return mixed
205			*/
206			public function download($fromUrl, $toResource = null)
207			{
208			$options = is_null($toResource)
209			? [RequestOptions::STREAM => true]
210			: [RequestOptions::SINK => $toResource];
211
212			try {
213			$this->log->info('JiraRestApi request: ', ['GET', $fromUrl, $options]);
214			$response = $this->transport->get($fromUrl, $options);
215			$this->log->info('JiraRestApi response: ', [$response->getHeaders()]);
216			} catch (ConnectException $e) {
217			$this->log->critical('JiraRestApi connection exception: ', [$e->getMessage()]);
218			} catch (RequestException $e) {
219			$this->log->error('JiraRestApi response fail with code : ' . $e->getCode(), [(string) $e->getRequest()->getBody(), $e->getRequest()->getHeaders()]);
220			$response = $e->getResponse();
221			}
222
223			return isset($response) && $response instanceof ResponseInterface
224			? $response
225			: false;
226			}
227
228			/**
229			* @param $array
230			* @param callable\|null $callback
231			*
232			* @return mixed
233			*/
234			protected function filterNullVariable($array, callable $callback = null)
235			{
236			$array = json_decode(json_encode($array), true); // toArray
237
238			$array = is_callable($callback) ? array_filter($array, $callback) : array_filter((array)$array);
239			foreach ($array as &$value) {
240			if (is_array($value)) {
241			$value = call_user_func([$this, 'filterNullVariable'], $value, $callback);
242			}
243			}
244
245			return $array;
246			}
247
248			/**
249			* @param $rawResponse
250			*
251			* @return mixed
252			*/
253			public function parseResponse(ResponseInterface $rawResponse)
254			{
255			return (new JiraClientResponse($rawResponse, $this->log))->parse();
256			}
257
258			/**
259			* @param $result
260			* @param array $responseCodes
261			* @param \Closure $callback
262			*
263			* @return mixed
264			*/
265			protected function extractErrors($result, array $responseCodes = [200], \Closure $callback)
266			{
267			if ($result instanceof JiraClientResponse &&
268			!$result->hasErrors() &&
269			in_array($result->getCode(), $responseCodes)
270			) {
271			return $callback();
272			}
273
274			if ($result && !in_array($result->getCode(), $responseCodes)) {
275			$result->setError('Unexpected response code, expected "' . implode(', ', $responseCodes) . '", ' . $result->getCode() . ' given');
276			}
277
278			return $result;
279			}
280
281			/**
282			* Get URL by context.
283			*
284			* @param string $context
285			*
286			* @return string
287			*/
288			protected function createUrlByContext($context)
289			{
290			return $this->api_uri . '/' . preg_replace('/\//', '', $context, 1);
291			}
292
293			/**
294			* Jira Rest API Configuration.
295			*
296			* @return ConfigurationInterface
297			*/
298			public function getConfiguration()
299			{
300			return $this->configuration;
301			}
302
303			/**
304			* @return \JsonMapper
305			*/
306			public function getJsonMapper()
307			{
308			return $this->json_mapper;
309			}
310			}
311

Dragonqos / php-jira-rest-client

GitHub Access Token became invalid

Issues (37)

Security Analysis no request data

src/JiraClient.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like