corser

README

CORS-er

CORS (Cross-Origin Resource Sharing) handler configurator based on config settings.

How to install?

Simply type in

go get github.com/zspkg/corser

Documentation

Index

• Constants
• type CorsOptions
• type Corser
  • func NewCorser(getter kv.Getter, configKey string) Corser

Constants

const DefaultConfigKey = "cors_options"

Types

type CorsOptions

type CorsOptions struct {
	// AllowedOrigins is a list of origins a cross-domain request can be executed from.
	// If the special "*" value is present in the list, all origins will be allowed.
	// An origin may contain a wildcard (*) to replace 0 or more characters
	// (i.e.: http://*.domain.com). Usage of wildcards implies a small performance penalty.
	// Only one wildcard can be used per origin.
	// Default value is ["*"]
	AllowedOrigins []string `fig:"allowed_origins"`

	// AllowedMethods is a list of methods the client is allowed to use with
	// cross-domain requests. Default value is simple methods (HEAD, GET and POST).
	AllowedMethods []string `fig:"allowed_methods"`

	// AllowedHeaders is list of non-simple headers the client is allowed to use with
	// cross-domain requests.
	// If the special "*" value is present in the list, all headers will be allowed.
	// Default value is [] but "Origin" is always appended to the list.
	AllowedHeaders []string `fig:"allowed_headers"`

	// ExposedHeaders indicates which headers are safe to expose to the API of a CORS
	// API specification
	ExposedHeaders []string `fig:"exposed_headers"`

	// AllowCredentials indicates whether the request can include user credentials like
	// cookies, HTTP authentication or client side SSL certificates.
	AllowCredentials bool `fig:"allow_credentials"`

	// MaxAge indicates how long (in seconds) the results of a preflight request
	// can be cached
	MaxAge int `fig:"max_age"`

	// OptionsPassthrough instructs preflight to let other potential next handlers to
	// process the OPTIONS method. Turn this on if your application handles OPTIONS.
	OptionsPassthrough bool `fig:"options_passthrough"`

	// Debugging flag adds additional output to debug server side CORS issues
	Debug bool `fig:"debug"`
}

CorsSettings defines a set of options to allow cors requests

type Corser

type Corser interface {
	// CorsOptions returns cors options from config file.
	// If config file is empty, default options will be returned.
	CorsOptions() cors.Options
	// CorsHandler returns cors handler based on configured cors options
	CorsHandler() func(next http.Handler) http.Handler
}

Corser is an interface for cors configuration

func NewCorser

func NewCorser(getter kv.Getter, configKey string) Corser

NewCorser creates a new instance of Corser.

• getter - config getter
• configKey - key in config file to get cors options from