Issues in Step.php (master) - Issues in master - malukenho/kawaii-gherkin - Measure and Improve Code Quality continuously with Scrutinizer

Issues (4)

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/Formatter/Step.php (2 issues)

Labels

Bug 2

Severity

Minor 2

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
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license.
 */

namespace KawaiiGherkin\Formatter;

use Behat\Gherkin\Node\ArgumentInterface;
use Behat\Gherkin\Node\StepNode;

/**
 * @author  Jefersson Nathan  <[email protected]>
 * @license MIT
 */
final class Step extends AbstractFormatter
{
    const ALIGN_TO_LEFT  = 'left';
    const ALIGN_TO_RIGHT = 'right';

    /**
     * @var string
     */
    private $align;

    /**
     * @param string $align
     */
    public function __construct($align = self::ALIGN_TO_RIGHT)
    {
        $this->align = $align;
    }

    /**
     * @param \Behat\Gherkin\Node\StepNode[] $steps
     *
     * @return string
     */
    public function format(array $steps)
    {
        return implode(
            array_map(
                function (StepNode $step) {
                    return $this->getStepText($step) . $this->getArguments($step);
                },
                $steps
            )
        );
    }

    /**
     * @param string $keyword
     *
     * @return int
     */
    private function computeIndentationSpaces($keyword)
    {
        if ($this->align === self::ALIGN_TO_RIGHT) {
            return (self::INDENTATION * 2) - strlen(trim($keyword)) + 1;
        }

        return self::INDENTATION;
    }

    /**
     * @param StepNode $step
     *
     * @return string
     */
    private function getStepText(StepNode $step)
    {
        $spacesQuantity = $this->computeIndentationSpaces($step->getKeyword());

        return rtrim(sprintf(
            '%s%s %s',
            $this->indent($spacesQuantity + self::INDENTATION),
            trim($step->getKeyword()),
            trim($step->getText())
        )) . "\n";

    }

    /**
     * @param StepNode $step
     *
     * @return string
     */
    private function getArguments(StepNode $step)
    {
        if (! $step->hasArguments()) {
            return;
        }

        return implode(
            array_map(
                function (ArgumentInterface $argument) {
                    if (in_array($argument->getNodeType(), ['Table', 'ExampleTable'])) {
                        return implode(
                            array_map(
                                function ($arguments) {
                                    return $this->indent(self::INDENTATION * 2 + 4) . trim($arguments) . "\n";
                                },
                                explode("\n", $argument->getTableAsString())
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                            )
                        );
                    }

                    if ('PyString' === $argument->getNodeType()) {
                        return $this->encapsulateAsPyString(
                            implode(
                                array_map(
                                    function ($arguments) {
                                        return rtrim($this->indent(self::INDENTATION * 2 + 2) . trim($arguments)) . "\n";
                                    },
                                    $argument->getStrings()
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                                )
                            )
                        );
                    }
                },
                $step->getArguments()
            )
        );
    }

    /**
     * @param string $string
     *
     * @return string
     */
    private function encapsulateAsPyString($string)
    {
        return sprintf('%s%s%1$s', $this->indent(8) . '"""' . "\n", $string);
    }
}


1		<?php
2		/*
3		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14		*
15		* This software consists of voluntary contributions made by many individuals
16		* and is licensed under the MIT license.
17		*/
18
19		namespace KawaiiGherkin\Formatter;
20
21		use Behat\Gherkin\Node\ArgumentInterface;
22		use Behat\Gherkin\Node\StepNode;
23
24		/**
25		* @author Jefersson Nathan <[email protected]>
26		* @license MIT
27		*/
28		final class Step extends AbstractFormatter
29		{
30		const ALIGN_TO_LEFT = 'left';
31		const ALIGN_TO_RIGHT = 'right';
32
33		/**
34		* @var string
35		*/
36		private $align;
37
38		/**
39		* @param string $align
40		*/
41	3	public function __construct($align = self::ALIGN_TO_RIGHT)
42		{
43	3	$this->align = $align;
44	3	}
45
46		/**
47		* @param \Behat\Gherkin\Node\StepNode[] $steps
48		*
49		* @return string
50		*/
51	3	public function format(array $steps)
52		{
53	3	return implode(
54	3	array_map(
55		function (StepNode $step) {
56	3	return $this->getStepText($step) . $this->getArguments($step);
57	3	},
58	3	$steps
59		)
60		);
61		}
62
63		/**
64		* @param string $keyword
65		*
66		* @return int
67		*/
68	3	private function computeIndentationSpaces($keyword)
69		{
70	3	if ($this->align === self::ALIGN_TO_RIGHT) {
71	1	return (self::INDENTATION * 2) - strlen(trim($keyword)) + 1;
72		}
73
74	2	return self::INDENTATION;
75		}
76
77		/**
78		* @param StepNode $step
79		*
80		* @return string
81		*/
82	3	private function getStepText(StepNode $step)
83		{
84	3	$spacesQuantity = $this->computeIndentationSpaces($step->getKeyword());
85
86	3	return rtrim(sprintf(
87	3	'%s%s %s',
88	3	$this->indent($spacesQuantity + self::INDENTATION),
89	3	trim($step->getKeyword()),
90	3	trim($step->getText())
91	3	)) . "\n";
92
93		}
94
95		/**
96		* @param StepNode $step
97		*
98		* @return string
99		*/
100	3	private function getArguments(StepNode $step)
101		{
102	3	if (! $step->hasArguments()) {
103	3	return;
104		}
105
106	3	return implode(
107	3	array_map(
108		function (ArgumentInterface $argument) {
109	3	if (in_array($argument->getNodeType(), ['Table', 'ExampleTable'])) {
110	2	return implode(
111	2	array_map(
112		function ($arguments) {
113	2	return $this->indent(self::INDENTATION * 2 + 4) . trim($arguments) . "\n";
114	2	},
115	2	explode("\n", $argument->getTableAsString())
		0 ignored issues – show Bug introduced 2016-01-30 12:29 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a concrete implementation and not the interface `Behat\Gherkin\Node\ArgumentInterface` as the method `getTableAsString()` does only exist in the following implementations of said interface: `Behat\Gherkin\Node\ExampleTableNode`, `Behat\Gherkin\Node\TableNode`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
116		)
117		);
118		}
119
120	1	if ('PyString' === $argument->getNodeType()) {
121	1	return $this->encapsulateAsPyString(
122	1	implode(
123	1	array_map(
124	1	function ($arguments) {
125	1	return rtrim($this->indent(self::INDENTATION * 2 + 2) . trim($arguments)) . "\n";
126	1	},
127	1	$argument->getStrings()
		0 ignored issues – show Bug introduced 2016-01-30 12:29 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a concrete implementation and not the interface `Behat\Gherkin\Node\ArgumentInterface` as the method `getStrings()` does only exist in the following implementations of said interface: `Behat\Gherkin\Node\PyStringNode`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
128		)
129		)
130		);
131		}
132	3	},
133	3	$step->getArguments()
134		)
135		);
136		}
137
138		/**
139		* @param string $string
140		*
141		* @return string
142		*/
143	1	private function encapsulateAsPyString($string)
144		{
145	1	return sprintf('%s%s%1$s', $this->indent(8) . '"""' . "\n", $string);
146		}
147		}
148

malukenho / kawaii-gherkin

Issues (4)

Security Analysis no request data

src/Formatter/Step.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like