ca.uhn.fhir.rest.server.interceptor.auth

Class AuthorizationInterceptor

java.lang.Object

ca.uhn.fhir.rest.server.interceptor.InterceptorAdapter

ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor

All Implemented Interfaces:

IRuleApplier, IServerInterceptor, IServerOperationInterceptor

public class AuthorizationInterceptor
extends InterceptorAdapter
implements IServerOperationInterceptor, IRuleApplier

This class is a base class for interceptors which can be used to inspect requests and responses to determine whether the calling user has permission to perform the given action.

See the HAPI FHIR Documentation on Server Security for information on how to use this interceptor.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthorizationInterceptor.Verdict

Nested classes/interfaces inherited from interface ca.uhn.fhir.rest.server.interceptor.IServerInterceptor

IServerInterceptor.ActionRequestDetails

Constructor Summary

Constructors

Constructor and Description
AuthorizationInterceptor() Constructor
AuthorizationInterceptor(PolicyEnum theDefaultPolicy) Constructor

Method Summary

Modifier and Type	Method and Description
AuthorizationInterceptor.Verdict	applyRulesAndReturnDecision(RestOperationTypeEnum theOperation, RequestDetails theRequestDetails, IBaseResource theInputResource, IIdType theInputResourceId, IBaseResource theOutputResource)
List<IAuthRule>	buildRuleList(RequestDetails theRequestDetails) Subclasses should override this method to supply the set of rules to be applied to this individual request.
PolicyEnum	getDefaultPolicy() The default policy if no rules have been found to apply.
protected void	handleDeny(AuthorizationInterceptor.Verdict decision) Handle an access control verdict of PolicyEnum.DENY.
void	incomingRequestPreHandled(RestOperationTypeEnum theOperation, IServerInterceptor.ActionRequestDetails theProcessedRequest) Invoked before an incoming request is processed.
boolean	outgoingResponse(RequestDetails theRequestDetails, Bundle theBundle) This method is called after the server implementation method has been called, but before any attempt to stream the response back to the client
boolean	outgoingResponse(RequestDetails theRequestDetails, Bundle theResponseObject, javax.servlet.http.HttpServletRequest theServletRequest, javax.servlet.http.HttpServletResponse theServletResponse) This method is called after the server implementation method has been called, but before any attempt to stream the response back to the client
boolean	outgoingResponse(RequestDetails theRequestDetails, IBaseResource theResponseObject) This method is called after the server implementation method has been called, but before any attempt to stream the response back to the client
boolean	outgoingResponse(RequestDetails theRequestDetails, TagList theResponseObject) This method is called after the server implementation method has been called, but before any attempt to stream the response back to the client
boolean	outgoingResponse(RequestDetails theRequestDetails, TagList theResponseObject, javax.servlet.http.HttpServletRequest theServletRequest, javax.servlet.http.HttpServletResponse theServletResponse) This method is called after the server implementation method has been called, but before any attempt to stream the response back to the client
void	resourceCreated(RequestDetails theRequest, IBaseResource theResource) User code may call this method to indicate to an interceptor that a resource is being created
void	resourceDeleted(RequestDetails theRequest, IBaseResource theResource) User code may call this method to indicate to an interceptor that a resource is being deleted
void	resourceUpdated(RequestDetails theRequest, IBaseResource theResource) User code may call this method to indicate to an interceptor that a resource is being updated
void	setDefaultPolicy(PolicyEnum theDefaultPolicy) The default policy if no rules have been found to apply.

Methods inherited from class ca.uhn.fhir.rest.server.interceptor.InterceptorAdapter

handleException, incomingRequestPostProcessed, incomingRequestPreProcessed, outgoingResponse, outgoingResponse, outgoingResponse, preProcessOutgoingException, processingCompletedNormally

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.rest.server.interceptor.IServerInterceptor

handleException, incomingRequestPostProcessed, incomingRequestPreProcessed, outgoingResponse, outgoingResponse, outgoingResponse, preProcessOutgoingException, processingCompletedNormally

Constructor Detail

AuthorizationInterceptor

public AuthorizationInterceptor()

Constructor

AuthorizationInterceptor

public AuthorizationInterceptor(PolicyEnum theDefaultPolicy)

Constructor

Parameters:

