middleware

Jul 14, 2023

Changes in this version

type GzipConfig

+ MinLength int

type ProxyConfig

+ ErrorHandler func(c echo.Context, err error) error

+ RetryCount int

+ RetryFilter func(c echo.Context, e error) bool

type RecoverConfig

+ DisableErrorHandler bool

Feb 21, 2023

Changes in this version

type CORSConfig

+ UnsafeWildcardOriginWithAllowCredentials bool

Feb 19, 2023

Changes in this version

+ func ContextTimeout(timeout time.Duration) echo.MiddlewareFunc

+ func ContextTimeoutWithConfig(config ContextTimeoutConfig) echo.MiddlewareFunc

+ type ContextTimeoutConfig struct

+ ErrorHandler func(err error, c echo.Context) error

+ Skipper Skipper

+ Timeout time.Duration

+ func (config ContextTimeoutConfig) ToMiddleware() (echo.MiddlewareFunc, error)

Dec 27, 2022

Changes in this version

type LoggerConfig

+ CustomTagFunc func(c echo.Context, buf *bytes.Buffer) (int, error)

type RequestLoggerConfig

+ HandleError bool

+ type TargetProvider interface

+ NextTarget func(echo.Context) (*ProxyTarget, error)

type ValuesExtractor

+ func CreateExtractors(lookups string) ([]ValuesExtractor, error)

Sep 4, 2022

Changes in this version

type CSRFConfig

+ ErrorHandler CSRFErrorHandler

+ type CSRFErrorHandler func(err error, c echo.Context) error

Aug 10, 2022 GO-2022-1031

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Mar 16, 2022 GO-2022-1031

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Changes in this version

type TimeoutConfig

+ func (config TimeoutConfig) ToMiddleware() (echo.MiddlewareFunc, error)

Mar 13, 2022 GO-2022-1031

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Mar 2, 2022 GO-2022-1031

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Changes in this version

+ var ErrCSRFInvalid = echo.NewHTTPError(http.StatusForbidden, "invalid csrf token")

+ type ErrKeyAuthMissing struct

+ Err error

+ func (e *ErrKeyAuthMissing) Error() string

+ func (e *ErrKeyAuthMissing) Unwrap() error

type JWTConfig

+ ContinueOnIgnoredError bool

+ TokenLookupFuncs []ValuesExtractor

type KeyAuthConfig

+ ContinueOnIgnoredError bool

+ type LogErrorFunc func(c echo.Context, err error, stack []byte) error

type RecoverConfig

+ LogErrorFunc LogErrorFunc

+ type ValuesExtractor func(c echo.Context) ([]string, error)

Jan 10, 2022 GO-2022-1031

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Dec 17, 2021 GO-2022-1031

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Changes in this version

type RequestIDConfig

+ TargetHeader string

Sep 26, 2021 GO-2022-1031

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Changes in this version

type RequestLoggerValues

+ StartTime time.Time

Sep 20, 2021 GO-2022-1031

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Changes in this version

+ func RequestLoggerWithConfig(config RequestLoggerConfig) echo.MiddlewareFunc

+ type RequestLoggerConfig struct

+ BeforeNextFunc func(c echo.Context)

+ LogContentLength bool

+ LogError bool

+ LogFormValues []string

+ LogHeaders []string

+ LogHost bool

+ LogLatency bool

+ LogMethod bool

+ LogProtocol bool

+ LogQueryParams []string

+ LogReferer bool

+ LogRemoteIP bool

+ LogRequestID bool

+ LogResponseSize bool

+ LogRoutePath bool

+ LogStatus bool

+ LogURI bool

+ LogURIPath bool

+ LogUserAgent bool

+ LogValuesFunc func(c echo.Context, v RequestLoggerValues) error

+ Skipper Skipper

+ func (config RequestLoggerConfig) ToMiddleware() (echo.MiddlewareFunc, error)

+ type RequestLoggerValues struct

+ ContentLength string

+ Error error

+ FormValues map[string][]string

+ Headers map[string][]string

+ Host string

+ Latency time.Duration

+ Method string

+ Protocol string

+ QueryParams map[string][]string

