Skip to content

[EDR Workflows] Set Agent Tamper Protection to false on policy unassignment #193017

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
szwarckonrad merged 6 commits into from
Sep 23, 2024
Merged

[EDR Workflows] Set Agent Tamper Protection to false on policy unassignment #193017

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
51f4c63
set Agent Tamper Protection to false on policy unassignment
szwarckonrad Sep 16, 2024
67cd49c
Merge branch 'main' into remove-atp-on-policy-unassign
szwarckonrad Sep 16, 2024
93f241f
Merge branch 'main' into remove-atp-on-policy-unassign
szwarckonrad Sep 19, 2024
04ee4f9
Merge branch 'refs/heads/main' into remove-atp-on-policy-unassign
szwarckonrad Sep 20, 2024
7f58756
cr
szwarckonrad Sep 20, 2024
031eef3
Merge branch 'main' into remove-atp-on-policy-unassign
szwarckonrad Sep 23, 2024
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
318 changes: 318 additions & 0 deletions x-pack/plugins/fleet/server/services/package_policy.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
* 2.0.
*/

import type { ElasticsearchClientMock } from '@kbn/core/server/mocks';
import {
elasticsearchServiceMock,
savedObjectsClientMock,
Expand Down Expand Up @@ -34,6 +35,7 @@ import type {
PackagePolicy,
PostPackagePolicyPostCreateCallback,
PostPackagePolicyDeleteCallback,
UpdatePackagePolicy,
} from '../types';
import { createPackagePolicyMock } from '../../common/mocks';

Expand Down Expand Up @@ -1715,6 +1717,141 @@ describe('Package policy service', () => {
savedObjectType: LEGACY_PACKAGE_POLICY_SAVED_OBJECT_TYPE,
});
});

describe('remove protections', () => {
beforeEach(() => {
mockAgentPolicyService.bumpRevision.mockReset();
});

const generateAttributes = (overrides: Record<string, string | string[]> = {}) => ({
name: 'endpoint-12',
description: '',
namespace: 'default',
enabled: true,
policy_ids: ['test'],
package: {
name: 'endpoint',
title: 'Elastic Endpoint',
version: '0.9.0',
},
inputs: [],
...overrides,
});

const generateSO = (overrides: Record<string, string | string[]> = {}) => ({
id: 'existing-package-policy',
type: 'ingest-package-policies',
references: [],
version: '1.0.0',
attributes: generateAttributes(overrides),
});

const testedPolicyIds = ['test-agent-policy-1', 'test-agent-policy-2', 'test-agent-policy-3'];

const setupSOClientMocks = (
savedObjectsClient: ReturnType<typeof savedObjectsClientMock.create>,
initialPolicies: string[],
updatesPolicies: string[]
) => {
savedObjectsClient.get.mockResolvedValueOnce(
generateSO({ name: 'test-package-policy', policy_ids: initialPolicies })
);

savedObjectsClient.get.mockResolvedValueOnce(
generateSO({ name: 'test-package-policy-1', policy_ids: updatesPolicies })
);

savedObjectsClient.get.mockResolvedValueOnce(
generateSO({ name: 'test-package-policy-1', policy_ids: updatesPolicies })
);
};

const callPackagePolicyServiceUpdate = async (
savedObjectsClient: ReturnType<typeof savedObjectsClientMock.create>,
elasticsearchClient: ElasticsearchClientMock,
policyIds: string[]
) => {
await packagePolicyService.update(
savedObjectsClient,
elasticsearchClient,
generateSO().id,
generateAttributes({
policy_ids: policyIds,
name: 'test-package-policy-1',
})
);
};

it('should not remove protections if policy_ids is not changed', async () => {
const savedObjectsClient = savedObjectsClientMock.create();
const elasticsearchClient = elasticsearchServiceMock.createClusterClient().asInternalUser;

setupSOClientMocks(savedObjectsClient, testedPolicyIds, testedPolicyIds);

await callPackagePolicyServiceUpdate(
savedObjectsClient,
elasticsearchClient,
testedPolicyIds
);

expect(mockAgentPolicyService.bumpRevision).toHaveBeenCalledTimes(testedPolicyIds.length);
Array.from({ length: testedPolicyIds.length }, (_, index) => index + 1).forEach((index) => {
expect(mockAgentPolicyService.bumpRevision).toHaveBeenNthCalledWith(
index,
savedObjectsClient,
elasticsearchClient,
expect.stringContaining(`test-agent-policy-${index}`),
expect.objectContaining({ removeProtection: false })
);
});
});

it('should remove protections if policy_ids is changed, only affected policies', async () => {
const savedObjectsClient = savedObjectsClientMock.create();
const elasticsearchClient = elasticsearchServiceMock.createClusterClient().asInternalUser;

const updatedPolicyIds = [...testedPolicyIds].splice(1, 2);

setupSOClientMocks(savedObjectsClient, testedPolicyIds, updatedPolicyIds);

await callPackagePolicyServiceUpdate(
savedObjectsClient,
elasticsearchClient,
updatedPolicyIds
);

expect(mockAgentPolicyService.bumpRevision).toHaveBeenCalledTimes(testedPolicyIds.length);
Array.from({ length: testedPolicyIds.length }, (_, index) => index + 1).forEach((index) => {
expect(mockAgentPolicyService.bumpRevision).toHaveBeenNthCalledWith(
index,
savedObjectsClient,
elasticsearchClient,
expect.stringContaining(`test-agent-policy-${index}`),
expect.objectContaining({ removeProtection: index === 1 })
);
});
});

it('should remove protections from all agent policies if updated policy_ids is empty', async () => {
const savedObjectsClient = savedObjectsClientMock.create();
const elasticsearchClient = elasticsearchServiceMock.createClusterClient().asInternalUser;

setupSOClientMocks(savedObjectsClient, testedPolicyIds, []);

await callPackagePolicyServiceUpdate(savedObjectsClient, elasticsearchClient, []);

expect(mockAgentPolicyService.bumpRevision).toHaveBeenCalledTimes(testedPolicyIds.length);
Array.from({ length: testedPolicyIds.length }, (_, index) => index + 1).forEach((index) => {
expect(mockAgentPolicyService.bumpRevision).toHaveBeenNthCalledWith(
index,
savedObjectsClient,
elasticsearchClient,
expect.stringContaining(`test-agent-policy-${index}`),
expect.objectContaining({ removeProtection: true })
);
});
});
});
});

