eclipse-arrowhead / core-java-spring

Eclipse Public License 2.0
26 stars 51 forks source link

fix: missing serialVersionUID for all serializable classes #444

Closed rng70-or closed 10 months ago

rng70-or commented 10 months ago
Motivation:

In Project: there exists some serializable classes but they do not contain any serialVersionUID field. The compiler generates one by default in such scenarios, but the generated id is dependent on compiler implementation and may cause unwanted problems during deserialization.

The Role of serialVersionUID:

The primary role of serialVersionUID is to provide version control during deserialization. When we deserialize an object, the JVM checks whether the serialVersionUID of the serialized data matches the serialVersionUID of the class in the current classpath. If they match, the deserialization proceeds without issues. However, if they do not match, program can encounter InvalidClassException.

As, serialVersionUID servers the purpose of version control of class during serialization-deserialization, without a serialVersionUID, we risk breaking backward compatibility when changes are made to classes, which can lead to unexpected issues and errors during deserialization.

So, any change(addition or removal of any field) in any classes in the future(if it is needed to be changed) will cause issue with all previous instances if no serialVersionUID is provided.

Sponsorship and Support:

This work is done by the security researchers from OpenRefactory and is supported by the Open Source Security Foundation (OpenSSF): Project Alpha-Omega. Alpha-Omega is a project partnering with open source software project maintainers to systematically find new, as-yet-undiscovered vulnerabilities in open source code - and get them fixed – to improve global software supply chain security.

The bug is found by running the Intelligent Code Repair (iCR) tool by OpenRefactory and then manually triaging the results.