+ Referer string

+ RemoteIP string

+ RequestID string

+ ResponseSize int64

+ RoutePath string

+ Status int

+ URI string

+ URIPath string

+ UserAgent string

Aug 1, 2021 GO-2022-1031

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Jul 12, 2021 GO-2022-1031

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Changes in this version

type JWTConfig

+ ParseTokenFunc func(auth string, c echo.Context) (interface{}, error)

type RequestIDConfig

+ RequestIDHandler func(echo.Context, string)

May 8, 2021 GO-2022-1031

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Changes in this version

type JWTConfig

+ KeyFunc jwt.Keyfunc

type KeyAuthConfig

+ ErrorHandler KeyAuthErrorHandler

+ type KeyAuthErrorHandler func(error, echo.Context) error

type StaticConfig

+ Filesystem http.FileSystem

Apr 7, 2021 GO-2022-1031

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Mar 8, 2021 GO-2022-1031

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Changes in this version

+ const StatusCodeContextCanceled

type TimeoutConfig

+ ErrorMessage string

+ OnTimeoutRouteErrorHandler func(err error, c echo.Context)

Feb 11, 2021 GO-2022-1031

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Changes in this version

+ const GZIPEncoding

+ const SameSiteNoneMode

+ var DefaultDecompressConfig = DecompressConfig

+ var DefaultRateLimiterConfig = RateLimiterConfig

+ var DefaultRateLimiterMemoryStoreConfig = RateLimiterMemoryStoreConfig

+ var DefaultTimeoutConfig = TimeoutConfig

+ var ErrExtractorError = echo.NewHTTPError(http.StatusForbidden, "error while extracting identifier")

+ var ErrJWTInvalid = echo.NewHTTPError(http.StatusUnauthorized, "invalid or expired jwt")

+ var ErrRateLimitExceeded = echo.NewHTTPError(http.StatusTooManyRequests, "rate limit exceeded")

+ func Decompress() echo.MiddlewareFunc

+ func DecompressWithConfig(config DecompressConfig) echo.MiddlewareFunc

+ func RateLimiter(store RateLimiterStore) echo.MiddlewareFunc

+ func RateLimiterWithConfig(config RateLimiterConfig) echo.MiddlewareFunc

+ func Timeout() echo.MiddlewareFunc

+ func TimeoutWithConfig(config TimeoutConfig) echo.MiddlewareFunc

type CORSConfig

+ AllowOriginFunc func(origin string) (bool, error)

type CSRFConfig

+ CookieSameSite http.SameSite

+ type DecompressConfig struct

+ GzipDecompressPool Decompressor

+ Skipper Skipper

+ type Decompressor interface

+ type DefaultGzipDecompressPool struct

+ type Extractor func(context echo.Context) (string, error)

type ProxyConfig

+ RegexRewrite map[*regexp.Regexp]string

+ type RateLimiterConfig struct

+ BeforeFunc BeforeFunc

+ DenyHandler func(context echo.Context, identifier string, err error) error

+ ErrorHandler func(context echo.Context, err error) error

+ IdentifierExtractor Extractor

+ Skipper Skipper

+ Store RateLimiterStore

+ type RateLimiterMemoryStore struct

+ func NewRateLimiterMemoryStore(rate rate.Limit) (store *RateLimiterMemoryStore)

+ func NewRateLimiterMemoryStoreWithConfig(config RateLimiterMemoryStoreConfig) (store *RateLimiterMemoryStore)

+ func (store *RateLimiterMemoryStore) Allow(identifier string) (bool, error)

+ type RateLimiterMemoryStoreConfig struct

+ Burst int

+ ExpiresIn time.Duration

+ Rate rate.Limit

+ type RateLimiterStore interface

+ Allow func(identifier string) (bool, error)

type RewriteConfig

+ RegexRules map[*regexp.Regexp]string

type StaticConfig

+ IgnoreBase bool

+ type TimeoutConfig struct

+ ErrorHandler TimeoutErrorHandlerWithContext

+ Skipper Skipper

+ Timeout time.Duration

+ type TimeoutErrorHandlerWithContext func(error, echo.Context) error

+ type Visitor struct

