Skip to content

docs: explain how to render untrusted templates with a sandboxed environment #670

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cvas22 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: explain how to render untrusted templates with a sandboxed environment #670

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,6 +466,22 @@ Then in your template, you will be able to use::
Euros price : {{ price_dollars|multiply_by(0.88) }}


Untrusted templates
-------------------

By default templates are rendered with a regular jinja environment, so a template can run arbitrary Python code.
If the docx template comes from a source you do not trust, pass a sandboxed environment to ``render()``::

from docxtpl import DocxTemplate
from jinja2.sandbox import SandboxedEnvironment

doc = DocxTemplate("my_word_template.docx")
doc.render(context, SandboxedEnvironment())

An expression such as ``{{ ''.__class__.__mro__ }}`` then raises a ``jinja2.exceptions.SecurityError`` instead of being evaluated.
The same environment is used for the document properties and footnotes, and ``get_undeclared_template_variables()`` accepts it too.


Command-line execution
----------------------

Expand Down