-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
sess.go
1249 lines (1071 loc) · 37 KB
/
sess.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 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 proxy
import (
"context"
"fmt"
"io"
"net/http"
"net/url"
"reflect"
"strings"
"sync"
"time"
"github.com/google/uuid"
"github.com/gravitational/trace"
"github.com/julienschmidt/httprouter"
log "github.com/sirupsen/logrus"
"golang.org/x/exp/slices"
"k8s.io/client-go/tools/remotecommand"
"github.com/gravitational/teleport"
"github.com/gravitational/teleport/api/types"
apievents "github.com/gravitational/teleport/api/types/events"
"github.com/gravitational/teleport/lib/auth"
"github.com/gravitational/teleport/lib/events"
"github.com/gravitational/teleport/lib/events/recorder"
"github.com/gravitational/teleport/lib/kube/proxy/streamproto"
tsession "github.com/gravitational/teleport/lib/session"
"github.com/gravitational/teleport/lib/srv"
"github.com/gravitational/teleport/lib/utils"
)
const sessionRecorderID = "session-recorder"
const (
PresenceVerifyInterval = time.Second * 15
PresenceMaxDifference = time.Minute
sessionMaxLifetime = time.Hour * 24
)
// remoteClient is either a kubectl or websocket client.
type remoteClient interface {
stdinStream() io.Reader
stdoutStream() io.Writer
stderrStream() io.Writer
resizeQueue() <-chan *remotecommand.TerminalSize
resize(size *remotecommand.TerminalSize) error
forceTerminate() <-chan struct{}
sendStatus(error) error
io.Closer
}
type websocketClientStreams struct {
stream *streamproto.SessionStream
}
func (p *websocketClientStreams) stdinStream() io.Reader {
return p.stream
}
func (p *websocketClientStreams) stdoutStream() io.Writer {
return p.stream
}
func (p *websocketClientStreams) stderrStream() io.Writer {
return p.stream
}
func (p *websocketClientStreams) resizeQueue() <-chan *remotecommand.TerminalSize {
return p.stream.ResizeQueue()
}
func (p *websocketClientStreams) resize(size *remotecommand.TerminalSize) error {
return p.stream.Resize(size)
}
func (p *websocketClientStreams) forceTerminate() <-chan struct{} {
return p.stream.ForceTerminateQueue()
}
func (p *websocketClientStreams) sendStatus(err error) error {
return nil
}
func (p *websocketClientStreams) Close() error {
return trace.Wrap(p.stream.Close())
}
type kubeProxyClientStreams struct {
proxy *remoteCommandProxy
sizeQueue *termQueue
stdin io.Reader
stdout io.Writer
stderr io.Writer
close chan struct{}
wg sync.WaitGroup
}
func newKubeProxyClientStreams(proxy *remoteCommandProxy) *kubeProxyClientStreams {
options := proxy.options()
return &kubeProxyClientStreams{
proxy: proxy,
stdin: options.Stdin,
stdout: options.Stdout,
stderr: options.Stderr,
close: make(chan struct{}),
sizeQueue: proxy.resizeQueue,
}
}
func (p *kubeProxyClientStreams) stdinStream() io.Reader {
return p.stdin
}
func (p *kubeProxyClientStreams) stdoutStream() io.Writer {
return p.stdout
}
func (p *kubeProxyClientStreams) stderrStream() io.Writer {
return p.stderr
}
func (p *kubeProxyClientStreams) resizeQueue() <-chan *remotecommand.TerminalSize {
ch := make(chan *remotecommand.TerminalSize)
p.wg.Add(1)
go func() {
defer p.wg.Done()
for {
size := p.sizeQueue.Next()
if size == nil {
return
}
select {
case ch <- size:
// Check if the sizeQueue was already terminated.
case <-p.sizeQueue.done.Done():
return
}
}
}()
return ch
}
func (p *kubeProxyClientStreams) resize(size *remotecommand.TerminalSize) error {
escape := fmt.Sprintf("\x1b[8;%d;%dt", size.Height, size.Width)
_, err := p.stdout.Write([]byte(escape))
return trace.Wrap(err)
}
func (p *kubeProxyClientStreams) forceTerminate() <-chan struct{} {
return make(chan struct{})
}
func (p *kubeProxyClientStreams) sendStatus(err error) error {
return trace.Wrap(p.proxy.sendStatus(err))
}
func (p *kubeProxyClientStreams) Close() error {
if p.sizeQueue != nil {
p.sizeQueue.Close()
}
p.wg.Wait()
return trace.Wrap(p.proxy.Close())
}
// multiResizeQueue is a merged queue of multiple terminal size queues.
type multiResizeQueue struct {
queues map[string]<-chan *remotecommand.TerminalSize
cases []reflect.SelectCase
callback func(*remotecommand.TerminalSize)
mutex sync.Mutex
parentCtx context.Context
reloadCtx context.Context
reloadCancel context.CancelFunc
}
func newMultiResizeQueue(parentCtx context.Context) *multiResizeQueue {
ctx, cancel := context.WithCancel(parentCtx)
return &multiResizeQueue{
queues: make(map[string]<-chan *remotecommand.TerminalSize),
parentCtx: parentCtx,
reloadCtx: ctx,
reloadCancel: cancel,
}
}
func (r *multiResizeQueue) rebuild() {
oldCancel := r.reloadCancel
defer oldCancel()
r.reloadCtx, r.reloadCancel = context.WithCancel(r.parentCtx)
r.cases = make([]reflect.SelectCase, 1, len(r.queues)+1)
r.cases[0] = reflect.SelectCase{
Dir: reflect.SelectRecv,
Chan: reflect.ValueOf(r.reloadCtx.Done()),
}
for _, queue := range r.queues {
r.cases = append(r.cases,
reflect.SelectCase{
Dir: reflect.SelectRecv,
Chan: reflect.ValueOf(queue),
},
)
}
}
func (r *multiResizeQueue) close() {
r.reloadCancel()
}
func (r *multiResizeQueue) add(id string, queue <-chan *remotecommand.TerminalSize) {
r.mutex.Lock()
defer r.mutex.Unlock()
r.queues[id] = queue
r.rebuild()
}
func (r *multiResizeQueue) remove(id string) {
r.mutex.Lock()
defer r.mutex.Unlock()
delete(r.queues, id)
r.rebuild()
}
func (r *multiResizeQueue) Next() *remotecommand.TerminalSize {
loop:
for {
r.mutex.Lock()
cases := r.cases
r.mutex.Unlock()
idx, value, ok := reflect.Select(cases)
if !ok || idx == 0 {
select {
// if parent context is canceled, the session has ended and we should
// return early. Otherwise, it means that we rebuilt and in that case we should continue.
case <-r.parentCtx.Done():
return nil
default:
continue loop
}
}
size := value.Interface().(*remotecommand.TerminalSize)
r.callback(size)
return size
}
}
// party represents one participant of the session and their associated state.
type party struct {
Ctx authContext
ID uuid.UUID
Client remoteClient
Mode types.SessionParticipantMode
closeC chan struct{}
closeOnce sync.Once
}
// newParty creates a new party.
func newParty(ctx authContext, mode types.SessionParticipantMode, client remoteClient) *party {
return &party{
Ctx: ctx,
ID: uuid.New(),
Client: client,
Mode: mode,
closeC: make(chan struct{}),
}
}
// InformClose informs the party that he must leave the session.
func (p *party) InformClose() {
p.closeOnce.Do(func() {
close(p.closeC)
})
}
// CloseConnection closes the party underlying connection.
func (p *party) CloseConnection() error {
return trace.Wrap(p.Client.Close())
}
// session represents an ongoing k8s session.
type session struct {
mu sync.RWMutex
// ctx is the auth context of the session initiator
ctx authContext
forwarder *Forwarder
req *http.Request
params httprouter.Params
id uuid.UUID
// parties is a map of currently active parties.
parties map[uuid.UUID]*party
// partiesHistorical is a map of all current previous parties.
// This is used for audit trails.
partiesHistorical map[uuid.UUID]*party
log *log.Entry
io *srv.TermManager
terminalSizeQueue *multiResizeQueue
tracker *srv.SessionTracker
accessEvaluator auth.SessionAccessEvaluator
recorder events.SessionPreparerRecorder
emitter apievents.Emitter
podName string
started bool
initiator uuid.UUID
expires time.Time
// sess is the clusterSession used to establish this session.
sess *clusterSession
closeC chan struct{}
closeOnce sync.Once
// PresenceEnabled is set to true if MFA based presence is required.
PresenceEnabled bool
// Set if we should broadcast information about participant requirements to the session.
displayParticipantRequirements bool
// invitedUsers is a list of users that were invited to the session.
invitedUsers []string
// reason is the reason for the session.
reason string
// eventsWaiter is used to wait for events to be emitted and goroutines closed
// when a session is closed.
eventsWaiter sync.WaitGroup
streamContext context.Context
streamContextCancel context.CancelFunc
// partiesWg is a sync.WaitGroup that tracks the number of active parties
// in this session. It's incremented when a party joins a session and
// decremented when he leaves - it waits until the session leave events
// are emitted for every party before returning.
partiesWg sync.WaitGroup
}
// newSession creates a new session in pending mode.
func newSession(ctx authContext, forwarder *Forwarder, req *http.Request, params httprouter.Params, initiator *party, sess *clusterSession) (*session, error) {
id := uuid.New()
log := forwarder.log.WithField("session", id.String())
log.Debug("Creating session")
var policySets []*types.SessionTrackerPolicySet
roles := ctx.Checker.Roles()
for _, role := range roles {
policySet := role.GetSessionPolicySet()
policySets = append(policySets, &policySet)
}
q := req.URL.Query()
accessEvaluator := auth.NewSessionAccessEvaluator(policySets, types.KubernetesSessionKind, ctx.User.GetName())
io := srv.NewTermManager()
streamContext, streamContextCancel := context.WithCancel(forwarder.ctx)
s := &session{
ctx: ctx,
forwarder: forwarder,
req: req,
params: params,
id: id,
parties: make(map[uuid.UUID]*party),
partiesHistorical: make(map[uuid.UUID]*party),
log: log,
io: io,
accessEvaluator: accessEvaluator,
emitter: events.NewDiscardEmitter(),
terminalSizeQueue: newMultiResizeQueue(streamContext),
started: false,
sess: sess,
closeC: make(chan struct{}),
initiator: initiator.ID,
expires: time.Now().UTC().Add(sessionMaxLifetime),
PresenceEnabled: ctx.Identity.GetIdentity().MFAVerified != "",
displayParticipantRequirements: utils.AsBool(q.Get(teleport.KubeSessionDisplayParticipantRequirementsQueryParam)),
invitedUsers: strings.Split(q.Get(teleport.KubeSessionInvitedQueryParam), ","),
reason: q.Get(teleport.KubeSessionReasonQueryParam),
streamContext: streamContext,
streamContextCancel: streamContextCancel,
partiesWg: sync.WaitGroup{},
}
s.io.OnWriteError = s.disconnectPartyOnErr
s.io.OnReadError = s.disconnectPartyOnErr
s.BroadcastMessage("Creating session with ID: %v...", id.String())
s.BroadcastMessage(srv.SessionControlsInfoBroadcast)
go func() {
if _, open := <-s.io.TerminateNotifier(); open {
err := s.Close()
if err != nil {
s.log.Errorf("Failed to close session: %v.", err)
}
}
}()
if err := s.trackSession(initiator, policySets); err != nil {
return nil, trace.Wrap(err)
}
return s, nil
}
// disconnectPartyOnErr is called when any party connection returns an error.
// It is used to properly handle client disconnections.
func (s *session) disconnectPartyOnErr(idString string, err error) {
if idString == sessionRecorderID {
s.log.Error("Failed to write to session recorder, closing session.")
s.Close()
return
}
id, uuidParseErr := uuid.Parse(idString)
if uuidParseErr != nil {
s.log.WithError(uuidParseErr).Errorf("Unable to decode %q into a UUID.", idString)
return
}
wasActive, leaveErr := s.leave(id)
if leaveErr != nil {
s.log.WithError(leaveErr).Errorf("Failed to disconnect party %v from the session.", idString)
}
if wasActive {
// log the error only if it was the reason for the user disconnection.
s.log.Errorf("Encountered error: %v with party %v. Disconnecting them from the session.", err, idString)
}
}
// checkPresence checks the presence timestamp of involved moderators
// and kicks them if they are not active.
func (s *session) checkPresence() error {
s.mu.Lock()
defer s.mu.Unlock()
for _, participant := range s.tracker.GetParticipants() {
if participant.ID == s.initiator.String() {
continue
}
if participant.Mode == string(types.SessionModeratorMode) && time.Now().UTC().After(participant.LastActive.Add(PresenceMaxDifference)) {
s.log.Debugf("Participant %v is not active, kicking.", participant.ID)
id, _ := uuid.Parse(participant.ID)
_, err := s.unlockedLeave(id)
if err != nil {
s.log.WithError(err).Warnf("Failed to kick participant %v for inactivity.", participant.ID)
}
}
}
return nil
}
// launch waits until the session meets access requirements and then transitions the session
// to a running state.
func (s *session) launch() error {
defer func() {
err := s.Close()
if err != nil {
s.log.WithError(err).Errorf("Failed to close session: %v", s.id)
}
}()
s.log.Debugf("Launching session: %v", s.id)
q := s.req.URL.Query()
request := &remoteCommandRequest{
podNamespace: s.params.ByName("podNamespace"),
podName: s.params.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")),
httpRequest: s.req,
httpResponseWriter: nil,
context: s.req.Context(),
pingPeriod: s.forwarder.cfg.ConnPingPeriod,
}
s.podName = request.podName
s.BroadcastMessage("Connecting to %v over K8S", s.podName)
eventPodMeta := request.eventPodMeta(request.context, s.sess.kubeAPICreds)
onFinished, err := s.lockedSetupLaunch(request, q, eventPodMeta)
if err != nil {
return trace.Wrap(err)
}
defer func() {
// The closure captures the err variable pointer so that the variable can
// be changed by the code below, but when defer runs, it gets the last value.
onFinished(err)
}()
termParams := tsession.TerminalParams{
W: 100,
H: 100,
}
sessionStartEvent, err := s.recorder.PrepareSessionEvent(&apievents.SessionStart{
Metadata: apievents.Metadata{
Type: events.SessionStartEvent,
Code: events.SessionStartCode,
ClusterName: s.forwarder.cfg.ClusterName,
},
ServerMetadata: apievents.ServerMetadata{
ServerID: s.forwarder.cfg.HostID,
ServerNamespace: s.forwarder.cfg.Namespace,
ServerHostname: s.sess.teleportCluster.name,
ServerAddr: s.sess.kubeAddress,
},
SessionMetadata: apievents.SessionMetadata{
SessionID: s.id.String(),
WithMFA: s.ctx.Identity.GetIdentity().MFAVerified,
},
UserMetadata: s.ctx.eventUserMeta(),
ConnectionMetadata: apievents.ConnectionMetadata{
RemoteAddr: s.req.RemoteAddr,
LocalAddr: s.sess.kubeAddress,
Protocol: events.EventProtocolKube,
},
TerminalSize: termParams.Serialize(),
KubernetesClusterMetadata: s.ctx.eventClusterMeta(s.req),
KubernetesPodMetadata: eventPodMeta,
InitialCommand: q["command"],
SessionRecording: s.ctx.recordingConfig.GetMode(),
})
if err == nil {
if err := s.recorder.RecordEvent(s.forwarder.ctx, sessionStartEvent); err != nil {
s.forwarder.log.WithError(err).Warn("Failed to record session start event.")
}
if err := s.emitter.EmitAuditEvent(s.forwarder.ctx, sessionStartEvent.GetAuditEvent()); err != nil {
s.forwarder.log.WithError(err).Warn("Failed to emit session start event.")
}
} else {
s.forwarder.log.WithError(err).Warn("Failed to set up session start event - event will not be recorded")
}
s.eventsWaiter.Add(1)
go func() {
defer s.eventsWaiter.Done()
t := time.NewTimer(time.Until(s.expires))
defer t.Stop()
select {
case <-t.C:
s.BroadcastMessage("Session expired, closing...")
err := s.Close()
if err != nil {
s.log.WithError(err).Error("Failed to close session")
}
case <-s.closeC:
}
}()
if err = s.tracker.UpdateState(s.forwarder.ctx, types.SessionState_SessionStateRunning); err != nil {
s.log.WithError(err).Warn("Failed to set tracker state to running")
}
var executor remotecommand.Executor
executor, err = s.forwarder.getExecutor(s.sess, s.req)
if err != nil {
s.log.WithError(err).Warning("Failed creating executor.")
return trace.Wrap(err)
}
options := remotecommand.StreamOptions{
Stdin: s.io,
Stdout: s.io,
Stderr: s.io,
Tty: true,
TerminalSizeQueue: s.terminalSizeQueue,
}
s.io.On()
if err = executor.StreamWithContext(s.streamContext, options); err != nil {
s.log.WithError(err).Warning("Executor failed while streaming.")
return trace.Wrap(err)
}
return nil
}
func (s *session) lockedSetupLaunch(request *remoteCommandRequest, q url.Values, eventPodMeta apievents.KubernetesPodMetadata) (func(error), error) {
s.mu.Lock()
defer s.mu.Unlock()
var err error
s.started = true
sessionStart := s.forwarder.cfg.Clock.Now().UTC()
if !s.sess.noAuditEvents {
s.terminalSizeQueue.callback = func(resize *remotecommand.TerminalSize) {
s.mu.Lock()
defer s.mu.Unlock()
for id, p := range s.parties {
err := p.Client.resize(resize)
if err != nil {
s.log.WithError(err).Errorf("Failed to resize client: %v", id.String())
}
}
params := tsession.TerminalParams{
W: int(resize.Width),
H: int(resize.Height),
}
resizeEvent, err := s.recorder.PrepareSessionEvent(&apievents.Resize{
Metadata: apievents.Metadata{
Type: events.ResizeEvent,
Code: events.TerminalResizeCode,
ClusterName: s.forwarder.cfg.ClusterName,
},
ConnectionMetadata: apievents.ConnectionMetadata{
RemoteAddr: s.req.RemoteAddr,
Protocol: events.EventProtocolKube,
},
ServerMetadata: apievents.ServerMetadata{
ServerNamespace: s.forwarder.cfg.Namespace,
},
SessionMetadata: apievents.SessionMetadata{
SessionID: s.id.String(),
WithMFA: s.ctx.Identity.GetIdentity().MFAVerified,
},
UserMetadata: s.ctx.eventUserMeta(),
TerminalSize: params.Serialize(),
KubernetesClusterMetadata: s.ctx.eventClusterMeta(s.req),
KubernetesPodMetadata: eventPodMeta,
})
if err == nil {
// Report the updated window size to the event log (this is so the sessions
// can be replayed correctly).
if err := s.recorder.RecordEvent(s.forwarder.ctx, resizeEvent); err != nil {
s.forwarder.log.WithError(err).Warn("Failed to emit terminal resize event.")
}
} else {
s.forwarder.log.WithError(err).Warn("Failed to set up terminal resize event - event will not be recorded")
}
}
} else {
s.terminalSizeQueue.callback = func(resize *remotecommand.TerminalSize) {}
}
recorder, err := recorder.New(recorder.Config{
SessionID: tsession.ID(s.id.String()),
ServerID: s.forwarder.cfg.HostID,
Namespace: s.forwarder.cfg.Namespace,
Clock: s.forwarder.cfg.Clock,
ClusterName: s.forwarder.cfg.ClusterName,
RecordingCfg: s.ctx.recordingConfig,
SyncStreamer: s.forwarder.cfg.AuthClient,
DataDir: s.forwarder.cfg.DataDir,
Component: teleport.Component(teleport.ComponentSession, teleport.ComponentProxyKube),
// Session stream is using server context, not session context,
// to make sure that session is uploaded even after it is closed
Context: s.forwarder.ctx,
})
if err != nil {
return nil, trace.Wrap(err)
}
s.recorder = recorder
s.emitter = s.forwarder.cfg.Emitter
s.io.AddWriter(sessionRecorderID, recorder)
// If the identity is verified with an MFA device, we enabled MFA-based presence for the session.
if s.PresenceEnabled {
s.eventsWaiter.Add(1)
go func() {
defer s.eventsWaiter.Done()
ticker := time.NewTicker(PresenceVerifyInterval)
defer ticker.Stop()
for {
select {
case <-ticker.C:
err := s.checkPresence()
if err != nil {
s.log.WithError(err).Error("Failed to check presence, closing session as a security measure")
err := s.Close()
if err != nil {
s.log.WithError(err).Error("Failed to close session")
}
}
case <-s.closeC:
return
}
}
}()
}
// If we get here, it means we are going to have a session.end event.
// This increments the waiter so that session.Close() guarantees that once called
// the events are emitted before closing the emitter/recorder.
// It might happen when a user disconnects or when a moderator forces an early
// termination.
s.eventsWaiter.Add(1)
// receive the exec error returned from API call to kube cluster
return func(errExec error) {
defer s.eventsWaiter.Done()
s.mu.Lock()
defer s.mu.Unlock()
for _, party := range s.parties {
if err := party.Client.sendStatus(errExec); err != nil {
s.forwarder.log.WithError(err).Warning("Failed to send status. Exec command was aborted by client.")
}
}
serverMetadata := apievents.ServerMetadata{
ServerID: s.forwarder.cfg.HostID,
ServerNamespace: s.forwarder.cfg.Namespace,
}
sessionMetadata := apievents.SessionMetadata{
SessionID: s.id.String(),
WithMFA: s.ctx.Identity.GetIdentity().MFAVerified,
}
conMetadata := apievents.ConnectionMetadata{
RemoteAddr: s.req.RemoteAddr,
LocalAddr: s.sess.kubeAddress,
Protocol: events.EventProtocolKube,
}
execEvent := &apievents.Exec{
Metadata: apievents.Metadata{
Type: events.ExecEvent,
ClusterName: s.forwarder.cfg.ClusterName,
// can be changed to ExecFailureCode if errExec is not nil
Code: events.ExecCode,
},
ServerMetadata: serverMetadata,
SessionMetadata: sessionMetadata,
UserMetadata: s.sess.eventUserMeta(),
ConnectionMetadata: conMetadata,
CommandMetadata: apievents.CommandMetadata{
Command: strings.Join(request.cmd, " "),
},
KubernetesClusterMetadata: s.ctx.eventClusterMeta(s.req),
KubernetesPodMetadata: eventPodMeta,
}
if errExec != nil {
execEvent.Code = events.ExecFailureCode
execEvent.Error, execEvent.ExitCode = exitCode(err)
}
if err := s.emitter.EmitAuditEvent(s.forwarder.ctx, execEvent); err != nil {
s.forwarder.log.WithError(err).Warn("Failed to emit exec event.")
}
sessionDataEvent := &apievents.SessionData{
Metadata: apievents.Metadata{
Type: events.SessionDataEvent,
Code: events.SessionDataCode,
ClusterName: s.forwarder.cfg.ClusterName,
},
ServerMetadata: serverMetadata,
SessionMetadata: sessionMetadata,
UserMetadata: s.sess.eventUserMeta(),
ConnectionMetadata: conMetadata,
// Bytes transmitted from user to pod.
BytesTransmitted: s.io.CountRead(),
// Bytes received from pod by user.
BytesReceived: s.io.CountWritten(),
}
if err := s.emitter.EmitAuditEvent(s.forwarder.ctx, sessionDataEvent); err != nil {
s.forwarder.log.WithError(err).Warn("Failed to emit session data event.")
}
sessionEndEvent, err := s.recorder.PrepareSessionEvent(&apievents.SessionEnd{
Metadata: apievents.Metadata{
Type: events.SessionEndEvent,
Code: events.SessionEndCode,
ClusterName: s.forwarder.cfg.ClusterName,
},
ServerMetadata: serverMetadata,
SessionMetadata: sessionMetadata,
UserMetadata: s.sess.eventUserMeta(),
ConnectionMetadata: conMetadata,
Interactive: true,
Participants: s.allParticipants(),
StartTime: sessionStart,
EndTime: s.forwarder.cfg.Clock.Now().UTC(),
KubernetesClusterMetadata: s.ctx.eventClusterMeta(s.req),
KubernetesPodMetadata: eventPodMeta,
InitialCommand: request.cmd,
SessionRecording: s.ctx.recordingConfig.GetMode(),
})
if err == nil {
if err := s.recorder.RecordEvent(s.forwarder.ctx, sessionEndEvent); err != nil {
s.forwarder.log.WithError(err).Warn("Failed to record session end event.")
}
if err := s.emitter.EmitAuditEvent(s.forwarder.ctx, sessionEndEvent.GetAuditEvent()); err != nil {
s.forwarder.log.WithError(err).Warn("Failed to emit session end event.")
}
} else {
s.forwarder.log.WithError(err).Warn("Failed to set up session end event - event will not be recorded")
}
}, nil
}
// join attempts to connect a party to the session.
func (s *session) join(p *party) error {
if p.Ctx.User.GetName() != s.ctx.User.GetName() {
roles := p.Ctx.Checker.Roles()
accessContext := auth.SessionAccessContext{
Username: p.Ctx.User.GetName(),
Roles: roles,
}
modes := s.accessEvaluator.CanJoin(accessContext)
if !slices.Contains(modes, p.Mode) {
return trace.AccessDenied("insufficient permissions to join session")
}
}
if s.tracker.GetState() == types.SessionState_SessionStateTerminated {
return trace.AccessDenied("The requested session is not active")
}
s.log.Debugf("Tracking participant: %s", p.ID)
participant := &types.Participant{
ID: p.ID.String(),
User: p.Ctx.User.GetName(),
Mode: string(p.Mode),
LastActive: time.Now().UTC(),
}
if err := s.tracker.AddParticipant(s.forwarder.ctx, participant); err != nil {
return trace.Wrap(err)
}
sessionJoinEvent := &apievents.SessionJoin{
Metadata: apievents.Metadata{
Type: events.SessionJoinEvent,
Code: events.SessionJoinCode,
ClusterName: s.ctx.teleportCluster.name,
},
KubernetesClusterMetadata: apievents.KubernetesClusterMetadata{
KubernetesCluster: s.ctx.kubeClusterName,
KubernetesUsers: []string{},
KubernetesGroups: []string{},
KubernetesLabels: s.ctx.kubeClusterLabels,
},
SessionMetadata: apievents.SessionMetadata{
SessionID: s.id.String(),
},
UserMetadata: p.Ctx.eventUserMetaWithLogin("root"),
ConnectionMetadata: apievents.ConnectionMetadata{
RemoteAddr: s.params.ByName("podName"),
},
}
if err := s.emitter.EmitAuditEvent(s.forwarder.ctx, sessionJoinEvent); err != nil {
s.forwarder.log.WithError(err).Warn("Failed to emit event.")
}
recentWrites := s.io.GetRecentHistory()
if _, err := p.Client.stdoutStream().Write(recentWrites); err != nil {
s.log.Warnf("Failed to write history to client: %v.", err)
}
// increment the party track waitgroup.
// It is decremented when session.leave() finishes its execution.
s.partiesWg.Add(1)
s.mu.Lock()
defer s.mu.Unlock()
stringID := p.ID.String()
s.parties[p.ID] = p
s.partiesHistorical[p.ID] = p
s.terminalSizeQueue.add(stringID, p.Client.resizeQueue())
if p.Mode == types.SessionPeerMode {
s.io.AddReader(stringID, p.Client.stdinStream())
}
s.io.AddWriter(stringID, p.Client.stdoutStream())
s.BroadcastMessage("User %v joined the session with participant mode: %v.", p.Ctx.User.GetName(), p.Mode)
if p.Mode == types.SessionModeratorMode {
s.eventsWaiter.Add(1)
go func() {
defer s.eventsWaiter.Done()
c := p.Client.forceTerminate()
select {
case <-c:
go func() {
s.log.Debugf("Received force termination request")
err := s.Close()
if err != nil {
s.log.Errorf("Failed to close session: %v.", err)
}
}()
case <-s.closeC:
return
}
}()
}
canStart, _, err := s.canStart()
if err != nil {
return trace.Wrap(err)
}
if !s.started {
if canStart {
go func() {
if err := s.launch(); err != nil {
s.log.WithError(err).Warning("Failed to launch Kubernetes session.")
}
}()
} else if len(s.parties) == 1 {
base := "Waiting for required participants..."
if s.displayParticipantRequirements {
s.BroadcastMessage(base+"\r\n%v", s.accessEvaluator.PrettyRequirementsList())
} else {
s.BroadcastMessage(base)
}
}
} else if canStart && s.tracker.GetState() == types.SessionState_SessionStatePending {
// If the session is already running, but the party is a moderator that left
// a session with onLeave=pause and then rejoined, we need to unpause the session.
// When the moderator left the session, the session was paused, and we spawn
// a goroutine to wait for the moderator to rejoin. If the moderator rejoins
// before the session ends, we need to unpause the session by updating its state and
// the goroutine will unblock the s.io terminal.
// types.SessionState_SessionStatePending marks a session that is waiting for
// a moderator to rejoin.
if err := s.tracker.UpdateState(s.forwarder.ctx, types.SessionState_SessionStateRunning); err != nil {
s.log.Warnf("Failed to set tracker state to %v", types.SessionState_SessionStateRunning)
}
}
return nil
}
func (s *session) BroadcastMessage(format string, args ...any) {
if s.accessEvaluator.IsModerated() {
s.io.BroadcastMessage(fmt.Sprintf(format, args...))
}
}
// leave removes a party from the session and returns if the party was still active
// in the session. If the party wasn't found, it returns false, nil.
func (s *session) leave(id uuid.UUID) (bool, error) {
s.mu.Lock()
defer s.mu.Unlock()
return s.unlockedLeave(id)
}
// unlockedLeave removes a party from the session without locking the mutex.
// The boolean returned identifies if the party was still active in the session.
// If the party wasn't found, it returns false, nil.
// In order to call this function, lock the mutex before.
func (s *session) unlockedLeave(id uuid.UUID) (bool, error) {
var errs []error