Skip to content

MFA for Admin Actions: user groups #35464

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
Joerger merged 7 commits into from
Dec 19, 2023
Merged

MFA for Admin Actions: user groups #35464

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9b7909c
Refactor admin action tctl tests to use testify/suite for shared setu…
Joerger Dec 16, 2023
ae2beeb
Make user group endpoints admin actions.
Joerger Nov 17, 2023
23e45d5
Add tctl test.
Joerger Dec 7, 2023
41bf5d8
Merge branch 'master' into joerger/admin-actions-user-groups
Joerger Dec 19, 2023
bed137b
Merge branch 'master' into joerger/admin-actions-user-groups
Joerger Dec 19, 2023
eabea72
Merge branch 'master' into joerger/admin-actions-user-groups
Joerger Dec 19, 2023
d9577be
Revert TestAdminActionMFA to not use testify/suite to properly skip t…
Joerger Dec 19, 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
16 changes: 16 additions & 0 deletions lib/auth/auth_with_roles.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6484,6 +6484,10 @@ func (a *ServerWithRoles) CreateUserGroup(ctx context.Context, userGroup types.U
return trace.Wrap(err)
}

if err := authz.AuthorizeAdminAction(ctx, &a.context); err != nil {
return trace.Wrap(err)
}

if err := a.checkAccessToUserGroup(userGroup); err != nil {
return trace.Wrap(err)
}
Expand All @@ -6497,6 +6501,10 @@ func (a *ServerWithRoles) UpdateUserGroup(ctx context.Context, userGroup types.U
return trace.Wrap(err)
}

if err := authz.AuthorizeAdminAction(ctx, &a.context); err != nil {
return trace.Wrap(err)
}

previousUserGroup, err := a.authServer.GetUserGroup(ctx, userGroup.GetName())
if err != nil {
return trace.Wrap(err)
Expand All @@ -6515,6 +6523,10 @@ func (a *ServerWithRoles) DeleteUserGroup(ctx context.Context, name string) erro
return trace.Wrap(err)
}

if err := authz.AuthorizeAdminAction(ctx, &a.context); err != nil {
return trace.Wrap(err)
}

previousUserGroup, err := a.authServer.GetUserGroup(ctx, name)
if err != nil {
return trace.Wrap(err)
Expand All @@ -6533,6 +6545,10 @@ func (a *ServerWithRoles) DeleteAllUserGroups(ctx context.Context) error {
return trace.Wrap(err)
}

if err := authz.AuthorizeAdminAction(ctx, &a.context); err != nil {
return trace.Wrap(err)
}

return a.authServer.DeleteAllUserGroups(ctx)
}

