subservers: add Permissions method to the interface

Author: ellemouton

subservers/faraday.go

@@ -7,9 +7,11 @@ import (
 	"github.com/lightninglabs/faraday"
 	"github.com/lightninglabs/faraday/frdrpc"
 	"github.com/lightninglabs/faraday/frdrpcserver"
+	"github.com/lightninglabs/faraday/frdrpcserver/perms"
 	"github.com/lightninglabs/lndclient"
 	"github.com/lightningnetwork/lnd/lnrpc"
 	"google.golang.org/grpc"
+	"gopkg.in/macaroon-bakery.v2/bakery"
 )
 
 // faradaySubServer implements the SubServer interface.
@@ -108,3 +110,11 @@ func (f *faradaySubServer) ServerErrChan() chan error {
 func (f *faradaySubServer) MacPath() string {
 	return f.cfg.MacaroonPath
 }
+
+// Permissions returns a map of all RPC methods and their required macaroon
+// permissions to access the sub-server.
+//
+// NOTE: this is part of the SubServer interface.
+func (f *faradaySubServer) Permissions() map[string][]bakery.Op {
+	return perms.RequiredPermissions
+}

subservers/interface.go

@@ -8,6 +8,7 @@ import (
 	"github.com/lightningnetwork/lnd/lnrpc"
 	"github.com/lightningnetwork/lnd/macaroons"
 	"google.golang.org/grpc"
+	"gopkg.in/macaroon-bakery.v2/bakery"
 )
 
 // SubServer defines an interface that should be implemented by any sub-server
@@ -53,4 +54,8 @@ type SubServer interface {
 	// MacPath returns the path to the sub-server's macaroon if it is not
 	// running in remote mode.
 	MacPath() string
+
+	// Permissions returns a map of all RPC methods and their required
+	// macaroon permissions to access the sub-server.
+	Permissions() map[string][]bakery.Op
 }

subservers/loop.go

@@ -7,9 +7,11 @@ import (
 	"github.com/lightninglabs/lndclient"
 	"github.com/lightninglabs/loop"
 	"github.com/lightninglabs/loop/loopd"
+	"github.com/lightninglabs/loop/loopd/perms"
 	"github.com/lightninglabs/loop/looprpc"
 	"github.com/lightningnetwork/lnd/lnrpc"
 	"google.golang.org/grpc"
+	"gopkg.in/macaroon-bakery.v2/bakery"
 )
 
 // loopSubServer implements the SubServer interface.
@@ -118,3 +120,11 @@ func (l *loopSubServer) ServerErrChan() chan error {
 func (l *loopSubServer) MacPath() string {
 	return l.cfg.MacaroonPath
 }
+
+// Permissions returns a map of all RPC methods and their required macaroon
+// permissions to access the sub-server.
+//
+// NOTE: this is part of the SubServer interface.
+func (l *loopSubServer) Permissions() map[string][]bakery.Op {
+	return perms.RequiredPermissions
+}

subservers/pool.go

@@ -6,9 +6,11 @@ import (
 	restProxy "github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
 	"github.com/lightninglabs/lndclient"
 	"github.com/lightninglabs/pool"
+	"github.com/lightninglabs/pool/perms"
 	"github.com/lightninglabs/pool/poolrpc"
 	"github.com/lightningnetwork/lnd/lnrpc"
 	"google.golang.org/grpc"
+	"gopkg.in/macaroon-bakery.v2/bakery"
 )
 
 // poolSubServer implements the SubServer interface.
@@ -108,3 +110,11 @@ func (p *poolSubServer) ServerErrChan() chan error {
 func (p *poolSubServer) MacPath() string {
 	return p.cfg.MacaroonPath
 }
+
+// Permissions returns a map of all RPC methods and their required macaroon
+// permissions to access the sub-server.
+//
+// NOTE: this is part of the SubServer interface.
+func (p *poolSubServer) Permissions() map[string][]bakery.Op {
+	return perms.RequiredPermissions
+}