-
Notifications
You must be signed in to change notification settings - Fork 97
/
genPnorImages.pl
executable file
·1252 lines (1132 loc) · 52 KB
/
genPnorImages.pl
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
#!/usr/bin/perl
# IBM_PROLOG_BEGIN_TAG
# This is an automatically generated prolog.
#
# $Source: src/build/buildpnor/genPnorImages.pl $
#
# OpenPOWER HostBoot Project
#
# Contributors Listed Below - COPYRIGHT 2016,2017
# [+] International Business Machines Corp.
#
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied. See the License for the specific language governing
# permissions and limitations under the License.
#
# IBM_PROLOG_END_TAG
use strict;
use Data::Dumper;
use File::Basename;
use Cwd qw(abs_path cwd);
use lib dirname abs_path($0);
use PnorUtils qw(loadPnorLayout getNumber traceErr trace run_command PAGE_SIZE
loadBinFiles findLayoutKeyByEyeCatch checkSpaceConstraints
getSwSignatures getBinDataFromFile);
use Getopt::Long qw(:config pass_through);
use constant COMMUNITY => "community";
# Hostboot base image constants for the hardware header portion of the
# secureboot header
use constant BASE_IMAGE_TOTAL_CONTAINER_SIZE => 0x000000000007EF80;
use constant BASE_IMAGE_TARGET_HRMOR => 0x0000000008000000;
use constant BASE_IMAGE_INSTRUCTION_START_STACK_POINTER => 0x0000000008280000;
# Max HBBL content size is 20K
my $MAX_HBBL_SIZE = 20480;
################################################################################
# Be explicit with POSIX
# Everything is exported by default (with a handful of exceptions). This is an
# unfortunate backwards compatibility feature and its use is strongly discouraged.
# You should either prevent the exporting (by saying use POSIX (); , as usual)
# and then use fully qualified names (e.g. POSIX::SEEK_END ), or give an explicit
# import list. If you do neither and opt for the default (as in use POSIX; ),
# you will import hundreds and hundreds of symbols into your namespace.
################################################################################
use POSIX ();
use Digest::SHA qw(sha512);
my $programName = File::Basename::basename $0;
my @systemBinFiles = ();
my %pnorLayout = ();
my %PhysicalOffsets = ();
# Truncate SHA to n bytes
use constant SHA_TRUNCATE_SIZE => 32;
# Defined in src/include/sys/vfs.h
use constant VFS_EXTENDED_MODULE_MAX => 128;
# VfsSystemModule struct size
use constant VFS_MODULE_TABLE_ENTRY_SIZE => 112;
# VFS Module table max size
use constant VFS_MODULE_TABLE_MAX_SIZE => VFS_EXTENDED_MODULE_MAX
* VFS_MODULE_TABLE_ENTRY_SIZE;
# Flag parameter string passed into signing tools
# Note spaces before/after are critical.
use constant LOCAL_SIGNING_FLAG => " -flag ";
use constant OP_SIGNING_FLAG => " -flags ";
# Security bits HW flag strings
use constant OP_BUILD_FLAG => 0x80000000;
use constant FIPS_BUILD_FLAG => 0x40000000;
# Applies to SBE image only
use constant LAB_SECURITY_OVERRIDE_FLAG => 0x00080000;
use constant KEY_TRANSITION_FLAG => 0x00000001;
# Size of HW keys' Hash
use constant HW_KEYS_HASH_SIZE => 64;
# TODO: RTC 163655
# Implement dynamic support for choosing FSP or op-build flag type.
# For now, assume OP build
my $buildFlag = OP_BUILD_FLAG;
# Corrupt parameter strings
my $CORRUPT_PROTECTED = "pro";
my $CORRUPT_UNPROTECTED = "unpro";
use constant MAX_PAGES_TO_CORRUPT => 10;
# rand file prefix string. Note hbDistribute cleans up files with this prefix
use constant RAND_PREFIX => "rand-";
# Signing modes
my $DEVELOPMENT = "development";
my $IMPRINT = "imprint";
my $PRODUCTION = "production";
################################################################################
# I/O parsing
################################################################################
my %globals = ();
my $bin_dir = cwd();
my $secureboot = 0;
my $testRun = 0;
my $pnorLayoutFile = "";
my $system_target = "";
my $build_all = 0;
my $emitEccless = 0;
my $install_all = 0;
my $key_transition = "";
my $help = 0;
my %partitionsToCorrupt = ();
my $sign_mode = $DEVELOPMENT;
my $sb_signing_config_file = "";
my $hwKeyHashFile = "";
my $hb_standalone="";
# @TODO RTC 170650: Set default to 0 after all environments provide external
# control over this policy, plus remove '!' from 'lab-security-override'
# command line option as well as documentation for
# '--no-lab-security-override'
my $labSecurityOverride = 1;
GetOptions("binDir:s" => \$bin_dir,
"secureboot" => \$secureboot,
"test" => \$testRun,
"pnorLayout:s" => \$pnorLayoutFile,
"systemBinFiles:s" => \@systemBinFiles,
"build-all" => \$build_all,
"install-all" => \$install_all,
"key-transition:s" => \$key_transition,
"corrupt:s" => \%partitionsToCorrupt,
"sign-mode:s" => \$sign_mode,
"sb-signing-config-file:s" => \$sb_signing_config_file,
"hwKeyHashFile:s" => \$hwKeyHashFile,
"hb-standalone" => \$hb_standalone,
"lab-security-override!" => \$labSecurityOverride,
"emit-eccless" => \$emitEccless,
"help" => \$help);
if ($help)
{
usage();
exit 0;
}
################################################################################
# Environment Setup, Checking, and Variable Initialization
################################################################################
# Put mode transition input into a hash and ensure a valid signing mode
my %signMode = ( $DEVELOPMENT => 1,
$PRODUCTION => 0 );
if ($sign_mode =~ m/^$DEVELOPMENT/i)
{}
elsif ($sign_mode =~ m/^$PRODUCTION/i)
{
$signMode{$PRODUCTION} = 1;
$signMode{$DEVELOPMENT} = 0;
}
else
{
die "Invalid signing mode = $sign_mode";
}
# Secure boot signing config file only required in production mode.
if ($signMode{$PRODUCTION})
{
die "SB signing config file path not provided" if ($sb_signing_config_file eq "");
}
# Put key transition input into a hash and ensure a valid key transition mode
my %keyTransition = ( enabled => 0,
$IMPRINT => 0,
$PRODUCTION => 0 );
if ($key_transition =~ m/^$IMPRINT/i)
{
$keyTransition{$IMPRINT} = 1;
$keyTransition{enabled} = 1;
}
elsif ($key_transition =~ m/^$PRODUCTION/i)
{
$keyTransition{$PRODUCTION} = 1;
$keyTransition{enabled} = 1;
}
elsif ($key_transition ne "")
{
die "Invalid key transition mode = $key_transition";
}
my $labSecurityOverrideFlag = 0;
if($labSecurityOverride)
{
if($signMode{$DEVELOPMENT})
{
$labSecurityOverrideFlag = LAB_SECURITY_OVERRIDE_FLAG;
}
else
{
$labSecurityOverride = 0;
print "WARNING! Lab security override only valid in development/"
. "imprint mode, continuing with lab security override disabled.\n";
}
}
if ($secureboot)
{
# Ensure all values of partitionsToCorrupt hash are valid.
# Allow some flexibility for the user and do a regex, case insensitive check
# to properly clean up the corrupt partition hash.
foreach my $key (keys %partitionsToCorrupt)
{
my $value = $partitionsToCorrupt{$key};
if ($value eq "" || $value =~ m/^$CORRUPT_PROTECTED/i)
{
$partitionsToCorrupt{uc($key)} = $CORRUPT_PROTECTED
}
elsif ($value =~ m/^$CORRUPT_UNPROTECTED/i)
{
$partitionsToCorrupt{uc($key)} = $CORRUPT_UNPROTECTED;
}
else
{
die "Error> Unsupported option for --corrupt, value \"$key=$value\"";
}
}
}
# @TODO RTC: 155374 add official signing support including up to 3 sw keys
# Signing and Dev key directory location set via env vars
my $SIGNING_DIR = $ENV{'SIGNING_DIR'};
my $DEV_KEY_DIR = $ENV{'DEV_KEY_DIR'};
if ($secureboot)
{
# Check all components needed for developer signing
die "Signing Dir = $SIGNING_DIR DNE" if(! -d $SIGNING_DIR);
die "Dev Key Dir = $DEV_KEY_DIR DNE" if(! -d $DEV_KEY_DIR);
die "hw_key_a DNE in $DEV_KEY_DIR" if(!glob("$DEV_KEY_DIR/hw_key_a*"));
die "hw_key_b DNE in $DEV_KEY_DIR" if(!glob("$DEV_KEY_DIR/hw_key_b*"));
die "hw_key_c DNE in $DEV_KEY_DIR" if(!glob("$DEV_KEY_DIR/hw_key_c*"));
die "sw_key_a DNE in $DEV_KEY_DIR" if(!glob("$DEV_KEY_DIR/sw_key_a*"));
}
my $openSigningTool = 0;
my $SIGNING_TOOL_EDITION = $ENV{'SIGNING_TOOL_EDITION'};
if($SIGNING_TOOL_EDITION eq COMMUNITY)
{
$openSigningTool = 1;
}
### Local development signing
# Requires naming convention of hw/sw keys in DEV_KEY_DIR
my $SIGN_BUILD_PARAMS = "-skp ${DEV_KEY_DIR}/sw_key_a";
# Key prefix used for current key siging of partitions (N/A for open edition)
my $SIGN_PREFIX_PARAMS = "-hka ${DEV_KEY_DIR}/hw_key_a -hkb "
. "${DEV_KEY_DIR}/hw_key_b -hkc ${DEV_KEY_DIR}/hw_key_c "
. "-skp ${DEV_KEY_DIR}/sw_key_a";
# Key prefix used for secureboot key transition partition.
# Default key transition to same keys.
my $SIGN_SBKT_PREFIX_PARAMS = $SIGN_PREFIX_PARAMS;
if ($keyTransition{enabled})
{
# Note: simply reordered the keys to create a pseudo production key.
$SIGN_SBKT_PREFIX_PARAMS = "-hka ${DEV_KEY_DIR}/hw_key_c -hkb "
. "${DEV_KEY_DIR}/hw_key_b -hkc ${DEV_KEY_DIR}/hw_key_a "
. "-skp ${DEV_KEY_DIR}/sw_key_a";
}
### Open POWER signing
my $OPEN_SIGN_REQUEST="$SIGNING_DIR/crtSignedContainer.pl ";
# By default key transition container is unused
my $OPEN_SIGN_KEY_TRANS_REQUEST = $OPEN_SIGN_REQUEST;
# Production signing parameters
my $OPEN_PRD_SIGN_PARAMS = "--mode production "
. " --sign-project-config $sb_signing_config_file";
# Imprint key signing parameters
my $OPEN_DEV_SIGN_PARAMS = " -hwPrivKeyA $DEV_KEY_DIR/hw_key_a.key "
. "-hwPrivKeyB $DEV_KEY_DIR/hw_key_b.key "
. "-hwPrivKeyC $DEV_KEY_DIR/hw_key_c.key "
. "-swPrivKeyP $DEV_KEY_DIR/sw_key_a.key";
# Handle key transition and production signing logic
# If in production mode, key transition is not supported yet
# If in developement mode, key transition can move to either imprint or
# production keys
if ($signMode{$PRODUCTION})
{
# Production to Production key transition not supported yet
$OPEN_SIGN_REQUEST .= $OPEN_PRD_SIGN_PARAMS;
$OPEN_SIGN_KEY_TRANS_REQUEST = "";
}
elsif ($keyTransition{enabled} && $signMode{$DEVELOPMENT})
{
$OPEN_SIGN_REQUEST .= $OPEN_DEV_SIGN_PARAMS;
if ($keyTransition{$IMPRINT})
{
$OPEN_SIGN_KEY_TRANS_REQUEST .= $OPEN_DEV_SIGN_PARAMS;
}
elsif ($keyTransition{$PRODUCTION})
{
$OPEN_SIGN_KEY_TRANS_REQUEST .= "$OPEN_PRD_SIGN_PARAMS --sign-project-FW-token SBKT";
}
}
else
{
$OPEN_SIGN_REQUEST .= $OPEN_DEV_SIGN_PARAMS;
$OPEN_SIGN_KEY_TRANS_REQUEST = "";
}
### Secureboot headers
# Contains the appropriate flags, prefix, and file names.
my $randPrefix = "rand-".POSIX::ceil(rand(0xFFFFFFFF));
my %sb_hdrs = (
DEFAULT => {
flags => sprintf("0x%08X",$buildFlag),
prefix => $SIGN_PREFIX_PARAMS,
file => "$bin_dir/$randPrefix.default.secureboot.hdr.bin"
},
SBE => {
flags => sprintf("0x%08X",($buildFlag | $labSecurityOverrideFlag)),
prefix => $SIGN_PREFIX_PARAMS,
file => "$bin_dir/$randPrefix.sbe.default.secureboot.hdr.bin"
},
SBKT => {
outer => {
flags => sprintf("0x%08X", $buildFlag | KEY_TRANSITION_FLAG),
prefix => $SIGN_PREFIX_PARAMS,
file => "$bin_dir/$randPrefix.sbkt.outer.secureboot.hdr.bin"
},
inner => {
flags => sprintf("0x%08X", $buildFlag),
prefix => $SIGN_SBKT_PREFIX_PARAMS,
file => "$bin_dir/$randPrefix.sbkt.inner.secureboot.hdr.bin"
}
}
);
################################################################################
# main
################################################################################
# Print all settings in one print statement to avoid parallel build to mess
# up output.
my $SETTINGS = "\n//============= Generate PNOR Image Settings ===========//\n";
$SETTINGS .= "PNOR Layout = ".$pnorLayoutFile."\n";
$SETTINGS .= $build_all ? "Build Phase = build_all\n" : "";
$SETTINGS .= "Emit ECC-less versions of output files, when possible = ";
$SETTINGS .= $emitEccless ? "Yes\n" : "No\n";
$SETTINGS .= $install_all ? "Build Phase = install_all\n" : "";
$SETTINGS .= $testRun ? "Test Mode = Yes\n" : "Test Mode = No\n";
$SETTINGS .= $secureboot ? "Secureboot = Enabled\n" : "Secureboot = Disabled\n";
$SETTINGS .= %partitionsToCorrupt && $secureboot ? "Corrupt Partitions: ".Dumper \%partitionsToCorrupt : "";
$SETTINGS .= $secureboot ? "Sign Mode = $sign_mode\n" : "Sign Mode = NA\n";
$SETTINGS .= $key_transition && $secureboot ? "Key Transition Mode = $key_transition\n" : "Key Transition Mode = NA\n";
$SETTINGS .= "Lab security override (valid for SBE partition only) = ";
$SETTINGS .= $labSecurityOverride ? "Yes\n" : "No\n";
$SETTINGS .= "//======================================================//\n\n";
print $SETTINGS;
if($secureboot && !$openSigningTool)
{
# Generate each secureboot header file
foreach my $header (keys %sb_hdrs)
{
next if($header eq "SBKT" && !$key_transition);
# SBKT parition has 2 sections outer and inner, need to create both
if ($header eq "SBKT")
{
foreach my $section (keys %{$sb_hdrs{$header}})
{
run_command("$SIGNING_DIR/prefix -good -of $sb_hdrs{$header}{$section}{file}".
LOCAL_SIGNING_FLAG."$sb_hdrs{$header}{$section}{flags}".
" $sb_hdrs{$header}{$section}{prefix}");
}
}
else
{
run_command("$SIGNING_DIR/prefix -good -of $sb_hdrs{$header}{file}".
LOCAL_SIGNING_FLAG."$sb_hdrs{$header}{flags}".
" $sb_hdrs{$header}{prefix}");
}
}
# Generate test containers once and limit to build phase
if ($build_all)
{
gen_test_containers();
}
}
#Load PNOR Layout XML file
loadPnorLayout($pnorLayoutFile, \%pnorLayout, \%PhysicalOffsets, $testRun);
# Generate final images for each system's bin files.
foreach my $binFilesCSV (@systemBinFiles)
{
my %binFiles = ();
my $system_target = "";
# Check if format includes a system target 'TARGET:<csv of bin files>'
if ($binFilesCSV =~ m/:/)
{
my @arr = split(':', $binFilesCSV);
$system_target = $arr[0];
$binFilesCSV = $arr[1];
}
# Load bin files into hash to know what to generate
loadBinFiles($binFilesCSV, \%binFiles);
#Perform any data integrity manipulation (ECC, sha-hash, etc)
manipulateImages(\%pnorLayout, \%binFiles, $system_target);
# Make sure provided files will fit in their sections
checkSpaceConstraints(\%pnorLayout, \%binFiles, $testRun);
}
# Clean up temp header files
foreach my $header (keys %sb_hdrs)
{
if($header eq "SBKT")
{
foreach my $section (keys %{$sb_hdrs{$header}})
{
system("rm -f $sb_hdrs{$header}{$section}{file}");
die "Could not delete $sb_hdrs{$header}{$section}{file}" if $?;
}
}
else
{
system("rm -f $sb_hdrs{$header}{file}");
die "Could not delete $sb_hdrs{$header}{file}" if $?;
}
}
################################################################################
# Subroutines
################################################################################
################################################################################
# partitionDepSort
# Custom sort to ensure images are handled in the correct dependency order.
# If a dependency is not specified in the hash used, use default behavior.
################################################################################
# Hardcoded defined order that binfiles should be handled.
my %partitionDeps = ( HBBL => 0,
HBB => 1,
HBI => 2);
sub partitionDepSort
{
# If $a exists but $b does not, set $a < $b
if (exists $partitionDeps{$a} && !exists $partitionDeps{$b})
{
-1
}
# If $a does not exists but $b does, set $a > $b
elsif (!exists $partitionDeps{$a} && exists $partitionDeps{$b})
{
1
}
# If both $a and $b exist, actually compare values.
elsif (exists $partitionDeps{$a} && exists $partitionDeps{$b})
{
if ($partitionDeps{$a} < $partitionDeps{$b}) {-1}
elsif ($partitionDeps{$a} > $partitionDeps{$b}) {1}
else {0}
}
# If neither $a or $b have a dependency, order doesn't matter
else {0}
}
################################################################################
# manipulateImages - Perform any ECC/padding/sha/signing manipulations
################################################################################
sub manipulateImages
{
my ($i_pnorLayoutRef, $i_binFilesRef, $system_target) = @_;
my $this_func = (caller(0))[3];
my %sectionHash = %{$$i_pnorLayoutRef{sections}};
trace(1, "manipulateImages");
# Prefix for temporary files for parallel builds
my $parallelPrefix = RAND_PREFIX.POSIX::ceil(rand(0xFFFFFFFF)).$system_target;
# Partitions that have a hash page table at the beginning of the section
# for secureboot purposes.
my %hashPageTablePartitions = (HBI => 1);
my %preReqImages = (
HBB_SW_SIG_FILE => "$bin_dir/$parallelPrefix.hbb_sw_sig.bin"
);
foreach my $key (sort partitionDepSort keys %{$i_binFilesRef})
{
my %callerHwHdrFields = (
configure => 0,
totalContainerSize => 0,
targetHrmor => 0,
instructionStartStackPointer => 0);
my $layoutKey = findLayoutKeyByEyeCatch($key, \%$i_pnorLayoutRef);
my $eyeCatch = $sectionHash{$layoutKey}{eyeCatch};
my %tempImages = (
HDR_PHASE => "$bin_dir/$parallelPrefix.$eyeCatch.temp.hdr.bin",
TEMP_SHA_IMG => "$bin_dir/$parallelPrefix.$eyeCatch.temp.sha.bin",
PAD_PHASE => "$bin_dir/$parallelPrefix.$eyeCatch.temp.pad.bin",
ECC_PHASE => "$bin_dir/$parallelPrefix.$eyeCatch.temp.bin.ecc",
VFS_MODULE_TABLE => => "$bin_dir/$parallelPrefix.$eyeCatch.vfs_module_table.bin",
TEMP_BIN => "$bin_dir/$parallelPrefix.$eyeCatch.temp.bin",
PAYLOAD_TEXT => "$bin_dir/$parallelPrefix.$eyeCatch.payload_text.bin",
PROTECTED_PAYLOAD => "$bin_dir/$parallelPrefix.$eyeCatch.protected_payload.bin"
);
my $size = $sectionHash{$layoutKey}{physicalRegionSize};
my $bin_file = $$i_binFilesRef{$eyeCatch};
# Check if bin file is system specific and prefix target to the front
my $final_bin_file = ($system_target eq "")? "$bin_dir/$eyeCatch.bin":
"$bin_dir/$system_target.$eyeCatch.bin";
# Get size of partition without ecc
if ($sectionHash{$layoutKey}{ecc} eq "yes")
{
$size = page_aligned_size_wo_ecc($size);
}
# Sections that have secureboot support. Secureboot still must be
# enabled for secureboot actions on these partitions to occur.
# @TODO securebootp9 re-enable with SBE/SBEC/PAYLOAD secureboot ports
my $isNormalSecure = ($eyeCatch eq "HBBL");
$isNormalSecure ||= ($eyeCatch eq "SBE");
$isNormalSecure ||= ($eyeCatch eq "HBRT");
#$isNormalSecure ||= ($eyeCatch eq "SBEC");
$isNormalSecure ||= ($eyeCatch eq "PAYLOAD");
$isNormalSecure ||= ($eyeCatch eq "OCC");
#$isNormalSecure ||= ($eyeCatch eq "CAPP");
#$isNormalSecure ||= ($eyeCatch eq "BOOTKERNEL");
$isNormalSecure ||= ($eyeCatch eq "HCODE");
$isNormalSecure ||= ($eyeCatch eq "WOFDATA");
my $isSpecialSecure = ($eyeCatch eq "HBB");
$isSpecialSecure ||= ($eyeCatch eq "HBD");
$isSpecialSecure ||= ($eyeCatch eq "HBI");
# Used to indicate security is supported in firmware
my $secureSupported = $isNormalSecure || $isSpecialSecure;
# If there is a non-default header for this section, use it instead
my $header = $sb_hdrs{DEFAULT};
if(exists $sb_hdrs{$eyeCatch})
{
$header = $sb_hdrs{$eyeCatch};
}
my $openSigningFlags = OP_SIGNING_FLAG.$header->{flags};
my $secureboot_hdr = $header->{file};
my $CUR_OPEN_SIGN_REQUEST = "$OPEN_SIGN_REQUEST $openSigningFlags";
if ($signMode{$PRODUCTION})
{
$CUR_OPEN_SIGN_REQUEST .= " --sign-project-FW-token $eyeCatch ";
}
# Used for corrupting partitions. By default all protected offsets start
# immediately after the container header which is size = PAGE_SIZE.
# *Note: this is before ECC.
my $protectedOffset = PAGE_SIZE;
# Handle partitions that have an input binary.
if (-e $bin_file)
{
# Track original name and whether file has a header or not in order
# to emit eccless outputs, if requested
my $eccless_file = $bin_file;
my $eccless_prefix = "";
# HBBL + ROM combination
if ($eyeCatch eq "HBBL")
{
# Ensure there is enough room at the end of the HBBL partition
# to store the HW keys' hash.
my $hbblRawSize = (-s $bin_file or die "Cannot get size of file $bin_file");
print "HBBL raw size (no padding/ecc) = $hbblRawSize/$MAX_HBBL_SIZE\n";
if ($hbblRawSize > $MAX_HBBL_SIZE - HW_KEYS_HASH_SIZE)
{
die "HBBL cannot fit HW Keys' Hash (64 bytes) at the end without overwriting real data";
}
# Pad HBBL to max size
run_command("cp $bin_file $tempImages{TEMP_BIN}");
run_command("dd if=$tempImages{TEMP_BIN} of=$bin_file ibs=$MAX_HBBL_SIZE conv=sync");
# Add HW key hash to end of HBBL - 64 Bytes
my $hwKeyHashStart = (-s $bin_file or die "Cannot get size of file $bin_file")
- HW_KEYS_HASH_SIZE;
# dd used with seek to add the hw keys' hash at the end of the hbbl
# padded bin file
run_command("dd if=$hwKeyHashFile conv=notrunc of=$bin_file bs=1 seek=\$(($hwKeyHashStart))");
}
# Header Phase
if($sectionHash{$layoutKey}{sha512Version} eq "yes")
{
$eccless_prefix.=".header";
# Add secure container header
# @TODO RTC:155374 Remove when official signing supported
if ($secureboot && $isSpecialSecure)
{
$callerHwHdrFields{configure} = 1;
if (exists $hashPageTablePartitions{$eyeCatch})
{
if ($eyeCatch eq "HBI")
{
# Pass HBB sw signatures as the salt entry.
$tempImages{hashPageTable} = genHashPageTable($bin_file, $eyeCatch,
getBinDataFromFile($preReqImages{HBB_SW_SIG_FILE}));
}
else
{
$tempImages{hashPageTable} = genHashPageTable($bin_file, $eyeCatch);
}
}
# Add hash page table
if ($tempImages{hashPageTable} ne "" && -e $tempImages{hashPageTable})
{
trace(1,"Adding hash page table for $eyeCatch");
my $hashPageTableSize = -s $tempImages{hashPageTable};
die "hashPageTable size undefined: errno = $!" unless(defined $hashPageTableSize);
# Move protected offset after hash page table.
$protectedOffset += $hashPageTableSize;
if ($eyeCatch eq "HBI")
{
# Add the VFS module table to the payload text section.
run_command("dd if=$bin_file of=$tempImages{VFS_MODULE_TABLE} count=".VFS_EXTENDED_MODULE_MAX." ibs=".VFS_MODULE_TABLE_ENTRY_SIZE);
# Remove VFS module table from bin file
run_command("dd if=$bin_file of=$tempImages{TEMP_BIN} skip=".VFS_EXTENDED_MODULE_MAX." ibs=".VFS_MODULE_TABLE_ENTRY_SIZE);
run_command("cp $tempImages{TEMP_BIN} $bin_file");
# Pad after hash page table to have the VFS module table end at a 4K boundary
my $padSize = PAGE_SIZE - (($hashPageTableSize + VFS_MODULE_TABLE_MAX_SIZE) % PAGE_SIZE);
run_command("dd if=/dev/zero bs=$padSize count=1 | tr \"\\000\" \"\\377\" >> $tempImages{hashPageTable} ");
# Move protected offset after padding of hash page table.
$protectedOffset += $padSize;
# Payload text section
run_command("cat $tempImages{hashPageTable} $tempImages{VFS_MODULE_TABLE} > $tempImages{PAYLOAD_TEXT} ");
}
else
{
run_command("cp $tempImages{hashPageTable} $tempImages{PAYLOAD_TEXT}");
}
if($openSigningTool)
{
run_command("$CUR_OPEN_SIGN_REQUEST "
. "-protectedPayload $tempImages{PAYLOAD_TEXT} "
. "-out $tempImages{PROTECTED_PAYLOAD}");
}
else
{
# @TODO RTC:155374 Remove when official signing
# supported
run_command("$SIGNING_DIR/build -good -if $secureboot_hdr -of $tempImages{PROTECTED_PAYLOAD} -bin $tempImages{PAYLOAD_TEXT} $SIGN_BUILD_PARAMS");
}
run_command("cat $tempImages{PROTECTED_PAYLOAD} $bin_file > $tempImages{HDR_PHASE}");
}
# Handle read-only protected payload
elsif ($eyeCatch eq "HBD")
{
if($openSigningTool)
{
run_command("$CUR_OPEN_SIGN_REQUEST "
. "-protectedPayload $bin_file.protected "
. "-out $tempImages{PROTECTED_PAYLOAD}");
}
else
{
# @TODO RTC:155374 Remove when official signing
# supported
run_command("$SIGNING_DIR/build -good -if $secureboot_hdr -of $tempImages{PROTECTED_PAYLOAD} -bin $bin_file.protected $SIGN_BUILD_PARAMS");
}
run_command("cat $tempImages{PROTECTED_PAYLOAD} $bin_file.unprotected > $tempImages{HDR_PHASE}");
}
else
{
if($openSigningTool)
{
my $codeStartOffset = ($eyeCatch eq "HBB") ?
"-code-start-offset 0x00000180" : "";
run_command("$CUR_OPEN_SIGN_REQUEST "
. "$codeStartOffset "
. "-protectedPayload $bin_file "
. "-out $tempImages{HDR_PHASE}");
}
else
{
# @TODO RTC:155374 Remove when official signing
# supported
run_command("$SIGNING_DIR/build -good -if $secureboot_hdr -of $tempImages{HDR_PHASE} -bin $bin_file $SIGN_BUILD_PARAMS");
}
}
# Customize secureboot prefix header with container size,
# target HRMOR, and stack address (8 bytes each), in that
# order. Customization begins at offset 6 into the container
# header.
if($eyeCatch eq "HBB")
{
$callerHwHdrFields{totalContainerSize}
= BASE_IMAGE_TOTAL_CONTAINER_SIZE;
$callerHwHdrFields{targetHrmor}
= BASE_IMAGE_TARGET_HRMOR;
$callerHwHdrFields{instructionStartStackPointer}
= BASE_IMAGE_INSTRUCTION_START_STACK_POINTER;
# Save off HBB sw signatures for use by HBI
open (HBB_SW_SIG_FILE, ">",
$preReqImages{HBB_SW_SIG_FILE}) or die "Error opening file $preReqImages{HBB_SW_SIG_FILE}: $!\n";
binmode HBB_SW_SIG_FILE;
print HBB_SW_SIG_FILE getSwSignatures($tempImages{HDR_PHASE});
die "Error writing to $preReqImages{HBB_SW_SIG_FILE} failed" if $!;
close HBB_SW_SIG_FILE;
die "Error closing of $preReqImages{HBB_SW_SIG_FILE} failed" if $!;
}
}
elsif($secureboot && $isNormalSecure)
{
$callerHwHdrFields{configure} = 1;
if($openSigningTool)
{
run_command("$CUR_OPEN_SIGN_REQUEST "
. "-protectedPayload $bin_file "
. "-out $tempImages{HDR_PHASE}");
}
else
{
# @TODO RTC:155374 Remove when official signing
# supported
run_command("$SIGNING_DIR/build -good -if "
. "$secureboot_hdr -of $tempImages{HDR_PHASE} -bin "
. "$bin_file $SIGN_BUILD_PARAMS");
}
}
# Add simple version header
else
{
run_command("env echo -en VERSION\\\\0 > $tempImages{TEMP_SHA_IMG}");
run_command("sha512sum $bin_file | awk \'{print \$1}\' | xxd -pr -r >> $tempImages{TEMP_SHA_IMG}");
run_command("dd if=$tempImages{TEMP_SHA_IMG} of=$tempImages{HDR_PHASE} ibs=4k conv=sync");
run_command("cat $bin_file >> $tempImages{HDR_PHASE}");
}
}
else
{
run_command("cp $bin_file $tempImages{HDR_PHASE}");
}
setCallerHwHdrFields(\%callerHwHdrFields, $tempImages{HDR_PHASE});
# Padding Phase
if ($eyeCatch eq "HBI" && $testRun)
{
# If "--test" flag set do not pad as the test HBI images is
# possibly larger than partition size and does not need to be
# fully padded. Size adjustments made in checkSpaceConstraints
run_command("dd if=$tempImages{HDR_PHASE} of=$tempImages{PAD_PHASE} ibs=4k conv=sync");
}
# HBBL was already padded
elsif ($eyeCatch eq "HBBL")
{
run_command("cp $tempImages{HDR_PHASE} $tempImages{PAD_PHASE}");
}
else
{
run_command("dd if=$tempImages{HDR_PHASE} of=$tempImages{PAD_PHASE} ibs=$size conv=sync");
}
# If so instructed, retain pre-ECC versions of the output files
# using the appropriate naming convention
if ($emitEccless)
{
my($file,$dirs,$suffix) = fileparse($eccless_file);
$file =~ s/(\.\w+)$/$eccless_prefix$1/;
run_command("cp $tempImages{PAD_PHASE} $bin_dir/$file");
}
# Corrupt section if user specified to do so, before ECC injection.
if ($secureboot && exists $partitionsToCorrupt{$eyeCatch})
{
# If no protected file ($tempImages{PAYLOAD_TEXT}) exists
# for this partition, then that means there is no unprotected
# section. A protected file is only created when there's a need
# to split up the partition for signing purposes.
corrupt_partition($eyeCatch, $protectedOffset,
$tempImages{PAYLOAD_TEXT},
$tempImages{PAD_PHASE});
}
}
# Handle partitions that have no input binary. Simply zero or random
# fill the partition.
elsif (!-e $bin_file)
{
# Test partitions have random data
if ($eyeCatch eq "TEST" || $eyeCatch eq "TESTRO")
{
run_command("dd if=/dev/urandom of=$tempImages{PAD_PHASE} count=1 bs=$size");
}
elsif ($eyeCatch eq "SBKT" && $secureboot && $keyTransition{enabled})
{
$callerHwHdrFields{configure} = 1;
create_sb_key_transition_container($tempImages{PAD_PHASE});
setCallerHwHdrFields(\%callerHwHdrFields, $tempImages{PAD_PHASE});
}
# Other partitions fill with FF's if no empty bin file provided
else
{
run_command("dd if=/dev/zero bs=$size count=1 | tr \"\\000\" \"\\377\" > $tempImages{PAD_PHASE}");
# Add secure container header
if( ($sectionHash{$layoutKey}{sha512Version} eq "yes")
&& ($eyeCatch ne "SBKT"))
{
# Remove PAGE_SIZE bytes from generated dummy content of
# file to make room for the secure header
my $fileSize = (-s $tempImages{PAD_PHASE}) - PAGE_SIZE;
die "fileSize undefined: errno = $!"
unless(defined $fileSize);
run_command("dd if=$tempImages{PAD_PHASE} of=$tempImages{TEMP_BIN} count=1 bs=$fileSize");
if ($secureboot && $secureSupported)
{
$callerHwHdrFields{configure} = 1;
# @TODO RTC:155374 Remove when official signing
# supported
run_command("$SIGNING_DIR/build -good -if $secureboot_hdr -of $tempImages{PAD_PHASE} -bin $tempImages{TEMP_BIN} $SIGN_BUILD_PARAMS");
setCallerHwHdrFields(\%callerHwHdrFields,
$tempImages{PAD_PHASE});
}
else
{
run_command("env echo -en VERSION\\\\0 > $tempImages{TEMP_SHA_IMG}");
run_command("sha512sum $tempImages{TEMP_BIN} | awk \'{print \$1}\' | xxd -pr -r >> $tempImages{TEMP_SHA_IMG}");
run_command("dd if=$tempImages{TEMP_SHA_IMG} of=$tempImages{PAD_PHASE} ibs=4k conv=sync");
run_command("cat $tempImages{TEMP_BIN} >> $tempImages{PAD_PHASE}");
}
}
}
}
# ECC Phase
if( ($sectionHash{$layoutKey}{ecc} eq "yes") )
{
run_command("ecc --inject $tempImages{PAD_PHASE} --output $tempImages{ECC_PHASE} --p8");
}
else
{
run_command("cp $tempImages{PAD_PHASE} $tempImages{ECC_PHASE}");
}
# Compression phase
if( ($sectionHash{$layoutKey}{compressed}{algorithm} eq "xz"))
{
# Placeholder for compression partitions
}
# Move content to final bin filename
run_command("cp $tempImages{ECC_PHASE} $final_bin_file");
# Clean up temp images
foreach my $image (keys %tempImages)
{
system("rm -f $tempImages{$image}");
die "Failed deleting $tempImages{$image}" if ($?);
}
}
# Clean up prerequisite images
foreach my $image (keys %preReqImages)
{
system("rm -f $preReqImages{$image}");
die "Failed deleting $preReqImages{$image}" if ($?);
}
return 0;
}
################################################################################
# corrupt_partition : Corrupts a single byte of a section's bin file.
# The input $protected_file is used to determine the
# unprotected offset. Some partitions have no unprotected
# section, so the file DNE.
# *Note: this should be run before ECC is injected.
################################################################################
sub corrupt_partition
{
my ($eyeCatch, $protected_offset, $protected_file, $bin_file) = @_;
die "Error> Missing bin file to corrupt $bin_file" if (!-f $bin_file);
my $section = $partitionsToCorrupt{$eyeCatch};
my $offset = 0;
my $bin_file_size = -s $bin_file;
die "size of $bin_file undef" unless(defined $bin_file_size);
if ($section eq $CORRUPT_PROTECTED)
{
$offset = $protected_offset;
}
elsif ($section eq $CORRUPT_UNPROTECTED)
{
# If no protected_file file exists for this partition, then that means
# there is no unprotected section. A protected_file is only created
# when there's a need to split up the partition for signing purposes.
# *Note: Must add PAGE_SIZE to protected size as it does not include
# the secure container header.
$offset = (-f $protected_file) ? (-s $protected_file)+PAGE_SIZE : 0;
die "offset undef" unless(defined $offset);
if ($offset == 0)
{
die "Error> Section $eyeCatch does not have an unprotected section to corrupt";
}
elsif ($offset <= $protected_offset)
{
die "Error> Unprotected offset($offset) <= Protected offset($protected_offset)";
}
}
else
{
die "Error> Unsupported --corrupt value \"$section\"";
}
# Error checking
die "Error> corrupt offset not set" if ($offset == 0);
die "Error> Offset=$offset is past the size of the bin file to corrupt size=$bin_file_size" if ($offset >= $bin_file_size);
# Corrupt partition
my $num_pages_to_corrupt = 1;
# If corrupting the unprotected HBI section, corrupt multiple pages in
# attempt to corrupt a page that is actually used to result in a VFS
# verify page failure.
if (($eyeCatch eq "HBI") && ($section eq $CORRUPT_UNPROTECTED))
{
$num_pages_to_corrupt = MAX_PAGES_TO_CORRUPT;
}
for (my $i = 0; $i < $num_pages_to_corrupt; $i++)
{
my $page_offset = $i*PAGE_SIZE;
my $hex_offset = sprintf("0x%X", $offset + $page_offset);
trace(1,"Corrupting $eyeCatch $section section offset=$hex_offset");
# dd used with seek to manipulate a bin file in-place at a specific location.
run_command("printf \'\\xaf\' | dd conv=notrunc of=$bin_file bs=1 seek=\$(($hex_offset))");
}
}
################################################################################
# page_aligned_size_wo_ecc : Size of partition without ECC, rounded down to
# nearest multiple of PAGE_SIZE.
################################################################################
sub page_aligned_size_wo_ecc
{
my ($size) = @_;
die "Size must be at least (9/8)*PAGE_SIZE" if ($size < ((9/8)*PAGE_SIZE));
return POSIX::floor((($size * 8) / 9) / PAGE_SIZE) * PAGE_SIZE;
}
################################################################################
# truncate_sha - Truncates sha hash
# @return sha hash if already less than truncate size
# otherwise truncated sha hash
################################################################################
sub truncate_sha
{
my ($sha) = @_;
# Switch Perl to byte mode vs char mode. Only lasts in scope.
use bytes;
(length($sha) < SHA_TRUNCATE_SIZE)? return $sha :
return substr ($sha, 0, SHA_TRUNCATE_SIZE);
}
################################################################################
# genHashPageTable - Generates hash page table for PNOR partitions
# @return filename of binary hash page table content
################################################################################