[DNM] HAPI FHIR BALP Interceptor PoC for AuditEvents #398
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,54 @@ | ||
| package com.google.fhir.gateway.plugin.audit; | ||
|
|
||
| import ca.uhn.fhir.rest.client.api.IGenericClient; | ||
| import ca.uhn.fhir.storage.interceptor.balp.IBalpAuditContextServices; | ||
| import ca.uhn.fhir.storage.interceptor.balp.IBalpAuditEventSink; | ||
| import com.google.fhir.gateway.interfaces.AccessDecision; | ||
| import com.google.fhir.gateway.interfaces.RequestDetailsReader; | ||
| import com.google.fhir.gateway.interfaces.RequestMutation; | ||
| import java.io.IOException; | ||
| import org.apache.http.HttpResponse; | ||
| import org.jetbrains.annotations.Nullable; | ||
|
|
||
| public class BalpAccessDecision implements AccessDecision { | ||
|
|
||
| private final BalpAuditEventSink eventSink; | ||
| private final IBalpAuditContextServices contextServices; | ||
| private AccessDecision accessDecision; | ||
|
|
||
| public BalpAccessDecision(IGenericClient genericClient) { | ||
| this.eventSink = new BalpAuditEventSink(genericClient); | ||
| this.contextServices = new BalpAuditContextService(); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean canAccess() { | ||
| return accessDecision.canAccess(); | ||
| } | ||
|
|
||
| @Override | ||
| public @Nullable RequestMutation getRequestMutation(RequestDetailsReader requestDetailsReader) { | ||
| return accessDecision.getRequestMutation(requestDetailsReader); | ||
| } | ||
|
|
||
| @Override | ||
| public String postProcess(RequestDetailsReader request, HttpResponse response) | ||
| throws IOException { | ||
| return accessDecision.postProcess(request, response); | ||
| } | ||
|
|
||
| @Override | ||
| public @Nullable IBalpAuditEventSink getBalpAuditEventSink() { | ||
| return this.eventSink; | ||
| } | ||
|
|
||
| @Override | ||
| public @Nullable IBalpAuditContextServices getBalpAuditContextService() { | ||
| return this.contextServices; | ||
| } | ||
|
|
||
| public BalpAccessDecision withAccess(AccessDecision accessDecision) { | ||
| this.accessDecision = accessDecision; | ||
| return this; | ||
| } | ||
| } |
This file contains hidden or 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,86 @@ | ||
| package com.google.fhir.gateway.plugin.audit; | ||
|
|
||
| import ca.uhn.fhir.rest.api.server.RequestDetails; | ||
| import ca.uhn.fhir.rest.server.exceptions.AuthenticationException; | ||
| import ca.uhn.fhir.storage.interceptor.balp.IBalpAuditContextServices; | ||
| import com.auth0.jwt.JWT; | ||
| import com.auth0.jwt.exceptions.JWTDecodeException; | ||
| import com.auth0.jwt.interfaces.DecodedJWT; | ||
| import com.google.fhir.gateway.JwtUtil; | ||
| import jakarta.annotation.Nonnull; | ||
| import org.apache.http.HttpHeaders; | ||
| import org.hl7.fhir.instance.model.api.IBaseResource; | ||
| import org.hl7.fhir.instance.model.api.IIdType; | ||
| import org.hl7.fhir.r4.model.Identifier; | ||
| import org.hl7.fhir.r4.model.Reference; | ||
| import org.jetbrains.annotations.NotNull; | ||
|
|
||
| public class BalpAuditContextService implements IBalpAuditContextServices { | ||
|
|
||
| private static final String BEARER_PREFIX = "Bearer "; | ||
| private static final String CLAIM_NAME = "name"; | ||
| private static final String CLAIM_PREFERRED_NAME = "preferred_username"; | ||
| private static final String CLAIM_SUBJECT = "sub"; | ||
|
|
||
| @Override | ||
| public @NotNull Reference getAgentClientWho(RequestDetails requestDetails) { | ||
|
There was a problem hiding this comment. Should this be at There was a problem hiding this comment. Yeah, this is independent and can reside on the server. |
||
|
|
||
| return new Reference() | ||
| // .setReference("Device/fhir-info-gateway") | ||
| .setType("Device") | ||
| .setDisplay("FHIR Info Gateway") | ||
| .setIdentifier( | ||
| new Identifier() | ||
| .setSystem("http://fhir-info-gateway/devices") | ||
| .setValue("fhir-info-gateway-001")); | ||
| } | ||
|
|
||
| @Override | ||
| public @NotNull Reference getAgentUserWho(RequestDetails requestDetails) { | ||
|
|
||
| String username = getClaimIfExists(requestDetails, CLAIM_PREFERRED_NAME); | ||
| String name = getClaimIfExists(requestDetails, CLAIM_NAME); | ||
| String subject = getClaimIfExists(requestDetails, CLAIM_SUBJECT); | ||
|
|
||
| return new Reference() | ||
| // .setReference("Practitioner/" + subject) | ||
|
There was a problem hiding this comment. Shouldn't this be a valid reference to a resource in the FHIR server? There was a problem hiding this comment. FHIR allows creating a reference with an Identifier only if a Reference would break validation - https://hl7.org/fhir/references.html#Reference |
||
| .setType("Practitioner") | ||
| .setDisplay(name) | ||
| .setIdentifier( | ||
| new Identifier() | ||
| .setSystem("http://fhir-info-gateway/practitioners") | ||
| .setValue(username)); | ||
| } | ||
|
|
||
| @Override | ||
| public @NotNull String massageResourceIdForStorage( | ||
|
There was a problem hiding this comment. This also seems to be independent of plugins. |
||
| @Nonnull RequestDetails theRequestDetails, | ||
| @Nonnull IBaseResource theResource, | ||
| @Nonnull IIdType theResourceId) { | ||
|
|
||
| /** | ||
| * Server not configured to allow external references resulting to InvalidRequestException: HTTP | ||
| * 400 : HAPI-0507: Resource contains external reference to URL. Here we should use relative | ||
| * references instead e.g. Patient/123; | ||
| */ | ||
| // String serverBaseUrl = theRequestDetails.getFhirServerBase(); | ||
| return theRequestDetails.getId() != null | ||
| ? theRequestDetails.getId().getValue() | ||
| : ""; // For entity POST there will be no agent.who entry reference since not generated yet | ||
| } | ||
|
|
||
| public String getClaimIfExists(RequestDetails requestDetails, String claimName) { | ||
| String claim; | ||
| try { | ||
| String authHeader = requestDetails.getHeader(HttpHeaders.AUTHORIZATION); | ||
| String bearerToken = authHeader.substring(BEARER_PREFIX.length()); | ||
| DecodedJWT jwt; | ||
|
|
||
| jwt = JWT.decode(bearerToken); | ||
| claim = JwtUtil.getClaimOrDie(jwt, claimName); | ||
| } catch (JWTDecodeException | AuthenticationException e) { | ||
| claim = ""; | ||
| } | ||
| return claim; | ||
| } | ||
| } | ||
This file contains hidden or 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,19 @@ | ||
| package com.google.fhir.gateway.plugin.audit; | ||
|
|
||
| import ca.uhn.fhir.rest.client.api.IGenericClient; | ||
| import ca.uhn.fhir.storage.interceptor.balp.IBalpAuditEventSink; | ||
| import org.hl7.fhir.r4.model.AuditEvent; | ||
|
|
||
| public class BalpAuditEventSink implements IBalpAuditEventSink { | ||
|
|
||
| private final IGenericClient genericClient; | ||
|
|
||
| public BalpAuditEventSink(IGenericClient genericClient) { | ||
| this.genericClient = genericClient; | ||
| } | ||
|
|
||
| @Override | ||
| public void recordAuditEvent(AuditEvent auditEvent) { | ||
| genericClient.create().resource(auditEvent).prettyPrint().encodedJson().execute(); | ||
| } | ||
| } |
This file contains hidden or 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 hidden or 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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we file AuditEvents for access-denied?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah we can add the support.
We might want to make it configurable especially if we are using the same FHIR Data Store to persist both the health data and the forbidden access Audit Events because I assume the latter to be profuse e.g. any valid request with an expired token would be logged.
Thus the caveat would be the growing database size.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I agree that we need some configuration parameters to control what type of AuditEvents are created (and in future where they are stored).
But back to the actual AuditEvent for access-denied question, it seems to me that the BALP IG is fairly silent about this and just refers to AccessDenied in core FHIR. But it also has a profile for consent authorization decisions. Hence I am not sure creation of AuditEvent in the access-denied scenarios is necessary or not.