Apache Solr open-source search software
SOLR-18170: add validation for configset names (#4248)
Eric Pugh24b576513622
diff --git a/changelog/unreleased/SOLR-18170-add-validation-for-configset-names.yml b/changelog/unreleased/SOLR-18170-add-validation-for-configset-names.ymlnew file mode 100644index 00000000000..8302e15561c--- /dev/null+++ b/changelog/unreleased/SOLR-18170-add-validation-for-configset-names.yml@@ -0,0 +1,7 @@+title: Add validation for configset names at API layer in line with what Admin UI enforces.+type: fixed+authors:+ - name: Eric Pugh+links:+ - name: SOLR-18170+ url: https://issues.apache.org/jira/browse/SOLR-18170diff --git a/solr/core/src/java/org/apache/solr/handler/configsets/CloneConfigSet.java b/solr/core/src/java/org/apache/solr/handler/configsets/CloneConfigSet.javaindex c98442d8b44..0ceb5a830be 100644--- a/solr/core/src/java/org/apache/solr/handler/configsets/CloneConfigSet.java+++ b/solr/core/src/java/org/apache/solr/handler/configsets/CloneConfigSet.java@@ -26,6 +26,7 @@ import java.util.Map;import org.apache.solr.client.api.endpoint.ConfigsetsApi;import org.apache.solr.client.api.model.CloneConfigsetRequestBody;import org.apache.solr.client.api.model.SolrJerseyResponse;+import org.apache.solr.client.solrj.util.SolrIdentifierValidator;import org.apache.solr.cloud.ConfigSetCmds;import org.apache.solr.common.SolrException;import org.apache.solr.common.params.ConfigSetParams;@@ -50,6 +51,7 @@ public class CloneConfigSet extends ConfigSetAPIBase implements ConfigsetsApi.Clpublic SolrJerseyResponse cloneExistingConfigSet(CloneConfigsetRequestBody requestBody)throws Exception {final var response = instantiateJerseyResponse(SolrJerseyResponse.class);+ SolrIdentifierValidator.validateConfigSetName(requestBody.name);if (configSetService.checkConfigExists(requestBody.name)) {throw new SolrException(SolrException.ErrorCode.BAD_REQUEST, "ConfigSet already exists: " + requestBody.name);diff --git a/solr/core/src/java/org/apache/solr/handler/configsets/UploadConfigSet.java b/solr/core/src/java/org/apache/solr/handler/configsets/UploadConfigSet.javaindex 617d5c8af22..fee660a87f5 100644--- a/solr/core/src/java/org/apache/solr/handler/configsets/UploadConfigSet.java+++ b/solr/core/src/java/org/apache/solr/handler/configsets/UploadConfigSet.java@@ -29,6 +29,7 @@ import java.util.zip.ZipEntry;import java.util.zip.ZipInputStream;import org.apache.solr.client.api.endpoint.ConfigsetsApi;import org.apache.solr.client.api.model.SolrJerseyResponse;+import org.apache.solr.client.solrj.util.SolrIdentifierValidator;import org.apache.solr.common.SolrException;import org.apache.solr.core.ConfigSetService;import org.apache.solr.core.CoreContainer;@@ -58,6 +59,7 @@ public class UploadConfigSet extends ConfigSetAPIBase implements ConfigsetsApi.Uthrows IOException {final var response = instantiateJerseyResponse(SolrJerseyResponse.class);ensureConfigSetUploadEnabled();+ SolrIdentifierValidator.validateConfigSetName(configSetName);boolean overwritesExisting = configSetService.checkConfigExists(configSetName);// Get upload parameters@@ -110,6 +112,7 @@ public class UploadConfigSet extends ConfigSetAPIBase implements ConfigsetsApi.Uthrows IOException {final var response = instantiateJerseyResponse(SolrJerseyResponse.class);ensureConfigSetUploadEnabled();+ SolrIdentifierValidator.validateConfigSetName(configSetName);boolean overwritesExisting = configSetService.checkConfigExists(configSetName);diff --git a/solr/core/src/test/org/apache/solr/cloud/TestConfigSetsAPI.java b/solr/core/src/test/org/apache/solr/cloud/TestConfigSetsAPI.javaindex 6bc03e5ef31..c30bcabed91 100644--- a/solr/core/src/test/org/apache/solr/cloud/TestConfigSetsAPI.java+++ b/solr/core/src/test/org/apache/solr/cloud/TestConfigSetsAPI.java@@ -162,6 +162,14 @@ public class TestConfigSetsAPI extends SolrCloudTestCase {Create baseConfigNoExists = new Create();baseConfigNoExists.setConfigSetName("newConfigSet").setBaseConfigSetName("baseConfigSet");verifyException(solrClient, baseConfigNoExists, "Base ConfigSet does not exist");++ // Invalid configset names+ for (String invalidName :+ new String[] {"configset!", "configset\"", "-configset", "configset name"}) {+ Create invalidNameCreate = new Create();+ invalidNameCreate.setConfigSetName(invalidName).setBaseConfigSetName("_default");+ verifyException(solrClient, invalidNameCreate, "Invalid configset");+ }}}@@ -383,6 +391,22 @@ public class TestConfigSetsAPI extends SolrCloudTestCase {"Expected file doesnt exist in zk. It's possibly overwritten",zkClient.exists("/configs/myconf/anotherDummyFile"));+ // Checking error when configuration name contains invalid characters+ for (String invalidName : new String[] {"configset!", "-configset"}) {+ map =+ postDataAndGetResponse(+ cluster.getSolrClient(),+ cluster.getJettySolrRunners().get(0).getBaseUrl().toString()+ + "/admin/configs?action=UPLOAD&name="+ + invalidName,+ emptyData,+ null,+ false);+ assertNotNull(map);+ statusCode = (long) getObjectByPath(map, Arrays.asList("responseHeader", "status"));+ assertEquals("Expected 400 for invalid configset name: " + invalidName, 400l, statusCode);+ }+zkClient.close();solrClient.close();}diff --git a/solr/solrj/src/java/org/apache/solr/client/solrj/util/SolrIdentifierValidator.java b/solr/solrj/src/java/org/apache/solr/client/solrj/util/SolrIdentifierValidator.javaindex c66b560304b..19454b31e3f 100644--- a/solr/solrj/src/java/org/apache/solr/client/solrj/util/SolrIdentifierValidator.java+++ b/solr/solrj/src/java/org/apache/solr/client/solrj/util/SolrIdentifierValidator.java@@ -33,7 +33,8 @@ public class SolrIdentifierValidator {SHARD,COLLECTION,CORE,- ALIAS+ ALIAS,+ CONFIGSET}public static String validateName(IdentifierType type, String name) {@@ -59,6 +60,10 @@ public class SolrIdentifierValidator {return validateName(IdentifierType.CORE, coreName);}+ public static String validateConfigSetName(String configSetName) {+ return validateName(IdentifierType.CONFIGSET, configSetName);+ }+private static boolean validateIdentifier(String identifier) {if (identifier != null && identifierPattern.matcher(identifier).matches()) {return true;