[sql-31] firewalldb: Privacy Mapper schemas, queries and CRUD

db/migrations.go

@@ -22,7 +22,7 @@ const (
 	// daemon.
 	//
 	// NOTE: This MUST be updated when a new migration is added.
-	LatestMigrationVersion = 3
+	LatestMigrationVersion = 4
 )
 
 // MigrationTarget is a functional option that can be passed to applyMigrations

db/sqlc/migrations/000004_privacy_pairs.down.sql

@@ -0,0 +1,4 @@
+DROP INDEX IF EXISTS privacy_pairs_group_id_idx;
+DROP INDEX IF EXISTS privacy_pairs_unique_real;
+DROP INDEX IF EXISTS privacy_pairs_unique_pseudo;
+DROP TABLE IF EXISTS privacy_pairs;

db/sqlc/migrations/000004_privacy_pairs.up.sql

@@ -0,0 +1,23 @@
+-- privacy_pairs stores the privacy map pairs for a given session group.
+CREATE TABLE IF NOT EXISTS privacy_pairs (
+    -- The group ID of the session that this privacy pair is associated
+    -- with.
+    group_id BIGINT NOT NULL REFERENCES sessions(id) ON DELETE CASCADE,
+
+    -- The real value of the privacy pair.
+    real_val TEXT NOT NULL,
+
+    -- The pseudo value of the privacy pair.
+    pseudo_val TEXT NOT NULL
+);
+
+-- There should be no duplicate real values for a given group ID.
+CREATE UNIQUE INDEX privacy_pairs_unique_real ON privacy_pairs (
+    group_id, real_val
+);
+
+-- There should be no duplicate pseudo values for a given group ID.
+CREATE UNIQUE INDEX privacy_pairs_unique_pseudo ON privacy_pairs (
+    group_id, pseudo_val
+);
+

db/sqlc/queries/privacy_paris.sql

@@ -0,0 +1,18 @@
+-- name: InsertPrivacyPair :exec
+INSERT INTO privacy_pairs (group_id, real_val, pseudo_val)
+VALUES ($1, $2, $3);
+
+-- name: GetRealForPseudo :one
+SELECT real_val
+FROM privacy_pairs
+WHERE group_id = $1 AND pseudo_val = $2;
+
+-- name: GetPseudoForReal :one
+SELECT pseudo_val
+FROM privacy_pairs
+WHERE group_id = $1 AND real_val = $2;
+
+-- name: GetAllPrivacyPairs :many
+SELECT real_val, pseudo_val
+FROM privacy_pairs
+WHERE group_id = $1;

firewall/privacy_mapper.go

@@ -60,19 +60,19 @@ var _ mid.RequestInterceptor = (*PrivacyMapper)(nil)
 // PrivacyMapper is a RequestInterceptor that maps any pseudo names in certain
 // requests to their real values and vice versa for responses.
 type PrivacyMapper struct {
-	newDB     firewalldb.NewPrivacyMapDB
+	db        firewalldb.PrivacyMapper
 	randIntn  func(int) (int, error)
 	sessionDB firewalldb.SessionDB
 }
 
 // NewPrivacyMapper returns a new instance of PrivacyMapper. The randIntn
 // function is used to draw randomness for request field obfuscation.
