cors

Documentation

Overview

Package cors does cors stuff

Index

• Variables
• func New(allowedOrigins []string) echo.MiddlewareFunc
• func NewWithConfig(config Config) (echo.MiddlewareFunc, error)
• func Validate(origins []string) error
• type Config
• type ValidationError
  • func (e *ValidationError) Error() string

Variables

var DefaultConfig = Config{
	Skipper:  middleware.DefaultSkipper,
	Prefixes: nil,
}

DefaultConfig creates a default config

var DefaultSchemas = []string{
	"http://",
	"https://",
}

DefaultSchemas is a list of default allowed schemas for CORS origins

Functions

func New

func New(allowedOrigins []string) echo.MiddlewareFunc

New creates a new middleware function with the default config

func NewWithConfig

func NewWithConfig(config Config) (echo.MiddlewareFunc, error)

NewWithConfig creates a new middleware function with the provided config

func Validate

func Validate(origins []string) error

Validate checks a list of origins to see if they comply with the allowed origins

Types

type Config

type Config struct {
	// Enable or disable the CORS middleware
	Enabled bool               `json:"enabled" koanf:"enabled" default:"true"`
	Skipper middleware.Skipper `json:"-" koanf:"-"`
	// Prefixes is a map of prefixes to allowed origins
	Prefixes map[string][]string `json:"prefixes" koanf:"prefixes"`
	// AllowOrigins is a list of allowed origins
	AllowOrigins []string `json:"allowOrigins" koanf:"allowOrigins"`
	// CookieInsecure sets the cookie to be insecure
	CookieInsecure bool `json:"cookieInsecure" koanf:"cookieInsecure"`
}

Config holds the cors configuration settings

type ValidationError

type ValidationError struct {
	Validation string
	Allowed    string
}

ValidationError is returned when the origins do not pass validation

func (*ValidationError) Error

func (e *ValidationError) Error() string

Error returns the ValidationError in string format