[PR #83] [MERGED] feat: implement option to make authentication required for everything #159

New Issue

2026-02-15T21:15:10-05:00

yindo commented

2026-02-15 21:15:10 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/mcpo/pull/83
Author: @tremlin
Created: 4/17/2025
Status: ✅ Merged
Merged: 4/19/2025
Merged by: @tjbck

Base: dev ← Head: feat-extend-api-key-protection

📝 Commits (1)

9d3e34b feat: implement option to make authentication required to access documentation and spec

📊 Changes

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

View changed files

📝 src/mcpo/__init__.py (+5 -0)
📝 src/mcpo/main.py (+10 -1)
📝 src/mcpo/utils/auth.py (+73 -1)

📄 Description

Pull Request Checklist

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.
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

Adds an option to protect all URLs, including the OpenAPI spec and documentation, by requiring an API Key. Both Basic Auth and Bearer token are supported to make it easy to use in browsers.

Added

Adds an option to protect all URLs, including the OpenAPI spec and documentation, by requiring an API Key. Both Basic Auth and Bearer token are supported to make it easy to use in browsers.

Changed

Deprecated

Removed

Fixed

Security

Breaking Changes

Additional Information

At the moment the documentation url /docs and the spec /openapi.json are not protected by an API token.
The API token protects only the API endpoints.

Screenshots or Videos

_{🔄 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/mcpo/pull/83 **Author:** [@tremlin](https://github.com/tremlin) **Created:** 4/17/2025 **Status:** ✅ Merged **Merged:** 4/19/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `feat-extend-api-key-protection` --- ### 📝 Commits (1) - [`9d3e34b`](https://github.com/open-webui/mcpo/commit/9d3e34bfa9e92042af1725ad9b2c90ebdc062654) feat: implement option to make authentication required to access documentation and spec ### 📊 Changes **3 files changed** (+88 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `src/mcpo/__init__.py` (+5 -0) 📝 `src/mcpo/main.py` (+10 -1) 📝 `src/mcpo/utils/auth.py` (+73 -1) </details> ### 📄 Description # Pull Request Checklist **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] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [X] **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 - Adds an option to protect all URLs, including the OpenAPI spec and documentation, by requiring an API Key. Both Basic Auth and Bearer token are supported to make it easy to use in browsers. ### Added - Adds an option to protect all URLs, including the OpenAPI spec and documentation, by requiring an API Key. Both Basic Auth and Bearer token are supported to make it easy to use in browsers. ### Changed ### Deprecated ### Removed ### Fixed ### Security ### Breaking Changes --- ### Additional Information At the moment the documentation url `/docs` and the spec `/openapi.json` are not protected by an API token. The API token protects only the API endpoints. ### Screenshots or Videos --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

yindo added the pull-request label 2026-02-15 21:15:10 -05:00

yindo closed this issue

2026-02-15 21:15:10 -05:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: open-webui/mcpo#159