Skip to content

Commit

Permalink
Merge pull request #789 from OWASP/update
Browse files Browse the repository at this point in the history 
Code tidying, challenge difficulty refactor, removal of unnecessary code
  • Loading branch information
@commjoen
commjoen committed Apr 28, 2023
2 parents 76d7630 + a6c1a56 commit ec24b00
Show file tree
Hide file tree
Showing 49 changed files with 417 additions and 327 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/dast-zap-test.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
java-version: "19"
distribution: "temurin"
- name: Clean install
run: ./mvnw clean install -DskipTests -Ddependency-check.skip -Dcyclonedx.skip=true
run: ./mvnw --no-transfer-progress clean install -DskipTests -Ddependency-check.skip -Dcyclonedx.skip=true
- name: Start wrongsecrets
run: nohup ./mvnw spring-boot:run -Dspring-boot.run.profiles=without-vault &
- name: ZAP Scan
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/java_swagger_doc.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ jobs:
java-version: "19"
distribution: "temurin"
- name: Clean install
run: ./mvnw clean install -DskipTests -Ddependency-check.skip -Dcyclonedx.skip=true
run: ./mvnw --no-transfer-progress clean install -DskipTests -Ddependency-check.skip -Dcyclonedx.skip=true
- name: Compile javadoc
run: ./mvnw compile javadoc:javadoc
run: ./mvnw --no-transfer-progress compile javadoc:javadoc
- name: Start wrongsecrets
run: nohup ./mvnw spring-boot:run -Dspring-boot.run.profiles=without-vault &
run: nohup ./mvnw --no-transfer-progress spring-boot:run -Dspring-boot.run.profiles=without-vault &
- name: Compile javadocs
run: ./mvnw compile javadoc:javadoc
run: ./mvnw --no-transfer-progress compile javadoc:javadoc
- name: Generate swaggerdoc
run: ./mvnw springdoc-openapi:generate
run: ./mvnw --no-transfer-progress springdoc-openapi:generate
- name: Upload swagger api doc
uses: actions/upload-artifact@v3
with:
Expand Down
178 changes: 96 additions & 82 deletions pom.xml
View file
Original file line number Diff line number Diff line change
@@ -1,44 +1,48 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>3.0.6</version>
<relativePath/> <!-- lookup parent from repository -->
<relativePath/>
<!-- lookup parent from repository -->
</parent>

<groupId>org.owasp</groupId>
<artifactId>wrongsecrets</artifactId>
<version>1.6.1-SNAPSHOT</version>

<name>OWASP WrongSecrets</name>
<description>Examples with how to not use secrets</description>
<url>https://owasp.org/www-project-wrongsecrets/</url>
<scm>
<url>https://github.com/OWASP/wrongsecrets</url>
</scm>
<issueManagement>
<system>GitHub Issue Tracking</system>
<url>https://github.com/OWASP/wrongsecrets/issues</url>
</issueManagement>
<organization>
<name>The Open Web Application Security Project (OWASP)</name>
<url>https://owasp.org/</url>
</organization>
<licenses>
<license>
<name>AGPLv3 License</name>
<url>https://opensource.org/license/agpl-v3/</url>
<distribution>repo</distribution>
</license>
</licenses>
<organization>
<name>The Open Web Application Security Project (OWASP)</name>
<url>https://owasp.org/</url>
</organization>

<scm>
<url>https://github.com/OWASP/wrongsecrets</url>
</scm>
<issueManagement>
<system>GitHub Issue Tracking</system>
<url>https://github.com/OWASP/wrongsecrets/issues</url>
</issueManagement>

<!-- <distributionManagement>-->
<!-- <snapshotRepository>-->
<!-- <id>ossrh</id>-->
<!-- <url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>-->
<!-- </snapshotRepository>-->
<!-- </distributionManagement>-->

<properties>
<java.version>19</java.version>
<maven.compiler.target>19</maven.compiler.target>
Expand All @@ -63,6 +67,31 @@
<dependency-check-maven.version>8.2.1</dependency-check-maven.version>
</properties>

