-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add MsAzure workaround for illegal value-subAttributes in PatchRequests
fixes #516
- Loading branch information
1 parent
03ed5eb
commit 67da341
Showing
10 changed files
with
629 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,6 +15,61 @@ | |
| public class MsAzurePatchFilterWorkaround | ||
| { | ||
|
|
||
| /** | ||
| * this method is a workaround for MsAzures expected behaviour that a value is added to a multivalued complex | ||
| * node if it is reference in a patch-filter but not added within the attribute itself | ||
| * | ||
| * <pre> | ||
| * { | ||
| * "schemas": [ | ||
| * "urn:ietf:params:scim:api:messages:2.0:PatchOp" | ||
| * ], | ||
| * "Operations": [ | ||
| * { | ||
| * "op": "add", | ||
| * "path": "emails[type eq \"work\"].value", | ||
| * "value": "[email protected]" | ||
| * } | ||
| * ] | ||
| * } | ||
| * </pre> | ||
| * | ||
| * must be rebuilt to: | ||
| * | ||
| * <pre> | ||
| * { | ||
| * "schemas": [ | ||
| * "urn:ietf:params:scim:api:messages:2.0:PatchOp" | ||
| * ], | ||
| * "Operations": [ | ||
| * { | ||
| * "op": "add", | ||
| * "path": "emails[type eq \"work\"].value", | ||
| * "value": [ | ||
| * { | ||
| * "value": "[email protected]" | ||
| * }, | ||
| * { | ||
| * "type": "work" | ||
| * } | ||
| * ] | ||
| * } | ||
| * ] | ||
| * } | ||
| * </pre> | ||
| * | ||
| * The complete rebuild is not done within this method. This method will simply create the last objectNode | ||
| * from the filter-expression: | ||
| * | ||
| * <pre> | ||
| * { | ||
| * "type": "work" | ||
| * } | ||
| * </pre> | ||
| * | ||
| * @param path the patch filter expression node. | ||
| * @return the | ||
| */ | ||
| public ScimObjectNode createAttributeFromPatchFilter(AttributePathRoot path) | ||
| { | ||
| SchemaAttribute schemaAttribute = path.getSchemaAttribute(); | ||
|
|
||
165 changes: 165 additions & 0 deletions
165
...captaingoldfish/scim/sdk/server/patch/msazure/MsAzurePatchValueSubAttributeRebuilder.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,165 @@ | ||
| package de.captaingoldfish.scim.sdk.server.patch.msazure; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import com.fasterxml.jackson.databind.node.ObjectNode; | ||
|
|
||
| import de.captaingoldfish.scim.sdk.common.constants.AttributeNames; | ||
| import de.captaingoldfish.scim.sdk.common.constants.enums.PatchOp; | ||
| import de.captaingoldfish.scim.sdk.common.utils.JsonHelper; | ||
| import lombok.RequiredArgsConstructor; | ||
| import lombok.extern.slf4j.Slf4j; | ||
|
|
||
|
|
||
| /** | ||
| * This class is a workaround handler in order to handle the broken patch requests of Microsoft Azure. Azure | ||
| * sends illegal patch requests that look like this: | ||
| * | ||
| * <pre> | ||
| * { | ||
| * "op": "Add", | ||
| * "path": "roles", | ||
| * "value": [ | ||
| * { | ||
| * "value": "{\"id\":\"827f0d2e-be15-4d8f-a8e3-f8697239c112\", | ||
| * \"value\":\"DocumentMgmt-Admin\", | ||
| * \"displayName\":\"DocumentMgmt Admin\"}" | ||
| * }, | ||
| * { | ||
| * "value": "{\"id\":\"8ae06bd4-35bb-4fcd-977e-14e074ad1192\", | ||
| * \"value\":\"Admin\", | ||
| * \"displayName\":\"Admin\"}" | ||
| * } | ||
| * ] | ||
| * } | ||
| * </pre> | ||
| * | ||
| * The problem in this request is the nested value-attribute that should not be there. Instead, the request | ||
| * should look like this: | ||
| * | ||
| * <pre> | ||
| * { | ||
| * "op": "Add", | ||
| * "path": "roles", | ||
| * "value": [ | ||
| * | ||
| * "{\"id\":\"827f0d2e-be15-4d8f-a8e3-f7697239c112\", | ||
| * \"value\":\"DocumentMgmt-BuyerAdmin\", | ||
| * \"displayName\":\"DocumentMgmt BuyerAdmin\"}", | ||
| * | ||
| * "{\"id\":\"8ae06bd4-35bb-4fcd-977e-12e074ad1192\", | ||
| * \"value\":\"Buyer-Admin\", | ||
| * \"displayName\":\"Buyer Admin\"}" | ||
| * ] | ||
| * } | ||
| * </pre> | ||
| * | ||
| * @author Pascal Knueppel | ||
| * @since 07.10.2023 | ||
| */ | ||
| @Slf4j | ||
| @RequiredArgsConstructor | ||
| public class MsAzurePatchValueSubAttributeRebuilder | ||
| { | ||
|
|
||
| /** | ||
| * the patch operation that is currently executed | ||
| */ | ||
| private final PatchOp patchOp; | ||
|
|
||
| /** | ||
| * the values of the patch operation. This attribute should actually be empty | ||
| */ | ||
| private final List<String> patchValues; | ||
|
|
||
| /** | ||
| * this method will try to resolve a PatchRequest as described in the class-documentation to its correct state | ||
| * | ||
| * @param patchValues the values sent in the PatchRequest | ||
| * @return the fixed values from the PatchRequest | ||
| */ | ||
| public List<String> fixValues() | ||
| { | ||
| // simply a check to return early from this method if a remove operation is used | ||
| if (PatchOp.REMOVE.equals(patchOp)) | ||
| { | ||
| log.trace("[MS Azure value-subAttribute workaround] only handling 'REPLACE' and 'ADD' requests"); | ||
| return patchValues; | ||
| } | ||
|
|
||
| if (patchValues == null || patchValues.isEmpty()) | ||
| { | ||
| log.trace("[MS Azure value-subAttribute workaround] not executed for values-list is empty"); | ||
| return patchValues; | ||
| } | ||
|
|
||
| List<String> fixedValues = new ArrayList<>(); | ||
| for ( String patchValue : patchValues ) | ||
| { | ||
| final JsonNode jsonNode; | ||
| try | ||
| { | ||
| jsonNode = JsonHelper.readJsonDocument(patchValue); | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| log.trace("[MS Azure value-subAttribute workaround] ignored value-node because it is no valid JSON " | ||
| + "object-node"); | ||
| fixedValues.add(patchValue); | ||
| continue; | ||
| } | ||
|
|
||
| boolean isObjectNode = jsonNode instanceof ObjectNode; | ||
| if (!isObjectNode) | ||
| { | ||
| log.trace("[MS Azure value-subAttribute workaround] ignored value because it is no JSON-ObjectNode"); | ||
| fixedValues.add(patchValue); | ||
| continue; | ||
| } | ||
|
|
||
| ObjectNode objectNode = (ObjectNode)jsonNode; | ||
| if (objectNode.size() != 1) | ||
| { | ||
| log.trace("[MS Azure value-subAttribute workaround] ignored JSON-ObjectNode because it has less or more " | ||
| + "than 1 sub-nodes"); | ||
| fixedValues.add(patchValue); | ||
| continue; | ||
| } | ||
|
|
||
| JsonNode innerValueNode = objectNode.get(AttributeNames.RFC7643.VALUE); | ||
| if (innerValueNode == null) | ||
| { | ||
| log.trace("[MS Azure value-subAttribute workaround] ignored JSON-ObjectNode because it has no value-node"); | ||
| fixedValues.add(patchValue); | ||
| continue; | ||
| } | ||
|
|
||
| final JsonNode innerObjectNode; | ||
| try | ||
| { | ||
| innerObjectNode = JsonHelper.readJsonDocument(innerValueNode.textValue()); | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| log.trace("[MS Azure value-subAttribute workaround] ignored inner value-node because it is no valid JSON-node"); | ||
| fixedValues.add(patchValue); | ||
| continue; | ||
| } | ||
|
|
||
| isObjectNode = innerObjectNode instanceof ObjectNode; | ||
| if (!isObjectNode) | ||
| { | ||
| log.trace("[MS Azure value-subAttribute workaround] ignored inner value-node because it is no not a JSON " | ||
| + "object-node"); | ||
| fixedValues.add(patchValue); | ||
| continue; | ||
| } | ||
|
|
||
| fixedValues.add(innerObjectNode.toString()); | ||
| } | ||
|
|
||
| return fixedValues; | ||
| } | ||
| } |
Oops, something went wrong.