Skip to content

Fixes bulk re-encryption for encrypted objects located in all spaces #217625

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
jeramysoucy merged 4 commits into from
Apr 14, 2025
Merged

Fixes bulk re-encryption for encrypted objects located in all spaces #217625

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2c6c897
Fixes optional namespace parameter to bulk update from ESO rotate ser…
jeramysoucy Apr 9, 2025
6aef379
Merge branch 'main' into fix-eso-rotate-all-namespaces
jeramysoucy Apr 9, 2025
59db44a
[CI] Auto-commit changed files from 'node scripts/yarn_deduplicate'
kibanamachine Apr 9, 2025
473d0d7
Merge branch 'main' into fix-eso-rotate-all-namespaces
jeramysoucy Apr 14, 2025
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
24 changes: 17 additions & 7 deletions ...gins/shared/encrypted_saved_objects/server/crypto/encryption_key_rotation_service.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,11 @@ beforeEach(() => {
{ name: 'type-id-4', namespaceType: 'multiple', mappings: { properties: {} }, hidden: true },
{ name: 'type-id-5', namespaceType: 'single', mappings: { properties: {} }, hidden: false },
{ name: 'type-id-6', namespaceType: 'single', mappings: { properties: {} }, hidden: true },
{ name: 'type-id-7', namespaceType: 'multiple', mappings: { properties: {} }, hidden: false },
]);
typeRegistryMock.isSingleNamespace.mockImplementation((type) => type !== 'type-id-4');
typeRegistryMock.isSingleNamespace.mockImplementation(
(type) => type !== 'type-id-4' && type !== 'type-id-7'
);
mockSavedObjects.getTypeRegistry.mockReturnValue(typeRegistryMock);

mockRetrieveClient = savedObjectsClientMock.create();
Expand Down Expand Up @@ -125,7 +128,7 @@ it('does not perform rotation if there are no Saved Objects to process', async (

expect(mockRetrieveClient.find).toHaveBeenCalledTimes(1);
expect(mockRetrieveClient.find).toHaveBeenCalledWith({
type: ['type-id-1', 'type-id-2', 'type-id-4', 'type-id-5'],
type: ['type-id-1', 'type-id-2', 'type-id-4', 'type-id-5', 'type-id-7'],
perPage: 12345,
namespaces: ['*'],
sortField: 'updated_at',
Expand Down Expand Up @@ -200,11 +203,12 @@ it('properly rotates encryption key', async () => {
getMockSavedObject({ id: 'id-1' }),
getMockSavedObject({ id: 'id-2', namespaces: ['ns-1'] }),
getMockSavedObject({ id: 'id-4', namespaces: ['ns-2', 'ns-3'] }),
getMockSavedObject({ id: 'id-7', namespaces: ['*'] }),
];
mockRetrieveClient.find.mockResolvedValue({
total: 3,
total: 4,
saved_objects: savedObjects,
per_page: 3,
per_page: 4,
page: 0,
});
mockUpdateClient.bulkUpdate.mockResolvedValue({
Expand All @@ -214,12 +218,12 @@ it('properly rotates encryption key', async () => {
await expect(
service.rotate(httpServerMock.createKibanaRequest(), { batchSize: 12345 })
).resolves.toEqual({
total: 3,
successful: 3,
total: 4,
successful: 4,
failed: 0,
});

expect(mockEncryptionService.decryptAttributes).toHaveBeenCalledTimes(3);
expect(mockEncryptionService.decryptAttributes).toHaveBeenCalledTimes(4);
expect(mockEncryptionService.decryptAttributes).toHaveBeenCalledWith(
{ type: 'type-id-1', id: 'id-1' },
{ attr: 'attr-id-1' },
Expand All @@ -235,12 +239,18 @@ it('properly rotates encryption key', async () => {
{ attr: 'attr-id-4' },
{ omitPrimaryEncryptionKey: true }
);
expect(mockEncryptionService.decryptAttributes).toHaveBeenCalledWith(
{ type: 'type-id-7', id: 'id-7' },
{ attr: 'attr-id-7' },
{ omitPrimaryEncryptionKey: true }
);

expect(mockUpdateClient.bulkUpdate).toHaveBeenCalledTimes(1);
expect(mockUpdateClient.bulkUpdate).toHaveBeenCalledWith([
{ ...savedObjects[0], attributes: { attr: 'decrypted-attr-id-1' } },
{ ...savedObjects[1], namespace: 'ns-1', attributes: { attr: 'decrypted-attr-id-2' } },
{ ...savedObjects[2], namespace: 'ns-2', attributes: { attr: 'decrypted-attr-id-4' } },
{ ...savedObjects[3], attributes: { attr: 'decrypted-attr-id-7' } },
]);
});

Expand Down
8 changes: 6 additions & 2 deletions ...m/plugins/shared/encrypted_saved_objects/server/crypto/encryption_key_rotation_service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import type {
StartServicesAccessor,
} from '@kbn/core/server';
import { ENCRYPTION_EXTENSION_ID } from '@kbn/core-saved-objects-server';
import { ALL_NAMESPACES_STRING } from '@kbn/core-saved-objects-utils-server';
import type { AuthenticatedUser } from '@kbn/core-security-common';
import type { PublicMethodsOf } from '@kbn/utility-types';

Expand Down Expand Up @@ -258,11 +259,14 @@ export class EncryptionKeyRotationService {
continue;
}

const firstNamespace = savedObject.namespaces?.[0];

decryptedSavedObjects.push({
...savedObject,
attributes: decryptedAttributes,
// `bulkUpdate` expects objects with a single `namespace`.
namespace: savedObject.namespaces?.[0],
// The optional object namespace for `bulkUpdate` is used to affect objects outside of the current space
// '*' is an invalid option, and if the object exists in all spaces, we don't need to set the namespace
namespace: firstNamespace !== ALL_NAMESPACES_STRING ? firstNamespace : undefined,
});
}

Expand Down
1 change: 1 addition & 0 deletions x-pack/platform/plugins/shared/encrypted_saved_objects/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
"@kbn/test-jest-helpers",
"@kbn/config",
"@kbn/encrypted-saved-objects-shared",
"@kbn/core-saved-objects-utils-server",
],
"exclude": [
"target/**/*",
Expand Down