Skip to content

The only tool you need to know what is happening and how to fix it.

feat: made oauth_sessions persist in db for multi instance deployments

dduxa8f58eb28474
diff --git a/backend/app/migrations/pg/0035_create_oauth_sessions.up.sql b/backend/app/migrations/pg/0035_create_oauth_sessions.up.sql
new file mode 100644
index 00000000..45cf11d2
--- /dev/null
+++ b/backend/app/migrations/pg/0035_create_oauth_sessions.up.sql
@@ -0,0 +1,5 @@
+CREATE TABLE IF NOT EXISTS oauth_sessions (
+ id TEXT PRIMARY KEY,
+ data BYTEA NOT NULL,
+ expires_at TIMESTAMPTZ NOT NULL
+)
diff --git a/backend/app/migrations/pg/0036_create_oauth_sessions_expires_idx.up.sql b/backend/app/migrations/pg/0036_create_oauth_sessions_expires_idx.up.sql
new file mode 100644
index 00000000..173f0367
--- /dev/null
+++ b/backend/app/migrations/pg/0036_create_oauth_sessions_expires_idx.up.sql
@@ -0,0 +1 @@
+CREATE INDEX IF NOT EXISTS idx_oauth_sessions_expires_at ON oauth_sessions(expires_at)
diff --git a/backend/app/migrations/sqlite/0010_create_oauth_sessions.up.sql b/backend/app/migrations/sqlite/0010_create_oauth_sessions.up.sql
new file mode 100644
index 00000000..80bad9e4
--- /dev/null
+++ b/backend/app/migrations/sqlite/0010_create_oauth_sessions.up.sql
@@ -0,0 +1,7 @@
+CREATE TABLE IF NOT EXISTS oauth_sessions (
+ id TEXT PRIMARY KEY,
+ data BLOB NOT NULL,
+ expires_at DATETIME NOT NULL
+);
+
+CREATE INDEX IF NOT EXISTS idx_oauth_sessions_expires_at ON oauth_sessions(expires_at);
diff --git a/backend/app/repositories/oauth_session.repository.go b/backend/app/repositories/oauth_session.repository.go
new file mode 100644
index 00000000..ecf446cd
--- /dev/null
+++ b/backend/app/repositories/oauth_session.repository.go
@@ -0,0 +1,92 @@
+package repositories
+
+import (
+ "database/sql"
+ "errors"
+ "time"
+
+ "github.com/tracewayapp/lit/v2"
+ "github.com/tracewayapp/traceway/backend/app/db"
+)
+
+type oauthSessionRepository struct{}
+
+func (r *oauthSessionRepository) Get(tx *sql.Tx, id string) ([]byte, error) {
+ query, args, err := lit.ParseNamedQuery(
+ db.Driver,
+ "SELECT data FROM oauth_sessions WHERE id = :id AND expires_at > :now",
+ lit.P{"id": id, "now": time.Now().UTC().Format(time.RFC3339Nano)},
+ )
+ if err != nil {
+ return nil, err
+ }
+
+ var data []byte
+ if err := tx.QueryRow(query, args...).Scan(&data); err != nil {
+ if errors.Is(err, sql.ErrNoRows) {
+ return nil, nil
+ }
+ return nil, err
+ }
+ return data, nil
+}
+
+func (r *oauthSessionRepository) Save(tx *sql.Tx, id string, data []byte, expiresAt time.Time) error {
+ deleteQuery, deleteArgs, err := lit.ParseNamedQuery(
+ db.Driver,
+ "DELETE FROM oauth_sessions WHERE id = :id",
+ lit.P{"id": id},
+ )
+ if err != nil {
+ return err
+ }
+ if _, err := tx.Exec(deleteQuery, deleteArgs...); err != nil {
+ return err
+ }
+
+ insertQuery, insertArgs, err := lit.ParseNamedQuery(
+ db.Driver,
+ "INSERT INTO oauth_sessions (id, data, expires_at) VALUES (:id, :data, :expires_at)",
+ lit.P{
+ "id": id,
+ "data": data,
+ "expires_at": expiresAt.UTC().Format(time.RFC3339Nano),
+ },
+ )
+ if err != nil {
+ return err
+ }
+ _, err = tx.Exec(insertQuery, insertArgs...)
+ return err
+}
+
+func (r *oauthSessionRepository) Delete(tx *sql.Tx, id string) error {
+ query, args, err := lit.ParseNamedQuery(
+ db.Driver,
+ "DELETE FROM oauth_sessions WHERE id = :id",
+ lit.P{"id": id},
+ )
+ if err != nil {
+ return err
+ }
+ _, err = tx.Exec(query, args...)
+ return err
+}
+
+func (r *oauthSessionRepository) PruneExpired(tx *sql.Tx, now time.Time) (int64, error) {
+ query, args, err := lit.ParseNamedQuery(
+ db.Driver,
+ "DELETE FROM oauth_sessions WHERE expires_at < :cutoff",
+ lit.P{"cutoff": now.UTC().Format(time.RFC3339Nano)},
+ )
+ if err != nil {
+ return 0, err
+ }
+ result, err := tx.Exec(query, args...)
+ if err != nil {
+ return 0, err
+ }
+ return result.RowsAffected()
+}
+
+var OAuthSessionRepository = oauthSessionRepository{}
diff --git a/backend/app/retention/oauth_sessions.go b/backend/app/retention/oauth_sessions.go
new file mode 100644
index 00000000..3b061c7e
--- /dev/null
+++ b/backend/app/retention/oauth_sessions.go
@@ -0,0 +1,49 @@
+package retention
+
+import (
+ "context"
+ "database/sql"
+ "fmt"
+ "time"
+
+ "github.com/tracewayapp/traceway/backend/app/config"
+ "github.com/tracewayapp/traceway/backend/app/db"
+ "github.com/tracewayapp/traceway/backend/app/repositories"
+ traceway "go.tracewayapp.com"
+)
+
+const oauthSessionsPruneInterval = 24 * time.Hour
+
+func startOAuthSessionsPrune(ctx context.Context) {
+ config.Logf("Starting oauth_sessions prune worker (interval: %s)", oauthSessionsPruneInterval)
+
+ go func() {
+ defer traceway.Recover()
+
+ runOAuthSessionsPrune(ctx)
+
+ ticker := time.NewTicker(oauthSessionsPruneInterval)
+ defer ticker.Stop()
+ for {
+ select {
+ case <-ctx.Done():
+ return
+ case <-ticker.C:
+ runOAuthSessionsPrune(ctx)
+ }
+ }
+ }()
+}
+
+func runOAuthSessionsPrune(ctx context.Context) {
+ if ctx.Err() != nil || db.DB == nil {
+ return
+ }
+
+ _, err := db.ExecuteTransaction(func(tx *sql.Tx) (int64, error) {
+ return repositories.OAuthSessionRepository.PruneExpired(tx, time.Now().UTC())
+ })
+ if err != nil {
+ traceway.CaptureException(fmt.Errorf("retention: prune oauth_sessions failed: %w", err))
+ }
+}
diff --git a/backend/app/retention/retention.go b/backend/app/retention/retention.go
index 351e4784..61bf4952 100644
--- a/backend/app/retention/retention.go
+++ b/backend/app/retention/retention.go
@@ -36,4 +36,5 @@ func Start(ctx context.Context) {
startSQLiteRetention(ctx, daysRetentionSqlite)
startRecordingDiskCleanup(ctx, daysRetentionRecordings)
+ startOAuthSessionsPrune(ctx)
}
diff --git a/backend/app/services/oauth.service.go b/backend/app/services/oauth.service.go
index 502cea78..2cef08bf 100644
--- a/backend/app/services/oauth.service.go
+++ b/backend/app/services/oauth.service.go
@@ -63,16 +63,13 @@ func InitOAuth() {
secret = cfg.JWTSecret
}
- store := sessions.NewFilesystemStore("", []byte(secret))
- store.MaxLength(0)
- store.Options = &sessions.Options{
+ gothic.Store = newDBSessionStore(secret, &sessions.Options{
Path: "/",
HttpOnly: true,
MaxAge: 600,
Secure: strings.HasPrefix(cfg.AppBaseURL, "https://"),
SameSite: http.SameSiteLaxMode,
- }
- gothic.Store = store
+ })
providers := []goth.Provider{}
base := strings.TrimRight(cfg.AppBaseURL, "/")
diff --git a/backend/app/services/oauth_session_store.go b/backend/app/services/oauth_session_store.go
new file mode 100644
index 00000000..5c546a68
--- /dev/null
+++ b/backend/app/services/oauth_session_store.go
@@ -0,0 +1,108 @@
+package services
+
+import (
+ "database/sql"
+ "encoding/base32"
+ "net/http"
+ "strings"
+ "time"
+
+ "github.com/gorilla/securecookie"
+ "github.com/gorilla/sessions"
+ "github.com/tracewayapp/traceway/backend/app/db"
+ "github.com/tracewayapp/traceway/backend/app/repositories"
+)
+
+// dbSessionStore is a gorilla/sessions.Store backed by the main transactional
+// DB. The cookie holds only a signed session ID; the session data (which can
+// exceed the 4096-byte cookie limit for large OIDC ID tokens) lives in the
+// oauth_sessions table.
+type dbSessionStore struct {
+ codecs []securecookie.Codec
+ options *sessions.Options
+}
+
+func newDBSessionStore(secret string, options *sessions.Options) *dbSessionStore {
+ codecs := securecookie.CodecsFromPairs([]byte(secret))
+ for _, c := range codecs {
+ if sc, ok := c.(*securecookie.SecureCookie); ok {
+ sc.MaxLength(0)
+ }
+ }
+ return &dbSessionStore{codecs: codecs, options: options}
+}
+
+func (s *dbSessionStore) Get(r *http.Request, name string) (*sessions.Session, error) {
+ return sessions.GetRegistry(r).Get(s, name)
+}
+
+func (s *dbSessionStore) New(r *http.Request, name string) (*sessions.Session, error) {
+ session := sessions.NewSession(s, name)
+ opts := *s.options
+ session.Options = &opts
+ session.IsNew = true
+
+ cookie, err := r.Cookie(name)
+ if err != nil {
+ return session, nil
+ }
+
+ var id string
+ if err := securecookie.DecodeMulti(name, cookie.Value, &id, s.codecs...); err != nil {
+ return session, nil
+ }
+
+ data, err := db.ExecuteTransaction(func(tx *sql.Tx) ([]byte, error) {
+ return repositories.OAuthSessionRepository.Get(tx, id)
+ })
+ if err != nil || data == nil {
+ return session, nil
+ }
+
+ if err := securecookie.DecodeMulti(name, string(data), &session.Values, s.codecs...); err != nil {
+ return session, nil
+ }
+ session.ID = id
+ session.IsNew = false
+ return session, nil
+}
+
+func (s *dbSessionStore) Save(r *http.Request, w http.ResponseWriter, session *sessions.Session) error {
+ if session.Options != nil && session.Options.MaxAge < 0 {
+ if session.ID != "" {
+ if _, err := db.ExecuteTransaction(func(tx *sql.Tx) (struct{}, error) {
+ return struct{}{}, repositories.OAuthSessionRepository.Delete(tx, session.ID)
+ }); err != nil {
+ return err
+ }
+ }
+ http.SetCookie(w, sessions.NewCookie(session.Name(), "", session.Options))
+ return nil
+ }
+
+ if session.ID == "" {
+ session.ID = strings.TrimRight(
+ base32.StdEncoding.EncodeToString(securecookie.GenerateRandomKey(32)),
+ "=",
+ )
+ }
+
+ encoded, err := securecookie.EncodeMulti(session.Name(), session.Values, s.codecs...)
+ if err != nil {
+ return err
+ }
+
+ expires := time.Now().UTC().Add(time.Duration(session.Options.MaxAge) * time.Second)
+ if _, err := db.ExecuteTransaction(func(tx *sql.Tx) (struct{}, error) {
+ return struct{}{}, repositories.OAuthSessionRepository.Save(tx, session.ID, []byte(encoded), expires)
+ }); err != nil {
+ return err
+ }
+
+ cookieValue, err := securecookie.EncodeMulti(session.Name(), session.ID, s.codecs...)
+ if err != nil {
+ return err
+ }
+ http.SetCookie(w, sessions.NewCookie(session.Name(), cookieValue, session.Options))
+ return nil
+}
diff --git a/backend/go.mod b/backend/go.mod
index d485aa88..bfe70082 100644
--- a/backend/go.mod
+++ b/backend/go.mod
@@ -9,6 +9,7 @@ require (
github.com/aws/aws-sdk-go-v2/service/s3 v1.96.0
github.com/coreos/go-systemd/v22 v22.6.0
github.com/golang-jwt/jwt/v5 v5.3.0
+ github.com/gorilla/securecookie v1.1.2
github.com/gorilla/sessions v1.4.0
github.com/lib/pq v1.10.9
github.com/markbates/goth v1.82.0
@@ -22,7 +23,6 @@ require (
cloud.google.com/go/compute/metadata v0.8.0 // indirect
github.com/go-chi/chi/v5 v5.2.2 // indirect
github.com/gorilla/mux v1.7.4 // indirect
- github.com/gorilla/securecookie v1.1.2 // indirect
github.com/grpc-ecosystem/grpc-gateway/v2 v2.27.2 // indirect
github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 // indirect
github.com/remyoudompheng/bigfft v0.0.0-20200410134404-eec4a21b6bb0 // indirect