feat(security): Remove Writable from security services

Update for security services on: - Loglevel is on the top level of ConfigurationStruct - Remove Writable from Configuration struct - Make UpdateFromRaw, UpdateWritableFromRaw do nothing and make EmptyWritablePtr just return nil Fixes: #3123 Signed-off-by: Jim Wang <yutsung.jim.wang@intel.com>
edgexfoundry · Feb 8, 2021 · 15c04cc · 15c04cc
1 parent 9ee6a91
commit 15c04cc
Show file tree

Hide file tree

Showing 11 changed files with 31 additions and 89 deletions.
diff --git a/cmd/secrets-config/main.go b/cmd/secrets-config/main.go
@@ -14,7 +14,7 @@ import (
 )
 
 func main() {
-	os.Setenv("WRITABLE_LOGLEVEL", "ERROR") // Workaround for https://github.com/edgexfoundry/edgex-go/issues/2922
+	os.Setenv("LOGLEVEL", "ERROR") // Workaround for https://github.com/edgexfoundry/edgex-go/issues/2922
 	ctx, cancel := context.WithCancel(context.Background())
 	exitStatusCode := config.Main(ctx, cancel)
 	os.Exit(exitStatusCode)

diff --git a/cmd/security-bootstrapper/res/configuration.toml b/cmd/security-bootstrapper/res/configuration.toml
@@ -1,4 +1,3 @@
-[Writable]
 LogLevel = 'INFO'
 
 [StageGate]

diff --git a/cmd/security-proxy-setup/res/configuration.toml b/cmd/security-proxy-setup/res/configuration.toml
@@ -16,8 +16,9 @@
 
 # This is a TOML config file for edgexsecurity service.
 
-[Writable]
 LogLevel = "DEBUG"
+
+[ProxySetup]
 RequestTimeout = 10
 
 [KongURL]

diff --git a/cmd/security-secretstore-setup/res-file-token-provider/configuration.toml b/cmd/security-secretstore-setup/res-file-token-provider/configuration.toml
@@ -1,4 +1,3 @@
-[Writable]
 LogLevel = 'DEBUG'
 
 [SecretService]

diff --git a/cmd/security-secretstore-setup/res/configuration.toml b/cmd/security-secretstore-setup/res/configuration.toml
@@ -16,7 +16,6 @@
 
 # This is a TOML config file for EdgeX security-secretstore-setup service.
 
-[Writable]
 LogLevel = 'DEBUG'
 
 [SecretService]

diff --git a/internal/security/bootstrapper/config/config.go b/internal/security/bootstrapper/config/config.go
@@ -20,38 +20,26 @@ import (
 )
 
 type ConfigurationStruct struct {
-	Writable  WritableInfo
+	LogLevel  string
 	StageGate StageGateInfo
 }
 
-type WritableInfo struct {
-	LogLevel string
-}
-
 // UpdateFromRaw converts configuration received from the registry to a service-specific configuration struct which is
 // then used to overwrite the service's existing configuration struct.
 func (c *ConfigurationStruct) UpdateFromRaw(rawConfig interface{}) bool {
-	configuration, ok := rawConfig.(*ConfigurationStruct)
-	if ok {
-		*c = *configuration
-	}
-	return ok
+	return false
 }
 
 // EmptyWritablePtr returns a pointer to a service-specific empty WritableInfo struct.  It is used by the bootstrap to
 // provide the appropriate structure to registry.Client's WatchForChanges().
 func (c *ConfigurationStruct) EmptyWritablePtr() interface{} {
-	return &WritableInfo{}
+	return nil
 }
 
 // UpdateWritableFromRaw converts configuration received from the registry to a service-specific WritableInfo struct
 // which is then used to overwrite the service's existing configuration's WritableInfo struct.
 func (c *ConfigurationStruct) UpdateWritableFromRaw(rawWritable interface{}) bool {
-	writable, ok := rawWritable.(*WritableInfo)
-	if ok {
-		c.Writable = *writable
-	}
-	return ok
+	return false
 }
 
 // GetBootstrap returns the configuration elements required by the bootstrap.  Currently, a copy of the configuration
@@ -65,7 +53,7 @@ func (c *ConfigurationStruct) GetBootstrap() bootstrapConfig.BootstrapConfigurat
 
 // GetLogLevel returns the current ConfigurationStruct's log level.
 func (c *ConfigurationStruct) GetLogLevel() string {
-	return c.Writable.LogLevel
+	return c.LogLevel
 }
 
 // GetRegistryInfo returns the RegistryInfo from the ConfigurationStruct.

diff --git a/internal/security/fileprovider/config/config.go b/internal/security/fileprovider/config/config.go
@@ -23,16 +23,11 @@ import (
 )
 
 type ConfigurationStruct struct {
-	Writable          WritableInfo
+	LogLevel          string
 	SecretService     secretstoreclient.SecretServiceInfo
 	TokenFileProvider TokenFileProviderInfo
 }
 
-type WritableInfo struct {
-	LogLevel string
-	Title    string
-}
-
 type TokenFileProviderInfo struct {
 	// Path to Vault authorization token to be used by the service
 	PrivilegedTokenPath string
@@ -47,31 +42,19 @@ type TokenFileProviderInfo struct {
 // UpdateFromRaw converts configuration received from the registry to a service-specific configuration struct which is
 // then used to overwrite the service's existing configuration struct.
 func (c *ConfigurationStruct) UpdateFromRaw(rawConfig interface{}) bool {
-	configuration, ok := rawConfig.(*ConfigurationStruct)
-	if ok {
-		// Check that information was successfully read from Registry
-		if configuration.SecretService.Port == 0 {
-			return false
-		}
-		*c = *configuration
-	}
-	return ok
+	return false
 }
 
 // EmptyWritablePtr returns a pointer to a service-specific empty WritableInfo struct.  It is used by the bootstrap to
 // provide the appropriate structure to registry.Client's WatchForChanges().
 func (c *ConfigurationStruct) EmptyWritablePtr() interface{} {
-	return &WritableInfo{}
+	return nil
 }
 
 // UpdateWritableFromRaw converts configuration received from the registry to a service-specific WritableInfo struct
 // which is then used to overwrite the service's existing configuration's WritableInfo struct.
 func (c *ConfigurationStruct) UpdateWritableFromRaw(rawWritable interface{}) bool {
-	writable, ok := rawWritable.(*WritableInfo)
-	if ok {
-		c.Writable = *writable
-	}
-	return ok
+	return false
 }
 
 // GetBootstrap returns the configuration elements required by the bootstrap.  Currently, a copy of the configuration
@@ -85,7 +68,7 @@ func (c *ConfigurationStruct) GetBootstrap() bootstrapConfig.BootstrapConfigurat
 
 // GetLogLevel returns the current ConfigurationStruct's log level.
 func (c *ConfigurationStruct) GetLogLevel() string {
-	return c.Writable.LogLevel
+	return c.LogLevel
 }
 
 // GetRegistryInfo returns the RegistryInfo from the ConfigurationStruct.

diff --git a/internal/security/proxy/config/config.go b/internal/security/proxy/config/config.go
@@ -1,4 +1,5 @@
 /*******************************************************************************
+ * Copyright 2021 Intel Corporation
  * Copyright 2019 Dell Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
@@ -24,7 +25,8 @@ import (
 )
 
 type ConfigurationStruct struct {
-	Writable      WritableInfo
+	LogLevel      string
+	ProxySetup    ProxySetupInfo
 	KongURL       KongUrlInfo
 	KongAuth      KongAuthInfo
 	KongACL       KongAclInfo
@@ -33,8 +35,7 @@ type ConfigurationStruct struct {
 	Clients       map[string]bootstrapConfig.ClientInfo
 }
 
-type WritableInfo struct {
-	LogLevel       string
+type ProxySetupInfo struct {
 	RequestTimeout int
 }
 
@@ -92,31 +93,19 @@ func (s SecretServiceInfo) GetSecretSvcBaseURL() string {
 // UpdateFromRaw converts configuration received from the registry to a service-specific configuration struct which is
 // then used to overwrite the service's existing configuration struct.
 func (c *ConfigurationStruct) UpdateFromRaw(rawConfig interface{}) bool {
-	configuration, ok := rawConfig.(*ConfigurationStruct)
-	if ok {
-		// Check that information was successfully read from Registry
-		if configuration.SecretService.Port == 0 {
-			return false
-		}
-		*c = *configuration
-	}
-	return ok
+	return false
 }
 
 // EmptyWritablePtr returns a pointer to a service-specific empty WritableInfo struct.  It is used by the bootstrap to
 // provide the appropriate structure to registry.Client's WatchForChanges().
 func (c *ConfigurationStruct) EmptyWritablePtr() interface{} {
-	return &WritableInfo{}
+	return nil
 }
 
 // UpdateWritableFromRaw converts configuration received from the registry to a service-specific WritableInfo struct
 // which is then used to overwrite the service's existing configuration's WritableInfo struct.
 func (c *ConfigurationStruct) UpdateWritableFromRaw(rawWritable interface{}) bool {
-	writable, ok := rawWritable.(*WritableInfo)
-	if ok {
-		c.Writable = *writable
-	}
-	return ok
+	return false
 }
 
 // GetBootstrap returns the configuration elements required by the bootstrap.  Currently, a copy of the configuration
@@ -148,7 +137,7 @@ func (c *ConfigurationStruct) GetBootstrap() bootstrapConfig.BootstrapConfigurat
 
 // GetLogLevel returns the current ConfigurationStruct's log level.
 func (c *ConfigurationStruct) GetLogLevel() string {
-	return c.Writable.LogLevel
+	return c.LogLevel
 }
 
 // GetRegistryInfo returns the RegistryInfo from the ConfigurationStruct.
@@ -158,7 +147,7 @@ func (c *ConfigurationStruct) GetRegistryInfo() bootstrapConfig.RegistryInfo {
 
 // GetDatabaseInfo returns a database information map.
 func (c *ConfigurationStruct) GetDatabaseInfo() map[string]bootstrapConfig.Database {
-	panic("GetDatabaseInfo() called unexpectedly.")
+	return nil
 }
 
 // GetInsecureSecrets returns the service's InsecureSecrets which this service doesn't support

diff --git a/internal/security/proxy/init.go b/internal/security/proxy/init.go
@@ -69,13 +69,13 @@ func (b *Bootstrap) BootstrapHandler(_ context.Context, _ *sync.WaitGroup, _ sta
 	if len(configuration.SecretService.CACertPath) > 0 {
 		req = NewRequestor(
 			b.insecureSkipVerify,
-			configuration.Writable.RequestTimeout,
+			configuration.ProxySetup.RequestTimeout,
 			configuration.SecretService.CACertPath,
 			lc)
 	} else {
 		req = NewRequestor(
 			true, // non-TLS mode internally
-			configuration.Writable.RequestTimeout,
+			configuration.ProxySetup.RequestTimeout,
 			"", // irrelevant
 			lc)
 	}

diff --git a/internal/security/proxy/testdata/configuration.toml b/internal/security/proxy/testdata/configuration.toml
@@ -16,8 +16,9 @@
 
 # This is a TOML config file for edgexsecurity service.
 
-[Writable]
 LogLevel = 'DEBUG'
+
+[ProxySetup]
 RequestTimeout = 10
 
 [KongURL]

diff --git a/internal/security/secretstore/config/config.go b/internal/security/secretstore/config/config.go
@@ -22,16 +22,11 @@ import (
 )
 
 type ConfigurationStruct struct {
-	Writable      WritableInfo
+	LogLevel      string
 	SecretService secretstoreclient.SecretServiceInfo
 	Databases     map[string]Database
 }
 
-type WritableInfo struct {
-	LogLevel string
-	Title    string
-}
-
 type Database struct {
 	Username string
 	Service  string
@@ -40,31 +35,19 @@ type Database struct {
 // UpdateFromRaw converts configuration received from the registry to a service-specific configuration struct which is
 // then used to overwrite the service's existing configuration struct.
 func (c *ConfigurationStruct) UpdateFromRaw(rawConfig interface{}) bool {
-	configuration, ok := rawConfig.(*ConfigurationStruct)
-	if ok {
-		// Check that information was successfully read from Registry
-		if configuration.SecretService.Port == 0 {
-			return false
-		}
-		*c = *configuration
-	}
-	return ok
+	return false
 }
 
 // EmptyWritablePtr returns a pointer to a service-specific empty WritableInfo struct.  It is used by the bootstrap to
 // provide the appropriate structure to registry.Client's WatchForChanges().
 func (c *ConfigurationStruct) EmptyWritablePtr() interface{} {
-	return &WritableInfo{}
+	return nil
 }
 
 // UpdateWritableFromRaw converts configuration received from the registry to a service-specific WritableInfo struct
 // which is then used to overwrite the service's existing configuration's WritableInfo struct.
 func (c *ConfigurationStruct) UpdateWritableFromRaw(rawWritable interface{}) bool {
-	writable, ok := rawWritable.(*WritableInfo)
-	if ok {
-		c.Writable = *writable
-	}
-	return ok
+	return false
 }
 
 // GetBootstrap returns the configuration elements required by the bootstrap.  Currently, a copy of the configuration
@@ -78,7 +61,7 @@ func (c *ConfigurationStruct) GetBootstrap() bootstrapConfig.BootstrapConfigurat
 
 // GetLogLevel returns the current ConfigurationStruct's log level.
 func (c *ConfigurationStruct) GetLogLevel() string {
-	return c.Writable.LogLevel
+	return c.LogLevel
 }
 
 // GetRegistryInfo returns the RegistryInfo from the ConfigurationStruct.