Ref #25533: validate parameter id format

Author: LEDfan

src/main/java/eu/openanalytics/containerproxy/service/ParametersService.java

@@ -39,6 +39,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 
 @Service
@@ -47,6 +48,8 @@ public class ParametersService {
     @Inject
     private IProxySpecProvider baseSpecProvider;
 
+    private static final Pattern PARAMETER_ID_PATTERN = Pattern.compile("[a-zA-Z\\d_-]*");
+
     @PostConstruct
     public void init() {
         for (ProxySpec spec : baseSpecProvider.getSpecs()) {
@@ -59,8 +62,6 @@ private void validateSpec(ProxySpec spec) {
             return;
         }
 
-        // TODO validate parameter id
-
         // Validate Parameter Definitions
         HashSet<String> parameterIds = new HashSet<>();
         for (ParameterDefinition definition : spec.getParameters().getDefinitions()) {
@@ -70,6 +71,9 @@ private void validateSpec(ProxySpec spec) {
             if (parameterIds.contains(definition.getId())) {
                 throw new IllegalStateException(String.format("Configuration error: error in parameters of spec '%s', error: duplicate parameter id '%s'", spec.getId(), definition.getId()));
             }
+            if (!PARAMETER_ID_PATTERN.matcher(definition.getId()).matches()) {
+                throw new IllegalStateException(String.format("Configuration error: error in parameters of spec '%s', error: parameter id '%s' is invalid, id may only exists out of Latin letters, numbers, dash and underscore", spec.getId(), definition.getId()));
+            }
             parameterIds.add(definition.getId());
             if (definition.getDisplayName() != null && StringUtils.isBlank(definition.getDisplayName())) {
                 throw new IllegalStateException(String.format("Configuration error: error in parameters of spec '%s', error: displayName may not be blank of parameter with id '%s'", spec.getId(), definition.getId()));

src/test/java/eu/openanalytics/containerproxy/test/unit/TestParameterValidationService.java

@@ -60,6 +60,7 @@ public void testParameterDefinitionErrors() {
         test("classpath:application-parameters-validation-2.yaml", "Configuration error: error in parameters of spec 'big-parameters', error: duplicate parameter id 'parameter1'");
         test("classpath:application-parameters-validation-3.yaml", "Configuration error: error in parameters of spec 'big-parameters', error: displayName may not be blank of parameter with id 'parameter1'");
         test("classpath:application-parameters-validation-4.yaml", "Configuration error: error in parameters of spec 'big-parameters', error: description may not be blank of parameter with id 'parameter1'");
+        test("classpath:application-parameters-validation-8.yaml", "Configuration error: error in parameters of spec 'big-parameters', error: parameter id 'parameter1$#>>>.;;' is invalid, id may only exists out of Latin letters, numbers, dash and underscore");
     }
 
     @Test

src/test/resources/application-parameters-validation-8.yaml

@@ -0,0 +1,35 @@
+spring:
+  session:
+    store-type: none
+  data:
+    redis:
+      repositories:
+        enabled: false
+proxy:
+  authentication: simple
+  container-backend: docker
+
+
+  users:
+    - name: demo
+      password: demo
+    - name: demo2
+      password: demo2
+
+  docker:
+    url: http://localhost:2375
+
+  specs:
+    - id: big-parameters
+      container-specs:
+        - image: "openanalytics/shinyproxy-demo"
+          cmd: [ "R", "-e", "shinyproxy::run_01_hello()" ]
+          port-mapping:
+            default: 3838
+      parameters:
+        definitions:
+          - id: "parameter1$#>>>.;;"
+        values:
+          - parameter1:
+              - a
+            parameterblub: a