mirrors/traefik
1
0
Fork 0
mirror of https://github.com/traefik/traefik.git synced 2025-12-19 00:11:19 +01:00
Code Issues Projects Releases Wiki Activity

Fix encodedCharacters entryPoint option documentation

Browse Source
This commit is contained in:
Romain 2025-12-08 10:50:04 +01:00 committed by GitHub
parent f0957c8df4
commit 950e957b03
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 69 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
docs/content/routing/entrypoints.md
View File

@ -129,6 +129,7 @@ They can be defined by using a file (YAML or TOML) or CLI arguments.
trustedIPs: trustedIPs:
- "127.0.0.1" - "127.0.0.1"
- "192.168.0.1" - "192.168.0.1"
http:
encodedCharacters: encodedCharacters:
allowEncodedSlash: true allowEncodedSlash: true
allowEncodedBackSlash: true allowEncodedBackSlash: true
@ -164,7 +165,7 @@ They can be defined by using a file (YAML or TOML) or CLI arguments.
[entryPoints.name.forwardedHeaders] [entryPoints.name.forwardedHeaders]
insecure = true insecure = true
trustedIPs = ["127.0.0.1", "192.168.0.1"] trustedIPs = ["127.0.0.1", "192.168.0.1"]
[entryPoints.name.encodedCharacters] [entryPoints.name.http.encodedCharacters]
allowEncodedSlash = true allowEncodedSlash = true
allowEncodedBackSlash = true allowEncodedBackSlash = true
allowEncodedNullCharacter = true allowEncodedNullCharacter = true
@ -190,13 +191,13 @@ They can be defined by using a file (YAML or TOML) or CLI arguments.
--entryPoints.name.proxyProtocol.trustedIPs=127.0.0.1,192.168.0.1 --entryPoints.name.proxyProtocol.trustedIPs=127.0.0.1,192.168.0.1
--entryPoints.name.forwardedHeaders.insecure=true --entryPoints.name.forwardedHeaders.insecure=true
--entryPoints.name.forwardedHeaders.trustedIPs=127.0.0.1,192.168.0.1 --entryPoints.name.forwardedHeaders.trustedIPs=127.0.0.1,192.168.0.1
--entryPoints.name.encodedCharacters.allowEncodedSlash=true --entryPoints.name.http.encodedCharacters.allowEncodedSlash=true
--entryPoints.name.encodedCharacters.allowEncodedBackSlash=true --entryPoints.name.http.encodedCharacters.allowEncodedBackSlash=true
--entryPoints.name.encodedCharacters.allowEncodedNullCharacter=true --entryPoints.name.http.encodedCharacters.allowEncodedNullCharacter=true
--entryPoints.name.encodedCharacters.allowEncodedSemicolon=true --entryPoints.name.http.encodedCharacters.allowEncodedSemicolon=true
--entryPoints.name.encodedCharacters.allowEncodedPercent=true --entryPoints.name.http.encodedCharacters.allowEncodedPercent=true
--entryPoints.name.encodedCharacters.allowEncodedQuestionMark=true --entryPoints.name.http.encodedCharacters.allowEncodedQuestionMark=true
--entryPoints.name.encodedCharacters.allowEncodedHash=true --entryPoints.name.http.encodedCharacters.allowEncodedHash=true
``` ```
### Address ### Address
@ -657,6 +658,7 @@ By default, Traefik rejects requests containing certain encoded characters that
entryPoints: entryPoints:
web: web:
address: ":80" address: ":80"
http:
encodedCharacters: encodedCharacters:
allowEncodedSlash: true allowEncodedSlash: true
``` ```
@ -667,14 +669,14 @@ By default, Traefik rejects requests containing certain encoded characters that
[entryPoints.web] [entryPoints.web]
address = ":80" address = ":80"
[entryPoints.web.encodedCharacters] [entryPoints.web.http.encodedCharacters]
allowEncodedSlash = true allowEncodedSlash = true
``` ```
```bash tab="CLI" ```bash tab="CLI"
## Static configuration ## Static configuration
--entryPoints.web.address=:80 --entryPoints.web.address=:80
--entryPoints.web.encodedCharacters.allowEncodedSlash=true --entryPoints.web.http.encodedCharacters.allowEncodedSlash=true
``` ```
??? info "`encodedCharacters.allowEncodedBackSlash`" ??? info "`encodedCharacters.allowEncodedBackSlash`"
@ -688,6 +690,7 @@ By default, Traefik rejects requests containing certain encoded characters that
entryPoints: entryPoints:
web: web:
address: ":80" address: ":80"
http:
encodedCharacters: encodedCharacters:
allowEncodedBackSlash: true allowEncodedBackSlash: true
``` ```
@ -698,14 +701,14 @@ By default, Traefik rejects requests containing certain encoded characters that
[entryPoints.web] [entryPoints.web]
address = ":80" address = ":80"
[entryPoints.web.encodedCharacters] [entryPoints.web.http.encodedCharacters]
allowEncodedBackSlash = true allowEncodedBackSlash = true
``` ```
```bash tab="CLI" ```bash tab="CLI"
## Static configuration ## Static configuration
--entryPoints.web.address=:80 --entryPoints.web.address=:80
--entryPoints.web.encodedCharacters.allowEncodedBackSlash=true --entryPoints.web.http.encodedCharacters.allowEncodedBackSlash=true
``` ```
??? info "`encodedCharacters.allowEncodedNullCharacter`" ??? info "`encodedCharacters.allowEncodedNullCharacter`"
@ -719,6 +722,7 @@ By default, Traefik rejects requests containing certain encoded characters that
entryPoints: entryPoints:
web: web:
address: ":80" address: ":80"
http:
encodedCharacters: encodedCharacters:
allowEncodedNullCharacter: true allowEncodedNullCharacter: true
``` ```
@ -729,14 +733,14 @@ By default, Traefik rejects requests containing certain encoded characters that
[entryPoints.web] [entryPoints.web]
address = ":80" address = ":80"
[entryPoints.web.encodedCharacters] [entryPoints.web.http.encodedCharacters]
allowEncodedNullCharacter = true allowEncodedNullCharacter = true
``` ```
```bash tab="CLI" ```bash tab="CLI"
## Static configuration ## Static configuration
--entryPoints.web.address=:80 --entryPoints.web.address=:80
--entryPoints.web.encodedCharacters.allowEncodedNullCharacter=true --entryPoints.web.http.encodedCharacters.allowEncodedNullCharacter=true
``` ```
??? info "`encodedCharacters.allowEncodedSemicolon`" ??? info "`encodedCharacters.allowEncodedSemicolon`"
@ -750,6 +754,7 @@ By default, Traefik rejects requests containing certain encoded characters that
entryPoints: entryPoints:
web: web:
address: ":80" address: ":80"
http:
encodedCharacters: encodedCharacters:
allowEncodedSemicolon: true allowEncodedSemicolon: true
``` ```
@ -760,14 +765,14 @@ By default, Traefik rejects requests containing certain encoded characters that
[entryPoints.web] [entryPoints.web]
address = ":80" address = ":80"
[entryPoints.web.encodedCharacters] [entryPoints.web.http.encodedCharacters]
allowEncodedSemicolon = true allowEncodedSemicolon = true
``` ```
```bash tab="CLI" ```bash tab="CLI"
## Static configuration ## Static configuration
--entryPoints.web.address=:80 --entryPoints.web.address=:80
--entryPoints.web.encodedCharacters.allowEncodedSemicolon=true --entryPoints.web.http.encodedCharacters.allowEncodedSemicolon=true
``` ```
??? info "`encodedCharacters.allowEncodedPercent`" ??? info "`encodedCharacters.allowEncodedPercent`"
@ -781,6 +786,7 @@ By default, Traefik rejects requests containing certain encoded characters that
entryPoints: entryPoints:
web: web:
address: ":80" address: ":80"
http:
encodedCharacters: encodedCharacters:
allowEncodedPercent: true allowEncodedPercent: true
``` ```
@ -791,14 +797,14 @@ By default, Traefik rejects requests containing certain encoded characters that
[entryPoints.web] [entryPoints.web]
address = ":80" address = ":80"
[entryPoints.web.encodedCharacters] [entryPoints.web.http.encodedCharacters]
allowEncodedPercent = true allowEncodedPercent = true
``` ```
```bash tab="CLI" ```bash tab="CLI"
## Static configuration ## Static configuration
--entryPoints.web.address=:80 --entryPoints.web.address=:80
--entryPoints.web.encodedCharacters.allowEncodedPercent=true --entryPoints.web.http.encodedCharacters.allowEncodedPercent=true
``` ```
??? info "`encodedCharacters.allowEncodedQuestionMark`" ??? info "`encodedCharacters.allowEncodedQuestionMark`"
@ -812,6 +818,7 @@ By default, Traefik rejects requests containing certain encoded characters that
entryPoints: entryPoints:
web: web:
address: ":80" address: ":80"
http:
encodedCharacters: encodedCharacters:
allowEncodedQuestionMark: true allowEncodedQuestionMark: true
``` ```
@ -822,14 +829,14 @@ By default, Traefik rejects requests containing certain encoded characters that
[entryPoints.web] [entryPoints.web]
address = ":80" address = ":80"
[entryPoints.web.encodedCharacters] [entryPoints.web.http.encodedCharacters]
allowEncodedQuestionMark = true allowEncodedQuestionMark = true
``` ```
```bash tab="CLI" ```bash tab="CLI"
## Static configuration ## Static configuration
--entryPoints.web.address=:80 --entryPoints.web.address=:80
--entryPoints.web.encodedCharacters.allowEncodedQuestionMark=true --entryPoints.web.http.encodedCharacters.allowEncodedQuestionMark=true
``` ```
??? info "`encodedCharacters.allowEncodedHash`" ??? info "`encodedCharacters.allowEncodedHash`"
@ -843,6 +850,7 @@ By default, Traefik rejects requests containing certain encoded characters that
entryPoints: entryPoints:
web: web:
address: ":80" address: ":80"
http:
encodedCharacters: encodedCharacters:
allowEncodedHash: true allowEncodedHash: true
``` ```
@ -853,14 +861,14 @@ By default, Traefik rejects requests containing certain encoded characters that
[entryPoints.web] [entryPoints.web]
address = ":80" address = ":80"
[entryPoints.web.encodedCharacters] [entryPoints.web.http.encodedCharacters]
allowEncodedHash = true allowEncodedHash = true
``` ```
```bash tab="CLI" ```bash tab="CLI"
## Static configuration ## Static configuration
--entryPoints.web.address=:80 --entryPoints.web.address=:80
--entryPoints.web.encodedCharacters.allowEncodedHash=true --entryPoints.web.http.encodedCharacters.allowEncodedHash=true
``` ```
### Transport ### Transport

