[PR #24512] [CLOSED] feat: add configurable artifact CSP support #98733

New Issue

GiteaMirror · 2026-05-16T01:34:23-05:00

GiteaMirror commented

2026-05-16 01:34:23 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/24512
Author: @michaellrowley
Created: 5/9/2026
Status: ❌ Closed

Base: dev ← Head: owui-artifact-csp-support

📝 Commits (1)

1e26013 feat: add configurable artifact CSP support

📊 Changes

6 files changed (+78 additions, -4 deletions)

View changed files

📝 backend/open_webui/config.py (+6 -0)
📝 backend/open_webui/main.py (+5 -0)
📝 backend/open_webui/routers/auths.py (+4 -0)
📝 src/lib/components/admin/Settings/General.svelte (+17 -0)
📝 src/lib/components/chat/Artifacts.svelte (+42 -4)
📝 src/lib/stores/index.ts (+4 -0)

📄 Description

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request.

This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR.

Before submitting, make sure you've checked the following:

Target branch: Verify that the pull request targets the dev branch. PRs targeting main will be immediately closed.
Description: Provide a concise description of the changes made in this pull request down below.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Add docs in Open WebUI Docs Repository. Document user-facing behavior, environment variables, public APIs/interfaces, or deployment steps.

About to open docs PR.

Dependencies: Are there any new or upgraded dependencies? If so, explain why, update the changelog/docs, and include any compatibility notes. Actually run the code/function that uses updated library to ensure it doesn't crash.
Testing: Perform manual tests to verify the implemented fix/feature works as intended AND does not break any other functionality. Include reproducible steps to demonstrate the issue before the fix. Test edge cases (URL encoding, HTML entities, types). Take this as an opportunity to make screenshots of the feature/fix and include them in the PR description.
Agentic AI Code: Confirm this Pull Request is not written by any AI Agent or has at least gone through additional human review AND manual testing. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR.

The code in this PR was written by an AI agent, but has undergone human review of commits AND manual testing (as evidenced in the screenshots below.

Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Design & Architecture: Prefer smart defaults over adding new settings; use local state for ephemeral UI logic. Open a Discussion for major architectural or UX changes.
Git Hygiene: Keep PRs atomic (one logical change). Clean up commits and rebase on dev to ensure no unrelated commits (e.g. from main) are included. Push updates to the existing PR branch instead of closing and reopening.
Title Prefix: To clearly categorize this pull request, prefix the pull request title using one of the following:
- BREAKING CHANGE: Significant changes that may affect compatibility
- build: Changes that affect the build system or external dependencies
- ci: Changes to our continuous integration processes or workflows
- chore: Refactor, cleanup, or other non-functional code changes
- docs: Documentation update or addition
- feat: Introduces a new feature or enhancement to the codebase
- fix: Bug fix or error correction
- i18n: Internationalization or localization changes
- perf: Performance improvement
- refactor: Code restructuring for better maintainability, readability, or scalability
- style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
- test: Adding missing tests or correcting existing tests
- WIP: Work in progress, a temporary label for incomplete or ongoing work

Changelog Entry

Description

This pull request introduces support for configuring a Content Security Policy (CSP) specifically for artifact iframe previews in OpenWebUI. The new setting can be managed via environment variables, the admin UI, and API, and is injected into artifact iframes to enhance security. The implementation includes backend configuration, admin interface updates, frontend injection logic, and comprehensive tests.

These changes collectively improve the security and configurability of artifact previews in OpenWebUI.

Added

- Updated the admin UI to allow setting the artifact CSP via a new textarea in the general settings panel. (src/lib/components/admin/Settings/General.svelte)
- Added a new ARTIFACT_CONTENT_SECURITY_POLICY environment variable and backend config option to control the CSP for artifact iframes. This value is exposed in both general and admin config APIs. (.env.example, backend/open_webui/config.py, backend/open_webui/main.py.
- Implemented applyArtifactContentSecurityPolicy utility to inject or replace the CSP meta tag in artifact iframe HTML, ensuring the configured policy is always applied. (src/lib/utils/artifacts.ts)
- Added comprehensive unit tests for the CSP injection utility to cover various HTML scenarios. (src/lib/utils/artifacts.test.ts)

Changed

- Extended the config store type to include the new artifacts CSP property. (src/lib/stores/index.ts, (src/lib/stores/index.ts).
- Updated the artifact preview component to use the configured CSP when rendering iframe artifacts. (src/lib/components/chat/Artifacts.svelte)

Deprecated

None

Removed

None

Fixed

N/A

Security

This entire PR is a security improvement. Teams can now granularly specify CSP application of LLM-generated code preview iframes.

Breaking Changes

None AFAIK; by default, the setting is initialized as an empty string, which should default to browser default.

Additional Information

https://github.com/open-webui/open-webui/discussions/13684

Screenshots or Videos

CSP configuration is at the bottom of the first screenshot in each of the below 'note' sections.

Note

Unset CSP

Note

Set CSP

Contributor License Agreement

By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.

Note

Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/open-webui/pull/24512 **Author:** [@michaellrowley](https://github.com/michaellrowley) **Created:** 5/9/2026 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `owui-artifact-csp-support` --- ### 📝 Commits (1) - [`1e26013`](https://github.com/open-webui/open-webui/commit/1e2601377b2adb1107e98fdd491155dc557e3aa9) feat: add configurable artifact CSP support ### 📊 Changes **6 files changed** (+78 additions, -4 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/config.py` (+6 -0) 📝 `backend/open_webui/main.py` (+5 -0) 📝 `backend/open_webui/routers/auths.py` (+4 -0) 📝 `src/lib/components/admin/Settings/General.svelte` (+17 -0) 📝 `src/lib/components/chat/Artifacts.svelte` (+42 -4) 📝 `src/lib/stores/index.ts` (+4 -0) </details> ### 📄 Description  # Pull Request Checklist ### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request. This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR.  **Before submitting, make sure you've checked the following:** - [x] **Target branch:** Verify that the pull request targets the `dev` branch. **PRs targeting `main` will be immediately closed.** - [x] **Description:** Provide a concise description of the changes made in this pull request down below. - [x] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description. - [x] **Documentation:** Add docs in [Open WebUI Docs Repository](https://github.com/open-webui/docs). Document user-facing behavior, environment variables, public APIs/interfaces, or deployment steps. > About to open docs PR. - [x] **Dependencies:** Are there any new or upgraded dependencies? If so, explain why, update the changelog/docs, and include any compatibility notes. Actually run the code/function that uses updated library to ensure it doesn't crash. - [X] **Testing:** Perform manual tests to **verify the implemented fix/feature works as intended AND does not break any other functionality**. Include reproducible steps to demonstrate the issue before the fix. Test edge cases (URL encoding, HTML entities, types). Take this as an opportunity to **make screenshots of the feature/fix and include them in the PR description**. - [X] **Agentic AI Code:** Confirm this Pull Request is **not written by any AI Agent** or has at least **gone through additional human review AND manual testing**. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR. > The code in this PR was written by an AI agent, but has undergone human review of commits AND manual testing (as evidenced in the screenshots below. - [x] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards? - [x] **Design & Architecture:** Prefer smart defaults over adding new settings; use local state for ephemeral UI logic. Open a Discussion for major architectural or UX changes. - [x] **Git Hygiene:** Keep PRs atomic (one logical change). Clean up commits and rebase on `dev` to ensure no unrelated commits (e.g. from `main`) are included. Push updates to the existing PR branch instead of closing and reopening. - [x] **Title Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following: - **BREAKING CHANGE**: Significant changes that may affect compatibility - **build**: Changes that affect the build system or external dependencies - **ci**: Changes to our continuous integration processes or workflows - **chore**: Refactor, cleanup, or other non-functional code changes - **docs**: Documentation update or addition - **feat**: Introduces a new feature or enhancement to the codebase - **fix**: Bug fix or error correction - **i18n**: Internationalization or localization changes - **perf**: Performance improvement - **refactor**: Code restructuring for better maintainability, readability, or scalability - **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.) - **test**: Adding missing tests or correcting existing tests - **WIP**: Work in progress, a temporary label for incomplete or ongoing work # Changelog Entry ### Description This pull request introduces support for configuring a Content Security Policy (CSP) specifically for artifact iframe previews in OpenWebUI. The new setting can be managed via environment variables, the admin UI, and API, and is injected into artifact iframes to enhance security. The implementation includes backend configuration, admin interface updates, frontend injection logic, and comprehensive tests. These changes collectively improve the security and configurability of artifact previews in OpenWebUI. ### Added - * Updated the admin UI to allow setting the artifact CSP via a new textarea in the general settings panel. (`src/lib/components/admin/Settings/General.svelte`) - * Added a new `ARTIFACT_CONTENT_SECURITY_POLICY` environment variable and backend config option to control the CSP for artifact iframes. This value is exposed in both general and admin config APIs. (`.env.example`, `backend/open_webui/config.py`, `backend/open_webui/main.py`. - * Implemented `applyArtifactContentSecurityPolicy` utility to inject or replace the CSP meta tag in artifact iframe HTML, ensuring the configured policy is always applied. (`src/lib/utils/artifacts.ts`) - * Added comprehensive unit tests for the CSP injection utility to cover various HTML scenarios. (`src/lib/utils/artifacts.test.ts`) ### Changed - * Extended the config store type to include the new artifacts CSP property. (`src/lib/stores/index.ts`, (src/lib/stores/index.ts). - * Updated the artifact preview component to use the configured CSP when rendering iframe artifacts. (`src/lib/components/chat/Artifacts.svelte`) ### Deprecated None ### Removed None ### Fixed N/A ### Security - This entire PR is a security improvement. Teams can now granularly specify CSP application of LLM-generated code preview iframes. ### Breaking Changes None AFAIK; by default, the setting is initialized as an empty string, which should default to browser default. --- ### Additional Information - https://github.com/open-webui/open-webui/discussions/13684 ### Screenshots or Videos CSP configuration is at the bottom of the first screenshot in each of the below 'note' sections. > [!NOTE] > Unset CSP <img width="1371" height="764" alt="Screenshot 2026-05-09 at 16 52 28" src="https://github.com/user-attachments/assets/01b6efcd-7cdc-4246-a856-d9190d1d74c0" /> <img width="1419" height="764" alt="Screenshot 2026-05-09 at 16 54 05" src="https://github.com/user-attachments/assets/30fd9cbf-1a6b-4dbb-aedc-f1b581506c60" /> > [!NOTE] > Set CSP <img width="1419" height="764" alt="Screenshot 2026-05-09 at 16 55 19" src="https://github.com/user-attachments/assets/1b02d091-08d5-4ffe-9742-aabd6db05f85" /> <img width="1419" height="764" alt="Screenshot 2026-05-09 at 16 55 02" src="https://github.com/user-attachments/assets/6bcf49e9-b841-4e74-912b-9c0dcc374541" /> <img width="1419" height="764" alt="Screenshot 2026-05-09 at 16 55 13" src="https://github.com/user-attachments/assets/78d870c4-db0a-4db9-8e61-61555b42d492" /> ### Contributor License Agreement  - [x] By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](https://github.com/open-webui/open-webui/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms. > [!NOTE] > Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2026-05-16 01:34:23 -05:00

GiteaMirror closed this issue

2026-05-16 01:34:27 -05:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/open-webui#98733