Skip to content

[v13] Store original roles with user login state. #34355

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.

Sign up for GitHub

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
mdwn merged 2 commits into from
Nov 10, 2023
Merged

[v13] Store original roles with user login state. #34355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
19f7305
Store original roles with user login state.
Nov 6, 2023
44ba1e6
Tweak comments, code formatting, remove unnecessary nil vs. empty arr…
Nov 8, 2023
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
42 changes: 27 additions & 15 deletions api/gen/proto/go/teleport/userloginstate/v1/userloginstate.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions api/proto/teleport/userloginstate/v1/userloginstate.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,8 @@ message Spec {

// user_type is the type of user this state represents.
string user_type = 3;

// original_roles are the user roles that are part of the user's static definition. These roles are
// not affected by access granted by access lists and are obtained prior to granting access list access.
repeated string original_roles = 4;
}
14 changes: 8 additions & 6 deletions api/types/userloginstate/convert/v1/user_login_state.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,10 @@ func FromProto(msg *userloginstatev1.UserLoginState) (*userloginstate.UserLoginS
}

uls, err := userloginstate.New(headerv1.FromMetadataProto(msg.Header.Metadata), userloginstate.Spec{
Roles: msg.Spec.Roles,
Traits: traitv1.FromProto(msg.Spec.Traits),
UserType: types.UserType(msg.Spec.UserType),
OriginalRoles: msg.Spec.GetOriginalRoles(),
Roles: msg.Spec.Roles,
Traits: traitv1.FromProto(msg.Spec.Traits),
UserType: types.UserType(msg.Spec.UserType),
})

