Issues (1401)

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.

repo/includes/Api/SetLabel.php (2 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
namespace Wikibase\Repo\Api;
6
7
use ApiMain;
8
use Wikibase\DataModel\Entity\EntityDocument;
9
use Wikibase\DataModel\Term\LabelsProvider;
10
use Wikibase\Lib\Summary;
11
use Wikibase\Repo\ChangeOp\ChangeOp;
12
use Wikibase\Repo\ChangeOp\ChangeOps;
13
use Wikibase\Repo\ChangeOp\FingerprintChangeOpFactory;
14
use Wikibase\Repo\WikibaseRepo;
15
16
/**
17
 * API module to set the label for a Wikibase entity.
18
 * Requires API write mode to be enabled.
19
 *
20
 * @license GPL-2.0-or-later
21
 * @author Jeroen De Dauw < [email protected] >
22
 * @author John Erling Blad < [email protected] >
23
 * @author Tobias Gritschacher < [email protected] >
24
 */
25
class SetLabel extends ModifyTerm {
26
27
	/**
28
	 * @var FingerprintChangeOpFactory
29
	 */
30
	private $termChangeOpFactory;
31
32
	public function __construct(
33
		ApiMain $mainModule,
34
		string $moduleName,
35
		FingerprintChangeOpFactory $termChangeOpFactory,
36
		bool $federatedPropertiesEnabled
37
	) {
38
		parent::__construct( $mainModule, $moduleName, $federatedPropertiesEnabled );
39
40
		$this->termChangeOpFactory = $termChangeOpFactory;
41
	}
42
43
	public static function factory( ApiMain $mainModule, string $moduleName ): self {
44
		$wikibaseRepo = WikibaseRepo::getDefaultInstance();
45
		return new self(
46
			$mainModule,
47
			$moduleName,
48
			$wikibaseRepo->getChangeOpFactoryProvider()
49
				->getFingerprintChangeOpFactory(),
50
			$wikibaseRepo->inFederatedPropertyMode()
51
		);
52
	}
53
54
	protected function modifyEntity( EntityDocument $entity, ChangeOp $changeOp, array $preparedParameters ): Summary {
55
		if ( !( $entity instanceof LabelsProvider ) ) {
56
			$this->errorReporter->dieError( 'The given entity cannot contain labels', 'not-supported' );
0 ignored issues
show
Deprecated Code introduced by
The method Wikibase\Repo\Api\ApiErrorReporter::dieError() has been deprecated with message: Use dieWithError() instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
57
		}
58
59
		$summary = $this->createSummary( $preparedParameters );
60
		$language = $preparedParameters['language'];
61
62
		$this->applyChangeOp( $changeOp, $entity, $summary );
63
64
		$labels = $entity->getLabels();
0 ignored issues
show
It seems like you code against a concrete implementation and not the interface Wikibase\DataModel\Entity\EntityDocument as the method getLabels() does only exist in the following implementations of said interface: Wikibase\DataModel\Entity\Item, Wikibase\DataModel\Entity\Property.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
65
		$resultBuilder = $this->getResultBuilder();
66
67
		if ( $labels->hasTermForLanguage( $language ) ) {
68
			$termList = $labels->getWithLanguages( [ $language ] );
69
			$resultBuilder->addLabels( $termList, 'entity' );
70
		} else {
71
			$resultBuilder->addRemovedLabel( $language, 'entity' );
72
		}
73
74
		return $summary;
75
	}
76
77
	protected function getChangeOp( array $preparedParameters, EntityDocument $entity ): ChangeOp {
78
		$label = "";
79
		$language = $preparedParameters['language'];
80
81
		if ( isset( $preparedParameters['value'] ) ) {
82
			$label = $this->stringNormalizer->trimToNFC( $preparedParameters['value'] );
83
		}
84
85
		if ( $label === "" ) {
86
			$op = $this->termChangeOpFactory->newRemoveLabelOp( $language );
87
		} else {
88
			$op = $this->termChangeOpFactory->newSetLabelOp( $language, $label );
89
		}
90
91
		return $this->termChangeOpFactory->newFingerprintChangeOp( new ChangeOps( $op ) );
92
	}
93
94
	/**
95
	 * @see ApiBase::needsToken
96
	 *
97
	 * @return string
98
	 */
99
	public function needsToken(): string {
100
		return 'csrf';
101
	}
102
103
	/**
104
	 * @see ApiBase::isWriteMode()
105
	 *
106
	 * @return bool Always true.
107
	 */
108
	public function isWriteMode(): bool {
109
		return true;
110
	}
111
112
	/**
113
	 * @inheritDoc
114
	 */
115
	protected function getExamplesMessages(): array {
116
		return [
117
			'action=wbsetlabel&id=Q42&language=en&value=Wikimedia&format=jsonfm'
118
				=> 'apihelp-wbsetlabel-example-1',
119
			'action=wbsetlabel&site=enwiki&title=Earth&language=en&value=Earth'
120
				=> 'apihelp-wbsetlabel-example-2',
121
		];
122
	}
123
124
	/**
125
	 * @inheritDoc
126
	 */
127
	protected function getAllowedParams(): array {
128
		return array_merge(
129
			parent::getAllowedParams(),
130
			[
131
				'new' => [
132
					self::PARAM_TYPE => $this->getEntityTypesWithLabels(),
133
				],
134
			]
135
		);
136
	}
137
138
	protected function getEntityTypesWithLabels(): array {
139
		// TODO inject me
140
		$entityFactory = WikibaseRepo::getDefaultInstance()->getEntityFactory();
141
		$supportedEntityTypes = [];
142
		foreach ( $this->enabledEntityTypes as $entityType ) {
143
			$testEntity = $entityFactory->newEmpty( $entityType );
144
			if ( $testEntity instanceof LabelsProvider ) {
145
				$supportedEntityTypes[] = $entityType;
146
			}
147
		}
148
		return $supportedEntityTypes;
149
	}
150
151
}
152