Issues (4122)

Security Analysis    not enabled

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.

includes/libs/lockmanager/RedisLockManager.php (2 issues)

Labels
Severity

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
 * Version of LockManager based on using redis servers.
4
 *
5
 * This program is free software; you can redistribute it and/or modify
6
 * it under the terms of the GNU General Public License as published by
7
 * the Free Software Foundation; either version 2 of the License, or
8
 * (at your option) any later version.
9
 *
10
 * This program is distributed in the hope that it will be useful,
11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
 * GNU General Public License for more details.
14
 *
15
 * You should have received a copy of the GNU General Public License along
16
 * with this program; if not, write to the Free Software Foundation, Inc.,
17
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18
 * http://www.gnu.org/copyleft/gpl.html
19
 *
20
 * @file
21
 * @ingroup LockManager
22
 */
23
24
/**
25
 * Manage locks using redis servers.
26
 *
27
 * Version of LockManager based on using redis servers.
28
 * This is meant for multi-wiki systems that may share files.
29
 * All locks are non-blocking, which avoids deadlocks.
30
 *
31
 * All lock requests for a resource, identified by a hash string, will map to one
32
 * bucket. Each bucket maps to one or several peer servers, each running redis.
33
 * A majority of peers must agree for a lock to be acquired.
34
 *
35
 * This class requires Redis 2.6 as it makes use Lua scripts for fast atomic operations.
36
 *
37
 * @ingroup LockManager
38
 * @since 1.22
39
 */
