GitLab

Problem: Partition secret configurations available via partition service can pose following security issue:

1. All Secrets are exposed by default to any service regardless if they need them or not.
2. Secrets are held in memory cache both at the partition service and the service client library.
3. Potential for logging secret values to the central logger are increased due to secrets being sent in Microservice HTTP Response Objects. a. Trace Logs are often used to dump http request and response objects between services for debugging purposes.

Solution: Provide a mechanism to distinguish secret and non-secret partition configuration and delegate responsibility of consuming secret using cloud native libraries at service level.

Current

public class PartitionInfo {

    @Builder.Default
    Map<String, Object> properties = new HashMap<>();
}

e.g.

{
    "properties": {
        "complianceRuleSet": "shared",
        "storageAccountKey": "test-storage-**secret**"
    }
}

Proposed

public class PartitionInfo {

    @Builder.Default
    Map<String, Property> properties = new HashMap<>();
}

public class Property {
    @Builder.Default
    private boolean sensitive = false;
    private Object value;
}

e.g.

{
    "properties": {
        "complianceRuleSet": {
            "sensitive": false,
            "value": "shared"
        },
        "storageAccountKey": {
            "sensitive": true,
            "value": "test-storage-**key**"
        }
    }
}