Issues in OpenAPIGenerator.php (master) - Issues in master - hiqdev/hiapi - Measure and Improve Code Quality continuously with Scrutinizer

Issues (78)

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.

src/Service/OpenApi/OpenAPIGenerator.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
declare(strict_types=1);

namespace hiapi\Service\OpenApi;

use cebe\openapi\spec\Components;
use cebe\openapi\spec\OpenApi;
use cebe\openapi\spec\Operation;
use cebe\openapi\spec\PathItem;
use cebe\openapi\spec\Response;
use cebe\openapi\spec\Responses;
use cebe\openapi\spec\Schema;
use cebe\openapi\spec\SecurityRequirement;
use cebe\openapi\spec\SecurityScheme;
use cebe\openapi\spec\Server;
use cebe\openapi\spec\ServerVariable;
use Generator;
use hiapi\commands\Reflection\BaseCommandReflection;
use hiapi\Core\Endpoint\EndpointRepository;
use hiapi\endpoints\Module\InOutControl\VO\Collection;
use hiapi\exceptions\ConfigurationException;
use hiapi\validators\Reflection\ValidatorReflection;
use yii\validators\EachValidator;
use yii\validators\InlineValidator;
use yii\validators\RequiredValidator;
use yii\validators\SafeValidator;
use yii\validators\Validator;
use ReflectionObject;

/**
 * Class OpenAPIGenerator generates OpenAPI documentation.
 *
 * This class represents a general implementation.
 *
 * @author Dmytro Naumenko <[email protected]>
 */
class OpenAPIGenerator
{
    /** @psalm-var array<string, SecurityScheme> */
    private array $securitySchemes;

    private EndpointRepository $endpointRepository;
    /** @psalm-var list<string> */
    private array $hosts;
    private array $apiInfo;

    public function __construct(EndpointRepository $endpointRepository, array $options = [])
    {
        $this->endpointRepository = $endpointRepository;

        $this->hosts = $options['hosts'] ?? [];
        $this->securitySchemes = $options['securitySchemes'] ?? [];
        $this->apiInfo = $options['apiInfo'] ?? [];
    }

    public function __invoke(): OpenApi
    {
        return $this->createOpenAPI();
    }

    private function createOpenAPI(): OpenApi
    {
        return new OpenApi([
            'openapi' => '3.0.2',
            'info' => $this->apiInfo,
            'paths' => iterator_to_array($this->generatePaths(), true),
            'servers' => iterator_to_array($this->buildServers(), false),
            'components' => $this->buildComponents(),
        ]);
    }

    /**
     * @psalm-return Generator<int, Server>
     */
    private function buildServers(): Generator
    {
        $isDev = YII_ENV_DEV;

        foreach($this->hosts as $host) {
            yield new Server([
                'url' => "{protocol}://$host/",
                'variables' => [
                    'protocol' => new ServerVariable([
                        'enum' => ['http', 'https'],
                        'default' => $isDev ? 'http' : 'https',
                    ]),
                ],
            ]);
        }
    }

    /**
     * @psalm-return Generator<int, PathItem>
     */
    private function generatePaths(): Generator
    {
        foreach ($this->endpointRepository->getEndpointNames() as $name) {
            try {
                $endpoint = $this->endpointRepository->getByName($name);
                $input = $endpoint->inputType;

                yield "/$name" => new PathItem(array_filter([
                    'post' => new Operation([
                        'tags' => [], // TODO: parse endpoint name
                        'summary' => $endpoint->description,
                        'security' => iterator_to_array($this->generateSecuritySchemas($endpoint), true),
                        'requestBody' => [
                            'required' => true,
                            'content' => [
                                'application/x-www-form-urlencoded' => [
                                    'schema' => $this->generateRequestSchema($endpoint),
                                ],
                            ],
                        ],
                        'responses' => new Responses([
                            'default' => new Response([
                                'description' => '',
                                // TODO: response example
                            ]),
                        ]),
                    ]),
                ]));
            } catch (ConfigurationException $exception) {
            }
        }
    }

    private function buildComponents(): Components
    {
        return new Components([
            'schemas' => $this->validationSchemas(),
            'securitySchemes' => $this->securitySchemes,
        ]);
    }

    /**
     * @return Schema[]
     */
    private function validationSchemas(): array
    {
        $result = [];
        foreach ($this->metValidators as $name => $className) {
            $reflection = ValidatorReflection::fromClassname($className);

            $result[$name] = new Schema(array_filter([
                'pattern' => $reflection->getPattern(),
                'type' => 'string',
                'description' => $reflection->getSummary(),
                'example' => $reflection->getExample(),
            ]));
        }

        return $result;
    }

    /**
     * @param \hiapi\Core\Endpoint\Endpoint $endpoint
     * @psalm-return Generator<int, SecurityScheme>
     */
    private function generateSecuritySchemas(\hiapi\Core\Endpoint\Endpoint $endpoint): Generator
    {
        if (!empty($endpoint->permissions)) {
            foreach ($this->securitySchemes as $name => $_) {
                yield new SecurityRequirement([
                    $name => $endpoint->permissions,
                ]);
            }
        }
    }

