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
|
package core
import (
"fmt"
"io"
"net"
"os"
"strings"
"sync"
"time"
"github.com/dimonomid/nerdlog/log"
"github.com/juju/errors"
"golang.org/x/crypto/ssh"
"golang.org/x/crypto/ssh/agent"
)
// ShellTransportSSHLib implements ShellTransport over SSH.
type ShellTransportSSHLib struct {
params ShellTransportSSHLibParams
}
var _ ShellTransport = &ShellTransportSSHLib{}
func NewShellTransportSSHLib(params ShellTransportSSHLibParams) *ShellTransportSSHLib {
params.Logger = params.Logger.WithNamespaceAppended("TransportSSHLib")
return &ShellTransportSSHLib{
params: params,
}
}
type ShellTransportSSHLibParams struct {
// SSHKeys specifies paths to ssh keys to try, in the given order, until
// an existing key is found.
SSHKeys []string
ConnDetails ConfigLogStreamShellTransportSSHLib
Logger *log.Logger
}
func (st *ShellTransportSSHLib) Connect(resCh chan<- ShellConnUpdate) {
go st.doConnect(resCh)
}
func (st *ShellTransportSSHLib) makeDebugInfo(message string) *ShellConnDebugInfo {
return &ShellConnDebugInfo{
Message: message,
}
}
func (st *ShellTransportSSHLib) doConnect(
resCh chan<- ShellConnUpdate,
) (res ShellConnResult) {
logger := st.params.Logger
defer func() {
if res.Err != nil {
logger.Errorf("Connection failed: %s", res.Err)
}
resCh <- ShellConnUpdate{
Result: &res,
}
}()
connDetails := st.params.ConnDetails
resCh <- ShellConnUpdate{
DebugInfo: st.makeDebugInfo(fmt.Sprintf(
"Trying to connect using internal ssh library to addr: %s, user: %s",
connDetails.Host.Addr, connDetails.Host.User,
)),
}
var sshClient *ssh.Client
conf, err := st.getClientConfig(resCh, logger, connDetails.Host.User)
if err != nil {
res.Err = errors.Annotatef(err, "getting ssh client for %s", connDetails.Host.User)
return res
}
resCh <- ShellConnUpdate{
DebugInfo: st.makeDebugInfo(fmt.Sprintf("Got client config: %s", conf.Descr)),
}
if connDetails.Jumphost != nil {
logger.Infof("Connecting via jumphost")
// Use jumphost
jumphost, err := st.getJumphostClient(resCh, logger, connDetails.Jumphost)
if err != nil {
logger.Errorf("Jumphost connection failed: %s", err)
res.Err = errors.Annotatef(err, "getting jumphost client")
return res
}
conn, err := dialWithTimeout(jumphost, "tcp", connDetails.Host.Addr, connectionTimeout)
if err != nil {
res.Err = errors.Annotatef(err, conf.Descr)
return res
}
authConn, chans, reqs, err := ssh.NewClientConn(conn, connDetails.Host.Addr, conf.ClientConfig)
if err != nil {
res.Err = errors.Annotatef(err, conf.Descr)
return res
}
sshClient = ssh.NewClient(authConn, chans, reqs)
} else {
logger.Infof("Connecting to %s (%+v)", connDetails.Host.Addr, conf)
var err error
sshClient, err = ssh.Dial("tcp", connDetails.Host.Addr, conf.ClientConfig)
if err != nil {
res.Err = errors.Annotatef(err, conf.Descr)
return res
}
}
shellBin := "/bin/sh"
resCh <- ShellConnUpdate{
DebugInfo: st.makeDebugInfo(fmt.Sprintf("Connected, creating pipes and starting %s", shellBin)),
}
logger.Infof("Connected to %s", connDetails.Host.Addr)
sshSession, err := sshClient.NewSession()
if err != nil {
res.Err = errors.Annotatef(err, conf.Descr)
return res
}
stdinBuf, err := sshSession.StdinPipe()
if err != nil {
res.Err = errors.Annotatef(err, conf.Descr)
return res
}
stdoutBuf, err := sshSession.StdoutPipe()
if err != nil {
res.Err = errors.Annotatef(err, conf.Descr)
return res
}
stderrBuf, err := sshSession.StderrPipe()
if err != nil {
res.Err = errors.Annotatef(err, conf.Descr)
return res
}
err = sshSession.Start(shellBin)
if err != nil {
res.Err = errors.Annotatef(err, conf.Descr)
return res
}
res.Conn = &ShellConnSSH{
sshClient: sshClient,
sshSession: sshSession,
stdinBuf: stdinBuf,
stdoutBuf: stdoutBuf,
stderrBuf: stderrBuf,
}
return res
}
// dialWithTimeout is a hack needed to get a timeout for the ssh client.
// https://stackoverflow.com/questions/31554196/ssh-connection-timeout
//
// It's possible we could accomplish the same thing by using NewClient() with Conn.SetDeadline(), but that requires
// some refactoring.
func dialWithTimeout(client *ssh.Client, protocol, hostAddr string, timeout time.Duration) (net.Conn, error) {
finishedChan := make(chan net.Conn)
errChan := make(chan error)
go func() {
conn, err := client.Dial(protocol, hostAddr)
if err != nil {
errChan <- err
return
}
finishedChan <- conn
}()
select {
case conn := <-finishedChan:
return conn, nil
case err := <-errChan:
return nil, errors.Trace(err)
case <-time.After(connectionTimeout):
// Don't close the connection here since it's reused
return nil, errors.New("ssh client dial timed out")
}
}
type ClientConfigWMeta struct {
// ClientConfig is the actual client config.
ClientConfig *ssh.ClientConfig
// Descr is a human-readable string which is useful to include in any
// error messages about this SSH connection.
Descr string
}
type AuthMethodWMeta struct {
AuthMethod ssh.AuthMethod
// Descr is a human-readable string which is useful to include in any
// error messages about this SSH connection.
Descr string
}
func (st *ShellTransportSSHLib) getClientConfig(resCh chan<- ShellConnUpdate, logger *log.Logger, username string) (*ClientConfigWMeta, error) {
auth, err := st.getSSHAuthMethod(resCh, logger)
if err != nil {
return nil, errors.Trace(err)
}
return &ClientConfigWMeta{
ClientConfig: &ssh.ClientConfig{
User: username,
Auth: []ssh.AuthMethod{auth.AuthMethod},
// TODO: fix it
HostKeyCallback: ssh.InsecureIgnoreHostKey(),
Timeout: connectionTimeout,
},
Descr: auth.Descr,
}, nil
}
var (
sshAuthMethodShared *AuthMethodWMeta
sshAuthMethodSharedMtx sync.Mutex
)
func (st *ShellTransportSSHLib) getSSHAuthMethod(resCh chan<- ShellConnUpdate, logger *log.Logger) (*AuthMethodWMeta, error) {
sshAuthMethodSharedMtx.Lock()
defer sshAuthMethodSharedMtx.Unlock()
if sshAuthMethodShared != nil {
return sshAuthMethodShared, nil
}
// Try ssh-agent first
var sshAgentErr error
sshAuthSock := os.Getenv("SSH_AUTH_SOCK")
if sshAuthSock != "" {
logger.Infof("Trying ssh-agent via SSH_AUTH_SOCK=%s", sshAuthSock)
sshAgent, err := net.Dial("unix", sshAuthSock)
if err != nil {
logger.Infof("Failed to connect to ssh-agent: %s", err.Error())
sshAgentErr = errors.Annotatef(err, "using SSH_AUTH_SOCK env var")
} else {
sshAuthMethodShared = &AuthMethodWMeta{
AuthMethod: ssh.PublicKeysCallback(agent.NewClient(sshAgent).Signers),
Descr: "using ssh-agent",
}
return sshAuthMethodShared, nil
}
} else {
sshAgentErr = errors.Errorf("SSH_AUTH_SOCK env var is empty")
logger.Infof("SSH_AUTH_SOCK not set; skipping ssh-agent")
}
// Fall back to private key
logger.Infof("Fallback to parsing ssh key...")
var keyPath string
var keyData []byte
var errBuilder strings.Builder
for _, keyPath = range st.params.SSHKeys {
var err error
keyData, err = os.ReadFile(keyPath)
if err != nil {
if errBuilder.Len() > 0 {
errBuilder.WriteString(", ")
}
errBuilder.WriteString(fmt.Sprintf("%s: %s", keyPath, err.Error()))
continue
}
// Found the key file.
break
}
if len(keyData) == 0 {
return nil, errors.Errorf(
"failed to read key data from any of the following: %s (%s)",
st.params.SSHKeys,
errBuilder.String(),
)
}
signer, err := ssh.ParsePrivateKey(keyData)
if err != nil {
if _, ok := err.(*ssh.PassphraseMissingError); ok {
// We need a passphrase to decrypt the private key. Request it from
// the client code.
passphraseCh := make(chan string, 1)
resCh <- ShellConnUpdate{
DataRequest: &ShellConnDataRequest{
Title: "SSH key is passphrase-protected",
Message: fmt.Sprintf("Unable to use ssh-agent: %s, falling back to ssh keys.\nPlease enter passphrase for %s.\nAlternatively, use ssh-agent, and make sure the SSH_AUTH_SOCK environment variable is set correctly.\nTo use a different ssh key, provide it with the --ssh-key flag.", sshAgentErr.Error(), keyPath),
DataKind: ShellConnDataKindPassword,
ResponseCh: passphraseCh,
},
}
// Now wait for the client code to provide the passphrase.
//
// TODO: support teardown; as of now, if the user tries to exit the app,
// it'll be stuck on the "Closing connections" stage, until the Ctrl+C is
// pressed.
passphrase := <-passphraseCh
var err error
signer, err = ssh.ParsePrivateKeyWithPassphrase(keyData, []byte(passphrase))
if err != nil {
// Something has failed even with the provided passphrase.
// We don't implement any retries here in case of typos, because the
// whole connection will be retried, and we'll naturally ask for the
// passphrase again.
return nil, errors.Annotatef(err, "parsing private key from %s with the given passphrase", keyPath)
}
} else {
return nil, errors.Annotatef(err, "parsing private key from %s", keyPath)
}
}
logger.Infof("Using private key from %s", keyPath)
sshAuthMethodShared = &AuthMethodWMeta{
AuthMethod: ssh.PublicKeys(signer),
Descr: fmt.Sprintf("using key %s", keyPath),
}
return sshAuthMethodShared, nil
}
var (
jumphostsShared = map[string]*ssh.Client{}
jumphostsSharedMtx sync.Mutex
)
func (st *ShellTransportSSHLib) getJumphostClient(resCh chan<- ShellConnUpdate, logger *log.Logger, jhConfig *ConfigHost) (*ssh.Client, error) {
jumphostsSharedMtx.Lock()
defer jumphostsSharedMtx.Unlock()
key := jhConfig.Key()
jh := jumphostsShared[key]
if jh == nil {
logger.Infof("Connecting to jumphost... %+v", jhConfig)
parts := strings.Split(jhConfig.Addr, ":")
if len(parts) != 2 {
return nil, errors.Errorf("malformed jumphost address %q", jhConfig.Addr)
}
addrs, err := net.LookupHost(parts[0])
if err != nil {
return nil, errors.Trace(err)
}
if len(addrs) != 1 {
return nil, errors.New("Address not found")
}
conf, err := st.getClientConfig(resCh, logger, jhConfig.User)
if err != nil {
return nil, errors.Trace(err)
}
jh, err = ssh.Dial("tcp", jhConfig.Addr, conf.ClientConfig)
if err != nil {
return nil, errors.Trace(err)
}
jumphostsShared[key] = jh
logger.Infof("Jumphost ok")
}
return jh, nil
}
// ShellConnSSH implements ShellConn for SSH.
type ShellConnSSH struct {
sshClient *ssh.Client
sshSession *ssh.Session
stdinBuf io.WriteCloser
stdoutBuf io.Reader
stderrBuf io.Reader
}
var _ ShellConn = &ShellConnSSH{}
func (c *ShellConnSSH) Stdin() io.Writer {
return c.stdinBuf
}
func (c *ShellConnSSH) Stdout() io.Reader {
return c.stdoutBuf
}
func (c *ShellConnSSH) Stderr() io.Reader {
return c.stderrBuf
}
// Close closes underlying SSH connection.
func (c *ShellConnSSH) Close() {
c.stdinBuf.Close()
c.sshSession.Close()
c.sshClient.Close()
}
|