-
Notifications
You must be signed in to change notification settings - Fork 363
/
ssh.go
71 lines (64 loc) · 2.35 KB
/
ssh.go
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
// Copyright 2019 Antrea Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package exec
import (
"bytes"
"fmt"
"strings"
"golang.org/x/crypto/ssh"
)
// RunSSHCommand runs the provided SSH command on the specified host. Returns the exit code of the
// command, along with the contents of stdout and stderr as strings. Note that if the command
// returns a non-zero error code, this function does not report it as an error.
func RunSSHCommand(host string, config *ssh.ClientConfig, cmd string, envs map[string]string, stdin string, sudo bool) (
code int, stdout, stderr string, err error) {
client, err := ssh.Dial("tcp", host, config)
if err != nil {
return 0, "", "", fmt.Errorf("cannot establish SSH connection to host: %v", err)
}
session, err := client.NewSession()
if err != nil {
return 0, "", "", fmt.Errorf("cannot create SSH session: %v", err)
}
defer session.Close()
// Set environment variables.
for e, v := range envs {
// Session.Setenv() requires that the remote host's sshd configuration accepts
// environment variables set by clients. So, just pre-appending environment
// variables to the command.
cmd = e + "='" + v + "' " + cmd
}
if sudo {
cmd = "sudo " + cmd
}
var stdoutB, stderrB bytes.Buffer
session.Stdout = &stdoutB
session.Stderr = &stderrB
if stdin != "" {
session.Stdin = strings.NewReader(stdin)
}
if err := session.Run(cmd); err != nil {
switch e := err.(type) {
case *ssh.ExitMissingError:
return 0, "", "", fmt.Errorf("did not get an exit status for SSH command: %v", e)
case *ssh.ExitError:
// SSH operation successful, but command returned error code
return e.ExitStatus(), stdoutB.String(), stderrB.String(), nil
default:
return 0, "", "", fmt.Errorf("unknown error when executing SSH command: %v", err)
}
}
// command is successful
return 0, stdoutB.String(), stderrB.String(), nil
}