Add validation framework for imposing specific rules for configuration

values and a single PortValidator as a POC, and add a LifecycleListener
that is capable of stopping the startup process when there are validation
failures.

This is a proof-of-concept implementation that enhances the configtest
command with validation capabilities, focusing on port configuration
as a valuable starting point from dev-list discussion.

The configtest behavior hasn't changed unless you use the
--validate-only option to produce validation output instead of the
typical server startup attempt. There's also a new command in catalina
for config-validate for ease of use.

Port validation detects:
- Port conflicts (already in use)
- Invalid port numbers (< 0 or > 65535)
- Duplicate port assignments across connectors
- Privileged ports (< 1024) without root access
- Default/insecure shutdown commands
- AJP connectors missing required 'secret' attribute
- AJP connectors listening on all interfaces (0.0.0.0)

Author: csutherl

bin/catalina.bat

@@ -263,6 +263,7 @@ if ""%1"" == ""run"" goto doRun
 if ""%1"" == ""start"" goto doStart
 if ""%1"" == ""stop"" goto doStop
 if ""%1"" == ""configtest"" goto doConfigTest
+if ""%1"" == ""config-validate"" goto doConfigValidate
 if ""%1"" == ""version"" goto doVersion
 
 echo Usage:  catalina ( commands ... )
@@ -273,6 +274,7 @@ echo   run               Start Catalina in the current window
 echo   start             Start Catalina in a separate window
 echo   stop              Stop Catalina
 echo   configtest        Run a basic syntax check on server.xml
+echo   config-validate   Run configuration validators with detailed output
 echo   version           What version of tomcat are you running?
 goto end
 
@@ -300,7 +302,19 @@ goto execCmd
 
 :doConfigTest
 shift
-set ACTION=configtest
+rem Check if --validate-only argument is present
+if ""%1"" == ""--validate-only"" (
+    set ACTION=config-validate
+    shift
+) else (
+    set ACTION=configtest
+)
+set CATALINA_OPTS=
+goto execCmd
+
+:doConfigValidate
+shift
+set ACTION=config-validate
 set CATALINA_OPTS=
 goto execCmd
 

bin/catalina.sh

@@ -549,18 +549,35 @@ elif [ "$1" = "stop" ] ; then
 
 elif [ "$1" = "configtest" ] ; then
 
+    # Check if --validate-only argument is present
+    if [ "$2" = "--validate-only" ] ; then
+        COMMAND="config-validate"
+    else
+        COMMAND="configtest"
+    fi
+
     eval "\"$_RUNJAVA\"" $LOGGING_MANAGER "$JAVA_OPTS" \
       -classpath "\"$CLASSPATH\"" \
       -Dcatalina.base="\"$CATALINA_BASE\"" \
       -Dcatalina.home="\"$CATALINA_HOME\"" \
       -Djava.io.tmpdir="\"$CATALINA_TMPDIR\"" \
-      org.apache.catalina.startup.Bootstrap configtest
+      org.apache.catalina.startup.Bootstrap "$COMMAND"
     result=$?
-    if [ $result -ne 0 ]; then
+    if [ $result -ne 0 ] && [ "$COMMAND" = "configtest" ]; then
         echo "Configuration error detected!"
     fi
     exit $result
 
+elif [ "$1" = "config-validate" ] ; then
+
+    eval "\"$_RUNJAVA\"" $LOGGING_MANAGER "$JAVA_OPTS" \
+      -classpath "\"$CLASSPATH\"" \
+      -Dcatalina.base="\"$CATALINA_BASE\"" \
+      -Dcatalina.home="\"$CATALINA_HOME\"" \
+      -Djava.io.tmpdir="\"$CATALINA_TMPDIR\"" \
+      org.apache.catalina.startup.Bootstrap config-validate
+    exit $?
+
 elif [ "$1" = "version" ] ; then
 
    eval "\"$_RUNJAVA\"" "$JAVA_OPTS" \

java/org/apache/catalina/startup/Bootstrap.java