Aug 28, 2020 GO-2021-0051 +1 more

  GO-2021-0051: Directory traversal on Windows in github.com/labstack/echo/v4

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Changes in this version

type ProxyConfig

+ ModifyResponse func(*http.Response) error

type RecoverConfig

+ LogLevel log.Lvl

Mar 30, 2020 GO-2021-0051 +1 more

  GO-2021-0051: Directory traversal on Windows in github.com/labstack/echo/v4

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Feb 29, 2020 GO-2021-0051 +1 more

  GO-2021-0051: Directory traversal on Windows in github.com/labstack/echo/v4

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Jan 24, 2020 GO-2021-0051 +1 more

  GO-2021-0051: Directory traversal on Windows in github.com/labstack/echo/v4

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Jan 1, 2020 GO-2021-0051 +1 more

  GO-2021-0051: Directory traversal on Windows in github.com/labstack/echo/v4

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Dec 30, 2019 GO-2021-0051 +1 more

  GO-2021-0051: Directory traversal on Windows in github.com/labstack/echo/v4

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Oct 7, 2019 GO-2021-0051 +1 more

  GO-2021-0051: Directory traversal on Windows in github.com/labstack/echo/v4

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Aug 17, 2019 GO-2021-0051 +1 more

  GO-2021-0051: Directory traversal on Windows in github.com/labstack/echo/v4

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Aug 11, 2019 GO-2021-0051 +1 more

  GO-2021-0051: Directory traversal on Windows in github.com/labstack/echo/v4

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Aug 5, 2019 GO-2021-0051 +1 more

  GO-2021-0051: Directory traversal on Windows in github.com/labstack/echo/v4

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Aug 2, 2019 GO-2021-0051 +1 more

  GO-2021-0051: Directory traversal on Windows in github.com/labstack/echo/v4

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Changes in this version

type JWTConfig

+ ErrorHandlerWithContext JWTErrorHandlerWithContext

+ type JWTErrorHandlerWithContext func(error, echo.Context) error

type SecureConfig

+ ReferrerPolicy string

Jun 9, 2019 GO-2021-0051 +1 more

  GO-2021-0051: Directory traversal on Windows in github.com/labstack/echo/v4

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Changes in this version

type JWTConfig

+ SigningKeys map[string]interface{}

Apr 30, 2019 GO-2021-0051 +1 more

  GO-2021-0051: Directory traversal on Windows in github.com/labstack/echo/v4

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Apr 29, 2019 GO-2021-0051 +1 more

  GO-2021-0051: Directory traversal on Windows in github.com/labstack/echo/v4

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Apr 29, 2019 GO-2021-0051 +1 more

  GO-2021-0051: Directory traversal on Windows in github.com/labstack/echo/v4

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Apr 29, 2019 GO-2021-0051 +1 more

  GO-2021-0051: Directory traversal on Windows in github.com/labstack/echo/v4

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Apr 29, 2019 GO-2021-0051 +1 more

  GO-2021-0051: Directory traversal on Windows in github.com/labstack/echo/v4

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Apr 29, 2019 GO-2021-0051 +1 more

  GO-2021-0051: Directory traversal on Windows in github.com/labstack/echo/v4

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Changes in this version

type SecureConfig

+ CSPReportOnly bool

+ HSTSPreloadEnabled bool

Jan 30, 2019 GO-2021-0051 +1 more

  GO-2021-0051: Directory traversal on Windows in github.com/labstack/echo/v4

  GO-2022-1031: Open redirect in github.com/labstack/echo/v4

Changes in this version

+ const AlgorithmHS256

+ var DefaultBasicAuthConfig = BasicAuthConfig

+ var DefaultBodyDumpConfig = BodyDumpConfig

+ var DefaultBodyLimitConfig = BodyLimitConfig

+ var DefaultCORSConfig = CORSConfig

+ var DefaultCSRFConfig = CSRFConfig

+ var DefaultGzipConfig = GzipConfig

+ var DefaultJWTConfig = JWTConfig

+ var DefaultKeyAuthConfig = KeyAuthConfig

+ var DefaultLoggerConfig = LoggerConfig

+ var DefaultMethodOverrideConfig = MethodOverrideConfig

+ var DefaultProxyConfig = ProxyConfig

+ var DefaultRecoverConfig = RecoverConfig

+ var DefaultRedirectConfig = RedirectConfig

+ var DefaultRequestIDConfig = RequestIDConfig

+ var DefaultRewriteConfig = RewriteConfig

+ var DefaultSecureConfig = SecureConfig

+ var DefaultStaticConfig = StaticConfig

+ var DefaultTrailingSlashConfig = TrailingSlashConfig

+ var ErrJWTMissing = echo.NewHTTPError(http.StatusBadRequest, "missing or malformed jwt")

+ func AddTrailingSlash() echo.MiddlewareFunc

+ func AddTrailingSlashWithConfig(config TrailingSlashConfig) echo.MiddlewareFunc

+ func BasicAuth(fn BasicAuthValidator) echo.MiddlewareFunc

+ func BasicAuthWithConfig(config BasicAuthConfig) echo.MiddlewareFunc

+ func BodyDump(handler BodyDumpHandler) echo.MiddlewareFunc

+ func BodyDumpWithConfig(config BodyDumpConfig) echo.MiddlewareFunc

+ func BodyLimit(limit string) echo.MiddlewareFunc

+ func BodyLimitWithConfig(config BodyLimitConfig) echo.MiddlewareFunc

+ func CORS() echo.MiddlewareFunc

+ func CORSWithConfig(config CORSConfig) echo.MiddlewareFunc

+ func CSRF() echo.MiddlewareFunc

+ func CSRFWithConfig(config CSRFConfig) echo.MiddlewareFunc

+ func DefaultSkipper(echo.Context) bool

+ func Gzip() echo.MiddlewareFunc

+ func GzipWithConfig(config GzipConfig) echo.MiddlewareFunc

+ func HTTPSNonWWWRedirect() echo.MiddlewareFunc

+ func HTTPSNonWWWRedirectWithConfig(config RedirectConfig) echo.MiddlewareFunc

+ func HTTPSRedirect() echo.MiddlewareFunc

+ func HTTPSRedirectWithConfig(config RedirectConfig) echo.MiddlewareFunc

+ func HTTPSWWWRedirect() echo.MiddlewareFunc

+ func HTTPSWWWRedirectWithConfig(config RedirectConfig) echo.MiddlewareFunc

+ func JWT(key interface{}) echo.MiddlewareFunc

+ func JWTWithConfig(config JWTConfig) echo.MiddlewareFunc

+ func KeyAuth(fn KeyAuthValidator) echo.MiddlewareFunc

+ func KeyAuthWithConfig(config KeyAuthConfig) echo.MiddlewareFunc

+ func Logger() echo.MiddlewareFunc

+ func LoggerWithConfig(config LoggerConfig) echo.MiddlewareFunc

+ func MethodOverride() echo.MiddlewareFunc

+ func MethodOverrideWithConfig(config MethodOverrideConfig) echo.MiddlewareFunc

+ func NonWWWRedirect() echo.MiddlewareFunc

+ func NonWWWRedirectWithConfig(config RedirectConfig) echo.MiddlewareFunc

+ func Proxy(balancer ProxyBalancer) echo.MiddlewareFunc

+ func ProxyWithConfig(config ProxyConfig) echo.MiddlewareFunc

+ func Recover() echo.MiddlewareFunc

+ func RecoverWithConfig(config RecoverConfig) echo.MiddlewareFunc

+ func RemoveTrailingSlash() echo.MiddlewareFunc

+ func RemoveTrailingSlashWithConfig(config TrailingSlashConfig) echo.MiddlewareFunc

+ func RequestID() echo.MiddlewareFunc

+ func RequestIDWithConfig(config RequestIDConfig) echo.MiddlewareFunc

+ func Rewrite(rules map[string]string) echo.MiddlewareFunc

+ func RewriteWithConfig(config RewriteConfig) echo.MiddlewareFunc

+ func Secure() echo.MiddlewareFunc

+ func SecureWithConfig(config SecureConfig) echo.MiddlewareFunc

+ func Static(root string) echo.MiddlewareFunc

+ func StaticWithConfig(config StaticConfig) echo.MiddlewareFunc

+ func WWWRedirect() echo.MiddlewareFunc

+ func WWWRedirectWithConfig(config RedirectConfig) echo.MiddlewareFunc

+ type BasicAuthConfig struct

+ Realm string

+ Skipper Skipper

+ Validator BasicAuthValidator

+ type BasicAuthValidator func(string, string, echo.Context) (bool, error)

+ type BeforeFunc func(echo.Context)

+ type BodyDumpConfig struct

+ Handler BodyDumpHandler

+ Skipper Skipper

+ type BodyDumpHandler func(echo.Context, []byte, []byte)

+ type BodyLimitConfig struct

+ Limit string

+ Skipper Skipper

+ type CORSConfig struct

+ AllowCredentials bool

+ AllowHeaders []string

+ AllowMethods []string

+ AllowOrigins []string

+ ExposeHeaders []string

+ MaxAge int

+ Skipper Skipper

+ type CSRFConfig struct

+ ContextKey string

+ CookieDomain string

+ CookieHTTPOnly bool

+ CookieMaxAge int

+ CookieName string

+ CookiePath string

+ CookieSecure bool

+ Skipper Skipper

+ TokenLength uint8

+ TokenLookup string

+ type GzipConfig struct

+ Level int

+ Skipper Skipper

+ type JWTConfig struct

+ AuthScheme string

+ BeforeFunc BeforeFunc

+ Claims jwt.Claims

+ ContextKey string

+ ErrorHandler JWTErrorHandler

+ SigningKey interface{}

+ SigningMethod string

+ Skipper Skipper

+ SuccessHandler JWTSuccessHandler

+ TokenLookup string

+ type JWTErrorHandler func(error) error

+ type JWTSuccessHandler func(echo.Context)

+ type KeyAuthConfig struct

+ AuthScheme string

+ KeyLookup string

+ Skipper Skipper

+ Validator KeyAuthValidator

+ type KeyAuthValidator func(string, echo.Context) (bool, error)

+ type LoggerConfig struct

+ CustomTimeFormat string

+ Format string

+ Output io.Writer

+ Skipper Skipper

+ type MethodOverrideConfig struct

+ Getter MethodOverrideGetter

+ Skipper Skipper

+ type MethodOverrideGetter func(echo.Context) string

+ func MethodFromForm(param string) MethodOverrideGetter

+ func MethodFromHeader(header string) MethodOverrideGetter

+ func MethodFromQuery(param string) MethodOverrideGetter

+ type ProxyBalancer interface

+ AddTarget func(*ProxyTarget) bool

+ Next func(echo.Context) *ProxyTarget

+ RemoveTarget func(string) bool

+ func NewRandomBalancer(targets []*ProxyTarget) ProxyBalancer

+ func NewRoundRobinBalancer(targets []*ProxyTarget) ProxyBalancer

+ type ProxyConfig struct

+ Balancer ProxyBalancer

+ ContextKey string

+ Rewrite map[string]string

+ Skipper Skipper

+ Transport http.RoundTripper

+ type ProxyTarget struct

+ Meta echo.Map

+ Name string

+ URL *url.URL

+ type RecoverConfig struct

+ DisablePrintStack bool

+ DisableStackAll bool

+ Skipper Skipper

+ StackSize int

+ type RedirectConfig struct

+ Code int

+ type RequestIDConfig struct

+ Generator func() string

+ Skipper Skipper

+ type RewriteConfig struct

+ Rules map[string]string

+ Skipper Skipper

+ type SecureConfig struct

+ ContentSecurityPolicy string

+ ContentTypeNosniff string

+ HSTSExcludeSubdomains bool

+ HSTSMaxAge int

+ Skipper Skipper

+ XFrameOptions string

+ XSSProtection string

+ type Skipper func(echo.Context) bool

+ type StaticConfig struct

+ Browse bool

+ HTML5 bool

+ Index string

+ Root string

+ Skipper Skipper

+ type TrailingSlashConfig struct

+ RedirectCode int

+ Skipper Skipper