multi: allow custom session with all read-only perms

In this commit, a special case is added to the creation of a custom
session to allow the user to specify custom URIs as well as the
permissions for all read-only endpoints.

Author: ellemouton

perms/permissions_test.go

@@ -78,4 +78,10 @@ func TestMatchRegexURI(t *testing.T) {
 	uris, isRegex = m.MatchRegexURI("/poolrpc.Trader/.*")
 	require.True(t, isRegex)
 	require.Empty(t, uris)
+
+	// Assert that the read-only permission's keyword is not seen as a valid
+	// regex.
+	uris, isRegex = m.MatchRegexURI("***readonly***")
+	require.False(t, isRegex)
+	require.Empty(t, uris)
 }

session_rpcserver.go

@@ -19,6 +19,14 @@ import (
 	"gopkg.in/macaroon.v2"
 )
 
+// readOnlyAction defines the keyword that a permission action should be set to
+// when the entity is set to "uri" in order to activate the special case that
+// will result in all read-only permissions known to lit to be added to a
+// session's macaroon. The purpose of the three '*'s is to make this keyword
+// an invalid URI and an invalid regex so that it does not ever clash with the
+// other special cases.
+const readOnlyAction = "***readonly***"
+
 // sessionRpcServer is the gRPC server for the Session RPC interface.
 type sessionRpcServer struct {
 	litrpc.UnimplementedSessionsServer
@@ -152,6 +160,20 @@ func (s *sessionRpcServer) AddSession(_ context.Context,
 				continue
 			}
 
+			// If the action specified was equal to the
+			// readOnlyAction keyword, then this is taken to mean
+			// that the permissions for all read-only URIs should be
+			// granted.
+			if op.Action == readOnlyAction {
+				readPerms := s.cfg.permMgr.ActivePermissions(
+					true,
+				)
+
+				permissions = append(permissions, readPerms...)
+
+				continue
+			}
+
 			// First check if this is a regex URI.
 			uris, isRegex := s.cfg.permMgr.MatchRegexURI(op.Action)
 			if isRegex {