describe('bulkUpdate', () => {
Expand Down Expand Up @@ -2521,6 +2658,187 @@ describe('Package policy service', () => {
},
]);
});

describe('remove protections', () => {
beforeEach(() => {
mockAgentPolicyService.bumpRevision.mockReset();
});
const generateAttributes = (overrides: Record<string, string | string[]> = {}) => ({
name: 'endpoint-12',
description: '',
namespace: 'default',
enabled: true,
policy_ids: ['test'],
package: {
name: 'endpoint',
title: 'Elastic Endpoint',
version: '0.9.0',
},
inputs: [],
...overrides,
});

const generateSO = (overrides: Record<string, string | string[]> = {}) => ({
id: 'existing-package-policy',
type: 'ingest-package-policies',
references: [],
version: '1.0.0',
attributes: generateAttributes(overrides),
...(overrides.id ? ({ id: overrides.id } as { id: string }) : {}),
});

const packagePoliciesSO = [
generateSO({
name: 'test-package-policy',
policy_ids: ['test-agent-policy-1', 'test-agent-policy-2', 'test-agent-policy-3'],
id: 'asdb',
}),
generateSO({
name: 'test-package-policy-1',
policy_ids: ['test-agent-policy-4', 'test-agent-policy-5', 'test-agent-policy-6'],
id: 'asdb1',
}),
];
const testedPackagePolicies = packagePoliciesSO.map((so) => so.attributes);

const totalPolicyIds = packagePoliciesSO.reduce(
(count, policy) => count + policy.attributes.policy_ids.length,
0
);

const setupSOClientMocks = (
savedObjectsClient: ReturnType<typeof savedObjectsClientMock.create>
) => {
savedObjectsClient.bulkGet.mockResolvedValue({
saved_objects: packagePoliciesSO,
});

savedObjectsClient.bulkUpdate.mockImplementation(
async (
objs: Array<{
type: string;
id: string;
attributes: any;
}>
) => {
const newObjs = objs.map((obj) => ({
id: 'test',
type: 'abcd',
references: [],
version: 'test',
attributes: obj.attributes,
}));

savedObjectsClient.bulkGet.mockResolvedValue({
saved_objects: newObjs,
});
return {
saved_objects: newObjs,
};
}
);
};

const callPackagePolicyServiceBulkUpdate = async (
savedObjectsClient: ReturnType<typeof savedObjectsClientMock.create>,
elasticsearchClient: ElasticsearchClientMock,
packagePolicies: UpdatePackagePolicy[]
) => {
await packagePolicyService.bulkUpdate(
savedObjectsClient,
elasticsearchClient,
packagePolicies,
{ force: true }
);
};

it('should not remove protections if policy_ids is not changed', async () => {
const savedObjectsClient = savedObjectsClientMock.create();

setupSOClientMocks(savedObjectsClient);

const elasticsearchClient = elasticsearchServiceMock.createClusterClient().asInternalUser;

await callPackagePolicyServiceBulkUpdate(
savedObjectsClient,
elasticsearchClient,
testedPackagePolicies
);

expect(mockAgentPolicyService.bumpRevision).toHaveBeenCalledTimes(totalPolicyIds);

Array.from({ length: totalPolicyIds }, (_, index) => index + 1).forEach((index) => {
expect(mockAgentPolicyService.bumpRevision).toHaveBeenNthCalledWith(
index,
savedObjectsClient,
elasticsearchClient,
expect.stringContaining(`test-agent-policy-${index}`),
expect.objectContaining({ removeProtection: false })
);
});
});

it('should remove protections if policy_ids is changed, only affected policies', async () => {
const savedObjectsClient = savedObjectsClientMock.create();

setupSOClientMocks(savedObjectsClient);

const elasticsearchClient = elasticsearchServiceMock.createClusterClient().asInternalUser;

const packagePoliciesWithIncompletePolicyIds = testedPackagePolicies.map((policy) => ({
...policy,
policy_ids: [...policy.policy_ids].splice(1, 2),
}));

await callPackagePolicyServiceBulkUpdate(
savedObjectsClient,
elasticsearchClient,
packagePoliciesWithIncompletePolicyIds
);

expect(mockAgentPolicyService.bumpRevision).toHaveBeenCalledTimes(totalPolicyIds);

Array.from({ length: totalPolicyIds }, (_, index) => index + 1).forEach((index) => {
expect(mockAgentPolicyService.bumpRevision).toHaveBeenCalledWith(
savedObjectsClient,
elasticsearchClient,
expect.stringContaining(`test-agent-policy-${index}`),
expect.objectContaining({ removeProtection: index === 1 || index === 4 })
);
});
});

it('should remove protections from all agent policies if updated policy_ids is empty', async () => {
const savedObjectsClient = savedObjectsClientMock.create();

setupSOClientMocks(savedObjectsClient);

const elasticsearchClient = elasticsearchServiceMock.createClusterClient().asInternalUser;

const packagePoliciesWithEmptyPolicyIds = testedPackagePolicies.map((policy) => ({
...policy,
policy_ids: [],
}));

await callPackagePolicyServiceBulkUpdate(
savedObjectsClient,
elasticsearchClient,
packagePoliciesWithEmptyPolicyIds
);

expect(mockAgentPolicyService.bumpRevision).toHaveBeenCalledTimes(totalPolicyIds);

Array.from({ length: totalPolicyIds }, (_, index) => index + 1).forEach((index) => {
expect(mockAgentPolicyService.bumpRevision).toHaveBeenNthCalledWith(
index,
savedObjectsClient,
elasticsearchClient,
expect.stringContaining(`test-agent-policy-${index}`),
expect.objectContaining({ removeProtection: true })
);
});
});
});
});