Expand Down
74 changes: 53 additions & 21 deletions tool/tctl/common/admin_action_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ import (

"github.com/gravitational/trace"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"

"github.com/gravitational/teleport"
"github.com/gravitational/teleport/api/client"
"github.com/gravitational/teleport/api/client/proto"
"github.com/gravitational/teleport/api/constants"
"github.com/gravitational/teleport/api/mfa"
"github.com/gravitational/teleport/api/types"
apiutils "github.com/gravitational/teleport/api/utils"
"github.com/gravitational/teleport/lib/auth"
"github.com/gravitational/teleport/lib/auth/mocku2f"
wancli "github.com/gravitational/teleport/lib/auth/webauthncli"
Expand All @@ -51,11 +51,15 @@ import (
)

func TestAdminActionMFA(t *testing.T) {
suite.Run(t, &AdminActionTestSuite{})
s := newAdminActionTestSuite(t)

t.Run("Users", s.testUsers)
t.Run("Bots", s.testBots)
t.Run("Roles", s.testRoles)
t.Run("UserGroups", s.testUserGroups)
}

func (s *AdminActionTestSuite) TestUser() {
t := s.T()
func (s *adminActionTestSuite) testUsers(t *testing.T) {
ctx := context.Background()

user, err := types.NewUser("teleuser")
Expand Down Expand Up @@ -107,8 +111,7 @@ func (s *AdminActionTestSuite) TestUser() {
})
}

func (s *AdminActionTestSuite) TestBot() {
t := s.T()
func (s *adminActionTestSuite) testBots(t *testing.T) {
ctx := context.Background()

botReq := &proto.CreateBotRequest{
Expand Down Expand Up @@ -146,8 +149,7 @@ func (s *AdminActionTestSuite) TestBot() {
})
}

func (s *AdminActionTestSuite) TestRole() {
t := s.T()
func (s *adminActionTestSuite) testRoles(t *testing.T) {
ctx := context.Background()

role, err := types.NewRole("telerole", types.RoleSpecV6{})
Expand Down Expand Up @@ -180,13 +182,37 @@ func (s *AdminActionTestSuite) TestRole() {
})
}

func (s *adminActionTestSuite) testUserGroups(t *testing.T) {
ctx := context.Background()

userGroup, err := types.NewUserGroup(types.Metadata{
Name: "teleusergroup",
Labels: map[string]string{"label": "value"},
}, types.UserGroupSpecV1{})
require.NoError(t, err)

// Only deletion is permitted through tctl.
t.Run("tctl rm", func(t *testing.T) {
s.testCommand(t, ctx, adminActionTestCase{
command: fmt.Sprintf("rm %v", getResourceRef(userGroup)),
cliCommand: &tctl.ResourceCommand{},
setup: func() error {
return s.authServer.CreateUserGroup(ctx, userGroup)
},
cleanup: func() error {
return s.authServer.DeleteUserGroup(ctx, userGroup.GetName())
},
})
})
}

type resourceCommandTestCase struct {
resource types.Resource
resourceCreate func() error
resourceDelete func() error
}

func (s *AdminActionTestSuite) testResourceCommand(t *testing.T, ctx context.Context, tc resourceCommandTestCase) {
func (s *adminActionTestSuite) testResourceCommand(t *testing.T, ctx context.Context, tc resourceCommandTestCase) {
t.Helper()

f, err := os.CreateTemp(t.TempDir(), "resource-*.yaml")
Expand Down Expand Up @@ -227,7 +253,7 @@ type editCommandTestCase struct {
resourceDelete func() error
}

func (s *AdminActionTestSuite) testEditCommand(t *testing.T, ctx context.Context, tc editCommandTestCase) {
func (s *adminActionTestSuite) testEditCommand(t *testing.T, ctx context.Context, tc editCommandTestCase) {
t.Run("tctl edit", func(t *testing.T) {
s.testCommand(t, ctx, adminActionTestCase{
command: fmt.Sprintf("edit %v", tc.resourceRef),
Expand All @@ -252,17 +278,16 @@ func (s *AdminActionTestSuite) testEditCommand(t *testing.T, ctx context.Context
})
}

type AdminActionTestSuite struct {
suite.Suite
type adminActionTestSuite struct {
authServer *auth.Server
// userClientWithMFA supports MFA prompt for admin actions.
userClientWithMFA auth.ClientI
// userClientWithMFA does not support MFA prompt for admin actions.
userClientNoMFA auth.ClientI
}

func (s *AdminActionTestSuite) SetupSuite() {
t := s.T()
func newAdminActionTestSuite(t *testing.T) *adminActionTestSuite {
t.Helper()
ctx := context.Background()

authPref, err := types.NewAuthPreference(types.AuthPreferenceSpecV2{
Expand All @@ -286,12 +311,13 @@ func (s *AdminActionTestSuite) SetupSuite() {
)
authAddr, err := process.AuthAddr()
require.NoError(t, err)
s.authServer = process.GetAuthServer()
authServer := process.GetAuthServer()

// create admin role and user.
username := "admin"
adminRole, err := types.NewRole(username, types.RoleSpecV6{
Allow: types.RoleConditions{
GroupLabels: types.Labels{types.Wildcard: apiutils.Strings{types.Wildcard}},
Rules: []types.Rule{
{
Resources: []string{types.Wildcard},
Expand All @@ -301,16 +327,16 @@ func (s *AdminActionTestSuite) SetupSuite() {
},
})
require.NoError(t, err)
adminRole, err = s.authServer.CreateRole(ctx, adminRole)
adminRole, err = authServer.CreateRole(ctx, adminRole)
require.NoError(t, err)

user, err := types.NewUser(username)
user.SetRoles([]string{adminRole.GetName()})
require.NoError(t, err)
_, err = s.authServer.CreateUser(ctx, user)
_, err = authServer.CreateUser(ctx, user)
require.NoError(t, err)

mockWebauthnLogin := setupWebAuthn(t, s.authServer, username)
mockWebauthnLogin := setupWebAuthn(t, authServer, username)
mockMFAPromptConstructor := func(opts ...mfa.PromptOpt) mfa.Prompt {
promptCfg := libmfa.NewPromptConfig(proxyPublicAddr.String(), opts...)
promptCfg.WebauthnLoginFunc = mockWebauthnLogin
Expand All @@ -336,22 +362,28 @@ func (s *AdminActionTestSuite) SetupSuite() {
)
require.NoError(t, err)

s.userClientNoMFA, err = auth.NewClient(client.Config{
userClientNoMFA, err := auth.NewClient(client.Config{
Addrs: []string{authAddr.String()},
Credentials: []client.Credentials{
client.LoadProfile(tshHome, ""),
},
})
require.NoError(t, err)

s.userClientWithMFA, err = auth.NewClient(client.Config{
userClientWithMFA, err := auth.NewClient(client.Config{
Addrs: []string{authAddr.String()},
Credentials: []client.Credentials{
client.LoadProfile(tshHome, ""),
},
MFAPromptConstructor: mockMFAPromptConstructor,
})
require.NoError(t, err)

return &adminActionTestSuite{
authServer: authServer,
userClientNoMFA: userClientNoMFA,
userClientWithMFA: userClientWithMFA,
}
}

type adminActionTestCase struct {
Expand All @@ -361,7 +393,7 @@ type adminActionTestCase struct {
cleanup func() error
}

func (s *AdminActionTestSuite) testCommand(t *testing.T, ctx context.Context, tc adminActionTestCase) {
func (s *adminActionTestSuite) testCommand(t *testing.T, ctx context.Context, tc adminActionTestCase) {
t.Helper()

t.Run("OK with MFA", func(t *testing.T) {
Expand Down