Merging to release-5.3.6: [TT-13087] Adjust example gateway config, to have match preficing explicit by default (#6564)

buger commented 2 months ago

User description

TT-13087 Adjust example gateway config, to have match preficing explicit by default (#6564)

User description

Description

TT-13087 Adjust example gateway config, to have match preficing explicit by default

Motivation and Context

Would be advised that Gateway users, would have by default explicit path matching settings enabled by default, as the wildcard behaviour of the path matching, can be challenging at times to configure properly.

How This Has Been Tested

Types of changes

[x] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[x] Breaking change (fix or feature that would cause existing functionality to change)
[x] Refactoring or add test (improvements in base code or adds test coverage to functionality)

Checklist

[x] I ensured that the documentation is up to date
[x] I explained why this PR updates go.mod in detail with reasoning why it's required
[x] I would like a code coverage CI quality gate exception and have explained why

PR Type

enhancement, configuration changes

Description

Added new configuration options in tyk.conf.example to enable strict routing and explicit path matching by default.
The changes aim to improve the default behavior for gateway users by making path matching settings explicit.

Changes walkthrough 📝

Relevant files

Configuration changes

tyk.conf.example

Add explicit path
matching options to example gateway config

tyk.conf.example

Added http_server_options section.

Enabled enable_strict_routes.

Enabled enable_path_prefix_matching.

Enabled enable_path_suffix_matching.

+5/-0

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

PR Type

enhancement, configuration changes

Description

Added new configuration options in tyk.conf.example to enable explicit path matching by default.
Introduced http_server_options with enable_strict_routes, enable_path_prefix_matching, and enable_path_suffix_matching set to true.
These changes aim to provide more predictable path matching behavior and improve configuration clarity for gateway users.

Changes walkthrough 📝

Relevant files

Configuration changes

tyk.conf.example

Add explicit path matching options to example gateway config

tyk.conf.example

Added http_server_options section.

Enabled enable_strict_routes.

Enabled enable_path_prefix_matching.

Enabled enable_path_suffix_matching.

+5/-0

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

github-actions[bot] commented 2 months ago

API Changes

no api changes detected

github-actions[bot] commented 2 months ago

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review

Configuration Change
The new configuration options `enable_strict_routes`, `enable_path_prefix_matching`, and `enable_path_suffix_matching` have been added to improve path matching behavior. Ensure that these changes are well-documented and communicated to users, as they could affect existing deployments.

github-actions[bot] commented 2 months ago

PR Code Suggestions ✨

Category	Suggestion	Score
Security	Change the default setting of `enable_path_suffix_matching` to `false` to enhance security and routing precision ___ Consider setting `"enable_path_suffix_matching"` to `false` by default to avoid unintended route matches that could lead to security issues or misrouting unless explicitly needed. [tyk.conf.example [36]](https://github.com/TykTechnologies/tyk/pull/6568/files#diff-a6736b4b3cda1ee503675d7b725f6138f4eb83d7145f3afecf6087d219f2b23aR36-R36) ```diff "http_server_options": { "enable_strict_routes": true, "enable_path_prefix_matching": true, - "enable_path_suffix_matching": true + "enable_path_suffix_matching": false } ``` Suggestion importance[1-10]: 8 Why: The suggestion addresses a potential security concern by recommending a more secure default configuration, which can prevent unintended route matches and enhance routing precision. This is an important consideration for maintaining secure and predictable behavior in the application. The existing code and improved code sections are correctly derived from the PR code diff.	8