From 066c54b8d5108d6011674f69fa76210d78115844 Mon Sep 17 00:00:00 2001
From: Lee Hinman <lee@writequit.org>
Date: Tue, 1 Aug 2017 16:38:48 -0600
Subject: [PATCH] Disallow : in cluster and index/alias names

We use `:` for cross-cluster search (eg `cluster:index`), therefore, we should
not allow the ambiguity when allowing cluster or index names.

Relates to #23892
---
 .../main/java/org/elasticsearch/cluster/ClusterName.java  | 3 +++
 .../cluster/metadata/MetaDataCreateIndexService.java      | 3 +++
 .../cluster/metadata/MetaDataCreateIndexServiceTests.java | 1 +
 docs/reference/migration/migrate_7_0.asciidoc             | 8 ++++++++
 docs/reference/migration/migrate_7_0/cluster.asciidoc     | 7 +++++++
 docs/reference/migration/migrate_7_0/indices.asciidoc     | 7 +++++++
 6 files changed, 29 insertions(+)
 create mode 100644 docs/reference/migration/migrate_7_0/cluster.asciidoc
 create mode 100644 docs/reference/migration/migrate_7_0/indices.asciidoc

diff --git a/core/src/main/java/org/elasticsearch/cluster/ClusterName.java b/core/src/main/java/org/elasticsearch/cluster/ClusterName.java
index 36676300954e7..ab2efc6061e4e 100644
--- a/core/src/main/java/org/elasticsearch/cluster/ClusterName.java
+++ b/core/src/main/java/org/elasticsearch/cluster/ClusterName.java
@@ -34,6 +34,9 @@ public class ClusterName implements Writeable {
         if (s.isEmpty()) {
             throw new IllegalArgumentException("[cluster.name] must not be empty");
         }
+        if (s.contains(":")) {
+            throw new IllegalArgumentException("[cluster.name] must not contain ':'");
+        }
         return new ClusterName(s);
     }, Setting.Property.NodeScope);
 
diff --git a/core/src/main/java/org/elasticsearch/cluster/metadata/MetaDataCreateIndexService.java b/core/src/main/java/org/elasticsearch/cluster/metadata/MetaDataCreateIndexService.java
index 07a97b4f320cb..ae3dc19f62dc1 100644
--- a/core/src/main/java/org/elasticsearch/cluster/metadata/MetaDataCreateIndexService.java
+++ b/core/src/main/java/org/elasticsearch/cluster/metadata/MetaDataCreateIndexService.java
@@ -165,6 +165,9 @@ public static void validateIndexOrAliasName(String index, BiFunction<String, Str
         if (index.contains("#")) {
             throw exceptionCtor.apply(index, "must not contain '#'");
         }
+        if (index.contains(":")) {
+            throw exceptionCtor.apply(index, "must not contain ':'");
+        }
         if (index.charAt(0) == '_' || index.charAt(0) == '-' || index.charAt(0) == '+') {
             throw exceptionCtor.apply(index, "must not start with '_', '-', or '+'");
         }
diff --git a/core/src/test/java/org/elasticsearch/cluster/metadata/MetaDataCreateIndexServiceTests.java b/core/src/test/java/org/elasticsearch/cluster/metadata/MetaDataCreateIndexServiceTests.java
index 387b66d031b37..98d8d5072fafa 100644
--- a/core/src/test/java/org/elasticsearch/cluster/metadata/MetaDataCreateIndexServiceTests.java
+++ b/core/src/test/java/org/elasticsearch/cluster/metadata/MetaDataCreateIndexServiceTests.java
@@ -212,6 +212,7 @@ public void testValidateIndexName() throws Exception {
 
         validateIndexName("..", "must not be '.' or '..'");
 
+        validateIndexName("foo:bar", "must not contain ':'");
     }
 
     private void validateIndexName(String indexName, String errorMessage) {
diff --git a/docs/reference/migration/migrate_7_0.asciidoc b/docs/reference/migration/migrate_7_0.asciidoc
index 856ace1e4484c..c3e0a8a7f3b97 100644
--- a/docs/reference/migration/migrate_7_0.asciidoc
+++ b/docs/reference/migration/migrate_7_0.asciidoc
@@ -21,3 +21,11 @@ way to reindex old indices is to use the `reindex` API.
 
 =========================================
 
+[float]
+=== Also see:
+
+* <<breaking_70_cluster_changes>>
+* <<breaking_70_indices_changes>>
+
+include::migrate_7_0/cluster.asciidoc[]
+include::migrate_7_0/indices.asciidoc[]
diff --git a/docs/reference/migration/migrate_7_0/cluster.asciidoc b/docs/reference/migration/migrate_7_0/cluster.asciidoc
new file mode 100644
index 0000000000000..b573fc9da40a1
--- /dev/null
+++ b/docs/reference/migration/migrate_7_0/cluster.asciidoc
@@ -0,0 +1,7 @@
+[[breaking_70_cluster_changes]]
+=== Cluster changes
+
+==== `:` is no longer allowed in cluster name
+
+Due to cross-cluster search using `:` to separate a cluster and index name,
+cluster names may no longer contain `:`.
diff --git a/docs/reference/migration/migrate_7_0/indices.asciidoc b/docs/reference/migration/migrate_7_0/indices.asciidoc
new file mode 100644
index 0000000000000..eeecacc06fc06
--- /dev/null
+++ b/docs/reference/migration/migrate_7_0/indices.asciidoc
@@ -0,0 +1,7 @@
+[[breaking_70_indices_changes]]
+=== Indices changes
+
+==== `:` is no longer allowed in index name
+
+Due to cross-cluster search using `:` to separate a cluster and index name,
+index names may no longer contain `:`.