theDefaultPolicy - The default policy if no rules apply (must not be null)

Method Detail

applyRulesAndReturnDecision

public AuthorizationInterceptor.Verdict applyRulesAndReturnDecision(RestOperationTypeEnum theOperation,
                                                                    RequestDetails theRequestDetails,
                                                                    IBaseResource theInputResource,
                                                                    IIdType theInputResourceId,
                                                                    IBaseResource theOutputResource)

Specified by:

applyRulesAndReturnDecision in interface IRuleApplier

buildRuleList

public List<IAuthRule> buildRuleList(RequestDetails theRequestDetails)

Subclasses should override this method to supply the set of rules to be applied to this individual request.

Typically this is done by examining theRequestDetails to find out who the current user is and then using a RuleBuilder to create an appropriate rule chain.

Parameters:

theRequestDetails - The individual request currently being applied

getDefaultPolicy

public PolicyEnum getDefaultPolicy()

The default policy if no rules have been found to apply. Default value for this setting is PolicyEnum.DENY

handleDeny

protected void handleDeny(AuthorizationInterceptor.Verdict decision)

Handle an access control verdict of PolicyEnum.DENY.

Subclasses may override to implement specific behaviour, but default is to throw ForbiddenOperationException (HTTP 403) with error message citing the rule name which trigered failure

incomingRequestPreHandled

public void incomingRequestPreHandled(RestOperationTypeEnum theOperation,
                                      IServerInterceptor.ActionRequestDetails theProcessedRequest)

Description copied from interface: IServerInterceptor

Invoked before an incoming request is processed. Note that this method is called after the server has begin preparing the response to the incoming client request. As such, it is not able to supply a response to the incoming request in the way that IServerInterceptor.incomingRequestPreHandled(RestOperationTypeEnum, ActionRequestDetails) and IServerInterceptor.incomingRequestPostProcessed(RequestDetails, HttpServletRequest, HttpServletResponse) are.

This method may however throw a subclass of BaseServerResponseException, and processing will be aborted with an appropriate error returned to the client.

Specified by:

incomingRequestPreHandled in interface IServerInterceptor

Overrides:

incomingRequestPreHandled in class InterceptorAdapter

Parameters:

theOperation - The type of operation that the FHIR server has determined that the client is trying to invoke

theProcessedRequest - An object which will be populated with the details which were extracted from the raw request by the server, e.g. the FHIR operation type and the parsed resource body (if any).

outgoingResponse

public boolean outgoingResponse(RequestDetails theRequestDetails,
                                Bundle theBundle)

Description copied from interface: IServerInterceptor

This method is called after the server implementation method has been called, but before any attempt to stream the response back to the client

Specified by:

outgoingResponse in interface IServerInterceptor

Overrides:

outgoingResponse in class InterceptorAdapter

theBundle - The actual object which is being streamed to the client as a response

Returns:

Return true if processing should continue normally. This is generally the right thing to do. If your interceptor is providing a response rather than letting HAPI handle the response normally, you must return false. In this case, no further processing will occur and no further interceptors will be called.

outgoingResponse

public boolean outgoingResponse(RequestDetails theRequestDetails,
                                Bundle theResponseObject,
                                javax.servlet.http.HttpServletRequest theServletRequest,
                                javax.servlet.http.HttpServletResponse theServletResponse)
                         throws AuthenticationException

Description copied from interface: IServerInterceptor

This method is called after the server implementation method has been called, but before any attempt to stream the response back to the client

Specified by:

outgoingResponse in interface IServerInterceptor

Overrides:

outgoingResponse in class InterceptorAdapter

Parameters:

theRequestDetails - A bean containing details about the request that is about to be processed, including

theResponseObject - The actual object which is being streamed to the client as a response

theServletRequest - The incoming request

theServletResponse - The response. Note that interceptors may choose to provide a response (i.e. by calling ServletResponse.getWriter()) but in that case it is important to return false to indicate that the server itself should not also provide a response.

Returns:

Return true if processing should continue normally. This is generally the right thing to do. If your interceptor is providing a response rather than letting HAPI handle the response normally, you must return false. In this case, no further processing will occur and no further interceptors will be called.

Throws:

AuthenticationException - This exception may be thrown to indicate that the interceptor has detected an unauthorized access attempt. If thrown, processing will stop and an HTTP 401 will be returned to the client.

