Add hidden/undocumented/untested option to configure keybase binary for kssh

Author: ddworken

src/cmd/keybaseca/keybaseca.go

@@ -12,6 +12,8 @@ import (
 	"sync"
 	"syscall"
 
+	"github.com/keybase/bot-ssh-ca/src/keybaseca/constants"
+
 	"github.com/google/uuid"
 
 	"github.com/keybase/bot-ssh-ca/src/keybaseca/bot"
@@ -192,7 +194,7 @@ func signAction(c *cli.Context) error {
 func mainAction(c *cli.Context) error {
 	switch {
 	case c.Bool("wipe-all-configs"):
-		teams, err := shared.KBFSList("/keybase/team/")
+		teams, err := constants.GetDefaultKBFSOperationsStruct().KBFSList("/keybase/team/")
 		if err != nil {
 			return err
 		}
@@ -206,9 +208,9 @@ func mainAction(c *cli.Context) error {
 				boundChan <- 0
 
 				filename := fmt.Sprintf("/keybase/team/%s/%s", team, shared.ConfigFilename)
-				exists, _ := shared.KBFSFileExists(filename)
+				exists, _ := constants.GetDefaultKBFSOperationsStruct().KBFSFileExists(filename)
 				if exists {
-					err = shared.KBFSDelete(filename)
+					err = constants.GetDefaultKBFSOperationsStruct().KBFSDelete(filename)
 					if err != nil {
 						fmt.Printf("%v\n", err)
 					}
@@ -227,7 +229,7 @@ func mainAction(c *cli.Context) error {
 		}
 		logLocation := conf.GetLogLocation()
 		if strings.HasPrefix(logLocation, "/keybase/") {
-			err = shared.KBFSDelete(logLocation)
+			err = constants.GetDefaultKBFSOperationsStruct().KBFSDelete(logLocation)
 			if err != nil {
 				return fmt.Errorf("Failed to delete log file at %s: %v", logLocation, err)
 			}
@@ -272,7 +274,7 @@ func writeClientConfig(conf config.Config) error {
 			return err
 		}
 
-		err = shared.KBFSWrite(filename, string(content), false)
+		err = constants.GetDefaultKBFSOperationsStruct().KBFSWrite(filename, string(content), false)
 		if err != nil {
 			return err
 		}
@@ -292,7 +294,7 @@ func deleteClientConfig(conf config.Config) error {
 
 	for _, team := range teams {
 		filename := filepath.Join("/keybase/team/", team, shared.ConfigFilename)
-		err := shared.KBFSDelete(filename)
+		err := constants.GetDefaultKBFSOperationsStruct().KBFSDelete(filename)
 		if err != nil {
 			return err
 		}

src/keybaseca/config/config.go

@@ -6,6 +6,8 @@ import (
 	"os"
 	"strings"
 
+	"github.com/keybase/bot-ssh-ca/src/keybaseca/constants"
+
 	"github.com/keybase/bot-ssh-ca/src/keybaseca/botwrapper"
 
 	"github.com/keybase/bot-ssh-ca/src/shared"
@@ -89,17 +91,17 @@ func validateChannel(conf Config, teamName string, channelName string) error {
 func validatePath(path string) error {
 	if strings.HasPrefix(path, "/keybase/") {
 		// If it exists it is valid
-		exists, _ := shared.KBFSFileExists(path)
+		exists, _ := constants.GetDefaultKBFSOperationsStruct().KBFSFileExists(path)
 		if exists {
 			return nil
 		}
 
 		// Otherwise try to write to it
-		err := shared.KBFSWrite(path, "", false)
+		err := constants.GetDefaultKBFSOperationsStruct().KBFSWrite(path, "", false)
 		if err != nil {
 			return fmt.Errorf("path is not writable: %v", err)
 		}
-		shared.KBFSDelete(path)
+		constants.GetDefaultKBFSOperationsStruct().KBFSDelete(path)
 		return nil
 	}
 	_, err := os.Stat(path)

src/keybaseca/constants/kbfs.go

@@ -0,0 +1,9 @@
+package constants
+
+import "github.com/keybase/bot-ssh-ca/src/shared"
+
+// Get the default KBFSOperation struct used for KBFS operations. Currently keybaseca does not support running with a
+// custom keybase binary path
+func GetDefaultKBFSOperationsStruct() *shared.KBFSOperation {
+	return &shared.KBFSOperation{KeybaseBinaryPath: "keybase"}
+}

src/keybaseca/log/log.go

@@ -6,8 +6,9 @@ import (
 	"strings"
 	"time"
 
+	"github.com/keybase/bot-ssh-ca/src/keybaseca/constants"
+
 	"github.com/keybase/bot-ssh-ca/src/keybaseca/config"
-	"github.com/keybase/bot-ssh-ca/src/shared"
 )
 
 // Log attempts to log the given string to a file. If conf.GetStrictLogging() it will panic if it fails
@@ -33,7 +34,7 @@ func Log(conf config.Config, str string) {
 // the local filesystem
 func appendToFile(filename string, str string) error {
 	if strings.HasPrefix(filename, "/keybase/") {
-		return shared.KBFSWrite(filename, str, true)
+		return constants.GetDefaultKBFSOperationsStruct().KBFSWrite(filename, str, true)
 	}
 	f, err := os.OpenFile(filename, os.O_APPEND|os.O_WRONLY|os.O_CREATE, 0600)
 	if err != nil {

src/kssh/bot.go

@@ -14,7 +14,7 @@ import (
 func GetSignedKey(config ConfigFile, request shared.SignatureRequest) (shared.SignatureResponse, error) {
 	empty := shared.SignatureResponse{}
 
-	runOptions := kbchat.RunOptions{KeybaseLocation: "keybase"}
+	runOptions := kbchat.RunOptions{KeybaseLocation: GetKeybaseBinaryPath()}
 	kbc, err := kbchat.Start(runOptions)
 	if err != nil {
 		return empty, fmt.Errorf("error starting Keybase chat: %v", err)

src/kssh/config.go

@@ -23,7 +23,7 @@ type ConfigFile struct {
 // Both lists are deduplicated based on ConfigFile.BotName. Runs the KBFS operations in parallel
 // to speed up loading configs.
 func LoadConfigs() ([]ConfigFile, []string, error) {
-	allTeamsFromKBFS, err := shared.KBFSList("/keybase/team/")
+	allTeamsFromKBFS, err := GetKBFSOperationsStruct().KBFSList("/keybase/team/")
 	if err != nil {
 		return nil, nil, fmt.Errorf("failed to load config file(s): %v", err)
 	}
@@ -41,7 +41,7 @@ func LoadConfigs() ([]ConfigFile, []string, error) {
 			boundChan <- 0
 
 			filename := fmt.Sprintf("/keybase/team/%s/%s", team, shared.ConfigFilename)
-			exists, err := shared.KBFSFileExists(filename)
+			exists, err := GetKBFSOperationsStruct().KBFSFileExists(filename)
 			if err != nil {
 				// Treat an error as it not existing and just skip that team while searching for config files
 				exists = false
@@ -89,7 +89,7 @@ func LoadConfig(kbfsFilename string) (ConfigFile, error) {
 	if !strings.HasPrefix(kbfsFilename, "/keybase/") {
 		return cf, fmt.Errorf("cannot load a kssh config from outside of KBFS")
 	}
-	bytes, err := shared.KBFSRead(kbfsFilename)
+	bytes, err := GetKBFSOperationsStruct().KBFSRead(kbfsFilename)
 	if err != nil {
 		return cf, fmt.Errorf("found a config file at %s that could not be read: %v", kbfsFilename, err)
 	}
@@ -117,6 +117,23 @@ type LocalConfigFile struct {
 	DefaultBotName string `json:"default_bot"`
 	DefaultBotTeam string `json:"default_team"`
 	DefaultSSHUser string `json:"default_ssh_user"`
+	KeybaseBinPath string `json:"keybase_binary"`
+}
+
+func GetKeybaseBinaryPath() string {
+	lcf, err := getCurrentConfig()
+	if err != nil {
+		return "keybase"
+	}
+
+	if lcf.KeybaseBinPath != "" {
+		return lcf.KeybaseBinPath
+	}
+	return "keybase"
+}
+
+func GetKBFSOperationsStruct() *shared.KBFSOperation {
+	return &shared.KBFSOperation{KeybaseBinaryPath: GetKeybaseBinaryPath()}
 }
 
 // Where to store the local config file. Just stash it in ~/.ssh rather than making a ~/.kssh folder

src/shared/kbfs.go

@@ -22,8 +22,12 @@ func supportsFuse() bool {
 	return err1 == nil && err2 == nil && err3 == nil && err4 == nil
 }
 
+type KBFSOperation struct {
+	KeybaseBinaryPath string
+}
+
 // Returns whether the given KBFS file exists
-func KBFSFileExists(kbfsFilename string) (bool, error) {
+func (ko *KBFSOperation) KBFSFileExists(kbfsFilename string) (bool, error) {
 	if supportsFuse() {
 		// Note that this code is not tested via integration tests since fuse does not run in docker. Handle with care.
 		_, err := os.Stat(kbfsFilename)
@@ -36,7 +40,7 @@ func KBFSFileExists(kbfsFilename string) (bool, error) {
 		return false, err
 	}
 
-	cmd := exec.Command("keybase", "fs", "stat", kbfsFilename)
+	cmd := exec.Command(ko.KeybaseBinaryPath, "fs", "stat", kbfsFilename)
 	bytes, err := cmd.CombinedOutput()
 	if err == nil {
 		return true, nil
@@ -48,12 +52,12 @@ func KBFSFileExists(kbfsFilename string) (bool, error) {
 }
 
 // Reads the specified KBFS file into a byte array
-func KBFSRead(kbfsFilename string) ([]byte, error) {
+func (ko *KBFSOperation) KBFSRead(kbfsFilename string) ([]byte, error) {
 	if supportsFuse() {
 		// Note that this code is not tested via integration tests since fuse does not run in docker. Handle with care.
 		return ioutil.ReadFile(kbfsFilename)
 	}
-	cmd := exec.Command("keybase", "fs", "read", kbfsFilename)
+	cmd := exec.Command(ko.KeybaseBinaryPath, "fs", "read", kbfsFilename)
 	bytes, err := cmd.CombinedOutput()
 	if err != nil {
 		return nil, fmt.Errorf("failed to read %s: %s (%v)", kbfsFilename, strings.TrimSpace(string(bytes)), err)
@@ -62,8 +66,8 @@ func KBFSRead(kbfsFilename string) ([]byte, error) {
 }
 
 // Delete the specified KBFS file
-func KBFSDelete(filename string) error {
-	cmd := exec.Command("keybase", "fs", "rm", filename)
+func (ko *KBFSOperation) KBFSDelete(filename string) error {
+	cmd := exec.Command(ko.KeybaseBinaryPath, "fs", "rm", filename)
 	bytes, err := cmd.CombinedOutput()
 	if err != nil {
 		return fmt.Errorf("failed to delete the file at %s: %s (%v)", filename, strings.TrimSpace(string(bytes)), err)
@@ -73,20 +77,20 @@ func KBFSDelete(filename string) error {
 
 // Write contents to the specified KBFS file. If appendToFile, appends onto the end of the file. Otherwise, overwrites
 // and truncates the file.
-func KBFSWrite(filename string, contents string, appendToFile bool) error {
+func (ko *KBFSOperation) KBFSWrite(filename string, contents string, appendToFile bool) error {
 	var cmd *exec.Cmd
 	if appendToFile {
 		// `keybase fs write --append` only works if the file already exists so create it if it does not exist
-		exists, err := KBFSFileExists(filename)
+		exists, err := ko.KBFSFileExists(filename)
 		if !exists || err != nil {
-			err = KBFSWrite(filename, "", false)
+			err = ko.KBFSWrite(filename, "", false)
 			if err != nil {
 				return err
 			}
 		}
-		cmd = exec.Command("keybase", "fs", "write", "--append", filename)
+		cmd = exec.Command(ko.KeybaseBinaryPath, "fs", "write", "--append", filename)
 	} else {
-		cmd = exec.Command("keybase", "fs", "write", filename)
+		cmd = exec.Command(ko.KeybaseBinaryPath, "fs", "write", filename)
 	}
 
 	cmd.Stdin = strings.NewReader(string(contents))
@@ -98,8 +102,8 @@ func KBFSWrite(filename string, contents string, appendToFile bool) error {
 }
 
 // List KBFS files in the given KBFS path
-func KBFSList(path string) ([]string, error) {
-	cmd := exec.Command("keybase", "fs", "ls", "-1", "--nocolor", path)
+func (ko *KBFSOperation) KBFSList(path string) ([]string, error) {
+	cmd := exec.Command(ko.KeybaseBinaryPath, "fs", "ls", "-1", "--nocolor", path)
 	output, err := cmd.CombinedOutput()
 	if err != nil {
 		return nil, fmt.Errorf("failed to list files in /keybase/team/: %s (%v)", strings.TrimSpace(string(output)), err)