Skip to main content

Restrict deserialized classes for JMS ObjectMessage

org.openrewrite.java.security.marshalling.FixInsecureJmsDeserialization

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 two factory instantiation shapes: a local variable declaration (ActiveMQConnectionFactory f = new ActiveMQConnectionFactory(...)) and a direct return (return new ActiveMQConnectionFactory(...)), the latter refactored into a declare-then-return. Skips factories that already configure a trusted-packages / allowlist call.

Tags​

Recipe source​

This recipe is only available to users of Moderne.

This recipe is available under the Moderne Proprietary License.

Options​

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

Used by​

This recipe is used as part of the following composite recipes:

Example​

Parameters​
ParameterValue
allowedPackagesnull
Unchanged​
import javax.jms.*;
class Listener implements MessageListener {
    public void onMessage(Message message) {
        try {
            Object payload = ((ObjectMessage) message).getObject();
        } catch (JMSException ignored) {}
    }
}
Before​
import org.apache.activemq.ActiveMQConnectionFactory;
import javax.jms.ConnectionFactory;

class JmsConfig {
    ConnectionFactory connectionFactory() {
        ActiveMQConnectionFactory factory = new ActiveMQConnectionFactory("tcp://broker:61616");
        return factory;
    }
}
After​
import org.apache.activemq.ActiveMQConnectionFactory;
import javax.jms.ConnectionFactory;

import java.util.Arrays;

class JmsConfig {
    ConnectionFactory connectionFactory() {
        ActiveMQConnectionFactory factory = new ActiveMQConnectionFactory("tcp://broker:61616");
        factory.setTrustedPackages(Arrays.asList("java.util", "java.lang"));
        return factory;
    }
}

Usage​

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe FixInsecureJmsDeserialization

If the recipe is not available locally, then you can install it using:

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

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.