[3.3.0.2 backport] CBG-4964 create cookie with SameSite=None if CORS enabled

auth/session.go

@@ -135,7 +135,7 @@ func (auth *Authenticator) GetSession(sessionID string) (*LoginSession, error) {
 	return &session, nil
 }
 
-func (auth *Authenticator) MakeSessionCookie(session *LoginSession, secureCookie bool, httpOnly bool) *http.Cookie {
+func (auth *Authenticator) MakeSessionCookie(session *LoginSession, secureCookie bool, httpOnly bool, sameSite http.SameSite) *http.Cookie {
 	if session == nil {
 		return nil
 	}
@@ -145,6 +145,8 @@ func (auth *Authenticator) MakeSessionCookie(session *LoginSession, secureCookie
 		Expires:  session.Expiration,
 		Secure:   secureCookie,
 		HttpOnly: httpOnly,
+		// as of go 1.25, http.SameSiteDefaultMode will omit SameSite attribute from the cookie
+		SameSite: sameSite,
 	}
 }
 

auth/session_test.go

@@ -116,14 +116,14 @@ func TestMakeSessionCookie(t *testing.T) {
 		Ttl:        24 * time.Hour,
 	}
 
-	cookie := auth.MakeSessionCookie(mockSession, false, false)
+	cookie := auth.MakeSessionCookie(mockSession, false, false, http.SameSiteDefaultMode)
 	assert.Equal(t, DefaultCookieName, cookie.Name)
 	assert.Equal(t, sessionID, cookie.Value)
 	assert.NotEmpty(t, cookie.Expires)
 
 	// Cookies should not be created with uninitialized session
 	mockSession = nil
-	cookie = auth.MakeSessionCookie(mockSession, false, false)
+	cookie = auth.MakeSessionCookie(mockSession, false, false, http.SameSiteDefaultMode)
 	assert.Empty(t, cookie)
 }
 
@@ -143,16 +143,16 @@ func TestMakeSessionCookieProperties(t *testing.T) {
 		Ttl:        24 * time.Hour,
 	}
 
-	unsecuredCookie := auth.MakeSessionCookie(mockSession, false, false)
+	unsecuredCookie := auth.MakeSessionCookie(mockSession, false, false, http.SameSiteDefaultMode)
 	assert.False(t, unsecuredCookie.Secure)
 
-	securedCookie := auth.MakeSessionCookie(mockSession, true, false)
+	securedCookie := auth.MakeSessionCookie(mockSession, true, false, http.SameSiteDefaultMode)
 	assert.True(t, securedCookie.Secure)
 
-	httpOnlyFalseCookie := auth.MakeSessionCookie(mockSession, false, false)
+	httpOnlyFalseCookie := auth.MakeSessionCookie(mockSession, false, false, http.SameSiteDefaultMode)
 	assert.False(t, httpOnlyFalseCookie.HttpOnly)
 
-	httpOnlyCookie := auth.MakeSessionCookie(mockSession, false, true)
+	httpOnlyCookie := auth.MakeSessionCookie(mockSession, false, true, http.SameSiteDefaultMode)
 	assert.True(t, httpOnlyCookie.HttpOnly)
 }
 
