Merge pull request #36 from sensu-community/feature/secret-option

working secret option that hides default value from option usage message

CHANGELOG.md

@@ -6,6 +6,8 @@ and this project adheres to [Semantic
 Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
+### Added
+- Added support for to designated PluginConfigOptions as Secret. If Secret, the default value for the argument will not be displayed in the usage message. This prevents sensitive values stored in envvars from leaking into the usage message.
 ### Fixed
 - Do not create commandline flag unless Argument is set for PluginConfigOption
 

sensu/gohandler_test.go

@@ -36,6 +36,7 @@ var (
 		Path:      "path1",
 		Shorthand: "d",
 		Usage:     "First argument",
+		Secret:    true,
 	}
 
 	defaultOption2 = PluginConfigOption{

sensu/gomutator_test.go

@@ -33,6 +33,7 @@ var (
 		Path:      "path1",
 		Shorthand: "d",
 		Usage:     "First argument",
+		Secret:    true,
 	}
 
 	mutatorOption2 = PluginConfigOption{

sensu/goplugin.go

@@ -50,6 +50,9 @@ type PluginConfigOption struct {
 
 	// Usage adds help context to the command-line flag.
 	Usage string
+
+	// If secret option do not copy Argument value into Default
+	Secret bool
 }
 
 // PluginConfig defines the base plugin configuration.
@@ -196,6 +199,12 @@ func setupFlag(cmd *cobra.Command, opt *PluginConfigOption) error {
 	default:
 		return fmt.Errorf("invalid input type: %v", kind)
 	}
+	flag := cmd.Flags().Lookup(opt.Argument)
+	// Set empty DefValue string if option is a secret
+	// DefValue is only used for pflag usage message construction
+	if opt.Secret {
+		flag.DefValue = ""
+	}
 	return nil
 }