mirror of https://github.com/gofiber/fiber.git
🧬 Add internal middleware
Fenny
parent
0f890b6f9d
commit
3c8a44e3de
|
|
@ -0,0 +1,75 @@
|
|||
package middleware
|
||||
|
||||
import (
|
||||
"github.com/gofiber/fiber"
|
||||
"github.com/valyala/fasthttp"
|
||||
)
|
||||
|
||||
// Middleware types
|
||||
type (
|
||||
// CompressConfig defines the config for Compress middleware.
|
||||
CompressConfig struct {
|
||||
// Next defines a function to skip this middleware.
|
||||
Next func(ctx *fiber.Ctx) bool
|
||||
// Compression level for brotli, gzip and deflate
|
||||
Level int
|
||||
}
|
||||
)
|
||||
|
||||
// Compression levels
|
||||
const (
|
||||
CompressLevelDisabled = -1
|
||||
CompressLevelDefault = 0
|
||||
CompressLevelBestSpeed = 1
|
||||
CompressLevelBestCompression = 2
|
||||
)
|
||||
|
||||
// Default config
|
||||
var CompressConfigDefault = CompressConfig{
|
||||
Next: nil,
|
||||
Level: CompressLevelDefault,
|
||||
}
|
||||
|
||||
// Compress is the default initiator allowing to pass the compression level
|
||||
// It supports brotli, gzip and deflate compression
|
||||
// The same order is used to check against the Accept-Encoding header
|
||||
func Compress(level ...int) fiber.Handler {
|
||||
// Create default config
|
||||
var config = CompressConfigDefault
|
||||
// Set level if provided
|
||||
if len(level) > 0 {
|
||||
config.Level = level[0]
|
||||
}
|
||||
// Return CompressWithConfig
|
||||
return CompressWithConfig(config)
|
||||
}
|
||||
|
||||
// CompressWithConfig allows you to pass an CompressConfig
|
||||
// It supports brotli, gzip and deflate compression
|
||||
// The same order is used to check against the Accept-Encoding header
|
||||
func CompressWithConfig(config CompressConfig) fiber.Handler {
|
||||
// Init middleware settings
|
||||
var compress fasthttp.RequestHandler
|
||||
switch config.Level {
|
||||
case -1: // Disabled
|
||||
compress = fasthttp.CompressHandlerBrotliLevel(func(c *fasthttp.RequestCtx) {}, fasthttp.CompressBrotliNoCompression, fasthttp.CompressNoCompression)
|
||||
case 1: // Best speed
|
||||
compress = fasthttp.CompressHandlerBrotliLevel(func(c *fasthttp.RequestCtx) {}, fasthttp.CompressBrotliBestSpeed, fasthttp.CompressBestSpeed)
|
||||
case 2: // Best compression
|
||||
compress = fasthttp.CompressHandlerBrotliLevel(func(c *fasthttp.RequestCtx) {}, fasthttp.CompressBrotliBestCompression, fasthttp.CompressBestCompression)
|
||||
default: // Default
|
||||
compress = fasthttp.CompressHandlerBrotliLevel(func(c *fasthttp.RequestCtx) {}, fasthttp.CompressBrotliDefaultCompression, fasthttp.CompressDefaultCompression)
|
||||
}
|
||||
// Return handler
|
||||
return func(c *fiber.Ctx) {
|
||||
// Don't execute the middleware if Next returns false
|
||||
if config.Next != nil && config.Next(c) {
|
||||
c.Next()
|
||||
return
|
||||
}
|
||||
// Middleware logic...
|
||||
c.Next()
|
||||
// Compress response
|
||||
compress(c.Fasthttp)
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
package middleware
|
||||
|
||||
import (
|
||||
"github.com/gofiber/fiber"
|
||||
"github.com/gofiber/utils"
|
||||
)
|
||||
|
||||
// Middleware types
|
||||
type (
|
||||
// HelmetConfig defines the config for Hel;met middleware.
|
||||
HelmetConfig struct {
|
||||
// Next defines a function to skip this middleware.
|
||||
Next func(ctx *fiber.Ctx) bool
|
||||
|
||||
ContentSecurityPolicy string // x
|
||||
CrossDomain string // x
|
||||
DNSPrefetchControl bool // ✓
|
||||
ExpectCTMaxAge int // x
|
||||
ExpectCTEnfore bool // x
|
||||
ExpectCTReportURI string // x
|
||||
FeaturePolicy map[string]string // x
|
||||
FrameGuard string // ✓
|
||||
HSTSMaxAge int // ✓
|
||||
HSTSExcludeSubDomains bool // ✓
|
||||
IEnoOpen bool // ✓
|
||||
NoSniff bool // ✓
|
||||
ReferrerPolicy string // x
|
||||
XSSFilter bool // ✓
|
||||
XSSFilterReportURI string // ✓
|
||||
}
|
||||
)
|
||||
|
||||
// Helmet helps secure your apps by setting various HTTP headers
|
||||
func Helmet() fiber.Handler {
|
||||
return func(ctx *fiber.Ctx) {
|
||||
// Get id from request
|
||||
rid := ctx.Get(fiber.HeaderXRequestID)
|
||||
// Create new UUID if empty
|
||||
if len(rid) <= 0 {
|
||||
rid = utils.UUID()
|
||||
}
|
||||
// Set new id to response
|
||||
ctx.Set(fiber.HeaderXRequestID, rid)
|
||||
// Continue stack
|
||||
ctx.Next()
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,273 @@
|
|||
package middleware
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"strconv"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"github.com/gofiber/fiber"
|
||||
"github.com/gofiber/utils"
|
||||
"github.com/valyala/bytebufferpool"
|
||||
)
|
||||
|
||||
// Middleware types
|
||||
type (
|
||||
// LoggerConfig defines the config for Logger middleware.
|
||||
LoggerConfig struct {
|
||||
// Next defines a function to skip this middleware.
|
||||
Next func(ctx *fiber.Ctx) bool
|
||||
// Format defines the logging format with defined variables
|
||||
// Optional. Default: "${time} ${method} ${path} - ${ip} - ${status} - ${latency}\n"
|
||||
// Possible values:
|
||||
// time, ip, ips, url, host, method, path, protocol, route
|
||||
// referer, ua, latency, status, body, error, bytesSent, bytesReceived
|
||||
// header:<key>, query:<key>, form:<key>, cookie:<key>
|
||||
Format string
|
||||
// TimeFormat https://programming.guide/go/format-parse-string-time-date-example.html
|
||||
// Optional. Default: 15:04:05
|
||||
TimeFormat string
|
||||
// Output is a writter where logs are written
|
||||
// Default: os.Stderr
|
||||
Output io.Writer
|
||||
}
|
||||
)
|
||||
|
||||
// Logger variables
|
||||
const (
|
||||
LoggerTagTime = "time"
|
||||
LoggerTagReferer = "referer"
|
||||
LoggerTagProtocol = "protocol"
|
||||
LoggerTagIP = "ip"
|
||||
LoggerTagIPs = "ips"
|
||||
LoggerTagHost = "host"
|
||||
LoggerTagMethod = "method"
|
||||
LoggerTagPath = "path"
|
||||
LoggerTagURL = "url"
|
||||
LoggerTagUA = "ua"
|
||||
LoggerTagLatency = "latency"
|
||||
LoggerTagStatus = "status"
|
||||
LoggerTagBody = "body"
|
||||
LoggerTagBytesSent = "bytesSent"
|
||||
LoggerTagBytesReceived = "bytesReceived"
|
||||
LoggerTagRoute = "route"
|
||||
LoggerTagError = "error"
|
||||
LoggerTagHeader = "header:"
|
||||
LoggerTagQuery = "query:"
|
||||
LoggerTagForm = "form:"
|
||||
LoggerTagCookie = "cookie:"
|
||||
)
|
||||
|
||||
// Default config
|
||||
var LoggerConfigDefault = LoggerConfig{
|
||||
Next: nil,
|
||||
Format: "${time} ${method} ${path} - ${ip} - ${status} - ${latency}\n",
|
||||
TimeFormat: "15:04:05",
|
||||
Output: os.Stderr,
|
||||
}
|
||||
|
||||
// Logger is the default initiator allowing to pass a log format
|
||||
func Logger(format ...string) fiber.Handler {
|
||||
// Create default config
|
||||
var config = LoggerConfigDefault
|
||||
// Set format if provided
|
||||
if len(format) > 0 {
|
||||
config.Format = format[0]
|
||||
}
|
||||
// Return LoggerWithConfig
|
||||
return LoggerWithConfig(config)
|
||||
}
|
||||
|
||||
// LoggerWithConfig allows you to pass an CompressConfig
|
||||
func LoggerWithConfig(config LoggerConfig) fiber.Handler {
|
||||
// Middleware settings
|
||||
var mutex sync.RWMutex
|
||||
|
||||
var tmpl loggerTemplate
|
||||
tmpl.new(config.Format, "${", "}")
|
||||
|
||||
timestamp := time.Now().Format(config.TimeFormat)
|
||||
// Update date/time every second in a seperate go routine
|
||||
if strings.Contains(config.Format, "${time}") {
|
||||
go func() {
|
||||
for {
|
||||
mutex.Lock()
|
||||
timestamp = time.Now().Format(config.TimeFormat)
|
||||
mutex.Unlock()
|
||||
time.Sleep(250 * time.Millisecond)
|
||||
}
|
||||
}()
|
||||
}
|
||||
// Return handler
|
||||
return func(c *fiber.Ctx) {
|
||||
// Don't execute the middleware if Next returns false
|
||||
if config.Next != nil && config.Next(c) {
|
||||
c.Next()
|
||||
return
|
||||
}
|
||||
// Middleware logic...
|
||||
start := time.Now()
|
||||
// handle request
|
||||
c.Next()
|
||||
// build log
|
||||
stop := time.Now()
|
||||
// Get new buffer
|
||||
buf := bytebufferpool.Get()
|
||||
_, err := tmpl.executeFunc(buf, func(w io.Writer, tag string) (int, error) {
|
||||
switch tag {
|
||||
case LoggerTagTime:
|
||||
mutex.RLock()
|
||||
defer mutex.RUnlock()
|
||||
return buf.WriteString(timestamp)
|
||||
case LoggerTagReferer:
|
||||
return buf.WriteString(c.Get(fiber.HeaderReferer))
|
||||
case LoggerTagProtocol:
|
||||
return buf.WriteString(c.Protocol())
|
||||
case LoggerTagIP:
|
||||
return buf.WriteString(c.IP())
|
||||
case LoggerTagIPs:
|
||||
return buf.WriteString(c.Get(fiber.HeaderXForwardedFor))
|
||||
case LoggerTagHost:
|
||||
return buf.WriteString(c.Hostname())
|
||||
case LoggerTagMethod:
|
||||
return buf.WriteString(c.Method())
|
||||
case LoggerTagPath:
|
||||
return buf.WriteString(c.Path())
|
||||
case LoggerTagURL:
|
||||
return buf.WriteString(c.OriginalURL())
|
||||
case LoggerTagUA:
|
||||
return buf.WriteString(c.Get(fiber.HeaderUserAgent))
|
||||
case LoggerTagLatency:
|
||||
return buf.WriteString(stop.Sub(start).String())
|
||||
case LoggerTagStatus:
|
||||
return buf.WriteString(strconv.Itoa(c.Fasthttp.Response.StatusCode()))
|
||||
case LoggerTagBody:
|
||||
return buf.WriteString(c.Body())
|
||||
case LoggerTagBytesReceived:
|
||||
return buf.WriteString(strconv.Itoa(len(c.Fasthttp.Request.Body())))
|
||||
case LoggerTagBytesSent:
|
||||
return buf.WriteString(strconv.Itoa(len(c.Fasthttp.Response.Body())))
|
||||
case LoggerTagRoute:
|
||||
return buf.WriteString(c.Route().Path)
|
||||
case LoggerTagError:
|
||||
if c.Error() != nil {
|
||||
return buf.WriteString(c.Error().Error())
|
||||
}
|
||||
default:
|
||||
switch {
|
||||
case strings.HasPrefix(tag, LoggerTagHeader):
|
||||
return buf.WriteString(c.Get(tag[7:]))
|
||||
case strings.HasPrefix(tag, LoggerTagQuery):
|
||||
return buf.WriteString(c.Query(tag[6:]))
|
||||
case strings.HasPrefix(tag, LoggerTagForm):
|
||||
return buf.WriteString(c.FormValue(tag[5:]))
|
||||
case strings.HasPrefix(tag, LoggerTagCookie):
|
||||
return buf.WriteString(c.Cookies(tag[7:]))
|
||||
}
|
||||
}
|
||||
return 0, nil
|
||||
})
|
||||
if err != nil {
|
||||
_, _ = buf.WriteString(err.Error())
|
||||
}
|
||||
if _, err := config.Output.Write(buf.Bytes()); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
bytebufferpool.Put(buf)
|
||||
}
|
||||
}
|
||||
|
||||
// MIT License fasttemplate
|
||||
// Copyright (c) 2015 Aliaksandr Valialkin
|
||||
// https://github.com/valyala/fasttemplate/blob/master/LICENSE
|
||||
|
||||
type (
|
||||
loggerTemplate struct {
|
||||
template string
|
||||
startTag string
|
||||
endTag string
|
||||
texts [][]byte
|
||||
tags []string
|
||||
}
|
||||
loggerTagFunc func(w io.Writer, tag string) (int, error)
|
||||
)
|
||||
|
||||
func (t *loggerTemplate) new(template, startTag, endTag string) {
|
||||
t.template = template
|
||||
t.startTag = startTag
|
||||
t.endTag = endTag
|
||||
t.texts = t.texts[:0]
|
||||
t.tags = t.tags[:0]
|
||||
|
||||
if len(startTag) == 0 {
|
||||
panic("startTag cannot be empty")
|
||||
}
|
||||
if len(endTag) == 0 {
|
||||
panic("endTag cannot be empty")
|
||||
}
|
||||
|
||||
s := utils.GetBytes(template)
|
||||
a := utils.GetBytes(startTag)
|
||||
b := utils.GetBytes(endTag)
|
||||
|
||||
tagsCount := bytes.Count(s, a)
|
||||
if tagsCount == 0 {
|
||||
return
|
||||
}
|
||||
|
||||
if tagsCount+1 > cap(t.texts) {
|
||||
t.texts = make([][]byte, 0, tagsCount+1)
|
||||
}
|
||||
if tagsCount > cap(t.tags) {
|
||||
t.tags = make([]string, 0, tagsCount)
|
||||
}
|
||||
|
||||
for {
|
||||
n := bytes.Index(s, a)
|
||||
if n < 0 {
|
||||
t.texts = append(t.texts, s)
|
||||
break
|
||||
}
|
||||
t.texts = append(t.texts, s[:n])
|
||||
|
||||
s = s[n+len(a):]
|
||||
n = bytes.Index(s, b)
|
||||
if n < 0 {
|
||||
panic(fmt.Errorf("Cannot find end tag=%q in the template=%q starting from %q", endTag, template, s))
|
||||
}
|
||||
|
||||
t.tags = append(t.tags, utils.GetString(s[:n]))
|
||||
s = s[n+len(b):]
|
||||
}
|
||||
}
|
||||
|
||||
func (t *loggerTemplate) executeFunc(w io.Writer, f loggerTagFunc) (int64, error) {
|
||||
var nn int64
|
||||
|
||||
n := len(t.texts) - 1
|
||||
if n == -1 {
|
||||
ni, err := w.Write(utils.GetBytes(t.template))
|
||||
return int64(ni), err
|
||||
}
|
||||
|
||||
for i := 0; i < n; i++ {
|
||||
ni, err := w.Write(t.texts[i])
|
||||
nn += int64(ni)
|
||||
if err != nil {
|
||||
return nn, err
|
||||
}
|
||||
|
||||
ni, err = f(w, t.tags[i])
|
||||
nn += int64(ni)
|
||||
if err != nil {
|
||||
return nn, err
|
||||
}
|
||||
}
|
||||
ni, err := w.Write(t.texts[n])
|
||||
nn += int64(ni)
|
||||
return nn, err
|
||||
}
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
package middleware
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/gofiber/fiber"
|
||||
)
|
||||
|
||||
// Recover will recover from panics and calls the ErrorHandler
|
||||
func Recover() fiber.Handler {
|
||||
return func(ctx *fiber.Ctx) {
|
||||
defer func() {
|
||||
if r := recover(); r != nil {
|
||||
err, ok := r.(error)
|
||||
if !ok {
|
||||
err = fmt.Errorf("%v", r)
|
||||
}
|
||||
ctx.Fasthttp.Response.Header.Reset()
|
||||
ctx.App().Settings.ErrorHandler(ctx, err)
|
||||
return
|
||||
}
|
||||
}()
|
||||
ctx.Next()
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
package middleware
|
||||
|
||||
import (
|
||||
"github.com/gofiber/fiber"
|
||||
"github.com/gofiber/utils"
|
||||
)
|
||||
|
||||
// RequestID adds an UUID indentifier to the request
|
||||
func RequestID() fiber.Handler {
|
||||
return func(ctx *fiber.Ctx) {
|
||||
// Get id from request
|
||||
rid := ctx.Get(fiber.HeaderXRequestID)
|
||||
// Create new UUID if empty
|
||||
if len(rid) <= 0 {
|
||||
rid = utils.UUID()
|
||||
}
|
||||
// Set new id to response
|
||||
ctx.Set(fiber.HeaderXRequestID, rid)
|
||||
// Continue stack
|
||||
ctx.Next()
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue