cors

Documentation

Index

• Variables
• func New(opts ...Option) (echo.MiddlewareFunc, error)
• type Option
  • func Credentials() Option
  • func Headers(list ...string) Option
  • func MaxAge(age int) Option
  • func Methods(methods ...string) Option
  • func OriginFunc(f func(origin string) (bool, error)) Option
  • func Origins(list ...string) Option
  • func Skipper(skipper middleware.Skipper) Option

Variables

var (
	ErrHasQuery          = errors.New("includes query")
	ErrMissingScheme     = errors.New("missing scheme")
	ErrHasPath           = errors.New("has path")
	ErrInvalidHeader     = errors.New("invalid headers")
	ErrOriginFuncDefined = errors.New("cors.OriginFunc has been used")
	ErrOriginsDefined    = errors.New("cores.Origins has been users")
	ErrInvalidAge        = errors.New("max age can not be negative")

	AcceptableHeaders = []string{
		echo.HeaderAccept,
		echo.HeaderAcceptEncoding,
		echo.HeaderAllow,
		echo.HeaderAuthorization,
		echo.HeaderContentDisposition,
		echo.HeaderContentEncoding,
		echo.HeaderContentLength,
		echo.HeaderContentType,
		echo.HeaderCookie,
		echo.HeaderSetCookie,
		echo.HeaderIfModifiedSince,
		echo.HeaderLastModified,
		echo.HeaderLocation,
		echo.HeaderRetryAfter,
		echo.HeaderUpgrade,
		echo.HeaderVary,
		echo.HeaderWWWAuthenticate,
		echo.HeaderXForwardedFor,
		echo.HeaderXForwardedProto,
		echo.HeaderXForwardedProtocol,
		echo.HeaderXForwardedSsl,
		echo.HeaderXUrlScheme,
		echo.HeaderXHTTPMethodOverride,
		echo.HeaderXRealIP,
		echo.HeaderXRequestID,
		echo.HeaderXCorrelationID,
		echo.HeaderXRequestedWith,
		echo.HeaderServer,
		echo.HeaderOrigin,
		echo.HeaderCacheControl,
		echo.HeaderConnection,
		echo.HeaderAccessControlRequestMethod,
		echo.HeaderAccessControlRequestHeaders,
		echo.HeaderAccessControlAllowOrigin,
		echo.HeaderAccessControlAllowMethods,
		echo.HeaderAccessControlAllowHeaders,
		echo.HeaderAccessControlAllowCredentials,
		echo.HeaderAccessControlExposeHeaders,
		echo.HeaderAccessControlMaxAge,
		echo.HeaderStrictTransportSecurity,
		echo.HeaderXContentTypeOptions,
		echo.HeaderXXSSProtection,
		echo.HeaderXFrameOptions,
		echo.HeaderContentSecurityPolicy,
		echo.HeaderContentSecurityPolicyReportOnly,
		echo.HeaderXCSRFToken,
		echo.HeaderReferrerPolicy,
	}
)

Functions

func New

func New(opts ...Option) (echo.MiddlewareFunc, error)

Types

type Option

type Option interface {
	// contains filtered or unexported methods
}

func Credentials

func Credentials() Option

Credentials allows for credentials to be used.

func Headers

func Headers(list ...string) Option

Headers is used to give the headers that are allowed, others are not allowed.

func MaxAge

func MaxAge(age int) Option

func Methods

func Methods(methods ...string) Option

Methods allows for certain methods to be allowed by the CORS middleware.

func OriginFunc

func OriginFunc(f func(origin string) (bool, error)) Option

OriginFunc allows for a function that checks the origin to be used by the CORS middleware.

func Origins

func Origins(list ...string) Option

func Skipper

func Skipper(skipper middleware.Skipper) Option