Skip to content

[v9] Add nil check for billing mode in AWS DynamoDB events driver #12461

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

Merged
merged 2 commits into from
May 5, 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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions lib/events/dynamic.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,17 @@ func FromEventFields(fields EventFields) (apievents.AuditEvent, error) {
return nil, trace.Wrap(err)
}

eventType := fields.GetString(EventType)
var e apievents.AuditEvent
getFieldEmpty := func(field string) string {
i, ok := fields[field]
if !ok {
return ""
}
s, _ := i.(string)
return s
}

var eventType = getFieldEmpty(EventType)
var e events.AuditEvent

switch eventType {
case SessionPrintEvent:
Expand Down Expand Up @@ -240,7 +249,7 @@ func FromEventFields(fields EventFields) (apievents.AuditEvent, error) {
unknown.Type = UnknownEvent
unknown.Code = UnknownCode
unknown.UnknownType = eventType
unknown.UnknownCode = fields.GetString(EventCode)
unknown.UnknownCode = getFieldEmpty(EventCode)
unknown.Data = string(data)
return unknown, nil
}
Expand Down
69 changes: 69 additions & 0 deletions lib/events/dynamic_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
/*
Copyright 2022 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 events

import (
"testing"

"github.com/gravitational/teleport/api/types/events"
"github.com/stretchr/testify/require"
)

// TestDynamicTypeUnknown checks that we correctly translate unknown events strings into the correct proto type.
func TestDynamicUnknownType(t *testing.T) {
fields := EventFields{
EventType: "suspicious-cert-event",
EventCode: "foobar",
}

event, err := FromEventFields(fields)
require.NoError(t, err)

require.Equal(t, UnknownEvent, event.GetType())
require.Equal(t, UnknownCode, event.GetCode())
unknownEvent := event.(*events.Unknown)
require.Equal(t, "suspicious-cert-event", unknownEvent.UnknownType)
require.Equal(t, "foobar", unknownEvent.UnknownCode)
}

// TestDynamicNotSet checks that we properly handle cases where the event type is not set.
func TestDynamicTypeNotSet(t *testing.T) {
fields := EventFields{
"foo": "bar",
}

event, err := FromEventFields(fields)
require.NoError(t, err)

require.Equal(t, UnknownEvent, event.GetType())
require.Equal(t, UnknownCode, event.GetCode())
unknownEvent := event.(*events.Unknown)
require.Equal(t, "", unknownEvent.UnknownType)
require.Equal(t, "", unknownEvent.UnknownCode)
}

// TestDynamicTypeUnknown checks that we correctly translate known events into the correct proto type.
func TestDynamicKnownType(t *testing.T) {
fields := EventFields{
EventType: "print",
}

event, err := FromEventFields(fields)
require.NoError(t, err)
printEvent := event.(*events.SessionPrint)
require.Equal(t, SessionPrintEvent, printEvent.GetType())
}
11 changes: 9 additions & 2 deletions lib/events/dynamoevents/dynamoevents.go
Original file line number Diff line number Diff line change
Expand Up @@ -1167,14 +1167,21 @@ func (l *Log) getTableStatus(ctx context.Context, tableName string) (tableStatus
}

func (l *Log) getBillingModeIsProvisioned(ctx context.Context) (bool, error) {
table, err := l.svc.DescribeTableWithContext(ctx, &dynamodb.DescribeTableInput{
res, err := l.svc.DescribeTableWithContext(ctx, &dynamodb.DescribeTableInput{
TableName: aws.String(l.Tablename),
})
if err != nil {
return false, trace.Wrap(err)
}

return *table.Table.BillingModeSummary.BillingMode == dynamodb.BillingModeProvisioned, nil
// Guaranteed to be set.
table := res.Table

// Perform pessimistic nil-checks, assume the table is provisioned if they are true.
// Otherwise, actually check the billing mode.
return table.BillingModeSummary == nil ||
table.BillingModeSummary.BillingMode == nil ||
*table.BillingModeSummary.BillingMode == dynamodb.BillingModeProvisioned, nil
}

// indexExists checks if a given index exists on a given table and that it is active or updating.
Expand Down
27 changes: 16 additions & 11 deletions lib/events/dynamoevents/dynamoevents_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -123,12 +123,15 @@ func (s *DynamoeventsSuite) TestSizeBreak(c *check.C) {

const eventCount int = 10
for i := 0; i < eventCount; i++ {
err := s.Log.EmitAuditEventLegacy(events.UserLocalLoginE, events.EventFields{
events.LoginMethod: events.LoginMethodSAML,
events.AuthAttemptSuccess: true,
events.EventUser: "bob",
events.EventTime: s.Clock.Now().UTC().Add(time.Second * time.Duration(i)),
"test.data": blob,
err := s.Log.EmitAuditEvent(context.Background(), &apievents.UserLogin{
Method: events.LoginMethodSAML,
Status: apievents.Status{Success: true},
UserMetadata: apievents.UserMetadata{User: "bob"},
Metadata: apievents.Metadata{
Type: events.UserLoginEvent,
Time: s.Clock.Now().UTC().Add(time.Second * time.Duration(i)),
},
IdentityAttributes: apievents.MustEncodeMap(map[string]interface{}{"test.data": blob}),
})
c.Assert(err, check.IsNil)
}
Expand Down Expand Up @@ -309,11 +312,13 @@ var _ = check.Suite(&DynamoeventsLargeTableSuite{})
func (s *DynamoeventsLargeTableSuite) TestLargeTableRetrieve(c *check.C) {
const eventCount = 4000
for i := 0; i < eventCount; i++ {
err := s.Log.EmitAuditEventLegacy(events.UserLocalLoginE, events.EventFields{
events.LoginMethod: events.LoginMethodSAML,
events.AuthAttemptSuccess: true,
events.EventUser: "bob",
events.EventTime: s.Clock.Now().UTC(),
err := s.Log.EmitAuditEvent(context.Background(), &apievents.UserLogin{
Method: events.LoginMethodSAML,
Status: apievents.Status{Success: true},
UserMetadata: apievents.UserMetadata{User: "bob"},
Metadata: apievents.Metadata{
Type: events.UserLoginEvent,
Time: s.Clock.Now().UTC()},
})
c.Assert(err, check.IsNil)
}
Expand Down
57 changes: 47 additions & 10 deletions lib/events/test/suite.go
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,14 @@ func (s *EventsSuite) EventPagination(c *check.C) {
names := []string{"bob", "jack", "daisy", "evan"}

for i, name := range names {
err := s.Log.EmitAuditEventLegacy(events.UserLocalLoginE, events.EventFields{
events.LoginMethod: events.LoginMethodSAML,
events.AuthAttemptSuccess: true,
events.EventUser: name,
events.EventTime: baseTime.Add(time.Second * time.Duration(i)),
err := s.Log.EmitAuditEvent(context.Background(), &apievents.UserLogin{
Method: events.LoginMethodSAML,
Status: apievents.Status{Success: true},
UserMetadata: apievents.UserMetadata{User: name},
Metadata: apievents.Metadata{
Type: events.UserLoginEvent,
Time: baseTime.Add(time.Second * time.Duration(i)),
},
})
c.Assert(err, check.IsNil)
}
Expand Down Expand Up @@ -166,11 +169,14 @@ func (s *EventsSuite) EventPagination(c *check.C) {
// SessionEventsCRUD covers session events
func (s *EventsSuite) SessionEventsCRUD(c *check.C) {
// Bob has logged in
err := s.Log.EmitAuditEventLegacy(events.UserLocalLoginE, events.EventFields{
events.LoginMethod: events.LoginMethodSAML,
events.AuthAttemptSuccess: true,
events.EventUser: "bob",
events.EventTime: s.Clock.Now().UTC(),
err := s.Log.EmitAuditEvent(context.Background(), &apievents.UserLogin{
Method: events.LoginMethodSAML,
Status: apievents.Status{Success: true},
UserMetadata: apievents.UserMetadata{User: "bob"},
Metadata: apievents.Metadata{
Type: events.UserLoginEvent,
Time: s.Clock.Now().UTC(),
},
})
c.Assert(err, check.IsNil)

Expand Down Expand Up @@ -213,6 +219,37 @@ func (s *EventsSuite) SessionEventsCRUD(c *check.C) {
})
c.Assert(err, check.IsNil)

err = s.Log.EmitAuditEvent(context.Background(), &apievents.SessionStart{
Metadata: apievents.Metadata{
Time: s.Clock.Now().UTC(),
Index: 0,
Type: events.SessionStartEvent,
},
SessionMetadata: apievents.SessionMetadata{
SessionID: string(sessionID),
},
UserMetadata: apievents.UserMetadata{
Login: "bob",
},
})
c.Assert(err, check.IsNil)

err = s.Log.EmitAuditEvent(context.Background(), &apievents.SessionEnd{
Metadata: apievents.Metadata{
Time: s.Clock.Now().Add(time.Hour).UTC(),
Index: 4,
Type: events.SessionEndEvent,
},
UserMetadata: apievents.UserMetadata{
Login: "bob",
},
SessionMetadata: apievents.SessionMetadata{
SessionID: string(sessionID),
},
Participants: []string{"bob", "alice"},
})
c.Assert(err, check.IsNil)

// read the session event
historyEvents, err := s.Log.GetSessionEvents(apidefaults.Namespace, sessionID, 0, false)
c.Assert(err, check.IsNil)
Expand Down