    private function generateRequestSchema(\hiapi\Core\Endpoint\Endpoint $endpoint): Schema
    {
        $properties = $required = [];

        $inputType = $endpoint->inputType;
        if ($inputType instanceof Collection) {
            // TODO: describe as a nested object
            $inputType = $inputType->getEntriesClass();
        }
        /** @psalm-var class-string<BaseCommand> $inputType */
        $reflection = BaseCommandReflection::fromClassname($inputType);

        foreach ($reflection->getAttributes() as $attribute) {
            $rules = $reflection->getAttributeValidationRules($attribute);

            $schemas = [];
            foreach ($rules as $key => $validator) {
                if ($validator instanceof RequiredValidator) {
                    $required[] = $attribute;
                }
                if (($rule = $this->ruleNameByValidator($validator)) === null) {
                    continue;
                }

                $schemas[$key] = new Schema([
                    '$ref' => '#/components/schemas/' . $rule,
                ]);
            }
            if (count($schemas) === 0) {
                continue; // Not validated attributes are not a part of a public API
            }

            if (count($schemas) === 1) {
                $properties[$attribute] = reset($schemas);
            } else {
                $properties[$attribute] = new Schema(['allOf' => $schemas]);
            }
        }

        return new Schema([
            'properties' => $properties,
            'required' => array_unique($required),
        ]);
    }

    /** @psalm-var array<string, class-string<Validator>> */
    private array $metValidators = [];

    private function ruleNameByValidator(Validator $validator): ?string
    {
        $skippedValidators = [
            RequiredValidator::class => 'Is represented by OpenAPI required syntax',
            EachValidator::class => 'Is represented by OpenAPI array syntax',
            InlineValidator::class => 'Could not be inspected and should not be used',
            SafeValidator::class => 'Means nothing in OpenAPI',
        ];
        if (isset($skippedValidators[get_class($validator)])) {
            return null;
        }

        $name = (new ReflectionObject($validator))->getShortName();
        if (!isset($this->metValidators[$name])) {
            $this->metValidators[$name] = get_class($validator);
        }

        return $name;
    }
}


