1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
/*++
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
Crc32SectionExtract.c
Abstract:
Implements GUIDed section extraction protocol interface with
a specific GUID: CRC32.
Please refer to the Tiano File Image Format Specification,
FV spec 0.3.6
--*/
#include <GuidedSection.h>
#include <Crc32SectionExtract.h>
EFI_STATUS
InitializeCrc32GuidedSectionExtractionProtocol (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
);
EFI_STATUS
InitializeCrc32GuidedSectionExtractionProtocol (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
/*++
Routine Description:
Entry point of the CRC32 GUIDed section extraction protocol.
Creates and initializes an instance of the GUIDed section
extraction protocol with CRC32 GUID.
Arguments:
ImageHandle EFI_HANDLE: A handle for the image that is initializing
this driver
SystemTable EFI_SYSTEM_TABLE: A pointer to the EFI system table
Returns:
EFI_SUCCESS: Driver initialized successfully
EFI_LOAD_ERROR: Failed to Initialize or has been loaded
EFI_OUT_OF_RESOURCES: Could not allocate needed resources
--*/
{
EFI_STATUS Status;
EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL *Crc32GuidedSep;
EFI_HANDLE Handle;
//
// Call all constructors per produced protocols
//
Status = GuidedSectionExtractionProtocolConstructor (
&Crc32GuidedSep,
(EFI_EXTRACT_GUIDED_SECTION) Crc32ExtractSection
);
if (EFI_ERROR (Status)) {
if (Crc32GuidedSep != NULL) {
gBS->FreePool (Crc32GuidedSep);
}
return Status;
}
//
// Pass in a NULL to install to a new handle
//
Handle = NULL;
Status = gBS->InstallProtocolInterface (
&Handle,
&gEfiCrc32GuidedSectionExtractionProtocolGuid,
EFI_NATIVE_INTERFACE,
Crc32GuidedSep
);
if (EFI_ERROR (Status)) {
gBS->FreePool (Crc32GuidedSep);
return EFI_LOAD_ERROR;
}
return EFI_SUCCESS;
}
STATIC
UINT32
GetSectionLength (
IN EFI_COMMON_SECTION_HEADER *CommonHeader
)
/*++
Routine Description:
Get a length of section.
Parameters:
CommonHeader - Pointer to the common section header.
Return Value:
The length of the section, including the section header.
--*/
// TODO: function comment is missing 'Arguments:'
// TODO: function comment is missing 'Returns:'
// TODO: CommonHeader - add argument and description to function comment
{
UINT32 Size;
Size = *(UINT32 *) CommonHeader->Size & 0x00FFFFFF;
return Size;
}
STATIC
EFI_STATUS
Crc32ExtractSection (
IN EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL *This,
IN VOID *InputSection,
OUT VOID **OutputBuffer,
OUT UINTN *OutputSize,
OUT UINT32 *AuthenticationStatus
)
/*++
Routine Description:
This function reads and extracts contents of a section from an
encapsulating section.
Parameters:
This - Indicates the calling context.
InputSection - Buffer containing the input GUIDed section
to be processed.
OutputBuffer - *OutputBuffer is allocated from boot services
pool memory and containing the new section
stream. The caller is responsible for freeing
this buffer.
AuthenticationStatus - Pointer to a caller allocated UINT32 that
indicates the authentication status of the
output buffer
Return Value:
EFI_SUCCESS
EFI_OUT_OF_RESOURCES
EFI_INVALID_PARAMETER
EFI_NOT_AVAILABLE_YET
--*/
// TODO: function comment is missing 'Arguments:'
// TODO: function comment is missing 'Returns:'
// TODO: This - add argument and description to function comment
// TODO: InputSection - add argument and description to function comment
// TODO: OutputBuffer - add argument and description to function comment
// TODO: OutputSize - add argument and description to function comment
// TODO: AuthenticationStatus - add argument and description to function comment
// TODO: EFI_INVALID_PARAMETER - add return value to function comment
// TODO: EFI_INVALID_PARAMETER - add return value to function comment
// TODO: EFI_OUT_OF_RESOURCES - add return value to function comment
// TODO: EFI_SUCCESS - add return value to function comment
{
EFI_STATUS Status;
CRC32_SECTION_HEADER *Crc32SectionHeader;
EFI_GUID_DEFINED_SECTION *GuidedSectionHeader;
UINT8 *Image;
UINT32 Crc32Checksum;
VOID *DummyInterface;
if (OutputBuffer == NULL) {
return EFI_INVALID_PARAMETER;
}
*OutputBuffer = NULL;
//
// Points to the section header
//
Crc32SectionHeader = (CRC32_SECTION_HEADER *) InputSection;
GuidedSectionHeader = (EFI_GUID_DEFINED_SECTION *) InputSection;
//
// Check if the GUID is a CRC32 section GUID
//
if (!CompareGuid (
&(GuidedSectionHeader->SectionDefinitionGuid),
&gEfiCrc32GuidedSectionExtractionProtocolGuid
)) {
return EFI_INVALID_PARAMETER;
}
Image = (UINT8 *) InputSection + (UINT32) (GuidedSectionHeader->DataOffset);
*OutputSize = GetSectionLength ((EFI_COMMON_SECTION_HEADER *) InputSection) - (UINT32) GuidedSectionHeader->DataOffset;
Status = gBS->AllocatePool (EfiBootServicesData, *OutputSize, OutputBuffer);
if (EFI_ERROR (Status)) {
return EFI_OUT_OF_RESOURCES;
}
//
// Implictly CRC32 GUIDed section should have STATUS_VALID bit set
//
ASSERT (GuidedSectionHeader->Attributes & EFI_GUIDED_SECTION_AUTH_STATUS_VALID);
*AuthenticationStatus = EFI_LOCAL_AUTH_STATUS_IMAGE_SIGNED | EFI_AGGREGATE_AUTH_STATUS_IMAGE_SIGNED;
//
// Check whether there exists EFI_SECURITY_POLICY_PROTOCOL_GUID.
//
Status = gBS->LocateProtocol (&gEfiSecurityPolicyProtocolGuid, NULL, &DummyInterface);
if (!EFI_ERROR (Status)) {
*AuthenticationStatus |= EFI_LOCAL_AUTH_STATUS_PLATFORM_OVERRIDE | EFI_AGGREGATE_AUTH_STATUS_PLATFORM_OVERRIDE;
} else {
//
// Calculate CRC32 Checksum of Image
//
gBS->CalculateCrc32 (Image, *OutputSize, &Crc32Checksum);
if (Crc32Checksum != Crc32SectionHeader->CRC32Checksum) {
*AuthenticationStatus |= EFI_LOCAL_AUTH_STATUS_TEST_FAILED | EFI_AGGREGATE_AUTH_STATUS_TEST_FAILED;
}
}
CopyMem (*OutputBuffer, Image, *OutputSize);
return EFI_SUCCESS;
}
|
