1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Test\Legacy;
use Magento\Framework\App\Utility\Files;
use Magento\Framework\Component\ComponentRegistrar;
use Magento\TestFramework\Utility\FunctionDetector;
/**
* Tests to detect unsecure functions usage
*/
class UnsecureFunctionsUsageTest extends \PHPUnit\Framework\TestCase
{
/**
* Php unsecure functions
*
* @var array
*/
private static $phpUnsecureFunctions = [];
/**
* JS unsecure functions
*
* @var array
*/
private static $jsUnsecureFunctions = [];
/**
* File extensions pattern to search for
*
* @var string
*/
private $fileExtensions = '/\.(php|phtml|js)$/';
/**
* Read fixtures into memory as arrays
*
* @return void
*/
public static function setUpBeforeClass()
{
self::loadData(self::$phpUnsecureFunctions, 'unsecure_php_functions*.php');
self::loadData(self::$jsUnsecureFunctions, 'unsecure_js_functions*.php');
}
/**
* Loads and merges data from fixtures
*
* @param array $data
* @param string $filePattern
* @return void
*/
private static function loadData(array &$data, $filePattern)
{
foreach (glob(__DIR__ . '/_files/security/' . $filePattern) as $file) {
$data = array_merge_recursive($data, self::readList($file));
}
$componentRegistrar = new ComponentRegistrar();
foreach ($data as $key => $value) {
$excludes = $value['exclude'];
$excludePaths = [];
foreach ($excludes as $exclude) {
if ('setup' == $exclude['type']) {
$excludePaths[] = BP . '/setup/' . $exclude['path'];
} else {
$excludePaths[] = $componentRegistrar->getPath($exclude['type'], $exclude['name'])
. '/' . $exclude['path'];
}
}
$data[$key]['exclude'] = $excludePaths;
}
}
/**
* Isolate including a file into a method to reduce scope
*
* @param string $file
* @return array
*/
private static function readList($file)
{
return include $file;
}
/**
* Detect unsecure functions usage for changed files in whitelist with the exception of blacklist
*
* @return void
*/
public function testUnsecureFunctionsUsage()
{
$invoker = new \Magento\Framework\App\Utility\AggregateInvoker($this);
$functionDetector = new FunctionDetector();
$invoker(
function ($fileFullPath) use ($functionDetector) {
$functions = $this->getFunctions($fileFullPath);
$lines = $functionDetector->detect($fileFullPath, array_keys($functions));
$message = '';
if (!empty($lines)) {
$message = $this->composeMessage($fileFullPath, $lines, $functions);
}
$this->assertEmpty(
$lines,
$message
);
},
$this->getFilesToVerify()
);
}
/**
* Compose message
*
* @param string $fileFullPath
* @param array $lines
* @param array $functionRules
* @return string
*/
private function composeMessage($fileFullPath, $lines, $functionRules)
{
$result = '';
foreach ($lines as $lineNumber => $detectedFunctions) {
$detectedFunctionRules = array_intersect_key($functionRules, array_flip($detectedFunctions));
$replacementString = '';
foreach ($detectedFunctionRules as $function => $functionRule) {
$replacement = $functionRule['replacement'];
if (is_array($replacement)) {
$replacement = array_unique($replacement);
$replacement = count($replacement) > 1 ?
"[\n\t\t\t" . implode("\n\t\t\t", $replacement) . "\n\t\t]" :
$replacement[0];
}
$replacement = empty($replacement) ? 'No suggested replacement at this time' : $replacement;
$replacementString .= "\t\t'$function' => '$replacement'\n";
}
$result .= sprintf(
"Functions '%s' are not secure in %s. \n\tSuggested replacement:\n%s",
implode(', ', $detectedFunctions),
$fileFullPath . ':' . $lineNumber,
$replacementString
);
}
return $result;
}
/**
* Get files to be verified
*
* @return array
*/
private function getFilesToVerify()
{
$fileExtensions = $this->fileExtensions;
$directoriesToScan = Files::init()->readLists(__DIR__ . '/_files/security/whitelist.txt');
$filesToVerify = [];
foreach (glob(__DIR__ . '/../_files/changed_files*') as $listFile) {
$filesToVerify = array_merge(
$filesToVerify,
file($listFile, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES)
);
}
array_walk(
$filesToVerify,
function (&$file) {
$file = [BP . '/' . $file];
}
);
$filesToVerify = array_filter(
$filesToVerify,
function ($path) use ($directoriesToScan, $fileExtensions) {
if (!file_exists($path[0])) {
return false;
}
$path = realpath($path[0]);
foreach ($directoriesToScan as $directory) {
$directory = realpath($directory);
if (strpos($path, $directory) === 0) {
if (preg_match($fileExtensions, $path)) {
// skip unit tests
if (preg_match('#' . preg_quote('Test/Unit', '#') . '#', $path)) {
return false;
}
return true;
}
}
}
return false;
}
);
return $filesToVerify;
}
/**
* Get functions for the given file
*
* @param string $fileFullPath
* @return array
*/
private function getFunctions($fileFullPath)
{
$fileExtension = pathinfo($fileFullPath, PATHINFO_EXTENSION);
$functions = [];
if ($fileExtension == 'php') {
$functions = self::$phpUnsecureFunctions;
} elseif ($fileExtension == 'js') {
$functions = self::$jsUnsecureFunctions;
} elseif ($fileExtension == 'phtml') {
$functions = array_merge_recursive(self::$phpUnsecureFunctions, self::$jsUnsecureFunctions);
}
foreach ($functions as $function => $functionRules) {
if (in_array($fileFullPath, $functionRules['exclude'])) {
unset($functions[$function]);
}
}
return $functions;
}
}