[PR #5466] [MERGED] feat: security response headers #21692

Closed
opened 2026-04-20 03:39:37 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/5466
Author: @phil-ogb
Created: 9/17/2024
Status: Merged
Merged: 9/17/2024
Merged by: @tjbck

Base: devHead: add-security-response-headers


📝 Commits (2)

  • 499e5e4 feat: security response headers
  • 896baf0 update comment block

📊 Changes

2 files changed (+123 additions, -0 deletions)

View changed files

📝 backend/open_webui/main.py (+3 -0)
backend/open_webui/utils/security_headers.py (+120 -0)

📄 Description

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.

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

  • Target branch: Please verify that the pull request targets the dev branch.
  • Description: Provide a concise description of the changes made in this pull request.
  • Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
  • Documentation: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
  • Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
  • Testing: Have you written and run sufficient tests for validating the changes?
  • 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?
  • Prefix: To cleary 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

  • [Concisely describe the changes made in this pull request, including any relevant motivation and impact (e.g., fixing a bug, adding a feature, or improving performance)]
    Introduced a middleware to enhance the security of web applications by adding configurable HTTP security headers. These headers can be used to mitigate various common web vulnerabilities and improve the overall security posture of the application.

Added

  • Created middleware to configure certain security response headers on Open-WebUI. The following headers can be configured on the application
    • Cache-Control : Controls browser caching policies. Configurable through the CACHE_CONTROL environment variable.
    • Referrer-Policy : Configures the amount of referrer information sent during navigation. Configured through the REFERRER_POLICY environment variable.
    • HTTP Strict Transport Security (HSTS) : Enforces HTTPS communication. Configurable via the HSTS environment variable.
    • X-Frame-Options : Prevents Clickjacking. Configurable using the XFRAME_OPTIONS environment variable to specify options.
    • X-Content-Type-Options : Prevents browsers from MIME-sniffing the content-type, forcing them to use the declared Content-Type header. Configurable using the XCONTENT_TYPE environment variable.
    • X-Download-Options : Restricts browser behaviours when handling file downloads to prevent executable downloads from running. Configurable using the XDOWNLOAD_OPTIONS environment variable.
    • X-Permitted-Cross-Domain-Policies : Limits permissible cross-domain policies to prevent unauthorized resource loading over domains. Configurable using the XPERMITTED_CROSS_DOMAIN_POLICIES environment variable.

Screenshots or Videos

image


🔄 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/5466 **Author:** [@phil-ogb](https://github.com/phil-ogb) **Created:** 9/17/2024 **Status:** ✅ Merged **Merged:** 9/17/2024 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `add-security-response-headers` --- ### 📝 Commits (2) - [`499e5e4`](https://github.com/open-webui/open-webui/commit/499e5e4f60057d11b05780836c27ef4ec3672c6b) feat: security response headers - [`896baf0`](https://github.com/open-webui/open-webui/commit/896baf021b0667c43e19c1965d681626d288d788) update comment block ### 📊 Changes **2 files changed** (+123 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/main.py` (+3 -0) ➕ `backend/open_webui/utils/security_headers.py` (+120 -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) and describe your changes before submitting a pull request. **Before submitting, make sure you've checked the following:** - [x] **Target branch:** Please verify that the pull request targets the `dev` branch. - [x] **Description:** Provide a concise description of the changes made in this pull request. - [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. - [ ] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources? - [ ] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [ ] **Testing:** Have you written and run sufficient tests for validating the changes? - [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] **Prefix:** To cleary 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 - [Concisely describe the changes made in this pull request, including any relevant motivation and impact (e.g., fixing a bug, adding a feature, or improving performance)] Introduced a middleware to enhance the security of web applications by adding configurable HTTP security headers. These headers can be used to mitigate various common web vulnerabilities and improve the overall security posture of the application. ### Added - Created middleware to configure certain security response headers on Open-WebUI. The following headers can be configured on the application - Cache-Control : Controls browser caching policies. Configurable through the `CACHE_CONTROL` environment variable. - Referrer-Policy : Configures the amount of referrer information sent during navigation. Configured through the `REFERRER_POLICY` environment variable. - HTTP Strict Transport Security (HSTS) : Enforces HTTPS communication. Configurable via the `HSTS` environment variable. - X-Frame-Options : Prevents Clickjacking. Configurable using the `XFRAME_OPTIONS` environment variable to specify options. - X-Content-Type-Options : Prevents browsers from MIME-sniffing the content-type, forcing them to use the declared Content-Type header. Configurable using the `XCONTENT_TYPE` environment variable. - X-Download-Options : Restricts browser behaviours when handling file downloads to prevent executable downloads from running. Configurable using the `XDOWNLOAD_OPTIONS` environment variable. - X-Permitted-Cross-Domain-Policies : Limits permissible cross-domain policies to prevent unauthorized resource loading over domains. Configurable using the `XPERMITTED_CROSS_DOMAIN_POLICIES` environment variable. --- ### Screenshots or Videos ![image](https://github.com/user-attachments/assets/5e429761-9471-4005-a071-b29d69d219aa) --- <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-04-20 03:39:37 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#21692