40
class RedisLockManager extends QuorumLockManager {
41
	/** @var array Mapping of lock types to the type actually used */
42
	protected $lockTypeMap = [
43
		self::LOCK_SH => self::LOCK_SH,
44
		self::LOCK_UW => self::LOCK_SH,
45
		self::LOCK_EX => self::LOCK_EX
46
	];
47
48
	/** @var RedisConnectionPool */
49
	protected $redisPool;
50
51
	/** @var array Map server names to hostname/IP and port numbers */
52
	protected $lockServers = [];
53
54
	/**
55
	 * Construct a new instance from configuration.
56
	 *
57
	 * @param array $config Parameters include:
58
	 *   - lockServers  : Associative array of server names to "<IP>:<port>" strings.
59
	 *   - srvsByBucket : Array of 1-16 consecutive integer keys, starting from 0,
60
	 *                    each having an odd-numbered list of server names (peers) as values.
61
	 *   - redisConfig  : Configuration for RedisConnectionPool::__construct().
62
	 * @throws Exception
63
	 */
64
	public function __construct( array $config ) {
65
		parent::__construct( $config );
66
67
		$this->lockServers = $config['lockServers'];
68
		// Sanitize srvsByBucket config to prevent PHP errors
69
		$this->srvsByBucket = array_filter( $config['srvsByBucket'], 'is_array' );
70
		$this->srvsByBucket = array_values( $this->srvsByBucket ); // consecutive
71
72
		$config['redisConfig']['serializer'] = 'none';
73
		$this->redisPool = RedisConnectionPool::singleton( $config['redisConfig'] );
74
	}
75
76
	protected function getLocksOnServer( $lockSrv, array $pathsByType ) {
77
		$status = StatusValue::newGood();
78
79
		$pathList = call_user_func_array( 'array_merge', array_values( $pathsByType ) );
80
81
		$server = $this->lockServers[$lockSrv];
82
		$conn = $this->redisPool->getConnection( $server, $this->logger );
83
		if ( !$conn ) {
84
			foreach ( $pathList as $path ) {
85
				$status->fatal( 'lockmanager-fail-acquirelock', $path );
86
			}
87
88
			return $status;
89
		}
90
91
		$pathsByKey = []; // (type:hash => path) map
92
		foreach ( $pathsByType as $type => $paths ) {
93
			$typeString = ( $type == LockManager::LOCK_SH ) ? 'SH' : 'EX';
94
			foreach ( $paths as $path ) {
95
				$pathsByKey[$this->recordKeyForPath( $path, $typeString )] = $path;
96
			}
97
		}
98
99
		try {
100
			static $script =
101
			/** @lang Lua */
102
<<<LUA
103
			local failed = {}
104
			-- Load input params (e.g. session, ttl, time of request)
105
			local rSession, rTTL, rMaxTTL, rTime = unpack(ARGV)
106
			-- Check that all the locks can be acquired
107
			for i,requestKey in ipairs(KEYS) do
108
				local _, _, rType, resourceKey = string.find(requestKey,"(%w+):(%w+)$")
109
				local keyIsFree = true
110
				local currentLocks = redis.call('hKeys',resourceKey)
111
				for i,lockKey in ipairs(currentLocks) do
112
					-- Get the type and session of this lock
113
					local _, _, type, session = string.find(lockKey,"(%w+):(%w+)")
114
					-- Check any locks that are not owned by this session
115
					if session ~= rSession then
116
						local lockExpiry = redis.call('hGet',resourceKey,lockKey)
117
						if 1*lockExpiry < 1*rTime then
118
							-- Lock is stale, so just prune it out
119
							redis.call('hDel',resourceKey,lockKey)
120
						elseif rType == 'EX' or type == 'EX' then
121
							keyIsFree = false
122
							break
123
						end
124
					end
125
				end
126
				if not keyIsFree then
127
					failed[#failed+1] = requestKey
128
				end
129
			end
130
			-- If all locks could be acquired, then do so
131
			if #failed == 0 then
132
				for i,requestKey in ipairs(KEYS) do
133
					local _, _, rType, resourceKey = string.find(requestKey,"(%w+):(%w+)$")
134
					redis.call('hSet',resourceKey,rType .. ':' .. rSession,rTime + rTTL)
135
					-- In addition to invalidation logic, be sure to garbage collect
136
					redis.call('expire',resourceKey,rMaxTTL)
137
				end
138
			end
139
			return failed
140
LUA;
141
			$res = $conn->luaEval( $script,
142
				array_merge(
143
					array_keys( $pathsByKey ), // KEYS[0], KEYS[1],...,KEYS[N]
144
					[
145
						$this->session, // ARGV[1]
146
						$this->lockTTL, // ARGV[2]
147
						self::MAX_LOCK_TTL, // ARGV[3]
148
						time() // ARGV[4]
149
					]
150
				),
151
				count( $pathsByKey ) # number of first argument(s) that are keys
152
			);
153
		} catch ( RedisException $e ) {
0 ignored issues
show
The class RedisException does not exist. Did you forget a USE statement, or did you not list all dependencies?

Scrutinizer analyzes your composer.json/composer.lock file if available to determine the classes, and functions that are defined by your dependencies.

It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis.

Loading history...
154
			$res = false;
155
			$this->redisPool->handleError( $conn, $e );
156
		}
157
158
		if ( $res === false ) {
159
			foreach ( $pathList as $path ) {
160
				$status->fatal( 'lockmanager-fail-acquirelock', $path );
161
			}
162
		} else {
163
			foreach ( $res as $key ) {
164
				$status->fatal( 'lockmanager-fail-acquirelock', $pathsByKey[$key] );
165
			}
166
		}
167
168
		return $status;
169
	}
170
171
	protected function freeLocksOnServer( $lockSrv, array $pathsByType ) {
172
		$status = StatusValue::newGood();
173
174
		$pathList = call_user_func_array( 'array_merge', array_values( $pathsByType ) );
175
176
		$server = $this->lockServers[$lockSrv];
177
		$conn = $this->redisPool->getConnection( $server, $this->logger );
178
		if ( !$conn ) {
179
			foreach ( $pathList as $path ) {
180
				$status->fatal( 'lockmanager-fail-releaselock', $path );
181
			}
182
183
			return $status;
184
		}
185
186
		$pathsByKey = []; // (type:hash => path) map
187
		foreach ( $pathsByType as $type => $paths ) {
188
			$typeString = ( $type == LockManager::LOCK_SH ) ? 'SH' : 'EX';
189
			foreach ( $paths as $path ) {
190
				$pathsByKey[$this->recordKeyForPath( $path, $typeString )] = $path;
191
			}
192
		}
193
194
		try {
195
			static $script =
196
			/** @lang Lua */
197
<<<LUA
198
			local failed = {}
199
			-- Load input params (e.g. session)
200
			local rSession = unpack(ARGV)
201
			for i,requestKey in ipairs(KEYS) do
202
				local _, _, rType, resourceKey = string.find(requestKey,"(%w+):(%w+)$")
203
				local released = redis.call('hDel',resourceKey,rType .. ':' .. rSession)
204
				if released > 0 then
205
					-- Remove the whole structure if it is now empty
206
					if redis.call('hLen',resourceKey) == 0 then
207
						redis.call('del',resourceKey)
208
					end
209
				else
210
					failed[#failed+1] = requestKey
211
				end
212
			end
213
			return failed
214
LUA;
215
			$res = $conn->luaEval( $script,
216
				array_merge(
217
					array_keys( $pathsByKey ), // KEYS[0], KEYS[1],...,KEYS[N]
218
					[
219
						$this->session, // ARGV[1]
220
					]
221
				),
222
				count( $pathsByKey ) # number of first argument(s) that are keys
223
			);
224
		} catch ( RedisException $e ) {
0 ignored issues
show
The class RedisException does not exist. Did you forget a USE statement, or did you not list all dependencies?

Scrutinizer analyzes your composer.json/composer.lock file if available to determine the classes, and functions that are defined by your dependencies.

It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis.

Loading history...
225
			$res = false;
226
			$this->redisPool->handleError( $conn, $e );
227
		}
228
229
		if ( $res === false ) {
230
			foreach ( $pathList as $path ) {
231
				$status->fatal( 'lockmanager-fail-releaselock', $path );
232
			}
233
		} else {
234
			foreach ( $res as $key ) {
235
				$status->fatal( 'lockmanager-fail-releaselock', $pathsByKey[$key] );
236
			}
237
		}
238
239
		return $status;
240
	}
241
242
	protected function releaseAllLocks() {
243
		return StatusValue::newGood(); // not supported
244
	}
245
246
	protected function isServerUp( $lockSrv ) {
247
		$conn = $this->redisPool->getConnection( $this->lockServers[$lockSrv], $this->logger );
248
249
		return (bool)$conn;
250
	}
251
252
	/**
253
	 * @param string $path
254
	 * @param string $type One of (EX,SH)
255
	 * @return string
256
	 */
257
	protected function recordKeyForPath( $path, $type ) {
258
		return implode( ':',
259
			[ __CLASS__, 'locks', "$type:" . $this->sha1Base36Absolute( $path ) ] );
260
	}
261
262
	/**
263
	 * Make sure remaining locks get cleared for sanity
264
	 */
265
	function __destruct() {
266
		while ( count( $this->locksHeld ) ) {
267
			$pathsByType = [];
268
			foreach ( $this->locksHeld as $path => $locks ) {
269
				foreach ( $locks as $type => $count ) {
270
					$pathsByType[$type][] = $path;
271
				}
272
			}
273
			$this->unlockByType( $pathsByType );
274
		}
275
	}
276
}
277