describe('delete', () => {
Expand Down
24 changes: 23 additions & 1 deletion x-pack/plugins/fleet/server/services/package_policy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1035,9 +1035,16 @@ class PackagePolicyClientImpl implements PackagePolicyClient {
logger.debug(`Bumping revision of associated agent policies ${associatedPolicyIds}`);
const bumpPromises = [];
for (const policyId of associatedPolicyIds) {
// If the agent policy is no longer associated with the endpoint package policy, remove the protection
const removeProtection =
newPolicy.package?.name === 'endpoint' &&
oldPackagePolicy.policy_ids.includes(policyId) &&
!newPolicy.policy_ids.includes(policyId);

bumpPromises.push(
agentPolicyService.bumpRevision(soClient, esClient, policyId, {
user: options?.user,
removeProtection,
})
);
}
Expand Down Expand Up @@ -1207,10 +1214,25 @@ class PackagePolicyClientImpl implements PackagePolicyClient {
...packagePolicyUpdates.flatMap((p) => p.policy_ids),
...oldPackagePolicies.flatMap((p) => p.policy_ids),
]);
logger.debug(`Bumping revision of associated agent policies ${associatedPolicyIds}`);

const [endpointPackagePolicyUpdatesIds, endpointOldPackagePoliciesIds] = [
packagePolicyUpdates,
oldPackagePolicies,
].map((packagePolicies) =>

@gergoabraham gergoabraham Sep 18, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sets instead of arrays could be built here, so the checks in lines 1231 and 1232 will have constant time complexity

@szwarckonrad szwarckonrad Sep 18, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

const [endpointPackagePolicyUpdatesIds, endpointOldPackagePoliciesIds] = [
  packagePolicyUpdates,
  oldPackagePolicies,
].map((packagePolicies) =>
  new Set(
    packagePolicies
      .filter((p) => p.package?.name === 'endpoint')
      .map((p) => p.policy_ids)
      .flat()
  )
);

Like this, right?

@gergoabraham gergoabraham Sep 20, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

like that : )

@ashokaditya ashokaditya Sep 20, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May I also add that instead of iterating twice using filter and map you could use reduce to iterate only once. 😅

packagePolicies
.filter((p) => p.package?.name === 'endpoint')
.map((p) => p.policy_ids)
.flat()
);

const bumpPromise = pMap(associatedPolicyIds, async (agentPolicyId) => {
// If the agent policy is no longer associated with the endpoint package policy, remove the protection
const removeProtection =
endpointOldPackagePoliciesIds.includes(agentPolicyId) &&
!endpointPackagePolicyUpdatesIds.includes(agentPolicyId);
await agentPolicyService.bumpRevision(soClient, esClient, agentPolicyId, {
user: options?.user,
removeProtection,
});
});

Expand Down