← All recipes
Moderne licensed

Restrict deserialized classes for JMS ObjectMessage

Recipe IDorg.openrewrite.java.security.marshalling.FixInsecureJmsDeserializationArtifactorg.openrewrite.recipe:rewrite-java-security

Patches ActiveMQConnectionFactory instantiations to install a deserialization allowlist when the same compilation run contains a javax.jms.ObjectMessage#getObject (or jakarta.jms.ObjectMessage#getObject) call inside a MessageListener#onMessage override. Targets ActiveMQ Classic (org.apache.activemq.ActiveMQConnectionFactory.setTrustedPackages) and ActiveMQ Artemis (org.apache.activemq.artemis.jms.client.ActiveMQConnectionFactory.setDeserializationAllowList). IBM MQ (com.ibm.mq.jms.MQConnectionFactory) is not yet supported. The recipe handles four factory instantiation shapes: a local variable declaration (ActiveMQConnectionFactory f = new ActiveMQConnectionFactory(...)), a direct return (return new ActiveMQConnectionFactory(...)) refactored into a declare-then-return, an assignment to an existing variable or field (this.factory = new ActiveMQConnectionFactory(...)), and a field initializer, guarded from an initializer block appended after the field. Skips factories that already configure a trusted-packages / allowlist call.

Single recipesecurityCWE-502Proprietary

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.java.security.marshalling.FixInsecureJmsDeserialization")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-java-security:3.41.0")
}

Then run

./gradlew rewriteRun

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.security.marshalling.FixInsecureJmsDeserialization

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-java-security:RELEASE

Options

NameTypeDescription
allowedPackagesStringComma-separated list of package prefixes whose classes are safe to deserialize. Defaults to a minimal safe baseline (java.util, java.lang) when unspecified.
e.g. com.acme.dto,java.util,java.lang

Data tables

Structured output this recipe can produce.

  • Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
  • Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
  • Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
  • Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats