adding standalone mode - addressing #6

Author: tkohegyi

README.md

@@ -86,4 +86,6 @@ SSL Support
 While the proxy supports SSL, it requires that a Certificate Authority be installed in to the browser / at client from where you call a server via the proxy.
 This allows the client to trust all the SSL traffic coming from the proxy, which will be proxied using a classic man-in-the-middle technique. 
 
-**IT IS CRITICAL THAT YOU NOT INSTALL THIS CERTIFICATE AUTHORITY ON A CLIENT/BROWSER THAT IS USED FOR ANYTHING OTHER THAN TESTING.**
+**IT IS CRITICAL THAT YOU DO NOT INSTALL THIS CERTIFICATE AUTHORITY ON A CLIENT/BROWSER THAT IS USED FOR ANYTHING OTHER THAN TESTING.**
+
+It is recommended to use `-Djdk.tls.namedGroups="secp256r1, secp384r1, ffdhe2048, ffdhe3072"` java arguments to address some issues still existing in some JDK implementations.

build.gradle

@@ -1,3 +1,12 @@
+/*==========================================================================
+Author: Tamas Kohegyi
+===========================================================================*/
+buildscript {
+    dependencies {
+        classpath 'gradle.plugin.com.github.jengelman.gradle.plugins:shadow:7.0.0'
+    }
+}
+
 plugins {
     id "org.sonarqube" version "3.2.0"
 }
@@ -9,6 +18,15 @@ apply plugin: 'java-library'
 apply plugin: 'maven-publish'
 apply plugin: 'signing'
 apply plugin: 'jacoco'
+apply plugin: 'application'
+apply plugin: 'com.github.johnrengelman.shadow'
+
+repositories {
+    mavenCentral()
+    maven { url "https://repo.maven.apache.org/maven2" }
+    maven { url "https://repository.mulesoft.org/nexus/content/repositories/public/" }
+    maven { url "https://oss.sonatype.org/content/repositories/snapshots" }
+}
 
 group = "website.magyar"
 archivesBaseName = "mitm-java-proxy"
@@ -19,16 +37,11 @@ ext.myBuildNumber='SNAPSHOT'
 if ( hasProperty('buildNumber') ) {
     myBuildNumber = "${project.ext.buildNumber}"
 }
-version = "$wilmaVersion" + ".24." + "${project.ext.myBuildNumber}"
+version = "$wilmaVersion" + ".25." + "${project.ext.myBuildNumber}"
+mainClassName = "website.magyar.mitm.standalone.StandaloneProxy"
 
 def isSnapshot = project.version.contains('SNAPSHOT')
 
-repositories {
-    maven { url "https://repo.maven.apache.org/maven2" }
-    maven { url "https://repository.mulesoft.org/nexus/content/repositories/public/" }
-    maven { url "https://oss.sonatype.org/content/repositories/snapshots" }
-}
-
 // Source and target info
 sourceCompatibility = JavaVersion.VERSION_15
 targetCompatibility = JavaVersion.VERSION_15
