ca.uhn.hapi.fhir.docs.AuthorizationInterceptors Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * HAPI FHIR - Docs
 * %%
 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package ca.uhn.hapi.fhir.docs;

import ca.uhn.fhir.context.FhirContext;
import ca.uhn.fhir.context.support.IValidationSupport;
import ca.uhn.fhir.i18n.Msg;
import ca.uhn.fhir.interceptor.api.HookParams;
import ca.uhn.fhir.interceptor.api.IInterceptorBroadcaster;
import ca.uhn.fhir.interceptor.api.Pointcut;
import ca.uhn.fhir.rest.annotation.ConditionalUrlParam;
import ca.uhn.fhir.rest.annotation.IdParam;
import ca.uhn.fhir.rest.annotation.ResourceParam;
import ca.uhn.fhir.rest.annotation.Update;
import ca.uhn.fhir.rest.api.MethodOutcome;
import ca.uhn.fhir.rest.api.server.RequestDetails;
import ca.uhn.fhir.rest.api.server.storage.TransactionDetails;
import ca.uhn.fhir.rest.server.IResourceProvider;
import ca.uhn.fhir.rest.server.RestfulServer;
import ca.uhn.fhir.rest.server.exceptions.AuthenticationException;
import ca.uhn.fhir.rest.server.interceptor.auth.AdditionalCompartmentSearchParameters;
import ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor;
import ca.uhn.fhir.rest.server.interceptor.auth.AuthorizedList;
import ca.uhn.fhir.rest.server.interceptor.auth.IAuthRule;
import ca.uhn.fhir.rest.server.interceptor.auth.PolicyEnum;
import ca.uhn.fhir.rest.server.interceptor.auth.RuleBuilder;
import ca.uhn.fhir.rest.server.interceptor.auth.SearchNarrowingConsentService;
import ca.uhn.fhir.rest.server.interceptor.auth.SearchNarrowingInterceptor;
import ca.uhn.fhir.rest.server.interceptor.consent.ConsentInterceptor;
import ca.uhn.fhir.rest.server.interceptor.consent.RuleFilteringConsentService;
import ca.uhn.fhir.rest.server.servlet.ServletRequestDetails;
import com.google.common.collect.Lists;
import org.hl7.fhir.dstu3.model.IdType;
import org.hl7.fhir.instance.model.api.IBaseResource;
import org.hl7.fhir.r4.model.Patient;

import java.util.List;

import static org.apache.commons.lang3.StringUtils.isNotBlank;

/**
 * Examples integrated into our documentation.
 */
@SuppressWarnings({"unused", "WriteOnlyObject", "UnnecessaryLocalVariable"})
public class AuthorizationInterceptors {

	public static class PatientResourceProvider implements IResourceProvider {

		@Override
		public Class getResourceType() {
			return Patient.class;
		}

		public MethodOutcome create(@ResourceParam Patient thePatient, RequestDetails theRequestDetails) {

			return new MethodOutcome(); // populate this
		}
	}

	@SuppressWarnings({"ConstantConditions", "InnerClassMayBeStatic"})
	// START SNIPPET: patientAndAdmin
	public class PatientAndAdminAuthorizationInterceptor extends AuthorizationInterceptor {

		@Override
		public List buildRuleList(RequestDetails theRequestDetails) {

			// Process authorization header - The following is a fake
			// implementation. Obviously we'd want something more real
			// for a production scenario.
			//
			// In this basic example we have two hardcoded bearer tokens,
			// one which is for a user that has access to one patient, and
			// another that has full access.
			IdType userIdPatientId = null;
			boolean userIsAdmin = false;
			String authHeader = theRequestDetails.getHeader("Authorization");
			if ("Bearer dfw98h38r".equals(authHeader)) {
				// This user has access only to Patient/1 resources
				userIdPatientId = new IdType("Patient", 1L);
			} else if ("Bearer 39ff939jgg".equals(authHeader)) {
				// This user has access to everything
				userIsAdmin = true;
			} else {
				// Throw an HTTP 401
				throw new AuthenticationException(Msg.code(644) + "Missing or invalid Authorization header value");
			}

			// If the user is a specific patient, we create the following rule chain:
			// Allow the user to read anything in their own patient compartment
			// Allow the user to write anything in their own patient compartment
			// If a client request doesn't pass either of the above, deny it
			if (userIdPatientId != null) {
				return new RuleBuilder()
						.allow()
						.read()
						.allResources()
						.inCompartment("Patient", userIdPatientId)
						.andThen()
						.allow()
						.write()
						.allResources()
						.inCompartment("Patient", userIdPatientId)
						.andThen()
						.denyAll()
						.build();
			}

			// If the user is an admin, allow everything
			if (userIsAdmin) {
				return new RuleBuilder().allowAll().build();
			}

			// By default, deny everything. This should never get hit, but it's
			// good to be defensive
			return new RuleBuilder().denyAll().build();
		}
	}
	// END SNIPPET: patientAndAdmin

