add godoc

internal/ssh/ssh.go

@@ -93,34 +93,36 @@ func directTCPIPHandler(resolver Resolver) func(srv *ssh.Server, conn *gossh.Ser
 			return
 		}
 
-		dChan, reqs, err := client.OpenChannel("direct-tcpip", gossh.Marshal(d))
+		dstChan, reqs, err := client.OpenChannel("direct-tcpip", gossh.Marshal(d))
 		if err != nil {
 			rejectConnectionAndLogError(ctx, newChan, "Failed to open destination channel", err)
 			return
 		}
-
+		// gossh.Request are requests sent outside of the normal stream of data (ex. pty-req for an interactive session).
+		// Since we only need the raw data to redirect, we can discard them.
 		go gossh.DiscardRequests(reqs)
 
-		ch, reqs, err := newChan.Accept()
+		srcDest, reqs, err := newChan.Accept()
 		if err != nil {
-			dChan.Close()
+			dstChan.Close()
 			return
 		}
-
+		// gossh.Request are requests sent outside of the normal stream of data (ex. pty-req for an interactive session).
+		// Since we only need the raw data to redirect, we can discard them.
 		go gossh.DiscardRequests(reqs)
 
 		go func() {
-			defer ch.Close()
-			defer dChan.Close()
-			_, err := io.Copy(ch, dChan)
+			defer srcDest.Close()
+			defer dstChan.Close()
+			_, err := io.Copy(srcDest, dstChan)
 			if err != nil {
 				rejectConnectionAndLogError(ctx, newChan, "Failed to copy data from src to dts", err)
 			}
 		}()
 		go func() {
-			defer ch.Close()
-			defer dChan.Close()
-			_, err := io.Copy(dChan, ch)
+			defer srcDest.Close()
+			defer dstChan.Close()
+			_, err := io.Copy(dstChan, srcDest)
 			if err != nil {
 				rejectConnectionAndLogError(ctx, newChan, "Failed to copy data from dst to src", err)
 			}

internal/ssh/ssh_test.go

@@ -116,7 +116,7 @@ func (s *sshSuite) TestSSHJump(c *qt.C) {
 		SrcPort:  0,
 	}
 	s.testInDestinationServerF = func(fm ssh.ForwardMessage) {
-		c.Assert(fm.DestAddr, qt.Equals, "model1")
+		c.Check(fm.DestAddr, qt.Equals, "model1")
 	}
 	ch, _, err := client.OpenChannel("direct-tcpip", gossh.Marshal(&msg))
 	c.Check(err, qt.IsNil)
@@ -159,7 +159,7 @@ func (s *sshSuite) TestSSHFinalDestinationDialFail(c *qt.C) {
 		SrcPort:  0,
 	}
 	s.testInDestinationServerF = func(fm ssh.ForwardMessage) {
-		c.Assert(fm.DestAddr, qt.Equals, "model1")
+		c.Check(fm.DestAddr, qt.Equals, "model1")
 	}
 	_, _, err = client.OpenChannel("direct-tcpip", gossh.Marshal(&msg))
 	c.Assert(err, qt.ErrorMatches, ".*connect failed.*")