Files
teleport/api/utils/sshutils/conn.go
T
rosstimothy 9f094aaef6 Add tracing instrumentation for ssh clients/servers (#12434)
* Add tracing instrumentation for ssh clients/servers

Add tracing context to the existing ProxyHelloSignature to provide
span information across ssh connections. To add span context per
ssh session on top of new connections, the same tracing context is
passed in the first global request of the session.

In order to ensure that tracing context is pulled from and inserted
into the proper context.Context, some interfaces and methods were
changed to take one as the first argument.
2022-05-25 12:24:02 +00:00

104 lines
3.1 KiB
Go

/*
Copyright 2021 Gravitational, Inc.
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 sshutils
import (
"bytes"
"encoding/json"
"fmt"
"io"
"github.com/gravitational/teleport/api/constants"
"github.com/gravitational/teleport/api/types"
"github.com/gravitational/trace"
"golang.org/x/crypto/ssh"
)
// ConnectProxyTransport opens a channel over the remote tunnel and connects
// to the requested host.
func ConnectProxyTransport(sconn ssh.Conn, req *DialReq, exclusive bool) (*ChConn, bool, error) {
if err := req.CheckAndSetDefaults(); err != nil {
return nil, false, trace.Wrap(err)
}
payload, err := json.Marshal(req)
if err != nil {
return nil, false, trace.Wrap(err)
}
channel, discard, err := sconn.OpenChannel(constants.ChanTransport, nil)
if err != nil {
return nil, false, trace.Wrap(err)
}
// DiscardRequests will return when the channel or underlying connection is closed.
go ssh.DiscardRequests(discard)
// Send a special SSH out-of-band request called "teleport-transport"
// the agent on the other side will create a new TCP/IP connection to
// 'addr' on its network and will start proxying that connection over
// this SSH channel.
ok, err := channel.SendRequest(constants.ChanTransportDialReq, true, payload)
if err != nil {
return nil, true, trace.Wrap(err)
}
if !ok {
defer channel.Close()
// Pull the error message from the tunnel client (remote cluster)
// passed to us via stderr.
errMessageBytes, _ := io.ReadAll(channel.Stderr())
errMessage := string(bytes.TrimSpace(errMessageBytes))
if len(errMessage) == 0 {
errMessage = fmt.Sprintf("failed connecting to %v [%v]", req.Address, req.ServerID)
}
return nil, false, trace.Errorf(errMessage)
}
if exclusive {
return NewExclusiveChConn(sconn, channel), false, nil
}
return NewChConn(sconn, channel), false, nil
}
// DialReq is a request for the address to connect to. Supports special
// non-resolvable addresses and search names if connection over a tunnel.
type DialReq struct {
// Address is the target host to make a connection to.
Address string `json:"address,omitempty"`
// ServerID is the hostUUID.clusterName of the node. ServerID is used when
// dialing through a tunnel to SSH and application nodes.
ServerID string `json:"server_id,omitempty"`
// ConnType is the type of connection requested, either node or application.
ConnType types.TunnelType `json:"conn_type"`
}
// CheckAndSetDefaults verifies all the values are valid.
func (d *DialReq) CheckAndSetDefaults() error {
if d.ConnType == "" {
d.ConnType = types.NodeTunnel
}
if d.Address == "" && d.ServerID == "" {
return trace.BadParameter("serverID or address required")
}
return nil
}