README

The VirtualPath library normalises paths and prevents directory traversal attacks without querying a file system.

Installation
Dependencies
Usage
Examples
Implementation Details
Tests

Installation

It's recommended to use the dependency manager Composer to install rayne/virtual-path.

composer require rayne/virtual-path

Dependencies

PHP 5.6 or better

Usage

The VirtualPath class normalises inputs to absolute virtual paths without querying any file system. It also detects and flags directory traversal attacks.

The JailedPath class utilises VirtualPath to build safe paths which can be used for working with real files. The normalisation is done relative to a jail called path which is used as virtual root for any path entered by the user. As JailedPath does not query the file system it's suited for working with local, remote or fictional paths.

Please read the Implementation Details section for more details.

TL;DR Use the JailedPath class when in doubt.

Examples

`JailedPath`

In this example website visitors are allowed to download any file from the local directory /test by specifying the relative path as GET parameter. To prevent users from leaving the directory with directory traversal attacks, JailedPath is used with /test as the virtual root directory.

<?php

use Rayne\VirtualPath\JailedPath;

$jailedPath = new JailedPath('/test', $_GET['path'] ?? '');

if ($jailedPath->hasJailbreakAttempt()) {
    // Log jailbreak attempt, ban user, …
    return;
}

if (is_file($jailedPath->getAbsolutePath())) {
    @readfile($jailedPath->getAbsolutePath());
}

The following table shows how user defined paths are normalised and how they are interpreted relative to the virtual root.

`VirtualPath`

If a fixed prefix or the sugar coating of JailedPath isn't required, then VirtualPath is sufficient as it is the class used for normalising paths. VirtualPath normalises the input and provides a trusted (normalised, with a leading /) and an untrusted (a string representation of the probably malicious user input) path.

The previous example can be easily recreated with VirtualPath when the instance of VirtualPath (which is (string) cast-able) is appended to the virtual root directory.

<?php

use Rayne\VirtualPath\VirtualPath;

$path = new VirtualPath($_GET['path'] ?? '');
$absolutePath = '/test' . $path;

Depending on the usage scenario it's sometimes useful to work with the normalised trusted path even if the original input is not trustworthy, e.g. when explicitly supporting relative paths and giving the user the benefit of doubt when accidentally trying to access files outside of the virtual path.

Note: VirtualPath returns the normalised path with a leading /. When working with files it's recommended to add a trusted path as prefix (see code example in the current section) as otherwise files relative to the file system's root would be referenced. To not forget to add the prefix use the JailedPath class instead when working with real files.

Implementation Details

Using a pure virtual normalised path has different benefits:

Path normalisation is done without querying a file system
It's impossible to forge timing attacks for files outside of the scope of the virtual path
No complex comparisons are required to limit directory traversals to a specific directory and its children
Only ., .., \ (normalised to /) and / are interpreted for path normalisation
No unexpected and information leaking ~ expansions as seen in other libraries

The implementation of VirtualPath does not interpret, alter or remove control characters and Unicode:

Directory and file paths are allowed to contain control characters on some systems
Removing control characters is out of scope for the library

Tests

Clone the repository

git clone https://github.com/rayne/virtual-path.git

Install the development dependencies
```
composer install --dev
```
Run the tests
```
composer test
```

rayne / virtual-path

Maintainers

Details