Skip to content

IS-18432: add support for accessing global secrets in validation_expr… #1307

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

Merged
hglad merged 2 commits into from
Jun 25, 2025
Merged

IS-18432: add support for accessing global secrets in validation_expr… #1307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1b01c8
IS-18432: add support for accessing global secrets in validation_expr…
hglad Jun 25, 2025
999beca
IS-18432: fix indent
hglad Jun 25, 2025
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
7 changes: 7 additions & 0 deletions hub/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
Changelog
=========

.. _changelog_2025-06-25:

2025-06-25
----------
- The ``validation_expression`` :ref:`property <validation_expression>` now supports looking up global secrets.
If the secret used in the expression is set on both the system and as a global secret, the system secret takes priority.

.. _changelog_2025-06-17:

2025-06-17
Expand Down
7 changes: 5 additions & 2 deletions hub/documentation/service-configuration/pipes/configuration-sources-http.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,14 +150,17 @@ Properties
- 100
- No

.. _validation_expression:
* - ``validation_expression``
- String
- This property allows custom request validation for receiver endpoints. This is particularly useful when clients
cannot use JWT tokens for authentication. The string must be a `Jinja template <https://jinja.palletsprojects.com/en/3.1.x/templates/#tests>`_.
The Jinja template is rendered for each incoming request. If it renders as an empty string then the request is
accepted, otherwise the rendered string will be reported as an error in the response. The context allows using
the ``secret`` function to access values of secrets. The named variables ``url``, ``request_params`` and
``request_headers`` are available to the template. Example:
the ``secret`` function to access values of secrets. System secrets (if the pipe has a system) and global secrets
can both be accessed. If the secret used in the expression is set on both the system and as a global secret,
the system secret takes priority. If using system secrets, the pipe must have permission to read from that system.
The named variables ``url``, ``request_params`` and ``request_headers`` are available to the template. Example:
``"{{ '' if request_headers['X-Sesam-Authorization'] == secret('webhook_secret') else 'Invalid authorization header value' }}"``.

Our :ref:`custom Jinja filters <custom_jinja_filters>` can also be used for more advanced validation, such as
Expand Down