Refactoring (#1201)

* Some initial refactoring

* Make it one application

* Got it working

* Fix problem on Windows

* Move WebWolf

* Move first lesson

* Moved all lessons

* Fix pom.xml

* Fix tests

* Add option to initialize a lesson

This way we can create content for each user inside a lesson. The initialize method will be called when a new user is created or when a lesson reset happens

* Clean up pom.xml files

* Remove fetching labels based on language.

We only support English at the moment, all the lesson explanations are written in English which makes it very difficult to translate. If we only had labels it would make sense to support multiple languages

* Fix SonarLint issues

* And move it all to the main project

* Fix for documentation paths

* Fix pom warnings

* Remove PMD as it does not work

* Update release notes about refactoring

Update release notes about refactoring

Update release notes about refactoring

* Fix lesson template

* Update release notes

* Keep it in the same repo in Dockerhub

* Update documentation to show how the connection is obtained.

Resolves: #1180

* Rename all integration tests

* Remove command from Dockerfile

* Simplify GitHub actions

Currently, we use a separate actions for pull-requests and branch build.
This is now consolidated in one action.
The PR action triggers always, it now only trigger when the PR is
opened and not in draft.
Running all platforms on a branch build is a bit too much, it is better
 to only run all platforms when someone opens a PR.

* Remove duplicate entry from release notes

* Add explicit registry for base image

* Lesson scanner not working when fat jar

When running the fat jar we have to take into account we
are reading from the jar file and not the filesystem. In
this case you cannot use `getFile` for example.

* added info in README and fixed release docker

* changed base image and added ignore file

Co-authored-by: Zubcevic.com <rene@zubcevic.com>

src/main/java/org/owasp/webgoat/container/asciidoc/EnvironmentExposure.java

@@ -0,0 +1,25 @@
+package org.owasp.webgoat.container.asciidoc;
+
+import org.springframework.beans.BeansException;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationContextAware;
+import org.springframework.core.env.Environment;
+import org.springframework.stereotype.Component;
+
+/**
+ * Make environment available in the asciidoc code (which you cannot inject because it is handled by the framework)
+ */
+@Component
+public class EnvironmentExposure implements ApplicationContextAware {
+
+    private static ApplicationContext context;
+
+    public static Environment getEnv() {
+        return context.getEnvironment();
+    }
+
+    @Override
+    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
+        context = applicationContext;
+    }
+}

src/main/java/org/owasp/webgoat/container/asciidoc/OperatingSystemMacro.java

@@ -0,0 +1,25 @@
+package org.owasp.webgoat.container.asciidoc;
+
+import org.asciidoctor.ast.ContentNode;
+import org.asciidoctor.extension.InlineMacroProcessor;
+
+import java.util.Map;
+
+public class OperatingSystemMacro extends InlineMacroProcessor {
+
+    public OperatingSystemMacro(String macroName) {
+        super(macroName);
+    }
+
+    public OperatingSystemMacro(String macroName, Map<String, Object> config) {
+        super(macroName, config);
+    }
+
+    @Override
+    public Object process(ContentNode contentNode, String target, Map<String, Object> attributes) {
+        var osName = System.getProperty("os.name");
+
+        //see https://discuss.asciidoctor.org/How-to-create-inline-macro-producing-HTML-In-AsciidoctorJ-td8313.html for why quoted is used
+        return createPhraseNode(contentNode, "quoted", osName);
+    }
+}

src/main/java/org/owasp/webgoat/container/asciidoc/UsernameMacro.java

@@ -0,0 +1,31 @@
+package org.owasp.webgoat.container.asciidoc;
+
+import org.asciidoctor.ast.ContentNode;
+import org.asciidoctor.extension.InlineMacroProcessor;
+import org.owasp.webgoat.container.users.WebGoatUser;
+import org.springframework.security.core.context.SecurityContextHolder;
+
+import java.util.Map;
+
+public class UsernameMacro extends InlineMacroProcessor {
+
+    public UsernameMacro(String macroName) {
+        super(macroName);
+    }
+
+    public UsernameMacro(String macroName, Map<String, Object> config) {
+        super(macroName, config);
+    }
+
+    @Override
+    public Object process(ContentNode contentNode, String target, Map<String, Object> attributes) {
+        var auth = SecurityContextHolder.getContext().getAuthentication();
+        var username = "unknown";
+        if (auth.getPrincipal() instanceof WebGoatUser webGoatUser) {
+            username = webGoatUser.getUsername();
+        }
+
+        //see https://discuss.asciidoctor.org/How-to-create-inline-macro-producing-HTML-In-AsciidoctorJ-td8313.html for why quoted is used
+        return createPhraseNode(contentNode, "quoted", username);
+    }
+}

src/main/java/org/owasp/webgoat/container/asciidoc/WebGoatTmpDirMacro.java

