summaryrefslogtreecommitdiff
path: root/internal/ssh/client/authmethods.go
blob: 1a4cb3f36a08fcd12aa9217bbf1ca7e4c21766a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
package client

import (
	"fmt"
	"os"

	"github.com/mimecast/dtail/internal/config"
	"github.com/mimecast/dtail/internal/io/dlog"
	"github.com/mimecast/dtail/internal/ssh"

	gossh "golang.org/x/crypto/ssh"
)

const addedPathStr string = "Added path to list of auth methods, not adding further methods"

// InitSSHAuthMethods initialises all known SSH auth methods on the client side.
func InitSSHAuthMethods(sshAuthMethods []gossh.AuthMethod,
	hostKeyCallback gossh.HostKeyCallback, trustAllHosts bool, throttleCh chan struct{},
	privateKeyPath string, agentKeyIndex int) ([]gossh.AuthMethod, HostKeyCallback) {

	if len(sshAuthMethods) > 0 {
		simpleCallback, err := NewSimpleCallback()
		if err != nil {
			dlog.Client.FatalPanic(err)
		}
		return sshAuthMethods, simpleCallback
	}
	return initKnownHostsAuthMethods(trustAllHosts, throttleCh, privateKeyPath, agentKeyIndex)
}

func initIntegrationTestKnownHostsAuthMethods() []gossh.AuthMethod {
	var sshAuthMethods []gossh.AuthMethod
	privateKeyPath := "./id_rsa"

	GeneratePrivatePublicKeyPairIfNotExists(privateKeyPath, 4096)
	authMethod, err := ssh.PrivateKey(privateKeyPath)
	if err != nil {
		dlog.Client.FatalPanic("Unable to use private SSH key", privateKeyPath, err)
	}

	sshAuthMethods = append(sshAuthMethods, authMethod)
	dlog.Client.Debug("initKnownHostsAuthMethods", addedPathStr, privateKeyPath)
	return sshAuthMethods
}

func initKnownHostsAuthMethods(trustAllHosts bool, throttleCh chan struct{},
	privateKeyPath string, agentKeyIndex int) ([]gossh.AuthMethod, HostKeyCallback) {

	var sshAuthMethods []gossh.AuthMethod
	knownHostsFile := fmt.Sprintf("%s/.ssh/known_hosts", os.Getenv("HOME"))
	if config.Env("DTAIL_INTEGRATION_TEST_RUN_MODE") {
		// In case of integration test, override known hosts file path.
		knownHostsFile = "./known_hosts"
	}

	knownHostsCallback, err := NewKnownHostsCallback(knownHostsFile, trustAllHosts, throttleCh)
	if err != nil {
		dlog.Client.FatalPanic(knownHostsFile, err)
	}
	dlog.Client.Debug("initKnownHostsAuthMethods", "Added known hosts file path", knownHostsFile)

	if config.Env("DTAIL_INTEGRATION_TEST_RUN_MODE") {
		return initIntegrationTestKnownHostsAuthMethods(), knownHostsCallback
	}

	// Try to read custom private key path.
	if privateKeyPath != "" {
		authMethod, err := ssh.PrivateKey(privateKeyPath)
		if err == nil {
			sshAuthMethods = append(sshAuthMethods, authMethod)
			dlog.Client.Debug("initKnownHostsAuthMethods", addedPathStr, privateKeyPath)
			return sshAuthMethods, knownHostsCallback
		}
		dlog.Client.FatalPanic("Unable to use private SSH key", privateKeyPath, err)
	}

	// Second, try SSH Agent
	authMethod, err := ssh.AgentWithKeyIndex(agentKeyIndex)
	if err == nil {
		sshAuthMethods = append(sshAuthMethods, authMethod)
		dlog.Client.Debug("initKnownHostsAuthMethods", "Added SSH Agent (SSH_AUTH_SOCK)"+
			"to list of auth methods, not adding further methods")
		return sshAuthMethods, knownHostsCallback
	}
	dlog.Client.Debug("initKnownHostsAuthMethods", "Unable to init SSH Agent auth method", err)

	// Third, try Linux/UNIX default key paths
	privateKeyPath = os.Getenv("HOME") + "/.ssh/id_rsa"
	authMethod, err = ssh.PrivateKey(privateKeyPath)
	if err == nil {
		sshAuthMethods = append(sshAuthMethods, authMethod)
		dlog.Client.Debug("initKnownHostsAuthmethods", addedPathStr, privateKeyPath)
		return sshAuthMethods, knownHostsCallback
	}
	dlog.Client.Debug("initKnownHostsAuthMethods", "Unable to use private key", privateKeyPath, err)

	privateKeyPath = os.Getenv("HOME") + "/.ssh/id_dsa"
	authMethod, err = ssh.PrivateKey(privateKeyPath)
	if err == nil {
		sshAuthMethods = append(sshAuthMethods, authMethod)
		dlog.Client.Debug("initKnownHostsAuthmethods", addedPathStr, privateKeyPath)
		return sshAuthMethods, knownHostsCallback
	}

	privateKeyPath = os.Getenv("HOME") + "/.ssh/id_ecdsa"
	authMethod, err = ssh.PrivateKey(privateKeyPath)
	if err == nil {
		sshAuthMethods = append(sshAuthMethods, authMethod)
		dlog.Client.Debug("initKnownHostsAuthmethods", addedPathStr, privateKeyPath)
		return sshAuthMethods, knownHostsCallback
	}

	dlog.Client.FatalPanic("Unable to find private SSH key information", privateKeyPath, err)
	// Never reach this point.
	return sshAuthMethods, knownHostsCallback
}