The repository connections required ssh-agent (#90)

There is an issue in previous release where the application would ignore
any private key file path and simply rely on the ssh-agent to
authentiate to a private key repository.  This has now been fixed and
the application will now use a private key file specified in the
configuration or passed via the command line.

If there is no private key file specified, the application will fallback
to using the ssh-agent.  If the ssh-agent is not running, the
application will generate an error.

fixes #69

Author: privateip

docs/configuration-reference.md

@@ -142,6 +142,34 @@ messages to any desired timezone.
 
 The default value for `timestamp_timezone` is `utc`
 
+### Git settings
+
+Whenw working with git repositories, there are some global settings that should
+be configured.  This section provides a configuration settings for setting
+global git options.
+
+#### `name`
+
+Configures the name to use when making commits using git.  The name configured
+here will be displayed in the commit message.
+
+The default value for `name` is `null`
+
+#### `email`
+
+Configures the email address to use when making git commits.  The email address
+will be used in commit messages.
+
+The default value for `email` is `null`
+
+#### `user`
+
+Sets the default user to use when connecting to a git repository over SSH.
+Most git server implementations require this value to be `git` which is the
+default; however it can be changed here if needed.
+
+The default value for `user` is `git`.
+
 ### Profiles
 
 Profiles provide server specific configuration settings for working with

internal/runners/repository.go

@@ -79,10 +79,11 @@ func (r Repository) Clone() (string, error) {
 	logger.Trace()
 
 	repo := repositories.Repository{
-		Url: r.Url,
+		Url:  r.Url,
+		User: "git",
 	}
 	if r.PrivateKeyFile != "" {
-		pk, err := utils.ReadStringFromFile(r.PrivateKeyFile)
+		pk, err := utils.ReadFromFile(r.PrivateKeyFile)
 		if err != nil {
 			return "", err
 		}

pkg/config/config.go

@@ -37,6 +37,7 @@ const (
 
 	defaultGitName  = ""
 	defaultGitEmail = ""
+	defaultGitUser  = "git"
 )
 
 type Config struct {
@@ -69,6 +70,7 @@ type Config struct {
 	// Git settings
 	GitName  string `json:"git_name"`
 	GitEmail string `json:"git_email"`
+	GitUser  string `json:"git_user"`
 }
 
 func NewConfig(defaults map[string]interface{}, envBinding map[string]string, appWorkingDir, sysConfigPath, fileName string) *Config {
@@ -200,6 +202,7 @@ func (ac *Config) populateFields() {
 
 	ac.GitName = viper.GetString("git.name")
 	ac.GitEmail = viper.GetString("git.email")
+	ac.GitUser = viper.GetString("git.user")
 }
 
 var defaultValues = map[string]interface{}{
@@ -221,6 +224,7 @@ var defaultValues = map[string]interface{}{
 
 	"git.name":  defaultGitName,
 	"git.email": defaultGitEmail,
+	"git.user":  defaultGitUser,
 }
 
 var defaultEnvVarBindings = map[string]string{
@@ -242,6 +246,7 @@ var defaultEnvVarBindings = map[string]string{
 
 	"git.name":  "IPCTL_GIT_NAME",
 	"git.email": "IPCTL_GIT_EMAIL",
+	"git.user":  "IPCTL_GIT_USER",
 }
 
 // getConfigFileFromFlag reads in the file passed in using the --config flag on the cli

pkg/repositories/repository.go

@@ -11,14 +11,17 @@ import (
 
 	"github.com/go-git/go-git/v5"
 	"github.com/go-git/go-git/v5/plumbing"
+	gitssh "github.com/go-git/go-git/v5/plumbing/transport/ssh"
 	"github.com/itential/ipctl/pkg/logger"
 	giturls "github.com/whilp/git-urls"
+	"golang.org/x/crypto/ssh"
 )
 
 type Repository struct {
 	Url        string
 	Reference  string
-	PrivateKey string
+	User       string
+	PrivateKey []byte
 }
 
 func (r Repository) Clone() (string, error) {
@@ -36,7 +39,23 @@ func (r Repository) Clone() (string, error) {
 
 	cloneOptions := &git.CloneOptions{
 		URL: r.Url,
-		//Auth: r.PrivateKey,
+	}
+
+	if r.PrivateKey != nil {
+		logger.Debug("setting up auth using private key")
+
+		signer, err := ssh.ParsePrivateKey(r.PrivateKey)
+		if err != nil {
+			return "", err
+		}
+
+		cloneOptions.Auth = &gitssh.PublicKeys{
+			User:   r.User,
+			Signer: signer,
+			HostKeyCallbackHelper: gitssh.HostKeyCallbackHelper{
+				HostKeyCallback: ssh.InsecureIgnoreHostKey(),
+			},
+		}
 	}
 
 	// Git will default to main/master if no repo is specified