ClassNotFoundException: org.owasp.shim.Java8Shim after update to 20240325.1

[veita]

After update to 20240325.1 there occur exceptions ClassNotFoundException: org.owasp.shim.Java8Shim.

I could not find documentation about which additional libraries have to be included on which Java platform such that things work properly. It seems that both java8-shim and java10-shim libraries are needed with Java 21, which seems odd.

Java version: OpenJDK Runtime Environment Temurin-21.0.2+13

[rombert]

You should add both libraries to your app, the right one will be selected at runtime based on the version of Java you're using.

[randomalgorithm01]

@rombert @mikesamuel

Can you kindly explain the use of this dependencies 8shim and 10shim. I originally thought the library has code that will compile in 11+ and this dependency act as adapter for older jdk. But from above it seems to be a problem in 21 jdk too.

I tried new html sanitizer version as a dependency in a large project without classnotfound exceptions (open jdk 11)

Can you kindly explain need of this jar and when to add as dependency

[randomalgorithm01]

@rombert a reply would be very helpful here.

[mebigfatguy]

Would be nice if these classes were loaded dynamically rather than statically. Why would i need to supply Java8-shim if i am not running on java8?

[jlczuk]

This issue has been open for some time now. I am hitting this as well. All I did was update my version to 2024-325.1.

It wasn't clear to me what the suggested solution was until I looked at the linked PR. If we are required to add new dependencies, it really should be pointed out in the release and in the README.

Apparently we should be adding these two dependencies, which I would prefer if the sanitizer JAR simply included the classes in itself.

I added the following to my gradle dependencies. Just one more thing to keep track of I suppose.

'com.googlecode.owasp-java-html-sanitizer:java8-shim:20240325.1',
'com.googlecode.owasp-java-html-sanitizer:java11-shim:20240325.1'

Also not that this release is a breaking change. All one needs to do is update one's build to the new release and the build will fail. Thank you for identifying in the release notes that Guava is no longer a dependency.

[theigl]

Requiring both shims on the classpath makes the library unusable with the Java module system because of split-packages. Compilation fails with the following error:

module XYZ reads package org.owasp.shim from both java10.shim and java8.shim

[aleruz-dt]

is there any news related to this issue? It applies also to the latest version, and as said by @theigl this is making the library unusable with the module system.

[jmanico]

cc some of the new leads @mrabhishek @aalmiray @kittylyst @erikcostlow @brianf

[aalmiray]

Understood. A viable modular option should be put in place.

Please bear with us, as part of the new set of maintainers are getting used to the codebase.

[aleruz-dt]

@aalmiray thanks for your effort.

[aleruz-dt]

Hi @aalmiray — I opened PR #379 which directly addresses the JPMS split-package error described in this thread.

The fix inlines both java8-shim and java10-shim into the main sanitizer JAR via the Maven Shade plugin, and marks them <optional>true</optional> so they no longer appear as transitive dependencies. The shaded JAR also carries an Automatic-Module-Name: owasp.java.html.sanitizer manifest entry so it is correctly placed on the module path by JPMS-aware build tools (Gradle, Maven).

Would love to get your review when you have a moment: #379

[jmanico]

Fixed on main by #379 from @aleruz-dt: the java8-shim and java10-shim classes are now bundled inside owasp-java-html-sanitizer.jar and the shim artifacts are no longer published separately, so there is no split package on the module path and nothing extra to put on the classpath. If you added an explicit dependency on either shim as a workaround, remove it when you upgrade. This ships in the next release after 20260313.1. Closing; please reopen if the new release does not fix your case.