cyclonedx-core-java icon indicating copy to clipboard operation
cyclonedx-core-java copied to clipboard

BomJsonGenerator.toJsonString() unexpectedly replaces all new lines in Strings with spaces

Open benken-parasoft opened this issue 1 year ago • 0 comments

If I serialize a org.cyclonedx.model.Bom to JSON using BomJsonGenerator.toJsonString() then I unexpectedly lose newlines in various strings, like license and copyright text where new lines are especially important.

I tracked down the problem to org.cyclonedx.util.serializer.TrimStringSerializer. This serializer is not just trimming but is also replacing carriage return, line feed, and tab characters with a space. These should be preserved in the JSON. Jackson will correctly escape such characters, like encoding newlines as '\n'.

In contrast, BomXmlGenerator is fine. The XML version has newlines correctly preserved in the XML.

I am currently working around the issue as follows:

    private static void removeTrimStringSerializer(BomJsonGenerator jsonGenerator) {
        ObjectMapper mapper = ((AbstractBomJsonGenerator) jsonGenerator).getMapper();
        SerializerFactory newSerializerFactory = BeanSerializerFactory.instance;
        SerializationConfig serializationConfig = mapper.getSerializationConfig();
        JavaType javaType = serializationConfig.constructType(String.class);
        BeanDescription beanDesc = serializationConfig.introspect(javaType);
        SerializerFactoryConfig serializerFactoryConfig = ((BasicSerializerFactory) mapper.getSerializerFactory()).getFactoryConfig();
        for (Serializers serializers : serializerFactoryConfig.serializers()) {
            JsonSerializer<?> stringSerializer = serializers.findSerializer(serializationConfig, javaType, beanDesc);
            if (!(stringSerializer instanceof TrimStringSerializer)) {
                newSerializerFactory = newSerializerFactory.withAdditionalSerializers(serializers);
            }
        }
        mapper.setSerializerFactory(newSerializerFactory);
    }

benken-parasoft avatar Apr 12 '24 20:04 benken-parasoft