17
docs/content/security/request-path.md
View File

@ -93,6 +93,7 @@ All encoded character filtering is enabled by default (`false` means encoded cha
entryPoints: entryPoints:
websecure: websecure:
address: ":443" address: ":443"
http:
encodedCharacters: encodedCharacters:
allowEncodedSlash: false # %2F - Default: false (RECOMMENDED) allowEncodedSlash: false # %2F - Default: false (RECOMMENDED)
allowEncodedBackSlash: false # %5C - Default: false (RECOMMENDED) allowEncodedBackSlash: false # %5C - Default: false (RECOMMENDED)
@ -107,7 +108,7 @@ entryPoints:
[entryPoints.websecure] [entryPoints.websecure]
address = ":443" address = ":443"
[entryPoints.websecure.encodedCharacters] [entryPoints.websecure.http.encodedCharacters]
allowEncodedSlash = false allowEncodedSlash = false
allowEncodedBackSlash = false allowEncodedBackSlash = false
allowEncodedNullCharacter = false allowEncodedNullCharacter = false
@ -119,11 +120,11 @@ entryPoints:
```bash tab="CLI" ```bash tab="CLI"
--entryPoints.websecure.address=:443 --entryPoints.websecure.address=:443
--entryPoints.websecure.encodedCharacters.allowEncodedSlash=false --entryPoints.websecure.http.encodedCharacters.allowEncodedSlash=false
--entryPoints.websecure.encodedCharacters.allowEncodedBackSlash=false --entryPoints.websecure.http.encodedCharacters.allowEncodedBackSlash=false
--entryPoints.websecure.encodedCharacters.allowEncodedNullCharacter=false --entryPoints.websecure.http.encodedCharacters.allowEncodedNullCharacter=false
--entryPoints.websecure.encodedCharacters.allowEncodedSemicolon=false --entryPoints.websecure.http.encodedCharacters.allowEncodedSemicolon=false
--entryPoints.websecure.encodedCharacters.allowEncodedPercent=false --entryPoints.websecure.http.encodedCharacters.allowEncodedPercent=false
--entryPoints.websecure.encodedCharacters.allowEncodedQuestionMark=false --entryPoints.websecure.http.encodedCharacters.allowEncodedQuestionMark=false
--entryPoints.websecure.encodedCharacters.allowEncodedHash=false --entryPoints.websecure.http.encodedCharacters.allowEncodedHash=false
``` ```