Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v10] Prevent "session.start" from being overwritten by "session.exec" #19496

Merged
merged 2 commits into from
Dec 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions lib/srv/ctx.go
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,10 @@ type IdentityContext struct {
// and other resources. SessionContext also holds a ServerContext which can be
// used to access resources on the underlying server. SessionContext can also
// be used to attach resources that should be closed once the session closes.
//
// Any events that need to be recorded should be emitted via session and not
// ServerContext directly. Failure to use the session emitted will result in
// incorrect event indexes that may ultimately cause events to be overwritten.
type ServerContext struct {
// ConnectionContext is the parent context which manages connection-level
// resources.
Expand Down
12 changes: 9 additions & 3 deletions lib/srv/exec.go
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,11 @@ func (e *remoteExec) PID() int {
return 0
}

// emitExecAuditEvent emits either an SCP or exec event based on the
// command run.
//
// Note: to ensure that the event is recorded ctx.session must be used
// instead of ctx.srv.
func emitExecAuditEvent(ctx *ServerContext, cmd string, execErr error) {
// Create common fields for event.
serverMeta := apievents.ServerMetadata{
Expand Down Expand Up @@ -436,13 +441,14 @@ func emitExecAuditEvent(ctx *ServerContext, cmd string, execErr error) {
scpEvent.Code = events.SCPDownloadCode
}
}
if err := ctx.srv.EmitAuditEvent(ctx.srv.Context(), scpEvent); err != nil {
if err := ctx.session.emitAuditEvent(ctx.srv.Context(), scpEvent); err != nil {
log.WithError(err).Warn("Failed to emit scp event.")
}
} else {
execEvent := &apievents.Exec{
Metadata: apievents.Metadata{
Type: events.ExecEvent,
Type: events.ExecEvent,
ClusterName: ctx.ClusterName,
},
ServerMetadata: serverMeta,
SessionMetadata: sessionMeta,
Expand All @@ -455,7 +461,7 @@ func emitExecAuditEvent(ctx *ServerContext, cmd string, execErr error) {
} else {
execEvent.Code = events.ExecCode
}
if err := ctx.srv.EmitAuditEvent(ctx.srv.Context(), execEvent); err != nil {
if err := ctx.session.emitAuditEvent(ctx.srv.Context(), execEvent); err != nil {
log.WithError(err).Warn("Failed to emit exec event.")
}
}
Expand Down
14 changes: 11 additions & 3 deletions lib/srv/exec_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import (

"github.com/gravitational/teleport"
apievents "github.com/gravitational/teleport/api/types/events"
"github.com/gravitational/teleport/lib/events"
"github.com/gravitational/teleport/lib/sshutils"
)

Expand All @@ -37,6 +38,9 @@ func TestEmitExecAuditEvent(t *testing.T) {
srv := newMockServer(t)
scx := newExecServerContext(t, srv)

rec, ok := scx.session.recorder.(*mockRecorder)
require.True(t, ok)

expectedUsr, err := user.Current()
require.NoError(t, err)
expectedHostname, err := os.Hostname()
Expand Down Expand Up @@ -84,7 +88,7 @@ func TestEmitExecAuditEvent(t *testing.T) {
}
for _, tt := range tests {
emitExecAuditEvent(scx, tt.inCommand, tt.inError)
execEvent := srv.MockEmitter.LastEvent().(*apievents.Exec)
execEvent := rec.emitter.LastEvent().(*apievents.Exec)
require.Equal(t, tt.outCommand, execEvent.Command)
require.Equal(t, tt.outCode, execEvent.ExitCode)
require.Equal(t, expectedMeta, execEvent.UserMetadata)
Expand All @@ -94,6 +98,7 @@ func TestEmitExecAuditEvent(t *testing.T) {
require.Equal(t, "xxx", execEvent.SessionID)
require.Equal(t, "10.0.0.5:4817", execEvent.RemoteAddr)
require.Equal(t, "127.0.0.1:3022", execEvent.LocalAddr)
require.NotZero(t, events.EventID)
}
}

Expand All @@ -113,8 +118,11 @@ func newExecServerContext(t *testing.T, srv Server) *ServerContext {
require.NoError(t, err)
term.SetTermType("xterm")

scx.session = &session{id: "xxx"}
scx.session.term = term
scx.session = &session{
id: "xxx",
term: term,
recorder: &mockRecorder{done: false},
}
err = scx.SetSSHRequest(&ssh.Request{Type: sshutils.ExecRequest})
require.NoError(t, err)

Expand Down
7 changes: 6 additions & 1 deletion lib/srv/sess_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -613,7 +613,8 @@ func testOpenSession(t *testing.T, reg *SessionRegistry, roleSet services.RoleSe

type mockRecorder struct {
events.StreamWriter
done bool
emitter eventstest.MockEmitter
done bool
}

func (m *mockRecorder) Done() <-chan struct{} {
Expand All @@ -625,6 +626,10 @@ func (m *mockRecorder) Done() <-chan struct{} {
return ch
}

func (m *mockRecorder) EmitAuditEvent(ctx context.Context, event apievents.AuditEvent) error {
return m.emitter.EmitAuditEvent(ctx, event)
}

type trackerService struct {
created int32
createError error
Expand Down