Improve ssh connection debug messages

1) Mention the host and port in the "Connecting..." message.

2) Mention the username in the post-connection handshaking message.

3) If handshaking fails, mention the user, host, and port in the error
   message that will eventually be returned to the user.
This commit is contained in:
Ahmon Dancy 2019-07-16 14:07:53 -07:00
parent 9ebcbe1d60
commit f9db6651b8
1 changed files with 7 additions and 4 deletions

View File

@ -18,6 +18,7 @@ import (
"sync" "sync"
"time" "time"
"github.com/hashicorp/errwrap"
"github.com/hashicorp/terraform/communicator/remote" "github.com/hashicorp/terraform/communicator/remote"
"github.com/hashicorp/terraform/terraform" "github.com/hashicorp/terraform/terraform"
"golang.org/x/crypto/ssh" "golang.org/x/crypto/ssh"
@ -165,7 +166,8 @@ func (c *Communicator) Connect(o terraform.UIOutput) (err error) {
} }
} }
log.Printf("[DEBUG] connecting to TCP connection for SSH") hostAndPort := fmt.Sprintf("%s:%d", c.connInfo.Host, c.connInfo.Port)
log.Printf("[DEBUG] Connecting to %s for SSH", hostAndPort)
c.conn, err = c.config.connection() c.conn, err = c.config.connection()
if err != nil { if err != nil {
// Explicitly set this to the REAL nil. Connection() can return // Explicitly set this to the REAL nil. Connection() can return
@ -180,10 +182,11 @@ func (c *Communicator) Connect(o terraform.UIOutput) (err error) {
return err return err
} }
log.Printf("[DEBUG] handshaking with SSH") log.Printf("[DEBUG] Connection established. Handshaking for user %v", c.connInfo.User)
host := fmt.Sprintf("%s:%d", c.connInfo.Host, c.connInfo.Port) sshConn, sshChan, req, err := ssh.NewClientConn(c.conn, hostAndPort, c.config.config)
sshConn, sshChan, req, err := ssh.NewClientConn(c.conn, host, c.config.config)
if err != nil { if err != nil {
err = errwrap.Wrapf(fmt.Sprintf("SSH authentication failed (%s@%s): {{err}}", c.connInfo.User, hostAndPort), err)
// While in theory this should be a fatal error, some hosts may start // While in theory this should be a fatal error, some hosts may start
// the ssh service before it is properly configured, or before user // the ssh service before it is properly configured, or before user
// authentication data is available. // authentication data is available.