return uls, trace.Wrap(err)
Expand All @@ -46,9 +47,10 @@ func ToProto(uls *userloginstate.UserLoginState) *userloginstatev1.UserLoginStat
return &userloginstatev1.UserLoginState{
Header: headerv1.ToResourceHeaderProto(uls.ResourceHeader),
Spec: &userloginstatev1.Spec{
Roles: uls.GetRoles(),
Traits: traitv1.ToProto(uls.GetTraits()),
UserType: string(uls.Spec.UserType),
OriginalRoles: uls.GetOriginalRoles(),
Roles: uls.GetRoles(),
Traits: traitv1.ToProto(uls.GetTraits()),
UserType: string(uls.Spec.UserType),
},
}
}
3 changes: 2 additions & 1 deletion api/types/userloginstate/convert/v1/user_login_state_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@ func newUserLoginState(t *testing.T, name string) *userloginstate.UserLoginState
Name: name,
},
userloginstate.Spec{
Roles: []string{"role1", "role2"},
OriginalRoles: []string{"role1"},
Roles: []string{"role1", "role2"},
Traits: trait.Traits{
"key1": []string{"value1"},
"key2": []string{"value2"},
Expand Down
8 changes: 8 additions & 0 deletions api/types/userloginstate/user_login_state.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ type UserLoginState struct {

// Spec is the specification for the user login state.
type Spec struct {
// OriginalRoles is the list of the original roles from the user login state.
OriginalRoles []string `json:"original_roles" yaml:"original_roles"`

// Roles is the list of roles attached to the user login state.
Roles []string `json:"roles" yaml:"roles"`

Expand Down Expand Up @@ -81,6 +84,11 @@ func (u *UserLoginState) CheckAndSetDefaults() error {
return nil
}

// GetOriginalRoles returns the original roles that the user login state was derived from.
func (u *UserLoginState) GetOriginalRoles() []string {
return u.Spec.OriginalRoles
}

// GetRoles returns the roles attached to the user login state.
func (u *UserLoginState) GetRoles() []string {
return u.Spec.Roles
Expand Down
8 changes: 5 additions & 3 deletions lib/auth/userloginstate/generator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,14 +119,16 @@ func (g *Generator) Generate(ctx context.Context, user types.User) (*userloginst
traits[k] = utils.CopyStrings(v)
}
}

// Create a new empty user login state.
uls, err := userloginstate.New(
header.Metadata{
Name: user.GetName(),
}, userloginstate.Spec{
Roles: utils.CopyStrings(user.GetRoles()),
Traits: traits,
UserType: user.GetUserType(),
OriginalRoles: utils.CopyStrings(user.GetRoles()),
Roles: utils.CopyStrings(user.GetRoles()),
Traits: traits,
UserType: user.GetUserType(),
})
if err != nil {
return nil, trace.Wrap(err)
Expand Down
94 changes: 32 additions & 62 deletions lib/auth/userloginstate/generator_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,10 @@ func TestAccessLists(t *testing.T) {
user: user,
cloud: true,
roles: []string{"orole1"},
expected: newUserLoginState(t, "user", []string{
"orole1",
}, map[string][]string{
"otrait1": {"value1", "value2"},
}),
expected: newUserLoginState(t, "user",
[]string{"orole1"},
[]string{"orole1"},
trait.Traits{"otrait1": {"value1", "value2"}}),
expectedRoleCount: 0,
expectedTraitCount: 0,
},
Expand All @@ -92,15 +91,9 @@ func TestAccessLists(t *testing.T) {
members: append(newAccessListMembers(t, clock, "1", "user"), newAccessListMembers(t, clock, "2", "user")...),
roles: []string{"orole1", "role1", "role2"},
expected: newUserLoginState(t, "user",
[]string{
"orole1",
"role1",
"role2",
}, trait.Traits{
"otrait1": []string{"value1", "value2"},
"trait1": []string{"value1", "value2"},
"trait2": []string{"value3"},
}),
[]string{"orole1"},
[]string{"orole1", "role1", "role2"},
trait.Traits{"otrait1": {"value1", "value2"}, "trait1": {"value1", "value2"}, "trait2": {"value3"}}),
expectedRoleCount: 2,
expectedTraitCount: 3,
},
Expand All @@ -120,15 +113,9 @@ func TestAccessLists(t *testing.T) {
members: append(newAccessListMembers(t, clock, "1", "user"), newAccessListMembers(t, clock, "2", "user")...),
roles: []string{"orole1", "role1", "role2"},
expected: newUserLoginState(t, "user",
[]string{
"orole1",
"role1",
"role2",
}, trait.Traits{
"otrait1": []string{"value1", "value2"},
"trait1": []string{"value1", "value2"},
"trait2": []string{"value3"},
}),
[]string{"orole1"},
[]string{"orole1", "role1", "role2"},
trait.Traits{"otrait1": {"value1", "value2"}, "trait1": {"value1", "value2"}, "trait2": {"value3"}}),
expectedRoleCount: 0,
expectedTraitCount: 0,
},
Expand All @@ -148,11 +135,9 @@ func TestAccessLists(t *testing.T) {
members: append(newAccessListMembers(t, clock, "1", "user"), newAccessListMembers(t, clock, "2", "user")...),
roles: []string{"orole1"},
expected: newUserLoginState(t, "user",
[]string{"orole1"}, trait.Traits{
"otrait1": []string{"value1", "value2"},
"trait1": []string{"value1", "value2"},
"trait2": []string{"value3"},
}),
[]string{"orole1"},
[]string{"orole1"},
trait.Traits{"otrait1": {"value1", "value2"}, "trait1": {"value1", "value2"}, "trait2": {"value3"}}),
expectedRoleCount: 0,
expectedTraitCount: 3,
},
Expand All @@ -172,13 +157,10 @@ func TestAccessLists(t *testing.T) {
members: append(newAccessListMembers(t, clock, "1", "user"), newAccessListMembers(t, clock, "2", "not-user")...),
roles: []string{"orole1", "role1", "role2"},
expected: newUserLoginState(t, "user",
[]string{
"orole1",
"role1",
}, trait.Traits{
"otrait1": []string{"value1", "value2"},
"trait1": []string{"value1"},
}),
[]string{"orole1"},
[]string{"orole1", "role1"},
trait.Traits{
"otrait1": {"value1", "value2"}, "trait1": {"value1"}}),
expectedRoleCount: 1,
expectedTraitCount: 1,
},
Expand All @@ -193,14 +175,9 @@ func TestAccessLists(t *testing.T) {
members: append(newAccessListMembers(t, clock, "1", "user"), newAccessListMembers(t, clock, "2", "user")...),
roles: []string{"orole1", "role1", "role2", "role3"},
expected: newUserLoginState(t, "user",
[]string{
"orole1",
"role1",
"role2",
"role3",
}, trait.Traits{
"otrait1": []string{"value1", "value2"},
}),
[]string{"orole1"},
[]string{"orole1", "role1", "role2", "role3"},
trait.Traits{"otrait1": {"value1", "value2"}}),
expectedRoleCount: 3,
expectedTraitCount: 0,
},
Expand All @@ -225,15 +202,9 @@ func TestAccessLists(t *testing.T) {
members: append(newAccessListMembers(t, clock, "1", "user"), newAccessListMembers(t, clock, "2", "user")...),
roles: []string{"orole1"},
expected: newUserLoginState(t, "user",
[]string{
"orole1",
},
trait.Traits{
"otrait1": []string{"value1", "value2"},
"trait1": []string{"value1", "value2"},
"trait2": []string{"value3", "value4", "value1"},
"trait3": []string{"value5", "value6"},
}),
[]string{"orole1"},
[]string{"orole1"},
trait.Traits{"otrait1": {"value1", "value2"}, "trait1": {"value1", "value2"}, "trait2": {"value3", "value4", "value1"}, "trait3": {"value5", "value6"}}),
expectedRoleCount: 0,
expectedTraitCount: 7,
},
Expand All @@ -257,14 +228,12 @@ func TestAccessLists(t *testing.T) {
members: append(newAccessListMembers(t, clock, "1", "user"), newAccessListMembers(t, clock, "2", "user")...),
roles: []string{"role1"},
expected: newUserLoginState(t, "user",
[]string{
"role1",
},
nil,
[]string{"role1"},
trait.Traits{
"trait1": []string{"value1", "value2"},
"trait2": []string{"value3", "value4"},
"trait3": []string{"value5", "value6"},
}),
"trait1": {"value1", "value2"},
"trait2": {"value3", "value4"},
"trait3": {"value5", "value6"}}),
expectedRoleCount: 1,
expectedTraitCount: 6,
},
Expand Down Expand Up @@ -411,14 +380,15 @@ func newAccessListMembers(t *testing.T, clock clockwork.Clock, accessList string
return alMembers
}

