[PR #17794] feat: Enforce optional password policy for users #11349

Open
opened 2025-11-11 19:29:26 -06:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/17794
Author: @Sozial-KI
Created: 9/26/2025
Status: 🔄 Open

Base: devHead: feat-add-basic-password-policy


📝 Commits (2)

  • 723c424 feat: Enforce optional password policy for users
  • 1838bf6 feat: make password policy length and required symbols configurable

📊 Changes

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

View changed files

📝 backend/open_webui/config.py (+17 -0)
📝 backend/open_webui/constants.py (+3 -0)
📝 backend/open_webui/main.py (+3 -0)
📝 backend/open_webui/routers/auths.py (+48 -4)
📝 backend/open_webui/routers/users.py (+14 -0)
📝 backend/open_webui/utils/misc.py (+18 -0)

📄 Description

Given the env variable ENABLE_ENFORCE_PASSWORD_POLICY is set to "true", the backend will enforce a basic password policy when users sign up, change their password or are create throught the api.

This is a basic implementation of the suggestion in this discussion post.

The password policy is currently hardcoded to be at least 12 characters, contain at least one number, one upper and one lowercase letter and one special character.

The feature is disabled by default to avoid introducing a breaking change.

Please find the PR to update documentation here.

NOTE: Tests where not updated, as the tests seem to be broken right now (as per this discussion entry https://github.com/open-webui/open-webui/discussions/12999)

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 to validate 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 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

Add the option to enforce a basic password-policy so that users are forced to set secure passwords, by setting the environment variable ENABLE_ENFORCE_PASSWORD_POLICY to true.
The feature is turned off by default to avoid introducing a breaking change.

Added

  • Added the persistent config option ENABLE_ENFORCE_PASSWORD_POLICY
  • Add a basic hard coded password policy (12+ characters, one uppercase, one lowercase, one number, one symbol), that is enforced on password change, signup and when creating or updating users through the API.

Changed

  • [List any changes, updates, refactorings, or optimizations]

Deprecated

  • [List any deprecated functionality or features that have been removed]

Removed

  • [List any removed features, files, or functionalities]

Fixed

  • [List any fixes, corrections, or bug fixes]

Security

  • Added option to enforce a basic password policy

Breaking Changes

  • BREAKING CHANGE: [List any breaking changes affecting compatibility or functionality]

Additional Information

  • [Insert any additional context, notes, or explanations for the changes]
    • [Reference any related issues, commits, or other relevant information]

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.


🔄 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/17794 **Author:** [@Sozial-KI](https://github.com/Sozial-KI) **Created:** 9/26/2025 **Status:** 🔄 Open **Base:** `dev` ← **Head:** `feat-add-basic-password-policy` --- ### 📝 Commits (2) - [`723c424`](https://github.com/open-webui/open-webui/commit/723c424bd6ebe3dd176dea00d8b499384c0912e0) feat: Enforce optional password policy for users - [`1838bf6`](https://github.com/open-webui/open-webui/commit/1838bf622eaf9c45ace4697f8c622e0fea8f5912) feat: make password policy length and required symbols configurable ### 📊 Changes **6 files changed** (+103 additions, -4 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/config.py` (+17 -0) 📝 `backend/open_webui/constants.py` (+3 -0) 📝 `backend/open_webui/main.py` (+3 -0) 📝 `backend/open_webui/routers/auths.py` (+48 -4) 📝 `backend/open_webui/routers/users.py` (+14 -0) 📝 `backend/open_webui/utils/misc.py` (+18 -0) </details> ### 📄 Description Given the env variable ENABLE_ENFORCE_PASSWORD_POLICY is set to "true", the backend will enforce a basic password policy when users sign up, change their password or are create throught the api. This is a basic implementation of the suggestion in [this discussion post](https://github.com/open-webui/open-webui/discussions/11062). The password policy is currently hardcoded to be at least 12 characters, contain at least one number, one upper and one lowercase letter and one special character. The feature is disabled by default to avoid introducing a breaking change. Please find the PR to update documentation [here](https://github.com/open-webui/docs/pull/714). NOTE: Tests where not updated, as the tests seem to be broken right now (as per this discussion entry https://github.com/open-webui/open-webui/discussions/12999) # 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. - [x] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources? - [x] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [?] **Testing:** Have you written and run sufficient tests to validate 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 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 Add the option to enforce a basic password-policy so that users are forced to set secure passwords, by setting the environment variable ENABLE_ENFORCE_PASSWORD_POLICY to true. The feature is turned off by default to avoid introducing a breaking change. ### Added - Added the persistent config option ENABLE_ENFORCE_PASSWORD_POLICY - Add a basic hard coded password policy (12+ characters, one uppercase, one lowercase, one number, one symbol), that is enforced on password change, signup and when creating or updating users through the API. ### Changed - [List any changes, updates, refactorings, or optimizations] ### Deprecated - [List any deprecated functionality or features that have been removed] ### Removed - [List any removed features, files, or functionalities] ### Fixed - [List any fixes, corrections, or bug fixes] ### Security - Added option to enforce a basic password policy ### Breaking Changes - **BREAKING CHANGE**: [List any breaking changes affecting compatibility or functionality] --- ### Additional Information - [Insert any additional context, notes, or explanations for the changes] - [Reference any related issues, commits, or other relevant information] ### 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)](https://github.com/open-webui/open-webui/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms. --- <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 2025-11-11 19:29:26 -06: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#11349