-
Notifications
You must be signed in to change notification settings - Fork 0
/
forwarder.go
1117 lines (1007 loc) · 35.7 KB
/
forwarder.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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Copyright 2018-2019 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 proxy
import (
"context"
"crypto/rand"
"crypto/tls"
"crypto/x509"
"crypto/x509/pkix"
"encoding/pem"
"fmt"
"io/ioutil"
"net"
"net/http"
"net/url"
"os"
"path/filepath"
"strings"
"sync"
"time"
"github.com/gravitational/teleport"
"github.com/gravitational/teleport/lib/auth"
"github.com/gravitational/teleport/lib/defaults"
"github.com/gravitational/teleport/lib/events"
"github.com/gravitational/teleport/lib/httplib"
"github.com/gravitational/teleport/lib/reversetunnel"
"github.com/gravitational/teleport/lib/services"
"github.com/gravitational/teleport/lib/session"
"github.com/gravitational/teleport/lib/srv"
"github.com/gravitational/teleport/lib/sshca"
"github.com/gravitational/teleport/lib/utils"
"github.com/gravitational/oxy/forward"
kubeutils "github.com/gravitational/teleport/lib/kube/utils"
"github.com/gravitational/trace"
"github.com/gravitational/ttlmap"
"github.com/jonboulle/clockwork"
"github.com/julienschmidt/httprouter"
log "github.com/sirupsen/logrus"
"golang.org/x/crypto/ssh"
"k8s.io/apimachinery/pkg/util/httpstream"
"k8s.io/client-go/rest"
"k8s.io/client-go/tools/remotecommand"
"k8s.io/client-go/transport/spdy"
utilexec "k8s.io/client-go/util/exec"
)
// ForwarderConfig specifies configuration for proxy forwarder
type ForwarderConfig struct {
// Tunnel is the teleport reverse tunnel server
Tunnel reversetunnel.Server
// ClusterName is a local cluster name
ClusterName string
// Keygen points to a key generator implementation
Keygen sshca.Authority
// Auth authenticates user
Auth auth.Authorizer
// Client is a proxy client
Client auth.ClientI
// TargetAddr is a target address
TargetAddr string
// DataDir is a data dir to store logs
DataDir string
// Namespace is a namespace of the proxy server (not a K8s namespace)
Namespace string
// AccessPoint is a caching access point to auth server
// for caching common requests to the backend
AccessPoint auth.AccessPoint
// AuditLog is audit log to send events to
AuditLog events.IAuditLog
// ServerID is a unique ID of a proxy server
ServerID string
// ClusterOverride if set, routes all requests
// to the cluster name, used in tests
ClusterOverride string
// Context passes the optional external context
// passing global close to all forwarder operations
Context context.Context
// KubeconfigPath is a path to kubernetes configuration
KubeconfigPath string
// Clock is a server clock, could be overriden in tests
Clock clockwork.Clock
}
// CheckAndSetDefaults checks and sets default values
func (f *ForwarderConfig) CheckAndSetDefaults() error {
if f.Client == nil {
return trace.BadParameter("missing parameter Client")
}
if f.AccessPoint == nil {
return trace.BadParameter("missing parameter AccessPoint")
}
if f.Auth == nil {
return trace.BadParameter("missing parameter Auth")
}
if f.Tunnel == nil {
return trace.BadParameter("missing parameter Tunnel")
}
if f.ClusterName == "" {
return trace.BadParameter("missing parameter LocalCluster")
}
if f.Keygen == nil {
return trace.BadParameter("missing parameter Keygen")
}
if f.DataDir == "" {
return trace.BadParameter("missing parameter DataDir")
}
if f.ServerID == "" {
return trace.BadParameter("missing parameter ServerID")
}
if f.TargetAddr == "" {
f.TargetAddr = teleport.KubeServiceAddr
}
if f.Namespace == "" {
f.Namespace = defaults.Namespace
}
if f.Context == nil {
f.Context = context.TODO()
}
if f.Clock == nil {
f.Clock = clockwork.NewRealClock()
}
return nil
}
// NewForwarder returns new instance of Kubernetes request
// forwarding proxy.
func NewForwarder(cfg ForwarderConfig) (*Forwarder, error) {
if err := cfg.CheckAndSetDefaults(); err != nil {
return nil, trace.Wrap(err)
}
creds, err := getKubeCreds(cfg.KubeconfigPath)
if err != nil {
return nil, trace.Wrap(err)
}
clusterSessions, err := ttlmap.New(defaults.ClientCacheSize)
if err != nil {
return nil, trace.Wrap(err)
}
closeCtx, close := context.WithCancel(cfg.Context)
fwd := &Forwarder{
creds: *creds,
Entry: log.WithFields(log.Fields{
trace.Component: teleport.Component(teleport.ComponentKube),
}),
Router: *httprouter.New(),
ForwarderConfig: cfg,
clusterSessions: clusterSessions,
activeRequests: make(map[string]context.Context),
ctx: closeCtx,
close: close,
}
fwd.POST("/api/:ver/namespaces/:podNamespace/pods/:podName/exec", fwd.withAuth(fwd.exec))
fwd.GET("/api/:ver/namespaces/:podNamespace/pods/:podName/exec", fwd.withAuth(fwd.exec))
fwd.POST("/api/:ver/namespaces/:podNamespace/pods/:podName/attach", fwd.withAuth(fwd.exec))
fwd.GET("/api/:ver/namespaces/:podNamespace/pods/:podName/attach", fwd.withAuth(fwd.exec))
fwd.POST("/api/:ver/namespaces/:podNamespace/pods/:podName/portforward", fwd.withAuth(fwd.portForward))
fwd.GET("/api/:ver/namespaces/:podNamespace/pods/:podName/portforward", fwd.withAuth(fwd.portForward))
fwd.NotFound = fwd.withAuthStd(fwd.catchAll)
if cfg.ClusterOverride != "" {
fwd.Debugf("Cluster override is set, forwarder will send all requests to remote cluster %v.", cfg.ClusterOverride)
}
return fwd, nil
}
// Forwarder intercepts kubernetes requests, acting as Kubernetes API proxy.
// it blindly forwards most of the requests on HTTPS protocol layer,
// however some requests like exec sessions it intercepts and records.
type Forwarder struct {
sync.Mutex
*log.Entry
httprouter.Router
ForwarderConfig
// clusterSessions is an expiring cache associated with authenticated
// user connected to a remote cluster, session is invalidated
// if user changes kubernetes groups via RBAC or cache has expired
// TODO(klizhentas): flush certs on teleport CA rotation?
clusterSessions *ttlmap.TTLMap
// activeRequests is a map used to serialize active CSR requests to the auth server
activeRequests map[string]context.Context
// close is a close function
close context.CancelFunc
// ctx is a global context signalling exit
ctx context.Context
// creds contain kubernetes credentials shared with a proxy process,
// could be a service account token or client X509 credentials
creds kubeCreds
}
// Close signals close to all outstanding or background operations
// to complete
func (f *Forwarder) Close() error {
f.close()
return nil
}
// authContext is a context of authenticated user,
// contains information about user, target cluster and authenticated groups
type authContext struct {
auth.AuthContext
kubeGroups []string
cluster cluster
clusterConfig services.ClusterConfig
// clientIdleTimeout sets information on client idle timeout
clientIdleTimeout time.Duration
// disconnectExpiredCert if set, controls the time when the connection
// should be disconnected because the client cert expires
disconnectExpiredCert time.Time
// sessionTTL specifies the duration of the user's session
sessionTTL time.Duration
}
func (c authContext) String() string {
return fmt.Sprintf("user: %v, groups: %v, cluster: %v", c.User.GetName(), c.kubeGroups, c.cluster.GetName())
}
func (c *authContext) key() string {
// it is important that the context key contains user, kubernetes groups and certificate expiry,
// so that new logins with different parameters will not reuse this context
return fmt.Sprintf("%v:%v:%v:%v", c.cluster.GetName(), c.User.GetName(), c.kubeGroups, c.disconnectExpiredCert.UTC().Unix())
}
// cluster represents cluster information, name of the cluster
// target address and custom dialer
type cluster struct {
remoteAddr utils.NetAddr
reversetunnel.RemoteSite
targetAddr string
isRemote bool
}
func (c *cluster) Dial(_, _ string) (net.Conn, error) {
return c.RemoteSite.DialTCP(reversetunnel.DialParams{
From: &c.remoteAddr,
To: &utils.NetAddr{AddrNetwork: "tcp", Addr: c.targetAddr},
})
}
func (c *cluster) DialWithContext(ctx context.Context, _, _ string) (net.Conn, error) {
return c.RemoteSite.DialTCP(reversetunnel.DialParams{
From: &c.remoteAddr,
To: &utils.NetAddr{AddrNetwork: "tcp", Addr: c.targetAddr},
})
}
// handlerWithAuthFunc is http handler with passed auth context
type handlerWithAuthFunc func(ctx *authContext, w http.ResponseWriter, r *http.Request, p httprouter.Params) (interface{}, error)
// handlerWithAuthFuncStd is http handler with passed auth context
type handlerWithAuthFuncStd func(ctx *authContext, w http.ResponseWriter, r *http.Request) (interface{}, error)
// authenticate function authenticates request
func (f *Forwarder) authenticate(req *http.Request) (*authContext, error) {
const accessDeniedMsg = "[00] access denied"
var isRemoteUser bool
userTypeI := req.Context().Value(auth.ContextUser)
switch userTypeI.(type) {
case auth.LocalUser:
case auth.RemoteUser:
isRemoteUser = true
case auth.BuiltinRole:
f.Warningf("Denying proxy access to unauthenticated user of type %T - this can sometimes be caused by inadvertently using an HTTP load balancer instead of a TCP load balancer on the Kubernetes port.", userTypeI)
default:
f.Warningf("Denying proxy access to unsupported user type: %T.", userTypeI)
return nil, trace.AccessDenied(accessDeniedMsg)
}
userContext, err := f.Auth.Authorize(req.Context())
if err != nil {
switch {
// propagate connection problem error so we can differentiate
// between connection failed and access denied
case trace.IsConnectionProblem(err):
return nil, trace.ConnectionProblem(err, "[07] failed to connect to the database")
case trace.IsAccessDenied(err):
// don't print stack trace, just log the warning
f.Warn(err)
return nil, trace.AccessDenied(accessDeniedMsg)
default:
f.Warn(trace.DebugReport(err))
return nil, trace.AccessDenied(accessDeniedMsg)
}
}
peers := req.TLS.PeerCertificates
if len(peers) > 1 {
// when turning intermediaries on, don't forget to verify
// https://github.com/kubernetes/kubernetes/pull/34524/files#diff-2b283dde198c92424df5355f39544aa4R59
return nil, trace.AccessDenied("access denied: intermediaries are not supported")
}
if len(peers) == 0 {
return nil, trace.AccessDenied("access denied: only mutual TLS authentication is supported")
}
clientCert := peers[0]
authContext, err := f.setupContext(*userContext, req, isRemoteUser, clientCert.NotAfter)
if err != nil {
f.Warn(err.Error())
return nil, trace.AccessDenied(accessDeniedMsg)
}
return authContext, nil
}
func (f *Forwarder) withAuthStd(handler handlerWithAuthFuncStd) http.HandlerFunc {
return httplib.MakeStdHandler(func(w http.ResponseWriter, req *http.Request) (interface{}, error) {
authContext, err := f.authenticate(req)
if err != nil {
return nil, trace.Wrap(err)
}
return handler(authContext, w, req)
})
}
func (f *Forwarder) withAuth(handler handlerWithAuthFunc) httprouter.Handle {
return httplib.MakeHandler(func(w http.ResponseWriter, req *http.Request, p httprouter.Params) (interface{}, error) {
authContext, err := f.authenticate(req)
if err != nil {
return nil, trace.Wrap(err)
}
return handler(authContext, w, req, p)
})
}
func (f *Forwarder) setupContext(ctx auth.AuthContext, req *http.Request, isRemoteUser bool, certExpires time.Time) (*authContext, error) {
roles := ctx.Checker
clusterConfig, err := f.AccessPoint.GetClusterConfig()
if err != nil {
return nil, trace.Wrap(err)
}
// adjust session ttl to the smaller of two values: the session
// ttl requested in tsh or the session ttl for the role.
sessionTTL := roles.AdjustSessionTTL(time.Hour)
// check signing TTL and return a list of allowed logins
kubeGroups, err := roles.CheckKubeGroups(sessionTTL)
if err != nil {
return nil, trace.Wrap(err)
}
// KubeSystemAuthenticated is a builtin group that allows
// any user to access common API methods, e.g. discovery methods
// required for initial client usage, without it, restricted user's
// kubectl clients will not work
if !utils.SliceContainsStr(kubeGroups, teleport.KubeSystemAuthenticated) {
kubeGroups = append(kubeGroups, teleport.KubeSystemAuthenticated)
}
var isRemoteCluster bool
targetCluster, err := f.Tunnel.GetSite(f.ClusterName)
if err != nil {
return nil, trace.Wrap(err)
}
if ctx.Identity.RouteToCluster != "" {
f.Debugf("Client certificate of %v has requested routing to a cluster: %v.", ctx.User.GetName(), ctx.Identity.RouteToCluster)
targetCluster, err = f.Tunnel.GetSite(ctx.Identity.RouteToCluster)
if err != nil {
return nil, trace.Wrap(err)
}
isRemoteCluster = targetCluster.GetName() != f.ClusterName
} else {
// DELETE IN(4.3.0)
// This logic is deprecated and after the second upgrade, will not be used
// by the newer post 4.2.0 clients, so will be safe to remove
for _, remoteCluster := range f.Tunnel.GetSites() {
encodedName := kubeutils.EncodeClusterName(remoteCluster.GetName())
if strings.HasPrefix(req.Host, remoteCluster.GetName()+".") || strings.HasPrefix(req.Host, encodedName+".") {
f.Debugf("Going to proxy to cluster: %v based on matching host prefix %v.", remoteCluster.GetName(), req.Host)
targetCluster = remoteCluster
isRemoteCluster = remoteCluster.GetName() != f.ClusterName
break
}
if f.ClusterOverride != "" && f.ClusterOverride == remoteCluster.GetName() {
f.Debugf("Going to proxy to cluster: %v based on override %v.", remoteCluster.GetName(), f.ClusterOverride)
targetCluster = remoteCluster
isRemoteCluster = remoteCluster.GetName() != f.ClusterName
f.Debugf("Override isRemoteCluster: %v %v %v", isRemoteCluster, remoteCluster.GetName(), f.ClusterName)
break
}
}
}
if targetCluster.GetName() != f.ClusterName && isRemoteUser {
return nil, trace.AccessDenied("access denied: remote user can not access remote cluster")
}
authCtx := &authContext{
clientIdleTimeout: roles.AdjustClientIdleTimeout(clusterConfig.GetClientIdleTimeout()),
sessionTTL: sessionTTL,
AuthContext: ctx,
kubeGroups: kubeGroups,
clusterConfig: clusterConfig,
cluster: cluster{
remoteAddr: utils.NetAddr{AddrNetwork: "tcp", Addr: req.RemoteAddr},
RemoteSite: targetCluster,
targetAddr: f.TargetAddr,
isRemote: isRemoteCluster,
},
}
disconnectExpiredCert := roles.AdjustDisconnectExpiredCert(clusterConfig.GetDisconnectExpiredCert())
if !certExpires.IsZero() && disconnectExpiredCert {
authCtx.disconnectExpiredCert = certExpires
}
return authCtx, nil
}
// exec forwards all exec requests to the target server, captures
// all output from the session
func (f *Forwarder) exec(ctx *authContext, w http.ResponseWriter, req *http.Request, p httprouter.Params) (interface{}, error) {
f.Debugf("Exec %v.", req.URL.String())
q := req.URL.Query()
request := remoteCommandRequest{
podNamespace: p.ByName("podNamespace"),
podName: p.ByName("podName"),
containerName: q.Get("container"),
cmd: q["command"],
stdin: utils.AsBool(q.Get("stdin")),
stdout: utils.AsBool(q.Get("stdout")),
stderr: utils.AsBool(q.Get("stderr")),
tty: utils.AsBool(q.Get("tty")),
httpRequest: req,
httpResponseWriter: w,
context: req.Context(),
}
var recorder events.SessionRecorder
sessionID := session.NewID()
var err error
if request.tty {
// create session recorder
// get the audit log from the server and create a session recorder. this will
// be a discard audit log if the proxy is in recording mode and a teleport
// node so we don't create double recordings.
recorder, err = events.NewForwardRecorder(events.ForwardRecorderConfig{
DataDir: filepath.Join(f.DataDir, teleport.LogsDir),
SessionID: sessionID,
Namespace: f.Namespace,
RecordSessions: ctx.clusterConfig.GetSessionRecording() != services.RecordOff,
Component: teleport.Component(teleport.ComponentSession, teleport.ComponentKube),
ForwardTo: f.AuditLog,
})
if err != nil {
return nil, trace.Wrap(err)
}
defer recorder.Close()
request.onResize = func(resize remotecommand.TerminalSize) {
params := session.TerminalParams{
W: int(resize.Width),
H: int(resize.Height),
}
// Build the resize event.
resizeEvent := events.EventFields{
events.EventProtocol: events.EventProtocolKube,
events.EventType: events.ResizeEvent,
events.EventNamespace: f.Namespace,
events.SessionEventID: sessionID,
events.EventLogin: ctx.User.GetName(),
events.EventUser: ctx.User.GetName(),
events.TerminalSize: params.Serialize(),
}
// Report the updated window size to the event log (this is so the sessions
// can be replayed correctly).
recorder.GetAuditLog().EmitAuditEvent(events.TerminalResize, resizeEvent)
}
}
sess, err := f.getOrCreateClusterSession(*ctx)
if err != nil {
return nil, trace.Wrap(err)
}
if request.tty {
// Emit "new session created" event. There are no initial terminal
// parameters per k8s protocol, so set up with any default
termParams := session.TerminalParams{
W: 100,
H: 100,
}
recorder.GetAuditLog().EmitAuditEvent(events.SessionStart, events.EventFields{
events.EventProtocol: events.EventProtocolKube,
events.EventNamespace: f.Namespace,
events.SessionEventID: string(sessionID),
events.SessionServerID: f.ServerID,
events.EventLogin: ctx.User.GetName(),
events.EventUser: ctx.User.GetName(),
events.LocalAddr: sess.cluster.targetAddr,
events.RemoteAddr: req.RemoteAddr,
events.TerminalSize: termParams.Serialize(),
})
}
if err := f.setupForwardingHeaders(ctx, sess, req); err != nil {
return nil, trace.Wrap(err)
}
proxy, err := createRemoteCommandProxy(request)
if err != nil {
return nil, trace.Wrap(err)
}
defer proxy.Close()
f.Debugf("Created streams, getting executor.")
executor, err := f.getExecutor(*ctx, sess, req)
if err != nil {
return nil, trace.Wrap(err)
}
streamOptions := proxy.options()
if request.tty {
// capture stderr and stdout writes to session recorder
streamOptions.Stdout = utils.NewBroadcastWriter(streamOptions.Stdout, recorder)
streamOptions.Stderr = utils.NewBroadcastWriter(streamOptions.Stderr, recorder)
}
err = executor.Stream(streamOptions)
if err := proxy.sendStatus(err); err != nil {
f.Warningf("Failed to send status: %v. Exec command was aborted by client.", err)
return nil, trace.Wrap(err)
}
if request.tty {
// send an event indicating that this session has ended
recorder.GetAuditLog().EmitAuditEvent(events.SessionEnd, events.EventFields{
events.EventProtocol: events.EventProtocolKube,
events.SessionEventID: sessionID,
events.EventUser: ctx.User.GetName(),
events.EventNamespace: f.Namespace,
})
} else {
f.Debugf("No tty, sending exec event.")
// send an exec event
fields := events.EventFields{
events.EventProtocol: events.EventProtocolKube,
events.ExecEventCommand: strings.Join(request.cmd, " "),
events.EventLogin: ctx.User.GetName(),
events.EventUser: ctx.User.GetName(),
events.LocalAddr: sess.cluster.targetAddr,
events.RemoteAddr: req.RemoteAddr,
events.EventNamespace: f.Namespace,
}
if err != nil {
fields[events.ExecEventError] = err.Error()
if exitErr, ok := err.(utilexec.ExitError); ok && exitErr.Exited() {
fields[events.ExecEventCode] = fmt.Sprintf("%d", exitErr.ExitStatus())
}
f.AuditLog.EmitAuditEvent(events.ExecFailure, fields)
} else {
f.AuditLog.EmitAuditEvent(events.Exec, fields)
}
}
f.Debugf("Exited successfully.")
return nil, nil
}
// portForward starts port forwarding to the remote cluster
func (f *Forwarder) portForward(ctx *authContext, w http.ResponseWriter, req *http.Request, p httprouter.Params) (interface{}, error) {
f.Debugf("Port forward: %v. req headers: %v", req.URL.String(), req.Header)
sess, err := f.getOrCreateClusterSession(*ctx)
if err != nil {
return nil, trace.Wrap(err)
}
if err := f.setupForwardingHeaders(ctx, sess, req); err != nil {
f.Debugf("DENIED Port forward: %v.", req.URL.String())
return nil, trace.Wrap(err)
}
dialer, err := f.getDialer(*ctx, sess, req)
if err != nil {
return nil, trace.Wrap(err)
}
onPortForward := func(addr string, success bool) {
event := events.PortForward
if !success {
event = events.PortForwardFailure
}
f.AuditLog.EmitAuditEvent(event, events.EventFields{
events.EventProtocol: events.EventProtocolKube,
events.PortForwardAddr: addr,
events.PortForwardSuccess: success,
events.EventLogin: ctx.User.GetName(),
events.EventUser: ctx.User.GetName(),
events.LocalAddr: sess.cluster.targetAddr,
events.RemoteAddr: req.RemoteAddr,
})
}
q := req.URL.Query()
request := portForwardRequest{
podNamespace: p.ByName("podNamespace"),
podName: p.ByName("podName"),
ports: q["ports"],
context: req.Context(),
httpRequest: req,
httpResponseWriter: w,
onPortForward: onPortForward,
targetDialer: dialer,
}
f.Debugf("Starting %v.", request)
err = runPortForwarding(request)
if err != nil {
return nil, trace.Wrap(err)
}
f.Debugf("Done %v.", request)
return nil, nil
}
func (f *Forwarder) setupForwardingHeaders(ctx *authContext, sess *clusterSession, req *http.Request) error {
for header := range req.Header {
if strings.HasPrefix(header, "Impersonate-") {
return trace.AccessDenied("impersonation request has been denied")
}
}
// Setup scheme, override target URL to the destination address
req.URL.Scheme = "https"
req.URL.Host = sess.cluster.targetAddr
req.RequestURI = req.URL.Path + "?" + req.URL.RawQuery
// add origin headers so the service consuming the request on the other site
// is aware of where it came from
req.Header.Add("X-Forwarded-Proto", "https")
req.Header.Add("X-Forwarded-Host", req.Host)
req.Header.Add("X-Forwarded-Path", req.URL.Path)
if !ctx.cluster.isRemote {
req.Header.Add("Impersonate-User", ctx.User.GetName())
f.Debugf("Impersonate User: %v", ctx.User)
for _, group := range ctx.kubeGroups {
req.Header.Add("Impersonate-Group", group)
f.Debugf("Impersonate Group: %v", group)
}
if f.creds.cfg.BearerToken != "" {
f.Debugf("Using Bearer Token Auth")
req.Header.Set("Authorization", fmt.Sprintf("Bearer %v", f.creds.cfg.BearerToken))
}
}
return nil
}
// catchAll forwards all HTTP requests to the target k8s API server
func (f *Forwarder) catchAll(ctx *authContext, w http.ResponseWriter, req *http.Request) (interface{}, error) {
sess, err := f.getOrCreateClusterSession(*ctx)
if err != nil {
return nil, trace.Wrap(err)
}
if err := f.setupForwardingHeaders(ctx, sess, req); err != nil {
return nil, trace.Wrap(err)
}
sess.forwarder.ServeHTTP(w, req)
return nil, nil
}
func (f *Forwarder) getExecutor(ctx authContext, sess *clusterSession, req *http.Request) (remotecommand.Executor, error) {
upgradeRoundTripper := NewSpdyRoundTripperWithDialer(roundTripperConfig{
ctx: req.Context(),
authCtx: ctx,
dial: sess.DialWithContext,
tlsConfig: sess.tlsConfig,
followRedirects: true,
bearerToken: f.creds.cfg.BearerToken,
})
return remotecommand.NewSPDYExecutorForTransports(upgradeRoundTripper, upgradeRoundTripper, req.Method, req.URL)
}
func (f *Forwarder) getDialer(ctx authContext, sess *clusterSession, req *http.Request) (httpstream.Dialer, error) {
upgradeRoundTripper := NewSpdyRoundTripperWithDialer(roundTripperConfig{
ctx: req.Context(),
authCtx: ctx,
dial: sess.DialWithContext,
tlsConfig: sess.tlsConfig,
followRedirects: true,
bearerToken: f.creds.cfg.BearerToken,
})
client := &http.Client{
Transport: upgradeRoundTripper,
}
return spdy.NewDialer(upgradeRoundTripper, client, req.Method, req.URL), nil
}
// clusterSession contains authenticated user session to the target cluster:
// x509 short lived credentials, forwarding proxies and other data
type clusterSession struct {
authContext
parent *Forwarder
tlsConfig *tls.Config
forwarder *forward.Forwarder
}
func (s *clusterSession) monitorConn(conn net.Conn, err error) (net.Conn, error) {
if err != nil {
return nil, trace.Wrap(err)
}
if s.disconnectExpiredCert.IsZero() && s.clientIdleTimeout == 0 {
return conn, nil
}
ctx, cancel := context.WithCancel(s.parent.ctx)
tc := &trackingConn{
Conn: conn,
clock: s.parent.Clock,
ctx: ctx,
cancel: cancel,
}
mon, err := srv.NewMonitor(srv.MonitorConfig{
DisconnectExpiredCert: s.disconnectExpiredCert,
ClientIdleTimeout: s.clientIdleTimeout,
Clock: s.parent.Clock,
Tracker: tc,
Conn: tc,
Context: ctx,
TeleportUser: s.User.GetName(),
ServerID: s.parent.ServerID,
Audit: s.parent.AuditLog,
Entry: s.parent.Entry,
})
if err != nil {
tc.Close()
return nil, trace.Wrap(err)
}
go mon.Start()
return tc, nil
}
func (s *clusterSession) Dial(network, addr string) (net.Conn, error) {
return s.monitorConn(s.cluster.Dial(network, addr))
}
func (s *clusterSession) DialWithContext(ctx context.Context, network, addr string) (net.Conn, error) {
return s.monitorConn(s.cluster.DialWithContext(ctx, network, addr))
}
type trackingConn struct {
sync.RWMutex
net.Conn
clock clockwork.Clock
lastActive time.Time
ctx context.Context
cancel context.CancelFunc
}
// Read reads data from the connection.
// Read can be made to time out and return an Error with Timeout() == true
// after a fixed time limit; see SetDeadline and SetReadDeadline.
func (t *trackingConn) Read(b []byte) (int, error) {
n, err := t.Conn.Read(b)
t.UpdateClientActivity()
return n, err
}
func (t *trackingConn) Close() error {
t.cancel()
return t.Conn.Close()
}
// GetClientLastActive returns time when client was last active
func (t *trackingConn) GetClientLastActive() time.Time {
t.RLock()
defer t.RUnlock()
return t.lastActive
}
// UpdateClientActivity sets last recorded client activity
func (t *trackingConn) UpdateClientActivity() {
t.Lock()
defer t.Unlock()
t.lastActive = t.clock.Now().UTC()
}
func (f *Forwarder) getOrCreateClusterSession(ctx authContext) (*clusterSession, error) {
client := f.getClusterSession(ctx)
if client != nil {
return client, nil
}
return f.serializedNewClusterSession(ctx)
}
func (f *Forwarder) getClusterSession(ctx authContext) *clusterSession {
f.Lock()
defer f.Unlock()
creds, ok := f.clusterSessions.Get(ctx.key())
if ok {
return creds.(*clusterSession)
}
return nil
}
func (f *Forwarder) serializedNewClusterSession(authContext authContext) (*clusterSession, error) {
ctx, cancel := f.getOrCreateRequestContext(authContext.key())
if cancel != nil {
f.Debugf("Requesting new creds for %v.", authContext)
defer cancel()
return f.newClusterSession(authContext)
}
// cancel == nil means that another request is in progress, so simply wait until
// it finishes or fails
f.Debugf("Another request is in progress for %v, waiting until it gets completed.", authContext)
select {
case <-ctx.Done():
sess := f.getClusterSession(authContext)
if sess == nil {
return nil, trace.BadParameter("failed to request certificate, try again")
}
return sess, nil
case <-f.ctx.Done():
return nil, trace.BadParameter("forwarder is closing, aborting the request")
}
}
func (f *Forwarder) newClusterSession(ctx authContext) (*clusterSession, error) {
pool := x509.NewCertPool()
tlsConfig := &tls.Config{
RootCAs: pool,
}
// for remote clusters, retrieve a client certificate
if ctx.cluster.isRemote {
response, err := f.requestCertificate(ctx)
if err != nil {
f.Warningf("Failed to get certificate for %v: %v.", ctx, err)
return nil, trace.AccessDenied("access denied: failed to authenticate with auth server")
}
cert, err := tls.X509KeyPair(response.cert, response.key)
if err != nil {
return nil, trace.Wrap(err)
}
for _, certAuthority := range response.certAuthorities {
ok := pool.AppendCertsFromPEM(certAuthority)
if !ok {
return nil, trace.BadParameter("failed to append certs from PEM")
}
}
tlsConfig.Certificates = []tls.Certificate{cert}
tlsConfig.ClientAuth = tls.RequireAndVerifyClientCert
} else {
ok := pool.AppendCertsFromPEM(f.creds.caPEM)
if !ok {
return nil, trace.BadParameter("failed to append certs from PEM")
}
if f.creds.cert != nil {
f.Debugf("Local Cluster: using TLS client certificates.")
tlsConfig.Certificates = []tls.Certificate{*f.creds.cert}
tlsConfig.ClientAuth = tls.RequireAndVerifyClientCert
}
}
tlsConfig.BuildNameToCertificate()
// remote clusters use special hardcoded URL,
// and use a special dialer
if ctx.cluster.isRemote {
ctx.cluster.targetAddr = reversetunnel.RemoteKubeProxy
} else {
// auth server supplied target API address to dial,
// use it for dialing
if f.creds.targetAddr != "" {
ctx.cluster.targetAddr = f.creds.targetAddr
} else { // otherwise, use supplied defaults
ctx.cluster.targetAddr = f.TargetAddr
}
}
sess := &clusterSession{
parent: f,
authContext: ctx,
tlsConfig: tlsConfig,
}
var transport http.RoundTripper = f.newTransport(sess.Dial, tlsConfig)
// when running inside Kubernetes cluster, kubeconfig provides a
// transport wrapper that adds service account token to requests
//
// when forwarding request to a remote cluster, this is not needed
// as the proxy uses client cert auth to reach out to remote proxy
// which will then use its own transport wrapper
if !ctx.cluster.isRemote && f.creds.cfg.WrapTransport != nil {
transport = f.creds.cfg.WrapTransport(transport)
}
fwd, err := forward.New(
forward.FlushInterval(100*time.Millisecond),
forward.RoundTripper(transport),
forward.WebsocketDial(sess.Dial),
forward.Logger(log.StandardLogger()),
)
if err != nil {
return nil, trace.Wrap(err)
}
sess.forwarder = fwd
f.Lock()
defer f.Unlock()
sessI, ok := f.clusterSessions.Get(ctx.key())
if ok {
return sessI.(*clusterSession), nil
}
f.clusterSessions.Set(ctx.key(), sess, ctx.sessionTTL)
f.Debugf("Created new session for %v.", ctx)
return sess, nil
}
// DialFunc is a network dialer function that returns a network connection
type DialFunc func(string, string) (net.Conn, error)
func (f *Forwarder) newTransport(dial DialFunc, tlsConfig *tls.Config) *http.Transport {
return &http.Transport{
Dial: dial,
TLSClientConfig: tlsConfig,
// Increase the size of the connection pool. This substantially improves the
// performance of Teleport under load as it reduces the number of TLS
// handshakes performed.
MaxIdleConns: defaults.HTTPMaxIdleConns,
MaxIdleConnsPerHost: defaults.HTTPMaxIdleConnsPerHost,
// IdleConnTimeout defines the maximum amount of time before idle connections
// are closed. Leaving this unset will lead to connections open forever and
// will cause memory leaks in a long running process.
IdleConnTimeout: defaults.HTTPIdleTimeout,
}
}
type bundle struct {
cert []byte
key []byte
certAuthorities [][]byte
targetAddr string
}
// getOrCreateRequestContext creates a new certificate request for a given context,
// if there is no active CSR request in progress, or returns an existing one.
// if the new context has been created, cancel function is returned as a
// second argument. Caller should call this function to signal that CSR has been
// completed or failed.
func (f *Forwarder) getOrCreateRequestContext(key string) (context.Context, context.CancelFunc) {
f.Lock()
defer f.Unlock()
ctx, ok := f.activeRequests[key]
if ok {
return ctx, nil
}
ctx, cancel := context.WithCancel(context.TODO())
f.activeRequests[key] = ctx
return ctx, func() {
cancel()
f.Lock()
defer f.Unlock()
delete(f.activeRequests, key)
}
}
func (f *Forwarder) requestCertificate(ctx authContext) (*bundle, error) {
f.Debugf("Requesting K8s cert for %v.", ctx)
keyPEM, _, err := f.Keygen.GenerateKeyPair("")
if err != nil {
return nil, trace.Wrap(err)
}
privateKey, err := ssh.ParseRawPrivateKey(keyPEM)
if err != nil {
return nil, trace.Wrap(err, "failed to parse private key")
}
csr := &x509.CertificateRequest{
Subject: pkix.Name{
CommonName: ctx.User.GetName(),
Organization: ctx.kubeGroups,
},
}
csrBytes, err := x509.CreateCertificateRequest(rand.Reader, csr, privateKey)
if err != nil {