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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
|
/** @file
Public API for Opal Core library.
Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
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.
**/
#include <Uefi.h>
#include <Library/BaseLib.h>
#include <Library/TimerLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/TcgStorageOpalLib.h>
#pragma pack(1)
typedef struct {
UINT8 HardwareReset : 1;
UINT8 Reserved : 7;
} TCG_BLOCK_SID_CLEAR_EVENTS;
#pragma pack()
#define TRUSTED_COMMAND_TIMEOUT_NS ((UINT64) 5 * ((UINT64)(1000000)) * 1000) // 5 seconds
#define BUFFER_SIZE 512
/**
The function performs a Trusted Send of a Buffer containing a TCG_COM_PACKET.
@param[in] Sscp The input Ssc Protocol.
@param[in] MediaId The input Media id info used by Ssc Protocol.
@param[in] SecurityProtocol Security Protocol
@param[in] SpSpecific Security Protocol Specific
@param[in] TransferLength Transfer Length of Buffer (in bytes) - always a multiple of 512
@param[in] Buffer Address of Data to transfer
@param[in] BufferSize Full Size of Buffer, including space that may be used for padding.
**/
TCG_RESULT
OpalTrustedSend(
EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *Sscp,
UINT32 MediaId,
UINT8 SecurityProtocol,
UINT16 SpSpecific,
UINTN TransferLength,
VOID *Buffer,
UINTN BufferSize
)
{
UINTN TransferLength512;
EFI_STATUS Status;
//
// Round transferLength up to a 512-byte multiple
//
TransferLength512 = (TransferLength + 511) & ~(UINTN)511;
if (TransferLength512 > BufferSize) {
return TcgResultFailureBufferTooSmall;
}
ZeroMem((UINT8*)Buffer + TransferLength, TransferLength512 - TransferLength);
Status = Sscp->SendData(
Sscp,
MediaId,
TRUSTED_COMMAND_TIMEOUT_NS,
SecurityProtocol,
SwapBytes16(SpSpecific),
TransferLength512,
Buffer
);
return Status == EFI_SUCCESS ? TcgResultSuccess : TcgResultFailure;
}
/**
The function performs a Trusted Receive of a Buffer containing a TCG_COM_PACKET.
@param[in] Sscp The input Ssc Protocol.
@param[in] MediaId The input Media id info used by Ssc Protocol.
@param[in] SecurityProtocol Security Protocol
@param[in] SpSpecific Security Protocol Specific
@param[in] Buffer Address of Data to transfer
@param[in] BufferSize Full Size of Buffer, including space that may be used for padding.
**/
TCG_RESULT
OpalTrustedRecv(
EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *Sscp,
UINT32 MediaId,
UINT8 SecurityProtocol,
UINT16 SpSpecific,
VOID *Buffer,
UINTN BufferSize
)
{
UINTN TransferLength512;
UINT32 Tries;
TCG_COM_PACKET *ComPacket;
UINT32 Length;
UINT32 OutstandingData;
EFI_STATUS Status;
UINTN TransferSize;
//
// Round Buffer Size down to a 512-byte multiple
//
TransferLength512 = BufferSize & ~(UINTN)511;
Tries = 0;
ComPacket = NULL;
Length = 0;
OutstandingData = 0;
if (TransferLength512 < sizeof(TCG_COM_PACKET)) {
DEBUG ((DEBUG_INFO, "transferLength %u too small for ComPacket\n", TransferLength512));
return TcgResultFailureBufferTooSmall;
}
//
// Some devices respond with Length = 0 and OutstandingData = 1 to indicate that processing is not yet completed,
// so we need to retry the IF-RECV to get the actual Data.
// See TCG Core Spec v2 Table 45 IF-RECV ComPacket Field Values Summary
// This is an arbitrary number of retries, not from the spec.
// have a max timeout of 10 seconds, 5000 tries * 2ms = 10s
//
Tries = 5000;
while ((Tries--) > 0) {
ZeroMem( Buffer, BufferSize );
TransferSize = 0;
Status = Sscp->ReceiveData(
Sscp,
MediaId,
TRUSTED_COMMAND_TIMEOUT_NS,
SecurityProtocol,
SwapBytes16(SpSpecific),
TransferLength512,
Buffer,
&TransferSize
);
if (EFI_ERROR (Status)) {
return TcgResultFailure;
}
if (SecurityProtocol != TCG_OPAL_SECURITY_PROTOCOL_1 && SecurityProtocol != TCG_OPAL_SECURITY_PROTOCOL_2) {
return TcgResultSuccess;
}
if (SpSpecific == TCG_SP_SPECIFIC_PROTOCOL_LEVEL0_DISCOVERY) {
return TcgResultSuccess;
}
ComPacket = (TCG_COM_PACKET*) Buffer;
Length = SwapBytes32(ComPacket->LengthBE);
OutstandingData = SwapBytes32( ComPacket->OutstandingDataBE );
if (Length != 0 && OutstandingData == 0) {
return TcgResultSuccess;
}
//
// Delay for 2 ms
//
MicroSecondDelay (2000);
}
return TcgResultFailure;
}
/**
The function performs send, recv, check comIDs, check method status action.
@param[in] Session OPAL_SESSION related to this method..
@param[in] SendSize Transfer Length of Buffer (in bytes) - always a multiple of 512
@param[in] Buffer Address of Data to transfer
@param[in] BufferSize Full Size of Buffer, including space that may be used for padding.
@param[in] ParseStruct Structure used to parse received TCG response.
@param[in] MethodStatus Method status of last action performed. If action succeeded, it should be TCG_METHOD_STATUS_CODE_SUCCESS.
**/
TCG_RESULT
EFIAPI
OpalPerformMethod(
OPAL_SESSION *Session,
UINT32 SendSize,
VOID *Buffer,
UINT32 BufferSize,
TCG_PARSE_STRUCT *ParseStruct,
UINT8 *MethodStatus
)
{
NULL_CHECK(Session);
NULL_CHECK(MethodStatus);
ERROR_CHECK(OpalTrustedSend(
Session->Sscp,
Session->MediaId,
TCG_OPAL_SECURITY_PROTOCOL_1,
Session->OpalBaseComId,
SendSize,
Buffer,
BufferSize
));
ERROR_CHECK(OpalTrustedRecv(
Session->Sscp,
Session->MediaId,
TCG_OPAL_SECURITY_PROTOCOL_1,
Session->OpalBaseComId,
Buffer,
BufferSize
));
ERROR_CHECK(TcgInitTcgParseStruct(ParseStruct, Buffer, BufferSize));
ERROR_CHECK(TcgCheckComIds(ParseStruct, Session->OpalBaseComId, Session->ComIdExtension));
ERROR_CHECK(TcgGetMethodStatus(ParseStruct, MethodStatus));
return TcgResultSuccess;
}
/**
Trig the block sid action.
@param[in] Session OPAL_SESSION related to this method..
@param[in] HardwareReset Whether need to do hardware reset.
**/
TCG_RESULT
EFIAPI
OpalBlockSid(
OPAL_SESSION *Session,
BOOLEAN HardwareReset
)
{
UINT8 Buffer[BUFFER_SIZE];
TCG_BLOCK_SID_CLEAR_EVENTS *ClearEvents;
NULL_CHECK(Session);
//
// Set Hardware Reset bit
//
ClearEvents = (TCG_BLOCK_SID_CLEAR_EVENTS *) &Buffer[0];
ClearEvents->Reserved = 0;
ClearEvents->HardwareReset = HardwareReset;
return(OpalTrustedSend(
Session->Sscp,
Session->MediaId,
TCG_OPAL_SECURITY_PROTOCOL_2,
TCG_BLOCKSID_COMID, // hardcode ComID 0x0005
1,
Buffer,
BUFFER_SIZE
));
}
/**
Reverts device using Admin SP Revert method.
@param[in] AdminSpSession OPAL_SESSION with OPAL_UID_ADMIN_SP as OPAL_ADMIN_SP_PSID_AUTHORITY to perform PSID revert.
**/
TCG_RESULT
EFIAPI
OpalPsidRevert(
OPAL_SESSION *AdminSpSession
)
{
//
// Now that base comid is known, start Session
// we'll attempt to start Session as PSID authority
// verify PSID Authority is defined in ADMIN SP authority table... is this possible?
//
TCG_CREATE_STRUCT CreateStruct;
TCG_PARSE_STRUCT ParseStruct;
UINT32 Size;
UINT8 Buffer[BUFFER_SIZE];
UINT8 MethodStatus;
NULL_CHECK(AdminSpSession);
//
// Send Revert action on Admin SP
//
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buffer, BUFFER_SIZE));
ERROR_CHECK(TcgStartComPacket(&CreateStruct, AdminSpSession->OpalBaseComId, AdminSpSession->ComIdExtension));
ERROR_CHECK(TcgStartPacket(&CreateStruct, AdminSpSession->TperSessionId, AdminSpSession->HostSessionId, 0x0, 0x0, 0x0));
ERROR_CHECK(TcgStartSubPacket(&CreateStruct, 0x0));
ERROR_CHECK(TcgStartMethodCall(&CreateStruct, OPAL_UID_ADMIN_SP, OPAL_ADMIN_SP_REVERT_METHOD));
ERROR_CHECK(TcgStartParameters(&CreateStruct));
ERROR_CHECK(TcgEndParameters(&CreateStruct));
ERROR_CHECK(TcgEndMethodCall(&CreateStruct));
ERROR_CHECK(TcgEndSubPacket(&CreateStruct));
ERROR_CHECK(TcgEndPacket(&CreateStruct));
ERROR_CHECK(TcgEndComPacket(&CreateStruct, &Size));
//
// Send Revert Method Call
//
ERROR_CHECK(OpalPerformMethod(AdminSpSession, Size, Buffer, BUFFER_SIZE, &ParseStruct, &MethodStatus));
METHOD_STATUS_ERROR_CHECK(MethodStatus, TcgResultFailure);
return TcgResultSuccess;
}
/**
The function fills in the provided Buffer with the level 0 discovery Header
of the device specified.
@param[in] Session OPAL_SESSION data.
@param[in] BufferSize Size of Buffer provided (in bytes)
@param[in] BuffAddress Buffer address to fill with Level 0 Discovery response
**/
TCG_RESULT
EFIAPI
OpalRetrieveLevel0DiscoveryHeader(
OPAL_SESSION *Session,
UINTN BufferSize,
VOID *BuffAddress
)
{
return (OpalTrustedRecv(
Session->Sscp,
Session->MediaId,
TCG_OPAL_SECURITY_PROTOCOL_1, // SP
TCG_SP_SPECIFIC_PROTOCOL_LEVEL0_DISCOVERY, // SP_Specific
BuffAddress,
BufferSize
));
}
/**
The function fills in the provided Buffer with the supported protocol list
of the device specified.
@param[in] Session OPAL_SESSION data.
@param[in] BufferSize Size of Buffer provided (in bytes)
@param[in] BuffAddress Buffer address to fill with security protocol list
**/
TCG_RESULT
EFIAPI
OpalRetrieveSupportedProtocolList(
OPAL_SESSION *Session,
UINTN BufferSize,
VOID *BuffAddress
)
{
return (OpalTrustedRecv(
Session->Sscp,
Session->MediaId,
TCG_SECURITY_PROTOCOL_INFO, // SP
TCG_SP_SPECIFIC_PROTOCOL_LIST, // SP_Specific
BuffAddress,
BufferSize
));
}
/**
Starts a session with a security provider (SP).
If a session is started successfully, the caller must end the session with OpalEndSession when finished
performing Opal actions.
@param[in/out] Session OPAL_SESSION to initialize.
@param[in] SpId Security provider ID to start the session with.
@param[in] Write Whether the session should be read-only (FALSE) or read/write (TRUE).
@param[in] HostChallengeLength Length of the host challenge. Length should be 0 if hostChallenge is NULL
@param[in] HostChallenge Host challenge for Host Signing Authority. If NULL, then no Host Challenge will be sent.
@param[in] HostSigningAuthority Host Signing Authority used for start session. If NULL, then no Host Signing Authority will be sent.
@param[in/out] MethodStatus Status of the StartSession method; only valid if TcgResultSuccess is returned.
@return TcgResultSuccess indicates that the function completed without any internal errors.
The caller must inspect the MethodStatus field to determine whether the method completed successfully.
**/
TCG_RESULT
EFIAPI
OpalStartSession(
OPAL_SESSION *Session,
TCG_UID SpId,
BOOLEAN Write,
UINT32 HostChallengeLength,
const VOID *HostChallenge,
TCG_UID HostSigningAuthority,
UINT8 *MethodStatus
)
{
TCG_CREATE_STRUCT CreateStruct;
TCG_PARSE_STRUCT ParseStruct;
UINT32 Size;
UINT8 Buf[BUFFER_SIZE];
UINT16 ComIdExtension;
UINT32 HostSessionId;
ComIdExtension = 0;
HostSessionId = 1;
NULL_CHECK(Session);
NULL_CHECK(MethodStatus);
Session->ComIdExtension = ComIdExtension;
Session->HostSessionId = HostSessionId;
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buf, sizeof(Buf)));
ERROR_CHECK(TcgCreateStartSession(
&CreateStruct,
&Size,
Session->OpalBaseComId,
ComIdExtension,
HostSessionId,
SpId,
Write,
HostChallengeLength,
HostChallenge,
HostSigningAuthority
));
ERROR_CHECK(OpalPerformMethod(Session, Size, Buf, sizeof(Buf), &ParseStruct, MethodStatus));
if (*MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
return TcgResultSuccess; // return early if method failed - user must check MethodStatus
}
if (TcgParseSyncSession(&ParseStruct, Session->OpalBaseComId, ComIdExtension, HostSessionId, &Session->TperSessionId) != TcgResultSuccess) {
OpalEndSession(Session);
return TcgResultFailure;
}
return TcgResultSuccess;
}
/**
Close a session opened with OpalStartSession.
@param[in/out] Session OPAL_SESSION to end.
**/
TCG_RESULT
EFIAPI
OpalEndSession(
OPAL_SESSION *Session
)
{
UINT8 Buffer[BUFFER_SIZE];
TCG_CREATE_STRUCT CreateStruct;
UINT32 Size;
TCG_PARSE_STRUCT ParseStruct;
NULL_CHECK(Session);
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buffer, sizeof(Buffer)));
ERROR_CHECK(TcgCreateEndSession(
&CreateStruct,
&Size,
Session->OpalBaseComId,
Session->ComIdExtension,
Session->HostSessionId,
Session->TperSessionId
));
ERROR_CHECK(OpalTrustedSend(
Session->Sscp,
Session->MediaId,
TCG_OPAL_SECURITY_PROTOCOL_1,
Session->OpalBaseComId,
Size,
Buffer,
sizeof(Buffer)
));
ERROR_CHECK(OpalTrustedRecv(
Session->Sscp,
Session->MediaId,
TCG_OPAL_SECURITY_PROTOCOL_1,
Session->OpalBaseComId,
Buffer,
sizeof(Buffer)
));
ERROR_CHECK(TcgInitTcgParseStruct(&ParseStruct, Buffer, sizeof(Buffer)));
ERROR_CHECK(TcgCheckComIds(&ParseStruct, Session->OpalBaseComId, Session->ComIdExtension));
ERROR_CHECK(TcgGetNextEndOfSession(&ParseStruct));
return TcgResultSuccess;
}
/**
The function retrieves the MSID from the device specified
@param[in] AdminSpSession OPAL_SESSION with OPAL_UID_ADMIN_SP as OPAL_ADMIN_SP_PSID_AUTHORITY to perform PSID revert.
@param[in] MsidBufferSize Allocated Buffer Size (in bytes) for MSID allocated by caller
@param[in] Msid Variable Length byte sequence representing MSID of device
@param[in] MsidLength Actual Length of MSID retrieved from device
**/
TCG_RESULT
EFIAPI
OpalGetMsid(
OPAL_SESSION *AdminSpSession,
UINT32 MsidBufferSize,
UINT8 *Msid,
UINT32 *MsidLength
)
{
//
// now that base comid is known, start Session
// we'll attempt to start Session as PSID authority
// verify PSID Authority is defined in ADMIN SP authority table... is this possible?
//
TCG_CREATE_STRUCT CreateStruct;
TCG_PARSE_STRUCT ParseStruct;
UINT32 Size;
UINT8 MethodStatus;
UINT32 Col;
const VOID *RecvMsid;
UINT8 Buffer[BUFFER_SIZE];
NULL_CHECK(AdminSpSession);
NULL_CHECK(Msid);
NULL_CHECK(MsidLength);
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buffer, BUFFER_SIZE));
ERROR_CHECK(TcgStartComPacket(&CreateStruct, AdminSpSession->OpalBaseComId, AdminSpSession->ComIdExtension));
ERROR_CHECK(TcgStartPacket(&CreateStruct, AdminSpSession->TperSessionId, AdminSpSession->HostSessionId, 0x0, 0x0, 0x0));
ERROR_CHECK(TcgStartSubPacket(&CreateStruct, 0x0));
ERROR_CHECK(TcgStartMethodCall(&CreateStruct, OPAL_UID_ADMIN_SP_C_PIN_MSID, TCG_UID_METHOD_GET));
ERROR_CHECK(TcgStartParameters(&CreateStruct));
ERROR_CHECK(TcgAddStartList(&CreateStruct));
ERROR_CHECK(TcgAddStartName(&CreateStruct));
ERROR_CHECK(TcgAddUINT8(&CreateStruct, TCG_CELL_BLOCK_START_COLUMN_NAME));
ERROR_CHECK(TcgAddUINT8(&CreateStruct, OPAL_ADMIN_SP_PIN_COL));
ERROR_CHECK(TcgAddEndName(&CreateStruct));
ERROR_CHECK(TcgAddStartName(&CreateStruct));
ERROR_CHECK(TcgAddUINT8(&CreateStruct, TCG_CELL_BLOCK_END_COLUMN_NAME));
ERROR_CHECK(TcgAddUINT8(&CreateStruct, OPAL_ADMIN_SP_PIN_COL));
ERROR_CHECK(TcgAddEndName(&CreateStruct));
ERROR_CHECK(TcgAddEndList(&CreateStruct));
ERROR_CHECK(TcgEndParameters(&CreateStruct));
ERROR_CHECK(TcgEndMethodCall(&CreateStruct));
ERROR_CHECK(TcgEndSubPacket(&CreateStruct));
ERROR_CHECK(TcgEndPacket(&CreateStruct));
ERROR_CHECK(TcgEndComPacket(&CreateStruct, &Size));
//
// Send MSID Method Call
//
ERROR_CHECK(OpalPerformMethod(AdminSpSession, Size, Buffer, BUFFER_SIZE, &ParseStruct, &MethodStatus));
METHOD_STATUS_ERROR_CHECK(MethodStatus, TcgResultFailure);
ERROR_CHECK(TcgGetNextStartList(&ParseStruct));
ERROR_CHECK(TcgGetNextStartList(&ParseStruct));
ERROR_CHECK(TcgGetNextStartName(&ParseStruct));
ERROR_CHECK(TcgGetNextUINT32(&ParseStruct, &Col));
ERROR_CHECK(TcgGetNextByteSequence(&ParseStruct, &RecvMsid, MsidLength));
ERROR_CHECK(TcgGetNextEndName(&ParseStruct));
ERROR_CHECK(TcgGetNextEndList(&ParseStruct));
ERROR_CHECK(TcgGetNextEndList(&ParseStruct));
ERROR_CHECK(TcgGetNextEndOfData(&ParseStruct));
if (Col != OPAL_ADMIN_SP_PIN_COL) {
DEBUG ((DEBUG_INFO, "ERROR: got col %u, expected %u\n", Col, OPAL_ADMIN_SP_PIN_COL));
return TcgResultFailure;
}
if (RecvMsid == NULL) {
return TcgResultFailure;
}
if (MsidBufferSize < *MsidLength) {
DEBUG ((DEBUG_INFO, "Buffer too small MsidBufferSize: %d MsidLength: %d\n", MsidBufferSize, *MsidLength));
return TcgResultFailureBufferTooSmall;
}
//
// copy msid into Buffer
//
CopyMem(Msid, RecvMsid, *MsidLength);
return TcgResultSuccess;
}
/**
The function calls the Admin SP RevertSP method on the Locking SP. If KeepUserData is True, then the optional parameter
to keep the user Data is set to True, otherwise the optional parameter is not provided.
@param[in] LockingSpSession OPAL_SESSION with OPAL_UID_LOCKING_SP as OPAL_LOCKING_SP_ADMIN1_AUTHORITY to revertSP
@param[in] KeepUserData Specifies whether or not to keep user Data when performing RevertSP action. True = keeps user Data.
@param[in/out] MethodStatus Method status of last action performed. If action succeeded, it should be TCG_METHOD_STATUS_CODE_SUCCESS.
**/
TCG_RESULT
EFIAPI
OpalAdminRevert(
OPAL_SESSION *LockingSpSession,
BOOLEAN KeepUserData,
UINT8 *MethodStatus
)
{
UINT8 Buf[BUFFER_SIZE];
TCG_CREATE_STRUCT CreateStruct;
UINT32 Size;
TCG_PARSE_STRUCT ParseStruct;
TCG_RESULT Ret;
NULL_CHECK(LockingSpSession);
NULL_CHECK(MethodStatus);
//
// ReadLocked or WriteLocked must be False (per Opal spec) to guarantee revertSP can keep user Data
//
if (KeepUserData) {
//
// set readlocked and writelocked to false
//
Ret = OpalUpdateGlobalLockingRange(
LockingSpSession,
FALSE,
FALSE,
MethodStatus);
if (Ret != TcgResultSuccess || *MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
//
// bail out
//
return Ret;
}
}
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buf, sizeof(Buf)));
ERROR_CHECK(TcgStartComPacket(&CreateStruct, LockingSpSession->OpalBaseComId, LockingSpSession->ComIdExtension));
ERROR_CHECK(TcgStartPacket(&CreateStruct, LockingSpSession->TperSessionId, LockingSpSession->HostSessionId, 0x0, 0x0, 0x0));
ERROR_CHECK(TcgStartSubPacket(&CreateStruct, 0x0));
ERROR_CHECK(TcgStartMethodCall(&CreateStruct, TCG_UID_THIS_SP, OPAL_LOCKING_SP_REVERTSP_METHOD));
ERROR_CHECK(TcgStartParameters(&CreateStruct));
if (KeepUserData) {
//
// optional parameter to keep Data after revert
//
ERROR_CHECK(TcgAddStartName(&CreateStruct));
ERROR_CHECK(TcgAddUINT32(&CreateStruct, 0x060000)); // weird Value but that's what spec says
ERROR_CHECK(TcgAddBOOLEAN(&CreateStruct, KeepUserData));
ERROR_CHECK(TcgAddEndName(&CreateStruct));
}
ERROR_CHECK(TcgEndParameters(&CreateStruct));
ERROR_CHECK(TcgEndMethodCall(&CreateStruct));
ERROR_CHECK(TcgEndSubPacket(&CreateStruct));
ERROR_CHECK(TcgEndPacket(&CreateStruct));
ERROR_CHECK(TcgEndComPacket(&CreateStruct, &Size));
//
// Send RevertSP method call
//
ERROR_CHECK(OpalPerformMethod(LockingSpSession, Size, Buf, sizeof(Buf), &ParseStruct, MethodStatus));
//
// Session is immediately ended by device after successful revertsp, so no need to end Session
//
if (*MethodStatus == TCG_METHOD_STATUS_CODE_SUCCESS) {
//
// Caller should take ownership again
//
return TcgResultSuccess;
} else {
//
// End Session
//
METHOD_STATUS_ERROR_CHECK(*MethodStatus, TcgResultSuccess); // exit with success on method failure - user must inspect MethodStatus
}
return TcgResultSuccess;
}
/**
The function activates the Locking SP.
Once activated, per Opal spec, the ADMIN SP SID PIN is copied over to the ADMIN1 LOCKING SP PIN.
If the Locking SP is already enabled, then TcgResultSuccess is returned and no action occurs.
@param[in] AdminSpSession OPAL_SESSION with OPAL_UID_ADMIN_SP as OPAL_ADMIN_SP_SID_AUTHORITY to activate Locking SP
@param[in/out] MethodStatus Method status of last action performed. If action succeeded, it should be TCG_METHOD_STATUS_CODE_SUCCESS.
**/
TCG_RESULT
EFIAPI
OpalActivateLockingSp(
OPAL_SESSION *AdminSpSession,
UINT8 *MethodStatus
)
{
UINT8 Buf[BUFFER_SIZE];
TCG_CREATE_STRUCT CreateStruct;
UINT32 Size;
TCG_PARSE_STRUCT ParseStruct;
NULL_CHECK(AdminSpSession);
NULL_CHECK(MethodStatus);
//
// Call Activate method on Locking SP
//
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buf, sizeof(Buf)));
ERROR_CHECK(TcgStartComPacket(&CreateStruct, AdminSpSession->OpalBaseComId, AdminSpSession->ComIdExtension));
ERROR_CHECK(TcgStartPacket(&CreateStruct, AdminSpSession->TperSessionId, AdminSpSession->HostSessionId, 0x0, 0x0, 0x0));
ERROR_CHECK(TcgStartSubPacket(&CreateStruct, 0x0));
ERROR_CHECK(TcgStartMethodCall(&CreateStruct, OPAL_UID_LOCKING_SP, OPAL_ADMIN_SP_ACTIVATE_METHOD));
ERROR_CHECK(TcgStartParameters(&CreateStruct));
ERROR_CHECK(TcgEndParameters(&CreateStruct));
ERROR_CHECK(TcgEndMethodCall(&CreateStruct));
ERROR_CHECK(TcgEndSubPacket(&CreateStruct));
ERROR_CHECK(TcgEndPacket(&CreateStruct));
ERROR_CHECK(TcgEndComPacket(&CreateStruct, &Size));
//
// Send Activate method call
//
ERROR_CHECK(OpalPerformMethod(AdminSpSession, Size, Buf, sizeof(Buf), &ParseStruct, MethodStatus));
METHOD_STATUS_ERROR_CHECK(*MethodStatus, TcgResultSuccess); // exit with success on method failure - user must inspect MethodStatus
return TcgResultSuccess;
}
/**
The function sets the PIN column of the specified cpinRowUid (authority) with the newPin Value.
@param[in/out] Session OPAL_SESSION to set password
@param[in] CpinRowUid UID of row (authority) to update PIN column
@param[in] NewPin New Pin to set for cpinRowUid specified
@param[in] NewPinLength Length in bytes of newPin
@param[in/out] MethodStatus Method status of last action performed. If action succeeded, it should be TCG_METHOD_STATUS_CODE_SUCCESS.
**/
TCG_RESULT
EFIAPI
OpalSetPassword(
OPAL_SESSION *Session,
TCG_UID CpinRowUid,
const VOID *NewPin,
UINT32 NewPinLength,
UINT8 *MethodStatus
)
{
UINT8 Buf[BUFFER_SIZE];
TCG_CREATE_STRUCT CreateStruct;
TCG_PARSE_STRUCT ParseStruct;
UINT32 Size;
NULL_CHECK(Session);
NULL_CHECK(NewPin);
NULL_CHECK(MethodStatus);
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buf, sizeof(Buf)));
ERROR_CHECK(TcgCreateSetCPin(
&CreateStruct,
&Size,
Session->OpalBaseComId,
Session->ComIdExtension,
Session->TperSessionId,
Session->HostSessionId,
CpinRowUid,
NewPin,
NewPinLength
));
ERROR_CHECK(OpalPerformMethod(Session, Size, Buf, sizeof(Buf), &ParseStruct, MethodStatus));
// exit with success on method failure - user must inspect MethodStatus
METHOD_STATUS_ERROR_CHECK(*MethodStatus, TcgResultSuccess);
return TcgResultSuccess;
}
/**
The function sets the Enabled column to TRUE for the authorityUid provided and updates the PIN column for the cpinRowUid provided
using the newPin provided. AuthorityUid and cpinRowUid should describe the same authority.
@param[in] LockingSpSession OPAL_SESSION with OPAL_UID_LOCKING_SP as OPAL_LOCKING_SP_ADMIN1_AUTHORITY to update
@param[in] CpinRowUid Row UID of C_PIN table of Locking SP to update PIN
@param[in] AuthorityUid UID of Locking SP authority to update Pin column with
@param[in] NewPin New Password used to set Pin column
@param[in] NewPinLength Length in bytes of new password
@param[in/out] MethodStatus Method status of last action performed. If action succeeded, it should be TCG_METHOD_STATUS_CODE_SUCCESS.
**/
TCG_RESULT
EFIAPI
OpalSetLockingSpAuthorityEnabledAndPin(
OPAL_SESSION *LockingSpSession,
TCG_UID CpinRowUid,
TCG_UID AuthorityUid,
const VOID *NewPin,
UINT32 NewPinLength,
UINT8 *MethodStatus
)
{
UINT8 Buf[BUFFER_SIZE];
TCG_CREATE_STRUCT CreateStruct;
TCG_PARSE_STRUCT ParseStruct;
UINT32 Size;
TCG_UID ActiveKey;
TCG_RESULT Ret;
NULL_CHECK(LockingSpSession);
NULL_CHECK(NewPin);
NULL_CHECK(MethodStatus);
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buf, sizeof(Buf)));
ERROR_CHECK(TcgSetAuthorityEnabled(
&CreateStruct,
&Size,
LockingSpSession->OpalBaseComId,
LockingSpSession->ComIdExtension,
LockingSpSession->TperSessionId,
LockingSpSession->HostSessionId,
AuthorityUid,
TRUE));
ERROR_CHECK(OpalPerformMethod(LockingSpSession, Size, Buf, sizeof(Buf), &ParseStruct, MethodStatus));
if (*MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
DEBUG ((DEBUG_INFO, "Send Set Authority error\n"));
return TcgResultFailure;
}
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buf, sizeof(Buf)));
ERROR_CHECK(TcgCreateSetCPin(
&CreateStruct,
&Size,
LockingSpSession->OpalBaseComId,
LockingSpSession->ComIdExtension,
LockingSpSession->TperSessionId,
LockingSpSession->HostSessionId,
CpinRowUid,
NewPin,
NewPinLength));
ERROR_CHECK(OpalPerformMethod(LockingSpSession, Size, Buf, sizeof(Buf), &ParseStruct, MethodStatus));
//
// allow user1 to set global range to unlocked/locked by modifying ACE_Locking_GlobalRange_SetRdLocked/SetWrLocked
//
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buf, sizeof(Buf)));
ERROR_CHECK(TcgCreateSetAce(
&CreateStruct,
&Size,
LockingSpSession->OpalBaseComId,
LockingSpSession->ComIdExtension,
LockingSpSession->TperSessionId,
LockingSpSession->HostSessionId,
OPAL_LOCKING_SP_ACE_LOCKING_GLOBALRANGE_SET_RDLOCKED,
OPAL_LOCKING_SP_USER1_AUTHORITY,
TCG_ACE_EXPRESSION_OR,
OPAL_LOCKING_SP_ADMINS_AUTHORITY
));
ERROR_CHECK(OpalPerformMethod(LockingSpSession, Size, Buf, sizeof(Buf), &ParseStruct, MethodStatus));
if (*MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
DEBUG ((DEBUG_INFO, "Update ACE for RDLOCKED failed\n"));
return TcgResultFailure;
}
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buf, sizeof(Buf)));
ERROR_CHECK(TcgCreateSetAce(
&CreateStruct,
&Size,
LockingSpSession->OpalBaseComId,
LockingSpSession->ComIdExtension,
LockingSpSession->TperSessionId,
LockingSpSession->HostSessionId,
OPAL_LOCKING_SP_ACE_LOCKING_GLOBALRANGE_SET_WRLOCKED,
OPAL_LOCKING_SP_USER1_AUTHORITY,
TCG_ACE_EXPRESSION_OR,
OPAL_LOCKING_SP_ADMINS_AUTHORITY
));
ERROR_CHECK(OpalPerformMethod(LockingSpSession, Size, Buf, sizeof(Buf), &ParseStruct, MethodStatus));
if (*MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
DEBUG ((DEBUG_INFO, "Update ACE for WRLOCKED failed\n"));
return TcgResultFailure;
}
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buf, sizeof(Buf)));
ERROR_CHECK(OpalCreateRetrieveGlobalLockingRangeActiveKey(LockingSpSession, &CreateStruct, &Size));
ERROR_CHECK(OpalPerformMethod(LockingSpSession, Size, Buf, sizeof(Buf), &ParseStruct, MethodStatus));
//
// For Pyrite type SSC, it not supports Active Key.
// So here add check logic before enable it.
//
Ret = OpalParseRetrieveGlobalLockingRangeActiveKey(&ParseStruct, &ActiveKey);
if (Ret == TcgResultSuccess) {
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buf, sizeof(Buf)));
ERROR_CHECK(TcgCreateSetAce(
&CreateStruct,
&Size,
LockingSpSession->OpalBaseComId,
LockingSpSession->ComIdExtension,
LockingSpSession->TperSessionId,
LockingSpSession->HostSessionId,
(ActiveKey == OPAL_LOCKING_SP_K_AES_256_GLOBALRANGE_KEY) ? OPAL_LOCKING_SP_ACE_K_AES_256_GLOBALRANGE_GENKEY : OPAL_LOCKING_SP_ACE_K_AES_128_GLOBALRANGE_GENKEY,
OPAL_LOCKING_SP_USER1_AUTHORITY,
TCG_ACE_EXPRESSION_OR,
OPAL_LOCKING_SP_ADMINS_AUTHORITY
));
ERROR_CHECK(OpalPerformMethod(LockingSpSession, Size, Buf, sizeof(Buf), &ParseStruct, MethodStatus));
if (*MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
DEBUG ((DEBUG_INFO, "Update ACE for GLOBALRANGE_GENKEY failed\n"));
//
// TODO do we want to disable user1 if all permissions are not granted
//
return TcgResultFailure;
}
}
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buf, sizeof(Buf)));
ERROR_CHECK(TcgCreateSetAce(
&CreateStruct,
&Size,
LockingSpSession->OpalBaseComId,
LockingSpSession->ComIdExtension,
LockingSpSession->TperSessionId,
LockingSpSession->HostSessionId,
OPAL_LOCKING_SP_ACE_LOCKING_GLOBALRANGE_GET_ALL,
OPAL_LOCKING_SP_USER1_AUTHORITY,
TCG_ACE_EXPRESSION_OR,
OPAL_LOCKING_SP_ADMINS_AUTHORITY
));
ERROR_CHECK(OpalPerformMethod(LockingSpSession, Size, Buf, sizeof(Buf), &ParseStruct, MethodStatus));
if (*MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
DEBUG ((DEBUG_INFO, "Update ACE for OPAL_LOCKING_SP_ACE_LOCKING_GLOBALRANGE_GET_ALL failed\n"));
return TcgResultFailure;
}
return TcgResultSuccess;
}
/**
The function sets the Enabled column to FALSE for the USER1 authority.
@param[in] LockingSpSession OPAL_SESSION with OPAL_UID_LOCKING_SP as OPAL_LOCKING_SP_ADMIN1_AUTHORITY to disable User1
@param[in/out] MethodStatus Method status of last action performed. If action succeeded, it should be TCG_METHOD_STATUS_CODE_SUCCESS.
**/
TCG_RESULT
EFIAPI
OpalDisableUser(
OPAL_SESSION *LockingSpSession,
UINT8 *MethodStatus
)
{
UINT8 Buf[BUFFER_SIZE];
TCG_CREATE_STRUCT CreateStruct;
TCG_PARSE_STRUCT ParseStruct;
UINT32 Size;
NULL_CHECK(LockingSpSession);
NULL_CHECK(MethodStatus);
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buf, sizeof(Buf)));
ERROR_CHECK(TcgSetAuthorityEnabled(
&CreateStruct,
&Size,
LockingSpSession->OpalBaseComId,
LockingSpSession->ComIdExtension,
LockingSpSession->TperSessionId,
LockingSpSession->HostSessionId,
OPAL_LOCKING_SP_USER1_AUTHORITY,
FALSE));
ERROR_CHECK(OpalPerformMethod(LockingSpSession, Size, Buf, sizeof(Buf), &ParseStruct, MethodStatus));
return TcgResultSuccess;
}
/**
The function retrieves the active key of the global locking range
and calls the GenKey method on the active key retrieved.
@param[in] LockingSpSession OPAL_SESSION with OPAL_UID_LOCKING_SP to generate key
@param[in/out] MethodStatus Method status of last action performed. If action succeeded, it should be TCG_METHOD_STATUS_CODE_SUCCESS.
**/
TCG_RESULT
EFIAPI
OpalGlobalLockingRangeGenKey(
OPAL_SESSION *LockingSpSession,
UINT8 *MethodStatus
)
{
UINT8 Buf[BUFFER_SIZE];
TCG_CREATE_STRUCT CreateStruct;
TCG_PARSE_STRUCT ParseStruct;
UINT32 Size;
TCG_UID ActiveKey;
NULL_CHECK(LockingSpSession);
NULL_CHECK(MethodStatus);
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buf, sizeof(Buf)));
//
// retrieve the activekey in order to know which globalrange key to generate
//
ERROR_CHECK(OpalCreateRetrieveGlobalLockingRangeActiveKey(LockingSpSession, &CreateStruct, &Size));
ERROR_CHECK(OpalPerformMethod(LockingSpSession, Size, Buf, sizeof(Buf), &ParseStruct, MethodStatus));
METHOD_STATUS_ERROR_CHECK(*MethodStatus, TcgResultSuccess);
ERROR_CHECK(OpalParseRetrieveGlobalLockingRangeActiveKey(&ParseStruct, &ActiveKey));
//
// call genkey on ActiveKey UID
//
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buf, sizeof(Buf)));
ERROR_CHECK(TcgStartComPacket(&CreateStruct, LockingSpSession->OpalBaseComId, LockingSpSession->ComIdExtension));
ERROR_CHECK(TcgStartPacket(&CreateStruct, LockingSpSession->TperSessionId, LockingSpSession->HostSessionId, 0x0, 0x0, 0x0));
ERROR_CHECK(TcgStartSubPacket(&CreateStruct, 0x0));
ERROR_CHECK(TcgStartMethodCall(&CreateStruct, ActiveKey, TCG_UID_METHOD_GEN_KEY));
ERROR_CHECK(TcgStartParameters(&CreateStruct));
ERROR_CHECK(TcgEndParameters(&CreateStruct));
ERROR_CHECK(TcgEndMethodCall(&CreateStruct));
ERROR_CHECK(TcgEndSubPacket(&CreateStruct));
ERROR_CHECK(TcgEndPacket(&CreateStruct));
ERROR_CHECK(TcgEndComPacket(&CreateStruct, &Size));
ERROR_CHECK(OpalPerformMethod(LockingSpSession, Size, Buf, sizeof(Buf), &ParseStruct, MethodStatus));
return TcgResultSuccess;
}
/**
The function updates the ReadLocked and WriteLocked columns of the Global Locking Range.
This funciton is required for a user1 authority, since a user1 authority shall only have access to ReadLocked and WriteLocked columns
(not ReadLockEnabled and WriteLockEnabled columns).
@param[in] LockingSpSession OPAL_SESSION with OPAL_UID_LOCKING_SP to generate key
@param[in] ReadLocked Value to set ReadLocked column for Global Locking Range
@param[in] WriteLocked Value to set WriteLocked column for Global Locking Range
@param[in/out] MethodStatus Method status of last action performed. If action succeeded, it should be TCG_METHOD_STATUS_CODE_SUCCESS.
**/
TCG_RESULT
EFIAPI
OpalUpdateGlobalLockingRange(
OPAL_SESSION *LockingSpSession,
BOOLEAN ReadLocked,
BOOLEAN WriteLocked,
UINT8 *MethodStatus
)
{
UINT8 Buf[BUFFER_SIZE];
TCG_CREATE_STRUCT CreateStruct;
TCG_PARSE_STRUCT ParseStruct;
UINT32 Size;
NULL_CHECK(LockingSpSession);
NULL_CHECK(MethodStatus);
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buf, sizeof(Buf)));
//
// set global locking range values
//
ERROR_CHECK(TcgStartComPacket(&CreateStruct, LockingSpSession->OpalBaseComId, LockingSpSession->ComIdExtension));
ERROR_CHECK(TcgStartPacket(&CreateStruct, LockingSpSession->TperSessionId, LockingSpSession->HostSessionId, 0x0, 0x0, 0x0));
ERROR_CHECK(TcgStartSubPacket(&CreateStruct, 0x0));
ERROR_CHECK(TcgStartMethodCall(&CreateStruct, OPAL_LOCKING_SP_LOCKING_GLOBALRANGE, TCG_UID_METHOD_SET));
ERROR_CHECK(TcgStartParameters(&CreateStruct));
ERROR_CHECK(TcgAddStartName(&CreateStruct));
ERROR_CHECK(TcgAddUINT8(&CreateStruct, 0x01)); // "Values"
ERROR_CHECK(TcgAddStartList(&CreateStruct));
ERROR_CHECK(TcgAddStartName(&CreateStruct));
ERROR_CHECK(TcgAddUINT8(&CreateStruct, 0x07)); // "ReadLocked"
ERROR_CHECK(TcgAddBOOLEAN(&CreateStruct, ReadLocked));
ERROR_CHECK(TcgAddEndName(&CreateStruct));
ERROR_CHECK(TcgAddStartName(&CreateStruct));
ERROR_CHECK(TcgAddUINT8(&CreateStruct, 0x08)); // "WriteLocked"
ERROR_CHECK(TcgAddBOOLEAN(&CreateStruct, WriteLocked));
ERROR_CHECK(TcgAddEndName(&CreateStruct));
ERROR_CHECK(TcgAddEndList(&CreateStruct));
ERROR_CHECK(TcgAddEndName(&CreateStruct));
ERROR_CHECK(TcgEndParameters(&CreateStruct));
ERROR_CHECK(TcgEndMethodCall(&CreateStruct));
ERROR_CHECK(TcgEndSubPacket(&CreateStruct));
ERROR_CHECK(TcgEndPacket(&CreateStruct));
ERROR_CHECK(TcgEndComPacket(&CreateStruct, &Size));
ERROR_CHECK(OpalPerformMethod(LockingSpSession, Size, Buf, sizeof(Buf), &ParseStruct, MethodStatus));
METHOD_STATUS_ERROR_CHECK(*MethodStatus, TcgResultSuccess);
return TcgResultSuccess;
}
/**
The function updates the RangeStart, RangeLength, ReadLockedEnabled, WriteLockedEnabled, ReadLocked and WriteLocked columns
of the specified Locking Range. This function requires admin authority of a locking SP session.
@param[in] LockingSpSession OPAL_SESSION with OPAL_UID_LOCKING_SP to generate key
@param[in] LockingRangeUid Locking range UID to set values
@param[in] RangeStart Value to set RangeStart column for Locking Range
@param[in] RangeLength Value to set RangeLength column for Locking Range
@param[in] ReadLockEnabled Value to set readLockEnabled column for Locking Range
@param[in] WriteLockEnabled Value to set writeLockEnabled column for Locking Range
@param[in] ReadLocked Value to set ReadLocked column for Locking Range
@param[in] WriteLocked Value to set WriteLocked column for Locking Range
@param[in/out] MethodStatus Method status of last action performed. If action succeeded, it should be TCG_METHOD_STATUS_CODE_SUCCESS.
**/
TCG_RESULT
EFIAPI
OpalSetLockingRange(
OPAL_SESSION *LockingSpSession,
TCG_UID LockingRangeUid,
UINT64 RangeStart,
UINT64 RangeLength,
BOOLEAN ReadLockEnabled,
BOOLEAN WriteLockEnabled,
BOOLEAN ReadLocked,
BOOLEAN WriteLocked,
UINT8 *MethodStatus
)
{
UINT8 Buf[BUFFER_SIZE];
TCG_CREATE_STRUCT CreateStruct;
TCG_PARSE_STRUCT ParseStruct;
UINT32 Size;
NULL_CHECK(LockingSpSession);
NULL_CHECK(MethodStatus);
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buf, sizeof(Buf)));
//
// set locking range values
//
ERROR_CHECK(TcgStartComPacket(&CreateStruct, LockingSpSession->OpalBaseComId, LockingSpSession->ComIdExtension));
ERROR_CHECK(TcgStartPacket(&CreateStruct, LockingSpSession->TperSessionId, LockingSpSession->HostSessionId, 0x0, 0x0, 0x0));
ERROR_CHECK(TcgStartSubPacket(&CreateStruct, 0x0));
ERROR_CHECK(TcgStartMethodCall(&CreateStruct, LockingRangeUid, TCG_UID_METHOD_SET));
ERROR_CHECK(TcgStartParameters(&CreateStruct));
ERROR_CHECK(TcgAddStartName(&CreateStruct));
ERROR_CHECK(TcgAddUINT8(&CreateStruct, 0x01)); // "Values"
ERROR_CHECK(TcgAddStartList(&CreateStruct));
//
// range start and range Length only apply to non-global locking ranges
//
if (LockingRangeUid != OPAL_LOCKING_SP_LOCKING_GLOBALRANGE) {
ERROR_CHECK(TcgAddStartName(&CreateStruct));
ERROR_CHECK(TcgAddUINT8(&CreateStruct, 0x03)); // "RangeStart"
ERROR_CHECK(TcgAddUINT64(&CreateStruct, RangeStart));
ERROR_CHECK(TcgAddEndName(&CreateStruct));
ERROR_CHECK(TcgAddStartName(&CreateStruct));
ERROR_CHECK(TcgAddUINT8(&CreateStruct, 0x04)); // "RangeLength"
ERROR_CHECK(TcgAddUINT64(&CreateStruct, RangeLength));
ERROR_CHECK(TcgAddEndName(&CreateStruct));
}
ERROR_CHECK(TcgAddStartName(&CreateStruct));
ERROR_CHECK(TcgAddUINT8(&CreateStruct, 0x05)); // "ReadLockEnabled"
ERROR_CHECK(TcgAddBOOLEAN(&CreateStruct, ReadLockEnabled));
ERROR_CHECK(TcgAddEndName(&CreateStruct));
ERROR_CHECK(TcgAddStartName(&CreateStruct));
ERROR_CHECK(TcgAddUINT8(&CreateStruct, 0x06)); // "WriteLockEnabled"
ERROR_CHECK(TcgAddBOOLEAN(&CreateStruct, WriteLockEnabled));
ERROR_CHECK(TcgAddEndName(&CreateStruct));
ERROR_CHECK(TcgAddStartName(&CreateStruct));
ERROR_CHECK(TcgAddUINT8(&CreateStruct, 0x07)); // "ReadLocked"
ERROR_CHECK(TcgAddBOOLEAN(&CreateStruct, ReadLocked));
ERROR_CHECK(TcgAddEndName(&CreateStruct));
ERROR_CHECK(TcgAddStartName(&CreateStruct));
ERROR_CHECK(TcgAddUINT8(&CreateStruct, 0x08)); // "WriteLocked"
ERROR_CHECK(TcgAddBOOLEAN(&CreateStruct, WriteLocked));
ERROR_CHECK(TcgAddEndName(&CreateStruct));
ERROR_CHECK(TcgAddEndList(&CreateStruct));
ERROR_CHECK(TcgAddEndName(&CreateStruct));
ERROR_CHECK(TcgEndParameters(&CreateStruct));
ERROR_CHECK(TcgEndMethodCall(&CreateStruct));
ERROR_CHECK(TcgEndSubPacket(&CreateStruct));
ERROR_CHECK(TcgEndPacket(&CreateStruct));
ERROR_CHECK(TcgEndComPacket(&CreateStruct, &Size));
ERROR_CHECK(OpalPerformMethod(LockingSpSession, Size, Buf, sizeof(Buf), &ParseStruct, MethodStatus));
// Exit with success on method failure - user must inspect MethodStatus
METHOD_STATUS_ERROR_CHECK(*MethodStatus, TcgResultSuccess);
return TcgResultSuccess;
}
/**
The function populates the CreateStruct with a payload that will retrieve the global locking range active key.
It is intended to be called with a session that is already started with a valid credential.
The function does not send the payload.
@param[in] Session OPAL_SESSION to populate command for, needs ComId
@param[in/out] CreateStruct Structure to populate with encoded TCG command
@param[in/out] Size Size in bytes of the command created.
**/
TCG_RESULT
EFIAPI
OpalCreateRetrieveGlobalLockingRangeActiveKey(
const OPAL_SESSION *Session,
TCG_CREATE_STRUCT *CreateStruct,
UINT32 *Size
)
{
NULL_CHECK(Session);
NULL_CHECK(CreateStruct);
NULL_CHECK(Size);
// Retrieve the activekey in order to know which globalrange key to generate
ERROR_CHECK(TcgStartComPacket(CreateStruct, Session->OpalBaseComId, Session->ComIdExtension));
ERROR_CHECK(TcgStartPacket(CreateStruct, Session->TperSessionId, Session->HostSessionId, 0x0, 0x0, 0x0));
ERROR_CHECK(TcgStartSubPacket(CreateStruct, 0x0));
ERROR_CHECK(TcgStartMethodCall(CreateStruct, OPAL_LOCKING_SP_LOCKING_GLOBALRANGE, TCG_UID_METHOD_GET));
ERROR_CHECK(TcgStartParameters(CreateStruct));
ERROR_CHECK(TcgAddStartList(CreateStruct));
ERROR_CHECK(TcgAddStartName(CreateStruct));
ERROR_CHECK(TcgAddUINT8(CreateStruct, TCG_CELL_BLOCK_START_COLUMN_NAME));
ERROR_CHECK(TcgAddUINT8(CreateStruct, 0x0A)); // ActiveKey
ERROR_CHECK(TcgAddEndName(CreateStruct));
ERROR_CHECK(TcgAddStartName(CreateStruct));
ERROR_CHECK(TcgAddUINT8(CreateStruct, TCG_CELL_BLOCK_END_COLUMN_NAME));
ERROR_CHECK(TcgAddUINT8(CreateStruct, 0x0A));
ERROR_CHECK(TcgAddEndName(CreateStruct));
ERROR_CHECK(TcgAddEndList(CreateStruct));
ERROR_CHECK(TcgEndParameters(CreateStruct));
ERROR_CHECK(TcgEndMethodCall(CreateStruct));
ERROR_CHECK(TcgEndSubPacket(CreateStruct));
ERROR_CHECK(TcgEndPacket(CreateStruct));
ERROR_CHECK(TcgEndComPacket(CreateStruct, Size));
return TcgResultSuccess;
}
/**
The function acquires the activeKey specified for the Global Locking Range from the ParseStruct.
@param[in] ParseStruct Structure that contains the device's response with the activekey
@param[in/out] ActiveKey The UID of the active key retrieved
**/
TCG_RESULT
EFIAPI
OpalParseRetrieveGlobalLockingRangeActiveKey(
TCG_PARSE_STRUCT *ParseStruct,
TCG_UID *ActiveKey
)
{
UINT32 ColumnName;
NULL_CHECK(ParseStruct);
NULL_CHECK(ActiveKey);
// parse response
ERROR_CHECK(TcgGetNextStartList(ParseStruct));
ERROR_CHECK(TcgGetNextStartList(ParseStruct));
ERROR_CHECK(TcgGetNextStartName(ParseStruct));
ERROR_CHECK(TcgGetNextUINT32(ParseStruct, &ColumnName));
ERROR_CHECK(TcgGetNextTcgUid(ParseStruct, ActiveKey));
ERROR_CHECK(TcgGetNextEndName(ParseStruct));
ERROR_CHECK(TcgGetNextEndList(ParseStruct));
ERROR_CHECK(TcgGetNextEndList(ParseStruct));
ERROR_CHECK(TcgGetNextEndOfData(ParseStruct));
if (ColumnName != 0x0A) {
DEBUG ((DEBUG_INFO, "Unexpected column name %u (exp 0x0A)\n", ColumnName));
return TcgResultFailure;
}
if (*ActiveKey != OPAL_LOCKING_SP_K_AES_256_GLOBALRANGE_KEY && *ActiveKey != OPAL_LOCKING_SP_K_AES_128_GLOBALRANGE_KEY) {
DEBUG ((DEBUG_INFO, "Unexpected gen key %u (exp %u or %u)\n", *ActiveKey, OPAL_LOCKING_SP_K_AES_256_GLOBALRANGE_KEY, OPAL_LOCKING_SP_K_AES_128_GLOBALRANGE_KEY));
return TcgResultFailure;
}
return TcgResultSuccess;
}
/**
The function retrieves the TryLimit column for the specified rowUid (authority).
@param[in] LockingSpSession OPAL_SESSION with OPAL_UID_LOCKING_SP to retrieve try limit
@param[in] RowUid Row UID of the Locking SP C_PIN table to retrieve TryLimit column
@param[in/out] TryLimit Value from TryLimit column
**/
TCG_RESULT
EFIAPI
OpalGetTryLimit(
OPAL_SESSION *LockingSpSession,
TCG_UID RowUid,
UINT32 *TryLimit
)
{
TCG_CREATE_STRUCT CreateStruct;
TCG_PARSE_STRUCT ParseStruct;
UINT32 Size;
UINT8 MethodStatus;
UINT8 Buf[BUFFER_SIZE];
UINT32 Col;
NULL_CHECK(LockingSpSession);
NULL_CHECK(TryLimit);
ERROR_CHECK(TcgInitTcgCreateStruct(&CreateStruct, Buf, sizeof(Buf)));
ERROR_CHECK(TcgStartComPacket(&CreateStruct, LockingSpSession->OpalBaseComId, LockingSpSession->ComIdExtension));
ERROR_CHECK(TcgStartPacket(&CreateStruct, LockingSpSession->TperSessionId, LockingSpSession->HostSessionId, 0x0, 0x0, 0x0));
ERROR_CHECK(TcgStartSubPacket(&CreateStruct, 0x0));
ERROR_CHECK(TcgStartMethodCall(&CreateStruct, RowUid, TCG_UID_METHOD_GET));
ERROR_CHECK(TcgStartParameters(&CreateStruct));
ERROR_CHECK(TcgAddStartList(&CreateStruct));
ERROR_CHECK(TcgAddStartName(&CreateStruct));
ERROR_CHECK(TcgAddUINT8(&CreateStruct, TCG_CELL_BLOCK_START_COLUMN_NAME));
ERROR_CHECK(TcgAddUINT8(&CreateStruct, OPAL_LOCKING_SP_C_PIN_TRYLIMIT_COL));
ERROR_CHECK(TcgAddEndName(&CreateStruct));
ERROR_CHECK(TcgAddStartName(&CreateStruct));
ERROR_CHECK(TcgAddUINT8(&CreateStruct, TCG_CELL_BLOCK_END_COLUMN_NAME));
ERROR_CHECK(TcgAddUINT8(&CreateStruct, OPAL_LOCKING_SP_C_PIN_TRYLIMIT_COL));
ERROR_CHECK(TcgAddEndName(&CreateStruct));
ERROR_CHECK(TcgAddEndList(&CreateStruct));
ERROR_CHECK(TcgEndParameters(&CreateStruct));
ERROR_CHECK(TcgEndMethodCall(&CreateStruct));
ERROR_CHECK(TcgEndSubPacket(&CreateStruct));
ERROR_CHECK(TcgEndPacket(&CreateStruct));
ERROR_CHECK(TcgEndComPacket(&CreateStruct, &Size));
ERROR_CHECK(OpalPerformMethod(LockingSpSession, Size, Buf, sizeof(Buf), &ParseStruct, &MethodStatus));
METHOD_STATUS_ERROR_CHECK(MethodStatus, TcgResultFailure);
ERROR_CHECK(TcgGetNextStartList(&ParseStruct));
ERROR_CHECK(TcgGetNextStartList(&ParseStruct));
ERROR_CHECK(TcgGetNextStartName(&ParseStruct));
ERROR_CHECK(TcgGetNextUINT32(&ParseStruct, &Col));
ERROR_CHECK(TcgGetNextUINT32(&ParseStruct, TryLimit));
ERROR_CHECK(TcgGetNextEndName(&ParseStruct));
ERROR_CHECK(TcgGetNextEndList(&ParseStruct));
ERROR_CHECK(TcgGetNextEndList(&ParseStruct));
ERROR_CHECK(TcgGetNextEndOfData(&ParseStruct));
if (Col != OPAL_LOCKING_SP_C_PIN_TRYLIMIT_COL) {
DEBUG ((DEBUG_INFO, "ERROR: got col %u, expected %u\n", Col, OPAL_LOCKING_SP_C_PIN_TRYLIMIT_COL));
return TcgResultFailure;
}
return TcgResultSuccess;
}
/**
Get the support attribute info.
@param[in] Session OPAL_SESSION with OPAL_UID_LOCKING_SP to retrieve info.
@param[out] SupportedAttributes Return the support attribute info.
@param[out] OpalBaseComId Return the base com id info.
**/
TCG_RESULT
EFIAPI
OpalGetSupportedAttributesInfo(
IN OPAL_SESSION *Session,
OUT OPAL_DISK_SUPPORT_ATTRIBUTE *SupportedAttributes,
OUT UINT16 *OpalBaseComId
)
{
UINT8 Buffer[BUFFER_SIZE];
TCG_SUPPORTED_SECURITY_PROTOCOLS *SupportedProtocols;
TCG_LEVEL0_DISCOVERY_HEADER *DiscoveryHeader;
OPAL_LEVEL0_FEATURE_DESCRIPTOR *Feat;
UINTN Size;
NULL_CHECK(Session);
NULL_CHECK(SupportedAttributes);
NULL_CHECK(OpalBaseComId);
ZeroMem(Buffer, BUFFER_SIZE);
ASSERT(sizeof(Buffer) >= sizeof(TCG_SUPPORTED_SECURITY_PROTOCOLS));
//
// Retrieve supported protocols verify security protocol 1 is supported
//
SupportedProtocols = (TCG_SUPPORTED_SECURITY_PROTOCOLS*) Buffer;
//
// Get list of supported protocols
//
if (OpalRetrieveSupportedProtocolList (Session, sizeof(TCG_SUPPORTED_SECURITY_PROTOCOLS), SupportedProtocols) == TcgResultFailure) {
DEBUG ((DEBUG_INFO, "OpalRetrieveSupportedProtocolList failed\n"));
return TcgResultFailure;
}
SupportedAttributes->Sp1 = TcgIsProtocolSupported (SupportedProtocols, TCG_OPAL_SECURITY_PROTOCOL_1);
SupportedAttributes->Sp2 = TcgIsProtocolSupported (SupportedProtocols, TCG_OPAL_SECURITY_PROTOCOL_2);
SupportedAttributes->SpIeee1667 = TcgIsProtocolSupported (SupportedProtocols, TCG_SECURITY_PROTOCOL_IEEE_1667);
DEBUG ((DEBUG_INFO, "Supported Protocols: Sp1 %d Sp2: %d SpIeee1667 %d \n",
SupportedAttributes->Sp1,
SupportedAttributes->Sp2,
SupportedAttributes->SpIeee1667
));
//
// Perform level 0 discovery and assign desired feature info to Opal Disk structure
//
ZeroMem (Buffer, BUFFER_SIZE);
if (OpalRetrieveLevel0DiscoveryHeader (Session, BUFFER_SIZE, Buffer) == TcgResultFailure) {
DEBUG ((DEBUG_INFO, "OpalRetrieveLevel0DiscoveryHeader failed\n"));
return TcgResultFailure;
}
//
// Check for required feature descriptors
//
DiscoveryHeader = (TCG_LEVEL0_DISCOVERY_HEADER*) Buffer;
Size = 0;
Feat = (OPAL_LEVEL0_FEATURE_DESCRIPTOR*) TcgGetFeature (DiscoveryHeader, TCG_FEATURE_OPAL_SSC_V2_0_0, &Size);
SupportedAttributes->OpalSsc2 = (Feat != NULL);
*OpalBaseComId = TCG_RESERVED_COMID;
//
// Check Opal SCC V2 has valid settings for SID C_PIN on revert
//
if (SupportedAttributes->OpalSsc2 && Size >= sizeof (OPAL_SSCV2_FEATURE_DESCRIPTOR)) {
//
// Want opposite polarity b/c Value is greater than a bit, but we only care about non-zero vs zero
//
SupportedAttributes->InitCpinIndicator = (Feat->OpalSscV2.InitialCPINSIDPIN == 0);
SupportedAttributes->CpinUponRevert = (Feat->OpalSscV2.CPINSIDPINRevertBehavior == 0);
DEBUG ((DEBUG_INFO, "Opal SSC V2 InitCpinIndicator %d CpinUponRevert %d \n",
SupportedAttributes->InitCpinIndicator,
SupportedAttributes->CpinUponRevert
));
*OpalBaseComId = SwapBytes16 (Feat->OpalSscV2.BaseComdIdBE);
}
Size = 0;
Feat = (OPAL_LEVEL0_FEATURE_DESCRIPTOR*) TcgGetFeature (DiscoveryHeader, TCG_FEATURE_OPAL_SSC_LITE, &Size);
SupportedAttributes->OpalSscLite = (Feat != NULL);
if (Feat != NULL && Size >= sizeof (OPAL_SSCLITE_FEATURE_DESCRIPTOR)) {
if (*OpalBaseComId == TCG_RESERVED_COMID) {
//
// Pin values used always match up with ComId used
//
*OpalBaseComId = SwapBytes16 (Feat->OpalSscLite.BaseComdIdBE);
SupportedAttributes->InitCpinIndicator = (Feat->OpalSscV2.InitialCPINSIDPIN == 0);
SupportedAttributes->CpinUponRevert = (Feat->OpalSscV2.CPINSIDPINRevertBehavior == 0);
DEBUG ((DEBUG_INFO, "Opal SSC Lite InitCpinIndicator %d CpinUponRevert %d \n",
SupportedAttributes->InitCpinIndicator,
SupportedAttributes->CpinUponRevert
));
}
}
Size = 0;
Feat = (OPAL_LEVEL0_FEATURE_DESCRIPTOR*) TcgGetFeature (DiscoveryHeader, TCG_FEATURE_PYRITE_SSC, &Size);
SupportedAttributes->PyriteSsc = (Feat != NULL);
if (Feat != NULL && Size >= sizeof (PYRITE_SSC_FEATURE_DESCRIPTOR)) {
if (*OpalBaseComId == TCG_RESERVED_COMID) {
*OpalBaseComId = SwapBytes16 (Feat->PyriteSsc.BaseComdIdBE);
SupportedAttributes->InitCpinIndicator = (Feat->PyriteSsc.InitialCPINSIDPIN == 0);
SupportedAttributes->CpinUponRevert = (Feat->PyriteSsc.CPINSIDPINRevertBehavior == 0);
DEBUG ((DEBUG_INFO, "Pyrite SSC InitCpinIndicator %d CpinUponRevert %d \n",
SupportedAttributes->InitCpinIndicator,
SupportedAttributes->CpinUponRevert
));
}
}
Size = 0;
Feat = (OPAL_LEVEL0_FEATURE_DESCRIPTOR*) TcgGetFeature (DiscoveryHeader, TCG_FEATURE_OPAL_SSC_V1_0_0, &Size);
SupportedAttributes->OpalSsc1 = (Feat != NULL);
if (Feat != NULL && Size >= sizeof (OPAL_SSCV1_FEATURE_DESCRIPTOR)) {
if (*OpalBaseComId == TCG_RESERVED_COMID) {
*OpalBaseComId = SwapBytes16 (Feat->OpalSscV1.BaseComdIdBE);
}
}
Size = 0;
Feat = (OPAL_LEVEL0_FEATURE_DESCRIPTOR*) TcgGetFeature (DiscoveryHeader, TCG_FEATURE_LOCKING, &Size);
if (Feat != NULL && Size >= sizeof (TCG_LOCKING_FEATURE_DESCRIPTOR)) {
SupportedAttributes->MediaEncryption = Feat->Locking.MediaEncryption;
}
Size = 0;
Feat = (OPAL_LEVEL0_FEATURE_DESCRIPTOR*) TcgGetFeature (DiscoveryHeader, TCG_FEATURE_BLOCK_SID, &Size);
if (Feat != NULL && Size >= sizeof (TCG_BLOCK_SID_FEATURE_DESCRIPTOR)) {
SupportedAttributes->BlockSid = TRUE;
}
DEBUG ((DEBUG_INFO, "Base COMID 0x%04X \n", *OpalBaseComId));
return TcgResultSuccess;
}
/**
Get the support attribute info.
@param[in] Session OPAL_SESSION with OPAL_UID_LOCKING_SP to retrieve info.
@param[in/out] LockingFeature Return the Locking info.
**/
TCG_RESULT
EFIAPI
OpalGetLockingInfo(
OPAL_SESSION *Session,
TCG_LOCKING_FEATURE_DESCRIPTOR *LockingFeature
)
{
UINT8 Buffer[BUFFER_SIZE];
TCG_LEVEL0_DISCOVERY_HEADER *DiscoveryHeader;
OPAL_LEVEL0_FEATURE_DESCRIPTOR *Feat;
UINTN Size;
NULL_CHECK(Session);
NULL_CHECK(LockingFeature);
ZeroMem(Buffer, BUFFER_SIZE);
ASSERT(sizeof(Buffer) >= sizeof(TCG_SUPPORTED_SECURITY_PROTOCOLS));
if (OpalRetrieveLevel0DiscoveryHeader (Session, BUFFER_SIZE, Buffer) == TcgResultFailure) {
DEBUG ((DEBUG_INFO, "OpalRetrieveLevel0DiscoveryHeader failed\n"));
return TcgResultFailure;
}
DiscoveryHeader = (TCG_LEVEL0_DISCOVERY_HEADER*) Buffer;
Size = 0;
Feat = (OPAL_LEVEL0_FEATURE_DESCRIPTOR*) TcgGetFeature (DiscoveryHeader, TCG_FEATURE_LOCKING, &Size);
if (Feat != NULL && Size >= sizeof (TCG_LOCKING_FEATURE_DESCRIPTOR)) {
CopyMem (LockingFeature, &Feat->Locking, sizeof (TCG_LOCKING_FEATURE_DESCRIPTOR));
}
return TcgResultSuccess;
}
/**
The function determines whether or not all of the requirements for the Opal Feature (not full specification)
are met by the specified device.
@param[in] SupportedAttributes Opal device attribute.
**/
BOOLEAN
EFIAPI
OpalFeatureSupported(
OPAL_DISK_SUPPORT_ATTRIBUTE *SupportedAttributes
)
{
NULL_CHECK(SupportedAttributes);
if (SupportedAttributes->Sp1 == 0) {
return FALSE;
}
if (SupportedAttributes->OpalSscLite == 0 &&
SupportedAttributes->OpalSsc1 == 0 &&
SupportedAttributes->OpalSsc2 == 0 &&
SupportedAttributes->PyriteSsc == 0
) {
return FALSE;
}
return TRUE;
}
/**
The function returns whether or not the device is Opal Enabled.
TRUE means that the device is partially or fully locked.
This will perform a Level 0 Discovery and parse the locking feature descriptor
@param[in] SupportedAttributes Opal device attribute.
@param[in] LockingFeature Opal device locking status.
**/
BOOLEAN
EFIAPI
OpalFeatureEnabled(
OPAL_DISK_SUPPORT_ATTRIBUTE *SupportedAttributes,
TCG_LOCKING_FEATURE_DESCRIPTOR *LockingFeature
)
{
NULL_CHECK(SupportedAttributes);
NULL_CHECK(LockingFeature);
if (!OpalFeatureSupported (SupportedAttributes)) {
return FALSE;
}
if (LockingFeature->LockingSupported && LockingFeature->LockingEnabled) {
return TRUE;
}
return FALSE;
}
/**
The function returns whether or not the device is Opal Locked.
TRUE means that the device is partially or fully locked.
This will perform a Level 0 Discovery and parse the locking feature descriptor
@param[in] SupportedAttributes Opal device attribute.
@param[in] LockingFeature Opal device locking status.
**/
BOOLEAN
OpalDeviceLocked(
OPAL_DISK_SUPPORT_ATTRIBUTE *SupportedAttributes,
TCG_LOCKING_FEATURE_DESCRIPTOR *LockingFeature
)
{
NULL_CHECK(SupportedAttributes);
NULL_CHECK(LockingFeature);
if (!OpalFeatureEnabled (SupportedAttributes, LockingFeature)) {
return FALSE;
}
return LockingFeature->Locked;
}
|