<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring.cloud-version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>spring-cloud-gcp-dependencies</artifactId>
<version>${gcp.sdk.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>com.azure.spring</groupId>
<artifactId>spring-cloud-azure-dependencies</artifactId>
<version>${com.azure.spring.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>org.projectlombok</groupId>
Expand Down Expand Up @@ -227,58 +256,6 @@
<!-- </dependency>-->
</dependencies>

<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring.cloud-version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>spring-cloud-gcp-dependencies</artifactId>
<version>${gcp.sdk.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>com.azure.spring</groupId>
<artifactId>spring-cloud-azure-dependencies</artifactId>
<version>${com.azure.spring.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>

<!-- Required by exec-maven-plugin to run NPM *.CMD script on Windows -->
<profiles>
<profile>
<id>Windows</id>
<activation>
<os>
<family>Windows</family>
</os>
</activation>
<properties>
<script.extension>.cmd</script.extension>
</properties>
</profile>
<profile>
<id>unix</id>
<activation>
<os>
<family>unix</family>
</os>
</activation>
<properties>
<script.extension/>
</properties>
</profile>
</profiles>

<build>
<pluginManagement>
<plugins>
Expand Down Expand Up @@ -353,8 +330,7 @@
<suppressionsFileExpression>checkstyle.suppressions.file</suppressionsFileExpression>
</configuration>
</plugin>
<plugin>
<!-- https://github.com/asciidoctor/asciidoctor-maven-examples/blob/main/asciidoc-to-html-example/pom.xml -->
<plugin><!-- https://github.com/asciidoctor/asciidoctor-maven-examples/blob/main/asciidoc-to-html-example/pom.xml -->
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>${asciidoctor.maven.plugin.version}</version>
Expand Down Expand Up @@ -405,18 +381,18 @@
<outputName>bom</outputName>
</configuration>
</plugin>
<plugin>
<groupId>org.owasp</groupId>
<artifactId>dependency-check-maven</artifactId>
<version>${dependency-check-maven.version}</version>
<executions>
<execution>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.owasp</groupId>
<artifactId>dependency-check-maven</artifactId>
<version>${dependency-check-maven.version}</version>
<executions>
<execution>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
<!-- todo: #178 add the missing plugins and profiles from https://central.sonatype.org/publish/publish-maven/-->
<plugin>
<groupId>com.github.eirslett</groupId>
Expand Down Expand Up @@ -482,8 +458,46 @@
<target>19</target>
</configuration>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>tidy-maven-plugin</artifactId>
<version>1.2.0</version>
<executions>
<execution>
<id>validate</id>
<phase>validate</phase>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>


<!-- Required by exec-maven-plugin to run NPM *.CMD script on Windows -->
<profiles>
<profile>
<id>Windows</id>
<activation>
<os>
<family>Windows</family>
</os>
</activation>
<properties>
<script.extension>.cmd</script.extension>
</properties>
</profile>
<profile>
<id>unix</id>
<activation>
<os>
<family>unix</family>
</os>
</activation>
<properties>
<script.extension/>
</properties>
</profile>
</profiles>
</project>
4 changes: 1 addition & 3 deletions src/main/java/org/owasp/wrongsecrets/AboutController.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,9 @@
@Controller
public class AboutController {



@GetMapping("/about")
@Operation(description = "Endpoint to get dynamic data on about")
public String getStats(Model model) {
public String getStats() {
return "about";
}
}
8 changes: 0 additions & 8 deletions src/main/java/org/owasp/wrongsecrets/WrongSecretsApplication.java
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
package org.owasp.wrongsecrets;

import org.owasp.wrongsecrets.challenges.ChallengesController;
import org.owasp.wrongsecrets.challenges.kubernetes.Vaultpassword;
import org.owasp.wrongsecrets.oauth.TokenController;
import org.springdoc.core.utils.SpringDocUtils;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
Expand All @@ -24,9 +21,4 @@ public static void main(String[] args) {
public InMemoryScoreCard scoreCard() {
return new InMemoryScoreCard(28);
}

static {
SpringDocUtils.getConfig().addRestControllers(AboutController.class, ChallengesController.class, IndexController.class, StatsController.class, TokenController.class);
}

}
4 changes: 2 additions & 2 deletions src/main/java/org/owasp/wrongsecrets/challenges/Challenge.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public abstract class Challenge {
public abstract List<Environment> supportedRuntimeEnvironments();

/**
* returns the difficulty (1-5).
* returns the difficulty level.
* @return int with difficulty
*/
public abstract int difficulty();
Expand All @@ -53,7 +53,7 @@ public abstract class Challenge {
* boolean indicating a challenge needs to be run differently with a different explanation/steps when running on a shared platform.
* @return boolean with true if a different explanation is required when running on a shared platform
*/
public abstract boolean isLimittedWhenOnlineHosted();
public abstract boolean isLimitedWhenOnlineHosted();

/**
* boolean indicating if the challenge can be enabled when running in CTF mode.
Expand Down
Loading

0 comments on commit ec24b00

Please sign in to comment.