Stores PHP code in files with securely hashed names.
The goal of this class is to ensure that if a PHP file is replaced with an untrusted one, it does not get loaded. Since mtime granularity is 1 second, we cannot prevent an attack that happens within one second of the initial save(). However, it is very unlikely for an attacker exploiting an upload or file write vulnerability to also know when a legitimate file is being saved, discover its hash, undo its file permissions, and override the file with an upload all within a single second. Being able to accomplish that would indicate a site very likely vulnerable to many other attack vectors.
Each file is stored in its own unique containing directory. The hash is based on the virtual file name, the containing directory's mtime, and a cryptographically hard to guess secret string. Thus, even if the hashed file name is discovered and replaced by an untrusted file (e.g., via a move_uploaded_file() invocation by a script that performs insufficient validation), the directory's mtime gets updated in the process, invalidating the hash and preventing the untrusted file from getting loaded. Also, the file mtime will be checked providing security against overwriting in-place, at the cost of an additional system call for every load() and exists().
The containing directory is created with the same name as the virtual file name (slashes replaced with hashmarks) to assist with debugging, since the file itself is stored with a name that's meaningless to humans.
Hierarchy
- class \Drupal\Component\PhpStorage\FileStorage implements PhpStorageInterface
- class \Drupal\Component\PhpStorage\MTimeProtectedFastFileStorage
- class \Drupal\Component\PhpStorage\MTimeProtectedFileStorage
- class \Drupal\Component\PhpStorage\MTimeProtectedFastFileStorage
File
- core/lib/Drupal/Component/PhpStorage/MTimeProtectedFileStorage.php, line 32
Namespace
Drupal\Component\PhpStorage
Members
Name | Modifiers | Type | Description |
---|---|---|---|
FileStorage::$directory | protected | property | The directory where the files should be stored. |
FileStorage::createDirectory | protected | function | Ensures the requested directory exists and has the right permissions. |
FileStorage::deleteAll | public | function | Removes all files in this bin. Overrides PhpStorageInterface::deleteAll |
FileStorage::ensureDirectory | protected | function | Ensures the directory exists, has the right permissions, and a .htaccess. |
FileStorage::htaccessLines | public static | function | Returns the standard .htaccess lines that Drupal writes to file directories. |
FileStorage::listAll | public | function | Lists all the files in the storage. Overrides PhpStorageInterface::listAll |
FileStorage::unlink | protected | function | Deletes files and/or directories in the specified path. |
FileStorage::writeable | public | function | Whether this is a writeable storage. Overrides PhpStorageInterface::writeable |
MTimeProtectedFastFileStorage::$secret | protected | property | The secret used in the HMAC. |
MTimeProtectedFastFileStorage::delete | public | function | Deletes PHP code from storage. Overrides FileStorage::delete |
MTimeProtectedFastFileStorage::garbageCollection | public | function | Performs garbage collection on the storage. Overrides FileStorage::garbageCollection |
MTimeProtectedFastFileStorage::getContainingDirectoryFullPath | protected | function | Gets the full path of the containing directory where the file is or should be stored. |
MTimeProtectedFastFileStorage::getFullPath | public | function | Gets the full path where the file is or should be stored. Overrides FileStorage::getFullPath |
MTimeProtectedFastFileStorage::getUncachedMTime | protected | function | Clears PHP's stat cache and returns the directory's mtime. |
MTimeProtectedFastFileStorage::save | public | function | Saves PHP code to storage. Overrides FileStorage::save |
MTimeProtectedFastFileStorage::tempnam | protected | function | A brute force tempnam implementation supporting streams. |
MTimeProtectedFastFileStorage::__construct | public | function | Constructs this MTimeProtectedFastFileStorage object. Overrides FileStorage::__construct |
MTimeProtectedFileStorage::checkFile | protected | function | Determines whether a protected file exists and sets the filename too. |
MTimeProtectedFileStorage::exists | public | function | Checks whether the PHP code exists in storage. Overrides FileStorage::exists |
MTimeProtectedFileStorage::getPath | public | function | |
MTimeProtectedFileStorage::load | public | function | Loads PHP code from storage. Overrides FileStorage::load |
Please login to continue.