github-starred/open-webui
2
0
Fork 0
mirror of https://github.com/open-webui/open-webui.git synced 2026-07-15 21:19:39 -05:00
Code Issues 2.4k Packages Projects Releases 129 Wiki Activity

[PR #24626] feat: optional HS256 JWT for forwarded user identity headers #98785

New Issue
Open
opened 2026-05-16 01:38:42 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-05-16 01:38:42 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/24626
Author: @jmleksan
Created: 5/12/2026
Status: 🔄 Open

Base: dev ← Head: feat/user-jwt-header

📝 Commits (1)

  • 9d07481 feat: add JWT support for user info headers

📊 Changes

2 files changed (+51 additions, -3 deletions)

View changed files

📝 backend/open_webui/env.py (+10 -0)
📝 backend/open_webui/utils/headers.py (+41 -3)

📄 Description

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

  • Linked Issue/Discussion: Relates to Discussion (https://github.com/open-webui/open-webui/discussions/24627)
  • Target branch: This PR targets dev (not main).
  • Description: See “Changelog Entry” / “Description” below.
  • Changelog: Keep a Changelog–style entry included below under “Changelog Entry”.
  • Documentation: Open WebUI docs
  • Dependencies: No new dependencies. Uses existing PyJWT (import jwt) already used elsewhere in the backend.
  • Testing: Manual verification: with ENABLE_FORWARD_USER_INFO_HEADERS=true and FORWARD_USER_JWT_SECRET set, outbound requests include FORWARD_USER_JWT_HEADER (default X-OpenWebUI-User-Jwt) with HS256 JWT; claims sub, email, name, role, iss (open-webui), iat, exp. Without secret, legacy X-OpenWebUI-User-* headers unchanged. Gateway decode with shared secret succeeds.
  • Agentic AI Code: Confirm per your process (human review + manual testing).
  • Code review: Self-reviewed; follows existing env.py int-parse patterns and centralizes behavior in include_user_info_headers so all existing call sites pick it up.
  • Design & Architecture: Opt-in via env only; default behavior unchanged when FORWARD_USER_JWT_SECRET is unset.
  • Git Hygiene: Single logical feature (forwarded user identity as optional signed JWT).
  • Title Prefix: feat: optional signed JWT for forwarded user identity to external backends

Changelog Entry

  • 🔐 Signed JWT for forwarded user identity. When "ENABLE_FORWARD_USER_INFO_HEADERS" is enabled, setting "FORWARD_USER_JWT_SECRET" sends a short-lived HS256 JWT in "FORWARD_USER_JWT_HEADER" instead of the separate "X-OpenWebUI-User-*" headers, so OpenAI-compatible gateways and tool backends can verify user context with a shared secret.

Description

When ENABLE_FORWARD_USER_INFO_HEADERS is enabled, operators can optionally set FORWARD_USER_JWT_SECRET so Open WebUI sends one HS256 JWT (header name configurable) carrying sub, email, name, and role instead of the four separate X-OpenWebUI-User-* headers. This lets upstream gateways verify user context cryptographically with a shared secret instead of trusting plain header strings alone which should prevent spoofing of headers by bad actors. If minting fails, behavior falls back to the legacy headers.

Added

  • Environment variables: FORWARD_USER_JWT_SECRET, FORWARD_USER_JWT_HEADER (default X-OpenWebUI-User-Jwt), FORWARD_USER_JWT_EXPIRES_SECONDS (default 300, invalid values fall back to 300).
  • JWT claims: sub (user id), email, name, role, iss (open-webui), iat, exp (HS256).

Changed

  • include_user_info_headers: when FORWARD_USER_JWT_SECRET is non-empty, adds only the configured JWT header and omits the four legacy user info headers for that request path.

Security

  • Optional signed user context for trusted hops to external OpenAI-compatible backends, RAG, tools, TTS/STT, etc. (same call sites as existing forwarded headers). Operators should use a dedicated secret and short TTL appropriate to their gateway; iss is fixed to open-webui for verification pinning.

Breaking Changes

  • Behavioral (env-driven): If FORWARD_USER_JWT_SECRET is set, upstreams that previously relied only on X-OpenWebUI-User-Name / Id / Email / Role will no longer receive those four headers from this path; they must accept the JWT header instead. Unset FORWARD_USER_JWT_SECRET to restore legacy behavior.

Additional Information

  • Implementation: backend/open_webui/env.py (env wiring), backend/open_webui/utils/headers.py (_mint_forward_user_jwt + branch in include_user_info_headers).
  • Session / login JWT (WEBUI_SECRET_KEY) is unchanged; this is a separate optional secret for gateway-facing assertions.
  • JWT is not exposed to the browser by default; it is attached to server-side outbound requests that already use include_user_info_headers.

Screenshots or Videos

  • N/A (no UI change; verification via gateway / proxy logs or test upstream).

Contributor License Agreement

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/24626 **Author:** [@jmleksan](https://github.com/jmleksan) **Created:** 5/12/2026 **Status:** 🔄 Open **Base:** `dev` ← **Head:** `feat/user-jwt-header` --- ### 📝 Commits (1) - [`9d07481`](https://github.com/open-webui/open-webui/commit/9d07481b4f4043b1aac30c17b9cf65d2b1986d61) feat: add JWT support for user info headers ### 📊 Changes **2 files changed** (+51 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/env.py` (+10 -0) 📝 `backend/open_webui/utils/headers.py` (+41 -3) </details> ### 📄 Description <!-- ⚠️ CRITICAL CHECKS FOR CONTRIBUTORS (READ, DON'T DELETE) ⚠️ 1. Target the `dev` branch. PRs targeting `main` will be automatically closed. 2. Do NOT delete the CLA section at the bottom. It is required for the bot to accept your PR. --> <!-- ### ⚠️ Important: Your PR is a contribution, not a guarantee of merge. The most impactful way to contribute to Open WebUI is through well-written bug reports, detailed feature discussions, and thoughtful ideas. These directly shape the project. If you do open a pull request, please know that Open WebUI is held to the highest standard of code quality, consistency, and architectural coherence, and every line merged becomes something the core team must own, maintain, and support indefinitely. Submitted code may be refactored, rewritten, or used as inspiration for a different implementation. This is not a reflection of your work's quality. It is how we ensure that a small team can deeply understand and evolve every part of the codebase. --> **Before submitting, make sure you've checked the following:** - [x] **Linked Issue/Discussion:** Relates to Discussion (https://github.com/open-webui/open-webui/discussions/24627) - [x] **Target branch:** This PR targets **`dev`** (not `main`). - [x] **Description:** See “Changelog Entry” / “Description” below. - [x] **Changelog:** Keep a Changelog–style entry included below under “Changelog Entry”. - [ ] **Documentation:** Open WebUI docs - [x] **Dependencies:** No new dependencies. Uses existing `PyJWT` (`import jwt`) already used elsewhere in the backend. - [x] **Testing:** Manual verification: with `ENABLE_FORWARD_USER_INFO_HEADERS=true` and `FORWARD_USER_JWT_SECRET` set, outbound requests include `FORWARD_USER_JWT_HEADER` (default `X-OpenWebUI-User-Jwt`) with HS256 JWT; claims `sub`, `email`, `name`, `role`, `iss` (`open-webui`), `iat`, `exp`. Without secret, legacy `X-OpenWebUI-User-*` headers unchanged. Gateway decode with shared secret succeeds. - [x] **Agentic AI Code:** Confirm per your process (human review + manual testing). - [x] **Code review:** Self-reviewed; follows existing `env.py` int-parse patterns and centralizes behavior in `include_user_info_headers` so all existing call sites pick it up. - [x] **Design & Architecture:** Opt-in via env only; default behavior unchanged when `FORWARD_USER_JWT_SECRET` is unset. - [x] **Git Hygiene:** Single logical feature (forwarded user identity as optional signed JWT). - [x] **Title Prefix:** **feat**: optional signed JWT for forwarded user identity to external backends # Changelog Entry - 🔐 **Signed JWT for forwarded user identity.** When `"ENABLE_FORWARD_USER_INFO_HEADERS"` is enabled, setting `"FORWARD_USER_JWT_SECRET"` sends a short-lived HS256 JWT in `"FORWARD_USER_JWT_HEADER"` instead of the separate `"X-OpenWebUI-User-*"` headers, so OpenAI-compatible gateways and tool backends can verify user context with a shared secret. ### Description When `ENABLE_FORWARD_USER_INFO_HEADERS` is enabled, operators can optionally set `FORWARD_USER_JWT_SECRET` so Open WebUI sends **one** HS256 JWT (header name configurable) carrying `sub`, `email`, `name`, and `role` instead of the four separate `X-OpenWebUI-User-*` headers. This lets upstream gateways verify user context cryptographically with a shared secret instead of trusting plain header strings alone which should prevent spoofing of headers by bad actors. If minting fails, behavior falls back to the legacy headers. ### Added - Environment variables: `FORWARD_USER_JWT_SECRET`, `FORWARD_USER_JWT_HEADER` (default `X-OpenWebUI-User-Jwt`), `FORWARD_USER_JWT_EXPIRES_SECONDS` (default `300`, invalid values fall back to `300`). - JWT claims: `sub` (user id), `email`, `name`, `role`, `iss` (`open-webui`), `iat`, `exp` (HS256). ### Changed - `include_user_info_headers`: when `FORWARD_USER_JWT_SECRET` is non-empty, adds only the configured JWT header and omits the four legacy user info headers for that request path. ### Security - Optional signed user context for trusted hops to external OpenAI-compatible backends, RAG, tools, TTS/STT, etc. (same call sites as existing forwarded headers). Operators should use a dedicated secret and short TTL appropriate to their gateway; `iss` is fixed to `open-webui` for verification pinning. ### Breaking Changes - **Behavioral (env-driven):** If `FORWARD_USER_JWT_SECRET` is set, upstreams that previously relied only on `X-OpenWebUI-User-Name` / `Id` / `Email` / `Role` will no longer receive those four headers from this path; they must accept the JWT header instead. Unset `FORWARD_USER_JWT_SECRET` to restore legacy behavior. --- ### Additional Information - Implementation: `backend/open_webui/env.py` (env wiring), `backend/open_webui/utils/headers.py` (`_mint_forward_user_jwt` + branch in `include_user_info_headers`). - Session / login JWT (`WEBUI_SECRET_KEY`) is unchanged; this is a separate optional secret for gateway-facing assertions. - JWT is not exposed to the browser by default; it is attached to **server-side** outbound requests that already use `include_user_info_headers`. ### Screenshots or Videos - N/A (no UI change; verification via gateway / proxy logs or test upstream). ### Contributor License Agreement <!-- 🚨 DO NOT DELETE THE TEXT BELOW 🚨 Keep the "Contributor License Agreement" confirmation text intact. Deleting it will trigger the CLA-Bot to INVALIDATE your PR. Your PR will NOT be reviewed or merged until you check the box below confirming that you have read and agree to the terms of the CLA. --> - [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:38:43 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
confirmed
confirmed issue
core
documentation
enhancement
good first issue
help wanted
non-core
pull-request
Mirrored from GitHub Pull Request
 python
question
testing wanted
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#98785
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?