github-starred/open-webui
2
0
Fork 0
mirror of https://github.com/open-webui/open-webui.git synced 2026-05-06 10:58:17 -05:00
Code Issues 1.2k Packages Projects Releases 126 Wiki Activity

[PR #21380] [CLOSED] feat: security improvements - more env variables for configurability and adjustable api key length #41687

New Issue
Closed
opened 2026-04-25 13:52:06 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-25 13:52:06 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/21380
Author: @jpaodev
Created: 2/13/2026
Status: ❌ Closed

Base: dev ← Head: feat-sec-improve

📝 Commits (10+)

📊 Changes

9 files changed (+116 additions, -11 deletions)

View changed files

📝 backend/open_webui/env.py (+32 -0)
📝 backend/open_webui/functions.py (+4 -1)
📝 backend/open_webui/main.py (+12 -4)
📝 backend/open_webui/routers/functions.py (+43 -1)
📝 backend/open_webui/utils/actions.py (+4 -1)
📝 backend/open_webui/utils/auth.py (+5 -2)
📝 backend/open_webui/utils/filter.py (+4 -0)
📝 backend/open_webui/utils/plugin.py (+11 -2)
📝 backend/requirements.txt (+1 -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.
  • 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.
  • 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 PR introduces granular control over Function and Tool features through new environment variables, enhancing security and operational flexibility. It allows administrators to enable or disable specific aspects of function and tool management, such as creation/modification, pip installations, and URL loading. Additionally, API key generation is made configurable (i.e. API key length).

This PR is nothing fancy, just a small PR with some small security enhancements.

Added

  • New environment variables for granular control over functions and tools:
    • ENABLE_FUNCTIONS_WRITE: Controls the ability to create, modify, or delete functions.
    • ENABLE_FUNCTIONS_PIP_INSTALL: Controls whether functions can trigger pip install commands.
    • ENABLE_FUNCTIONS_URL_LOAD: Controls the ability to load functions from external URLs.
    • ENABLE_TOOLS_CODE_EXECUTION: Controls whether tool code execution is allowed.
  • Environment variables for API key customization:
    • API_KEY_LENGTH: Specifies the length of generated API keys.
    • API_KEY_PREFIX: Specifies the prefix for generated API keys.

Changed

  • Function and Tool related endpoints and logic (e.g., get_function_models, chat_action, router inclusion, dependency installation) now respect the new ENABLE_FUNCTIONS flag, preventing execution if disabled.
  • Specific function management endpoints (load_function_from_url, sync_functions, create_new_function, toggle_function_by_id, toggle_global_by_id, update_function_by_id, delete_function_by_id) are now protected by ENABLE_FUNCTIONS_WRITE and ENABLE_FUNCTIONS_URL_LOAD flags.
  • Tool code loading (load_tool_module_by_id) is now protected by ENABLE_TOOLS_CODE_EXECUTION.
  • Function requirements installation (install_frontmatter_requirements) is now protected by ENABLE_FUNCTIONS_PIP_INSTALL.
  • API key generation now utilizes the API_KEY_LENGTH and API_KEY_PREFIX environment variables for customization.
  • During lifespan initialization, function/tool dependency installation is skipped if ENABLE_FUNCTIONS is false.
  • SAFE_MODE now also deactivates all functions if enabled.

Fixed

  • Add numba>=0.60.0 to requirements.txt to prevent unstructured dependency issues.

Dependencies

  • Added numba>=0.60.0 to backend/requirements.txt to resolve potential dependency conflicts with other libraries, specifically unstructured.

Additional Information

  • These new environment variables provide more fine-grained control for administrators to manage security aspects related to dynamic code execution and external integrations.
  • Existing functionality will default to True for these new flags to maintain current behavior unless explicitly set to False.

Screenshots or Videos

  • [Attach any relevant screenshots or videos demonstrating the changes]

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/21380 **Author:** [@jpaodev](https://github.com/jpaodev) **Created:** 2/13/2026 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `feat-sec-improve` --- ### 📝 Commits (10+) - [`fe6783c`](https://github.com/open-webui/open-webui/commit/fe6783c16699911c7be17392596d579333fb110c) Merge pull request #19030 from open-webui/dev - [`fc05e0a`](https://github.com/open-webui/open-webui/commit/fc05e0a6c5d39da60b603b4d520f800d6e36f748) Merge pull request #19405 from open-webui/dev - [`e3faec6`](https://github.com/open-webui/open-webui/commit/e3faec62c58e3a83d89aa3df539feacefa125e0c) Merge pull request #19416 from open-webui/dev - [`9899293`](https://github.com/open-webui/open-webui/commit/9899293f050ad50ae12024cbebee7e018acd851e) Merge pull request #19448 from open-webui/dev - [`140605e`](https://github.com/open-webui/open-webui/commit/140605e660b8186a7d5c79fb3be6ffb147a2f498) Merge pull request #19462 from open-webui/dev - [`6f1486f`](https://github.com/open-webui/open-webui/commit/6f1486ffd0cb288d0e21f41845361924e0d742b3) Merge pull request #19466 from open-webui/dev - [`d95f533`](https://github.com/open-webui/open-webui/commit/d95f533214e3fe5beb5e41ec1f349940bc4c7043) Merge pull request #19729 from open-webui/dev - [`a727153`](https://github.com/open-webui/open-webui/commit/a7271532f8a38da46785afcaa7e65f9a45e7d753) 0.6.43 (#20093) - [`6adde20`](https://github.com/open-webui/open-webui/commit/6adde203cd292a9e3af9c64a2ae36b603fed096a) Merge pull request #20394 from open-webui/dev - [`f9b0534`](https://github.com/open-webui/open-webui/commit/f9b0534e0c442631d1cb7205169588b9b6204179) Merge pull request #20522 from open-webui/dev ### 📊 Changes **9 files changed** (+116 additions, -11 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/env.py` (+32 -0) 📝 `backend/open_webui/functions.py` (+4 -1) 📝 `backend/open_webui/main.py` (+12 -4) 📝 `backend/open_webui/routers/functions.py` (+43 -1) 📝 `backend/open_webui/utils/actions.py` (+4 -1) 📝 `backend/open_webui/utils/auth.py` (+5 -2) 📝 `backend/open_webui/utils/filter.py` (+4 -0) 📝 `backend/open_webui/utils/plugin.py` (+11 -2) 📝 `backend/requirements.txt` (+1 -0) </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. --> # 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. - [ ] **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. - [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. - [ ] **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. - [ ] **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 PR introduces granular control over Function and Tool features through new environment variables, enhancing security and operational flexibility. It allows administrators to enable or disable specific aspects of function and tool management, such as creation/modification, pip installations, and URL loading. Additionally, API key generation is made configurable (i.e. API key length). This PR is nothing fancy, just a small PR with some small security enhancements. ### Added - New environment variables for granular control over functions and tools: - `ENABLE_FUNCTIONS_WRITE`: Controls the ability to create, modify, or delete functions. - `ENABLE_FUNCTIONS_PIP_INSTALL`: Controls whether functions can trigger `pip install` commands. - `ENABLE_FUNCTIONS_URL_LOAD`: Controls the ability to load functions from external URLs. - `ENABLE_TOOLS_CODE_EXECUTION`: Controls whether tool code execution is allowed. - Environment variables for API key customization: - `API_KEY_LENGTH`: Specifies the length of generated API keys. - `API_KEY_PREFIX`: Specifies the prefix for generated API keys. ### Changed - Function and Tool related endpoints and logic (e.g., `get_function_models`, `chat_action`, router inclusion, dependency installation) now respect the new `ENABLE_FUNCTIONS` flag, preventing execution if disabled. - Specific function management endpoints (`load_function_from_url`, `sync_functions`, `create_new_function`, `toggle_function_by_id`, `toggle_global_by_id`, `update_function_by_id`, `delete_function_by_id`) are now protected by `ENABLE_FUNCTIONS_WRITE` and `ENABLE_FUNCTIONS_URL_LOAD` flags. - Tool code loading (`load_tool_module_by_id`) is now protected by `ENABLE_TOOLS_CODE_EXECUTION`. - Function requirements installation (`install_frontmatter_requirements`) is now protected by `ENABLE_FUNCTIONS_PIP_INSTALL`. - API key generation now utilizes the `API_KEY_LENGTH` and `API_KEY_PREFIX` environment variables for customization. - During `lifespan` initialization, function/tool dependency installation is skipped if `ENABLE_FUNCTIONS` is false. - `SAFE_MODE` now also deactivates all functions if enabled. ### Fixed - Add `numba>=0.60.0` to `requirements.txt` to prevent `unstructured` dependency issues. ### Dependencies - Added `numba>=0.60.0` to `backend/requirements.txt` to resolve potential dependency conflicts with other libraries, specifically `unstructured`. --- ### Additional Information - These new environment variables provide more fine-grained control for administrators to manage security aspects related to dynamic code execution and external integrations. - Existing functionality will default to `True` for these new flags to maintain current behavior unless explicitly set to `False`. ### Screenshots or Videos - [Attach any relevant screenshots or videos demonstrating the changes] ### 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. --> 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-04-25 13:52:06 -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#41687
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?