mirror of
https://github.com/gofiber/fiber.git
synced 2025-05-16 04:33:01 +00:00
8b1f9260a3
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
99 lines
3.0 KiB
Markdown
99 lines
3.0 KiB
Markdown
---
|
|
id: earlydata
|
|
title: EarlyData
|
|
---
|
|
|
|
The Early Data middleware for [Fiber](https://github.com/gofiber/fiber) adds support for TLS 1.3's early data ("0-RTT") feature.
|
|
Citing [RFC 8446](https://datatracker.ietf.org/doc/html/rfc8446#section-2-3), when a client and server share a PSK, TLS 1.3 allows clients to send data on the first flight ("early data") to speed up the request, effectively reducing the regular 1-RTT request to a 0-RTT request.
|
|
|
|
Make sure to enable fiber's `EnableTrustedProxyCheck` config option before using this middleware in order to not trust bogus HTTP request headers of the client.
|
|
|
|
Also be aware that enabling support for early data in your reverse proxy (e.g. nginx, as done with a simple `ssl_early_data on;`) makes requests replayable. Refer to the following documents before continuing:
|
|
|
|
- https://datatracker.ietf.org/doc/html/rfc8446#section-8
|
|
- https://blog.trailofbits.com/2019/03/25/what-application-developers-need-to-know-about-tls-early-data-0rtt/
|
|
|
|
By default, this middleware allows early data requests on safe HTTP request methods only and rejects the request otherwise, i.e. aborts the request before executing your handler. This behavior can be controlled by the `AllowEarlyData` config option.
|
|
Safe HTTP methods — `GET`, `HEAD`, `OPTIONS` and `TRACE` — should not modify a state on the server.
|
|
|
|
## Signatures
|
|
|
|
```go
|
|
func New(config ...Config) fiber.Handler
|
|
```
|
|
|
|
## Examples
|
|
|
|
Import the middleware package that is part of the Fiber web framework
|
|
|
|
```go
|
|
import (
|
|
"github.com/gofiber/fiber/v2"
|
|
"github.com/gofiber/fiber/v2/middleware/earlydata"
|
|
)
|
|
```
|
|
|
|
After you initiate your Fiber app, you can use the following possibilities:
|
|
|
|
```go
|
|
// Initialize default config
|
|
app.Use(earlydata.New())
|
|
|
|
// Or extend your config for customization
|
|
app.Use(earlydata.New(earlydata.Config{
|
|
Error: fiber.ErrTooEarly,
|
|
// ...
|
|
}))
|
|
```
|
|
|
|
## Config
|
|
|
|
```go
|
|
// Config defines the config for middleware.
|
|
type Config struct {
|
|
// Next defines a function to skip this middleware when returned true.
|
|
//
|
|
// Optional. Default: nil
|
|
Next func(c *fiber.Ctx) bool
|
|
|
|
// IsEarlyData returns whether the request is an early-data request.
|
|
//
|
|
// Optional. Default: a function which checks if the "Early-Data" request header equals "1".
|
|
IsEarlyData func(c *fiber.Ctx) bool
|
|
|
|
// AllowEarlyData returns whether the early-data request should be allowed or rejected.
|
|
//
|
|
// Optional. Default: a function which rejects the request on unsafe and allows the request on safe HTTP request methods.
|
|
AllowEarlyData func(c *fiber.Ctx) bool
|
|
|
|
// Error is returned in case an early-data request is rejected.
|
|
//
|
|
// Optional. Default: fiber.ErrTooEarly.
|
|
Error error
|
|
}
|
|
```
|
|
|
|
## Default Config
|
|
|
|
```go
|
|
var ConfigDefault = Config{
|
|
IsEarlyData: func(c *fiber.Ctx) bool {
|
|
return c.Get(DefaultHeaderName) == DefaultHeaderTrueValue
|
|
},
|
|
|
|
AllowEarlyData: func(c *fiber.Ctx) bool {
|
|
return fiber.IsMethodSafe(c.Method())
|
|
},
|
|
|
|
Error: fiber.ErrTooEarly,
|
|
}
|
|
```
|
|
|
|
## Constants
|
|
|
|
```go
|
|
const (
|
|
DefaultHeaderName = "Early-Data"
|
|
DefaultHeaderTrueValue = "1"
|
|
)
|
|
``` |