https://github.com/intaro/twig-sandbox-bundle
Annotation configuration of the allowed methods and properties for Twig\Sandbox extension
https://github.com/intaro/twig-sandbox-bundle
bundle php symfony symfony-bundle twig twig-extension
Last synced: 11 months ago
JSON representation
Annotation configuration of the allowed methods and properties for Twig\Sandbox extension
- Host: GitHub
- URL: https://github.com/intaro/twig-sandbox-bundle
- Owner: intaro
- License: mit
- Created: 2014-06-03T16:58:18.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2024-10-10T19:23:59.000Z (over 1 year ago)
- Last Synced: 2024-12-10T08:51:22.639Z (over 1 year ago)
- Topics: bundle, php, symfony, symfony-bundle, twig, twig-extension
- Language: PHP
- Homepage:
- Size: 68.4 KB
- Stars: 6
- Watchers: 6
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SecurityPolicy/SecurityPolicyRules.php
Awesome Lists containing this project
README
# TwigSandboxBundle
There is [Twig](https://twig.symfony.com)-extension [Sandbox](https://twig.symfony.com/doc/2.x/api.html#sandbox-extension) which can be used to evaluate untrusted code and where access to unsafe properties and methods is prohibited. This bundle allows to configure security policy for sandbox.
## Installation
TwigSandboxBundle requires Symfony 6.0 or higher.
Install the bundle:
```
$ composer require intaro/twig-sandbox-bundle
```
Register the bundle in `config/bundles.php`:
```php
return [
// ...
Intaro\TwigSandboxBundle\IntaroTwigSandboxBundle::class => ['all' => true],
];
```
## Usage
Define allowed properties and methods for your entities using attribute `#[Sandbox]`.
Optionally you can add `type` option for attribute (for example `#[Sandbox(type: 'int')]`).
This option defines type of value that property stores or method returns.
In your application you can use annotation reader to extract value of `type` option and use this value
to perform additional checks or any other actions, for example, use twig filters according to value of the option.
```php
id;
}
public function setName(string $name): self
{
$this->name = $name;
return $this;
}
#[Sandbox]
public function getName(): string
{
return $this->name;
}
public function setQuantity(?int $quantity): self
{
$this->quantity = $quantity;
return $this;
}
public function getQuantity(): ?int
{
return $this->quantity;
}
}
```
And use sandbox environment.
```php
use Acme\DemoBundle\Entity\Product;
use Intaro\TwigSandboxBundle\Builder\EnvironmentBuilder;
class Example {
private EnvironmentBuilder $environmentBuilder;
public function __construct(EnvironmentBuilder $environmentBuilder)
{
$this->environmentBuilder = $environmentBuilder;
}
$twig = $this->environmentBuilder->getSandboxEnvironment();
$product = new Product();
$product->setName('Product 1');
$product->setQuantity(5);
// successful render
$html1 = $twig->render(
'Product {{ product.name }}',
['product' => $product]
);
// render with the exception on access to the quantity method
$html2 = $twig->render(
'Product {{ product.name }} in the quantity {{ product.quantity }}',
['product' => $product]
);
}
```
### Validation
You can validate entity fields which contain twig templates with TwigSandbox validator.
```php
// in Entity/Page.php
use Intaro\TwigSandboxBundle\Validator\Constraints\TwigSandbox;
class Page
{
//...
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('template', new TwigSandbox());
}
//...
}
```
## Configure
### Methods and properties
You can define allowed methods and properties of entities with attribute `Intaro\TwigSandboxBundle\Attribute\Sandbox`. Example above.
### Tags
Default list of the allowed tags:
```yml
- 'autoescape'
- 'filter'
- 'do'
- 'flush'
- 'for'
- 'set'
- 'verbatium'
- 'if'
- 'spaceless'
```
You can override list in the parameter `intaro.twig_sandbox.policy_tags`:
```yml
# app/config/config.yml
parameters:
intaro.twig_sandbox.policy_tags:
- 'do'
- 'for'
- 'if'
- 'spaceless'
```
### Filters
Default list of the allowed filters:
```yml
- 'abs'
- 'batch'
- 'capitalize'
- 'convert_encoding'
- 'date'
- 'date_modify'
- 'default'
- 'escape'
- 'first'
- 'format'
- 'join'
- 'json_encode'
- 'keys'
- 'last'
- 'length'
- 'lower'
- 'merge'
- 'nl2br'
- 'number_format'
- 'raw'
- 'replace'
- 'reverse'
- 'slice'
- 'sort'
- 'split'
- 'striptags'
- 'title'
- 'trim'
- 'upper'
- 'url_encode'
```
You can override list in the parameter `intaro.twig_sandbox.policy_filters`:
```yml
# app/config/config.yml
parameters:
intaro.twig_sandbox.policy_filters:
- 'sort'
- 'upper'
- 'sort'
```
### Functions
Default list of the allowed functions:
```yml
- 'attribute'
- 'constant'
- 'cycle'
- 'date'
- 'random'
- 'range'
```
You can override list in parameter `intaro.twig_sandbox.policy_functions`:
```yml
# app/config/config.yml
parameters:
intaro.twig_sandbox.policy_functions:
- 'date'
- 'range'
```
### Allowed types
Default list of allowed return types:
```yml
- 'bool'
- 'collection'
- 'date'
- 'float'
- 'int'
- 'object'
- 'string'
```
You can override list in parameter `intaro.twig_sandbox.sandbox_annotation.value_types`:
```yml
# app/config/config.yml
parameters:
intaro.twig_sandbox.sandbox_annotation.value_types:
- 'string'
- 'date'
- 'collection'
- 'stdClass'
```
### Environment
You can set twig environment parameters:
```php
$twig = $this->get(EnvironmentBuilder::class)->getSandboxEnvironment([
'strict_variables' => true
]);
```
Also, you might want to add extensions to your twig environment. Example how to add:
```php
// Acme/DemoBundle/AcmeDemoBundle.php
addCompilerPass(new TwigSandboxPass());
}
}
```
```php
// Acme/DemoBundle/DependencyInjection/Compiler/TwigSandboxPass.php
hasDefinition(EnvironmentBuilder::class)) {
return;
}
$sandbox = $container->getDefinition(EnvironmentBuilder::class);
$sandbox->addMethodCall('addExtension', [new Reference('acme_demo.twig_extension')]);
}
}
```
### Other parameters
You can specify additional directories for each bundle to scan (using parameter `intaro.twig_sandbox.additional_paths`).
Example:
```yml
# app/config/config.yml
parameters:
intaro.twig_sandbox.additional_paths:
AcmeDemoBundle:
- 'Model'
```
## Development ##
### Run tests ###
Install vendors:
```shell
make vendor
```
Run php-cs-fixer, phpstan and phpunit:
```shell
make check
```