@@ -275,9 +275,25 @@ public void init() throws Exception {
      * Load daemon.
      */
     private void load(String[] arguments) throws Exception {
+        invokeCatalinaMethod("load", arguments);
+    }
+
+    /**
+     * Load configuration only without initializing server.
+     * Used for validation without binding to ports.
+     */
+    private void loadConfigOnly(String[] arguments) throws Exception {
+        invokeCatalinaMethod("loadConfigOnly", arguments);
+    }
 
-        // Call the load() method
-        String methodName = "load";
+    /**
+     * Helper method to invoke a Catalina method via reflection with optional arguments.
+     *
+     * @param methodName the name of the method to invoke
+     * @param arguments optional arguments to pass to the method
+     * @throws Exception if the method invocation fails
+     */
+    private void invokeCatalinaMethod(String methodName, String[] arguments) throws Exception {
         Object[] param;
         Class<?>[] paramTypes;
         if (arguments == null || arguments.length == 0) {
@@ -296,7 +312,6 @@ private void load(String[] arguments) throws Exception {
         method.invoke(catalinaDaemon, param);
     }
 
-
     /**
      * getServer() for configtest
      */
@@ -307,6 +322,18 @@ private Object getServer() throws Exception {
         return method.invoke(catalinaDaemon);
     }
 
+    /**
+     * Run configuration validation tests.
+     *
+     * @return exit code (0 = success, 1 = errors found)
+     * @throws Exception Fatal validation error
+     */
+    public int configtest() throws Exception {
+        Method method = catalinaDaemon.getClass().getMethod("configtest");
+        Integer exitCode = (Integer) method.invoke(catalinaDaemon);
+        return exitCode != null ? exitCode.intValue() : 1;
+    }
+
 
     // ----------------------------------------------------------- Main Program
 
@@ -482,6 +509,14 @@ public static void main(String[] args) {
                     }
                     System.exit(0);
                     break;
+                case "config-validate":
+                    daemon.loadConfigOnly(args);
+                    if (null == daemon.getServer()) {
+                        System.exit(1);
+                    }
+                    int exitCode = daemon.configtest();
+                    System.exit(exitCode);
+                    break;
                 default:
                     log.warn("Bootstrap: command \"" + command + "\" does not exist.");
                     break;

java/org/apache/catalina/startup/Catalina.java

@@ -343,6 +343,9 @@ protected boolean arguments(String[] args) {
             } else if (arg.equals("configtest")) {
                 isGenerateCode = false;
                 // NOOP
+            } else if (arg.equals("config-validate")) {
+                isGenerateCode = false;
+                // NOOP
             } else if (arg.equals("stop")) {
                 isGenerateCode = false;
                 // NOOP
@@ -673,17 +676,34 @@ public void stopServer(String[] arguments) {
     }
 
 
+    /**
+     * Load configuration without initializing the server.
+     * Used for configuration validation without binding to ports.
+     */
+    public void loadConfigOnly() {
+        loadInternal(false);
+    }
+
     /**
      * Start a new server instance.
      */
     public void load() {
+        loadInternal(true);
+    }
 
+    /**
+     * Internal load method that handles both config-only and full initialization.
+     *
+     * @param initServer if true, initialize the server and bind to ports;
+     *                   if false, only parse configuration
+     */
+    private void loadInternal(boolean initServer) {
         if (loaded) {
             return;
         }
         loaded = true;
 
-        long t1 = System.nanoTime();
+        long t1 = initServer ? System.nanoTime() : 0;
 
         // Before digester - it may be needed
         initNaming();
@@ -699,23 +719,25 @@ public void load() {
         getServer().setCatalinaHome(Bootstrap.getCatalinaHomeFile());
         getServer().setCatalinaBase(Bootstrap.getCatalinaBaseFile());
 
-        // Stream redirection
-        initStreams();
+        if (initServer) {
+            // Stream redirection
+            initStreams();
 
-        // Start the new server
-        try {
-            getServer().init();
-        } catch (LifecycleException e) {
-            if (throwOnInitFailure) {
-                throw new Error(e);
-            } else {
-                log.error(sm.getString("catalina.initError"), e);
+            // Start the new server
+            try {
+                getServer().init();
+            } catch (LifecycleException e) {
+                if (throwOnInitFailure) {
+                    throw new Error(e);
+                } else {
+                    log.error(sm.getString("catalina.initError"), e);
+                }
             }
-        }
 
-        if (log.isInfoEnabled()) {
-            log.info(sm.getString("catalina.init",
-                    Long.toString(TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - t1))));
+            if (log.isInfoEnabled()) {
+                log.info(sm.getString("catalina.init",
+                        Long.toString(TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - t1))));
+            }
         }
     }
 
@@ -734,6 +756,20 @@ public void load(String[] args) {
         }
     }
 
+    /*
+     * Load configuration only using arguments
+     */
+    public void loadConfigOnly(String[] args) {
+
+        try {
+            if (arguments(args)) {
+                loadConfigOnly();
+            }
+        } catch (Exception e) {
+            e.printStackTrace(System.out);
+        }
+    }
+
 
     /**
      * Start a new server instance.
@@ -857,6 +893,69 @@ protected void usage() {
 
     }
 
+    /**
+     * Run configuration validation tests.
+     *
+     * @return exit code (0 = success, 1 = errors found)
+     */
+    public int configtest() {
+        if (server == null) {
+            return 1;
+        }
+
+        try {
+
+            // Run validators
+            org.apache.catalina.startup.validator.ValidatorRegistry registry =
+                    new org.apache.catalina.startup.validator.ValidatorRegistry();
+            org.apache.catalina.startup.validator.ValidationResult result =
+                    registry.validate(server);
+
+            // Print results
+            System.out.println();
+            System.out.println("Configuration Validation Results");
+            System.out.println("=================================");
+            System.out.println();
+
+            if (!result.hasFindings()) {
+                System.out.println("No issues found. Configuration is valid.");
+                return 0;
+            }
+
+            // Group findings by severity
+            java.util.List<org.apache.catalina.startup.validator.ValidationResult.Finding> findings =
+                    result.getFindings();
+
+            for (org.apache.catalina.startup.validator.ValidationResult.Finding finding : findings) {
+                System.out.println(finding.toString());
+            }
+
+            System.out.println();
+            System.out.println("Summary: " + result.getErrorCount() + " error(s), " +
+                    result.getWarningCount() + " warning(s), " +
+                    result.getInfoCount() + " info message(s)");
+            System.out.println();
+
+            if (result.getErrorCount() > 0) {
+                System.out.println("Configuration test FAILED.");
+                System.out.println("Configuration error detected!");
+                return 1;
+            } else {
+                if (result.getWarningCount() > 0) {
+                    System.out.println("Configuration test PASSED (with warnings).");
+                } else {
+                    System.out.println("Configuration test PASSED.");
+                }
+                return 0;
+            }
+
+        } catch (Exception e) {
+            log.error(sm.getString("catalina.configTestError"), e);
+            e.printStackTrace();
+            return 1;
+        }
+    }
+
 
     protected void initStreams() {
         // Replace System.out and System.err with a custom PrintStream

java/org/apache/catalina/startup/validator/LocalStrings.properties

@@ -0,0 +1,32 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# StartupValidationListener messages
+startupValidationListener.notServer=StartupValidationListener can only be attached to a Server
+startupValidationListener.starting=Running configuration validation checks...
+startupValidationListener.abortingOnErrors=Aborting startup due to {0} configuration errors
+startupValidationListener.complete=Configuration validation complete: {0} errors, {1} warnings, {2} info messages
+
+# PortValidator messages
+portValidator.shutdownDisabled=Shutdown port is disabled (port < 0)
+portValidator.shutdownCommandDefault=Shutdown command is set to default value "SHUTDOWN" on port {0}. Consider using a custom shutdown command.
+portValidator.invalidPort=Invalid port number: {0}
+portValidator.privilegedPort=Port {0} requires root/administrator privileges (current user: {1})
+portValidator.portInUse=Port {0} is already in use
+portValidator.shutdownPortInUse=Shutdown port {0} is already in use
+portValidator.duplicatePort=Port {0} is already configured for: {1}
+portValidator.invalidAddress=Invalid bind address: {0}
+portValidator.ajpMissingSecret=AJP connector is missing required ''secret'' attribute for secure operation
+portValidator.ajpListeningAll=AJP connector is listening on all interfaces (0.0.0.0). Consider binding to localhost or specific IP.