	public void ruleFiltering() {
		RestfulServer restfulServer = new RestfulServer();
		AuthorizationInterceptor theAuthorizationInterceptor = new AuthorizationInterceptor();

		// START SNIPPET: ruleFiltering
		ConsentInterceptor consentInterceptor = new ConsentInterceptor();
		consentInterceptor.registerConsentService(new RuleFilteringConsentService(theAuthorizationInterceptor));
		restfulServer.registerInterceptor(consentInterceptor);

		// END SNIPPET: ruleFiltering
	}

	// START SNIPPET: conditionalUpdate
	@Update()
	public MethodOutcome update(
			@IdParam IdType theId,
			@ResourceParam Patient theResource,
			@ConditionalUrlParam String theConditionalUrl,
			ServletRequestDetails theRequestDetails,
			IInterceptorBroadcaster theInterceptorBroadcaster) {

		// If we're processing a conditional URL...
		if (isNotBlank(theConditionalUrl)) {

			// Pretend we've done the conditional processing. Now let's
			// notify the interceptors that an update has been performed
			// and supply the actual ID that's being updated
			IdType actual = new IdType("Patient", "1123");
		}

		// In a real server, perhaps we would process the conditional
		// request differently and follow a separate path. Either way,
		// let's pretend there is some storage code here.
		theResource.setId(theId.withVersion("2"));

		// One TransactionDetails object should be created for each FHIR operation. Interceptors
		// may use it for getting/setting details about the running transaction.
		TransactionDetails transactionDetails = new TransactionDetails();

		// Notify the interceptor framework when we're about to perform an update. This is
		// useful as the authorization interceptor will pick this event up and use it
		// to factor into a decision about whether the operation should be allowed to proceed.
		IBaseResource previousContents = theResource;
		IBaseResource newContents = theResource;
		HookParams params = new HookParams()
				.add(IBaseResource.class, previousContents)
				.add(IBaseResource.class, newContents)
				.add(RequestDetails.class, theRequestDetails)
				.add(ServletRequestDetails.class, theRequestDetails)
				.add(TransactionDetails.class, transactionDetails);
		theInterceptorBroadcaster.callHooks(Pointcut.STORAGE_PRESTORAGE_RESOURCE_UPDATED, params);

		MethodOutcome retVal = new MethodOutcome();
		retVal.setCreated(true);
		retVal.setResource(theResource);
		return retVal;
	}
	// END SNIPPET: conditionalUpdate

	public void authorizeTenantAction() {
		// START SNIPPET: authorizeTenantAction
		new AuthorizationInterceptor(PolicyEnum.DENY) {
			@Override
			public List buildRuleList(RequestDetails theRequestDetails) {
				return new RuleBuilder()
						.allow()
						.read()
						.resourcesOfType(Patient.class)
						.withAnyId()
						.forTenantIds("TENANTA")
						.andThen()
						.build();
			}
		};
		// END SNIPPET: authorizeTenantAction

		// START SNIPPET: patchAll
		new AuthorizationInterceptor(PolicyEnum.DENY) {
			@Override
			public List buildRuleList(RequestDetails theRequestDetails) {
				return new RuleBuilder()
						// Authorize patch requests
						.allow()
						.patch()
						.allRequests()
						.andThen()
						// Authorize actual writes that patch may perform
						.allow()
						.write()
						.allResources()
						.inCompartment("Patient", new IdType("Patient/123"))
						.andThen()
						.build();
			}
		};
		// END SNIPPET: patchAll

		// START SNIPPET: bulkExport
		new AuthorizationInterceptor(PolicyEnum.DENY) {
			@Override
			public List buildRuleList(RequestDetails theRequestDetails) {
				return new RuleBuilder()
						.allow()
						.bulkExport()
						.systemExport()
						.withResourceTypes(Lists.newArrayList("Patient", "Encounter", "Observation"))
						.build();
			}
		};
		// END SNIPPET: bulkExport

		// START SNIPPET: advancedCompartment
		new AuthorizationInterceptor(PolicyEnum.DENY) {
			@Override
			public List buildRuleList(RequestDetails theRequestDetails) {
				AdditionalCompartmentSearchParameters additionalSearchParams =
						new AdditionalCompartmentSearchParameters();
				additionalSearchParams.addSearchParameters("device:patient", "device:subject");
				return new RuleBuilder()
						.allow()
						.read()
						.allResources()
						.inCompartmentWithAdditionalSearchParams(
								"Patient", new IdType("Patient/123"), additionalSearchParams)
						.build();
			}
		};
		// END SNIPPET: advancedCompartment
	}

