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 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
|
// Package easyssh provides a simple implementation of some SSH protocol
// features in Go. You can simply run a command on a remote server or get a file
// even simpler than native console SSH client. You don't need to think about
// Dials, sessions, defers, or public keys... Let easyssh think about it!
package easyssh
import (
"bufio"
"fmt"
"io"
"log"
"net"
"os"
"path/filepath"
"sync"
"time"
"github.com/ScaleFT/sshkeys"
"golang.org/x/crypto/ssh"
"golang.org/x/crypto/ssh/agent"
)
var defaultTimeout = 60 * time.Second
type Protocol string
const (
PROTOCOL_TCP Protocol = "tcp"
PROTOCOL_TCP4 Protocol = "tcp4"
PROTOCOL_TCP6 Protocol = "tcp6"
)
type (
// MakeConfig Contains main authority information.
// User field should be a name of user on remote server (ex. john in ssh john@example.com).
// Server field should be a remote machine address (ex. example.com in ssh john@example.com)
// Key is a path to private key on your local machine.
// Port is SSH server port on remote machine.
// Note: easyssh looking for private key in user's home directory (ex. /home/john + Key).
// Then ensure your Key begins from '/' (ex. /.ssh/id_rsa)
MakeConfig struct {
User string
Server string
Key string
KeyPath string
Port string
Protocol Protocol
Passphrase string
Password string
Timeout time.Duration
Proxy DefaultConfig
Ciphers []string
KeyExchanges []string
Fingerprint string
// Enable the use of insecure ciphers and key exchange methods.
// This enables the use of the the following insecure ciphers and key exchange methods:
// - aes128-cbc
// - aes192-cbc
// - aes256-cbc
// - 3des-cbc
// - diffie-hellman-group-exchange-sha256
// - diffie-hellman-group-exchange-sha1
// Those algorithms are insecure and may allow plaintext data to be recovered by an attacker.
UseInsecureCipher bool
// RequestPty requests a pseudo-terminal from the server.
RequestPty bool
}
// DefaultConfig for ssh proxy config
DefaultConfig struct {
User string
Server string
Key string
KeyPath string
Port string
Protocol Protocol
Passphrase string
Password string
Timeout time.Duration
Ciphers []string
KeyExchanges []string
Fingerprint string
// Enable the use of insecure ciphers and key exchange methods.
// This enables the use of the the following insecure ciphers and key exchange methods:
// - aes128-cbc
// - aes192-cbc
// - aes256-cbc
// - 3des-cbc
// - diffie-hellman-group-exchange-sha256
// - diffie-hellman-group-exchange-sha1
// Those algorithms are insecure and may allow plaintext data to be recovered by an attacker.
UseInsecureCipher bool
}
)
// returns ssh.Signer from user you running app home path + cutted key path.
// (ex. pubkey,err := getKeyFile("/.ssh/id_rsa") )
func getKeyFile(keypath, passphrase string) (ssh.Signer, error) {
var pubkey ssh.Signer
var err error
buf, err := os.ReadFile(keypath)
if err != nil {
return nil, err
}
if passphrase != "" {
pubkey, err = sshkeys.ParseEncryptedPrivateKey(buf, []byte(passphrase))
} else {
pubkey, err = ssh.ParsePrivateKey(buf)
}
if err != nil {
return nil, err
}
return pubkey, nil
}
// returns *ssh.ClientConfig and io.Closer.
// if io.Closer is not nil, io.Closer.Close() should be called when
// *ssh.ClientConfig is no longer used.
func getSSHConfig(config DefaultConfig) (*ssh.ClientConfig, io.Closer) {
var sshAgent io.Closer
// auths holds the detected ssh auth methods
auths := []ssh.AuthMethod{}
// figure out what auths are requested, what is supported
if config.Password != "" {
auths = append(auths, ssh.Password(config.Password))
}
if config.KeyPath != "" {
if pubkey, err := getKeyFile(config.KeyPath, config.Passphrase); err != nil {
log.Printf("getKeyFile error: %v\n", err)
} else {
auths = append(auths, ssh.PublicKeys(pubkey))
}
}
if config.Key != "" {
var signer ssh.Signer
var err error
if config.Passphrase != "" {
signer, err = sshkeys.ParseEncryptedPrivateKey([]byte(config.Key), []byte(config.Passphrase))
} else {
signer, err = ssh.ParsePrivateKey([]byte(config.Key))
}
if err != nil {
log.Printf("ssh.ParsePrivateKey: %v\n", err)
} else {
auths = append(auths, ssh.PublicKeys(signer))
}
}
if sshAgent, err := net.Dial("unix", os.Getenv("SSH_AUTH_SOCK")); err == nil {
auths = append(auths, ssh.PublicKeysCallback(agent.NewClient(sshAgent).Signers))
}
c := ssh.Config{}
if config.UseInsecureCipher {
c.SetDefaults()
c.Ciphers = append(c.Ciphers, "aes128-cbc", "aes192-cbc", "aes256-cbc", "3des-cbc")
c.KeyExchanges = append(c.KeyExchanges, "diffie-hellman-group-exchange-sha1", "diffie-hellman-group-exchange-sha256")
}
if len(config.Ciphers) > 0 {
c.Ciphers = append(c.Ciphers, config.Ciphers...)
}
if len(config.KeyExchanges) > 0 {
c.KeyExchanges = append(c.KeyExchanges, config.KeyExchanges...)
}
hostKeyCallback := ssh.InsecureIgnoreHostKey()
if config.Fingerprint != "" {
hostKeyCallback = func(hostname string, remote net.Addr, publicKey ssh.PublicKey) error {
if ssh.FingerprintSHA256(publicKey) != config.Fingerprint {
return fmt.Errorf("ssh: host key fingerprint mismatch")
}
return nil
}
}
return &ssh.ClientConfig{
Config: c,
Timeout: config.Timeout,
User: config.User,
Auth: auths,
HostKeyCallback: hostKeyCallback,
}, sshAgent
}
// Connect to remote server using MakeConfig struct and returns *ssh.Session
func (ssh_conf *MakeConfig) Connect() (*ssh.Session, *ssh.Client, error) {
var client *ssh.Client
var err error
// Default protocol is: tcp.
if ssh_conf.Protocol == "" {
ssh_conf.Protocol = PROTOCOL_TCP
}
if ssh_conf.Proxy.Protocol == "" {
ssh_conf.Proxy.Protocol = PROTOCOL_TCP
}
targetConfig, closer := getSSHConfig(DefaultConfig{
User: ssh_conf.User,
Key: ssh_conf.Key,
KeyPath: ssh_conf.KeyPath,
Passphrase: ssh_conf.Passphrase,
Password: ssh_conf.Password,
Timeout: ssh_conf.Timeout,
Ciphers: ssh_conf.Ciphers,
KeyExchanges: ssh_conf.KeyExchanges,
Fingerprint: ssh_conf.Fingerprint,
UseInsecureCipher: ssh_conf.UseInsecureCipher,
})
if closer != nil {
defer closer.Close()
}
// Enable proxy command
if ssh_conf.Proxy.Server != "" {
proxyConfig, closer := getSSHConfig(DefaultConfig{
User: ssh_conf.Proxy.User,
Key: ssh_conf.Proxy.Key,
KeyPath: ssh_conf.Proxy.KeyPath,
Passphrase: ssh_conf.Proxy.Passphrase,
Password: ssh_conf.Proxy.Password,
Timeout: ssh_conf.Proxy.Timeout,
Ciphers: ssh_conf.Proxy.Ciphers,
KeyExchanges: ssh_conf.Proxy.KeyExchanges,
Fingerprint: ssh_conf.Proxy.Fingerprint,
UseInsecureCipher: ssh_conf.Proxy.UseInsecureCipher,
})
if closer != nil {
defer closer.Close()
}
proxyClient, err := ssh.Dial(string(ssh_conf.Proxy.Protocol), net.JoinHostPort(ssh_conf.Proxy.Server, ssh_conf.Proxy.Port), proxyConfig)
if err != nil {
return nil, nil, err
}
conn, err := proxyClient.Dial(string(ssh_conf.Protocol), net.JoinHostPort(ssh_conf.Server, ssh_conf.Port))
if err != nil {
return nil, nil, err
}
ncc, chans, reqs, err := ssh.NewClientConn(conn, net.JoinHostPort(ssh_conf.Server, ssh_conf.Port), targetConfig)
if err != nil {
return nil, nil, err
}
client = ssh.NewClient(ncc, chans, reqs)
} else {
client, err = ssh.Dial(string(ssh_conf.Protocol), net.JoinHostPort(ssh_conf.Server, ssh_conf.Port), targetConfig)
if err != nil {
return nil, nil, err
}
}
session, err := client.NewSession()
if err != nil {
return nil, nil, err
}
// Request a pseudo-terminal if this option is set
if ssh_conf.RequestPty {
modes := ssh.TerminalModes{
ssh.ECHO: 0, // disable echoing
ssh.TTY_OP_ISPEED: 14400, // input speed = 14.4kbaud
ssh.TTY_OP_OSPEED: 14400, // output speed = 14.4kbaud
}
if err := session.RequestPty("xterm", 80, 40, modes); err != nil {
session.Close()
return nil, nil, err
}
}
return session, client, nil
}
// Stream returns one channel that combines the stdout and stderr of the command
// as it is run on the remote machine, and another that sends true when the
// command is done. The sessions and channels will then be closed.
func (ssh_conf *MakeConfig) Stream(command string, timeout ...time.Duration) (<-chan string, <-chan string, <-chan bool, <-chan error, error) {
// continuously send the command's output over the channel
stdoutChan := make(chan string)
stderrChan := make(chan string)
doneChan := make(chan bool)
errChan := make(chan error)
// connect to remote host
session, client, err := ssh_conf.Connect()
if err != nil {
return stdoutChan, stderrChan, doneChan, errChan, err
}
// defer session.Close()
// connect to both outputs (they are of type io.Reader)
outReader, err := session.StdoutPipe()
if err != nil {
client.Close()
session.Close()
return stdoutChan, stderrChan, doneChan, errChan, err
}
errReader, err := session.StderrPipe()
if err != nil {
client.Close()
session.Close()
return stdoutChan, stderrChan, doneChan, errChan, err
}
err = session.Start(command)
if err != nil {
client.Close()
session.Close()
return stdoutChan, stderrChan, doneChan, errChan, err
}
// combine outputs, create a line-by-line scanner
stdoutReader := io.MultiReader(outReader)
stderrReader := io.MultiReader(errReader)
stdoutScanner := bufio.NewScanner(stdoutReader)
stderrScanner := bufio.NewScanner(stderrReader)
go func(stdoutScanner, stderrScanner *bufio.Scanner, stdoutChan, stderrChan chan string, doneChan chan bool, errChan chan error) {
defer close(doneChan)
defer close(errChan)
defer client.Close()
defer session.Close()
// default timeout value
executeTimeout := defaultTimeout
if len(timeout) > 0 {
executeTimeout = timeout[0]
}
timeoutChan := time.After(executeTimeout)
res := make(chan struct{}, 1)
var resWg sync.WaitGroup
resWg.Add(2)
go func() {
defer close(stdoutChan)
for stdoutScanner.Scan() {
stdoutChan <- stdoutScanner.Text()
}
resWg.Done()
}()
go func() {
defer close(stderrChan)
for stderrScanner.Scan() {
stderrChan <- stderrScanner.Text()
}
resWg.Done()
}()
go func() {
resWg.Wait()
// close all of our open resources
res <- struct{}{}
}()
select {
case <-res:
errChan <- session.Wait()
doneChan <- true
case <-timeoutChan:
errChan <- fmt.Errorf("Run Command Timeout")
doneChan <- false
}
}(stdoutScanner, stderrScanner, stdoutChan, stderrChan, doneChan, errChan)
return stdoutChan, stderrChan, doneChan, errChan, err
}
// Run command on remote machine and returns its stdout as a string
func (ssh_conf *MakeConfig) Run(command string, timeout ...time.Duration) (outStr string, errStr string, isTimeout bool, err error) {
stdoutChan, stderrChan, doneChan, errChan, err := ssh_conf.Stream(command, timeout...)
if err != nil {
return outStr, errStr, isTimeout, err
}
// read from the output channel until the done signal is passed
loop:
for {
select {
case isTimeout = <-doneChan:
break loop
case outline, ok := <-stdoutChan:
if !ok {
stdoutChan = nil
}
if outline != "" {
outStr += outline + "\n"
}
case errline, ok := <-stderrChan:
if !ok {
stderrChan = nil
}
if errline != "" {
errStr += errline + "\n"
}
case err = <-errChan:
}
}
// return the concatenation of all signals from the output channel
return outStr, errStr, isTimeout, err
}
// WriteFile reads size bytes from the reader and writes them to a file on the remote machine
func (ssh_conf *MakeConfig) WriteFile(reader io.Reader, size int64, etargetFile string) error {
session, client, err := ssh_conf.Connect()
if err != nil {
return err
}
defer client.Close()
defer session.Close()
targetFile := filepath.Base(etargetFile)
w, err := session.StdinPipe()
if err != nil {
return err
}
copyF := func() error {
_, err := fmt.Fprintln(w, "C0644", size, targetFile)
if err != nil {
return err
}
if size > 0 {
_, err = io.Copy(w, reader)
if err != nil {
return err
}
}
_, err = fmt.Fprint(w, "\x00")
if err != nil {
return err
}
return nil
}
copyErrC := make(chan error, 1)
go func() {
defer w.Close()
copyErrC <- copyF()
}()
err = session.Run(fmt.Sprintf("scp -tr %s", etargetFile))
if err != nil {
return err
}
err = <-copyErrC
return err
}
// Scp uploads sourceFile to remote machine like native scp console app.
func (ssh_conf *MakeConfig) Scp(sourceFile string, etargetFile string) error {
session, client, err := ssh_conf.Connect()
if err != nil {
return err
}
defer client.Close()
defer session.Close()
src, srcErr := os.Open(sourceFile)
if srcErr != nil {
return srcErr
}
defer src.Close()
srcStat, statErr := src.Stat()
if statErr != nil {
return statErr
}
return ssh_conf.WriteFile(src, srcStat.Size(), etargetFile)
}
|