class TwigSandboxPolicy
Same name in other branches
- 9 core/lib/Drupal/Core/Template/TwigSandboxPolicy.php \Drupal\Core\Template\TwigSandboxPolicy
- 10 core/lib/Drupal/Core/Template/TwigSandboxPolicy.php \Drupal\Core\Template\TwigSandboxPolicy
- 11.x core/lib/Drupal/Core/Template/TwigSandboxPolicy.php \Drupal\Core\Template\TwigSandboxPolicy
Default sandbox policy for Twig templates.
Twig's sandbox extension is usually used to evaluate untrusted code by limiting access to potentially unsafe properties or methods. Since we do not use ViewModels when passing objects to Twig templates, we limit what those objects can do by whitelisting certain classes, method names, and method names with an allowed prefix. All object properties may be accessed.
Hierarchy
- class \Drupal\Core\Template\TwigSandboxPolicy implements \Drupal\Core\Template\Twig_Sandbox_SecurityPolicyInterface
Expanded class hierarchy of TwigSandboxPolicy
1 file declares its use of TwigSandboxPolicy
- TwigSandboxTest.php in core/
tests/ Drupal/ Tests/ Core/ Template/ TwigSandboxTest.php - Contains \Drupal\Tests\Core\Template\TwigSandboxTest.
File
-
core/
lib/ Drupal/ Core/ Template/ TwigSandboxPolicy.php, line 16
Namespace
Drupal\Core\TemplateView source
class TwigSandboxPolicy implements \Twig_Sandbox_SecurityPolicyInterface {
/**
* An array of whitelisted methods in the form of methodName => TRUE.
*
* @var array
*/
protected $whitelisted_methods;
/**
* An array of whitelisted method prefixes -- any method starting with one of
* these prefixes will be allowed.
*
* @var array
*/
protected $whitelisted_prefixes;
/**
* An array of class names for which any method calls are allowed.
*
* @var array
*/
protected $whitelisted_classes;
/**
* Constructs a new TwigSandboxPolicy object.
*/
public function __construct() {
// Allow settings.php to override our default whitelisted classes, methods,
// and prefixes.
$whitelisted_classes = Settings::get('twig_sandbox_whitelisted_classes', [
// Allow any operations on the Attribute object as it is intended to be
// changed from a Twig template, for example calling addClass().
'Drupal\\Core\\Template\\Attribute',
]);
// Flip the arrays so we can check using isset().
$this->whitelisted_classes = array_flip($whitelisted_classes);
$whitelisted_methods = Settings::get('twig_sandbox_whitelisted_methods', [
// Only allow idempotent methods.
'id',
'label',
'bundle',
'get',
'__toString',
'toString',
]);
$this->whitelisted_methods = array_flip($whitelisted_methods);
$this->whitelisted_prefixes = Settings::get('twig_sandbox_whitelisted_prefixes', [
'get',
'has',
'is',
]);
}
/**
* {@inheritdoc}
*/
public function checkSecurity($tags, $filters, $functions) {
}
/**
* {@inheritdoc}
*/
public function checkPropertyAllowed($obj, $property) {
}
/**
* {@inheritdoc}
*/
public function checkMethodAllowed($obj, $method) {
foreach ($this->whitelisted_classes as $class => $key) {
if ($obj instanceof $class) {
return TRUE;
}
}
// Return quickly for an exact match of the method name.
if (isset($this->whitelisted_methods[$method])) {
return TRUE;
}
// If the method name starts with a whitelisted prefix, allow it.
// Note: strpos() is between 3x and 7x faster than preg_match in this case.
foreach ($this->whitelisted_prefixes as $prefix) {
if (strpos($method, $prefix) === 0) {
return TRUE;
}
}
throw new \Twig_Sandbox_SecurityError(sprintf('Calling "%s" method on a "%s" object is not allowed.', $method, get_class($obj)));
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
TwigSandboxPolicy::$whitelisted_classes | protected | property | An array of class names for which any method calls are allowed. |
TwigSandboxPolicy::$whitelisted_methods | protected | property | An array of whitelisted methods in the form of methodName => TRUE. |
TwigSandboxPolicy::$whitelisted_prefixes | protected | property | An array of whitelisted method prefixes -- any method starting with one of these prefixes will be allowed. |
TwigSandboxPolicy::checkMethodAllowed | public | function | |
TwigSandboxPolicy::checkPropertyAllowed | public | function | |
TwigSandboxPolicy::checkSecurity | public | function | |
TwigSandboxPolicy::__construct | public | function | Constructs a new TwigSandboxPolicy object. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.