rules: add Rule interface

Author: ellemouton

log.go

@@ -6,8 +6,8 @@ import (
 	"github.com/lightninglabs/lightning-node-connect/mailbox"
 	"github.com/lightninglabs/lightning-terminal/accounts"
 	"github.com/lightninglabs/lightning-terminal/firewall"
-	"github.com/lightninglabs/lightning-terminal/firewalldb"
 	mid "github.com/lightninglabs/lightning-terminal/rpcmiddleware"
+	"github.com/lightninglabs/lightning-terminal/rules"
 	"github.com/lightninglabs/lightning-terminal/session"
 	"github.com/lightninglabs/loop/loopd"
 	"github.com/lightninglabs/pool"
@@ -70,9 +70,7 @@ func SetupLoggers(root *build.RotatingLogWriter, intercept signal.Interceptor) {
 	lnd.AddSubLogger(
 		root, firewall.Subsystem, intercept, firewall.UseLogger,
 	)
-	lnd.AddSubLogger(
-		root, firewalldb.Subsystem, intercept, firewalldb.UseLogger,
-	)
+	lnd.AddSubLogger(root, rules.Subsystem, intercept, rules.UseLogger)
 
 	// Add daemon loggers to lnd's root logger.
 	faraday.SetupLoggers(root, intercept)

rules/config.go

@@ -0,0 +1,105 @@
+package rules
+
+import (
+	"github.com/lightninglabs/lightning-terminal/firewalldb"
+	"github.com/lightninglabs/lndclient"
+	"gopkg.in/macaroon-bakery.v2/bakery"
+)
+
+// Config encompasses all the possible configuration items that could be
+// required by the various rules.
+type Config interface {
+	// GetStores can be used to get access to methods that can be used to
+	// perform atomic transactions on permanent and temporary local and
+	// global kv stores.
+	GetStores() firewalldb.KVStores
+
+	// GetActionsDB can be used by rules to list any past actions that were
+	// made for the specific session or feature.
+	GetActionsDB() firewalldb.ActionsDB
+
+	// GetMethodPerms returns a map that contains URIs and the permissions
+	// required to use them.
+	GetMethodPerms() func(string) ([]bakery.Op, bool)
+
+	// GetNodePubKey returns the node ID of the lnd node.
+	GetNodePubKey() [33]byte
+
+	// GetRouterClient returns an lnd router client.
+	GetRouterClient() lndclient.RouterClient
+
+	// GetReqID is the request ID of the call being evaluated. This can be
+	// used to link a request with a response.
+	GetReqID() int64
+
+	// GetLndClient returns an lnd client.
+	GetLndClient() lndclient.LightningClient
+}
+
+// ConfigImpl is an implementation of the Config interface.
+type ConfigImpl struct {
+	// GetStores provides access to methods that can be used to perform
+	// atomic transactions on permanent and temporary local and global
+	// kv stores.
+	Stores firewalldb.KVStores
+
+	// ActionsDB can be used by rules to list any past actions that were
+	// made for the specific session or feature.
+	ActionsDB firewalldb.ActionsDB
+
+	// MethodPerms is a function that can be used to fetch the permissions
+	// required for a URI.
+	MethodPerms func(string) ([]bakery.Op, bool)
+
+	// NodeID is the pub key of the lnd node.
+	NodeID [33]byte
+
+	// RouterClient is an lnd router client.
+	RouterClient lndclient.RouterClient
+
+	// ReqID is the request ID of the call being evaluated. This can be used
+	// to link a request with a response.
+	ReqID int64
+
+	// LndClient is a connection to the Lit node's LND node.
+	LndClient lndclient.LightningClient
+}
+
+func (c *ConfigImpl) GetStores() firewalldb.KVStores {
+	return c.Stores
+}
+
+// GetActionsDB returns the list of past actions.
+func (c *ConfigImpl) GetActionsDB() firewalldb.ActionsDB {
+	return c.ActionsDB
+}
+
+// GetMethodPerms returns a function that can be used to fetch the permissions
+// of a URI.
+func (c *ConfigImpl) GetMethodPerms() func(string) ([]bakery.Op, bool) {
+	return c.MethodPerms
+}
+
+// GetNodePubKey returns the node ID for the lnd node.
+func (c *ConfigImpl) GetNodePubKey() [33]byte {
+	return c.NodeID
+}
+
+// GetRouterClient returns an lnd router client.
+func (c *ConfigImpl) GetRouterClient() lndclient.RouterClient {
+	return c.RouterClient
+}
+
+// GetReqID returns the request ID of the request or response being evaluated.
+func (c *ConfigImpl) GetReqID() int64 {
+	return c.ReqID
+}
+
+// GetLndClient returns an lnd client.
+func (c *ConfigImpl) GetLndClient() lndclient.LightningClient {
+	return c.LndClient
+}
+
+// A compile-time check to ensure that ConfigImpl implements the Config
+// interface.
+var _ Config = (*ConfigImpl)(nil)

rules/interfaces.go

@@ -0,0 +1,75 @@
+package rules
+
+import (
+	"context"
+	"encoding/json"
+
+	"github.com/lightninglabs/lightning-terminal/firewalldb"
+	"github.com/lightninglabs/lightning-terminal/litrpc"
+	"google.golang.org/protobuf/proto"
+)
+
+// Manager is the interface that any firewall rule managers will need to
+// implement. A rule Manager is used to construct a rule Enforcer or rule
+// Values.
+type Manager interface {
+	// NewEnforcer constructs a new rule enforcer using the passed values
+	// and config.
+	NewEnforcer(cfg Config, values Values) (Enforcer, error)
+
+	// NewValueFromProto converts the given proto value into a Value object.
+	NewValueFromProto(p *litrpc.RuleValue) (Values, error)
+
+	// EmptyValue returns a new Values instance of the type that this
+	// Manager handles.
+	EmptyValue() Values
+
+	// Stop cleans up the resources held by the manager.
+	Stop() error
+}
+
+// Enforcer is the interface that any firewall rule enforcer must implement.
+// An enforcer accepts, rejects, and possible alters an RPC proto message for a
+// specific URI.
+type Enforcer interface {
+	// HandleRequest checks the validity of a request and possibly edits it.
+	HandleRequest(ctx context.Context, uri string,
+		protoMsg proto.Message) (proto.Message, error)
+
+	// HandleResponse handles and possibly alters a response.
+	HandleResponse(ctx context.Context, uri string,
+		protoMsg proto.Message) (proto.Message, error)
+
+	// HandleErrorResponse handles and possibly alters a response error.
+	HandleErrorResponse(ctx context.Context, uri string, err error) (error,
+		error)
+}
+
+// Values represents the static values that encompass the settings of the rule.
+type Values interface {
+	// RuleName returns the name of the rule that these values are to be
+	// used with.
+	RuleName() string
+
+	// VerifySane checks that the rules values are valid given the allowed
+	// minimum and maximum values.
+	VerifySane(minVal, maxVal Values) error
+
+	// ToProto converts the rule Values to the litrpc counterpart.
+	ToProto() *litrpc.RuleValue
+
+	// RealToPseudo converts the rule Values to a new one that uses pseudo
+	// keys, channel IDs, channel points etc. It returns a map of real to
+	// pseudo strings that should be persisted.
+	RealToPseudo() (Values, map[string]string, error)
+
+	// PseudoToReal attempts to convert any appropriate pseudo fields in
+	// the rule Values to their corresponding real values. It uses the
+	// passed PrivacyMapDB to find the real values.
+	PseudoToReal(db firewalldb.PrivacyMapDB) (Values, error)
+}
+
+// Marshal converts the rule Values to a json byte slice.
+func Marshal(v Values) ([]byte, error) {
+	return json.Marshal(v)
+}

rules/log.go

@@ -0,0 +1,25 @@
+package rules
+
+import (
+	"github.com/btcsuite/btclog"
+	"github.com/lightningnetwork/lnd/build"
+)
+
+const Subsystem = "RULE"
+
+// log is a logger that is initialized with no output filters.  This
+// means the package will not perform any logging by default until the caller
+// requests it.
+var log btclog.Logger // nolint:unused
+
+// The default amount of logging is none.
+func init() {
+	UseLogger(build.NewSubLogger(Subsystem, nil))
+}
+
+// UseLogger uses a specified Logger to output package logging info.
+// This should be used in preference to SetLogWriter if the caller is also
+// using btclog.
+func UseLogger(logger btclog.Logger) {
+	log = logger
+}