Add Configuration for S2S to exclude fields from sharing [3]

[markusmann-vg]

Situation Description

With the current implementation Sormas 2 Sormas is also sending the External Token, the Internal ID, the general comment and the ExternalID. In corner cases this may result in either data protection issues or issues with the reporting system.

Feature Description

By default the sending (and receiving that values) of ExternalToken, ExternalID, generalComment, InternalID should be prevented.
With the config in sormas.properties (a config property for each mentioned field in all entities) you can decide which of the mentioned fields should be sent when using S2S and which won't.

Example with expected behavior:

• A case is sent from SORMAS A with ownership to SORMAS B
• SORMAS B accepts the case
• SORMAS B edits the case
• SORMAS B sends the case back to SORMAS A with ownership
• SORMAS A should have the details from the case AND the old externalID, ExternalToken, InternalToken AND the generalComment from the past
• SORMAS A does not get or see the externalID, ExternalToken, InternalToken NOR the generalComment from SORMAS B

Possible Alternatives

Additional Information

The fields should be excluded for all entities

[JonasCir]

Leaving the ongoing discussion aside, on a technical level we could use JSON patch to do this.

Json patch is an easy way to programmatically rewrite JSON objects.

So the query { "op": "remove", "path": "/c/b/c" } would drop the element if applied to a Json object.

We could simply provide a file with all the operations we want to see on outgoing entities. Find a java library here and the RFC

[vidi42]

4 new properties were introduced in sormas.properties

# Control which values are ignored when shared / overwritten trough S2S
# This are applied to all entities shared trough S2S
# Default: true
# Possible Values: true, false
#sormas2sormas.ignoreProperty.additionalDetails=true
#sormas2sormas.ignoreProperty.externalId=true
#sormas2sormas.ignoreProperty.externalToken=true
#sormas2sormas.ignoreProperty.internalToken=true

By default they are commented and are internally set to true, so the externalId, externalToken, internalToken and additionalDetails fields are not transmitted for any of the following entities: Case, Contact, Event, EventParticipant, Immunization and Person). By uncommenting them and setting them to false it's the only way to allow the system to transmit/receive them.

LabMessage and Sample do not contain this fields.

If a system has the properties set to true or missing, this means that the system doesn't send the fields value when sharing and also does not accept them if they come from systems which are sharing those values and it retains the already existing values.

[roxanamlendea]

Verified ticket on local environment using the latest version of Sormas 1.65.0-SNAPSHOT from the development branch and on the ignore_fields branch.

[vidi42]

More explanation about corner cases when configuring how external data is handled for different sormas instances can be found here #7014 (comment)