// Copyright GoFrame Author(https://goframe.org). All Rights Reserved. // // This Source Code Form is subject to the terms of the MIT License. // If a copy of the MIT was not distributed with this file, // You can obtain one at https://github.com/gogf/gf. // package ghttp import ( "net/http" "net/url" "github.com/gogf/gf/v2/errors/gcode" "github.com/gogf/gf/v2/errors/gerror" "github.com/gogf/gf/v2/text/gstr" "github.com/gogf/gf/v2/util/gconv" ) // CORSOptions is the options for CORS feature. // See https://www.w3.org/TR/cors/ . type CORSOptions struct { AllowDomain []string // Used for allowing requests from custom domains AllowOrigin string // Access-Control-Allow-Origin AllowCredentials string // Access-Control-Allow-Credentials ExposeHeaders string // Access-Control-Expose-Headers MaxAge int // Access-Control-Max-Age AllowMethods string // Access-Control-Allow-Methods AllowHeaders string // Access-Control-Allow-Headers } var ( // defaultAllowHeaders is the default allowed headers for CORS. // It's defined another map for better header key searching performance. defaultAllowHeaders = "Origin,Content-Type,Accept,User-Agent,Cookie,Authorization,X-Auth-Token,X-Requested-With" defaultAllowHeadersMap = make(map[string]struct{}) ) func init() { array := gstr.SplitAndTrim(defaultAllowHeaders, ",") for _, header := range array { defaultAllowHeadersMap[header] = struct{}{} } } // DefaultCORSOptions returns the default CORS options, // which allows any cross-domain request. func (r *Response) DefaultCORSOptions() CORSOptions { options := CORSOptions{ AllowOrigin: "*", AllowMethods: supportedHttpMethods, AllowCredentials: "true", AllowHeaders: defaultAllowHeaders, MaxAge: 3628800, } // Allow all client's custom headers in default. if headers := r.Request.Header.Get("Access-Control-Request-Headers"); headers != "" { array := gstr.SplitAndTrim(headers, ",") for _, header := range array { if _, ok := defaultAllowHeadersMap[header]; !ok { options.AllowHeaders += "," + header } } } // Allow all anywhere origin in default. if origin := r.Request.Header.Get("Origin"); origin != "" { options.AllowOrigin = origin } else if referer := r.Request.Referer(); referer != "" { if p := gstr.PosR(referer, "/", 6); p != -1 { options.AllowOrigin = referer[:p] } else { options.AllowOrigin = referer } } return options } // CORS sets custom CORS options. // See https://www.w3.org/TR/cors/ . func (r *Response) CORS(options CORSOptions) { if r.CORSAllowedOrigin(options) { r.Header().Set("Access-Control-Allow-Origin", options.AllowOrigin) } if options.AllowCredentials != "" { r.Header().Set("Access-Control-Allow-Credentials", options.AllowCredentials) } if options.ExposeHeaders != "" { r.Header().Set("Access-Control-Expose-Headers", options.ExposeHeaders) } if options.MaxAge != 0 { r.Header().Set("Access-Control-Max-Age", gconv.String(options.MaxAge)) } if options.AllowMethods != "" { r.Header().Set("Access-Control-Allow-Methods", options.AllowMethods) } if options.AllowHeaders != "" { r.Header().Set("Access-Control-Allow-Headers", options.AllowHeaders) } // No continue service handling if it's OPTIONS request. // Note that there's special checks in previous router searching, // so if it goes to here it means there's already serving handler exist. if gstr.Equal(r.Request.Method, "OPTIONS") { if r.Status == 0 { r.Status = http.StatusOK } // No continue serving. r.Request.ExitAll() } } // CORSAllowedOrigin CORSAllowed checks whether the current request origin is allowed cross-domain. func (r *Response) CORSAllowedOrigin(options CORSOptions) bool { if options.AllowDomain == nil { return true } origin := r.Request.Header.Get("Origin") if origin == "" { return true } parsed, err := url.Parse(origin) if err != nil { err = gerror.WrapCodef(gcode.CodeInvalidParameter, err, `url.Parse failed for URL "%s"`, origin) return false } for _, v := range options.AllowDomain { if gstr.IsSubDomain(parsed.Host, v) { return true } } return false } // CORSDefault sets CORS with default CORS options, // which allows any cross-domain request. func (r *Response) CORSDefault() { r.CORS(r.DefaultCORSOptions()) }