@@ -92,6 +105,34 @@ test {
 
 test.finalizedBy jacocoTestReport
 
+def configFileDefaultPath = "$project.projectDir/proxy.conf.properties"
+if (!hasProperty("configFilePath")) {
+    project.ext.configFilePath = configFileDefaultPath
+}
+
+run{
+    args = ["$configFilePath"]
+}
+
+shadowJar {
+    append('META-INF/spring.handlers')
+    append('META-INF/spring.schemas')
+
+    excludes = [
+            'META-INF/*.SF',
+            'META-INF/*.DSA',
+            'META-INF/*.RSA',
+            'images/',
+            '*.txt',
+            '*.gif',
+            '*.png',
+            '*.dtd',
+            'build.properties',
+            'XPP3_1.1.4c_MIN_VERSION',
+            'activemq.xsd.*',
+            'about.html'] as Iterable<String>
+}
+
 dependencies {
     implementation group: 'ch.qos.logback', name: 'logback-classic', version:'1.2.11'
     implementation group: 'org.slf4j', name: 'jcl-over-slf4j', version:'1.7.36'
@@ -123,8 +164,34 @@ def myCopySpec = project.copySpec {
 }
 
 jar {
+    manifest.attributes( 'provider': 'gradle')
+    manifest.attributes( 'Main-Class': mainClassName)
     manifest.attributes( 'Implementation-Title': "$componentDescription - V${project.version}")
     with myCopySpec
+    finalizedBy shadowJar
+}
+
+def myCopySpec2 = project.copySpec {
+    from(rootProject.rootDir.absolutePath + '/build/libs/') {
+        include "mitm-java-proxy-$version" + '-all.jar'
+    }
+    from(rootProject.rootDir.absolutePath + '/') {
+        include 'LICENSE.txt'
+        include 'README.txt'
+        include 'README.md'
+    }
+}
+
+task copyToReleaseRoot (type: Copy) {
+    dependsOn shadowJar
+    into(rootProject.rootDir.absolutePath + '/release')
+    rename "mitm-java-proxy-$version" + '-all.jar', "mitm-java-proxy-" + "$version" + ".jar"
+    with myCopySpec2
+}
+
+task release(type: Zip) {
+    dependsOn copyToReleaseRoot
+    from rootProject.rootDir.absolutePath + '/release'
 }
 
 publishing {

src/main/java/website/magyar/mitm/standalone/Bootstrap.java

@@ -0,0 +1,84 @@
+package website.magyar.mitm.standalone;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import website.magyar.mitm.proxy.ProxyServer;
+
+import java.util.Properties;
+
+/**
+ * Bootstrap class that starts the application engine.
+ *
+ * @author Tamas Kohegyi
+ */
+public class Bootstrap {
+    private static final int PROXY_TIMEOUT = 1200000; //20 minute - giving time to debug
+    private final Logger logger = LoggerFactory.getLogger(Bootstrap.class);
+    private int proxyPort = -1;
+
+    private Properties properties;
+    private ProxyServer proxyServer;
+
+    public ProxyServer getProxyServer() {
+        return proxyServer;
+    }
+
+    public int getProxyPort() {
+        return proxyPort;
+    }
+
+    /**
+     * Starts the application.
+     *
+     * @param args command line arguments
+     */
+    public ProxyServer bootstrap(final String[] args) {
+        ProxyServer proxyServer = null;
+        PropertyLoader propertyLoader = new PropertyLoader();
+        String configurationFile = args != null && args.length > 0 ? args[0] : null;
+        properties = propertyLoader.loadProperties(configurationFile);
+        Integer port = getPort();
+        Integer proxyTimeout = getProxyTimeout();
+        Boolean keepSslAlive = getKeepSslAlive();
+        try {
+            proxyServer = startProxy(port, proxyTimeout, keepSslAlive);
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+        return proxyServer;
+    }
+
+    private Boolean getKeepSslAlive() {
+        return Boolean.valueOf(properties.getProperty("proxy.keepSslAlive"));
+    }
+
+    private Integer getProxyTimeout() {
+        int timeout = PROXY_TIMEOUT;
+        try {
+            timeout = Integer.parseInt(properties.getProperty("proxy.timeout"));
+        } catch (NumberFormatException e) {
+            logger.warn("Invalid proxy timeout value! - Using default timeout:{}", PROXY_TIMEOUT);
+        }
+        return timeout;
+    }
+
+    private Integer getPort() {
+        int port = 0;
+        try {
+            port = Integer.parseInt(properties.getProperty("proxy.port"));
+        } catch (NumberFormatException e) {
+            logger.warn("Invalid proxy port value! - Using random port.");
+        }
+        return port;
+    }
+
+    private ProxyServer startProxy(int port, int proxyTimeout, boolean keepSslAlive) throws Exception {
+        proxyServer = new ProxyServer(port);
+        proxyServer.start(proxyTimeout);
+        proxyPort = proxyServer.getPort();
+        ProxyServer.setShouldKeepSslConnectionAlive(keepSslAlive);
+        return proxyServer;
+    }
+
+
+}

src/main/java/website/magyar/mitm/standalone/PropertyLoader.java

@@ -0,0 +1,44 @@
+package website.magyar.mitm.standalone;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import website.magyar.mitm.standalone.helper.PropertiesNotAvailableException;
+
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Properties;
+
+public class PropertyLoader {
+    private final Logger logger = LoggerFactory.getLogger(PropertyLoader.class);
+
+    /**
+     * Loads properties from the specified property file. Also validates
+     * the property file.
+     * @param configFile the configuration file to be read
+     * @return the loaded {@link Properties}
+     */
+    public Properties loadProperties(final String configFile) {
+        Properties properties = new Properties();
+        if (configFile != null) {
+            try {
+                checkPropertyFileArgument(configFile);
+                InputStream inputStream = new FileInputStream(configFile);
+                properties.load(inputStream);
+                logger.debug("Properties loaded from external configuration.");
+            } catch (IOException e) {
+                throw new PropertiesNotAvailableException("Configuration file " + configFile + " cannot be loaded.");
+            }
+        }
+        return properties;
+    }
+
+    private void checkPropertyFileArgument(final String args) {
+        if (args == null || "".equals(args)) {
+            throw new PropertiesNotAvailableException("Configuration file was not specified as input argument!");
+        } else if (!args.endsWith(".properties")) {
+            throw new PropertiesNotAvailableException("Configuration file must be a properties file!");
+        }
+    }
+
+}

src/main/java/website/magyar/mitm/standalone/StandaloneProxy.java

@@ -0,0 +1,17 @@
+package website.magyar.mitm.standalone;
+
+public final class StandaloneProxy {
+    public static String[] arguments; //NOSONAR
+
+    private StandaloneProxy() {
+    }
+
+    /**
+     * The app main entry point.
+     * @param args The program needs the path of conf.properties to run.
+     */
+    public static void main(final String[] args) {
+        arguments = args; //NOSONAR
+        new Bootstrap().bootstrap(args);
+    }
+}

src/main/java/website/magyar/mitm/standalone/helper/InvalidPropertyException.java

@@ -0,0 +1,27 @@
+package website.magyar.mitm.standalone.helper;
+
+/**
+ * Thrown when the configuration properties cannot be loaded.
+ * @author Tamas Kohegyi
+ *
+ */
+public class InvalidPropertyException extends RuntimeException {
+
+    /**
+     * Constructor with a cause.
+     * @param message the message of the exception
+     * @param throwable the cause of the exception
+     */
+    public InvalidPropertyException(final String message, final Throwable throwable) {
+        super(message, throwable);
+    }
+
+    /**
+     * Constructor with a message only.
+     * @param message the message of the exception
+     */
+    public InvalidPropertyException(final String message) {
+        super(message);
+    }
+
+}

src/main/java/website/magyar/mitm/standalone/helper/PropertiesNotAvailableException.java

@@ -0,0 +1,27 @@
+package website.magyar.mitm.standalone.helper;
+
+/**
+ * Thrown when the configuration properties cannot be loaded.
+ * @author Tamas Kohegyi
+ *
+ */
+public class PropertiesNotAvailableException extends RuntimeException {
+
+    /**
+     * Constructor with a cause.
+     * @param message the message of the exception
+     * @param throwable the cause of the exception
+     */
+    public PropertiesNotAvailableException(final String message, final Throwable throwable) {
+        super(message, throwable);
+    }
+
+    /**
+     * Constructor with a message only.
+     * @param message the message of the exception
+     */
+    public PropertiesNotAvailableException(final String message) {
+        super(message);
+    }
+
+}

src/main/resources/proxy.conf.properties

@@ -0,0 +1,4 @@
+#this property is just a sample file, to be used in standalone mode only
+proxy.port=9092
+proxy.timeout=30000
+proxy.keepSslAlive=false

src/test/java/website/magyar/mitm/proxy/stub/RequestInterceptorForStub.java

@@ -0,0 +1,36 @@
+package website.magyar.mitm.proxy.stub;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import website.magyar.mitm.proxy.RequestInterceptor;
+import website.magyar.mitm.proxy.http.MitmJavaProxyHttpRequest;
+
+import java.net.URI;
+import java.net.URISyntaxException;
+
+/**
+ * Class that is able to intercept and process every request going through the proxy, by implementing the RequestInterceptor interface.
+ * It redirects all incoming message to the stub service - which acts as service virtualization.
+ *
+ * @author Tamas_Kohegyi
+ */
+public class RequestInterceptorForStub implements RequestInterceptor {
+
+    private final Logger logger = LoggerFactory.getLogger(RequestInterceptorForStub.class);
+
+    private URI stubUri;
+
+    public RequestInterceptorForStub(String stubUrl) {
+        try {
+            this.stubUri = new URI(stubUrl);
+        } catch (URISyntaxException e) {
+            this.stubUri = null;
+        }
+    }
+
+    public void process(final MitmJavaProxyHttpRequest request) {
+        request.getMethod().setURI(stubUri);
+        logger.info("Redirecting request:{} to stub service.", request.getMethod().getURI().getPath());
+    }
+
+}