Merge pull request #504 from reubenmiller/fix-encryption-caching-option

fix: encryption passphrase caching option

Author: reubenmiller

pkg/c8ysession/c8ysession.go

@@ -158,7 +158,7 @@ func WriteOutput(w io.Writer, client *c8y.Client, cfg *config.Config, session *C
 
 	shell, isShell := utilities.ShellType.Parse(utilities.ShellBash, format)
 	if isShell {
-		output := GetVariablesFromSession(session, client, cfg.AlwaysIncludePassword())
+		output := GetVariablesFromSession(session, cfg, client, cfg.AlwaysIncludePassword())
 		utilities.WriteShellVariables(w, output, shell)
 		return nil
 	}
@@ -175,7 +175,7 @@ func WriteOutput(w io.Writer, client *c8y.Client, cfg *config.Config, session *C
 		}
 		fmt.Fprintf(w, "%s\n", out)
 	case "env", "dotenv":
-		output := GetVariablesFromSession(session, client, cfg.AlwaysIncludePassword())
+		output := GetVariablesFromSession(session, cfg, client, cfg.AlwaysIncludePassword())
 		for k, v := range output {
 			if v != "" {
 				fmt.Fprintf(w, "%s=%s\n", k, v)
@@ -188,7 +188,7 @@ func WriteOutput(w io.Writer, client *c8y.Client, cfg *config.Config, session *C
 }
 
 // GetVariablesFromSession gets all the environment variables associated with the current session
-func GetVariablesFromSession(session *CumulocitySession, client *c8y.Client, setPassword bool) map[string]interface{} {
+func GetVariablesFromSession(session *CumulocitySession, cfg *config.Config, client *c8y.Client, setPassword bool) map[string]interface{} {
 	host := session.Host
 	domain := session.GetDomain()
 	tenant := session.Tenant
@@ -227,6 +227,17 @@ func GetVariablesFromSession(session *CumulocitySession, client *c8y.Client, set
 		"C8Y_SETTINGS_LOGIN_TYPE":  loginType,
 	}
 
+	cache := cfg.CachePassphraseVariables()
+	cfg.Logger.Debugf("Cache passphrase: %v", cache)
+	if cache {
+		if cfg.Passphrase != "" {
+			output[config.EnvPassphrase] = cfg.Passphrase
+		}
+		if cfg.SecretText != "" {
+			output[config.EnvPassphraseText] = cfg.SecretText
+		}
+	}
+
 	if loginType != c8y.AuthMethodOAuth2Internal {
 		output["C8Y_TOKEN"] = ""
 	}
@@ -240,13 +251,8 @@ func GetVariablesFromSession(session *CumulocitySession, client *c8y.Client, set
 	return output
 }
 
-func ShowClientEnvironmentVariables(cfg *config.Config, c8yclient *c8y.Client, shell utilities.ShellType) {
-	output := cfg.GetEnvironmentVariables(c8yclient, cfg.AlwaysIncludePassword())
-	utilities.WriteShellVariables(os.Stdout, output, shell)
-}
-
 func ShowSessionEnvironmentVariables(session *CumulocitySession, cfg *config.Config, c8yclient *c8y.Client, shell utilities.ShellType) {
-	output := GetVariablesFromSession(session, c8yclient, cfg.AlwaysIncludePassword())
+	output := GetVariablesFromSession(session, cfg, c8yclient, cfg.AlwaysIncludePassword())
 	utilities.WriteShellVariables(os.Stdout, output, shell)
 }
 

pkg/config/cliConfiguration.go

@@ -474,7 +474,7 @@ func (c *Config) bindSettings() {
 	c.viper.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
 	c.viper.SetEnvPrefix(EnvSettingsPrefix)
 	err := c.WithOptions(
-		WithBindEnv(SettingEncryptionCachePassphrase, true),
+		WithBindEnv(SettingEncryptionCachePassphrase, false),
 		WithBindEnv(SettingsMaxWorkers, 50),
 		WithBindEnv(SettingsWorkers, 1),
 		WithBindEnv(SettingsIncludeAllPageSize, 2000),
@@ -754,77 +754,6 @@ func (c Config) DecryptAllProperties() (err error) {
 	return err
 }
 
-// GetEnvironmentVariables gets all the environment variables associated with the current session
-func (c Config) GetEnvironmentVariables(client *c8y.Client, setPassword bool) map[string]interface{} {
-	host := c.GetHost()
-	domain := c.GetDomain()
-	tenant := c.GetTenant()
-	c8yVersion := c.GetCumulocityVersion()
-	username := c.GetUsername()
-	password := c.MustGetPassword()
-	token := c.MustGetToken(false)
-	authHeaderValue := ""
-	authHeader := ""
-
-	if client != nil {
-		if client.TenantName != "" {
-			tenant = client.TenantName
-		}
-		if client.Username != "" {
-			username = client.Username
-		}
-		if client.BaseURL.Host != "" {
-			host = client.BaseURL.Scheme + "://" + client.BaseURL.Host
-		}
-		if client.Domain != "" {
-			domain = client.Domain
-		}
-		if client.Password != "" {
-			password = client.Password
-		}
-		if client.Token != "" {
-			token = client.Token
-		}
-		if dummyReq, err := client.NewRequest("GET", "/", "", nil); err == nil {
-			authHeaderValue = dummyReq.Header.Get("Authorization")
-			authHeader = "Authorization: " + authHeaderValue
-		}
-	}
-
-	// hide password if it is not needed
-	if !setPassword && token != "" {
-		password = ""
-	}
-
-	output := map[string]interface{}{
-		"C8Y_SESSION":              c.GetSessionFile(),
-		"C8Y_URL":                  host,
-		"C8Y_BASEURL":              host,
-		"C8Y_HOST":                 host,
-		"C8Y_DOMAIN":               domain,
-		"C8Y_TENANT":               tenant,
-		"C8Y_VERSION":              c8yVersion,
-		"C8Y_USER":                 username,
-		"C8Y_TOKEN":                token,
-		"C8Y_USERNAME":             username,
-		"C8Y_PASSWORD":             password,
-		"C8Y_HEADER_AUTHORIZATION": authHeaderValue,
-		"C8Y_HEADER":               authHeader,
-	}
-
-	cache := c.CachePassphraseVariables()
-	c.Logger.Debugf("Cache passphrase: %v", cache)
-	if cache {
-		if c.Passphrase != "" {
-			output[EnvPassphrase] = c.Passphrase
-		}
-		if c.SecretText != "" {
-			output[EnvPassphraseText] = c.SecretText
-		}
-	}
-	return output
-}
-
 // GetEnvKey returns the environment key value associated
 func (c Config) GetEnvKey(key string) string {
 	return "C8Y_" + strings.ToUpper(strings.ReplaceAll(key, ".", "_"))