-func NewPrivacyMapper(newDB firewalldb.NewPrivacyMapDB,
+func NewPrivacyMapper(newDB firewalldb.PrivacyMapper,
 	randIntn func(int) (int, error),
 	sessionDB firewalldb.SessionDB) *PrivacyMapper {
 
 	return &PrivacyMapper{
-		newDB:     newDB,
+		db:        newDB,
 		randIntn:  randIntn,
 		sessionDB: sessionDB,
 	}
@@ -195,7 +195,7 @@ func (p *PrivacyMapper) checkAndReplaceIncomingRequest(ctx context.Context,
 		return nil, err
 	}
 
-	db := p.newDB(session.GroupID)
+	db := p.db.PrivacyDB(session.GroupID)
 
 	// If we don't have a handler for the URI, we don't allow the request
 	// to go through.
@@ -225,7 +225,7 @@ func (p *PrivacyMapper) replaceOutgoingResponse(ctx context.Context, uri string,
 		return nil, err
 	}
 
-	db := p.newDB(session.GroupID)
+	db := p.db.PrivacyDB(session.GroupID)
 
 	// If we don't have a handler for the URI, we don't allow the response
 	// to go to avoid accidental leaks.

firewall/privacy_mapper_test.go

@@ -902,7 +902,7 @@ func TestPrivacyMapper(t *testing.T) {
 
 			// randIntn is used for deterministic testing.
 			randIntn := func(n int) (int, error) { return 100, nil }
-			p := NewPrivacyMapper(db.NewSessionDB, randIntn, pd)
+			p := NewPrivacyMapper(db, randIntn, pd)
 
 			rawMsg, err := proto.Marshal(test.msg)
 			require.NoError(t, err)
@@ -978,7 +978,7 @@ func TestPrivacyMapper(t *testing.T) {
 		rawMsg, err := proto.Marshal(msg)
 		require.NoError(t, err)
 
-		p := NewPrivacyMapper(db.NewSessionDB, CryptoRandIntn, pd)
+		p := NewPrivacyMapper(db, CryptoRandIntn, pd)
 		require.NoError(t, err)
 
 		// We test the independent outgoing amount (incoming amount
@@ -1071,7 +1071,7 @@ func newMockDB(t *testing.T, preloadRealToPseudo map[string]string,
 	sessID session.ID) mockDB {
 
 	db := mockDB{privDB: make(map[string]*mockPrivacyMapDB)}
-	sessDB := db.NewSessionDB(sessID)
+	sessDB := db.PrivacyDB(sessID)
 
 	_ = sessDB.Update(context.Background(), func(ctx context.Context,
 		tx firewalldb.PrivacyMapTx) error {
@@ -1085,14 +1085,14 @@ func newMockDB(t *testing.T, preloadRealToPseudo map[string]string,
 	return db
 }
 
-func (m mockDB) NewSessionDB(sessionID session.ID) firewalldb.PrivacyMapDB {
-	db, ok := m.privDB[string(sessionID[:])]
+func (m mockDB) PrivacyDB(groupID session.ID) firewalldb.PrivacyMapDB {
+	db, ok := m.privDB[string(groupID[:])]
 	if ok {
 		return db
 	}
 
 	newDB := newMockPrivacyMapDB()
-	m.privDB[string(sessionID[:])] = newDB
+	m.privDB[string(groupID[:])] = newDB
 
 	return newDB
 }

firewall/rule_enforcer.go

@@ -33,7 +33,7 @@ type RuleEnforcer struct {
 	actionsDB         firewalldb.ActionReadDBGetter
 	sessionDB         firewalldb.SessionDB
 	markActionErrored func(reqID uint64, reason string) error
-	newPrivMap        firewalldb.NewPrivacyMapDB
+	privMapDB         firewalldb.PrivacyMapper
 
 	permsMgr        *perms.Manager
 	getFeaturePerms featurePerms
@@ -64,7 +64,7 @@ func NewRuleEnforcer(ruleDB firewalldb.RulesDB,
 	lndClient lndclient.LightningClient, lndConnID string,
 	ruleMgrs rules.ManagerSet,
 	markActionErrored func(reqID uint64, reason string) error,
-	privMap firewalldb.NewPrivacyMapDB) *RuleEnforcer {
+	privMap firewalldb.PrivacyMapper) *RuleEnforcer {
 
 	return &RuleEnforcer{
 		ruleDB:            ruleDB,
@@ -76,7 +76,7 @@ func NewRuleEnforcer(ruleDB firewalldb.RulesDB,
 		lndClient:         lndClient,
 		ruleMgrs:          ruleMgrs,
 		markActionErrored: markActionErrored,
-		newPrivMap:        privMap,
+		privMapDB:         privMap,
 		sessionDB:         sessionIDIndex,
 		lndConnID:         lndConnID,
 	}
@@ -392,7 +392,7 @@ func (r *RuleEnforcer) initRule(ctx context.Context, reqID uint64, name string,
 	}
 
 	if privacy {
-		privMap := r.newPrivMap(session.GroupID)
+		privMap := r.privMapDB.PrivacyDB(session.GroupID)
 
 		ruleValues, err = ruleValues.PseudoToReal(
 			ctx, privMap, session.PrivacyFlags,

firewalldb/db.go

@@ -14,21 +14,28 @@ var (
 	ErrNoSuchKeyFound = fmt.Errorf("no such key found")
 )
 
+// firewallDBs is an interface that groups the RulesDB and PrivacyMapper
+// interfaces.
+type firewallDBs interface {
+	RulesDB
+	PrivacyMapper
+}
+
 // DB manages the firewall rules database.
 type DB struct {
 	started sync.Once
 	stopped sync.Once
 
-	RulesDB
+	firewallDBs
 
 	cancel fn.Option[context.CancelFunc]
 }
 
 // NewDB creates a new firewall database. For now, it only contains the
-// underlying rules' database.
-func NewDB(kvdb RulesDB) *DB {
+// underlying rules' and privacy mapper databases.
+func NewDB(dbs firewallDBs) *DB {
 	return &DB{
-		RulesDB: kvdb,
+		firewallDBs: dbs,
 	}
 }
 

firewalldb/interface.go

@@ -92,3 +92,11 @@ type RulesDB interface {
 	// DeleteTempKVStores deletes all temporary kv stores.
 	DeleteTempKVStores(ctx context.Context) error
 }
+
+// PrivacyMapper is an interface that abstracts access to the privacy mapper
+// database.
+type PrivacyMapper interface {
+	// PrivacyDB constructs a PrivacyMapDB that will be indexed under the
+	// given group ID key.
+	PrivacyDB(groupID session.ID) PrivacyMapDB
+}

firewalldb/privacy_mapper.go

@@ -11,8 +11,6 @@ import (
 	"strconv"
 	"strings"
 	"sync"
-
-	"github.com/lightninglabs/lightning-terminal/session"
 )
 
 var (
@@ -29,10 +27,6 @@ var (
 		"value already exists")
 )
 
-// NewPrivacyMapDB is a function type that takes a group ID and uses it to
-// construct a new PrivacyMapDB.
-type NewPrivacyMapDB func(groupID session.ID) PrivacyMapDB
-
 // PrivacyMapDB provides an Update and View method that will allow the caller
 // to perform atomic read and write transactions defined by PrivacyMapTx on the
 // underlying DB.

firewalldb/privacy_mapper_kvdb.go

@@ -30,6 +30,8 @@ var (
 
 // PrivacyDB constructs a PrivacyMapDB that will be indexed under the given
 // group ID key.
+//
+// NOTE: this is part of the PrivacyMapper interface.
 func (db *BoltDB) PrivacyDB(groupID session.ID) PrivacyMapDB {
 	return &kvdbExecutor[PrivacyMapTx]{
 		db: db.DB,