aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/golang.org/x/crypto/ssh/client.go
blob: c97f2978e8f6c61a771d0e36ddc5ab8f9daf6758 (plain) (blame)
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
// Copyright 2011 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package ssh

import (
    "errors"
    "fmt"
    "net"
    "sync"
    "time"
)

// Client implements a traditional SSH client that supports shells,
// subprocesses, port forwarding and tunneled dialing.
type Client struct {
    Conn

    forwards        forwardList // forwarded tcpip connections from the remote side
    mu              sync.Mutex
    channelHandlers map[string]chan NewChannel
}

// HandleChannelOpen returns a channel on which NewChannel requests
// for the given type are sent. If the type already is being handled,
// nil is returned. The channel is closed when the connection is closed.
func (c *Client) HandleChannelOpen(channelType string) <-chan NewChannel {
    c.mu.Lock()
    defer c.mu.Unlock()
    if c.channelHandlers == nil {
        // The SSH channel has been closed.
        c := make(chan NewChannel)
        close(c)
        return c
    }

    ch := c.channelHandlers[channelType]
    if ch != nil {
        return nil
    }

    ch = make(chan NewChannel, chanSize)
    c.channelHandlers[channelType] = ch
    return ch
}

// NewClient creates a Client on top of the given connection.
func NewClient(c Conn, chans <-chan NewChannel, reqs <-chan *Request) *Client {
    conn := &Client{
        Conn:            c,
        channelHandlers: make(map[string]chan NewChannel, 1),
    }

    go conn.handleGlobalRequests(reqs)
    go conn.handleChannelOpens(chans)
    go func() {
        conn.Wait()
        conn.forwards.closeAll()
    }()
    go conn.forwards.handleChannels(conn.HandleChannelOpen("forwarded-tcpip"))
    return conn
}

// NewClientConn establishes an authenticated SSH connection using c
// as the underlying transport.  The Request and NewChannel channels
// must be serviced or the connection will hang.
func NewClientConn(c net.Conn, addr string, config *ClientConfig) (Conn, <-chan NewChannel, <-chan *Request, error) {
    fullConf := *config
    fullConf.SetDefaults()
    conn := &connection{
        sshConn: sshConn{conn: c},
    }

    if err := conn.clientHandshake(addr, &fullConf); err != nil {
        c.Close()
        return nil, nil, nil, fmt.Errorf("ssh: handshake failed: %v", err)
    }
    conn.mux = newMux(conn.transport)
    return conn, conn.mux.incomingChannels, conn.mux.incomingRequests, nil
}

// clientHandshake performs the client side key exchange. See RFC 4253 Section
// 7.
func (c *connection) clientHandshake(dialAddress string, config *ClientConfig) error {
    if config.ClientVersion != "" {
        c.clientVersion = []byte(config.ClientVersion)
    } else {
        c.clientVersion = []byte(packageVersion)
    }
    var err error
    c.serverVersion, err = exchangeVersions(c.sshConn.conn, c.clientVersion)
    if err != nil {
        return err
    }

    c.transport = newClientTransport(
        newTransport(c.sshConn.conn, config.Rand, true /* is client */),
        c.clientVersion, c.serverVersion, config, dialAddress, c.sshConn.RemoteAddr())
    if err := c.transport.waitSession(); err != nil {
        return err
    }

    c.sessionID = c.transport.getSessionID()
    return c.clientAuthenticate(config)
}

// verifyHostKeySignature verifies the host key obtained in the key
// exchange.
func verifyHostKeySignature(hostKey PublicKey, result *kexResult) error {
    sig, rest, ok := parseSignatureBody(result.Signature)
    if len(rest) > 0 || !ok {
        return errors.New("ssh: signature parse error")
    }

    return hostKey.Verify(result.H, sig)
}

// NewSession opens a new Session for this client. (A session is a remote
// execution of a program.)
func (c *Client) NewSession() (*Session, error) {
    ch, in, err := c.OpenChannel("session", nil)
    if err != nil {
        return nil, err
    }
    return newSession(ch, in)
}

func (c *Client) handleGlobalRequests(incoming <-chan *Request) {
    for r := range incoming {
        // This handles keepalive messages and matches
        // the behaviour of OpenSSH.
        r.Reply(false, nil)
    }
}

// handleChannelOpens channel open messages from the remote side.
func (c *Client) handleChannelOpens(in <-chan NewChannel) {
    for ch := range in {
        c.mu.Lock()
        handler := c.channelHandlers[ch.ChannelType()]
        c.mu.Unlock()

        if handler != nil {
            handler <- ch
        } else {
            ch.Reject(UnknownChannelType, fmt.Sprintf("unknown channel type: %v", ch.ChannelType()))
        }
    }

    c.mu.Lock()
    for _, ch := range c.channelHandlers {
        close(ch)
    }
    c.channelHandlers = nil
    c.mu.Unlock()
}

// Dial starts a client connection to the given SSH server. It is a
// convenience function that connects to the given network address,
// initiates the SSH handshake, and then sets up a Client.  For access
// to incoming channels and requests, use net.Dial with NewClientConn
// instead.
func Dial(network, addr string, config *ClientConfig) (*Client, error) {
    conn, err := net.DialTimeout(network, addr, config.Timeout)
    if err != nil {
        return nil, err
    }
    c, chans, reqs, err := NewClientConn(conn, addr, config)
    if err != nil {
        return nil, err
    }
    return NewClient(c, chans, reqs), nil
}

// A ClientConfig structure is used to configure a Client. It must not be
// modified after having been passed to an SSH function.
type ClientConfig struct {
    // Config contains configuration that is shared between clients and
    // servers.
    Config

    // User contains the username to authenticate as.
    User string

    // Auth contains possible authentication methods to use with the
    // server. Only the first instance of a particular RFC 4252 method will
    // be used during authentication.
    Auth []AuthMethod

    // HostKeyCallback, if not nil, is called during the cryptographic
    // handshake to validate the server's host key. A nil HostKeyCallback
    // implies that all host keys are accepted.
    HostKeyCallback func(hostname string, remote net.Addr, key PublicKey) error

    // ClientVersion contains the version identification string that will
    // be used for the connection. If empty, a reasonable default is used.
    ClientVersion string

    // HostKeyAlgorithms lists the key types that the client will
    // accept from the server as host key, in order of
    // preference. If empty, a reasonable default is used. Any
    // string returned from PublicKey.Type method may be used, or
    // any of the CertAlgoXxxx and KeyAlgoXxxx constants.
    HostKeyAlgorithms []string

    // Timeout is the maximum amount of time for the TCP connection to establish.
    //
    // A Timeout of zero means no timeout.
    Timeout time.Duration
}