commit 17e015a63825b4f7221a17868f623f3c43e9c2b5
parent 245760ac5449108bd06112570622f963ca970fed
Author: Sean Enck <sean@ttypty.com>
Date: Sun, 3 Sep 2023 07:56:23 -0400
renaming interactive -> ask
Diffstat:
3 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/internal/config/vars.go b/internal/config/vars.go
@@ -16,7 +16,7 @@ const (
prefixKey = "LOCKBOX_"
clipBaseEnv = prefixKey + "CLIP_"
plainKeyMode = "plaintext"
- interactiveKeyMode = "interactive"
+ askKeyMode = "ask"
commandKeyMode = "command"
commandArgsExample = "[cmd args...]"
fileExample = "<file>"
@@ -82,7 +82,7 @@ var (
EnvFormatTOTP = EnvironmentFormatter{environmentBase: environmentBase{key: EnvTOTPToken.key + "_FORMAT", desc: "Override the otpauth url used to store totp tokens. It must have ONE format\nstring ('%s') to insert the totp base code."}, fxn: formatterTOTP, allowed: "otpauth//url/%s/args..."}
// EnvConfig is the location of the config file to read environment variables from
EnvConfig = EnvironmentString{environmentBase: environmentBase{key: prefixKey + "ENV", desc: fmt.Sprintf("Allows setting a specific file of environment variables for lockbox\nto read and use as configuration values (an '.env' file). The keyword\n'%s' will disable this functionality the keyword '%s' will search\nfor a file in the following paths in user's home directory matching\nthe first file found.\n\ndefault search paths:\n%v\n\nNote that this setting is not output as part of the environment.", noEnvironment, detectEnvironment, detectEnvironmentPaths)}, canDefault: true, defaultValue: detectEnvironment, allowed: []string{detectEnvironment, fileExample, noEnvironment}}
- envKeyMode = EnvironmentString{environmentBase: environmentBase{key: prefixKey + "KEYMODE", requirement: "must be set to a valid mode when using a key", desc: "How to retrieve the database store password."}, allowed: []string{commandKeyMode, plainKeyMode, interactiveKeyMode}, canDefault: true, defaultValue: commandKeyMode}
+ envKeyMode = EnvironmentString{environmentBase: environmentBase{key: prefixKey + "KEYMODE", requirement: "must be set to a valid mode when using a key", desc: "How to retrieve the database store password."}, allowed: []string{askKeyMode, commandKeyMode, plainKeyMode}, canDefault: true, defaultValue: commandKeyMode}
envKey = EnvironmentString{environmentBase: environmentBase{requirement: requiredKeyOrKeyFile, key: prefixKey + "KEY", desc: fmt.Sprintf("The database key ('%s' mode) or command to run ('%s' mode)\nto retrieve the database password.", plainKeyMode, commandKeyMode)}, allowed: []string{commandArgsExample, "password"}, canDefault: false}
envConfigExpands = EnvironmentInt{environmentBase: environmentBase{key: EnvConfig.key + "_EXPANDS", desc: "The maximum number of times to expand the input env to resolve variables,\nset to 0 to disable expansion. This value can NOT be an expansion itself\nif set in the env config file."}, shortDesc: "max expands", allowZero: true, defaultValue: 20}
)
@@ -125,16 +125,16 @@ func GetReKey(args []string) ([]string, error) {
func GetKey(dryrun bool) (*Key, error) {
useKey := envKey.Get()
keyMode := envKeyMode.Get()
- if keyMode == interactiveKeyMode {
+ if keyMode == askKeyMode {
isInteractive, err := EnvInteractive.Get()
if err != nil {
return nil, err
}
if !isInteractive {
- return nil, errors.New("interactive key mode requested in non-interactive mode")
+ return nil, errors.New("ask key mode requested in non-interactive mode")
}
if useKey != "" {
- return nil, errors.New("key can NOT be set in interactive mode")
+ return nil, errors.New("key can NOT be set in ask key mode")
}
return &Key{}, nil
}
diff --git a/internal/config/vars_test.go b/internal/config/vars_test.go
@@ -103,27 +103,27 @@ func TestGetKey(t *testing.T) {
t.Error("should have failed")
}
os.Setenv("LOCKBOX_INTERACTIVE", "yes")
- os.Setenv("LOCKBOX_KEYMODE", "interactive")
+ os.Setenv("LOCKBOX_KEYMODE", "ask")
os.Setenv("LOCKBOX_KEY", "")
if k, err := config.GetKey(false); err != nil || k == nil || !k.Interactive() {
t.Errorf("invalid error: %v", err)
}
os.Setenv("LOCKBOX_INTERACTIVE", "yes")
- os.Setenv("LOCKBOX_KEYMODE", "interactive")
+ os.Setenv("LOCKBOX_KEYMODE", "ask")
os.Setenv("LOCKBOX_KEY", "")
if k, err := config.GetKey(true); err != nil || k == nil || !k.Interactive() {
t.Errorf("invalid error: %v", err)
}
os.Setenv("LOCKBOX_INTERACTIVE", "no")
- os.Setenv("LOCKBOX_KEYMODE", "interactive")
+ os.Setenv("LOCKBOX_KEYMODE", "ask")
os.Setenv("LOCKBOX_KEY", "")
- if k, err := config.GetKey(false); err == nil || err.Error() != "interactive key mode requested in non-interactive mode" || k != nil {
+ if k, err := config.GetKey(false); err == nil || err.Error() != "ask key mode requested in non-interactive mode" || k != nil {
t.Errorf("invalid error: %v", err)
}
os.Setenv("LOCKBOX_INTERACTIVE", "yes")
- os.Setenv("LOCKBOX_KEYMODE", "interactive")
+ os.Setenv("LOCKBOX_KEYMODE", "ask")
os.Setenv("LOCKBOX_KEY", "aaa")
- if k, err := config.GetKey(false); err == nil || err.Error() != "key can NOT be set in interactive mode" || k != nil {
+ if k, err := config.GetKey(false); err == nil || err.Error() != "key can NOT be set in ask key mode" || k != nil {
t.Errorf("invalid error: %v", err)
}
}
diff --git a/tests/run.sh b/tests/run.sh
@@ -21,7 +21,7 @@ _execute() {
oldkey="$LOCKBOX_KEY"
if [ "$oldkey" != "" ]; then
export LOCKBOX_INTERACTIVE=yes
- export LOCKBOX_KEYMODE=interactive
+ export LOCKBOX_KEYMODE=ask
export LOCKBOX_KEY=""
else
printf "password: "
