Skip to content

Commit

Permalink
⭐️ integrate preflight check: role assignments
Browse files Browse the repository at this point in the history
This change adds a minimalistic preflight check where we verify that the
user has the right role assignments to onboard an Azure environment.

We need one of "Privileged Role Administrator" or "Global Administrator"
=> https://learn.microsoft.com/en-us/entra/identity/role-based-access-control/permissions-reference#privileged-role-administrator

Note that we run Azure CLI commands directly so that `cnspec` doesn't
have to import the entire Azure SDK which will make the binary much
bigger, which today is unnecessary for the amount of checks we are
running.

Signed-off-by: Salim Afiune Maya <afiune@mondoo.com>
  • Loading branch information
afiune committed Nov 22, 2024
1 parent f139271 commit 4feddcb
Show file tree
Hide file tree
Showing 2 changed files with 102 additions and 2 deletions.
7 changes: 5 additions & 2 deletions apps/cnspec/cmd/integrate.go
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,11 @@ NOTE that --allow and --deny are mutually exclusive and can't be use together.`,
os.Exit(1)
}

// TODO ideally, we should verify that the user has the "Privileged Role Administrator" or "Global Administrator"
// => https://learn.microsoft.com/en-us/entra/identity/role-based-access-control/permissions-reference#privileged-role-administrator
// Verify that the user has the right role assignments to onboard an Azure environment
log.Info().Msg("verifying role assignments for the currently logged-in user")
if err := onboarding.VerifyUserRoleAssignments(); err != nil {
return errors.Wrap(err, "preflight verification failed")
}

// Generate HCL for azure deployment
log.Info().Msg("generating automation code")
Expand Down
97 changes: 97 additions & 0 deletions internal/onboarding/azure.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
package onboarding

import (
"encoding/json"
"fmt"
"os/exec"
"strings"

"github.com/cockroachdb/errors"
Expand Down Expand Up @@ -281,3 +283,98 @@ func generateAzureIntegrationName(subscription string) string {
var subsSplit = strings.Split(subscription, "-")
return "subscription-" + subsSplit[len(subsSplit)-1]
}

// VerifyUserRoleAssignments checks that the user running onboarding has the right role
// assignments to run the automation.
//
// We need one of "Privileged Role Administrator" or "Global Administrator"
// => https://learn.microsoft.com/en-us/entra/identity/role-based-access-control/permissions-reference#privileged-role-administrator
//
// Note that we run Azure CLI commands so that cnspec doesn't have to import the entire
// Azure SDK which will make the binary much bigger, which is unnecessary for the amount
// of checks we are running today.
func VerifyUserRoleAssignments() error {
var BuiltInRoles = map[string]string{
"Privileged Role Administrator": "e8611ab8-c189-46e8-94e1-60213ab1f814",
"Global Administrator": "62e90394-69f5-4237-9190-012177145e10",
}

principalID, err := getCurrentUserServicePrincipal()
if err != nil {
return err
}
log.Info().Msgf("user service principal %s", theme.DefaultTheme.Primary(principalID))

var errs []error
theUserWillFail := true
for roleName, roleID := range BuiltInRoles {
assignments, err := getRoleAssignmentsForRole(roleID)
if err != nil {
errs = append(errs, errors.Wrapf(err, "- %s", roleName))
continue
}

if assignments.ContainsPrincipalID(principalID) {
// the user will succeed
log.Info().Msgf("role assignment %s found", theme.DefaultTheme.Success(roleName))
theUserWillFail = false
break
}
log.Info().Msgf("role assignment %s not found", theme.DefaultTheme.Secondary(roleName))
}

if theUserWillFail {
return errors.Newf(
"one of the following role assignments are required:\n\n%s",
errors.Join(errs...),
)
}
return nil
}

func getCurrentUserServicePrincipal() (string, error) {
signedUserJSON, err := exec.Command("az", "ad", "signed-in-user", "show", "-o", "json").Output()
if err != nil {
return "", errors.Wrap(err, "unable to get details for the currently logged-in user")
}
var userSP struct {
ID string `json:"id"`
}
err = json.Unmarshal(signedUserJSON, &userSP)
return userSP.ID, errors.Wrap(err, "unable to parse user details")
}

type roleAssignmentResponse struct {
Value []roleAssignment
}

func (r roleAssignmentResponse) ContainsPrincipalID(id string) bool {
for _, assignment := range r.Value {
if assignment.PrincipalID == id {
return true
}
}
return false
}

type roleAssignment struct {
DirectoryScopeID string
ID string
PrincipalID string
RoleDefinitionID string
}

func getRoleAssignmentsForRole(roleID string) (roleAssignmentResponse, error) {
restURL := fmt.Sprintf(
"https://graph.microsoft.com/v1.0/roleManagement/directory/roleAssignments?$filter=roleDefinitionId eq '%s'",
roleID,
)
var roleAssignments roleAssignmentResponse
restResponse, err := exec.Command("az", "rest", "--method", "get", "--url", restURL, "-o", "json").Output()
if err != nil {
return roleAssignments, errors.Wrap(err, "unable to list role assignments via REST")
}

err = json.Unmarshal(restResponse, &roleAssignments)
return roleAssignments, errors.Wrap(err, "unable to parse role assignments")
}

0 comments on commit 4feddcb

Please sign in to comment.