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
|
/** @file
Unit tests for the implementation of SecureBootVariableLib.
Copyright (c) 2022, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <Library/GoogleTestLib.h>
#include <GoogleTest/Library/MockUefiLib.h>
#include <GoogleTest/Library/MockUefiRuntimeServicesTableLib.h>
extern "C" {
#include <Uefi.h>
#include <UefiSecureBoot.h>
#include <Guid/AuthenticatedVariableFormat.h>
#include <Guid/ImageAuthentication.h>
#include <Library/SecureBootVariableLib.h>
#include <Library/MemoryAllocationLib.h>
}
using namespace testing;
//////////////////////////////////////////////////////////////////////////////
class SetSecureBootModeTest : public Test {
protected:
MockUefiRuntimeServicesTableLib RtServicesMock;
UINT8 SecureBootMode;
EFI_STATUS Status;
void
SetUp (
) override
{
// Any random magic number can be used for these tests
SecureBootMode = 0xAB;
}
};
// Test SetSecureBootMode() API from SecureBootVariableLib to verify the
// expected error is returned when the call to gRT->SetVariable() fails.
TEST_F (SetSecureBootModeTest, SetVarError) {
EXPECT_CALL (RtServicesMock, gRT_SetVariable)
.WillOnce (Return (EFI_INVALID_PARAMETER));
Status = SetSecureBootMode (SecureBootMode);
EXPECT_EQ (Status, EFI_INVALID_PARAMETER);
}
// Test SetSecureBootMode() API from SecureBootVariableLib to verify the
// expected secure boot mode is written to the correct variable in the call
// to gRT->SetVariable().
TEST_F (SetSecureBootModeTest, PropogateModeToSetVar) {
EXPECT_CALL (
RtServicesMock,
gRT_SetVariable (
Char16StrEq (EFI_CUSTOM_MODE_NAME),
BufferEq (&gEfiCustomModeEnableGuid, sizeof (EFI_GUID)),
EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
sizeof (SecureBootMode),
BufferEq (&SecureBootMode, sizeof (SecureBootMode))
)
)
.WillOnce (Return (EFI_SUCCESS));
Status = SetSecureBootMode (SecureBootMode);
EXPECT_EQ (Status, EFI_SUCCESS);
}
//////////////////////////////////////////////////////////////////////////////
class GetSetupModeTest : public Test {
protected:
MockUefiRuntimeServicesTableLib RtServicesMock;
UINT8 SetupMode;
EFI_STATUS Status;
UINT8 ExpSetupMode;
void
SetUp (
) override
{
// Any random magic number can be used for these tests
ExpSetupMode = 0xAB;
}
};
// Test GetSetupMode() API from SecureBootVariableLib to verify the expected
// error is returned when the call to gRT->GetVariable() fails.
TEST_F (GetSetupModeTest, GetVarError) {
EXPECT_CALL (RtServicesMock, gRT_GetVariable)
.WillOnce (Return (EFI_INVALID_PARAMETER));
Status = GetSetupMode (&SetupMode);
EXPECT_EQ (Status, EFI_INVALID_PARAMETER);
}
// Test GetSetupMode() API from SecureBootVariableLib to verify the expected
// setup mode is returned (and with a success return code) when the mode is
// successfully read from the call to gRT->GetVariable().
TEST_F (GetSetupModeTest, FetchModeFromGetVar) {
EXPECT_CALL (
RtServicesMock,
gRT_GetVariable (
Char16StrEq (EFI_SETUP_MODE_NAME),
BufferEq (&gEfiGlobalVariableGuid, sizeof (EFI_GUID)),
_,
Pointee (Eq (sizeof (SetupMode))),
NotNull ()
)
)
.WillOnce (
DoAll (
SetArgPointee<3>(sizeof (ExpSetupMode)),
SetArgBuffer<4>(&ExpSetupMode, sizeof (ExpSetupMode)),
Return (EFI_SUCCESS)
)
);
Status = GetSetupMode (&SetupMode);
ASSERT_EQ (Status, EFI_SUCCESS);
EXPECT_EQ (SetupMode, ExpSetupMode);
}
//////////////////////////////////////////////////////////////////////////////
class IsSecureBootEnabledTest : public Test {
protected:
MockUefiLib UefiLibMock;
BOOLEAN Enabled;
};
// Test IsSecureBootEnabled() API from SecureBootVariableLib to verify FALSE
// is returned when the call to GetEfiGlobalVariable2() fails.
TEST_F (IsSecureBootEnabledTest, GetVarError) {
EXPECT_CALL (UefiLibMock, GetEfiGlobalVariable2)
.WillOnce (Return (EFI_ABORTED));
Enabled = IsSecureBootEnabled ();
EXPECT_EQ (Enabled, FALSE);
}
//////////////////////////////////////////////////////////////////////////////
class IsSecureBootEnabledAllocTest : public IsSecureBootEnabledTest {
protected:
UINT8 *BootEnabledBuffer;
void
SetUp (
) override
{
BootEnabledBuffer = (UINT8 *)AllocatePool (1);
ASSERT_NE (BootEnabledBuffer, nullptr);
}
};
// Test IsSecureBootEnabled() API from SecureBootVariableLib to verify TRUE
// is returned when the call to GetEfiGlobalVariable2() is successful and
// returns SECURE_BOOT_MODE_ENABLE.
TEST_F (IsSecureBootEnabledAllocTest, IsEnabled) {
*BootEnabledBuffer = SECURE_BOOT_MODE_ENABLE;
EXPECT_CALL (
UefiLibMock,
GetEfiGlobalVariable2 (
Char16StrEq (EFI_SECURE_BOOT_MODE_NAME),
NotNull (),
_
)
)
.WillOnce (
DoAll (
SetArgBuffer<1>(&BootEnabledBuffer, sizeof (VOID *)),
Return (EFI_SUCCESS)
)
);
Enabled = IsSecureBootEnabled ();
EXPECT_EQ (Enabled, TRUE);
}
// Test IsSecureBootEnabled() API from SecureBootVariableLib to verify FALSE
// is returned when the call to GetEfiGlobalVariable2() is successful and
// returns SECURE_BOOT_MODE_DISABLE.
TEST_F (IsSecureBootEnabledAllocTest, IsDisabled) {
*BootEnabledBuffer = SECURE_BOOT_MODE_DISABLE;
EXPECT_CALL (
UefiLibMock,
GetEfiGlobalVariable2 (
Char16StrEq (EFI_SECURE_BOOT_MODE_NAME),
NotNull (),
_
)
)
.WillOnce (
DoAll (
SetArgBuffer<1>(&BootEnabledBuffer, sizeof (VOID *)),
Return (EFI_SUCCESS)
)
);
Enabled = IsSecureBootEnabled ();
EXPECT_EQ (Enabled, FALSE);
}
int
main (
int argc,
char *argv[]
)
{
testing::InitGoogleTest (&argc, argv);
return RUN_ALL_TESTS ();
}
|
