mirror of
https://github.com/fleetdm/fleet
synced 2026-05-06 06:48:54 +00:00
c6ab9939b5
Fixes #27758. <img width="807" height="303" alt="image" src="https://github.com/user-attachments/assets/58e5b9bc-42d6-4195-868e-bf6206ec9cd5" /> # Checklist for submitter If some of the following don't apply, delete the relevant line. <!-- Note that API documentation changes are now addressed by the product design team. --> - [x] Changes file added for user-visible changes in `changes/`, `orbit/changes/` or `ee/fleetd-chrome/changes`. See [Changes files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/guides/committing-changes.md#changes-files) for more information. - [x] Input data is properly validated, `SELECT *` is avoided, SQL injection is prevented (using placeholders for values in statements) - [x] If database migrations are included, checked table schema to confirm autoupdate - For database migrations: - [x] Checked schema for all modified table for columns that will auto-update timestamps during migration. - [x] Confirmed that updating the timestamps is acceptable, and will not cause unwanted side effects. - [x] Ensured the correct collation is explicitly set for character columns (`COLLATE utf8mb4_unicode_ci`). - [x] Added/updated automated tests - [x] Manual QA for all new/changed functionality
483 lines
15 KiB
Go
483 lines
15 KiB
Go
package service
|
|
|
|
import (
|
|
"context"
|
|
"path/filepath"
|
|
"testing"
|
|
"time"
|
|
|
|
eeservice "github.com/fleetdm/fleet/v4/ee/server/service"
|
|
authz_ctx "github.com/fleetdm/fleet/v4/server/contexts/authz"
|
|
"github.com/fleetdm/fleet/v4/server/contexts/viewer"
|
|
"github.com/fleetdm/fleet/v4/server/datastore/filesystem"
|
|
"github.com/fleetdm/fleet/v4/server/fleet"
|
|
"github.com/fleetdm/fleet/v4/server/mock"
|
|
"github.com/fleetdm/fleet/v4/server/ptr"
|
|
"github.com/fleetdm/fleet/v4/server/test"
|
|
kitlog "github.com/go-kit/log"
|
|
"github.com/jmoiron/sqlx"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestSoftwareInstallersAuth(t *testing.T) {
|
|
ds := new(mock.Store)
|
|
|
|
license := &fleet.LicenseInfo{Tier: fleet.TierPremium, Expiration: time.Now().Add(24 * time.Hour)}
|
|
|
|
svc, ctx := newTestService(t, ds, nil, nil, &TestServerOpts{License: license})
|
|
|
|
testCases := []struct {
|
|
name string
|
|
user *fleet.User
|
|
teamID *uint
|
|
shouldFailRead bool
|
|
shouldFailWrite bool
|
|
}{
|
|
{"no role no team", test.UserNoRoles, nil, true, true},
|
|
{"no role team 0", test.UserNoRoles, ptr.Uint(0), true, true},
|
|
{"no role team", test.UserNoRoles, ptr.Uint(1), true, true},
|
|
{"global admin no team", test.UserAdmin, nil, false, false},
|
|
{"global admin team 0", test.UserAdmin, ptr.Uint(0), false, false},
|
|
{"global admin team", test.UserAdmin, ptr.Uint(1), false, false},
|
|
{"global maintainer no team", test.UserMaintainer, nil, false, false},
|
|
{"global mainteiner team 0", test.UserMaintainer, ptr.Uint(0), false, false},
|
|
{"global maintainer team", test.UserMaintainer, ptr.Uint(1), false, false},
|
|
{"global observer no team", test.UserObserver, nil, true, true},
|
|
{"global observer team 0", test.UserObserver, ptr.Uint(0), true, true},
|
|
{"global observer team", test.UserObserver, ptr.Uint(1), true, true},
|
|
{"global observer+ no team", test.UserObserverPlus, nil, true, true},
|
|
{"global observer+ team 0", test.UserObserverPlus, ptr.Uint(0), true, true},
|
|
{"global observer+ team", test.UserObserverPlus, ptr.Uint(1), true, true},
|
|
{"global gitops no team", test.UserGitOps, nil, true, false},
|
|
{"global gitops team 0", test.UserGitOps, ptr.Uint(0), true, false},
|
|
{"global gitops team", test.UserGitOps, ptr.Uint(1), true, false},
|
|
{"team admin no team", test.UserTeamAdminTeam1, nil, true, true},
|
|
{"team admin team 0", test.UserTeamAdminTeam1, ptr.Uint(0), true, true},
|
|
{"team admin team", test.UserTeamAdminTeam1, ptr.Uint(1), false, false},
|
|
{"team admin other team", test.UserTeamAdminTeam2, ptr.Uint(1), true, true},
|
|
{"team maintainer no team", test.UserTeamMaintainerTeam1, nil, true, true},
|
|
{"team maintainer team 0", test.UserTeamMaintainerTeam1, ptr.Uint(0), true, true},
|
|
{"team maintainer team", test.UserTeamMaintainerTeam1, ptr.Uint(1), false, false},
|
|
{"team maintainer other team", test.UserTeamMaintainerTeam2, ptr.Uint(1), true, true},
|
|
{"team observer no team", test.UserTeamObserverTeam1, nil, true, true},
|
|
{"team observer team 0", test.UserTeamObserverTeam1, ptr.Uint(0), true, true},
|
|
{"team observer team", test.UserTeamObserverTeam1, ptr.Uint(1), true, true},
|
|
{"team observer other team", test.UserTeamObserverTeam2, ptr.Uint(1), true, true},
|
|
{"team observer+ no team", test.UserTeamObserverPlusTeam1, nil, true, true},
|
|
{"team observer+ team 0", test.UserTeamObserverPlusTeam1, ptr.Uint(0), true, true},
|
|
{"team observer+ team", test.UserTeamObserverPlusTeam1, ptr.Uint(1), true, true},
|
|
{"team observer+ other team", test.UserTeamObserverPlusTeam2, ptr.Uint(1), true, true},
|
|
{"team gitops no team", test.UserTeamGitOpsTeam1, nil, true, true},
|
|
{"team gitops team 0", test.UserTeamGitOpsTeam1, ptr.Uint(0), true, true},
|
|
{"team gitops team", test.UserTeamGitOpsTeam1, ptr.Uint(1), true, false},
|
|
{"team gitops other team", test.UserTeamGitOpsTeam2, ptr.Uint(1), true, true},
|
|
}
|
|
|
|
for _, tt := range testCases {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
ctx := viewer.NewContext(ctx, viewer.Viewer{User: tt.user})
|
|
|
|
ds.GetSoftwareInstallerMetadataByTeamAndTitleIDFunc = func(ctx context.Context, teamID *uint, titleID uint, withScripts bool) (*fleet.SoftwareInstaller, error) {
|
|
return &fleet.SoftwareInstaller{TeamID: tt.teamID}, nil
|
|
}
|
|
|
|
ds.DeleteSoftwareInstallerFunc = func(ctx context.Context, installerID uint) error {
|
|
return nil
|
|
}
|
|
|
|
tokenExpiration := time.Now().Add(24 * time.Hour)
|
|
token, err := test.CreateVPPTokenEncoded(tokenExpiration, "fleet", "ca")
|
|
require.NoError(t, err)
|
|
ds.GetVPPTokenByTeamIDFunc = func(ctx context.Context, teamID *uint) (*fleet.VPPTokenDB, error) {
|
|
return &fleet.VPPTokenDB{
|
|
ID: 1,
|
|
OrgName: "Fleet",
|
|
Location: "Earth",
|
|
RenewDate: tokenExpiration,
|
|
Token: string(token),
|
|
Teams: nil,
|
|
}, nil
|
|
}
|
|
|
|
ds.AppConfigFunc = func(ctx context.Context) (*fleet.AppConfig, error) {
|
|
return &fleet.AppConfig{}, nil
|
|
}
|
|
ds.NewActivityFunc = func(
|
|
ctx context.Context, user *fleet.User, activity fleet.ActivityDetails, details []byte, createdAt time.Time,
|
|
) error {
|
|
return nil
|
|
}
|
|
|
|
ds.TeamFunc = func(ctx context.Context, tid uint) (*fleet.Team, error) {
|
|
if tt.teamID != nil {
|
|
return &fleet.Team{ID: *tt.teamID}, nil
|
|
}
|
|
|
|
return nil, nil
|
|
}
|
|
|
|
ds.TeamExistsFunc = func(ctx context.Context, teamID uint) (bool, error) {
|
|
return false, nil
|
|
}
|
|
|
|
ds.GetAllMDMConfigAssetsByNameFunc = func(ctx context.Context, assetNames []fleet.MDMAssetName,
|
|
_ sqlx.QueryerContext,
|
|
) (map[fleet.MDMAssetName]fleet.MDMConfigAsset, error) {
|
|
return map[fleet.MDMAssetName]fleet.MDMConfigAsset{}, nil
|
|
}
|
|
|
|
_, err = svc.DownloadSoftwareInstaller(ctx, false, "media", 1, tt.teamID)
|
|
if tt.teamID == nil {
|
|
require.Error(t, err)
|
|
} else {
|
|
checkAuthErr(t, tt.shouldFailRead, err)
|
|
}
|
|
|
|
err = svc.DeleteSoftwareInstaller(ctx, 1, tt.teamID)
|
|
if tt.teamID == nil {
|
|
require.Error(t, err)
|
|
} else {
|
|
checkAuthErr(t, tt.shouldFailWrite, err)
|
|
}
|
|
|
|
// Note: these calls always return an error because they're attempting to unmarshal a
|
|
// non-existent VPP token.
|
|
_, err = svc.GetAppStoreApps(ctx, tt.teamID)
|
|
if tt.teamID == nil {
|
|
require.Error(t, err)
|
|
} else if tt.shouldFailRead {
|
|
checkAuthErr(t, true, err)
|
|
}
|
|
|
|
_, err = svc.AddAppStoreApp(ctx, tt.teamID, fleet.VPPAppTeam{VPPAppID: fleet.VPPAppID{AdamID: "123", Platform: fleet.IOSPlatform}})
|
|
if tt.teamID == nil {
|
|
require.Error(t, err)
|
|
} else if tt.shouldFailWrite {
|
|
checkAuthErr(t, true, err)
|
|
}
|
|
|
|
// TODO: configure test with mock software installer store and add tests to check upload auth
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestUpgradeCodeMigration(t *testing.T) {
|
|
ds := new(mock.Store)
|
|
license := &fleet.LicenseInfo{Tier: fleet.TierPremium, Expiration: time.Now().Add(24 * time.Hour)}
|
|
_, ctx := newTestService(t, ds, nil, nil, &TestServerOpts{License: license})
|
|
|
|
dir := t.TempDir()
|
|
softwareInstallStore, err := filesystem.NewSoftwareInstallerStore(dir)
|
|
require.NoError(t, err)
|
|
tfr, err := fleet.NewKeepFileReader(filepath.Join("testdata", "software-installers", "fleet-osquery.msi"))
|
|
require.NoError(t, err)
|
|
defer tfr.Close()
|
|
require.NoError(t, softwareInstallStore.Put(ctx, "deadbeef", tfr))
|
|
|
|
ds.GetMSIInstallersWithoutUpgradeCodeFunc = func(ctx context.Context) (map[uint]string, error) {
|
|
return map[uint]string{uint(1): "deadbeef", uint(2): "deadbeef", uint(3): "noexist", uint(4): "noexist"}, nil
|
|
}
|
|
|
|
var updatedInstallerIDs = map[uint]struct{}{}
|
|
ds.UpdateInstallerUpgradeCodeFunc = func(ctx context.Context, installerID uint, upgradeCode string) error {
|
|
updatedInstallerIDs[installerID] = struct{}{}
|
|
require.Equal(t, "{B681CB20-107E-428A-9B14-2D3C1AFED244}", upgradeCode)
|
|
return nil
|
|
}
|
|
|
|
require.NoError(t, eeservice.UpgradeCodeMigration(ctx, ds, softwareInstallStore, kitlog.NewNopLogger()))
|
|
require.True(t, ds.UpdateInstallerUpgradeCodeFuncInvoked)
|
|
require.Len(t, updatedInstallerIDs, 2)
|
|
}
|
|
|
|
// TestValidateSoftwareLabels tests logic for validating labels associated with software (VPP apps,
|
|
// FMAs, and custom packages)
|
|
func TestValidateSoftwareLabels(t *testing.T) {
|
|
ds := new(mock.Store)
|
|
|
|
license := &fleet.LicenseInfo{Tier: fleet.TierPremium, Expiration: time.Now().Add(24 * time.Hour)}
|
|
|
|
svc, ctx := newTestService(t, ds, nil, nil, &TestServerOpts{License: license})
|
|
|
|
t.Run("validate no update", func(t *testing.T) {
|
|
t.Run("no auth context", func(t *testing.T) {
|
|
_, err := eeservice.ValidateSoftwareLabels(context.Background(), svc, nil, nil)
|
|
require.ErrorContains(t, err, "Authentication required")
|
|
})
|
|
|
|
authCtx := authz_ctx.AuthorizationContext{}
|
|
ctx = authz_ctx.NewContext(ctx, &authCtx)
|
|
|
|
t.Run("no auth checked", func(t *testing.T) {
|
|
_, err := eeservice.ValidateSoftwareLabels(ctx, svc, nil, nil)
|
|
require.ErrorContains(t, err, "Authentication required")
|
|
})
|
|
|
|
// validator requires that an authz check has been performed upstream so we'll set it now for
|
|
// the rest of the tests
|
|
authCtx.SetChecked()
|
|
|
|
mockLabels := map[string]uint{
|
|
"foo": 1,
|
|
"bar": 2,
|
|
"baz": 3,
|
|
}
|
|
|
|
ds.LabelIDsByNameFunc = func(ctx context.Context, names []string) (map[string]uint, error) {
|
|
res := make(map[string]uint)
|
|
if names == nil {
|
|
return res, nil
|
|
}
|
|
for _, name := range names {
|
|
if id, ok := mockLabels[name]; ok {
|
|
res[name] = id
|
|
}
|
|
}
|
|
return res, nil
|
|
}
|
|
|
|
testCases := []struct {
|
|
name string
|
|
payloadIncludeAny []string
|
|
payloadExcludeAny []string
|
|
expectLabels map[string]fleet.LabelIdent
|
|
expectScope fleet.LabelScope
|
|
expectError string
|
|
}{
|
|
{
|
|
"no labels",
|
|
nil,
|
|
nil,
|
|
nil,
|
|
"",
|
|
"",
|
|
},
|
|
{
|
|
"include labels",
|
|
[]string{"foo", "bar"},
|
|
nil,
|
|
map[string]fleet.LabelIdent{
|
|
"foo": {LabelID: 1, LabelName: "foo"},
|
|
"bar": {LabelID: 2, LabelName: "bar"},
|
|
},
|
|
fleet.LabelScopeIncludeAny,
|
|
"",
|
|
},
|
|
{
|
|
"exclude labels",
|
|
nil,
|
|
[]string{"bar", "baz"},
|
|
map[string]fleet.LabelIdent{
|
|
"bar": {LabelID: 2, LabelName: "bar"},
|
|
"baz": {LabelID: 3, LabelName: "baz"},
|
|
},
|
|
fleet.LabelScopeExcludeAny,
|
|
"",
|
|
},
|
|
{
|
|
"include and exclude labels",
|
|
[]string{"foo"},
|
|
[]string{"bar"},
|
|
nil,
|
|
"",
|
|
`Only one of "labels_include_any" or "labels_exclude_any" can be included.`,
|
|
},
|
|
{
|
|
"non-existent label",
|
|
[]string{"foo", "qux"},
|
|
nil,
|
|
nil,
|
|
"",
|
|
"some or all the labels provided don't exist",
|
|
},
|
|
{
|
|
"duplicate label",
|
|
[]string{"foo", "foo"},
|
|
nil,
|
|
map[string]fleet.LabelIdent{
|
|
"foo": {LabelID: 1, LabelName: "foo"},
|
|
},
|
|
fleet.LabelScopeIncludeAny,
|
|
"",
|
|
},
|
|
{
|
|
"empty slice",
|
|
nil,
|
|
[]string{},
|
|
nil,
|
|
"",
|
|
"",
|
|
},
|
|
{
|
|
"empty string",
|
|
nil,
|
|
[]string{""},
|
|
nil,
|
|
"",
|
|
"some or all the labels provided don't exist",
|
|
},
|
|
}
|
|
for _, tt := range testCases {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
got, err := eeservice.ValidateSoftwareLabels(ctx, svc, tt.payloadIncludeAny, tt.payloadExcludeAny)
|
|
if tt.expectError != "" {
|
|
require.Error(t, err)
|
|
require.Contains(t, err.Error(), tt.expectError)
|
|
} else {
|
|
require.NoError(t, err)
|
|
require.NotNil(t, got)
|
|
require.Equal(t, tt.expectScope, got.LabelScope)
|
|
require.Equal(t, tt.expectLabels, got.ByName)
|
|
}
|
|
})
|
|
}
|
|
})
|
|
|
|
t.Run("validate update", func(t *testing.T) {
|
|
t.Run("no auth context", func(t *testing.T) {
|
|
_, _, err := eeservice.ValidateSoftwareLabelsForUpdate(context.Background(), svc, nil, nil, nil)
|
|
require.ErrorContains(t, err, "Authentication required")
|
|
})
|
|
|
|
authCtx := authz_ctx.AuthorizationContext{}
|
|
ctx = authz_ctx.NewContext(ctx, &authCtx)
|
|
|
|
t.Run("no auth checked", func(t *testing.T) {
|
|
_, _, err := eeservice.ValidateSoftwareLabelsForUpdate(ctx, svc, nil, nil, nil)
|
|
require.ErrorContains(t, err, "Authentication required")
|
|
})
|
|
|
|
// validator requires that an authz check has been performed upstream so we'll set it now for
|
|
// the rest of the tests
|
|
authCtx.SetChecked()
|
|
|
|
mockLabels := map[string]uint{
|
|
"foo": 1,
|
|
"bar": 2,
|
|
"baz": 3,
|
|
}
|
|
|
|
ds.LabelIDsByNameFunc = func(ctx context.Context, names []string) (map[string]uint, error) {
|
|
res := make(map[string]uint)
|
|
if names == nil {
|
|
return res, nil
|
|
}
|
|
for _, name := range names {
|
|
if id, ok := mockLabels[name]; ok {
|
|
res[name] = id
|
|
}
|
|
}
|
|
return res, nil
|
|
}
|
|
|
|
testCases := []struct {
|
|
name string
|
|
existingInstaller *fleet.SoftwareInstaller
|
|
payloadIncludeAny []string
|
|
payloadExcludeAny []string
|
|
shouldUpdate bool
|
|
expectLabels map[string]fleet.LabelIdent
|
|
expectScope fleet.LabelScope
|
|
expectError string
|
|
}{
|
|
{
|
|
"no installer",
|
|
nil,
|
|
nil,
|
|
[]string{"foo"},
|
|
false,
|
|
nil,
|
|
"",
|
|
"existing installer must be provided",
|
|
},
|
|
{
|
|
"no labels",
|
|
&fleet.SoftwareInstaller{},
|
|
nil,
|
|
nil,
|
|
false,
|
|
nil,
|
|
"",
|
|
"",
|
|
},
|
|
{
|
|
"add label",
|
|
&fleet.SoftwareInstaller{
|
|
LabelsIncludeAny: []fleet.SoftwareScopeLabel{{LabelID: 1, LabelName: "foo"}},
|
|
LabelsExcludeAny: []fleet.SoftwareScopeLabel{},
|
|
},
|
|
[]string{"foo", "bar"},
|
|
nil,
|
|
true,
|
|
map[string]fleet.LabelIdent{
|
|
"foo": {LabelID: 1, LabelName: "foo"},
|
|
"bar": {LabelID: 2, LabelName: "bar"},
|
|
},
|
|
fleet.LabelScopeIncludeAny,
|
|
"",
|
|
},
|
|
{
|
|
"change scope",
|
|
&fleet.SoftwareInstaller{
|
|
LabelsIncludeAny: []fleet.SoftwareScopeLabel{{LabelID: 1, LabelName: "foo"}},
|
|
LabelsExcludeAny: []fleet.SoftwareScopeLabel{},
|
|
},
|
|
nil,
|
|
[]string{"foo"},
|
|
true,
|
|
map[string]fleet.LabelIdent{
|
|
"foo": {LabelID: 1, LabelName: "foo"},
|
|
},
|
|
fleet.LabelScopeExcludeAny,
|
|
"",
|
|
},
|
|
{
|
|
"remove label",
|
|
&fleet.SoftwareInstaller{
|
|
LabelsIncludeAny: []fleet.SoftwareScopeLabel{{LabelID: 1, LabelName: "foo"}},
|
|
LabelsExcludeAny: []fleet.SoftwareScopeLabel{},
|
|
},
|
|
[]string{},
|
|
nil,
|
|
true,
|
|
nil,
|
|
"",
|
|
"",
|
|
},
|
|
{
|
|
"no change",
|
|
&fleet.SoftwareInstaller{
|
|
LabelsIncludeAny: []fleet.SoftwareScopeLabel{{LabelID: 1, LabelName: "foo"}},
|
|
LabelsExcludeAny: []fleet.SoftwareScopeLabel{},
|
|
},
|
|
[]string{"foo"},
|
|
nil,
|
|
false,
|
|
nil,
|
|
"",
|
|
"",
|
|
},
|
|
}
|
|
|
|
for _, tt := range testCases {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
shouldUpate, got, err := eeservice.ValidateSoftwareLabelsForUpdate(ctx, svc, tt.existingInstaller, tt.payloadIncludeAny, tt.payloadExcludeAny)
|
|
if tt.expectError != "" {
|
|
require.Error(t, err)
|
|
require.Contains(t, err.Error(), tt.expectError)
|
|
} else {
|
|
require.NoError(t, err)
|
|
if tt.shouldUpdate {
|
|
require.True(t, shouldUpate)
|
|
require.NotNil(t, got)
|
|
require.Equal(t, tt.expectScope, got.LabelScope)
|
|
require.Equal(t, tt.expectLabels, got.ByName)
|
|
} else {
|
|
require.False(t, shouldUpate)
|
|
require.Nil(t, got)
|
|
}
|
|
}
|
|
})
|
|
}
|
|
})
|
|
}
|