Giovanni Rivera
a84a7cee7e
📚 Doc: Fix code snippet indentation in /docs/api/middleware/keyauth.md
...
Removes an an extra level of indentation in line 51 of
`keyauth.md` [here](https://github.com/gofiber/fiber/blob/v2/docs/api/middleware/keyauth.md?plain=1#L51 )
2024-02-18 18:21:23 -08:00
René Werner
476e1ed9fe
fix healthcheck.md
2024-01-05 14:36:18 +01:00
Lucas Lemos
6249bc48bc
✨ feat: add liveness and readiness checks ( #2509 )
...
* ✨ feat: add liveness and readiness checkers
* 📝 docs: add docs for liveness and readiness
* ✨ feat: add options method for probe checkers
* ✅ tests: add tests for liveness and readiness
* ♻️ refactor: change default endpoint values
* ♻️ refactor: change default value for liveness endpoint
* 📝 docs: add return status for liveness and readiness probes
* ♻️ refactor: change probechecker to middleware
* 📝 docs: move docs to middleware session
* ♻️ refactor: apply gofumpt formatting
* ♻️ refactor: remove unused parameter
* split config and apply a review
* apply reviews and add testcases
* add benchmark
* cleanup
* rename middleware
* fix linter
* Update docs and config values
* Revert change to IsReady
* Updates based on code review
* Update docs to match other middlewares
---------
Co-authored-by: Muhammed Efe Cetin <efectn@protonmail.com>
Co-authored-by: Juan Calderon-Perez <835733+gaby@users.noreply.github.com>
Co-authored-by: Juan Calderon-Perez <jgcalderonperez@protonmail.com>
2024-01-03 18:13:58 +01:00
RW
38eb4bd238
♻️ logger/middleware colorize logger error message #2593 ( #2773 )
2023-12-23 08:31:58 +01:00
Bruno
dc2d2ef524
Changing default log output ( #2730 )
...
changing default log output
Closes #2729
2023-12-18 15:20:18 +01:00
Benjamin Grosse
b1850834a3
fix: don't constrain middlewares' context-keys to strings 🐛 ( #2751 )
...
* Revert "Revert "🐛 requestid.Config.ContextKey is interface{} (#2369 )" (#2742 )"
This reverts commit 28be17f929
.
* fix: request ContextKey default value condition
Should check for `nil` since it is `any`.
* fix: don't constrain middlewares' context-keys to strings
`context` recommends using "unexported type" as context keys to avoid
collisions https://pkg.go.dev/github.com/gofiber/fiber/v2#Ctx.Locals .
The official go blog also recommends this https://go.dev/blog/context .
`fiber.Ctx.Locals(key any, value any)` correctly allows consumers to
use unexported types or e.g. strings.
But some fiber middlewares constrain their context-keys to `string` in
their "default config structs", making it impossible to use unexported
types.
This PR removes the `string` _constraint_ from all middlewares, allowing
to now use unexported types as per the official guidelines. However
the default value is still a string, so it's not a breaking change, and
anyone still using strings as context keys is not affected.
2023-12-12 14:55:29 +01:00
iRedMail
c441bdf2d0
🩹 middleware/logger/: log client IP address by default ( #2755 )
...
* middleware/logger: Log client IP address by default.
* Update doc.
2023-12-08 10:36:43 +01:00
Jason McNeil
e4d7e84335
chore(encryptcookie)!: update default config ( #2753 )
...
* chore(encryptcookie)!: update default config
docs(encryptcookie): enhance documentation and examples
BREAKING CHANGE: removed the hardcoded "csrf_" from the Except.
* docs(encryptcookie): reads or modifies cookies
* chore(encryptcookie): csrf config example
* docs(encryptcookie): md table spacing
2023-12-07 08:39:41 +01:00
RW
28be17f929
Revert " 🐛 requestid.Config.ContextKey is interface{} ( #2369 )" ( #2742 )
...
This reverts commit d7b36cde
2023-11-27 14:35:49 +01:00
Jason McNeil
2374cad3cd
📄 docs: improve csrf docs ( #2726 )
...
* docs: improve csrf docs
- fix issues with `X-Csrf-Token` capitalization inconsistency.
- reduce redundancy and repetition.
- improve grammar.
* docs: update middleware description
* docs: within vs in
* docs: deleting tokens
* docs: MUST
* docs: add colon
* docs: all modern browsers
* docs: patterns
* docs: improve phrasing of pattern options
2023-11-16 12:34:31 +01:00
Jason McNeil
4bf3695125
📄 docs: enhance csrf.md ( #2692 )
...
* docs: enhance csrf.md
* docs: simplify language
* docs: update csrf.md
* docs: delete token/session reminders
* docs: and ! or
2023-10-27 13:45:30 +02:00
RW
6f0d34d39e
Update csrf.md
2023-10-16 14:31:28 +02:00
Jason McNeil
8c3916dbf4
Merge pull request from GHSA-94w9-97p3-p368
...
* feat: improved csrf with session support
* fix: double submit cookie
* feat: add warning cookie extractor without session
* feat: add warning CsrfFromCookie SameSite
* fix: use byes.Equal instead
* fix: Overriden CookieName KeyLookup cookie:<name>
* feat: Create helpers.go
* feat: use compareTokens (constant time compare)
* feat: validate cookie to prevent token injection
* refactor: clean up csrf.go
* docs: update comment about Double Submit Cookie
* docs: update docs for CSRF changes
* feat: add DeleteToken
* refactor: no else
* test: add more tests
* refactor: re-order tests
* docs: update safe methods RCF add note
* test: add CSRF_Cookie_Injection_Exploit
* feat: add SingleUseToken config
* test: check for new token
* docs: use warning
* fix: always register type Token
* feat: use UUIDv4
* test: swap in UUIDv4 here too
* fix: raw token injection
* fix: merege error
* feat: Sentinel errors
* chore: rename test
* fix: url parse
* test: add path to referer
* test: add expiration tests
* docs: add cookie prefix note
* docs: fix typo
* docs: add warning for refer checks
* test: add referer edge cases
And call ctx.Request.Reset() and
ctx.Response.Reset() before re-using ctx.
2023-10-16 09:06:30 +02:00
Javier Scappini
d974cf3c99
Fix typo in requestid.md
...
Minor typo fix in requestid.md.
2023-10-13 11:37:06 +00:00
Jason McNeil
b50d91d58e
Merge pull request from GHSA-94w9-97p3-p368
...
* feat: improved csrf with session support
* fix: double submit cookie
* feat: add warning cookie extractor without session
* feat: add warning CsrfFromCookie SameSite
* fix: use byes.Equal instead
* fix: Overriden CookieName KeyLookup cookie:<name>
* feat: Create helpers.go
* feat: use compareTokens (constant time compare)
* feat: validate cookie to prevent token injection
* refactor: clean up csrf.go
* docs: update comment about Double Submit Cookie
* docs: update docs for CSRF changes
* feat: add DeleteToken
* refactor: no else
* test: add more tests
* refactor: re-order tests
* docs: update safe methods RCF add note
* test: add CSRF_Cookie_Injection_Exploit
* feat: add SingleUseToken config
* test: check for new token
* docs: use warning
* fix: always register type Token
* feat: use UUIDv4
* test: swap in UUIDv4 here too
2023-10-11 14:41:42 +02:00
René Werner
59409f3841
improve sendFile documentation
2023-10-06 11:43:10 +02:00
René Werner
5171f6b505
improve compress middleware documentation
2023-10-05 09:00:11 +02:00
KaptinLin
d00f0b8348
✨ feat: add Reset method to Session struct in session middleware ( #2654 )
2023-10-02 15:19:35 +02:00
KaptinLin
d86c257c89
✨ feat: add Delete method to Store struct in session middleware ( #2655 )
...
* ✨ feat: add Delete method to Store struct in session middleware
* ♻ refactor: enhance Delete method and test cases in session middleware
2023-10-02 15:19:18 +02:00
Jimmy Li
c0988de91e
📝 middleware: cors: update docs to better explain AllowOriginsFunc ( #2652 )
2023-09-28 08:28:35 +02:00
M. Efe Çetin
e6d6fbe5a8
✨ middleware: cors: allow disabling caching in preflight requests ( #2649 )
2023-09-27 15:06:24 +02:00
RW
e547bea49e
Update cache.md
2023-09-20 09:14:58 +02:00
Jacob
892b23bd46
✨ Add custom data property to favicon middleware config ( #2579 )
...
* Add custom data property to favicon middleware
* Update favicon middleware docs
* Fix formatting
2023-08-17 15:04:53 +02:00
René Werner
443804e95d
improved the config section of the middleware readme´s
2023-07-24 17:03:11 +02:00
RW
51ea636b60
improved the config section of the middleware readme´s ( #2552 )
2023-07-24 16:46:50 +02:00
f1rstmehul
08099b0635
📚 Docs: Fix link ( #2542 )
...
fix link
2023-07-15 20:20:29 +02:00
RW
1603a148fe
Update logger.md
2023-06-22 13:21:14 +02:00
RW
b308b2b7a6
Update logger.md
...
correct spacings
2023-06-22 13:07:33 +02:00
cmd777
1b060cb150
🩹 Fix: default logger color behaviour ( #2513 )
...
* Fix logger colors
* Fix tests
Basically add ˙enableColors: true˙ back to default config
2023-06-22 13:06:37 +02:00
Anzhi
06ef450a8a
🚀 Add DisableColors to set the default output format ( #2493 )
...
Add DisableColor for default logger format
2023-06-05 13:20:45 +02:00
leonklingele
c56b4e66a0
middleware/adaptor: allow to convert fiber.Ctx to (net/http).Request ( #2461 )
2023-05-15 13:04:58 +02:00
M. Efe Çetin
c7c37d9b50
♻️ refactor: merge some external middlewares to core ( #2453 )
...
* ♻️ refactor: merge adaptor, helmet, keyauth, redirect, rewrite middlewares to core
* fix linting issues
* fix linting issues
* fix linting issues
* update
2023-05-10 08:01:49 +02:00
bcd
3c3f12b76c
[Feature]: Add filesystem config contentTypeCharset support ( #2438 )
...
* Update filesystem.go
* Update filesystem_test.go
* Update filesystem.md
* fmt
2023-05-02 08:40:20 +02:00
RW
ee2b13c8c0
Update timeout.md
2023-04-14 12:18:00 +02:00
cmd777
3b7a7d491b
📚 Docs: Fix import and comma issues ( #2410 )
...
Fix import and comma issues
2023-04-13 12:32:39 +08:00
James Lucas
866d5b7628
✨ feat(cors): Added new 'AllowOriginsFunc' function. ( #2394 )
...
* ✨ feat(cors): Added new 'AllowOriginsFunc' function.
* feat(cors): Added warning log for when both 'AllowOrigins' and 'AllowOriginsFunc' are set.
* feat(docs): Updated docs to include note about discouraging the use of this function in production workloads.
---------
Co-authored-by: RW <rene@gofiber.io>
2023-04-11 10:24:29 +02:00
cmd777
8b1f9260a3
📚 Docs: Fix typos, and make middleware documentation more consistent ( #2408 )
...
Fix typos, and make docs more consistent
This fixes several typos in the ISSUE_TEMPLATES, as well as improve
their readability, also makes the documentation markdowns more
consistent
2023-04-10 10:48:12 +08:00
Hakan Kutluay
22b407e2e7
🐛 [Bug-Fix] add original timeout middleware ( #2367 )
...
* add original timeout middleware
* fix linter issues
* deprecate original timeout middleware
* update timeout middleware documentation
2023-04-09 16:05:51 +02:00
René Werner
1f52799686
Refresh middleware documentation
2023-03-24 13:23:52 +01:00
Benjamin Grosse
d7b36cde54
🐛 requestid.Config.ContextKey is interface{} ( #2369 )
...
requestid.Config.ContextKey is interface{}
Consistent with c.Locals(key inteface{}, ...).
Fixes #2356
2023-03-14 19:37:10 +01:00
Tumushimire Yves
634f163e3f
🚀 [Feature]: SessionOnly when cookie.Expires is 0 ( #2152 )
...
* feature: session only for zero expire cookie #2145
* refactor condition to set MaxAge and Expire on cookie
* move checking zero maxage and expire in session middleware
Signed-off-by: Yves Tumushimire <yvestumushimire@gmail.com>
* feature: session only for zero expire cookie #2145
* refactor condition to set MaxAge and Expire on cookie
* move checking zero maxage and expire in session middleware
Signed-off-by: Yves Tumushimire <yvestumushimire@gmail.com>
* CR changes
* some updates
---------
Signed-off-by: Yves Tumushimire <yvestumushimire@gmail.com>
Co-authored-by: Muhammed Efe Çetin <efectn@protonmail.com>
Co-authored-by: René Werner <rene.werner@verivox.com>
2023-03-12 19:14:22 +01:00
Muhammed Efe Çetin
15e9235383
📝 docs: remove README.mds from middleware dirs
2023-03-06 16:42:35 +03:00
René Werner
f6b5ed6d26
update proxy docs
2023-02-25 10:57:12 +01:00
René Werner
35e6825614
update proxy docs
2023-02-25 10:55:27 +01:00
M. Efe Çetin
a1eb0e69a6
📝 docs: fix example on envvar middleware
2023-02-25 12:43:57 +03:00
M. Efe Çetin
b3643198f8
📝 docs: automated synchronization with `gofiber/docs` ( #2344 )
...
Automated Synchronization with gofiber/docs repo
2023-02-25 10:29:07 +01:00