Renamed resolver -> resolve
Signed-off-by: Diederik de Groot <ddegroot@talon.nl>
This commit is contained in:
Diederik de Groot
190
lib/resolve.php
Normal file
190
lib/resolve.php
Normal file
@@ -0,0 +1,190 @@
|
||||
<?php
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace SCCP\Resolve;
|
||||
include_once("config.php");
|
||||
include_once("utils.php");
|
||||
include_once("resolveCache.php");
|
||||
|
||||
use SCCP\Utils as Utils;
|
||||
use SCCP\ResolveCache as ResolveCache;
|
||||
|
||||
/* Todo:
|
||||
✔️ setup logging
|
||||
✔️ read config.file
|
||||
|
||||
✔?️ improve error handling
|
||||
✔️? secure urlencoding/urldecoding
|
||||
✔️? don't allow browsing
|
||||
|
||||
- check source ip-range
|
||||
- check HTTPHeader for known BrowserTypes
|
||||
|
||||
- Could use some more test-cases, especially error ones
|
||||
*/
|
||||
//class ResolveResult extends Enum {
|
||||
class ResolveResult {
|
||||
const Ok = 0;
|
||||
const EmptyRequest = 1;
|
||||
const RequestNotAString = 2;
|
||||
const RequestContainsInvalidChar = 3;
|
||||
const RequestContainsPathWalk = 4;
|
||||
const FileNotFound = 5;
|
||||
const InvalidFilename = 6;
|
||||
const InvalidPath = 7;
|
||||
}
|
||||
|
||||
class Resolve {
|
||||
private $isDirty = FALSE;
|
||||
private $cache;
|
||||
private $config;
|
||||
function __construct($config) {
|
||||
$this->config = $config;
|
||||
$this->cache = new ResolveCache\fileCache($this->config['main']['cache_filename']);
|
||||
if ($this->cache->isDirty()) {
|
||||
$this->rebuildCache();
|
||||
}
|
||||
}
|
||||
|
||||
public function searchForFile($filename) {
|
||||
$path = "";
|
||||
foreach($this->config['subdirs'] as $key => $value) {
|
||||
if ($key === "firmware" || $key === "data" || $key === "etc") {
|
||||
continue;
|
||||
}
|
||||
$path = realpath($this->config['main']['base_path'] . DIRECTORY_SEPARATOR . $value['path'] . DIRECTORY_SEPARATOR . $filename);
|
||||
if (!$path) {
|
||||
print("path: '" . $this->config['main']['base_path'] . DIRECTORY_SEPARATOR . $value['path'] . DIRECTORY_SEPARATOR . $filename . "' not found\n");
|
||||
return ResolveResult::FileNotFound;
|
||||
}
|
||||
$this->cache->addFile($filename, $path);
|
||||
return $path;
|
||||
}
|
||||
Utils\log_error("File '$filename' does not exist");
|
||||
return ResolveResult::FileNotFound;
|
||||
}
|
||||
|
||||
public function rebuildCache() {
|
||||
Utils\log_debug("Rebuilding Cache, standby...");
|
||||
foreach($this->config['subdirs'] as $key =>$value) {
|
||||
if ($key === "data" || $key === "etc") {
|
||||
continue;
|
||||
}
|
||||
$path = realpath($this->config['main']['base_path'] . DIRECTORY_SEPARATOR . $value['path'] . DIRECTORY_SEPARATOR);
|
||||
if (!$path) {
|
||||
print("path: '" . $this->config['main']['base_path'] . DIRECTORY_SEPARATOR . $value['path'] . "' not found\n");
|
||||
break;
|
||||
}
|
||||
$dir_iterator = new \RecursiveDirectoryIterator($path);
|
||||
$filter = new \RecursiveCallbackFilterIterator($dir_iterator, function ($current, $key, $iterator) {
|
||||
// Skip hidden files and directories.
|
||||
if ($current->getFilename()[0] === '.' || $current->getFilename() == "bak") {
|
||||
return FALSE;
|
||||
}
|
||||
return TRUE;
|
||||
});
|
||||
$iterator = new \RecursiveIteratorIterator($filter, \RecursiveIteratorIterator::SELF_FIRST);
|
||||
foreach ($iterator as $file) {
|
||||
if ($file->isFile()) {
|
||||
if ($value['strip']) {
|
||||
$this->cache->addFile($file->getFileName(), $file->getPathname());
|
||||
} else {
|
||||
$subdir = basename(dirname($file->getPathname()));
|
||||
$this->cache->addFile($subdir. DIRECTORY_SEPARATOR . $file->getFileName(), $file->getPathname());
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
$this->isDirty = TRUE;
|
||||
}
|
||||
|
||||
public function validateRequest($request) {
|
||||
/* make sure request does not startwith or contain: "/", "../" or "/./" */
|
||||
/* make sure request only starts with filename or one of $config[$subdir]['locale'] or $config[$subdir]['wallpaper'] */
|
||||
/* check uri/url decode */
|
||||
if (!$request || empty($request)) {
|
||||
log_error("Request is empty");
|
||||
return ResolveResult::EmptyRequest;
|
||||
}
|
||||
if (!is_string($request)) {
|
||||
log_error("Request is not a string");
|
||||
return ResolveResult::RequestNotAString;
|
||||
}
|
||||
Utils\log_debug($request . ":" . escapeshellarg($request) . ":" . Utils\utf8_urldecode($request) . "\n");
|
||||
$escaped_request = escapeshellarg(Utils\utf8_urldecode($request));
|
||||
if ($escaped_request !== "'" . $request . "'") {
|
||||
log_error("Request '$request' contains invalid characters");
|
||||
return ResolveResult::RequestContainsInvalidChar;
|
||||
}
|
||||
if (strstr($escaped_request, "..")) {
|
||||
Utils\log_error("Request '$request' contains '..'");
|
||||
return ResolveResult::RequestContainsPathWalk;
|
||||
}
|
||||
return ResolveResult::Ok;
|
||||
}
|
||||
|
||||
public function resolve($request) /* canthrow */ {
|
||||
$path = '';
|
||||
$result = $this->validateRequest($request);
|
||||
if ($result !== ResolveResult::Ok) {
|
||||
return $result;
|
||||
}
|
||||
if (($path = $this->cache->getPath($request))) {
|
||||
if (!file_exists($path)) {
|
||||
$this->cache->removeFile($request);
|
||||
log_error("File '$request' does not exist on FS");
|
||||
return ResolveResult::FileNotFound;
|
||||
}
|
||||
return $path;
|
||||
}
|
||||
if ($this->searchForFile($request)) {
|
||||
$path = $this->cache->getPath($request);
|
||||
}
|
||||
return $path;
|
||||
}
|
||||
|
||||
/* temporary */
|
||||
function printCache() {
|
||||
print_r($this->cache);
|
||||
}
|
||||
}
|
||||
|
||||
// Testing
|
||||
if(defined('STDIN') ) {
|
||||
$resolve = new Resolve($config);
|
||||
$test_cases = Array(
|
||||
Array('request' => 'jar70sccp.9-4-2ES26.sbn', 'expected' => '/data/firmware/7970/jar70sccp.9-4-2ES26.sbn'),
|
||||
Array('request' => 'Russian_Russian_Federation/be-sccp.jar', 'expected' => '/data/locales/languages/Russian_Russian_Federation/be-sccp.jar'),
|
||||
Array('request' => 'Spain/g3-tones.xml', 'expected' => '/data/locales/countries/Spain/g3-tones.xml'),
|
||||
Array('request' => '320x196x4/Chan-SCCP-b.png', 'expected' => '/data/wallpapers/320x196x4/Chan-SCCP-b.png'),
|
||||
Array('request' => 'XMLDefault.cnf.xml', 'expected' => '/data/settings/XMLDefault.cnf.xml'),
|
||||
Array('request' => '../XMLDefault.cnf.xml', 'expected' => ResolveResult::RequestContainsPathWalk),
|
||||
Array('request' => 'XMLDefault.cnf.xml/../../text.xml', 'expected' => ResolveResult::RequestContainsPathWalk),
|
||||
);
|
||||
foreach($test_cases as $test) {
|
||||
try {
|
||||
$result = $resolve->resolve($test['request']);
|
||||
if (is_string($result)) {
|
||||
if ($result === $base_path . $test['expected']) {
|
||||
print("'" . $test['request'] . "' => '" . $result . "'\n");
|
||||
continue;
|
||||
}
|
||||
} else {
|
||||
if ($result === $test['expected']) {
|
||||
print("'" . $test['request'] . "' => '" . $result . "'\n");
|
||||
continue;
|
||||
}
|
||||
}
|
||||
print("Error: expected result does not match what we got\n");
|
||||
print("request:'".$test['request']."'\n");
|
||||
print("expected:'" . $base_path . $test['expected'] . "'\n");
|
||||
print("result:'" . $result . "'\n\n");
|
||||
} catch (Exception $e) {
|
||||
print("'" . $test['request'] . "' => throws error as expected\n");
|
||||
print("Exception: " . $e->getMessage() . "\n");
|
||||
}
|
||||
}
|
||||
unset($resolve);
|
||||
#unlink($CACHEFILE_NAME);
|
||||
}
|
||||
?>
|
||||
Reference in New Issue
Block a user