cors

Documentation

Overview

Package cors provides handlers to enable CORS support. Usage

import (
	"github.com/beego/beego/v2"
	"github.com/beego/beego/v2/server/web/filter/cors"

)

func main() {
	// CORS for https://foo.* origins, allowing:
	// - PUT and PATCH methods
	// - Origin header
	// - Credentials share
	beego.InsertFilter("*", beego.BeforeRouter, cors.Allow(&cors.Options{
		AllowOrigins:     []string{"https://*.foo.com"},
		AllowMethods:     []string{"PUT", "PATCH"},
		AllowHeaders:     []string{"Origin"},
		ExposeHeaders:    []string{"Content-Length"},
		AllowCredentials: true,
	}))
	beego.Run()
}

Index

• func Allow(opts *Options) beego.FilterFunc
• type Options
  • func (o *Options) Header(origin string) (headers map[string]string)
  • func (o *Options) IsOriginAllowed(origin string) bool
  • func (o *Options) PreflightHeader(origin, rMethod, rHeaders string) (headers map[string]string)

Functions

func Allow

func Allow(opts *Options) beego.FilterFunc

Allow enables CORS for requests those match the provided options.

Types

type Options

type Options cors.Options

Options represents Access Control options.

func (*Options) Header

func (o *Options) Header(origin string) (headers map[string]string)

Header converts options into CORS headers.

func (*Options) IsOriginAllowed

func (o *Options) IsOriginAllowed(origin string) bool

IsOriginAllowed looks up if the origin matches one of the patterns generated from Options.AllowOrigins patterns.

func (*Options) PreflightHeader

func (o *Options) PreflightHeader(origin, rMethod, rHeaders string) (headers map[string]string)

PreflightHeader converts options into CORS headers for a preflight response.