outgoingResponse

public boolean outgoingResponse(RequestDetails theRequestDetails,
                                IBaseResource theResponseObject)

Description copied from interface: IServerInterceptor

This method is called after the server implementation method has been called, but before any attempt to stream the response back to the client

Specified by:

outgoingResponse in interface IServerInterceptor

Overrides:

outgoingResponse in class InterceptorAdapter

Parameters:

theRequestDetails - A bean containing details about the request that is about to be processed, including details such as the resource type and logical ID (if any) and other FHIR-specific aspects of the request which have been pulled out of the servlet request.

theResponseObject - The actual object which is being streamed to the client as a response

Returns:

Return true if processing should continue normally. This is generally the right thing to do. If your interceptor is providing a response rather than letting HAPI handle the response normally, you must return false. In this case, no further processing will occur and no further interceptors will be called.

outgoingResponse

public boolean outgoingResponse(RequestDetails theRequestDetails,
                                TagList theResponseObject)

Description copied from interface: IServerInterceptor

This method is called after the server implementation method has been called, but before any attempt to stream the response back to the client

Specified by:

outgoingResponse in interface IServerInterceptor

Overrides:

outgoingResponse in class InterceptorAdapter

Parameters:

theRequestDetails - A bean containing details about the request that is about to be processed, including details such as the resource type and logical ID (if any) and other FHIR-specific aspects of the request which have been pulled out of the servlet request.

theResponseObject - The actual object which is being streamed to the client as a response

Returns:

Return true if processing should continue normally. This is generally the right thing to do. If your interceptor is providing a response rather than letting HAPI handle the response normally, you must return false. In this case, no further processing will occur and no further interceptors will be called.

outgoingResponse

public boolean outgoingResponse(RequestDetails theRequestDetails,
                                TagList theResponseObject,
                                javax.servlet.http.HttpServletRequest theServletRequest,
                                javax.servlet.http.HttpServletResponse theServletResponse)
                         throws AuthenticationException

Description copied from interface: IServerInterceptor

This method is called after the server implementation method has been called, but before any attempt to stream the response back to the client

Specified by:

outgoingResponse in interface IServerInterceptor

Overrides:

outgoingResponse in class InterceptorAdapter

Parameters:

theRequestDetails - A bean containing details about the request that is about to be processed, including details such as the resource type and logical ID (if any) and other FHIR-specific aspects of the request which have been pulled out of the servlet request.

theResponseObject - The actual object which is being streamed to the client as a response

theServletRequest - The incoming request

theServletResponse - The response. Note that interceptors may choose to provide a response (i.e. by calling ServletResponse.getWriter()) but in that case it is important to return false to indicate that the server itself should not also provide a response.

Returns:

Return true if processing should continue normally. This is generally the right thing to do. If your interceptor is providing a response rather than letting HAPI handle the response normally, you must return false. In this case, no further processing will occur and no further interceptors will be called.

Throws:

AuthenticationException - This exception may be thrown to indicate that the interceptor has detected an unauthorized access attempt. If thrown, processing will stop and an HTTP 401 will be returned to the client.

resourceCreated

public void resourceCreated(RequestDetails theRequest,
                            IBaseResource theResource)

Description copied from interface: IServerOperationInterceptor

User code may call this method to indicate to an interceptor that a resource is being created

Specified by:

resourceCreated in interface IServerOperationInterceptor

resourceDeleted

public void resourceDeleted(RequestDetails theRequest,
                            IBaseResource theResource)

Description copied from interface: IServerOperationInterceptor

User code may call this method to indicate to an interceptor that a resource is being deleted

Specified by:

resourceDeleted in interface IServerOperationInterceptor

resourceUpdated

public void resourceUpdated(RequestDetails theRequest,
                            IBaseResource theResource)

Description copied from interface: IServerOperationInterceptor

User code may call this method to indicate to an interceptor that a resource is being updated

Specified by:

resourceUpdated in interface IServerOperationInterceptor

setDefaultPolicy

public void setDefaultPolicy(PolicyEnum theDefaultPolicy)

The default policy if no rules have been found to apply. Default value for this setting is PolicyEnum.DENY

Parameters:

theDefaultPolicy - The policy (must not be null)