	@SuppressWarnings("InnerClassMayBeStatic")
	// START SNIPPET: narrowing
	public class MyPatientSearchNarrowingInterceptor extends SearchNarrowingInterceptor {

		/**
		 * This method must be overridden to provide the list of compartments
		 * and/or resources that the current user should have access to
		 */
		@Override
		protected AuthorizedList buildAuthorizedList(RequestDetails theRequestDetails) {
			// Process authorization header - The following is a fake
			// implementation. Obviously we'd want something more real
			// for a production scenario.
			//
			// In this basic example we have two hardcoded bearer tokens,
			// one which is for a user that has access to one patient, and
			// another that has full access.
			String authHeader = theRequestDetails.getHeader("Authorization");
			if ("Bearer dfw98h38r".equals(authHeader)) {

				// This user will have access to two compartments
				return new AuthorizedList().addCompartment("Patient/123").addCompartment("Patient/456");

			} else if ("Bearer 39ff939jgg".equals(authHeader)) {

				// This user has access to everything
				return new AuthorizedList();

			} else {

				throw new AuthenticationException("Unknown bearer token");
			}
		}
	}
	// END SNIPPET: narrowing

	public void narrowingConditional() {
		// START SNIPPET: narrowingConditional
		SearchNarrowingInterceptor interceptor = new SearchNarrowingInterceptor();
		interceptor.setNarrowConditionalUrls(true);
		// END SNIPPET: narrowingConditional
	}

	@SuppressWarnings("SpellCheckingInspection")
	public void rsNarrowing() {
		RestfulServer restfulServer = new RestfulServer();

		// START SNIPPET: rsnarrowing
		SearchNarrowingInterceptor narrowingInterceptor = new SearchNarrowingInterceptor() {
			@Override
			protected AuthorizedList buildAuthorizedList(RequestDetails theRequestDetails) {
				// Your rules go here
				return new AuthorizedList()
						.addCodeInValueSet(
								"Observation", "code", "http://hl7.org/fhir/ValueSet/observation-vitalsignresult");
			}
		};
		restfulServer.registerInterceptor(narrowingInterceptor);

		// Create a consent service for search narrowing
		IValidationSupport validationSupport = null; // This needs to be populated
		FhirContext searchParamRegistry = null; // This needs to be populated
		SearchNarrowingConsentService consentService =
				new SearchNarrowingConsentService(validationSupport, searchParamRegistry);

		// Create a ConsentIntereptor to apply the ConsentService and register it with the server
		ConsentInterceptor consentInterceptor = new ConsentInterceptor();
		consentInterceptor.registerConsentService(consentService);
		restfulServer.registerInterceptor(consentInterceptor);

		// END SNIPPET: rsnarrowing
	}

	@SuppressWarnings("InnerClassMayBeStatic")
	// START SNIPPET: narrowingByCode
	public class MyCodeSearchNarrowingInterceptor extends SearchNarrowingInterceptor {

		/**
		 * This method must be overridden to provide the list of compartments
		 * and/or resources that the current user should have access to
		 */
		@Override
		protected AuthorizedList buildAuthorizedList(RequestDetails theRequestDetails) {
			// Process authorization header - The following is a fake
			// implementation. Obviously we'd want something more real
			// for a production scenario.
			String authHeader = theRequestDetails.getHeader("Authorization");
			if ("Bearer dfw98h38r".equals(authHeader)) {

				return new AuthorizedList()
						// When searching for Observations, narrow the search to only include Observations
						// with a code indicating that it is a Vital Signs Observation
						.addCodeInValueSet(
								"Observation", "code", "http://hl7.org/fhir/ValueSet/observation-vitalsignresult")
						// When searching for Encounters, narrow the search to exclude Encounters where
						// the Encounter class is in a ValueSet containing forbidden class codes
						.addCodeNotInValueSet("Encounter", "class", "http://my-forbidden-encounter-classes");

			} else {

				throw new AuthenticationException("Unknown bearer token");
			}
		}
	}
	// END SNIPPET: narrowingByCode

}