Rename remote cluster setting to credentials (#94560)

n1v0lg · web-flow · commit 56b849d8023c · 2023-03-22T05:16:30.000-04:00
Renames the `cluster.remote.*.authorization` setting to
`cluster.remote.*.credentials` since the name is more precise and aligns
with the rest of the code base.
diff --git a/qa/ccs-common-rest/src/yamlRestTest/java/org/elasticsearch/test/rest/yaml/RcsCcsCommonYamlTestSuiteIT.java b/qa/ccs-common-rest/src/yamlRestTest/java/org/elasticsearch/test/rest/yaml/RcsCcsCommonYamlTestSuiteIT.java
@@ -229,7 +229,7 @@ private static void configureRemoteCluster() throws IOException {
         final String encodedCrossClusterAccessApiKey = (String) apiKeyMap.get("encoded");
 
         final Settings.Builder builder = Settings.builder()
-            .put("cluster.remote." + REMOTE_CLUSTER_NAME + ".authorization", encodedCrossClusterAccessApiKey);
+            .put("cluster.remote." + REMOTE_CLUSTER_NAME + ".credentials", encodedCrossClusterAccessApiKey);
         if (randomBoolean()) {
             builder.put("cluster.remote." + REMOTE_CLUSTER_NAME + ".mode", "proxy")
                 .put("cluster.remote." + REMOTE_CLUSTER_NAME + ".proxy_address", fulfillingCluster.getRemoteClusterServerEndpoint(0));
diff --git a/server/src/main/java/org/elasticsearch/common/settings/ClusterSettings.java b/server/src/main/java/org/elasticsearch/common/settings/ClusterSettings.java
@@ -552,7 +552,7 @@ public void apply(Settings value, Settings current, Settings previous) {
         SimulatePipelineTransportAction.INGEST_NODE_TRANSPORT_ACTION_TIMEOUT,
         WriteAckDelay.WRITE_ACK_DELAY_INTERVAL,
         WriteAckDelay.WRITE_ACK_DELAY_RANDOMNESS_BOUND,
-        TcpTransport.isUntrustedRemoteClusterEnabled() ? RemoteClusterService.REMOTE_CLUSTER_AUTHORIZATION : null,
+        TcpTransport.isUntrustedRemoteClusterEnabled() ? RemoteClusterService.REMOTE_CLUSTER_CREDENTIALS : null,
         TcpTransport.isUntrustedRemoteClusterEnabled() ? RemoteClusterPortSettings.REMOTE_CLUSTER_SERVER_ENABLED : null,
         TcpTransport.isUntrustedRemoteClusterEnabled() ? RemoteClusterPortSettings.HOST : null,
         TcpTransport.isUntrustedRemoteClusterEnabled() ? RemoteClusterPortSettings.PUBLISH_HOST : null,
diff --git a/server/src/main/java/org/elasticsearch/transport/RemoteClusterAware.java b/server/src/main/java/org/elasticsearch/transport/RemoteClusterAware.java
@@ -106,7 +106,7 @@ public void listenForUpdates(ClusterSettings clusterSettings) {
         List<Setting.AffixSetting<?>> remoteClusterSettings = Stream.of(
             RemoteClusterService.REMOTE_CLUSTER_COMPRESS,
             RemoteClusterService.REMOTE_CLUSTER_PING_SCHEDULE,
-            TcpTransport.isUntrustedRemoteClusterEnabled() ? RemoteClusterService.REMOTE_CLUSTER_AUTHORIZATION : null,
+            TcpTransport.isUntrustedRemoteClusterEnabled() ? RemoteClusterService.REMOTE_CLUSTER_CREDENTIALS : null,
             RemoteConnectionStrategy.REMOTE_CONNECTION_MODE,
             SniffConnectionStrategy.REMOTE_CLUSTERS_PROXY,
             SniffConnectionStrategy.REMOTE_CLUSTER_SEEDS,
diff --git a/server/src/main/java/org/elasticsearch/transport/RemoteClusterService.java b/server/src/main/java/org/elasticsearch/transport/RemoteClusterService.java
@@ -122,9 +122,9 @@ public final class RemoteClusterService extends RemoteClusterAware implements Cl
         )
     );
 
-    public static final Setting.AffixSetting<String> REMOTE_CLUSTER_AUTHORIZATION = Setting.affixKeySetting(
+    public static final Setting.AffixSetting<String> REMOTE_CLUSTER_CREDENTIALS = Setting.affixKeySetting(
         "cluster.remote.",
-        "authorization",
+        "credentials",
         key -> Setting.simpleString(key, v -> {}, Setting.Property.Dynamic, Setting.Property.NodeScope, Setting.Property.Filtered)
     );
 
diff --git a/server/src/main/java/org/elasticsearch/transport/RemoteConnectionStrategy.java b/server/src/main/java/org/elasticsearch/transport/RemoteConnectionStrategy.java
@@ -44,7 +44,7 @@
 import java.util.stream.Stream;
 
 import static org.elasticsearch.core.Strings.format;
-import static org.elasticsearch.transport.RemoteClusterService.REMOTE_CLUSTER_AUTHORIZATION;
+import static org.elasticsearch.transport.RemoteClusterService.REMOTE_CLUSTER_CREDENTIALS;
 
 public abstract class RemoteConnectionStrategy implements TransportConnectionListener, Closeable {
 
@@ -142,7 +142,7 @@ public Writeable.Reader<RemoteConnectionInfo.ModeInfo> getReader() {
     }
 
     static ConnectionProfile buildConnectionProfile(String clusterAlias, Settings settings) {
-        final String transportProfile = REMOTE_CLUSTER_AUTHORIZATION.getConcreteSettingForNamespace(clusterAlias).exists(settings)
+        final String transportProfile = REMOTE_CLUSTER_CREDENTIALS.getConcreteSettingForNamespace(clusterAlias).exists(settings)
             ? RemoteClusterPortSettings.REMOTE_CLUSTER_PROFILE
             : TransportSettings.DEFAULT_PROFILE;
 
diff --git a/server/src/test/java/org/elasticsearch/transport/RemoteClusterConnectionTests.java b/server/src/test/java/org/elasticsearch/transport/RemoteClusterConnectionTests.java
@@ -451,7 +451,7 @@ private void doTestGetConnectionInfo(boolean hasClusterCredentials) throws Excep
                     settings = Settings.builder()
                         .put(settings)
                         .put(
-                            RemoteClusterService.REMOTE_CLUSTER_AUTHORIZATION.getConcreteSettingForNamespace(clusterAlias).getKey(),
+                            RemoteClusterService.REMOTE_CLUSTER_CREDENTIALS.getConcreteSettingForNamespace(clusterAlias).getKey(),
                             randomAlphaOfLength(20)
                         )
                         .build();
@@ -638,7 +638,7 @@ private void doTestCollectNodes(boolean hasClusterCredentials) throws Exception
                     settings = Settings.builder()
                         .put(settings)
                         .put(
-                            RemoteClusterService.REMOTE_CLUSTER_AUTHORIZATION.getConcreteSettingForNamespace(clusterAlias).getKey(),
+                            RemoteClusterService.REMOTE_CLUSTER_CREDENTIALS.getConcreteSettingForNamespace(clusterAlias).getKey(),
                             randomAlphaOfLength(20)
                         )
                         .build();
diff --git a/server/src/test/java/org/elasticsearch/transport/RemoteClusterServiceTests.java b/server/src/test/java/org/elasticsearch/transport/RemoteClusterServiceTests.java
@@ -89,7 +89,7 @@ public void testSettingsAreRegistered() {
         assertTrue(ClusterSettings.BUILT_IN_CLUSTER_SETTINGS.contains(SniffConnectionStrategy.REMOTE_CONNECTIONS_PER_CLUSTER));
         assertTrue(ClusterSettings.BUILT_IN_CLUSTER_SETTINGS.contains(SniffConnectionStrategy.REMOTE_CLUSTER_SEEDS));
         if (TcpTransport.isUntrustedRemoteClusterEnabled()) {
-            assertTrue(ClusterSettings.BUILT_IN_CLUSTER_SETTINGS.contains(RemoteClusterService.REMOTE_CLUSTER_AUTHORIZATION));
+            assertTrue(ClusterSettings.BUILT_IN_CLUSTER_SETTINGS.contains(RemoteClusterService.REMOTE_CLUSTER_CREDENTIALS));
         }
         assertTrue(ClusterSettings.BUILT_IN_CLUSTER_SETTINGS.contains(SniffConnectionStrategy.REMOTE_NODE_CONNECTIONS));
         assertTrue(ClusterSettings.BUILT_IN_CLUSTER_SETTINGS.contains(ProxyConnectionStrategy.PROXY_ADDRESS));
diff --git a/server/src/test/java/org/elasticsearch/transport/RemoteClusterSettingsTests.java b/server/src/test/java/org/elasticsearch/transport/RemoteClusterSettingsTests.java
@@ -21,7 +21,7 @@
 
 import static org.elasticsearch.test.NodeRoles.nonRemoteClusterClientNode;
 import static org.elasticsearch.test.NodeRoles.remoteClusterClientNode;
-import static org.elasticsearch.transport.RemoteClusterService.REMOTE_CLUSTER_AUTHORIZATION;
+import static org.elasticsearch.transport.RemoteClusterService.REMOTE_CLUSTER_CREDENTIALS;
 import static org.elasticsearch.transport.RemoteClusterService.REMOTE_CLUSTER_SKIP_UNAVAILABLE;
 import static org.elasticsearch.transport.RemoteClusterService.REMOTE_INITIAL_CONNECTION_TIMEOUT_SETTING;
 import static org.elasticsearch.transport.RemoteClusterService.REMOTE_NODE_ATTRIBUTE;
@@ -77,13 +77,13 @@ public void testSeedsDefault() {
 
     public void testAuthorizationDefault() {
         final String alias = randomAlphaOfLength(8);
-        assertThat(REMOTE_CLUSTER_AUTHORIZATION.getConcreteSettingForNamespace(alias).get(Settings.EMPTY), emptyString());
+        assertThat(REMOTE_CLUSTER_CREDENTIALS.getConcreteSettingForNamespace(alias).get(Settings.EMPTY), emptyString());
     }
 
     public void testAuthorizationFiltered() {
         final String alias = randomAlphaOfLength(8);
         assertThat(
-            REMOTE_CLUSTER_AUTHORIZATION.getConcreteSettingForNamespace(alias).getProperties(),
+            REMOTE_CLUSTER_CREDENTIALS.getConcreteSettingForNamespace(alias).getProperties(),
             Matchers.hasItem(Setting.Property.Filtered)
         );
     }
@@ -96,11 +96,11 @@ public void testProxyDefault() {
     public void testRemoteClusterEmptyOrNullApiKey() {
         // simple validation
         Settings settings = Settings.builder()
-            .put("cluster.remote.cluster1.authorization", "apikey")
-            .put("cluster.remote.cluster3.authorization", (String) null)
+            .put("cluster.remote.cluster1.credentials", "apikey")
+            .put("cluster.remote.cluster3.credentials", (String) null)
             .build();
         try {
-            REMOTE_CLUSTER_AUTHORIZATION.getAllConcreteSettings(settings).forEach(setting -> setting.get(settings));
+            REMOTE_CLUSTER_CREDENTIALS.getAllConcreteSettings(settings).forEach(setting -> setting.get(settings));
         } catch (Throwable t) {
             fail("Cluster Settings must be able to accept a null, empty, or non-empty string. Exception: " + t.getMessage());
         }
diff --git a/server/src/test/java/org/elasticsearch/transport/RemoteConnectionStrategyTests.java b/server/src/test/java/org/elasticsearch/transport/RemoteConnectionStrategyTests.java
@@ -14,7 +14,7 @@
 import org.elasticsearch.core.TimeValue;
 import org.elasticsearch.test.ESTestCase;
 
-import static org.elasticsearch.transport.RemoteClusterService.REMOTE_CLUSTER_AUTHORIZATION;
+import static org.elasticsearch.transport.RemoteClusterService.REMOTE_CLUSTER_CREDENTIALS;
 import static org.mockito.Mockito.mock;
 
 public class RemoteConnectionStrategyTests extends ESTestCase {
@@ -126,7 +126,7 @@ public void testTransportProfile() {
 
         // New rcs connection with credentials
         for (RemoteConnectionStrategy.ConnectionStrategy strategy : RemoteConnectionStrategy.ConnectionStrategy.values()) {
-            String settingKey = REMOTE_CLUSTER_AUTHORIZATION.getConcreteSettingForNamespace(clusterAlias).getKey();
+            String settingKey = REMOTE_CLUSTER_CREDENTIALS.getConcreteSettingForNamespace(clusterAlias).getKey();
             final Settings settings = Settings.builder().put(settingKey, randomAlphaOfLength(20)).build();
             ConnectionProfile profile = RemoteConnectionStrategy.buildConnectionProfile(clusterAlias, settings);
             assertEquals(
diff --git a/server/src/test/java/org/elasticsearch/transport/SniffConnectionStrategyTests.java b/server/src/test/java/org/elasticsearch/transport/SniffConnectionStrategyTests.java
@@ -70,7 +70,7 @@ public void setUp() throws Exception {
         final Settings.Builder builder = Settings.builder().put(modeKey, "sniff");
         if (hasClusterCredentials) {
             builder.put(
-                RemoteClusterService.REMOTE_CLUSTER_AUTHORIZATION.getConcreteSettingForNamespace(clusterAlias).getKey(),
+                RemoteClusterService.REMOTE_CLUSTER_CREDENTIALS.getConcreteSettingForNamespace(clusterAlias).getKey(),
                 randomAlphaOfLength(20)
             );
         }
diff --git a/x-pack/plugin/security/qa/multi-cluster/src/javaRestTest/java/org/elasticsearch/xpack/remotecluster/AbstractRemoteClusterSecurityTestCase.java b/x-pack/plugin/security/qa/multi-cluster/src/javaRestTest/java/org/elasticsearch/xpack/remotecluster/AbstractRemoteClusterSecurityTestCase.java
@@ -105,7 +105,7 @@ protected String configureRemoteClustersWithApiKey(String indicesPrivilegesJson,
 
         // Update remote cluster settings on QC with the API key
         final Settings.Builder builder = Settings.builder()
-            .put("cluster.remote.my_remote_cluster.authorization", encodedCrossClusterAccessApiKey);
+            .put("cluster.remote.my_remote_cluster.credentials", encodedCrossClusterAccessApiKey);
         ;
         if (isProxyMode) {
             builder.put("cluster.remote.my_remote_cluster.mode", "proxy")
diff --git a/x-pack/plugin/security/qa/multi-cluster/src/javaRestTest/java/org/elasticsearch/xpack/remotecluster/RemoteClusterSecurityRestIT.java b/x-pack/plugin/security/qa/multi-cluster/src/javaRestTest/java/org/elasticsearch/xpack/remotecluster/RemoteClusterSecurityRestIT.java
@@ -260,7 +260,7 @@ public void testCrossClusterSearch() throws Exception {
             );
 
             // Check that authentication fails if we use a non-existent API key
-            updateClusterSettings(Settings.builder().put("cluster.remote.my_remote_cluster.authorization", randomEncodedApiKey()).build());
+            updateClusterSettings(Settings.builder().put("cluster.remote.my_remote_cluster.credentials", randomEncodedApiKey()).build());
             final ResponseException exception4 = expectThrows(
                 ResponseException.class,
                 () -> performRequestWithRemoteSearchUser(new Request("GET", "/my_remote_cluster:index1/_search"))
diff --git a/x-pack/plugin/security/qa/security-trial/src/javaRestTest/java/org/elasticsearch/xpack/security/crossclusteraccess/CrossClusterAccessHeadersForCcsRestIT.java b/x-pack/plugin/security/qa/security-trial/src/javaRestTest/java/org/elasticsearch/xpack/security/crossclusteraccess/CrossClusterAccessHeadersForCcsRestIT.java
@@ -848,10 +848,10 @@ private void setupClusterSettings(
         if (useProxyMode) {
             updateRemoteClusterSettings(
                 clusterAlias,
-                Map.of("mode", "proxy", "proxy_address", remoteAddress.toString(), "authorization", clusterCredential)
+                Map.of("mode", "proxy", "proxy_address", remoteAddress.toString(), "credentials", clusterCredential)
             );
         } else {
-            updateRemoteClusterSettings(clusterAlias, Map.of("seeds", remoteAddress.toString(), "authorization", clusterCredential));
+            updateRemoteClusterSettings(clusterAlias, Map.of("seeds", remoteAddress.toString(), "credentials", clusterCredential));
         }
     }
 
diff --git a/x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/transport/RemoteClusterCredentialsResolver.java b/x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/transport/RemoteClusterCredentialsResolver.java
@@ -19,7 +19,7 @@
 import java.util.Map;
 import java.util.Optional;
 
-import static org.elasticsearch.transport.RemoteClusterService.REMOTE_CLUSTER_AUTHORIZATION;
+import static org.elasticsearch.transport.RemoteClusterService.REMOTE_CLUSTER_CREDENTIALS;
 
 public class RemoteClusterCredentialsResolver {
 
@@ -29,12 +29,12 @@ public class RemoteClusterCredentialsResolver {
 
     public RemoteClusterCredentialsResolver(final Settings settings, final ClusterSettings clusterSettings) {
         if (TcpTransport.isUntrustedRemoteClusterEnabled()) {
-            for (final Map.Entry<String, String> entry : REMOTE_CLUSTER_AUTHORIZATION.getAsMap(settings).entrySet()) {
+            for (final Map.Entry<String, String> entry : REMOTE_CLUSTER_CREDENTIALS.getAsMap(settings).entrySet()) {
                 if (Strings.isEmpty(entry.getValue()) == false) {
                     update(entry.getKey(), entry.getValue());
                 }
             }
-            clusterSettings.addAffixUpdateConsumer(REMOTE_CLUSTER_AUTHORIZATION, this::update, (clusterAlias, authorization) -> {});
+            clusterSettings.addAffixUpdateConsumer(REMOTE_CLUSTER_CREDENTIALS, this::update, (clusterAlias, credentials) -> {});
         }
     }
 
@@ -48,12 +48,12 @@ public Optional<RemoteClusterCredentials> resolve(final String clusterAlias) {
         return Optional.empty();
     }
 
-    private void update(final String clusterAlias, final String authorization) {
-        if (Strings.isEmpty(authorization)) {
+    private void update(final String clusterAlias, final String credentials) {
+        if (Strings.isEmpty(credentials)) {
             apiKeys.remove(clusterAlias);
             LOGGER.debug("Credentials value for cluster alias [{}] removed", clusterAlias);
         } else {
-            final boolean notFound = Strings.isEmpty(apiKeys.put(clusterAlias, authorization));
+            final boolean notFound = Strings.isEmpty(apiKeys.put(clusterAlias, credentials));
             LOGGER.debug("Credentials value for cluster alias [{}] {}", clusterAlias, (notFound ? "added" : "updated"));
         }
     }
diff --git a/x-pack/plugin/security/src/test/java/org/elasticsearch/xpack/security/transport/RemoteClusterCredentialsResolverTests.java b/x-pack/plugin/security/src/test/java/org/elasticsearch/xpack/security/transport/RemoteClusterCredentialsResolverTests.java
@@ -61,9 +61,9 @@ public void testRemoteClusterApiKeyChanges() {
         final String clusterNameB = "clusterB";
         final String clusterDoesNotExist = randomAlphaOfLength(10);
         final Settings.Builder initialSettingsBuilder = Settings.builder();
-        initialSettingsBuilder.put("cluster.remote." + clusterNameA + ".authorization", "initialize");
+        initialSettingsBuilder.put("cluster.remote." + clusterNameA + ".credentials", "initialize");
         if (randomBoolean()) {
-            initialSettingsBuilder.put("cluster.remote." + clusterNameB + ".authorization", "");
+            initialSettingsBuilder.put("cluster.remote." + clusterNameB + ".credentials", "");
         }
         final Settings initialSettings = initialSettingsBuilder.build();
         RemoteClusterCredentialsResolver remoteClusterCredentialsResolver = new RemoteClusterCredentialsResolver(
@@ -81,8 +81,8 @@ public void testRemoteClusterApiKeyChanges() {
         // Add clusterB authorization setting
         final String clusterBapiKey1 = randomApiKey();
         final Settings newSettingsAddClusterB = Settings.builder()
-            .put("cluster.remote." + clusterNameA + ".authorization", "addB")
-            .put("cluster.remote." + clusterNameB + ".authorization", clusterBapiKey1)
+            .put("cluster.remote." + clusterNameA + ".credentials", "addB")
+            .put("cluster.remote." + clusterNameB + ".credentials", clusterBapiKey1)
             .build();
         final ClusterState newClusterState1 = createClusterState(clusterNameA, masterNodeA, newSettingsAddClusterB);
         ClusterServiceUtils.setState(clusterService, newClusterState1);
@@ -96,8 +96,8 @@ public void testRemoteClusterApiKeyChanges() {
         // Change clusterB authorization setting
         final String clusterBapiKey2 = randomApiKey();
         final Settings newSettingsUpdateClusterB = Settings.builder()
-            .put("cluster.remote." + clusterNameA + ".authorization", "editB")
-            .put("cluster.remote." + clusterNameB + ".authorization", clusterBapiKey2)
+            .put("cluster.remote." + clusterNameA + ".credentials", "editB")
+            .put("cluster.remote." + clusterNameB + ".credentials", clusterBapiKey2)
             .build();
         final ClusterState newClusterState2 = createClusterState(clusterNameA, masterNodeA, newSettingsUpdateClusterB);
         ClusterServiceUtils.setState(clusterService, newClusterState2);
@@ -110,9 +110,9 @@ public void testRemoteClusterApiKeyChanges() {
 
         // Remove clusterB authorization setting
         final Settings.Builder newSettingsOmitClusterBBuilder = Settings.builder();
-        newSettingsOmitClusterBBuilder.put("cluster.remote." + clusterNameA + ".authorization", "omitB");
+        newSettingsOmitClusterBBuilder.put("cluster.remote." + clusterNameA + ".credentials", "omitB");
         if (randomBoolean()) {
-            initialSettingsBuilder.put("cluster.remote." + clusterNameB + ".authorization", "");
+            initialSettingsBuilder.put("cluster.remote." + clusterNameB + ".credentials", "");
         }
         final Settings newSettingsOmitClusterB = newSettingsOmitClusterBBuilder.build();
         final ClusterState newClusterState3 = createClusterState(clusterNameA, masterNodeA, newSettingsOmitClusterB);

Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ public void testSettingsAreRegistered() {`
`89`	`89`	`assertTrue(ClusterSettings.BUILT_IN_CLUSTER_SETTINGS.contains(SniffConnectionStrategy.REMOTE_CONNECTIONS_PER_CLUSTER));`
`90`	`90`	`assertTrue(ClusterSettings.BUILT_IN_CLUSTER_SETTINGS.contains(SniffConnectionStrategy.REMOTE_CLUSTER_SEEDS));`
`91`	`91`	`if (TcpTransport.isUntrustedRemoteClusterEnabled()) {`
`92`		`- assertTrue(ClusterSettings.BUILT_IN_CLUSTER_SETTINGS.contains(RemoteClusterService.REMOTE_CLUSTER_AUTHORIZATION));`
	`92`	`+ assertTrue(ClusterSettings.BUILT_IN_CLUSTER_SETTINGS.contains(RemoteClusterService.REMOTE_CLUSTER_CREDENTIALS));`
`93`	`93`	`}`
`94`	`94`	`assertTrue(ClusterSettings.BUILT_IN_CLUSTER_SETTINGS.contains(SniffConnectionStrategy.REMOTE_NODE_CONNECTIONS));`
`95`	`95`	`assertTrue(ClusterSettings.BUILT_IN_CLUSTER_SETTINGS.contains(ProxyConnectionStrategy.PROXY_ADDRESS));`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ public void setUp() throws Exception {`
`70`	`70`	`final Settings.Builder builder = Settings.builder().put(modeKey, "sniff");`
`71`	`71`	`if (hasClusterCredentials) {`
`72`	`72`	`builder.put(`
`73`		`- RemoteClusterService.REMOTE_CLUSTER_AUTHORIZATION.getConcreteSettingForNamespace(clusterAlias).getKey(),`
	`73`	`+ RemoteClusterService.REMOTE_CLUSTER_CREDENTIALS.getConcreteSettingForNamespace(clusterAlias).getKey(),`
`74`	`74`	`randomAlphaOfLength(20)`
`75`	`75`	`);`
`76`	`76`	`}`