4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Provides generic security measurement functions for DXE module.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2009, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_AUTH_OPERATION_MASK (EFI_AUTH_OPERATION_VERIFY_IMAGE \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SECURITY_FILE_AUTHENTICATION_STATE_HANDLER SecurityHandler;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Reallocates more global memory to store the registered Handler list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Reallocate memory successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Reallocate memory for security info structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mMaxNumberOfSecurityHandler * sizeof (SECURITY_INFO),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (mMaxNumberOfSecurityHandler + SECURITY_HANDLER_TABLE_SIZE) * sizeof (SECURITY_INFO),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // No enough resource is allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Increase max handler number
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mMaxNumberOfSecurityHandler = mMaxNumberOfSecurityHandler + SECURITY_HANDLER_TABLE_SIZE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Check whether an operation is valid according to the requirement of current operation,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which must make sure that the measure image operation is the last one.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CurrentAuthOperation Current operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CheckAuthOperation Operation to be checked.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE Operation is valid for current operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE Operation is invalid for current operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Make sure new auth operation can be recognized.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT ((CheckAuthOperation & ~(EFI_AUTH_OPERATION_MASK | EFI_AUTH_OPERATION_IMAGE_REQUIRED)) == 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // When current operation includes measure image operation,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // only another measure image operation or none operation will be allowed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((CurrentAuthOperation & EFI_AUTH_OPERATION_MEASURE_IMAGE) == EFI_AUTH_OPERATION_MEASURE_IMAGE) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (((CheckAuthOperation & EFI_AUTH_OPERATION_MEASURE_IMAGE) == EFI_AUTH_OPERATION_MEASURE_IMAGE) ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ((CheckAuthOperation & EFI_AUTH_OPERATION_MASK) == EFI_AUTH_OPERATION_NONE)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // When current operation doesn't include measure image operation,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // any new operation will be allowed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Register security measurement handler with its operation type. The different
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handler with the same operation can all be registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SecurityHandler is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If no enough resources available to register new handler, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If AuthenticationOperation is not recongnized, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the previous register handler can't be executed before the later register handler, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] SecurityHandler Security measurement service handler to be registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] AuthenticationOperation Operation type is specified for the registered handler.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The handlers were registered successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN SECURITY_FILE_AUTHENTICATION_STATE_HANDLER SecurityHandler,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Make sure AuthenticationOperation is valid in the register order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (CheckAuthenticationOperation (mCurrentAuthOperation, AuthenticationOperation));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mCurrentAuthOperation = mCurrentAuthOperation | AuthenticationOperation;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check whether the handler lists is enough to store new handler.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (mNumberOfSecurityHandler == mMaxNumberOfSecurityHandler) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Allocate more resources for new handler.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Register new handler into the handler list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mSecurityTable[mNumberOfSecurityHandler].SecurityOperation = AuthenticationOperation;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mSecurityTable[mNumberOfSecurityHandler].SecurityHandler = SecurityHandler;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Execute registered handlers until one returns an error and that error is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If none of the handlers return an error, then EFI_SUCCESS is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Before exectue handler, get the image buffer by file device path if a handler
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync requires the image file. And return the image buffer to each handler when exectue handler.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The handlers are executed in same order to their registered order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] AuthenticationStatus
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is the authentication type returned from the Section
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Extraction protocol. See the Section Extraction Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Specification for details on this type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FilePath This is a pointer to the device path of the file that is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being dispatched. This will optionally be used for logging.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The file specified by File did authenticate when more
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync than one security handler services were registered,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or the file did not authenticate when no security
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handler service was registered. And the platform policy
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync dictates that the DXE Core may use File.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER File is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the platform policy dictates that File should be placed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in the untrusted state. A file may be promoted from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the untrusted to the trusted state at a future time
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with a call to the Trust() DXE Service.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The file specified by File did not authenticate, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the platform policy dictates that File should not be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync used for any purpose.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Directly return successfully when no handler is registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HandlerAuthenticationStatus = AuthenticationStatus;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Run security handler in same order to their registered list
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < mNumberOfSecurityHandler; Index ++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((mSecurityTable[Index].SecurityOperation & EFI_AUTH_OPERATION_IMAGE_REQUIRED) == EFI_AUTH_OPERATION_IMAGE_REQUIRED) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Try get file buffer when the handler requires image buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Try to get image by FALSE boot policy for the exact boot file path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FileBuffer = GetFileBufferByFilePath (FALSE, FilePath, &FileSize, &AuthenticationStatus);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Try to get image by TRUE boot policy for the inexact boot file path.