[WIP] feat: add masking to list resources

cli/config.go

@@ -22,11 +22,12 @@ const configFlag = "config"
 
 // Config contains the application configuration.
 type Config struct {
-	Log       logger.LogConfig `mapstructure:"log"`
-	Syncer    SyncerConf       `mapstructure:"syncer"`
-	Service   ServeConfig      `mapstructure:"service"`
-	PGConnStr string           `mapstructure:"pg_conn_str" default:"postgres://postgres@localhost:5432/entropy?sslmode=disable"`
-	Telemetry telemetry.Config `mapstructure:"telemetry"`
+	Log        logger.LogConfig `mapstructure:"log"`
+	Syncer     SyncerConf       `mapstructure:"syncer"`
+	Service    ServeConfig      `mapstructure:"service"`
+	PGConnStr  string           `mapstructure:"pg_conn_str" default:"postgres://postgres@localhost:5432/entropy?sslmode=disable"`
+	Telemetry  telemetry.Config `mapstructure:"telemetry"`
+	SecretMask string           `mapstructure:"secret_mask"`
 }
 
 type SyncerConf struct {

cli/serve.go

@@ -63,7 +63,7 @@ func StartServer(ctx context.Context, cfg Config, migrate, spawnWorker bool) err
 	)
 
 	store := setupStorage(cfg.PGConnStr, cfg.Syncer, cfg.Service)
-	moduleService := module.NewService(setupRegistry(), store)
+	moduleService := module.NewService(setupRegistry(), store, cfg.SecretMask)
 	resourceService := core.New(store, moduleService, time.Now, cfg.Syncer.SyncBackoffInterval, cfg.Syncer.MaxRetries)
 
 	if migrate {

cli/worker.go

@@ -57,7 +57,7 @@ func cmdWorker() *cobra.Command {
 
 func StartWorkers(ctx context.Context, cfg Config) error {
 	store := setupStorage(cfg.PGConnStr, cfg.Syncer, cfg.Service)
-	moduleService := module.NewService(setupRegistry(), store)
+	moduleService := module.NewService(setupRegistry(), store, cfg.SecretMask)
 	resourceService := core.New(store, moduleService, time.Now, cfg.Syncer.SyncBackoffInterval, cfg.Syncer.MaxRetries)
 
 	eg := &errgroup.Group{}

core/core.go

@@ -18,13 +18,15 @@ type Service struct {
 	moduleSvc      ModuleService
 	syncBackoff    time.Duration
 	maxSyncRetries int
+	secretMask     string
 }
 
 type ModuleService interface {
 	PlanAction(ctx context.Context, res module.ExpandedResource, act module.ActionRequest) (*resource.Resource, error)
 	SyncState(ctx context.Context, res module.ExpandedResource) (*resource.State, error)
 	StreamLogs(ctx context.Context, res module.ExpandedResource, filter map[string]string) (<-chan module.LogChunk, error)
 	GetOutput(ctx context.Context, res module.ExpandedResource) (json.RawMessage, error)
+	MaskSecrets(ctx context.Context, res resource.Resource) (resource.Resource, error)
 }
 
 func New(repo resource.Store, moduleSvc ModuleService, clockFn func() time.Time, syncBackoffInterval time.Duration, maxRetries int) *Service {

core/module/module.go

@@ -29,6 +29,7 @@ type Descriptor struct {
 	Actions       []ActionDesc                               `json:"actions"`
 	Dependencies  map[string]string                          `json:"dependencies"`
 	DriverFactory func(conf json.RawMessage) (Driver, error) `json:"-"`
+	Secrets       []string                                   `json:"secrets"`
 }
 
 // Registry is responsible for installing and managing module-drivers as per

core/module/service.go

@@ -7,17 +7,20 @@ import (
 
 	"github.com/goto/entropy/core/resource"
 	"github.com/goto/entropy/pkg/errors"
+	jsonpkg "github.com/goto/entropy/pkg/json"
 )
 
 type Service struct {
-	store    Store
-	registry Registry
+	store      Store
+	registry   Registry
+	secretMask string
 }
 
-func NewService(registry Registry, store Store) *Service {
+func NewService(registry Registry, store Store, secretMask string) *Service {
 	return &Service{
-		store:    store,
-		registry: registry,
+		store:      store,
+		registry:   registry,
+		secretMask: secretMask,
 	}
 }
 
@@ -177,3 +180,30 @@ func (mr *Service) initDriver(ctx context.Context, mod Module) (Driver, Descript
 func generateURN(name, project string) string {
 	return fmt.Sprintf("orn:entropy:module:%s:%s", project, name)
 }
+
+func (mr *Service) MaskSecrets(ctx context.Context, res resource.Resource) (resource.Resource, error) {
+	mod, err := mr.discoverModule(ctx, res.Kind, res.Project)
+	if err != nil {
+		return resource.Resource{}, err
+	}
+
+	_, desc, err := mr.initDriver(ctx, *mod)
+	if err != nil {
+		return resource.Resource{}, err
+	}
+
+	for _, secret := range desc.Secrets {
+		maskedResSpecConfigs, err := jsonpkg.SetJSONField(res.Spec.Configs, secret, mr.secretMask)
+		if err != nil {
+			return resource.Resource{}, errors.ErrInternal.WithCausef(err.Error())
+		}
+		res.Spec.Configs = maskedResSpecConfigs
+
+		maskedResStateOutput, err := jsonpkg.SetJSONField(res.State.Output, secret, mr.secretMask)
+		if err != nil {
+			return resource.Resource{}, errors.ErrInternal.WithCausef(err.Error())
+		}
+		res.State.Output = maskedResStateOutput
+	}
+	return res, nil
+}

core/read.go

@@ -36,6 +36,11 @@ func (svc *Service) GetResource(ctx context.Context, urn string) (*resource.Reso
 		}
 	}
 
+	*res, err = svc.moduleSvc.MaskSecrets(ctx, *res)
+	if err != nil {
+		return nil, err
+	}
+
 	return res, nil
 }
 

core/read_test.go

@@ -17,6 +17,7 @@
 const (
 	defaultMaxRetries  = 5
 	defaultSyncBackoff = 5 * time.Second
+	secretMask         = "[MASKED]"
 )
 
 func TestService_GetResource(t *testing.T) {
@@ -58,7 +59,7 @@
 					Return(nil, nil).
 					Once()
 
 				return core.New(repo, mod, deadClock, defaultSyncBackoff, defaultMaxRetries)
 			},
 			urn:     "foo:bar:baz",
 			want:    &sampleResource,

modules/registry.go

@@ -2,7 +2,10 @@ package modules
 
 import (
 	"context"
+	"fmt"
+	"os"
 	"reflect"
+	"strings"
 	"sync"
 
 	"github.com/goto/entropy/core/module"
@@ -53,6 +56,10 @@ func (mr *Registry) Register(desc module.Descriptor) error {
 		}
 		desc.Actions[i] = action
 	}
+
+	secretKey := fmt.Sprintf("%s_SECRET", strings.ToUpper(desc.Kind))
+	secrets := os.Getenv(secretKey)
+	desc.Secrets = strings.Split(secrets, ",")
 	mr.modules[desc.Kind] = desc
 	return nil
 }

pkg/json/json.go

@@ -0,0 +1,17 @@
+package json
+
+import (
+	"encoding/json"
+
+	"github.com/tidwall/sjson"
+)
+
+func SetJSONField(json json.RawMessage, key string, value interface{}) (json.RawMessage, error) {
+	sjson, err := sjson.SetBytes(json, key, value)
+
+	if err != nil {
+		return nil, err
+	}
+
+	return sjson, nil
+}