CORS: add AllowCredentials

With this change, setting CORS.AllowCredentials will
permit set the "Access-Control-Allow-Credentials" header
which when combined with a client XHR's withCredentials
allows cookies to be used in subsequent Ajax requests.

Fixes orijtech#16

cors_test.go

@@ -0,0 +1,57 @@
+package otils
+
+import (
+	"encoding/json"
+	"net/http"
+	"net/http/httptest"
+	"reflect"
+	"testing"
+)
+
+func TestCORSHeader(t *testing.T) {
+	tests := []struct {
+		name string
+		cors *CORS
+		want http.Header
+	}{
+		{
+			name: "with allowCredentials",
+			cors: &CORS{
+				AllowCredentials: true,
+			},
+			want: http.Header{
+				"Access-Control-Allow-Credentials": {"true"},
+			},
+		},
+		{
+			name: "all enabled",
+			cors: CORSMiddlewareAllInclusive(nil).(*CORS),
+			want: http.Header{
+				"Access-Control-Allow-Credentials": {"true"},
+				"Access-Control-Allow-Headers":     {"*"},
+				"Access-Control-Allow-Methods":     {"*"},
+				"Access-Control-Allow-Origin":      {"*"},
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			rec := httptest.NewRecorder()
+			tt.cors.setCORSForResponseWriter(rec)
+			res := rec.Result()
+			got := res.Header
+			if !reflect.DeepEqual(got, tt.want) {
+				t.Fatalf("Mismatched end headers\nGot:  %s\nWant: %s", asJSON(got), asJSON(tt.want))
+			}
+		})
+	}
+}
+
+func asJSON(v interface{}) []byte {
+	blob, err := json.MarshalIndent(v, "", "  ")
+	if err != nil {
+		panic(err)
+	}
+	return blob
+}

otils.go

@@ -448,6 +448,12 @@ type CORS struct {
 	Methods []string
 	Headers []string
 
+	// AllowCredentials when set signifies that the header
+	// "Access-Control-Allow-Credentials" which will allow
+	// the possibility of the frontend XHR's withCredentials=true
+	// to be set.
+	AllowCredentials bool
+
 	next http.Handler
 }
 
@@ -465,13 +471,16 @@ var allInclusiveCORS = &CORS{
 	Origins: []string{"*"},
 	Methods: []string{"*"},
 	Headers: []string{"*"},
+
+	AllowCredentials: true,
 }
 
 // CORSMiddlewareAllInclusive is a convenience helper that uses the
 // all inclusive CORS:
 // Access-Control-Allow-Origin: *
 // Access-Control-Allow-Methods: *
 // Access-Control-Allow-Headers: *
+// Access-Control-Allow-Credentials: *
 // thus enabling all origins, all methods and all headers.
 func CORSMiddlewareAllInclusive(next http.Handler) http.Handler {
 	return CORSMiddleware(allInclusiveCORS, next)
@@ -496,6 +505,9 @@ func (c *CORS) setCORSForResponseWriter(rw http.ResponseWriter) {
 	for _, hdr := range c.Headers {
 		rw.Header().Add("Access-Control-Allow-Headers", hdr)
 	}
+	if c.AllowCredentials {
+		rw.Header().Add("Access-Control-Allow-Credentials", "true")
+	}
 }
 
 func EnvOrAlternates(envVar string, alternates ...string) string {