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
|
/** @file
Public API for Opal Core library.
Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <Uefi.h>
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include <Library/TcgStorageOpalLib.h>
#include "TcgStorageOpalLibInternal.h"
#define OPAL_MSID_LENGTH 128
/**
Creates a session with OPAL_UID_ADMIN_SP as OPAL_ADMIN_SP_PSID_AUTHORITY, then reverts device using Admin SP Revert method.
@param[in] Session, The session info for one opal device.
@param[in] Psid PSID of device to revert.
@param[in] PsidLength Length of PSID in bytes.
**/
TCG_RESULT
EFIAPI
OpalUtilPsidRevert(
OPAL_SESSION *Session,
const VOID *Psid,
UINT32 PsidLength
)
{
UINT8 MethodStatus;
TCG_RESULT Ret;
UINT32 RemovalTimeOut;
NULL_CHECK(Session);
NULL_CHECK(Psid);
RemovalTimeOut = GetRevertTimeOut (Session);
DEBUG ((DEBUG_INFO, "OpalUtilPsidRevert: Timeout value = %d\n", RemovalTimeOut));
Ret = OpalStartSession(
Session,
OPAL_UID_ADMIN_SP,
TRUE,
PsidLength,
Psid,
OPAL_ADMIN_SP_PSID_AUTHORITY,
&MethodStatus);
if (Ret == TcgResultSuccess && MethodStatus == TCG_METHOD_STATUS_CODE_SUCCESS) {
Ret = OpalPyrite2PsidRevert(Session, RemovalTimeOut);
if (Ret != TcgResultSuccess) {
//
// If revert was successful, session was already ended by TPer, so only end session on failure
//
OpalEndSession(Session);
}
}
if (MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
Ret = TcgResultFailure;
}
return Ret;
}
/**
Opens a session with OPAL_UID_ADMIN_SP as OPAL_ADMIN_SP_SID_AUTHORITY,
sets the OPAL_UID_ADMIN_SP_C_PIN_SID column with the new password,
and activates the locking SP to copy SID PIN to Admin1 Locking SP PIN
@param[in] Session, The session info for one opal device.
@param[in] GeneratedSid Generated SID of disk
@param[in] SidLength Length of generatedSid in bytes
@param[in] Password New admin password to set
@param[in] PassLength Length of password in bytes
**/
TCG_RESULT
EFIAPI
OpalUtilSetAdminPasswordAsSid(
OPAL_SESSION *Session,
const VOID *GeneratedSid,
UINT32 SidLength,
const VOID *Password,
UINT32 PassLength
)
{
UINT8 MethodStatus;
TCG_RESULT Ret;
NULL_CHECK(Session);
NULL_CHECK(GeneratedSid);
NULL_CHECK(Password);
Ret = OpalStartSession(
Session,
OPAL_UID_ADMIN_SP,
TRUE,
SidLength,
GeneratedSid,
OPAL_ADMIN_SP_SID_AUTHORITY,
&MethodStatus
);
if (Ret != TcgResultSuccess || MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
DEBUG ((DEBUG_INFO, "start session with admin SP as SID authority failed: Ret=%d MethodStatus=%u\n", Ret, MethodStatus));
goto done;
}
//
// 1. Update SID = new Password
//
Ret = OpalSetPassword(
Session,
OPAL_UID_ADMIN_SP_C_PIN_SID,
Password,
PassLength,
&MethodStatus
);
if (Ret != TcgResultSuccess || MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
OpalEndSession(Session);
DEBUG ((DEBUG_INFO, "set Password failed: Ret=%d MethodStatus=%u\n", Ret, MethodStatus));
goto done;
}
//
// 2. Activate locking SP
//
Ret = OpalActivateLockingSp(Session, &MethodStatus);
OpalEndSession(Session);
if (Ret != TcgResultSuccess || MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
DEBUG ((DEBUG_INFO, "activate locking SP failed: Ret=%d MethodStatus=%u\n", Ret, MethodStatus));
goto done;
}
done:
if (MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
Ret = TcgResultFailure;
}
return Ret;
}
/**
Opens a session with OPAL_UID_LOCKING_SP as OPAL_LOCKING_SP_ADMIN1_AUTHORITY,
and updates the specified locking range with the provided column values
@param[in] Session, The session info for one opal device.
@param[in] Password New admin password to set
@param[in] PassLength Length of password in bytes
@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
**/
TCG_RESULT
EFIAPI
OpalUtilSetOpalLockingRange(
OPAL_SESSION *Session,
const VOID *Password,
UINT32 PassLength,
TCG_UID LockingRangeUid,
UINT64 RangeStart,
UINT64 RangeLength,
BOOLEAN ReadLockEnabled,
BOOLEAN WriteLockEnabled,
BOOLEAN ReadLocked,
BOOLEAN WriteLocked
)
{
UINT8 MethodStatus;
TCG_RESULT Ret;
NULL_CHECK(Session);
NULL_CHECK(Password);
//
// Start session with Locking SP using current admin Password
//
Ret = OpalStartSession(
Session,
OPAL_UID_LOCKING_SP,
TRUE,
PassLength,
Password,
OPAL_LOCKING_SP_ADMIN1_AUTHORITY,
&MethodStatus);
if ((Ret != TcgResultSuccess) || (MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS)) {
DEBUG ((DEBUG_INFO, "start session with locking SP failed: Ret=%d MethodStatus=%u\n", Ret, MethodStatus));
goto done;
}
//
// Enable locking range
//
Ret = OpalSetLockingRange(
Session,
LockingRangeUid,
RangeStart,
RangeLength,
ReadLockEnabled,
WriteLockEnabled,
ReadLocked,
WriteLocked,
&MethodStatus);
OpalEndSession(Session);
if (Ret != TcgResultSuccess || MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
DEBUG ((DEBUG_INFO, "set locking range failed: Ret=%d MethodStatus=0x%x\n", Ret, MethodStatus));
}
done:
if (MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
Ret = TcgResultFailure;
}
return Ret;
}
/**
Opens a session with OPAL_UID_ADMIN_SP as OPAL_ADMIN_SP_SID_AUTHORITY,
sets OPAL_UID_ADMIN_SP_C_PIN_SID with the new password,
and sets OPAL_LOCKING_SP_C_PIN_ADMIN1 with the new password.
@param[in] Session, The session info for one opal device.
@param[in] OldPassword Current admin password
@param[in] OldPasswordLength Length of current admin password in bytes
@param[in] NewPassword New admin password to set
@param[in] NewPasswordLength Length of new password in bytes
**/
TCG_RESULT
EFIAPI
OpalUtilSetAdminPassword(
OPAL_SESSION *Session,
const VOID *OldPassword,
UINT32 OldPasswordLength,
const VOID *NewPassword,
UINT32 NewPasswordLength
)
{
TCG_RESULT Ret;
UINT8 MethodStatus;
NULL_CHECK(Session);
NULL_CHECK(OldPassword);
NULL_CHECK(NewPassword);
//
// Unknown ownership
//
Ret = OpalStartSession(
Session,
OPAL_UID_ADMIN_SP,
TRUE,
OldPasswordLength,
OldPassword,
OPAL_ADMIN_SP_SID_AUTHORITY,
&MethodStatus
);
if (Ret != TcgResultSuccess || MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
DEBUG ((DEBUG_INFO, "start session with admin SP using old Password failed\n"));
goto done;
}
//
// Update SID = new pw
//
Ret = OpalSetPassword(Session, OPAL_UID_ADMIN_SP_C_PIN_SID, NewPassword, NewPasswordLength, &MethodStatus);
OpalEndSession(Session);
if (Ret != TcgResultSuccess || MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
DEBUG ((DEBUG_INFO, "set new admin SP Password failed\n"));
goto done;
}
Ret = OpalStartSession(
Session,
OPAL_UID_LOCKING_SP,
TRUE,
OldPasswordLength,
OldPassword,
OPAL_LOCKING_SP_ADMIN1_AUTHORITY,
&MethodStatus
);
if (Ret != TcgResultSuccess || MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
DEBUG ((DEBUG_INFO, "start session with locking SP using old Password failed\n"));
goto done;
}
//
// Update admin locking SP to new pw
//
Ret = OpalSetPassword(Session, OPAL_LOCKING_SP_C_PIN_ADMIN1, NewPassword, NewPasswordLength, &MethodStatus);
OpalEndSession(Session);
if (Ret != TcgResultSuccess || MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
DEBUG ((DEBUG_INFO, "set new locking SP Password failed\n"));
goto done;
}
done:
if (MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
Ret = TcgResultFailure;
}
return Ret;
}
/**
Starts a session with OPAL_UID_LOCKING_SP as OPAL_LOCKING_SP_USER1_AUTHORITY or OPAL_LOCKING_SP_ADMIN1_AUTHORITY
and sets the User1 SP authority to enabled and sets the User1 password.
@param[in] Session, The session info for one opal device.
@param[in] OldPassword Current admin password
@param[in] OldPasswordLength Length of current admin password in bytes
@param[in] NewPassword New admin password to set
@param[in] NewPasswordLength Length of new password in bytes
**/
TCG_RESULT
EFIAPI
OpalUtilSetUserPassword(
OPAL_SESSION *Session,
const VOID *OldPassword,
UINT32 OldPasswordLength,
const VOID *NewPassword,
UINT32 NewPasswordLength
)
{
UINT8 MethodStatus;
TCG_RESULT Ret;
NULL_CHECK(Session);
NULL_CHECK(OldPassword);
NULL_CHECK(NewPassword);
//
// See if updating user1 authority
//
Ret = OpalStartSession(
Session,
OPAL_UID_LOCKING_SP,
TRUE,
OldPasswordLength,
OldPassword,
OPAL_LOCKING_SP_USER1_AUTHORITY,
&MethodStatus
);
if (Ret == TcgResultSuccess && MethodStatus == TCG_METHOD_STATUS_CODE_SUCCESS) {
Ret = OpalSetPassword(
Session,
OPAL_LOCKING_SP_C_PIN_USER1,
NewPassword,
NewPasswordLength,
&MethodStatus
);
OpalEndSession(Session);
if (Ret == TcgResultSuccess && MethodStatus == TCG_METHOD_STATUS_CODE_SUCCESS) {
return Ret;
}
}
//
// Setting Password for first time or setting Password as admin
//
//
// Start session with Locking SP using current admin Password
//
Ret = OpalStartSession(
Session,
OPAL_UID_LOCKING_SP,
TRUE,
OldPasswordLength,
OldPassword,
OPAL_LOCKING_SP_ADMIN1_AUTHORITY,
&MethodStatus
);
if (Ret != TcgResultSuccess || MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
DEBUG ((DEBUG_INFO, "StartSession with locking SP as admin1 authority failed\n"));
goto done;
}
//
// Enable User1 and set its PIN
//
Ret = OpalSetLockingSpAuthorityEnabledAndPin(
Session,
OPAL_LOCKING_SP_C_PIN_USER1,
OPAL_LOCKING_SP_USER1_AUTHORITY,
NewPassword,
NewPasswordLength,
&MethodStatus
);
OpalEndSession(Session);
if (Ret != TcgResultSuccess || MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
DEBUG ((DEBUG_INFO, "OpalSetLockingSpAuthorityEnabledAndPin failed\n"));
goto done;
}
done:
if (MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
Ret = TcgResultFailure;
}
return Ret;
}
/**
Verify whether user input the correct password.
@param[in] Session, The session info for one opal device.
@param[in] Password Admin password
@param[in] PasswordLength Length of password in bytes
@param[in/out] HostSigningAuthority Use the Host signing authority type.
**/
TCG_RESULT
EFIAPI
OpalUtilVerifyPassword (
OPAL_SESSION *Session,
const VOID *Password,
UINT32 PasswordLength,
TCG_UID HostSigningAuthority
)
{
TCG_RESULT Ret;
UINT8 MethodStatus;
NULL_CHECK(Session);
NULL_CHECK(Password);
Ret = OpalStartSession(
Session,
OPAL_UID_LOCKING_SP,
TRUE,
PasswordLength,
Password,
HostSigningAuthority,
&MethodStatus);
if (Ret == TcgResultSuccess && MethodStatus == TCG_METHOD_STATUS_CODE_SUCCESS) {
OpalEndSession(Session);
return TcgResultSuccess;
}
return TcgResultFailure;
}
/**
Starts a session with OPAL_UID_LOCKING_SP as OPAL_LOCKING_SP_USER1_AUTHORITY or OPAL_LOCKING_SP_ADMIN1_AUTHORITY
and generates a new global locking range key to erase the Data.
@param[in] Session, The session info for one opal device.
@param[in] Password Admin or user password
@param[in] PasswordLength Length of password in bytes
@param[in/out] PasswordFailed indicates if password failed (start session didn't work)
**/
TCG_RESULT
EFIAPI
OpalUtilSecureErase(
OPAL_SESSION *Session,
const VOID *Password,
UINT32 PasswordLength,
BOOLEAN *PasswordFailed
)
{
UINT8 MethodStatus;
TCG_RESULT Ret;
NULL_CHECK(Session);
NULL_CHECK(Password);
NULL_CHECK(PasswordFailed);
//
// Try to generate a new key with admin1
//
Ret = OpalStartSession(
Session,
OPAL_UID_LOCKING_SP,
TRUE,
PasswordLength,
Password,
OPAL_LOCKING_SP_ADMIN1_AUTHORITY,
&MethodStatus
);
if (Ret == TcgResultSuccess && MethodStatus == TCG_METHOD_STATUS_CODE_SUCCESS) {
Ret = OpalGlobalLockingRangeGenKey(Session, &MethodStatus);
*PasswordFailed = FALSE;
OpalEndSession(Session);
} else {
//
// Try to generate a new key with user1
//
Ret = OpalStartSession(
Session,
OPAL_UID_LOCKING_SP,
TRUE,
PasswordLength,
Password,
OPAL_LOCKING_SP_USER1_AUTHORITY,
&MethodStatus
);
if (Ret == TcgResultSuccess && MethodStatus == TCG_METHOD_STATUS_CODE_SUCCESS) {
Ret = OpalGlobalLockingRangeGenKey(Session, &MethodStatus);
*PasswordFailed = FALSE;
OpalEndSession(Session);
} else {
*PasswordFailed = TRUE;
}
}
if (MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
Ret = TcgResultFailure;
}
return Ret;
}
/**
Starts a session with OPAL_UID_LOCKING_SP as OPAL_LOCKING_SP_ADMIN1_AUTHORITY and disables the User1 authority.
@param[in] Session, The session info for one opal device.
@param[in] Password Admin password
@param[in] PasswordLength Length of password in bytes
@param[in/out] PasswordFailed indicates if password failed (start session didn't work)
**/
TCG_RESULT
EFIAPI
OpalUtilDisableUser(
OPAL_SESSION *Session,
const VOID *Password,
UINT32 PasswordLength,
BOOLEAN *PasswordFailed
)
{
UINT8 MethodStatus;
TCG_RESULT Ret;
NULL_CHECK(Session);
NULL_CHECK(Password);
NULL_CHECK(PasswordFailed);
//
// Start session with Locking SP using current admin Password
//
Ret = OpalStartSession(
Session,
OPAL_UID_LOCKING_SP,
TRUE,
PasswordLength,
Password,
OPAL_LOCKING_SP_ADMIN1_AUTHORITY,
&MethodStatus
);
if (Ret != TcgResultSuccess || MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
DEBUG ((DEBUG_INFO, "StartSession with Locking SP as Admin1 failed\n"));
*PasswordFailed = TRUE;
goto done;
}
*PasswordFailed = FALSE;
Ret = OpalDisableUser(Session, &MethodStatus);
OpalEndSession(Session);
done:
if (MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
Ret = TcgResultFailure;
}
return Ret;
}
/**
Opens a session with OPAL_UID_ADMIN_SP as OPAL_ADMIN_SP_PSID_AUTHORITY, then reverts the device using the RevertSP method.
@param[in] Session, The session info for one opal device.
@param[in] KeepUserData TRUE to keep existing Data on the disk, or FALSE to erase it
@param[in] Password Admin password
@param[in] PasswordLength Length of password in bytes
@param[in/out] PasswordFailed indicates if password failed (start session didn't work)
@param[in] Msid Msid info.
@param[in] MsidLength Msid data length.
**/
TCG_RESULT
EFIAPI
OpalUtilRevert(
OPAL_SESSION *Session,
BOOLEAN KeepUserData,
const VOID *Password,
UINT32 PasswordLength,
BOOLEAN *PasswordFailed,
UINT8 *Msid,
UINT32 MsidLength
)
{
UINT8 MethodStatus;
TCG_RESULT Ret;
UINT32 RemovalTimeOut;
NULL_CHECK(Session);
NULL_CHECK(Msid);
NULL_CHECK(Password);
NULL_CHECK(PasswordFailed);
RemovalTimeOut = GetRevertTimeOut (Session);
DEBUG ((DEBUG_INFO, "OpalUtilRevert: Timeout value = %d\n", RemovalTimeOut));
Ret = OpalStartSession(
Session,
OPAL_UID_LOCKING_SP,
TRUE,
PasswordLength,
Password,
OPAL_LOCKING_SP_ADMIN1_AUTHORITY,
&MethodStatus
);
if (Ret != TcgResultSuccess || MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
DEBUG ((DEBUG_INFO, "error starting session: Ret=%d, MethodStatus=%u\n", Ret, MethodStatus));
*PasswordFailed = TRUE;
goto done;
}
*PasswordFailed = FALSE;
//
// Try to revert with admin1
//
Ret = OpalPyrite2AdminRevert(Session, KeepUserData, &MethodStatus, RemovalTimeOut);
if (Ret != TcgResultSuccess || MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
//
// Device ends the session on successful revert, so only call OpalEndSession when fail.
//
DEBUG ((DEBUG_INFO, "OpalAdminRevert as admin failed\n"));
OpalEndSession(Session);
}
Ret = OpalUtilSetSIDtoMSID (Session, Password, PasswordLength, Msid, MsidLength);
done:
if (MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
Ret = TcgResultFailure;
}
return Ret;
}
/**
After revert success, set SID to MSID.
@param Session, The session info for one opal device.
@param Password, Input password info.
@param PasswordLength, Input password length.
@param Msid Msid info.
@param MsidLength Msid data length.
**/
TCG_RESULT
EFIAPI
OpalUtilSetSIDtoMSID (
OPAL_SESSION *Session,
const VOID *Password,
UINT32 PasswordLength,
UINT8 *Msid,
UINT32 MsidLength
)
{
TCG_RESULT Ret;
UINT8 MethodStatus;
NULL_CHECK(Session);
NULL_CHECK(Msid);
NULL_CHECK(Password);
//
// Start session with admin sp to update SID to MSID
//
Ret = OpalStartSession(
Session,
OPAL_UID_ADMIN_SP,
TRUE,
PasswordLength,
Password,
OPAL_ADMIN_SP_SID_AUTHORITY,
&MethodStatus
);
if (Ret != TcgResultSuccess || MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
goto done;
}
//
// Update SID pin
//
Ret = OpalSetPassword(Session, OPAL_UID_ADMIN_SP_C_PIN_SID, Msid, MsidLength, &MethodStatus);
OpalEndSession(Session);
done:
if (MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
Ret = TcgResultFailure;
}
return Ret;
}
/**
Update global locking range.
@param Session, The session info for one opal device.
@param Password, Input password info.
@param PasswordLength, Input password length.
@param ReadLocked, Read lock info.
@param WriteLocked write lock info.
**/
TCG_RESULT
EFIAPI
OpalUtilUpdateGlobalLockingRange(
OPAL_SESSION *Session,
const VOID *Password,
UINT32 PasswordLength,
BOOLEAN ReadLocked,
BOOLEAN WriteLocked
)
{
UINT8 MethodStatus;
TCG_RESULT Ret;
NULL_CHECK(Session);
NULL_CHECK(Password);
//
// Try to start session with Locking SP as admin1 authority
//
Ret = OpalStartSession(
Session,
OPAL_UID_LOCKING_SP,
TRUE,
PasswordLength,
Password,
OPAL_LOCKING_SP_ADMIN1_AUTHORITY,
&MethodStatus
);
if (Ret == TcgResultSuccess && MethodStatus == TCG_METHOD_STATUS_CODE_SUCCESS) {
Ret = OpalUpdateGlobalLockingRange(
Session,
ReadLocked,
WriteLocked,
&MethodStatus
);
OpalEndSession(Session);
if (Ret == TcgResultSuccess && MethodStatus == TCG_METHOD_STATUS_CODE_SUCCESS) {
goto done;
}
}
if (MethodStatus == TCG_METHOD_STATUS_CODE_AUTHORITY_LOCKED_OUT) {
DEBUG ((DEBUG_INFO, "unlock as admin failed with AUTHORITY_LOCKED_OUT\n"));
}
//
// Try user1 authority
//
Ret = OpalStartSession(
Session,
OPAL_UID_LOCKING_SP,
TRUE,
PasswordLength,
Password,
OPAL_LOCKING_SP_USER1_AUTHORITY,
&MethodStatus
);
if (Ret != TcgResultSuccess || MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
DEBUG ((DEBUG_INFO, "StartSession with Locking SP as User1 failed\n"));
goto done;
}
Ret = OpalUpdateGlobalLockingRange(Session, ReadLocked, WriteLocked, &MethodStatus);
OpalEndSession(Session);
done:
if (MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
if (MethodStatus == TCG_METHOD_STATUS_CODE_AUTHORITY_LOCKED_OUT) {
//
// Caller need to know this special error, but return status not has type for it.
// so here use TcgResultFailureInvalidType as an replacement.
//
Ret = TcgResultFailureInvalidType;
} else {
Ret = TcgResultFailure;
}
}
return Ret;
}
/**
Update global locking range.
@param Session, The session info for one opal device.
@param Msid, The data buffer to save Msid info.
@param MsidBufferLength, The data buffer length for Msid.
@param MsidLength, The actual data length for Msid.
**/
TCG_RESULT
EFIAPI
OpalUtilGetMsid(
OPAL_SESSION *Session,
UINT8 *Msid,
UINT32 MsidBufferLength,
UINT32 *MsidLength
)
{
UINT8 MethodStatus;
TCG_RESULT Ret;
NULL_CHECK(Session);
NULL_CHECK(Msid);
NULL_CHECK(MsidLength);
Ret = OpalStartSession(
Session,
OPAL_UID_ADMIN_SP,
TRUE,
0,
NULL,
TCG_UID_NULL,
&MethodStatus
);
if ((Ret == TcgResultSuccess) && (MethodStatus == TCG_METHOD_STATUS_CODE_SUCCESS)) {
Ret = OpalGetMsid (Session, MsidBufferLength, Msid, MsidLength);
OpalEndSession (Session);
}
if (MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
Ret = TcgResultFailure;
}
return Ret;
}
/**
The function determines who owns the device by attempting to start a session with different credentials.
If the SID PIN matches the MSID PIN, the no one owns the device.
If the SID PIN matches the ourSidPin, then "Us" owns the device. Otherwise it is unknown.
@param[in] Session The session info for one opal device.
@param Msid, The Msid info.
@param MsidLength, The data length for Msid.
**/
OPAL_OWNER_SHIP
EFIAPI
OpalUtilDetermineOwnership(
OPAL_SESSION *Session,
UINT8 *Msid,
UINT32 MsidLength
)
{
UINT8 MethodStatus;
TCG_RESULT Ret;
OPAL_OWNER_SHIP Owner;
if ((Session == NULL) || (Msid == NULL)) {
return OpalOwnershipUnknown;
}
Owner = OpalOwnershipUnknown;
//
// Start Session as SID_UID with ADMIN_SP using MSID PIN
//
Ret = OpalStartSession(
Session,
OPAL_UID_ADMIN_SP,
TRUE,
MsidLength,
Msid,
OPAL_ADMIN_SP_SID_AUTHORITY,
&MethodStatus);
if ((Ret == TcgResultSuccess) && (MethodStatus == TCG_METHOD_STATUS_CODE_SUCCESS)) {
//
// now we know that SID PIN == MSID PIN
//
Owner = OpalOwnershipNobody;
OpalEndSession(Session);
}
return Owner;
}
/**
The function returns if admin password exists.
@param[in] OwnerShip The owner ship of the opal device.
@param[in] LockingFeature The locking info of the opal device.
@retval TRUE Admin password existed.
@retval FALSE Admin password not existed.
**/
BOOLEAN
EFIAPI
OpalUtilAdminPasswordExists(
IN UINT16 OwnerShip,
IN TCG_LOCKING_FEATURE_DESCRIPTOR *LockingFeature
)
{
NULL_CHECK(LockingFeature);
// if it is Unknown who owns the device
// then someone has set password previously through our UI
// because the SID would no longer match the generated SID (ownership us)
// or someone has set password using 3rd party software
//
// Locking sp enabled is checked b/c it must be enabled to change the PIN of the Admin1.
//
return (OwnerShip == OpalOwnershipUnknown && LockingFeature->LockingEnabled);
}
/**
Get Active Data Removal Mechanism Value.
@param[in] Session The session info for one opal device.
@param[in] GeneratedSid Generated SID of disk
@param[in] SidLength Length of generatedSid in bytes
@param[out] ActiveDataRemovalMechanism Return the active data removal mechanism.
**/
TCG_RESULT
EFIAPI
OpalUtilGetActiveDataRemovalMechanism (
OPAL_SESSION *Session,
const VOID *GeneratedSid,
UINT32 SidLength,
UINT8 *ActiveDataRemovalMechanism
)
{
TCG_RESULT Ret;
UINT8 MethodStatus;
NULL_CHECK(Session);
NULL_CHECK(GeneratedSid);
NULL_CHECK(ActiveDataRemovalMechanism);
Ret = OpalStartSession(
Session,
OPAL_UID_ADMIN_SP,
TRUE,
SidLength,
GeneratedSid,
OPAL_ADMIN_SP_ANYBODY_AUTHORITY,
&MethodStatus
);
if (Ret != TcgResultSuccess || MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
DEBUG ((DEBUG_INFO, "Start session with admin SP as SID authority failed: Ret=%d MethodStatus=%u\n", Ret, MethodStatus));
if (MethodStatus != TCG_METHOD_STATUS_CODE_SUCCESS) {
Ret = TcgResultFailure;
}
return Ret;
}
Ret = OpalPyrite2GetActiveDataRemovalMechanism (
Session,
ActiveDataRemovalMechanism
);
if (Ret != TcgResultSuccess) {
DEBUG ((DEBUG_INFO, "Pyrite2 Get Active Data Removal Mechanism failed: Ret=%d\n", Ret));
}
OpalEndSession(Session);
return Ret;
}
/**
Calculate the estimated time.
@param[in] IsMinute Whether the input time value is minute type or second type.
@param[in] Time The input time value.
**/
UINT32
CalculateDataRemovalTime (
IN BOOLEAN IsMinute,
IN UINT16 Time
)
{
if (IsMinute) {
return Time * 2 * 60;
} else {
return Time * 2;
}
}
/**
Return the estimated time for specific type.
@param[in] Index The input data removal type.
@param[in] Descriptor DATA_REMOVAL_FEATURE_DESCRIPTOR
**/
UINT32
GetDataRemovalTime (
IN UINT8 Index,
IN DATA_REMOVAL_FEATURE_DESCRIPTOR *Descriptor
)
{
switch (Index) {
case OverwriteDataErase:
return CalculateDataRemovalTime (Descriptor->FormatBit0, SwapBytes16 (Descriptor->TimeBit0));
case BlockErase:
return CalculateDataRemovalTime (Descriptor->FormatBit1, SwapBytes16 (Descriptor->TimeBit1));
case CryptoErase:
return CalculateDataRemovalTime (Descriptor->FormatBit2, SwapBytes16 (Descriptor->TimeBit2));
case Unmap:
return CalculateDataRemovalTime (Descriptor->FormatBit3, SwapBytes16 (Descriptor->TimeBit3));
case ResetWritePointers:
return CalculateDataRemovalTime (Descriptor->FormatBit4, SwapBytes16 (Descriptor->TimeBit4));
case VendorSpecificErase:
return CalculateDataRemovalTime (Descriptor->FormatBit5, SwapBytes16 (Descriptor->TimeBit5));
default:
return 0;
}
}
/**
Get the supported Data Removal Mechanism list.
@param[in] Session The session info for one opal device.
@param[out] RemovalMechanismLists Return the supported data removal mechanism lists.
**/
TCG_RESULT
EFIAPI
OpalUtilGetDataRemovalMechanismLists (
IN OPAL_SESSION *Session,
OUT UINT32 *RemovalMechanismLists
)
{
TCG_RESULT Ret;
UINTN DataSize;
DATA_REMOVAL_FEATURE_DESCRIPTOR Descriptor;
UINT8 Index;
UINT8 BitValue;
NULL_CHECK(Session);
NULL_CHECK(RemovalMechanismLists);
DataSize = sizeof (Descriptor);
Ret = OpalGetFeatureDescriptor (Session, TCG_FEATURE_DATA_REMOVAL, &DataSize, &Descriptor);
if (Ret != TcgResultSuccess) {
return TcgResultFailure;
}
ASSERT (Descriptor.RemovalMechanism != 0);
for (Index = 0; Index < ResearvedMechanism; Index ++) {
BitValue = (BOOLEAN) BitFieldRead8 (Descriptor.RemovalMechanism, Index, Index);
if (BitValue == 0) {
RemovalMechanismLists[Index] = 0;
} else {
RemovalMechanismLists[Index] = GetDataRemovalTime (Index, &Descriptor);
}
}
return TcgResultSuccess;
}
/**
Get revert timeout value.
@param[in] Session The session info for one opal device.
**/
UINT32
GetRevertTimeOut (
IN OPAL_SESSION *Session
)
{
TCG_RESULT TcgResult;
OPAL_DISK_SUPPORT_ATTRIBUTE SupportedAttributes;
UINT16 BaseComId;
UINT32 MsidLength;
UINT8 Msid[OPAL_MSID_LENGTH];
UINT32 RemovalMechanishLists[ResearvedMechanism];
UINT8 ActiveDataRemovalMechanism;
TcgResult = OpalGetSupportedAttributesInfo (Session, &SupportedAttributes, &BaseComId);
if (TcgResult != TcgResultSuccess || SupportedAttributes.DataRemoval == 0) {
return 0;
}
TcgResult = OpalUtilGetMsid (Session, Msid, OPAL_MSID_LENGTH, &MsidLength);
if (TcgResult != TcgResultSuccess) {
return 0;
}
TcgResult = OpalUtilGetDataRemovalMechanismLists (Session, RemovalMechanishLists);
if (TcgResult != TcgResultSuccess) {
return 0;
}
TcgResult = OpalUtilGetActiveDataRemovalMechanism (Session, Msid, MsidLength, &ActiveDataRemovalMechanism);
if (TcgResult != TcgResultSuccess) {
return 0;
}
return RemovalMechanishLists[ActiveDataRemovalMechanism];
}
|