fix(common): prevent injection during jinja templating #1850
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lukapeschke
requested changes
Dec 12, 2024
toucan_connectors/common.py
Outdated
Comment on lines
26
to
27
| jinja_env = ImmutableSandboxedEnvironment() | ||
|
|
There was a problem hiding this comment.
Suggested change
| jinja_env = ImmutableSandboxedEnvironment() |
toucan_connectors/common.py
Outdated
| else: | ||
| env = Environment() # noqa: S701 | ||
| env = jinja_env # noqa: S701 |
There was a problem hiding this comment.
Suggested change
| env = jinja_env # noqa: S701 | |
| env = ImmutableSandboxedEnvironment() |
toucan_connectors/common.py
Outdated
| @@ -237,7 +243,7 @@ def _flatten_dict(p, parent_key=""): | |||
| parameters.update(p_keep_type) | |||
|
|
|||
| logging.getLogger(__name__).debug(f"Render query: {query} with parameters {parameters}") | |||
| return Template(query).render(parameters) | |||
| return jinja_env.from_string(query).render(parameters) | |||
There was a problem hiding this comment.
Same here, I'm in favor of avoiding globals when possible
toucan_connectors/common.py
Outdated
| @@ -476,7 +482,7 @@ def pandas_read_sql( | |||
| if convert_to_printf: | |||
| query = convert_to_printf_templating_style(query) | |||
| if render_user: | |||
| query = Template(query).render({"user": params.get("user", {})}) | |||
| query = jinja_env.from_string(query).render({"user": params.get("user", {})}) | |||
Instanciating an env doesn't cost a lot, so it's best to avoid any globals
Indeed, instantiating an env is cheap, so no need for a global: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Forward port of #1849