@@ -0,0 +1,26 @@
+package org.owasp.webgoat.container.asciidoc;
+
+import org.asciidoctor.ast.ContentNode;
+import org.asciidoctor.extension.InlineMacroProcessor;
+
+import java.util.Map;
+
+public class WebGoatTmpDirMacro extends InlineMacroProcessor {
+
+    public WebGoatTmpDirMacro(String macroName) {
+        super(macroName);
+    }
+
+    public WebGoatTmpDirMacro(String macroName, Map<String, Object> config) {
+        super(macroName, config);
+    }
+
+    @Override
+	public Object process(ContentNode contentNode, String target, Map<String, Object> attributes) {
+        var env = EnvironmentExposure.getEnv().getProperty("webgoat.server.directory");
+
+        //see https://discuss.asciidoctor.org/How-to-create-inline-macro-producing-HTML-In-AsciidoctorJ-td8313.html for why quoted is used
+        return createPhraseNode(contentNode, "quoted", env);
+
+    }
+}

src/main/java/org/owasp/webgoat/container/asciidoc/WebGoatVersionMacro.java

@@ -0,0 +1,25 @@
+package org.owasp.webgoat.container.asciidoc;
+
+import org.asciidoctor.ast.ContentNode;
+import org.asciidoctor.extension.InlineMacroProcessor;
+
+import java.util.Map;
+
+public class WebGoatVersionMacro extends InlineMacroProcessor {
+
+    public WebGoatVersionMacro(String macroName) {
+        super(macroName);
+    }
+
+    public WebGoatVersionMacro(String macroName, Map<String, Object> config) {
+        super(macroName, config);
+    }
+
+    @Override
+	public Object process(ContentNode contentNode, String target, Map<String, Object> attributes) {
+        var webgoatVersion = EnvironmentExposure.getEnv().getProperty("webgoat.build.version");
+
+        //see https://discuss.asciidoctor.org/How-to-create-inline-macro-producing-HTML-In-AsciidoctorJ-td8313.html for why quoted is used
+        return createPhraseNode(contentNode, "quoted", webgoatVersion);
+    }
+}

src/main/java/org/owasp/webgoat/container/asciidoc/WebWolfMacro.java

@@ -0,0 +1,73 @@
+package org.owasp.webgoat.container.asciidoc;
+
+import org.asciidoctor.ast.ContentNode;
+import org.asciidoctor.extension.InlineMacroProcessor;
+import org.springframework.web.context.request.RequestContextHolder;
+import org.springframework.web.context.request.ServletRequestAttributes;
+
+import javax.servlet.http.HttpServletRequest;
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Usage in asciidoc:
+ * <p>
+ * webWolfLink:here[] will display a href with here as text
+ */
+public class WebWolfMacro extends InlineMacroProcessor {
+
+    public WebWolfMacro(String macroName) {
+        super(macroName);
+    }
+
+    public WebWolfMacro(String macroName, Map<String, Object> config) {
+        super(macroName, config);
+    }
+
+    @Override
+    public Object process(ContentNode contentNode, String linkText, Map<String, Object> attributes) {
+        var env = EnvironmentExposure.getEnv();
+        var hostname = determineHost(env.getProperty("webwolf.port"));
+        var target = (String) attributes.getOrDefault("target", "home");
+        var href = hostname + "/" + target;
+
+        //are we using noLink in webWolfLink:landing[noLink]? Then display link with full href
+        if (displayCompleteLinkNoFormatting(attributes)) {
+            linkText = href;
+        }
+
+        var options = new HashMap<String, Object>();
+        options.put("type", ":link");
+        options.put("target", href);
+        attributes.put("window", "_blank");
+        return createPhraseNode(contentNode, "anchor", linkText, attributes, options).convert();
+    }
+
+    private boolean displayCompleteLinkNoFormatting(Map<String, Object> attributes) {
+        return attributes.values().stream().anyMatch(a -> a.equals("noLink"));
+    }
+
+    /**
+     * Determine the host from the hostname and ports that were used.
+     * The purpose is to make it possible to use the application behind a reverse proxy. For instance in the docker
+     * compose/stack version with webgoat webwolf and nginx proxy.
+     * You do not have to use the indicated hostname, but if you do, you should define two hosts aliases
+     * 127.0.0.1 www.webgoat.local www.webwolf.local
+     */
+    private String determineHost(String port) {
+        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest();
+        String host = request.getHeader("Host");
+        int semicolonIndex = host.indexOf(":");
+        if (semicolonIndex == -1 || host.endsWith(":80")) {
+            host = host.replace(":80", "").replace("www.webgoat.local", "www.webwolf.local");
+        } else {
+            host = host.substring(0, semicolonIndex);
+            host = host.concat(":").concat(port);
+        }
+        return "http://" + host + (includeWebWolfContext() ? "/WebWolf" : "");
+    }
+
+    protected boolean includeWebWolfContext() {
+        return true;
+    }
+}

src/main/java/org/owasp/webgoat/container/asciidoc/WebWolfRootMacro.java

@@ -0,0 +1,25 @@
+package org.owasp.webgoat.container.asciidoc;
+
+import java.util.Map;
+
+/**
+ * Usage in asciidoc:
+ * <p>
+ * webWolfLink:here[] will display a href with here as text
+ * webWolfLink:landing[noLink] will display the complete url, for example: http://WW_HOST:WW_PORT/landing
+ */
+public class WebWolfRootMacro extends WebWolfMacro {
+
+    public WebWolfRootMacro(String macroName) {
+        super(macroName);
+    }
+
+    public WebWolfRootMacro(String macroName, Map<String, Object> config) {
+        super(macroName, config);
+    }
+
+    @Override
+    protected boolean includeWebWolfContext() {
+        return false;
+    }
+}