Rename kssh config file

Author: ddworken

README.md

@@ -168,7 +168,7 @@ client config file is how kssh determines which teams are using kssh and the nee
 channel name, the name of the bot, etc). When keybaseca stops, it deletes all of the client config files. 
 
 kssh reads the client config file in order to determine how to interact with a bot. kssh does not have any user controlled
-configuration. It does have one local config file stored in `~/.ssh/kssh.config` that is used to store a few settings 
+configuration. It does have one local config file stored in `~/.ssh/kssh-config.json` that is used to store a few settings 
 for kssh. By default, this config file is not used. It is only created and meant to be interacted with via the 
 `--set-default-bot`, `--clear-default-bot`, `--set-default-user`, `--clear-default-user` flags. 
 

src/cmd/kssh/kssh.go

@@ -283,11 +283,20 @@ func provisionNewKey(config kssh.ConfigFile, keyPath string) error {
 // Run SSH with the given key. Calls os.Exit and does not return.
 func runSSHWithKey(keyPath string, remainingArgs []string) {
 	// Create a config file for the default user if necessary
-	useConfig, err := kssh.CreateDefaultUserConfigFile()
+	useConfig := false
+	user, err := kssh.GetDefaultSSHUser()
 	if err != nil {
-		fmt.Printf("Failed to set default user: %v\n", err)
+		fmt.Printf("Failed to retrieve default SSH user: %v\n", err)
 		os.Exit(1)
 	}
+	if user != "" {
+		useConfig = true
+		err = kssh.CreateDefaultUserConfigFile()
+		if err != nil {
+			fmt.Printf("Failed to set default user: %v\n", err)
+			os.Exit(1)
+		}
+	}
 
 	// Add the key to the ssh-agent in case we are doing multiple connections (eg via the `-J` flag)
 	err = kssh.AddKeyToSSHAgent(keyPath)

src/cmd/kssh/kssh_test.go

@@ -46,7 +46,7 @@ func TestIsValidCert(t *testing.T) {
 }
 
 func BenchmarkLoadConfigs(b *testing.B) {
-	os.Remove("~/.ssh/kssh.config")
+	os.Remove("~/.ssh/kssh-config.json")
 	b.ResetTimer()
 
 	for n := 0; n < b.N; n++ {

src/kssh/config.go

@@ -113,7 +113,7 @@ type LocalConfigFile struct {
 }
 
 // Where to store the local config file. Just stash it in ~/.ssh
-var localConfigFileLocation = shared.ExpandPathWithTilde("~/.ssh/kssh.config")
+var localConfigFileLocation = shared.ExpandPathWithTilde("~/.ssh/kssh-config.json")
 
 func GetDefaultSSHUser() (string, error) {
 	lcf, err := getCurrentConfig()

src/kssh/ssh.go

@@ -20,44 +20,45 @@ func AddKeyToSSHAgent(keyPath string) error {
 
 var AlternateSSHConfigFile = shared.ExpandPathWithTilde("~/.ssh/kssh-config")
 
-func CreateDefaultUserConfigFile() (bool, error) {
+// Create an SSH config file that inherits from the default SSH config file but sets a default SSH user
+func CreateDefaultUserConfigFile() error {
 	user, err := GetDefaultSSHUser()
 	if err != nil {
-		return false, err
+		return err
 	}
 	if user == "" {
-		return false, nil
+		return nil
 	}
 
 	err = MakeDotSSH()
 	if err != nil {
-		return false, err
+		return err
 	}
 
 	if _, err := os.Stat(shared.ExpandPathWithTilde("~/.ssh/config")); os.IsNotExist(err) {
 		f, err := os.OpenFile(shared.ExpandPathWithTilde("~/.ssh/config"), os.O_RDONLY|os.O_CREATE, 0644)
 		if err != nil {
-			return false, fmt.Errorf("failed to touch ~/.ssh/config: %v", err)
+			return fmt.Errorf("failed to touch ~/.ssh/config: %v", err)
 		}
 		f.Close()
 	}
 
-	config := fmt.Sprintf("# kssh config file\n"+
+	config := fmt.Sprintf("# kssh config file to set a default SSH user\n"+
 		"Include config\n"+
 		"Host *\n"+
 		"  User %s\n", user)
 
 	f, err := os.OpenFile(AlternateSSHConfigFile, os.O_CREATE|os.O_WRONLY, 0644)
 	if err != nil {
-		return false, err
+		return err
 	}
 	defer f.Close()
 	_, err = f.WriteString(config)
 	if err != nil {
-		return false, err
+		return err
 	}
 	fmt.Printf("Using default ssh user %s\n", user)
-	return true, nil
+	return nil
 }
 
 func MakeDotSSH() error {

tests/tests/lib.py

@@ -91,7 +91,7 @@ def clear_keys():
 def clear_local_config():
     # Clear kssh's local config file
     try:
-        run_command("rm -rf ~/.ssh/kssh.config")
+        run_command("rm -rf ~/.ssh/kssh-config.json")
     except subprocess.CalledProcessError:
         pass