You've already forked edk2-upstream
mirror of
https://github.com/Dasharo/edk2-upstream.git
synced 2026-03-06 15:03:57 -08:00
7a934d0bef
Replace traditional `#ifndef`/`#define`/`#endif` include guards with
`#pragma` once.
`#pragma once` is a widely supported preprocessor directive that
prevents header files from being included multiple times. It is
supported by all toolchains used to build edk2: GCC, Clang/LLVM, and
MSVC.
Compared to macro-based include guards, `#pragma once`:
- Eliminates the risk of macro name collisions or copy/paste errors
where two headers inadvertently use the same guard macro.
- Eliminate inconsistency in the way include guard macros are named
(e.g., some files use `__FILE_H__`, others use `FILE_H_`, etc.).
- Reduces boilerplate (three lines replaced by one).
- Avoids polluting the macro namespace with guard symbols.
- Can improve build times as the preprocessor can skip re-opening the
file entirely, rather than re-reading it to find the matching
`#endif` ("multiple-include optimization").
- Note that some compilers may already optimize traditional include
guards, by recognzining the idiomatic pattern.
This change is made acknowledging that overall portability of the
code will technically be reduced, as `#pragma once` is not part of the
C/C++ standards.
However, this is considered acceptable given:
1. edk2 already defines a subset of supported compilers in
BaseTools/Conf/tools_def.template, all of which have supported
`#pragma once` for over two decades.
2. There have been concerns raised to the project about inconsistent
include guard naming and potential macro collisions.
Approximate compiler support dates:
- MSVC: Supported since Visual C++ 4.2 (1996)
- GCC: Supported since 3.4 (2004)
(http://gnu.ist.utl.pt/software/gcc/gcc-3.4/changes.html)
- Clang (LLVM based): Since initial release in 2007
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
56 lines
2.6 KiB
C
56 lines
2.6 KiB
C
/** @file
|
|
FMP capsule authenitcation Library.
|
|
|
|
Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Protocol/FirmwareManagement.h>
|
|
|
|
/**
|
|
The function is used to do the authentication for FMP capsule based upon
|
|
EFI_FIRMWARE_IMAGE_AUTHENTICATION.
|
|
|
|
The FMP capsule image should start with EFI_FIRMWARE_IMAGE_AUTHENTICATION,
|
|
followed by the payload.
|
|
|
|
If the return status is RETURN_SUCCESS, the caller may continue the rest
|
|
FMP update process.
|
|
If the return status is NOT RETURN_SUCCESS, the caller should stop the FMP
|
|
update process and convert the return status to LastAttemptStatus
|
|
to indicate that FMP update fails.
|
|
The LastAttemptStatus can be got from ESRT table or via
|
|
EFI_FIRMWARE_MANAGEMENT_PROTOCOL.GetImageInfo().
|
|
|
|
Caution: This function may receive untrusted input.
|
|
|
|
@param[in] Image Points to an FMP authentication image, started from EFI_FIRMWARE_IMAGE_AUTHENTICATION.
|
|
@param[in] ImageSize Size of the authentication image in bytes.
|
|
@param[in] PublicKeyData The public key data used to validate the signature.
|
|
@param[in] PublicKeyDataLength The length of the public key data.
|
|
|
|
@retval RETURN_SUCCESS Authentication pass.
|
|
The LastAttemptStatus should be LAST_ATTEMPT_STATUS_SUCCESS.
|
|
@retval RETURN_SECURITY_VIOLATION Authentication fail.
|
|
The LastAttemptStatus should be LAST_ATTEMPT_STATUS_ERROR_AUTH_ERROR.
|
|
@retval RETURN_INVALID_PARAMETER The image is in an invalid format.
|
|
The LastAttemptStatus should be LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT.
|
|
@retval RETURN_UNSUPPORTED No Authentication handler associated with CertType.
|
|
The LastAttemptStatus should be LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT.
|
|
@retval RETURN_UNSUPPORTED Image or ImageSize is invalid.
|
|
The LastAttemptStatus should be LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT.
|
|
@retval RETURN_OUT_OF_RESOURCES No Authentication handler associated with CertType.
|
|
The LastAttemptStatus should be LAST_ATTEMPT_STATUS_ERROR_INSUFFICIENT_RESOURCES.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
AuthenticateFmpImage (
|
|
IN EFI_FIRMWARE_IMAGE_AUTHENTICATION *Image,
|
|
IN UINTN ImageSize,
|
|
IN CONST UINT8 *PublicKeyData,
|
|
IN UINTN PublicKeyDataLength
|
|
);
|