Improve security migration resilience by handling version conflicts #137558
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| pr: 137558 | ||
| summary: Improve security migration resilience by handling version conflicts | ||
| area: Security | ||
| type: enhancement | ||
| issues: [] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,191 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| package org.elasticsearch.xpack.security.support; | ||
|
|
||
| import org.elasticsearch.action.ActionListener; | ||
| import org.elasticsearch.action.search.SearchRequest; | ||
| import org.elasticsearch.action.search.SearchResponse; | ||
| import org.elasticsearch.action.support.WriteRequest; | ||
| import org.elasticsearch.cluster.metadata.IndexMetadata; | ||
| import org.elasticsearch.cluster.service.ClusterService; | ||
| import org.elasticsearch.core.TimeValue; | ||
| import org.elasticsearch.index.query.QueryBuilders; | ||
| import org.elasticsearch.painless.PainlessPlugin; | ||
| import org.elasticsearch.plugins.Plugin; | ||
| import org.elasticsearch.search.SearchHit; | ||
| import org.elasticsearch.test.ESIntegTestCase; | ||
| import org.elasticsearch.test.ESTestCase; | ||
| import org.elasticsearch.test.SecurityIntegTestCase; | ||
| import org.elasticsearch.xcontent.ToXContent; | ||
| import org.elasticsearch.xcontent.XContentBuilder; | ||
| import org.elasticsearch.xpack.core.security.action.UpdateIndexMigrationVersionAction; | ||
| import org.elasticsearch.xpack.core.security.authz.RoleDescriptor; | ||
| import org.elasticsearch.xpack.security.authz.store.NativeRolesStore; | ||
| import org.junit.Before; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Collection; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.concurrent.ExecutorService; | ||
| import java.util.concurrent.Executors; | ||
| import java.util.concurrent.atomic.AtomicBoolean; | ||
| import java.util.concurrent.atomic.AtomicLong; | ||
| import java.util.stream.Collectors; | ||
| import java.util.stream.Stream; | ||
|
|
||
| import static org.elasticsearch.xcontent.XContentFactory.jsonBuilder; | ||
| import static org.elasticsearch.xpack.core.security.action.UpdateIndexMigrationVersionAction.MIGRATION_VERSION_CUSTOM_DATA_KEY; | ||
| import static org.elasticsearch.xpack.core.security.action.UpdateIndexMigrationVersionAction.MIGRATION_VERSION_CUSTOM_KEY; | ||
| import static org.elasticsearch.xpack.core.security.authz.RoleDescriptor.ROLE_TYPE; | ||
| import static org.elasticsearch.xpack.core.security.test.TestRestrictedIndices.INTERNAL_SECURITY_MAIN_INDEX_7; | ||
| import static org.elasticsearch.xpack.security.support.SecurityMigrations.ROLE_METADATA_FLATTENED_MIGRATION_VERSION; | ||
| import static org.hamcrest.Matchers.greaterThanOrEqualTo; | ||
|
|
||
| @ESIntegTestCase.ClusterScope(scope = ESIntegTestCase.Scope.TEST, numDataNodes = 0, autoManageMasterNodes = false) | ||
| public class MetadataFlattenedMigrationIntegTests extends SecurityIntegTestCase { | ||
|
|
||
| private final AtomicLong versionCounter = new AtomicLong(1); | ||
|
|
||
| @Before | ||
| public void resetVersion() { | ||
| versionCounter.set(1); | ||
| } | ||
|
|
||
| public void testMigrationWithConcurrentUpdates() throws Exception { | ||
| internalCluster().setBootstrapMasterNodeIndex(0); | ||
| internalCluster().startNode(); | ||
| ensureGreen(); | ||
|
|
||
| waitForMigrationCompletion(); | ||
| var roles = createRoles(); | ||
| final var nativeRoleStore = internalCluster().getInstance(NativeRolesStore.class); | ||
|
|
||
| try (ExecutorService executor = Executors.newSingleThreadExecutor()) { | ||
|
Contributor
Author
There was a problem hiding this comment. This can be made a lot more intense by adding more concurrency and more roles, resulting in more retries, but I've reduced it as much as possible to work well in a unit test. |
||
| final AtomicBoolean runUpdateRolesBackground = new AtomicBoolean(true); | ||
| executor.submit(() -> { | ||
| while (runUpdateRolesBackground.get()) { | ||
| // Only update half the list so the other half can be verified as migrated | ||
| RoleDescriptor roleToUpdate = randomFrom(roles.subList(0, roles.size() / 2)); | ||
|
|
||
| RoleDescriptor updatedRole = new RoleDescriptor( | ||
| roleToUpdate.getName(), | ||
| new String[] { "monitor" }, | ||
| null, | ||
| null, | ||
| null, | ||
| null, | ||
| Map.of("test", "value", "timestamp", System.currentTimeMillis(), "random", randomAlphaOfLength(10)), | ||
| null | ||
| ); | ||
| nativeRoleStore.putRole( | ||
| WriteRequest.RefreshPolicy.IMMEDIATE, | ||
| updatedRole, | ||
| ActionListener.wrap(resp -> {}, ESTestCase::fail) | ||
| ); | ||
| try { | ||
| Thread.sleep(10); | ||
|
Contributor
There was a problem hiding this comment. for my own understanding: what's the purpose of 10s sleep here? |
||
| } catch (InterruptedException e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| resetMigration(); | ||
| try { | ||
| waitForMigrationCompletion(); | ||
| } finally { | ||
| runUpdateRolesBackground.set(false); | ||
| executor.shutdown(); | ||
| } | ||
| } | ||
| assertAllRolesHaveMetadataFlattened(); | ||
| } | ||
|
|
||
| private void resetMigration() { | ||
| client().execute( | ||
| UpdateIndexMigrationVersionAction.INSTANCE, | ||
| new UpdateIndexMigrationVersionAction.Request( | ||
| TimeValue.MAX_VALUE, | ||
| ROLE_METADATA_FLATTENED_MIGRATION_VERSION - 1, | ||
| INTERNAL_SECURITY_MAIN_INDEX_7 | ||
| ) | ||
| ).actionGet(); | ||
| } | ||
|
|
||
| private List<RoleDescriptor> createRoles() throws IOException { | ||
| var roles = randomList( | ||
| 25, | ||
| 50, | ||
| () -> new RoleDescriptor( | ||
| randomAlphaOfLength(20), | ||
| null, | ||
| null, | ||
| null, | ||
| null, | ||
| null, | ||
| Map.of("test", "value", "timestamp", System.currentTimeMillis(), "random", randomAlphaOfLength(10)), | ||
| Map.of() | ||
| ) | ||
| ); | ||
| for (RoleDescriptor role : roles) { | ||
| indexRoleDirectly(role); | ||
| } | ||
| indicesAdmin().prepareRefresh(INTERNAL_SECURITY_MAIN_INDEX_7).get(); | ||
| return roles; | ||
| } | ||
|
|
||
| private void indexRoleDirectly(RoleDescriptor role) throws IOException { | ||
| XContentBuilder builder = buildRoleDocument(role); | ||
| prepareIndex(INTERNAL_SECURITY_MAIN_INDEX_7).setId(ROLE_TYPE + "-" + role.getName()) | ||
| .setSource(builder) | ||
| .setRefreshPolicy(WriteRequest.RefreshPolicy.IMMEDIATE) | ||
| .get(); | ||
| } | ||
|
|
||
| private XContentBuilder buildRoleDocument(RoleDescriptor role) throws IOException { | ||
| XContentBuilder builder = jsonBuilder().startObject(); | ||
| // metadata_flattened is populated by the native role store, so write directly to index to simulate pre-migration state | ||
| role.innerToXContent(builder, ToXContent.EMPTY_PARAMS, true); | ||
| builder.endObject(); | ||
| return builder; | ||
| } | ||
|
|
||
| private int getCurrentMigrationVersion() { | ||
| ClusterService clusterService = internalCluster().getInstance(ClusterService.class); | ||
| IndexMetadata indexMetadata = clusterService.state().metadata().getProject().index(INTERNAL_SECURITY_MAIN_INDEX_7); | ||
| if (indexMetadata == null || indexMetadata.getCustomData(MIGRATION_VERSION_CUSTOM_KEY) == null) { | ||
| return 0; | ||
| } | ||
| return Integer.parseInt(indexMetadata.getCustomData(MIGRATION_VERSION_CUSTOM_KEY).get(MIGRATION_VERSION_CUSTOM_DATA_KEY)); | ||
| } | ||
|
|
||
| private void waitForMigrationCompletion() throws Exception { | ||
| assertBusy(() -> assertThat(getCurrentMigrationVersion(), greaterThanOrEqualTo(ROLE_METADATA_FLATTENED_MIGRATION_VERSION))); | ||
| } | ||
|
|
||
| private void assertAllRolesHaveMetadataFlattened() { | ||
| SearchRequest searchRequest = new SearchRequest(INTERNAL_SECURITY_MAIN_INDEX_7); | ||
| searchRequest.source().query(QueryBuilders.termQuery("type", "role")).size(1000); | ||
| SearchResponse response = client().search(searchRequest).actionGet(); | ||
| for (SearchHit hit : response.getHits().getHits()) { | ||
| @SuppressWarnings("unchecked") | ||
| Map<String, Object> metadata = (Map<String, Object>) hit.getSourceAsMap().get("metadata_flattened"); | ||
| // Only check non-reserved roles | ||
| if (metadata.get("_reserved") == null) { | ||
| assertEquals("value", metadata.get("test")); | ||
| } | ||
| } | ||
| response.decRef(); | ||
| } | ||
|
|
||
| @Override | ||
| protected Collection<Class<? extends Plugin>> nodePlugins() { | ||
| return Stream.concat(super.nodePlugins().stream(), Stream.of(PainlessPlugin.class)).collect(Collectors.toList()); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is now the first migration so we don't need this line anymore.