func newUserLoginState(t *testing.T, name string, roles []string, traits map[string][]string) *userloginstate.UserLoginState {
func newUserLoginState(t *testing.T, name string, originalRoles, roles []string, traits map[string][]string) *userloginstate.UserLoginState {
t.Helper()

uls, err := userloginstate.New(header.Metadata{
Name: name,
}, userloginstate.Spec{
Roles: roles,
Traits: traits,
OriginalRoles: originalRoles,
Roles: roles,
Traits: traits,
})
require.NoError(t, err)

Expand Down
16 changes: 8 additions & 8 deletions lib/auth/userloginstate/service_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ func TestGetUserLoginStates(t *testing.T) {
require.NoError(t, err)
require.Empty(t, getResp.UserLoginStates)

uls1 := newUserLoginState(t, "1", stRoles, stTraits)
uls2 := newUserLoginState(t, "2", stRoles, stTraits)
uls1 := newUserLoginState(t, "1", stRoles, stRoles, stTraits)
uls2 := newUserLoginState(t, "2", stRoles, stRoles, stTraits)

_, err = svc.UpsertUserLoginState(ctx, &userloginstatev1.UpsertUserLoginStateRequest{UserLoginState: conv.ToProto(uls1)})
require.NoError(t, err)
Expand All @@ -94,8 +94,8 @@ func TestUpsertUserLoginStates(t *testing.T) {
require.NoError(t, err)
require.Empty(t, getResp.UserLoginStates)

uls1 := newUserLoginState(t, "1", stRoles, stTraits)
uls2 := newUserLoginState(t, "2", stRoles, stTraits)
uls1 := newUserLoginState(t, "1", stRoles, stRoles, stTraits)
uls2 := newUserLoginState(t, "2", stRoles, stRoles, stTraits)

_, err = svc.UpsertUserLoginState(ctx, &userloginstatev1.UpsertUserLoginStateRequest{UserLoginState: conv.ToProto(uls1)})
require.NoError(t, err)
Expand All @@ -117,7 +117,7 @@ func TestGetUserLoginState(t *testing.T) {
require.NoError(t, err)
require.Empty(t, getResp.UserLoginStates)

uls1 := newUserLoginState(t, "1", stRoles, stTraits)
uls1 := newUserLoginState(t, "1", stRoles, stRoles, stTraits)

_, err = svc.UpsertUserLoginState(ctx, &userloginstatev1.UpsertUserLoginStateRequest{UserLoginState: conv.ToProto(uls1)})
require.NoError(t, err)
Expand All @@ -143,7 +143,7 @@ func TestDeleteUserLoginState(t *testing.T) {
require.NoError(t, err)
require.Empty(t, getResp.UserLoginStates)

uls1 := newUserLoginState(t, "1", stRoles, stTraits)
uls1 := newUserLoginState(t, "1", stRoles, stRoles, stTraits)

_, err = svc.UpsertUserLoginState(ctx, &userloginstatev1.UpsertUserLoginStateRequest{UserLoginState: conv.ToProto(uls1)})
require.NoError(t, err)
Expand All @@ -170,8 +170,8 @@ func TestDeleteAllAccessLists(t *testing.T) {
require.NoError(t, err)
require.Empty(t, getResp.UserLoginStates)

uls1 := newUserLoginState(t, "1", stRoles, stTraits)
uls2 := newUserLoginState(t, "2", stRoles, stTraits)
uls1 := newUserLoginState(t, "1", stRoles, stRoles, stTraits)
uls2 := newUserLoginState(t, "2", stRoles, stRoles, stTraits)

_, err = svc.UpsertUserLoginState(ctx, &userloginstatev1.UpsertUserLoginStateRequest{UserLoginState: conv.ToProto(uls1)})
require.NoError(t, err)
Expand Down