@@ -248,7 +248,7 @@ func TestCreateSessionChangePassword(t *testing.T) {
 
 			request, err := http.NewRequest(http.MethodGet, "", nil)
 			require.NoError(t, err)
-			request.AddCookie(auth.MakeSessionCookie(session, true, true))
+			request.AddCookie(auth.MakeSessionCookie(session, true, true, http.SameSiteDefaultMode))
 
 			recorder := httptest.NewRecorder()
 			_, err = auth.AuthenticateCookie(request, recorder)
@@ -304,7 +304,7 @@ func TestUserWithoutSessionUUID(t *testing.T) {
 
 	request, err := http.NewRequest(http.MethodGet, "", nil)
 	require.NoError(t, err)
-	request.AddCookie(auth.MakeSessionCookie(session, true, true))
+	request.AddCookie(auth.MakeSessionCookie(session, true, true, http.SameSiteDefaultMode))
 
 	recorder := httptest.NewRecorder()
 	_, err = auth.AuthenticateCookie(request, recorder)
@@ -334,7 +334,7 @@ func TestUserDeleteAllSessions(t *testing.T) {
 
 	request, err := http.NewRequest(http.MethodGet, "", nil)
 	require.NoError(t, err)
-	request.AddCookie(auth.MakeSessionCookie(session, true, true))
+	request.AddCookie(auth.MakeSessionCookie(session, true, true, http.SameSiteDefaultMode))
 	recorder := httptest.NewRecorder()
 
 	_, err = auth.AuthenticateCookie(request, recorder)

db/database.go

@@ -139,6 +139,7 @@ type DatabaseContext struct {
 	WasInitializedSynchronously  bool                           // true if the database was initialized synchronously
 	BroadcastSlowMode            atomic.Bool                    // bool to indicate if a slower ticker value should be used to notify changes feeds of changes
 	DatabaseStartupError         *DatabaseError                 // Error that occurred during database online processes startup
+	SameSiteCookieMode           http.SameSite
 }
 
 type Scope struct {
@@ -251,6 +252,7 @@ type UnsupportedOptions struct {
 	KVBufferSize                     int                      `json:"kv_buffer,omitempty"`                            // Enables user to set their own KV pool buffer
 	BlipSendDocsWithChannelRemoval   bool                     `json:"blip_send_docs_with_channel_removal,omitempty"`  // Enables sending docs with channel removals using channel filters
 	RejectWritesWithSkippedSequences bool                     `json:"reject_writes_with_skipped_sequences,omitempty"` // Reject writes if there are skipped sequences in the database
+	SameSiteCookie                   *string                  `json:"same_site_cookie,omitempty"`                     // Sets the SameSite attribute on session cookies.
 }
 
 type WarningThresholds struct {
@@ -418,6 +420,7 @@ func NewDatabaseContext(ctx context.Context, dbName string, bucket base.Bucket,
 		CollectionByID:      make(map[uint32]*DatabaseCollection),
 		ServerUUID:          serverUUID,
 		UserFunctionTimeout: defaultUserFunctionTimeout,
+		SameSiteCookieMode:  http.SameSiteDefaultMode,
 	}
 
 	// set up cancellable context based on the background context (context lifecycle for the database
@@ -2441,3 +2444,23 @@ func (db *Database) DataStoreNames() base.ScopeAndCollectionNames {
 	}
 	return names
 }
+
+// GetSameSiteCookieMode returns the http.SameSite mode based on the unsupported database options. Returns an error if
+// an invalid string is set.
+func (o *UnsupportedOptions) GetSameSiteCookieMode() (http.SameSite, error) {
+	if o == nil || o.SameSiteCookie == nil {
+		return http.SameSiteDefaultMode, nil
+	}
+	switch *o.SameSiteCookie {
+	case "Lax":
+		return http.SameSiteLaxMode, nil
+	case "Strict":
+		return http.SameSiteStrictMode, nil
+	case "None":
+		return http.SameSiteNoneMode, nil
+	case "Default":
+		return http.SameSiteDefaultMode, nil
+	default:
+		return http.SameSiteDefaultMode, fmt.Errorf("unsupported_options.same_site_cookie option %q is not valid, choices are \"Lax\", \"Strict\", and \"None", *o.SameSiteCookie)
+	}
+}

docs/api/components/schemas.yaml

@@ -1306,6 +1306,15 @@ Database:
         oidc_tls_skip_verify:
           description: Enable self-signed certificates for OIDC testing.
           type: boolean
+        same_site_cookie:
+          description: |-
+            Override the session cookie SameSite behavior. By default, a session cookie will have SameSite:None if CORS is enabled, and will have no SameSite attribute if CORS is not enabled.  Setting this property to`Default` will omit the SameSite attribute from the cookie.
+          type: string
+          enum:
+            - "Default"
+            - "Lax"
+            - "None"
+            - "Strict"
         sgr_tls_skip_verify:
           description: Enable self-signed certificates for SG-replicate testing.
           type: boolean

rest/config.go

@@ -1080,6 +1080,13 @@ func (dbConfig *DbConfig) validateVersion(ctx context.Context, isEnterpriseEditi
 		}
 	}
 
+	if dbConfig.Unsupported != nil {
+		_, err := dbConfig.Unsupported.GetSameSiteCookieMode()
+		if err != nil {
+			multiError = multiError.Append(err)
+		}
+	}
+
 	if validateReplications {
 		for name, r := range dbConfig.Replications {
 			if name == "" {

rest/config_test.go

@@ -3355,3 +3355,62 @@ func TestConfigUserXattrKeyValidation(t *testing.T) {
 		})
 	}
 }
+
+func TestValidateUnsupportedSameSiteCookies(t *testing.T) {
+	tests := []struct {
+		name                string
+		unsupportedSettings *db.UnsupportedOptions
+		error               string
+	}{
+		{
+			name:                "no unsupportedSettings present",
+			unsupportedSettings: &db.UnsupportedOptions{},
+			error:               "",
+		},
+		{
+			name:                "no samesite, unsupportedSettings present",
+			unsupportedSettings: &db.UnsupportedOptions{},
+			error:               "",
+		},
+		{
+			name:                "valid value Lax",
+			unsupportedSettings: &db.UnsupportedOptions{SameSiteCookie: base.Ptr("Lax")},
+			error:               "",
+		},
+		{
+			name:                "valid value Strict",
+			unsupportedSettings: &db.UnsupportedOptions{SameSiteCookie: base.Ptr("Strict")},
+			error:               "",
+		},
+		{
+			name:                "valid value None",
+			unsupportedSettings: &db.UnsupportedOptions{SameSiteCookie: base.Ptr("None")},
+			error:               "",
+		},
+		{
+			name:                "invalid value",
+			unsupportedSettings: &db.UnsupportedOptions{SameSiteCookie: base.Ptr("invalid value")},
+			error:               "unsupported_options.same_site_cookie option",
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			dbConfig := DbConfig{
+				Name:        "db",
+				Unsupported: test.unsupportedSettings,
+			}
+
+			validateReplications := false
+			validateOIDC := false
+			ctx := base.TestCtx(t)
+			err := dbConfig.validate(ctx, validateOIDC, validateReplications)
+			if test.error != "" {
+				require.Error(t, err)
+				require.Contains(t, err.Error(), test.error)
+			} else {
+				require.NoError(t, err)
+			}
+		})
+	}
+}

rest/cors_test.go

@@ -17,6 +17,7 @@ import (
 
 	"github.com/couchbase/sync_gateway/auth"
 	"github.com/couchbase/sync_gateway/base"
+	"github.com/couchbase/sync_gateway/db"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -407,66 +408,93 @@ func TestCORSLoginOriginPerDatabase(t *testing.T) {
 	// Override the default (example.com) CORS configuration in the DbConfig for /db:
 	rt := NewRestTesterPersistentConfigNoDB(t)
 	defer rt.Close()
-	dbConfig := rt.NewDbConfig()
-	dbConfig.CORS = &auth.CORSConfig{
-		Origin:      []string{"http://couchbase.com", "http://staging.couchbase.com"},
-		LoginOrigin: []string{"http://couchbase.com"},
-		Headers:     []string{},
-	}
-	RequireStatus(t, rt.CreateDatabase("dbloginorigin", dbConfig), http.StatusCreated)
-
-	const username = "alice"
-	rt.CreateUser(username, nil)
-
 	testCases := []struct {
-		name              string
-		origin            string
-		responseCode      int
-		responseErrorBody string
+		name               string
+		unsupportedOptions *db.UnsupportedOptions
+		sameSite           http.SameSite
 	}{
 		{
-			name:         "CORS login origin allowed couchbase",
-			origin:       "http://couchbase.com",
-			responseCode: http.StatusOK,
+			name:               "No unsupported options",
+			unsupportedOptions: nil,
+			sameSite:           http.SameSiteNoneMode,
 		},
 		{
-			name:              "CORS login origin not allowed staging",
-			origin:            "http://staging.couchbase.com",
-			responseCode:      http.StatusBadRequest,
-			responseErrorBody: "No CORS",
+			name: "With unsupported options",
+			unsupportedOptions: &db.UnsupportedOptions{
+				SameSiteCookie: base.Ptr("Strict"),
+			},
+			sameSite: http.SameSiteStrictMode,
 		},
 	}
-	for _, test := range testCases {
-		rt.Run(test.name, func(t *testing.T) {
-			reqHeaders := map[string]string{
-				"Origin":        test.origin,
-				"Authorization": GetBasicAuthHeader(t, username, RestTesterDefaultUserPassword),
-			}
-			resp := rt.SendRequestWithHeaders(http.MethodPost, "/{{.db}}/_session", "", reqHeaders)
-			RequireStatus(t, resp, test.responseCode)
-			if test.responseErrorBody != "" {
-				require.Contains(t, resp.Body.String(), test.responseErrorBody)
-				// the access control headers are returned based on Origin and not LoginOrigin which could be considered a bug
-				require.Equal(t, test.origin, resp.Header().Get(accessControlAllowOrigin))
-			} else {
-				require.Equal(t, test.origin, resp.Header().Get(accessControlAllowOrigin))
+	for _, dbTestCases := range testCases {
+		rt.Run(dbTestCases.name, func(t *testing.T) {
+			// Override the default (example.com) CORS configuration in the DbConfig for /db:
+			rt := NewRestTesterPersistentConfigNoDB(t)
+			defer rt.Close()
+
+			dbConfig := rt.NewDbConfig()
+			dbConfig.Unsupported = dbTestCases.unsupportedOptions
+			dbConfig.CORS = &auth.CORSConfig{
+				Origin:      []string{"http://couchbase.com", "http://staging.couchbase.com"},
+				LoginOrigin: []string{"http://couchbase.com"},
+				Headers:     []string{},
 			}
-			if test.responseCode == http.StatusOK {
-				cookie, err := http.ParseSetCookie(resp.Header().Get("Set-Cookie"))
-				require.NoError(t, err)
-				require.NotEmpty(t, cookie.Path)
-				reqHeaders["Cookie"] = fmt.Sprintf("%s=%s", cookie.Name, cookie.Value)
-			}
-			resp = rt.SendRequestWithHeaders(http.MethodDelete, "/{{.db}}/_session", "", reqHeaders)
-			RequireStatus(t, resp, test.responseCode)
-			if test.responseErrorBody != "" {
-				require.Contains(t, resp.Body.String(), test.responseErrorBody)
-				// the access control headers are returned based on Origin and not LoginOrigin which could be considered a bug
-				require.Equal(t, test.origin, resp.Header().Get(accessControlAllowOrigin))
-			} else {
-				require.Equal(t, test.origin, resp.Header().Get(accessControlAllowOrigin))
+			RequireStatus(t, rt.CreateDatabase(SafeDatabaseName(t, dbTestCases.name), dbConfig), http.StatusCreated)
+			const username = "alice"
+			rt.CreateUser(username, nil)
+
+			testCases := []struct {
+				name              string
+				origin            string
+				responseCode      int
+				responseErrorBody string
+			}{
+				{
+					name:         "CORS login origin allowed couchbase",
+					origin:       "http://couchbase.com",
+					responseCode: http.StatusOK,
+				},
+				{
+					name:              "CORS login origin not allowed staging",
+					origin:            "http://staging.couchbase.com",
+					responseCode:      http.StatusBadRequest,
+					responseErrorBody: "No CORS",
+				},
 			}
+			for _, test := range testCases {
+				rt.Run(test.name, func(t *testing.T) {
+					reqHeaders := map[string]string{
+						"Origin":        test.origin,
+						"Authorization": GetBasicAuthHeader(t, username, RestTesterDefaultUserPassword),
+					}
+					resp := rt.SendRequestWithHeaders(http.MethodPost, "/{{.db}}/_session", "", reqHeaders)
+					RequireStatus(t, resp, test.responseCode)
+					if test.responseErrorBody != "" {
+						require.Contains(t, resp.Body.String(), test.responseErrorBody)
+						// the access control headers are returned based on Origin and not LoginOrigin which could be considered a bug
+						require.Equal(t, test.origin, resp.Header().Get(accessControlAllowOrigin))
+					} else {
+						require.Equal(t, test.origin, resp.Header().Get(accessControlAllowOrigin))
+					}
+					if test.responseCode == http.StatusOK {
+						cookie, err := http.ParseSetCookie(resp.Header().Get("Set-Cookie"))
+						require.NoError(t, err)
+						require.NotEmpty(t, cookie.Path)
+						require.Equal(t, dbTestCases.sameSite, cookie.SameSite)
+						reqHeaders["Cookie"] = fmt.Sprintf("%s=%s", cookie.Name, cookie.Value)
+					}
+					resp = rt.SendRequestWithHeaders(http.MethodDelete, "/{{.db}}/_session", "", reqHeaders)
+					RequireStatus(t, resp, test.responseCode)
+					if test.responseErrorBody != "" {
+						require.Contains(t, resp.Body.String(), test.responseErrorBody)
+						// the access control headers are returned based on Origin and not LoginOrigin which could be considered a bug
+						require.Equal(t, test.origin, resp.Header().Get(accessControlAllowOrigin))
+					} else {
+						require.Equal(t, test.origin, resp.Header().Get(accessControlAllowOrigin))
+					}
 
+				})
+			}
 		})
 	}
 }

rest/server_context.go

@@ -922,6 +922,16 @@ func (sc *ServerContext) _getOrAddDatabaseFromConfig(ctx context.Context, config
 	} else {
 		dbcontext.CORS = sc.Config.API.CORS
 	}
+	if !dbcontext.CORS.IsEmpty() {
+		dbcontext.SameSiteCookieMode = http.SameSiteNoneMode
+	}
+	if config.Unsupported != nil && config.Unsupported.SameSiteCookie != nil {
+		var err error
+		dbcontext.SameSiteCookieMode, err = config.Unsupported.GetSameSiteCookieMode()
+		if err != nil {
+			return nil, err
+		}
+	}
 
 	if config.RevsLimit != nil {
 		dbcontext.RevsLimit = *config.RevsLimit