Merge pull request #746 from bitromortac/privacy-flags

firewall: session-dependent privacy flags

Author: bitromortac

.golangci.yml

@@ -1,6 +1,6 @@
 run:
   # timeout for analysis
-  deadline: 4m
+  timeout: 4m
 
   build-tags:
     - autopilotrpc

Makefile

@@ -83,7 +83,11 @@ ifneq ($(workers),)
 LINT_WORKERS = --concurrency=$(workers)
 endif
 
-DOCKER_TOOLS = docker run -v $$(pwd):/build litd-tools
+DOCKER_TOOLS = docker run \
+  -v $(shell bash -c "go env GOCACHE || (mkdir -p /tmp/go-cache; echo /tmp/go-cache)"):/tmp/build/.cache \
+  -v $(shell bash -c "go env GOMODCACHE || (mkdir -p /tmp/go-modcache; echo /tmp/go-modcache)"):/tmp/build/.modcache \
+  -v $(shell bash -c "mkdir -p /tmp/go-lint-cache; echo /tmp/go-lint-cache"):/root/.cache/golangci-lint \
+  -v $$(pwd):/build litd-tools
 
 ITEST_TAGS := integration itest $(LND_RELEASE_TAGS)
 ITEST_LDFLAGS := $(call make_ldflags, $(ITEST_TAGS))

app/src/types/generated/lit-autopilot_pb.d.ts

@@ -977,6 +977,7 @@ export const litListSessions: LIT.ListSessionsResponse.AsObject = {
         ],
       ],
       featureConfigsMap: [['SampleFeature', '{}']],
+      privacyFlags: '0',
     },
     {
       id: '',
@@ -1059,6 +1060,7 @@ export const litListSessions: LIT.ListSessionsResponse.AsObject = {
         ],
       ],
       featureConfigsMap: [['SampleFeature', '{}']],
+      privacyFlags: '0',
     },
   ],
 };

app/src/types/generated/lit-autopilot_pb.js

@@ -362,6 +362,7 @@ func (c *Client) ListFeatures(ctx context.Context) (map[string]*Feature,
 			Permissions:   perms,
 			Rules:         rules,
 			DefaultConfig: feature.DefaultConfig,
+			PrivacyFlags:  feature.PrivacyFlags,
 		}
 	}
 
@@ -378,11 +379,12 @@ func (c *Client) ListFeatures(ctx context.Context) (map[string]*Feature,
 // Note: this is part of the Autopilot interface.
 func (c *Client) RegisterSession(ctx context.Context, pubKey *btcec.PublicKey,
 	mailboxAddr string, devServer bool, featureConf map[string][]byte,
-	groupKey *btcec.PublicKey, linkSig []byte) (*btcec.PublicKey, error) {
+	groupKey *btcec.PublicKey, linkSig []byte,
+	privacyFlags uint64) (*btcec.PublicKey, error) {
 
 	remotePub, err := c.registerSession(
 		ctx, pubKey, mailboxAddr, devServer, featureConf,
-		groupKey, linkSig,
+		groupKey, linkSig, privacyFlags,
 	)
 	if err != nil {
 		log.Errorf("unsuccessful registration of session %x",
@@ -428,8 +430,8 @@ func (c *Client) trackClient(pubKey *btcec.PublicKey) {
 // public key with the autopilot server.
 func (c *Client) registerSession(ctx context.Context, pubKey *btcec.PublicKey,
 	mailboxAddr string, devServer bool, featureConfig map[string][]byte,
-	groupLocalPub *btcec.PublicKey, linkSig []byte) (*btcec.PublicKey,
-	error) {
+	groupLocalPub *btcec.PublicKey, linkSig []byte,
+	privacyFlags uint64) (*btcec.PublicKey, error) {
 
 	client, cleanup, err := c.getClientConn()
 	if err != nil {
@@ -452,6 +454,7 @@ func (c *Client) registerSession(ctx context.Context, pubKey *btcec.PublicKey,
 			LndVersion:        marshalVersion(c.cfg.LndVersion),
 			GroupResponderKey: groupKey,
 			GroupResponderSig: linkSig,
+			PrivacyFlags:      privacyFlags,
 		},
 	)
 	if err != nil {

app/src/types/generated/lit-sessions_pb.d.ts

@@ -45,7 +45,9 @@ func TestAutopilotClient(t *testing.T) {
 	require.ErrorContains(t, err, "no such client")
 
 	// Register the client.
-	_, err = client.RegisterSession(ctx, pubKey, "", false, nil, nil, nil)
+	_, err = client.RegisterSession(
+		ctx, pubKey, "", false, nil, nil, nil, 0,
+	)
 	require.NoError(t, err)
 
 	// Assert that the server sees the new client and has it in the Active

app/src/types/generated/lit-sessions_pb.js

@@ -30,7 +30,7 @@ type Autopilot interface {
 	RegisterSession(ctx context.Context, pubKey *btcec.PublicKey,
 		mailboxAddr string, devServer bool,
 		featureConf map[string][]byte, linkedGroupKey *btcec.PublicKey,
-		linkSig []byte) (*btcec.PublicKey, error)
+		linkSig []byte, privacyFlags uint64) (*btcec.PublicKey, error)
 
 	// ActivateSession attempts to inform the autopilot server that the
 	// given session is still active. After this is called, the autopilot
@@ -73,6 +73,9 @@ type Feature struct {
 	// represents the default configuration we can use if the user doesn't
 	// specify any.
 	DefaultConfig []byte
+
+	// PrivacyFlags is a list of privacy flags that the feature requires.
+	PrivacyFlags uint64
 }
 
 // RuleValues holds the default value along with the sane max and min values