Issues in DocsGeneratorTrait.php (master) - Issues in master - apiato/apiato - Measure and Improve Code Quality continuously with Scrutinizer

Issues (258)

Security Analysis not enabled

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.

Documentation/Traits/DocsGeneratorTrait.php (1 issue)

Labels

Bug 1

Severity

Major 1

Mahmoud Zalt 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 App\Containers\Documentation\Traits;

use DateTime;
use Illuminate\Support\Facades\Config;

/**
 * Class DocsGeneratorTrait
 *
 * @author  Mahmoud Zalt  <[email protected]>
 */
trait DocsGeneratorTrait
{

    /**
     * @param $type
     *
     * @return mixed
     */
    private function getFullApiUrl($type)
    {
        return '> ' . $this->getAppUrl() . '/' . $this->getUrl($type);
    }

    /**
     * @return  mixed
     */
    private function getAppUrl()
    {
        return Config::get('app.url');
    }

    /**
     * @return  mixed
     */
    private function getHtmlPath()
    {
        return Config::get("{$this->getConfigFile()}.html_files");
    }

    /**
     * Where to generate the new documentation.
     *
     * @param $type
     *
     * @return string
     */
    private function getDocumentationPath($type)
    {
        return $this->getHtmlPath() . $this->getUrl($type);
    }

    /**
     * @param $type
     *
     * @return string
     */
    private function getJsonFilePath($type)
    {
        return "app/Containers/Documentation/ApiDocJs/{$type}";
    }

    /**
     * @return  string
     */
    private function getConfigFile()
    {
        return 'documentation-container';
    }

    /**
     * @return  mixed
     */
    private function getTypeConfig()
    {
        return Config::get($this->getConfigFile() . '.types');
    }

    /**
     * @return  mixed
     */
    private function getExecutable()
    {
        return Config::get($this->getConfigFile() . '.executable');
    }

    /**
     * @return  mixed
     */
    private function getSwaggerConverter()
    {
        return Config::get($this->getConfigFile() . '.swagger-converter');
    }

    /**
     * @param $type
     *
     * @return  mixed
     */
    private function getUrl($type)
    {
        $configs = $this->getTypeConfig();

        return $configs[$type]['url'];
    }

    /**
     * @param $type
     *
     * @return  array
     */
    private function getEndpointFiles($type)
    {
        $configs = $this->getTypeConfig();

        // what files types needs to be included
        $routeFilesCommand = [];
        $routes = $configs[$type]['routes'];

        foreach ($routes as $route) {
          $routeFilesCommand[] = '-f';
          $routeFilesCommand[] = $route . '.php';
        }

        return $routeFilesCommand;
    }


    /**
     * @param $templateKey
     * @param $value
     */
    private function replace($templateKey, $value)
    {
        $this->headerMarkdownContent = str_replace($templateKey, $value, $this->headerMarkdownContent);
class MyClass { }

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

    /**
     * @param $minutes
     *
     * @return  string
     */
    private function minutesToTimeDisplay($minutes)
    {
        $seconds = $minutes * 60;

        $dtF = new DateTime('@0');
        $dtT = new DateTime("@$seconds");

        return $dtF->diff($dtT)->format('%a days, %h hours, %i minutes and %s seconds');
    }

}


1			<?php
2
3			namespace App\Containers\Documentation\Traits;
4
5			use DateTime;
6			use Illuminate\Support\Facades\Config;
7
8			/**
9			* Class DocsGeneratorTrait
10			*
11			* @author Mahmoud Zalt <[email protected]>
12			*/
13			trait DocsGeneratorTrait
14			{
15
16			/**
17			* @param $type
18			*
19			* @return mixed
20			*/
21			private function getFullApiUrl($type)
22			{
23			return '> ' . $this->getAppUrl() . '/' . $this->getUrl($type);
24			}
25
26			/**
27			* @return mixed
28			*/
29			private function getAppUrl()
30			{
31			return Config::get('app.url');
32			}
33
34			/**
35			* @return mixed
36			*/
37			private function getHtmlPath()
38			{
39			return Config::get("{$this->getConfigFile()}.html_files");
40			}
41
42			/**
43			* Where to generate the new documentation.
44			*
45			* @param $type
46			*
47			* @return string
48			*/
49			private function getDocumentationPath($type)
50			{
51			return $this->getHtmlPath() . $this->getUrl($type);
52			}
53
54			/**
55			* @param $type
56			*
57			* @return string
58			*/
59			private function getJsonFilePath($type)
60			{
61			return "app/Containers/Documentation/ApiDocJs/{$type}";
62			}
63
64			/**
65			* @return string
66			*/
67			private function getConfigFile()
68			{
69			return 'documentation-container';
70			}
71
72			/**
73			* @return mixed
74			*/
75			private function getTypeConfig()
76			{
77			return Config::get($this->getConfigFile() . '.types');
78			}
79
80			/**
81			* @return mixed
82			*/
83			private function getExecutable()
84			{
85			return Config::get($this->getConfigFile() . '.executable');
86			}
87
88			/**
89			* @return mixed
90			*/
91			private function getSwaggerConverter()
92			{
93			return Config::get($this->getConfigFile() . '.swagger-converter');
94			}
95
96			/**
97			* @param $type
98			*
99			* @return mixed
100			*/
101			private function getUrl($type)
102			{
103			$configs = $this->getTypeConfig();
104
105			return $configs[$type]['url'];
106			}
107
108			/**
109			* @param $type
110			*
111			* @return array
112			*/
113			private function getEndpointFiles($type)
114			{
115			$configs = $this->getTypeConfig();
116
117			// what files types needs to be included
118			$routeFilesCommand = [];
119			$routes = $configs[$type]['routes'];
120
121			foreach ($routes as $route) {
122			$routeFilesCommand[] = '-f';
123			$routeFilesCommand[] = $route . '.php';
124			}
125
126			return $routeFilesCommand;
127			}
128
129
130			/**
131			* @param $templateKey
132			* @param $value
133			*/
134			private function replace($templateKey, $value)
135			{
136			$this->headerMarkdownContent = str_replace($templateKey, $value, $this->headerMarkdownContent);
			0 ignored issues – show Bug introduced 2017-03-23 04:11 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `headerMarkdownContent` 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...
137			}
138
139			/**
140			* @param $minutes
141			*
142			* @return string
143			*/
144			private function minutesToTimeDisplay($minutes)
145			{
146			$seconds = $minutes * 60;
147
148			$dtF = new DateTime('@0');
149			$dtT = new DateTime("@$seconds");
150
151			return $dtF->diff($dtT)->format('%a days, %h hours, %i minutes and %s seconds');
152			}
153
154			}
155

apiato / apiato

Issues (258)

Security Analysis not enabled

Documentation/Traits/DocsGeneratorTrait.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like