forked from gravitational/teleport
-
Notifications
You must be signed in to change notification settings - Fork 0
/
server.go
434 lines (375 loc) · 12.1 KB
/
server.go
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
422
423
424
425
426
427
428
429
430
431
432
433
434
/*
Copyright 2015 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.
This file contains the implementatino of sshutils.Server class.
It is the underlying "base SSH server" for everything in Teleport.
*/
package sshutils
import (
"bytes"
"crypto/subtle"
"encoding/json"
"fmt"
"io"
"net"
"time"
"github.com/gravitational/teleport"
"github.com/gravitational/teleport/lib/defaults"
"github.com/gravitational/teleport/lib/limiter"
"github.com/gravitational/teleport/lib/utils"
log "github.com/Sirupsen/logrus"
"github.com/gravitational/trace"
"golang.org/x/crypto/ssh"
)
// Server is a generic implementation of an SSH server. All Teleport
// services (auth, proxy, ssh) use this as a base to accept SSH connections.
type Server struct {
// component is a name of the facility which uses this server,
// used for logging/debugging. typically it's "proxy" or "auth api", etc
component string
// addr is the address this server binds to and listens on
addr utils.NetAddr
// listener is usually the listening TCP/IP socket
listener net.Listener
// closeC channel is used to stop the server by closing it
closeC chan struct{}
newChanHandler NewChanHandler
reqHandler RequestHandler
cfg ssh.ServerConfig
limiter *limiter.Limiter
askedToClose bool
}
const (
// SSHVersionPrefix is the prefix of "server version" string which begins
// every SSH handshake. It MUST start with "SSH-2.0" according to
// https://tools.ietf.org/html/rfc4253#page-4
SSHVersionPrefix = "SSH-2.0-Teleport"
// ProxyHelloSignature is a string which Teleport proxy will send
// right after the initial SSH "handshake/version" message if it detects
// talking to a Teleport server.
ProxyHelloSignature = "Teleport-Proxy"
// MaxVersionStringBytes is the maximum number of bytes allowed for a
// SSH version string
// https://tools.ietf.org/html/rfc4253
MaxVersionStringBytes = 255
// TrueClientAddrVar environment variable is used by the web UI to pass
// the remote IP (user's IP) from the browser/HTTP session into an SSH session
TrueClientAddrVar = "TELEPORT_CLIENT_ADDR"
)
// ServerOption is a functional argument for server
type ServerOption func(cfg *Server) error
func SetLimiter(limiter *limiter.Limiter) ServerOption {
return func(s *Server) error {
s.limiter = limiter
return nil
}
}
func NewServer(
component string,
a utils.NetAddr,
h NewChanHandler,
hostSigners []ssh.Signer,
ah AuthMethods,
opts ...ServerOption) (*Server, error) {
err := checkArguments(a, h, hostSigners, ah)
if err != nil {
return nil, err
}
s := &Server{
component: component,
addr: a,
newChanHandler: h,
closeC: make(chan struct{}),
}
s.limiter, err = limiter.NewLimiter(limiter.LimiterConfig{})
if err != nil {
return nil, trace.Wrap(err)
}
for _, o := range opts {
if err := o(s); err != nil {
return nil, err
}
}
for _, signer := range hostSigners {
(&s.cfg).AddHostKey(signer)
}
s.cfg.PublicKeyCallback = ah.PublicKey
s.cfg.PasswordCallback = ah.Password
s.cfg.NoClientAuth = ah.NoClient
// Teleport SSH server will be sending the following "version string" during
// SSH handshake (example): "SSH-2.0-T eleport 1.5.1-beta" (space is important!)
s.cfg.ServerVersion = fmt.Sprintf("%s %s", SSHVersionPrefix, teleport.Version)
return s, nil
}
func SetSSHConfig(cfg ssh.ServerConfig) ServerOption {
return func(s *Server) error {
s.cfg = cfg
return nil
}
}
func SetRequestHandler(req RequestHandler) ServerOption {
return func(s *Server) error {
s.reqHandler = req
return nil
}
}
func (s *Server) Addr() string {
return s.listener.Addr().String()
}
func (s *Server) Start() error {
s.askedToClose = false
socket, err := net.Listen(s.addr.AddrNetwork, s.addr.Addr)
if err != nil {
return err
}
s.listener = socket
log.Infof("[SSH:%s] listening socket: %v", s.component, socket.Addr())
go s.acceptConnections()
return nil
}
func (s *Server) notifyClosed() {
close(s.closeC)
}
func (s *Server) Wait() {
<-s.closeC
}
// Close closes listening socket and stops accepting connections
func (s *Server) Close() error {
s.askedToClose = true
if s.listener != nil {
return s.listener.Close()
}
return nil
}
func (s *Server) acceptConnections() {
defer s.notifyClosed()
addr := s.Addr()
log.Infof("[SSH:%v] is listening on %v", s.component, addr)
for {
conn, err := s.listener.Accept()
if err != nil {
if s.askedToClose {
log.Infof("[SSH:%v] server %v exited", s.component, addr)
s.askedToClose = false
return
}
// our best shot to avoid excessive logging
if op, ok := err.(*net.OpError); ok && !op.Timeout() {
log.Debugf("[SSH:%v] closed socket %v", s.component, op)
return
}
log.Errorf("SSH:%v accept error: %T %v", s.component, err, err)
return
}
go s.handleConnection(conn)
}
}
// handleConnection is called every time an SSH server accepts a new
// connection from a client.
//
// this is the foundation of all SSH connections in Teleport (between clients
// and proxies, proxies and servers, servers and auth, etc).
//
func (s *Server) handleConnection(conn net.Conn) {
// initiate an SSH connection, note that we don't need to close the conn here
// in case of error as ssh server takes care of this
remoteAddr, _, err := net.SplitHostPort(conn.RemoteAddr().String())
if err != nil {
log.Errorf(err.Error())
}
if err := s.limiter.AcquireConnection(remoteAddr); err != nil {
log.Errorf(err.Error())
conn.Close()
return
}
defer s.limiter.ReleaseConnection(remoteAddr)
// apply idle read/write timeout to this connection.
conn = utils.ObeyIdleTimeout(conn,
defaults.DefaultIdleConnectionDuration,
s.component)
// create a new SSH server which handles the handshake (and pass the custom
// payload structure which will be populated only when/if this connection
// comes from another Teleport proxy):
sconn, chans, reqs, err := ssh.NewServerConn(wrapConnection(conn), &s.cfg)
if err != nil {
conn.SetDeadline(time.Time{})
return
}
user := sconn.User()
if err := s.limiter.RegisterRequest(user); err != nil {
log.Errorf(err.Error())
sconn.Close()
conn.Close()
return
}
// Connection successfully initiated
log.Infof("[SSH:%v] new connection %v -> %v vesion: %v",
s.component, sconn.RemoteAddr(), sconn.LocalAddr(), string(sconn.ClientVersion()))
// will be called when the connection is closed
connClosed := func() {
log.Infof("[SSH:%v] closed connection", s.component)
}
// The keepalive ticket will ensure that SSH keepalive requests are being sent
// to the client at an interval much shorter than idle connection kill switch
keepAliveTick := time.NewTicker(defaults.DefaultIdleConnectionDuration / 3)
defer keepAliveTick.Stop()
keepAlivePayload := [8]byte{0}
for {
select {
// handle out of band ssh requests
case req := <-reqs:
if req == nil {
connClosed()
return
}
log.Infof("[SSH:%v] recieved out-of-band request: %+v", s.component, req)
if s.reqHandler != nil {
go s.reqHandler.HandleRequest(req)
}
// handle channels:
case nch := <-chans:
if nch == nil {
connClosed()
return
}
go s.newChanHandler.HandleNewChan(conn, sconn, nch)
// send keepalive pings to the clients
case <-keepAliveTick.C:
const wantReply = true
sconn.SendRequest(teleport.KeepAliveReqType, wantReply, keepAlivePayload[:])
}
}
}
type RequestHandler interface {
HandleRequest(r *ssh.Request)
}
type RequestHandlerFunc func(*ssh.Request)
func (f RequestHandlerFunc) HandleRequest(r *ssh.Request) {
f(r)
}
type NewChanHandler interface {
HandleNewChan(net.Conn, *ssh.ServerConn, ssh.NewChannel)
}
type NewChanHandlerFunc func(net.Conn, *ssh.ServerConn, ssh.NewChannel)
func (f NewChanHandlerFunc) HandleNewChan(conn net.Conn, sshConn *ssh.ServerConn, ch ssh.NewChannel) {
f(conn, sshConn, ch)
}
type AuthMethods struct {
PublicKey PublicKeyFunc
Password PasswordFunc
NoClient bool
}
func checkArguments(a utils.NetAddr, h NewChanHandler, hostSigners []ssh.Signer, ah AuthMethods) error {
if a.Addr == "" || a.AddrNetwork == "" {
return trace.BadParameter("addr: specify network and the address for listening socket")
}
if h == nil {
return trace.BadParameter("missing NewChanHandler")
}
if len(hostSigners) == 0 {
return trace.BadParameter("need at least one signer")
}
for _, s := range hostSigners {
if s == nil {
return trace.BadParameter("host signer can not be nil")
}
}
if ah.PublicKey == nil && ah.Password == nil && ah.NoClient == false {
return trace.BadParameter("need at least one auth method")
}
return nil
}
type PublicKeyFunc func(conn ssh.ConnMetadata, key ssh.PublicKey) (*ssh.Permissions, error)
type PasswordFunc func(conn ssh.ConnMetadata, password []byte) (*ssh.Permissions, error)
// KeysEqual is constant time compare of the keys to avoid timing attacks
func KeysEqual(ak, bk ssh.PublicKey) bool {
a := ssh.Marshal(ak)
b := ssh.Marshal(bk)
return (len(a) == len(b) && subtle.ConstantTimeCompare(a, b) == 1)
}
// HandshakePayload structure is sent as a JSON blob by the teleport
// proxy to every SSH server who identifies itself as Teleport server
//
// It allows teleport proxies to communicate additional data to server
type HandshakePayload struct {
// ClientAddr is the IP address of the remote client
ClientAddr string `json:"clientAddr,omitempty"`
}
// connectionWrapper allows the SSH server to perform custom handshake which
// lets teleport proxy servers to relay a true remote client IP address
// to the SSH server.
//
// (otherwise connection.RemoteAddr (client IP) will always point to a proxy IP
// instead of oa true client IP)
type connectionWrapper struct {
net.Conn
// upstreamReader reads from the underlying (wrapped) connection
upstreamReader io.Reader
// clientAddr points to the true client address (client is behind
// a proxy). Keeping this address is the entire point of the
// connection wrapper.
clientAddr net.Addr
}
// RemoteAddr returns the behind-the-proxy client address
func (c *connectionWrapper) RemoteAddr() net.Addr {
return c.clientAddr
}
// Read implements io.Read() part of net.Connection which allows us
// peek at the beginning of SSH handshake (that's why we're wrapping the connection)
func (c *connectionWrapper) Read(b []byte) (int, error) {
// handshake already took place, forward upstream:
if c.upstreamReader != nil {
return c.upstreamReader.Read(b)
}
// inspect the client's hello message and see if it's a teleport
// proxy connecting?
buff := make([]byte, MaxVersionStringBytes)
n, err := c.Conn.Read(buff)
if err != nil {
log.Error(err)
return n, err
}
// chop off extra unused bytes at the end of the buffer:
buff = buff[:n]
var skip = 0
// are we reading from a Teleport proxy?
if bytes.HasPrefix(buff, []byte(ProxyHelloSignature)) {
// the JSON paylaod ends with a binary zero:
payloadBoundary := bytes.IndexByte(buff, 0x00)
if payloadBoundary > 0 {
var hp HandshakePayload
payload := buff[len(ProxyHelloSignature):payloadBoundary]
if err = json.Unmarshal(payload, &hp); err != nil {
log.Error(err)
} else {
ca, err := utils.ParseAddr(hp.ClientAddr)
if err != nil {
log.Error(err)
} else {
// replace proxy's client addr with a real client address
// we just got from the custom payload:
c.clientAddr = ca
}
}
skip = payloadBoundary + 1
}
}
c.upstreamReader = io.MultiReader(bytes.NewBuffer(buff[skip:]), c.Conn)
return c.upstreamReader.Read(b)
}
// wrapConnection takes a network connection, wraps it into connectionWrapper
// object (which overrides Read method) and returns the wrapper.
func wrapConnection(conn net.Conn) net.Conn {
return &connectionWrapper{
Conn: conn,
clientAddr: conn.RemoteAddr(),
}
}