CORS Headers

CHANGELOG.md

@@ -1,4 +1,9 @@
 
+#### **2.0.2**
+
+FEATURES:
+ * adding the --enable-cors-global to switch on CORs header injects into every response
+
 #### **2.0.1**
 
 BUGS:

README.md

@@ -441,12 +441,11 @@ You are permitted to add CORS following headers into the /oauth uri namespace
 Either from the config file:
 
 ```YAML
-cors:
-  origins:
-  - '*'
-  methods:
-  - GET
-  - POST
+cors-origins:
+- '*'
+cors-methods:
+- GET
+- POST
 ```
 
 or via the command line arguments

config_sample.yml

@@ -1,5 +1,4 @@
 
-
 # is the url for retrieve the openid configuration - normally the <server>/auth/realm/<realm_name>
 discovery-url: https://keycloak.example.com/auth/realms/commons
 # the client id for the 'client' application
@@ -74,17 +73,17 @@ resources:
       - openvpn:vpn-user
       - openvpn:prod-vpn
 
-# set the cross origin resource sharing headers
-cors:
-  # an array of origins (Access-Control-Allow-Origin)
-  origins: []
-  # an array of headers to apply (Access-Control-Allow-Headers)
-  headers: []
-  # an array of expose headers (Access-Control-Expose-Headers)
-  exposed-headers: []
-  # an array of methods (Access-Control-Allow-Methods)
-  methods: []
-  # the credentials flag (Access-Control-Allow-Credentials)
-  credentials: true|false
-  # the max age (Access-Control-Max-Age)
-  max-age: 1h
+# indicates you want cors headers injects for ALL responses
+enable-cors-global: false
+# an array of origins (Access-Control-Allow-Origin)
+cors-origins: []
+# an array of headers to apply (Access-Control-Allow-Headers)
+cors-headers: []
+# an array of expose headers (Access-Control-Expose-Headers)
+cors-exposed-headers: []
+# an array of methods (Access-Control-Allow-Methods)
+cors-methods: []
+# the credentials flag (Access-Control-Allow-Credentials)
+cors-credentials: true|false
+# the max age (Access-Control-Max-Age)
+cors-max-age: 1h

doc.go

@@ -131,6 +131,8 @@ type Config struct {
 	// Headers permits adding customs headers across the board
 	Headers map[string]string `json:"headers" yaml:"headers" usage:"custom headers to the upstream request, key=value"`
 
+	// EnableCorsGlobal enables the CORs header in all response headers
+	EnableCorsGlobal bool `json:"enable-cors-global" yaml:"enable-cors-global" usage:"inject the CORs headers into all responses" env:"ENABLE_CORS_GLOBAL"`
 	// EnableForwarding enables the forwarding proxy
 	EnableForwarding bool `json:"enable-forwarding" yaml:"enable-forwarding" usage:"enables the forwarding proxy mode, signing outbound request"`
 	// EnableSecurityFilter enabled the security handler

middleware.go

@@ -366,26 +366,24 @@ func (r *oauthProxy) admissionMiddleware() gin.HandlerFunc {
 	}
 }
 
-//
 // corsMiddleware injects the CORS headers, if set, for request made to /oauth
-//
 func (r *oauthProxy) corsMiddleware(c Cors) gin.HandlerFunc {
 	return func(cx *gin.Context) {
 		if len(c.Origins) > 0 {
 			cx.Writer.Header().Set("Access-Control-Allow-Origin", strings.Join(c.Origins, ","))
 		}
+		if c.Credentials {
+			cx.Writer.Header().Set("Access-Control-Allow-Credentials", "true")
+		}
+		if len(c.ExposedHeaders) > 0 {
+			cx.Writer.Header().Set("Access-Control-Expose-Headers", strings.Join(c.ExposedHeaders, ","))
+		}
 		if len(c.Methods) > 0 {
 			cx.Writer.Header().Set("Access-Control-Allow-Methods", strings.Join(c.Methods, ","))
 		}
 		if len(c.Headers) > 0 {
 			cx.Writer.Header().Set("Access-Control-Allow-Headers", strings.Join(c.Headers, ","))
 		}
-		if len(c.ExposedHeaders) > 0 {
-			cx.Writer.Header().Set("Access-Control-Expose-Headers", strings.Join(c.ExposedHeaders, ","))
-		}
-		if c.Credentials {
-			cx.Writer.Header().Set("Access-Control-Allow-Credentials", "true")
-		}
 		if c.MaxAge > 0 {
 			cx.Writer.Header().Set("Access-Control-Max-Age", fmt.Sprintf("%d", int(c.MaxAge.Seconds())))
 		}

middleware_test.go

@@ -215,10 +215,14 @@ func TestCrossSiteHandler(t *testing.T) {
 	p, _, _ := newTestProxyService(nil)
 
 	cases := []struct {
+		Method  string
+		URI     string
 		Cors    Cors
 		Headers map[string]string
 	}{
 		{
+			Method: http.MethodGet,
+			URI:    "/oauth/test",
 			Cors: Cors{
 				Origins: []string{"*"},
 			},
@@ -227,21 +231,33 @@ func TestCrossSiteHandler(t *testing.T) {
 			},
 		},
 		{
+			Method: http.MethodGet,
+			URI:    "/oauth/test",
 			Cors: Cors{
 				Origins: []string{"*", "https://examples.com"},
-				Methods: []string{"GET"},
+			},
+			Headers: map[string]string{
+				"Access-Control-Allow-Origin": "*,https://examples.com",
+			},
+		},
+		{
+			Method: http.MethodGet,
+			URI:    "/foo",
+			Cors: Cors{
+				Origins: []string{"*", "https://examples.com"},
+				Methods: []string{"GET", "POST"},
 			},
 			Headers: map[string]string{
 				"Access-Control-Allow-Origin":  "*,https://examples.com",
-				"Access-Control-Allow-Methods": "GET",
+				"Access-Control-Allow-Methods": "GET,POST",
 			},
 		},
 	}
 
 	for i, c := range cases {
 		handler := p.corsMiddleware(c.Cors)
 		// call the handler and check the responses
-		context := newFakeGinContext("GET", "/oauth/test")
+		context := newFakeGinContext(c.Method, c.URI)
 		handler(context)
 		// step: check the headers
 		for k, v := range c.Headers {

server.go

@@ -166,16 +166,24 @@ func (r *oauthProxy) createReverseProxy() error {
 	if r.config.EnableSecurityFilter {
 		engine.Use(r.securityMiddleware())
 	}
-
-	// step: add the routing and cors middleware
-	oauth := engine.Group(oauthURL).Use(r.corsMiddleware(Cors{
+	cors := Cors{
 		Origins:        r.config.CorsOrigins,
 		Methods:        r.config.CorsMethods,
 		Headers:        r.config.CorsHeaders,
 		ExposedHeaders: r.config.CorsExposedHeaders,
 		Credentials:    r.config.CorsCredentials,
 		MaxAge:         r.config.CorsMaxAge,
-	}))
+	}
+	// step: enabling globaling?
+	if r.config.EnableCorsGlobal {
+		log.Info("enabling CORs header injection globally")
+		engine.Use(r.corsMiddleware(cors))
+	}
+	// step: add the routing and cors middleware
+	oauth := engine.Group(oauthURL)
+	if !r.config.EnableCorsGlobal {
+		oauth.Use(r.corsMiddleware(cors))
+	}
 	oauth.GET(authorizationURL, r.oauthAuthorizationHandler)
 	oauth.GET(callbackURL, r.oauthCallbackHandler)
 	oauth.GET(healthURL, r.healthHandler)