1			<?php
2			declare(strict_types=1);
3
4			namespace hiapi\Service\OpenApi;
5
6			use cebe\openapi\spec\Components;
7			use cebe\openapi\spec\OpenApi;
8			use cebe\openapi\spec\Operation;
9			use cebe\openapi\spec\PathItem;
10			use cebe\openapi\spec\Response;
11			use cebe\openapi\spec\Responses;
12			use cebe\openapi\spec\Schema;
13			use cebe\openapi\spec\SecurityRequirement;
14			use cebe\openapi\spec\SecurityScheme;
15			use cebe\openapi\spec\Server;
16			use cebe\openapi\spec\ServerVariable;
17			use Generator;
18			use hiapi\commands\Reflection\BaseCommandReflection;
19			use hiapi\Core\Endpoint\EndpointRepository;
20			use hiapi\endpoints\Module\InOutControl\VO\Collection;
21			use hiapi\exceptions\ConfigurationException;
22			use hiapi\validators\Reflection\ValidatorReflection;
23			use yii\validators\EachValidator;
24			use yii\validators\InlineValidator;
25			use yii\validators\RequiredValidator;
26			use yii\validators\SafeValidator;
27			use yii\validators\Validator;
28			use ReflectionObject;
29
30			/**
31			* Class OpenAPIGenerator generates OpenAPI documentation.
32			*
33			* This class represents a general implementation.
34			*
35			* @author Dmytro Naumenko <[email protected]>
36			*/
37			class OpenAPIGenerator
38			{
39			/** @psalm-var array<string, SecurityScheme> */
40			private array $securitySchemes;
			0 ignored issues – show Bug introduced 2020-04-24 18:19 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_ARRAY, expecting T_FUNCTION or T_CONST Loading history...
41			private EndpointRepository $endpointRepository;
42			/** @psalm-var list<string> */
43			private array $hosts;
44			private array $apiInfo;
45
46			public function __construct(EndpointRepository $endpointRepository, array $options = [])
47			{
48			$this->endpointRepository = $endpointRepository;
49
50			$this->hosts = $options['hosts'] ?? [];
51			$this->securitySchemes = $options['securitySchemes'] ?? [];
52			$this->apiInfo = $options['apiInfo'] ?? [];
53			}
54
55			public function __invoke(): OpenApi
56			{
57			return $this->createOpenAPI();
58			}
59
60			private function createOpenAPI(): OpenApi
61			{
62			return new OpenApi([
63			'openapi' => '3.0.2',
64			'info' => $this->apiInfo,
65			'paths' => iterator_to_array($this->generatePaths(), true),
66			'servers' => iterator_to_array($this->buildServers(), false),
67			'components' => $this->buildComponents(),
68			]);
69			}
70
71			/**
72			* @psalm-return Generator<int, Server>
73			*/
74			private function buildServers(): Generator
75			{
76			$isDev = YII_ENV_DEV;
77
78			foreach($this->hosts as $host) {
79			yield new Server([
80			'url' => "{protocol}://$host/",
81			'variables' => [
82			'protocol' => new ServerVariable([
83			'enum' => ['http', 'https'],
84			'default' => $isDev ? 'http' : 'https',
85			]),
86			],
87			]);
88			}
89			}
90
91			/**
92			* @psalm-return Generator<int, PathItem>
93			*/
94			private function generatePaths(): Generator
95			{
96			foreach ($this->endpointRepository->getEndpointNames() as $name) {
97			try {
98			$endpoint = $this->endpointRepository->getByName($name);
99			$input = $endpoint->inputType;
100
101			yield "/$name" => new PathItem(array_filter([
102			'post' => new Operation([
103			'tags' => [], // TODO: parse endpoint name
104			'summary' => $endpoint->description,
105			'security' => iterator_to_array($this->generateSecuritySchemas($endpoint), true),
106			'requestBody' => [
107			'required' => true,
108			'content' => [
109			'application/x-www-form-urlencoded' => [
110			'schema' => $this->generateRequestSchema($endpoint),
111			],
112			],
113			],
114			'responses' => new Responses([
115			'default' => new Response([
116			'description' => '',
117			// TODO: response example
118			]),
119			]),
120			]),
121			]));
122			} catch (ConfigurationException $exception) {
123			}
124			}
125			}
126
127			private function buildComponents(): Components
128			{
129			return new Components([
130			'schemas' => $this->validationSchemas(),
131			'securitySchemes' => $this->securitySchemes,
132			]);
133			}
134
135			/**
136			* @return Schema[]
137			*/
138			private function validationSchemas(): array
139			{
140			$result = [];
141			foreach ($this->metValidators as $name => $className) {
142			$reflection = ValidatorReflection::fromClassname($className);
143
144			$result[$name] = new Schema(array_filter([
145			'pattern' => $reflection->getPattern(),
146			'type' => 'string',
147			'description' => $reflection->getSummary(),
148			'example' => $reflection->getExample(),
149			]));
150			}
151
152			return $result;
153			}
154
155			/**
156			* @param \hiapi\Core\Endpoint\Endpoint $endpoint
157			* @psalm-return Generator<int, SecurityScheme>
158			*/
159			private function generateSecuritySchemas(\hiapi\Core\Endpoint\Endpoint $endpoint): Generator
160			{
161			if (!empty($endpoint->permissions)) {
162			foreach ($this->securitySchemes as $name => $_) {
163			yield new SecurityRequirement([
164			$name => $endpoint->permissions,
165			]);
166			}
167			}
168			}
169
170			private function generateRequestSchema(\hiapi\Core\Endpoint\Endpoint $endpoint): Schema
171			{
172			$properties = $required = [];
173
174			$inputType = $endpoint->inputType;
175			if ($inputType instanceof Collection) {
176			// TODO: describe as a nested object
177			$inputType = $inputType->getEntriesClass();
178			}
179			/** @psalm-var class-string<BaseCommand> $inputType */
180			$reflection = BaseCommandReflection::fromClassname($inputType);
181
182			foreach ($reflection->getAttributes() as $attribute) {
183			$rules = $reflection->getAttributeValidationRules($attribute);
184
185			$schemas = [];
186			foreach ($rules as $key => $validator) {
187			if ($validator instanceof RequiredValidator) {
188			$required[] = $attribute;
189			}
190			if (($rule = $this->ruleNameByValidator($validator)) === null) {
191			continue;
192			}
193
194			$schemas[$key] = new Schema([
195			'$ref' => '#/components/schemas/' . $rule,
196			]);
197			}
198			if (count($schemas) === 0) {
199			continue; // Not validated attributes are not a part of a public API
200			}
201
202			if (count($schemas) === 1) {
203			$properties[$attribute] = reset($schemas);
204			} else {
205			$properties[$attribute] = new Schema(['allOf' => $schemas]);
206			}
207			}
208
209			return new Schema([
210			'properties' => $properties,
211			'required' => array_unique($required),
212			]);
213			}
214
215			/** @psalm-var array<string, class-string<Validator>> */
216			private array $metValidators = [];
217
218			private function ruleNameByValidator(Validator $validator): ?string
219			{
220			$skippedValidators = [
221			RequiredValidator::class => 'Is represented by OpenAPI required syntax',
222			EachValidator::class => 'Is represented by OpenAPI array syntax',
223			InlineValidator::class => 'Could not be inspected and should not be used',
224			SafeValidator::class => 'Means nothing in OpenAPI',
225			];
226			if (isset($skippedValidators[get_class($validator)])) {
227			return null;
228			}
229
230			$name = (new ReflectionObject($validator))->getShortName();
231			if (!isset($this->metValidators[$name])) {
232			$this->metValidators[$name] = get_class($validator);
233			}
234
235			return $name;
236			}
237			}
238

hiqdev / hiapi

Issues (78)

Security Analysis not enabled

src/Service/OpenApi/OpenAPIGenerator.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like