add migrate command to sshproxyctl

Author: cyrilst

README.asciidoc

@@ -143,6 +143,9 @@ Version 2 brings a lot of changes to sshproxy:
     connection to the destination. If the command does not return 0, the
     connection is aborted
 2. command line interface:
+  - `sshproxyctl convert` has been added: it converts your old v1
+    configuration file to the v2 format. Can be used like this:
+    `sshproxyctl -c /etc/sshproxy/sshproxy.old.yaml convert > /etc/sshproxy/sshproxy.new.yaml`
   - in all the tables, `Host` and `Port` columns are now merged into a single
     `Host:Port`
   - `sshproxyctl get_config` has been removed and replaced by

cmd/sshproxy/sshproxy.go

@@ -46,7 +46,7 @@ var log = logging.MustGetLogger("sshproxy")
 
 type etcdChecker struct {
 	LastState     utils.State
-	checkInterval utils.Duration
+	checkInterval time.Duration
 	cli           *utils.Client
 }
 
@@ -68,7 +68,7 @@ func (c *etcdChecker) Check(hostport string) bool {
 		c.LastState = c.doCheck(hostport)
 	case host.State == utils.Disabled:
 		c.LastState = host.State
-	case ts.Sub(host.Ts) > c.checkInterval.Duration():
+	case ts.Sub(host.Ts) > c.checkInterval:
 		c.LastState = c.doCheck(hostport)
 	default:
 		c.LastState = host.State
@@ -478,7 +478,7 @@ func mainExitCode() int {
 
 	var recorder *Recorder
 	if config.Dump != "" {
-		recorder = NewRecorder(conninfo, config.Dump, doCmd, config.EtcdStatsInterval.Duration(), config.LogStatsInterval.Duration(), config.DumpLimitSize, config.DumpLimitWindow.Duration())
+		recorder = NewRecorder(conninfo, config.Dump, doCmd, config.EtcdStatsInterval, config.LogStatsInterval, config.DumpLimitSize, config.DumpLimitWindow)
 
 		wg.Add(1)
 		go func() {

cmd/sshproxyctl/sshproxyctl.go

@@ -601,6 +601,7 @@ The commands are:
   forget        forget a host/error_banner in etcd
   disable       disable a host in etcd
   error_banner  set the error banner in etcd
+  convert       displays the config, converted from v1 to v2
 
 The common options are:
 `, os.Args[0])
@@ -728,6 +729,20 @@ The options are:
 	return fs
 }
 
+func newConvertParser() *flag.FlagSet {
+	fs := flag.NewFlagSet("convert", flag.ExitOnError)
+	fs.Usage = func() {
+		fmt.Fprintf(flag.CommandLine.Output(), `Usage: %s convert
+
+Show configuration converted from v1 to v2 and exit.
+Should be used like this:
+  %s -c %s.old convert > %s.new
+`, os.Args[0], os.Args[0], defaultConfig, defaultConfig)
+		os.Exit(2)
+	}
+	return fs
+}
+
 func getHostPortFromCommandLine(allFlag bool, hostsNodeset string, portsNodeset string, configFile string) ([]string, error) {
 	_, nodesetDlclose, nodesetExpand := nodesets.InitExpander()
 	defer nodesetDlclose()
@@ -875,6 +890,7 @@ func main() {
 		"forget":       newForgetParser(&allFlag, &hostString, &portString),
 		"disable":      newDisableParser(&allFlag, &hostString, &portString),
 		"error_banner": newErrorBannerParser(&expire),
+		"convert":      newConvertParser(),
 	}
 
 	cmd := flag.Arg(0)
@@ -1016,6 +1032,16 @@ func main() {
 			p.Usage()
 		}
 		setErrorBanner(errorBanner, t, *configFile)
+	case "convert":
+		p := parsers[cmd]
+		p.Parse(args)
+		yamlOutput, err := utils.ConvertConfigV1(*configFile)
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "ERROR: %s\n\n", err)
+			usage()
+		}
+		fmt.Println("---")
+		fmt.Print(string(yamlOutput[:]))
 	default:
 		fmt.Fprintf(os.Stderr, "ERROR: unknown command: %s\n\n", cmd)
 		usage()

doc/sshproxyctl.txt

@@ -105,6 +105,9 @@ COMMANDS
 	(host[:port]) is given with the '-source' option, the configuration
 	will be calculated for this specific source.
 
+*convert*::
+	Displays the configuration, converted from v1 to v2.
+
 
 FILES
 -----

pkg/utils/config.go

@@ -41,54 +41,54 @@ var cachedConfig Config
 
 // Config represents the configuration for sshproxy.
 type Config struct {
-	ready                 bool // true when the configuration has already been loaded
-	Nodeset               string
-	Debug                 bool
-	Log                   string
-	CheckInterval         Duration `yaml:"check_interval"`
-	ErrorBanner           string   `yaml:"error_banner"`
-	Dump                  string
-	DumpLimitSize         uint64   `yaml:"dump_limit_size"`
-	DumpLimitWindow       Duration `yaml:"dump_limit_window"`
-	Etcd                  etcdConfig
-	EtcdStatsInterval     Duration `yaml:"etcd_stats_interval"`
-	LogStatsInterval      Duration `yaml:"log_stats_interval"`
-	BlockingCommand       string   `yaml:"blocking_command"`
-	BgCommand             string   `yaml:"bg_command"`
-	SSH                   sshConfig
-	TranslateCommands     map[string]*TranslateCommandConfig `yaml:"translate_commands"`
-	Environment           map[string]string
-	Service               string
-	Dest                  []string
-	RouteSelect           string `yaml:"route_select"`
-	Mode                  string
-	ForceCommand          string `yaml:"force_command"`
-	CommandMustMatch      bool   `yaml:"command_must_match"`
-	EtcdKeyTTL            int64  `yaml:"etcd_keyttl"`
-	MaxConnectionsPerUser int    `yaml:"max_connections_per_user"`
-	Overrides             []subConfig
+	ready                 bool                               // true when the configuration has already been loaded
+	Nodeset               string                             `yaml:",omitempty"`
+	Debug                 bool                               `yaml:",omitempty"`
+	Log                   string                             `yaml:",omitempty"`
+	CheckInterval         time.Duration                      `yaml:"check_interval,omitempty"`
+	ErrorBanner           string                             `yaml:"error_banner,omitempty"`
+	Dump                  string                             `yaml:",omitempty"`
+	DumpLimitSize         uint64                             `yaml:"dump_limit_size,omitempty"`
+	DumpLimitWindow       time.Duration                      `yaml:"dump_limit_window,omitempty"`
+	Etcd                  etcdConfig                         `yaml:",omitempty"`
+	EtcdStatsInterval     time.Duration                      `yaml:"etcd_stats_interval,omitempty"`
+	LogStatsInterval      time.Duration                      `yaml:"log_stats_interval,omitempty"`
+	BlockingCommand       string                             `yaml:"blocking_command,omitempty"`
+	BgCommand             string                             `yaml:"bg_command,omitempty"`
+	SSH                   sshConfig                          `yaml:",omitempty"`
+	TranslateCommands     map[string]*TranslateCommandConfig `yaml:"translate_commands,omitempty"`
+	Environment           map[string]string                  `yaml:",omitempty"`
+	Service               string                             `yaml:",omitempty"`
+	Dest                  []string                           `yaml:",flow,omitempty"`
+	RouteSelect           string                             `yaml:"route_select,omitempty"`
+	Mode                  string                             `yaml:",omitempty"`
+	ForceCommand          string                             `yaml:"force_command,omitempty"`
+	CommandMustMatch      bool                               `yaml:"command_must_match,omitempty"`
+	EtcdKeyTTL            int64                              `yaml:"etcd_keyttl,omitempty"`
+	MaxConnectionsPerUser int                                `yaml:"max_connections_per_user,omitempty"`
+	Overrides             []subConfig                        `yaml:",omitempty"`
 }
 
 // TranslateCommandConfig represents the configuration of a translate_command.
 // SSHArgs is optional. Command is mandatory. DisableDump defaults to false
 type TranslateCommandConfig struct {
 	SSHArgs     []string `yaml:"ssh_args"`
 	Command     string
-	DisableDump bool `yaml:"disable_dump"`
+	DisableDump bool `yaml:"disable_dump,omitempty"`
 }
 
 type sshConfig struct {
-	Exe  string
-	Args []string
+	Exe  string   `yaml:",omitempty"`
+	Args []string `yaml:",flow,omitempty"`
 }
 
 type etcdConfig struct {
-	Endpoints []string
-	TLS       etcdTLSConfig
-	Username  string
-	Password  string
-	KeyTTL    int64
-	Mandatory bool
+	Endpoints []string      `yaml:",flow"`
+	TLS       etcdTLSConfig `yaml:",omitempty"`
+	Username  string        `yaml:",omitempty"`
+	Password  string        `yaml:",omitempty"`
+	KeyTTL    int64         `yaml:",omitempty"`
+	Mandatory bool          `yaml:",omitempty"`
 }
 
 type etcdTLSConfig struct {
@@ -100,30 +100,30 @@ type etcdTLSConfig struct {
 // We use interface{} instead of real type to check if the option was specified
 // or not.
 type subConfig struct {
-	Match                 []map[string][]string
-	Debug                 interface{}
-	Log                   interface{}
-	CheckInterval         interface{} `yaml:"check_interval"`
-	ErrorBanner           interface{} `yaml:"error_banner"`
-	Dump                  interface{}
-	DumpLimitSize         interface{} `yaml:"dump_limit_size"`
-	DumpLimitWindow       interface{} `yaml:"dump_limit_window"`
-	Etcd                  interface{}
-	EtcdStatsInterval     interface{} `yaml:"etcd_stats_interval"`
-	LogStatsInterval      interface{} `yaml:"log_stats_interval"`
-	BlockingCommand       interface{} `yaml:"blocking_command"`
-	BgCommand             interface{} `yaml:"bg_command"`
-	SSH                   interface{}
-	TranslateCommands     map[string]*TranslateCommandConfig `yaml:"translate_commands"`
-	Environment           map[string]string
-	Service               interface{}
-	Dest                  []string
-	RouteSelect           interface{} `yaml:"route_select"`
-	Mode                  interface{}
-	ForceCommand          interface{} `yaml:"force_command"`
-	CommandMustMatch      interface{} `yaml:"command_must_match"`
-	EtcdKeyTTL            interface{} `yaml:"etcd_keyttl"`
-	MaxConnectionsPerUser interface{} `yaml:"max_connections_per_user"`
+	Match                 []map[string][]string              `yaml:",omitempty"`
+	Debug                 interface{}                        `yaml:",omitempty"`
+	Log                   interface{}                        `yaml:",omitempty"`
+	CheckInterval         interface{}                        `yaml:"check_interval,omitempty"`
+	ErrorBanner           interface{}                        `yaml:"error_banner,omitempty"`
+	Dump                  interface{}                        `yaml:",omitempty"`
+	DumpLimitSize         interface{}                        `yaml:"dump_limit_size,omitempty"`
+	DumpLimitWindow       interface{}                        `yaml:"dump_limit_window,omitempty"`
+	Etcd                  interface{}                        `yaml:",omitempty"`
+	EtcdStatsInterval     interface{}                        `yaml:"etcd_stats_interval,omitempty"`
+	LogStatsInterval      interface{}                        `yaml:"log_stats_interval,omitempty"`
+	BlockingCommand       interface{}                        `yaml:"blocking_command,omitempty"`
+	BgCommand             interface{}                        `yaml:"bg_command,omitempty"`
+	SSH                   interface{}                        `yaml:",omitempty"`
+	TranslateCommands     map[string]*TranslateCommandConfig `yaml:"translate_commands,omitempty"`
+	Environment           map[string]string                  `yaml:",omitempty"`
+	Service               interface{}                        `yaml:",omitempty"`
+	Dest                  []string                           `yaml:",flow,omitempty"`
+	RouteSelect           interface{}                        `yaml:"route_select,omitempty"`
+	Mode                  interface{}                        `yaml:",omitempty"`
+	ForceCommand          interface{}                        `yaml:"force_command,omitempty"`
+	CommandMustMatch      interface{}                        `yaml:"command_must_match,omitempty"`
+	EtcdKeyTTL            interface{}                        `yaml:"etcd_keyttl,omitempty"`
+	MaxConnectionsPerUser interface{}                        `yaml:"max_connections_per_user,omitempty"`
 }
 
 // Return slice of strings containing formatted configuration values
@@ -132,14 +132,14 @@ func PrintConfig(config *Config, groups map[string]bool) []string {
 	output = append(output, fmt.Sprintf("groups = %v", groups))
 	output = append(output, fmt.Sprintf("config.debug = %v", config.Debug))
 	output = append(output, fmt.Sprintf("config.log = %s", config.Log))
-	output = append(output, fmt.Sprintf("config.check_interval = %s", config.CheckInterval.Duration()))
+	output = append(output, fmt.Sprintf("config.check_interval = %s", config.CheckInterval))
 	output = append(output, fmt.Sprintf("config.error_banner = %s", config.ErrorBanner))
 	output = append(output, fmt.Sprintf("config.dump = %s", config.Dump))
 	output = append(output, fmt.Sprintf("config.dump_limit_size = %d", config.DumpLimitSize))
-	output = append(output, fmt.Sprintf("config.dump_limit_window = %s", config.DumpLimitWindow.Duration()))
+	output = append(output, fmt.Sprintf("config.dump_limit_window = %s", config.DumpLimitWindow))
 	output = append(output, fmt.Sprintf("config.etcd = %+v", config.Etcd))
-	output = append(output, fmt.Sprintf("config.etcd_stats_interval = %s", config.EtcdStatsInterval.Duration()))
-	output = append(output, fmt.Sprintf("config.log_stats_interval = %s", config.LogStatsInterval.Duration()))
+	output = append(output, fmt.Sprintf("config.etcd_stats_interval = %s", config.EtcdStatsInterval))
+	output = append(output, fmt.Sprintf("config.log_stats_interval = %s", config.LogStatsInterval))
 	output = append(output, fmt.Sprintf("config.blocking_command = %s", config.BlockingCommand))
 	output = append(output, fmt.Sprintf("config.bg_command = %s", config.BgCommand))
 	output = append(output, fmt.Sprintf("config.ssh = %+v", config.SSH))
@@ -169,7 +169,7 @@ func parseSubConfig(config *Config, subconfig *subConfig) error {
 
 	if subconfig.CheckInterval != nil {
 		var err error
-		config.CheckInterval, err = ParseDuration(subconfig.CheckInterval.(string))
+		config.CheckInterval, err = time.ParseDuration(subconfig.CheckInterval.(string))
 		if err != nil {
 			return err
 		}
@@ -189,7 +189,7 @@ func parseSubConfig(config *Config, subconfig *subConfig) error {
 
 	if subconfig.DumpLimitWindow != nil {
 		var err error
-		config.DumpLimitWindow, err = ParseDuration(subconfig.DumpLimitWindow.(string))
+		config.DumpLimitWindow, err = time.ParseDuration(subconfig.DumpLimitWindow.(string))
 		if err != nil {
 			return err
 		}
@@ -201,15 +201,15 @@ func parseSubConfig(config *Config, subconfig *subConfig) error {
 
 	if subconfig.EtcdStatsInterval != nil {
 		var err error
-		config.EtcdStatsInterval, err = ParseDuration(subconfig.EtcdStatsInterval.(string))
+		config.EtcdStatsInterval, err = time.ParseDuration(subconfig.EtcdStatsInterval.(string))
 		if err != nil {
 			return err
 		}
 	}
 
 	if subconfig.LogStatsInterval != nil {
 		var err error
-		config.LogStatsInterval, err = ParseDuration(subconfig.LogStatsInterval.(string))
+		config.LogStatsInterval, err = time.ParseDuration(subconfig.LogStatsInterval.(string))
 		if err != nil {
 			return err
 		}