README.md

Trojan Source Maven Plugin

This Maven plugin scans your source code for occurrences of trojan source as described on the following page: https://trojansource.codes

Trojan source attacks use unicode control characters to make evil source code look valid by reordering parts of it. For a deeper explanation have a look on the above-mentioned page or even read the paper of Nicholas Boucher and Ross Anderson, linked there.

The attack is also tracked by CVE-2021-42574.

Add plugin to your project

To activate the plugin and let it scan the source code before compiling it, just add the following section to your pom.xml file:

<build>
  <plugins>
    <plugin>
      <groupId>net.troja</groupId>
      <artifactId>trojan-source-maven-plugin</artifactId>
      <version>1.0</version>
      <configuration>
        <fileExtensions>
          <param>mustache</param>
        </fileExtensions>
        <directories>
          <param>templates</param>
        </directories>
        <scanTests>false</scanTests>
      </configuration>
      <executions>
        <execution>
          <goals>
            <goal>scan</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

Configration

fileExtensions

Extra file extensions can also be scanned, which is very useful for example the templates for code generation. For each entry add a param tag.

directories

Other directories than src/main/java and src/test/java can be included in the scans with this configuration setting. For each entry add a param tag.

scanTests

By defaults the src/test/java directory is also scanned, this can be switched off by specifying false in this tag.

References

• Regular expression to scan for bidis was taken from https://github.com/nickboucher/bidi-viewer
• Example bidi file was taken from https://github.com/nickboucher/trojan-source