-
Notifications
You must be signed in to change notification settings - Fork 50
/
create_gpt_image.py
executable file
·1293 lines (1078 loc) · 50.9 KB
/
create_gpt_image.py
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/env python
# -*- coding: utf-8; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
# Copyright (c) 2014, Intel Corporation.
# Author: Perrot, ThomasX <[email protected]>
#
# This program is free software; you can redistribute it and/or modify it
# under the terms and conditions of the GNU General Public License,
# version 2, as published by the Free Software Foundation.
#
# This program is distributed in the hope it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
# more details.
"""
Script to create a GPT/UEFI image or to show information it contains.
"""
from sys import exit, version_info
if version_info < (3, 0):
exit('Python version must be 3.0 or higher')
from logging import (debug, info, error, DEBUG, INFO, getLogger,
basicConfig)
from argparse import ArgumentParser
from os import remove, stat
from os.path import isfile, normcase, normpath, realpath, abspath, dirname
from struct import unpack, pack
from uuid import UUID, uuid4
from binascii import crc32
from re import compile as re_compile
from collections import namedtuple
from configparser import ConfigParser, ParsingError, NoOptionError, NoSectionError
from math import floor, log
class MBRInfos(object):
"""
Named tuple of MBR information.
Raw MBR is a little-endian struct with:
+--------------------------------------------+
| name | type | size | format |
+==============+=========+==========+========+
| boot | int | 4 | I |
+--------------+---------+----------+--------+
| OS type | int | 4 | I |
+--------------+---------+----------+--------+
| starting LBA | uint | 4 | I |
+--------------+---------+----------+--------+
| size in LBA | uint | 4 | I |
+--------------+---------+----------+--------+
| dummy 1 | char[] | 430 char | 430s |
+--------------+---------+----------+--------+
| dummy 2 | char[] | 16 char | 16s |
+--------------+---------+----------+--------+
| dummy 3 | char[] | 48 char | 48s |
+--------------+---------+----------+--------+
| sign | char[] | 2 char | 2s |
+--------------+---------+----------+--------+
"""
__slots__ = ('block_size', 'raw', 'boot', 'os_type', 'lba_start',
'lba_size', 'dummy_1', 'dummy_2', 'dummy_3', 'sign')
_FMT = '<IIII430s16s48s2s'
_PART_ENTRY = b'\x00\x00\x00\x00\xee\x00\x00\x00\x01\x00\x00\x00\x00\x00\xee\x00'
def __init__(self, block_size=512):
self.block_size = block_size
self.raw = b''
# TODO use decorators and properties to subtitute by r/w access in the
# raw attribute with pack and unpack function all these attributes
self.boot = 0
self.os_type = 0
self.os_type = 0
self.lba_start = 0
self.lba_size = 0
self.dummy_1 = b''
self.dummy_2 = b''
self.dummy_3 = b''
self.sign = b'\x55\xaa'
def __repr__(self):
# converts the size
if self.lba_size > 0:
units = ('KBytes', 'MBytes', 'GBytes')
index = int(floor(log(self.lba_size, 1024)))
computed_size = round(self.lba_size // (1024**index), 2)
human_size = '{0} {1}'.format(computed_size, units[index])
else:
human_size = '0 Bytes'
chs_starting = self.boot & 0x00FFFFFF
chs_ending = self.os_type & 0x00FFFFFF
result = 'MBR:\n'
result = '{0}\tboot: 0x{1:02x}\n'.format(result, self.boot)
result = '{0}\tOS type: 0x{1:02x}\n'.format(result, self.os_type)
result = '{0}\tCHS : starting {1:d}, ending {2:d}\n' \
.format(result, chs_starting, chs_ending)
result = '{0}\tLBA: start {1:d}, size {2:d}\n' \
.format(result, self.lba_start, self.lba_size)
result = '{0}\tsize: {1}\n'.format(result, human_size)
return result
def read(self, img_file, offset=0):
"""
Used to extract information of GPT raw obtains after reading an image.
"""
# reads the image file
img_file.seek(offset)
# MBR size is 512 Bytes, so that img_file.read is a fixed size 512 Bytes
# fix the issue when block_size is seted 4096 by using UFS
if self.block_size > 512:
self.raw = img_file.read(512)
else:
self.raw = img_file.read(self.block_size)
# unpacks the raw MBR to a named tuple
self.boot, self.os_type, self.lba_start, self.lba_size, self.dummy_1, \
self.dummy_2, self.dummy_3, self.sign \
= unpack(MBRInfos._FMT, self.raw)
def write(self, img_file, offset=0):
"""
Used to write MBR in an image file
"""
self.raw = pack(MBRInfos._FMT, self.boot, self.os_type,
self.lba_start, self.lba_size, b'\x00',
MBRInfos._PART_ENTRY, b'\x00', self.sign)
img_file.seek(offset)
img_file.write(self.raw)
class GPTHeaderInfos(object):
"""
Named tuple of GPT/UEFI header information
GPT/UEFI header format:
+-----------+----------+--------------------------------------------------+
| offset | Length | Contents |
+===========+==========+==================================================+
| 0 (0x00) | 8 bytes | Signature ('EFI PART', |
| | | 45h 46h 49h 20h 50h 41h 52h 54h) |
+-----------+----------+--------------------------------------------------+
| 8 (0x08) | 4 bytes | Revision (for GPT version 1.0 (through at least |
| | | UEFI version 2.3.1), the value is |
| | | 00h 00h 01h 00h) |
+-----------+----------+--------------------------------------------------+
| 12 (0x0C) | 4 bytes | Header size in little endian (in bytes, |
| | | usually 5Ch 00h 00h 00h meaning 92 bytes) |
+-----------+----------+--------------------------------------------------+
| 16 (0x10) | 4 bytes | CRC32 of header (offset +0 up to header size), |
| | | with this field zeroed during calculation |
+-----------+----------+--------------------------------------------------+
| 20 (0x14) | 4 bytes | Reserved; must be zero |
+-----------+----------+--------------------------------------------------+
| 24 (0x18) | 8 bytes | Current LBA (location of this header copy) |
+-----------+----------+--------------------------------------------------+
| 32 (0x20) | 8 bytes | Backup LBA (location of the other header copy) |
+-----------+----------+--------------------------------------------------+
| 40 (0x28) | 8 bytes | First usable LBA for partitions (primary |
| | | partition table last LBA + 1) |
+-----------+----------+--------------------------------------------------+
| 48 (0x30) | 8 bytes | Last usable LBA (secondary partition table first |
| | | LBA - 1) |
+-----------+----------+--------------------------------------------------+
| 56 (0x38) | 16 bytes | Disk GUID (also referred as UUID on UNIXes) |
+-----------+----------+--------------------------------------------------+
| 72 (0x48) | 8 bytes | Starting LBA of array of partition entries |
| | | (always 2 in primary copy) |
+-----------+----------+--------------------------------------------------+
| 80 (0x50) | 4 bytes | Number of partition entries in array |
+-----------+----------+--------------------------------------------------+
| 84 (0x54) | 4 bytes | Size of a single partition entry (usually 128) |
+-----------+----------+--------------------------------------------------+
| 88 (0x58) | 4 bytes | CRC32 of partition array |
+-----------+----------+--------------------------------------------------+
| 92 (0x5C) | * | Reserved; must be zeroes for the rest of the |
| | | block (420 bytes for a sector size of 512 bytes |
| | | but can be more with larger sector sizes) |
+===========+==========+==================================================+
| LBA size | Total | |
+-----------+----------+--------------------------------------------------+
"""
__slots__ = ('raw', 'sign', 'rev', 'size', 'crc', 'lba_current',
'lba_backup', 'lba_first', 'lba_last', 'uuid', 'lba_start',
'table_length', 'entry_size', 'table_crc')
_FMT = '<8s4sII4xQQQQ16sQIII'
def __init__(self, img_size=2147483648, block_size=512, size=92):
self.raw = b''
# TODO use decorators and properties to subtitute by r/w access in the
# raw attribute with pack and unpack function all these attributes
self.sign = b'EFI PART'
self.rev = b'\x00\x00\x01\x00'
self.size = size
# sets the length and the entry size of the GPT partition table with
# their default values
self.table_length = 128
self.entry_size = 128
# calculates the size of image in block
size_in_block = img_size // block_size
# sets the lba backup at the value of first lba used by GPT backup
self.lba_backup = size_in_block - 1
# calculates the size of the partition table in block
table_size = (self.table_length * self.entry_size) // block_size
# sets the lba first at the first usable lba for a partition
self.lba_first = table_size + 2
# sets last lba at last usable lba for a partition
self.lba_last = size_in_block - 2 - table_size
# generates an unique disk GUID
self.uuid = uuid4().bytes_le
# sets lba start at the value of first lba used by GPT header
self.lba_start = size_in_block - 1 - table_size
self.crc = 0
self.lba_current = 0
self.table_crc = 0
def __repr__(self):
result = 'GPT Header:\n'
result = '{0}\tsignature: {1}\n'.format(result, self.sign)
result = '{0}\trevision: {1}\n'.format(result, self.rev)
result = '{0}\tsize: {1} bytes\n'.format(result, self.size)
result = '{0}\tCRC32: {1}\n'.format(result, self.crc)
result = '{0}\tLBAs:\n'.format(result)
result = '{0}\t\t current: {1}\n'.format(result, self.lba_current)
result = '{0}\t\t backup: {1}\n'.format(result, self.lba_backup)
result = '{0}\t\t first usable: {1}\n'.format(result, self.lba_first)
result = ('{0}\t\t last usable: {1} - {2}\n'
.format(result, self.lba_last, self.lba_start))
result = ('{0}Disk UUID: {1}\n'
.format(result, UUID(bytes_le=self.uuid)))
result = '{0}partition entries:\n'.format(result)
result = '{0}\tstarting LBA: {1}\n'.format(result, self.lba_start)
result = ('{0}\tnumber of partition entries: {1}\n'
.format(result, self.table_length))
result = ('{0}\tsize of a single partition: {1}\n'
.format(result, self.entry_size))
result = ('{0}\tCRC32 of partition array: {1}\n'
.format(result, self.table_crc))
return result
def read(self, img_file, offset):
"""
Used to extract information of raw gpt obtains after reading an image
"""
# reads the image file
img_file.seek(offset)
self.raw = img_file.read(self.size)
# unpacks the raw GPT header of the image file to a named tuple
self.sign, self.rev, self.size, self.crc, self.lba_current, \
self.lba_backup, self.lba_first, self.lba_last, self.uuid, \
self.lba_start, self.table_length, self.entry_size, \
self.table_crc = unpack(GPTHeaderInfos._FMT, self.raw)
def write(self, img_file, offset, block_size):
"""
Used to write GPT header and backup in an image file
"""
self.raw = pack(GPTHeaderInfos._FMT, self.sign, self.rev,
self.size, 0, 1, self.lba_backup,
self.lba_first, self.lba_last, self.uuid,
2, self.table_length, self.entry_size, 0)
backup_raw = pack(GPTHeaderInfos._FMT, self.sign, self.rev,
self.size, 0, self.lba_backup, 1,
self.lba_first, self.lba_last, self.uuid,
self.lba_start, self.table_length,
self.entry_size, 0)
# writes a new GPT header
img_file.seek(offset)
img_file.write(self.raw)
# writes zero on unused blocks of GPT header
raw_stuffing = b'\x00' * (block_size - len(self.raw))
img_file.write(raw_stuffing)
# saves the end of the GPT header
gpt_header_end = img_file.tell()
# writes a new GPT backup
backup_position = self.lba_backup * block_size
img_file.seek(backup_position)
img_file.write(backup_raw)
# writes zero on unused blocks of GPT backup
img_file.write(raw_stuffing)
# sets the read pointer at the end of GPT header wrote
img_file.seek(gpt_header_end)
class PartTableInfos(list):
"""
The list of partition table entries
"""
__slots__ = ('raw')
def __init__(self):
super(PartTableInfos, self).__init__()
self.raw = ''
def __repr__(self):
result = 'Partitions table:\n'
for entry in self:
if UUID(bytes_le=entry.type) == \
UUID('00000000-0000-0000-0000-000000000000'):
continue
result = '{0}{1}'.format(result, entry)
return result
def read(self, img_file, offset, length, entry_size):
"""
Read the partition table from a GPT/UEFI image
"""
img_file.seek(offset)
self.raw = img_file.read(length * entry_size)
# reads each entry of partition table
for i in range(length):
entry = TableEntryInfos(i, entry_size)
entry.read(self.raw)
self.append(entry)
def write(self, img_file, offset, entry_size, tlb_infos, last_usable):
"""
Used to write GPT partitions tables in an image file
"""
# erases the partition table entries
self = []
# writes all new partition entries in GPT header
current_offset = offset
for pos, part_info in enumerate(tlb_infos):
entry = TableEntryInfos(pos, entry_size)
entry.write(img_file, current_offset, part_info)
current_offset += entry_size
self.append(entry)
# copies all partition entries wrote from GPT header to
# the GPT backup
img_file.seek(offset)
raw_entries_size = current_offset - offset
raw_entries = img_file.read(raw_entries_size)
img_file.seek(last_usable + 1)
img_file.write(raw_entries)
img_file.seek(current_offset)
class TableEntryInfos(object):
"""
An entry of the partition table
UUID partition entry format:
+-----------+-----------+-------------------------------------------------+
| Offset | Length | Content |
+===========+===========+=================================================+
| 0 (0x00) | 16 bytes | Partition type GUID |
+-----------+-----------+-------------------------------------------------+
| 16 (0x10) | 16 bytes | Unique partition GUID |
+-----------+-----------+-------------------------------------------------+
| 32 (0x20) | 8 bytes | First LBA (little endian) |
+-----------+-----------+-------------------------------------------------+
| 40 (0x28) | 8 bytes | Last LBA (inclusive, usually odd) |
+-----------+-----------+-------------------------------------------------+
| 48 (0x30) | 8 bytes | Attribute flags (e.g. bit 60 denotes read-only) |
+-----------+-----------+-------------------------------------------------+
| 56 (0x38) | 72 bytes | Partition name (36 UTF-16LE code units) |
+===========+===========+=================================================+
| Total | 128 bytes | |
+-----------+-----------+-------------------------------------------------+
"""
__slots__ = ('pos', 'size', 'raw', 'type', 'uuid', 'lba_first',
'lba_last', 'attr', 'name')
_FMT = '<16s16sQQQ72s'
def __init__(self, pos, size):
self.pos = pos
self.size = size
self.raw = ''
self.type = ''
self.uuid = ''
self.lba_first = 0
self.lba_last = 0
self.attr = 0
self.name = ''
def __repr__(self):
result = 'UUID partition entry {0}\n'.format(self.pos)
result = '\t{0}type: {1}\n'.format(result, UUID(bytes_le=self.type))
result = '\t{0}UUID: {1}\n'.format(result, UUID(bytes_le=self.uuid))
result = '\t{0}first LBA: {1}\n'.format(result, self.lba_first)
result = '\t{0}last LBA: {1}\n'.format(result, self.lba_last)
result = '\t{0}attribute flags: 0x{1:08x}\n'.format(result, self.attr)
result = '\t{0}name: {1}\n'.format(result,
self.name.decode('utf-16le'))
result = '\t{0}size: {1}\n'.format(result,
self.lba_last + 1 - self.lba_first)
return result
def read(self, raw_table):
"""
Read a partition table entry from a GPT/UEFI image
"""
# computes the start and the end of the entry in the partition table
raw_entry_start = self.pos * self.size
raw_entry_end = (self.pos + 1) * self.size
self.raw = raw_table[raw_entry_start:raw_entry_end]
# unpacks the raw partition table entry read to a named tuple
self.type, self.uuid, self.lba_first, self.lba_last, self.attr, \
self.name = unpack(TableEntryInfos._FMT, self.raw)
def write(self, img_file, offset, entry_info):
"""
Use to write a partition table entries in an image file
"""
types = {
'Unused': '00000000-0000-0000-0000-000000000000',
'esp': 'C12A7328-F81F-11D2-BA4B-00A0C93EC93B',
'fat': '024DEE41-33E7-11D3-9D69-0008C781F39F',
'bootloader': '2568845D-2332-4675-BC39-8FA5A4748D15',
'boot': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'boot_a': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'boot_b': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'recovery': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'misc': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'metadata': '5808C8AA-7E8F-42E0-85D2-E1E90434CFB3',
'reserved': '8DA63339-0007-60C0-C436-083AC8230908',
'linux': {
'xen_dom0' : '0fc63daf-8483-4772-8e79-3d69d8477de4',
'xen_misc' : '0fc63daf-8483-4772-8e79-3d69d8477de4',
'xen_guest' : '0fc63daf-8483-4772-8e79-3d69d8477de4',
'xen_rootfs' : '0fc63daf-8483-4772-8e79-3d69d8477de4',
'sos_boot' : '0fc63daf-8483-4772-8e79-3d69d8477de4',
'uos_boot' : '0fc63daf-8483-4772-8e79-3d69d8477de4',
'android_guest' : '0fc63daf-8483-4772-8e79-3d69d8477de4',
'sos_rootfs' : '0fc63daf-8483-4772-8e79-3d69d8477de4',
'uos_rootfs' : '0fc63daf-8483-4772-8e79-3d69d8477de4',
'vbmeta': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'vbmeta_a': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'vbmeta_b': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'multiboot' : '0fc63daf-8483-4772-8e79-3d69d8477de4',
'multiboot_a' : '0fc63daf-8483-4772-8e79-3d69d8477de4',
'multiboot_b' : '0fc63daf-8483-4772-8e79-3d69d8477de4',
'tos' : '0fc63daf-8483-4772-8e79-3d69d8477de4',
'tos_a' : '0fc63daf-8483-4772-8e79-3d69d8477de4',
'tos_b' : '0fc63daf-8483-4772-8e79-3d69d8477de4',
'system': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'system_a': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'system_b': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'esp': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'esp2': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'bootloader': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'bootloader_a': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'bootloader_b': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'bootloader2': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'bldr_utils': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'vendor': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'vendor_a': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'vendor_b': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'vendor_boot': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'vendor_boot_a': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'vendor_boot_b': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'product': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'product_a': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'product_b': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'odm': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'odm_a': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'odm_b': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'acpi': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'acpi_a': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'acpi_b': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'acpio': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'acpio_a': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'acpio_b': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'cache': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'data': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'userdata': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'persistent': ('ebc597d0-2053-4b15-8b64-'
'e0aac75f4db1'),
'factory': ('0fc63daf-8483-4772-8e79-'
'3d69d8477de4'),
'config': ('0fc63daf-8483-4772-8e79-'
'3d69d8477de4'),
'mfos':'4f33cfe4-a0c1-448b-aec4-40f10a0cef3f',
'teedata': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'super': '0fc63daf-8483-4772-8e79-3d69d8477de4',
'reserved': '0fc63daf-8483-4772-8e79-3d69d8477de4'
}
}
# checks if the partition type used is available
if entry_info.type in types:
if isinstance(types[entry_info.type], dict):
tuuid = UUID(types[entry_info.type][entry_info.label]).bytes_le
else:
tuuid = UUID(types[entry_info.type]).bytes_le
else:
error('Unknown partition type: {0} {1}'
.format(entry_info.label, entry_info.type))
exit(-1)
# sets the partition uuid
puuid = UUID(entry_info.uuid).bytes_le
last = int(entry_info.size) + int(entry_info.begin) - 1
self.raw = pack(TableEntryInfos._FMT, tuuid, puuid,
int(entry_info.begin), last, 0,
entry_info.label.encode('utf-16le'))
img_file.seek(offset)
img_file.write(self.raw)
TLB_INFO = namedtuple('TLB_INFO', ('begin', 'size', 'type', 'uuid', 'label'))
class TLBInfos(list):
"""
TLB information extracted from the TLB partition file
"""
__slots__ = ('path', 'format', 'slotab')
def __init__(self, path):
super(TLBInfos, self).__init__()
self.path = path
self._set_format()
self.slotab = 0
def __repr__(self):
result = ''
for item in self:
line = ('add -b {0} -s {1} -t {2} -u {3} -l {4}'
'\n').format(item.begin, item.size, item.type, item.uuid,
item.label)
result = '{0}{1}'.format(result, line)
return result
def _set_format(self):
"""
Identify the format of the TLB partition file
"""
self.format = 'ini'
with open(self.path, 'r') as tlb_file:
for line in tlb_file:
# determines the type of partition table file
# If file contains "partition_table=gpt" pattern then
# it's a JSON TLB partition file,
# else it's probably an INI TLB partition file.
# Parser will then check if the file is correct.
tlb_file_type_found = line.find("partition_table=gpt")
if tlb_file_type_found != -1:
self.format = 'tbl'
break
debug('Partition table format: {0}'.format(self.format))
def _read_json(self, block_size):
"""
Used to read a JSON TLB partition file
"""
with open(self.path, 'rb') as tlb_file:
re_parser = re_compile(r'^add\s-b\s(?P<begin>\w+)\s-s\s'
'(?P<size>[\w$()-]+)\s-t\s'
'(?P<type>\w+)\s-u\s'
'(?P<uuid>[\w-]+)\s'
'-l\s(?P<label>\w+)'
)
# reads the JSON TLB file to instantiate a the TLBInfos
for line in tlb_file:
debug('TLB reading line: {0}'.format(line))
parsed_line = re_parser.match(line)
if parsed_line:
debug('TLB parsed line: {0}'.format(line))
debug('\t begin: {0}'
.format(parsed_line.group('begin')))
debug('\t size: {0}'.format(parsed_line.group('size')))
debug('\t type: {0}'.format(parsed_line.group('type')))
debug('\t uuid: {0}'.format(parsed_line.group('uuid')))
debug('\t label: {0}'
.format(parsed_line.group('label')))
self.append(TLB_INFO(*parsed_line.groups()))
else:
debug('TLB not parsed line: {0}'.format(line))
def _preparse_partitions(self, cfg):
"""
Taken from gpt_ini2bin.py
"""
with open(self.path, 'r') as f:
data = f.read()
try:
self.slotab = cfg.getint('base', 'nb_slot')
except NoOptionError:
self.slotab = 0
start_part = cfg.get('base', 'partitions').split()
try:
slot_group_bsp = cfg.get('base.slot_group_bsp', 'partitions').split()
except NoSectionError:
slot_group_bsp = []
try:
slot_group_aosp = cfg.get('base.slot_group_aosp', 'partitions').split()
except NoSectionError:
slot_group_aosp = []
try:
end_part = cfg.get('base.end', 'partitions').split()
except NoSectionError:
end_part = []
for l in data.split('\n'):
words = l.split()
if len(words) > 2:
if words[0] == 'partitions' and words[1] == '+=':
start_part += words[2:]
return start_part, slot_group_bsp, slot_group_aosp, end_part
def _contruct_tlb_info(self, start_lba, cfg, block_size, parts):
for part in parts:
partname = 'partition.{0}'.format(part)
ptype = cfg.get(partname, 'type')
label = cfg.get(partname, 'label')
nb_slots = 1
if self.slotab == 2:
try:
if cfg.get(partname, 'has_slot') == 'true':
nb_slots = 2
except NoOptionError:
nb_slots = 1
for slot_id in range(nb_slots):
try:
begin = cfg.get(partname, 'start_lba')
begin = int(begin.split(',')[slot_id])
except NoOptionError:
begin = start_lba
try:
readlen = cfg.get(partname, 'len')
readlen = int(readlen.split(',')[slot_id])
except IndexError:
readlen = cfg.getint(partname, 'len')
if readlen > 0:
size = (readlen * 1024 * 1024) // block_size
start_lba = begin + size
else:
size = readlen
uuid = str(uuid4())
if nb_slots == 1:
self.append(TLB_INFO(begin, size, ptype, uuid, label))
break
self.append(TLB_INFO(begin, size, ptype, uuid,
label + '_%c' % (ord('a') + slot_id)))
return start_lba
def _contruct_tlb_grp_info(self, start_lba, cfg, block_size, parts):
for grp_id in range(self.slotab):
for part in parts:
partname = 'partition.{0}'.format(part)
ptype = cfg.get(partname, 'type')
uuid = str(uuid4())
label = cfg.get(partname, 'label')
try:
readlen = cfg.get(partname, 'len')
readlen = int(readlen.split(',')[grp_id])
except IndexError:
readlen = cfg.getint(partname, 'len')
try:
begin = cfg.get(partname, 'start_lba')
begin = int(begin.split(',')[grp_id])
except NoOptionError:
begin = start_lba
if readlen > 0:
size = (readlen * 1024 * 1024) // block_size
start_lba = begin + size
else:
size = readlen
self.append(TLB_INFO(begin, size, ptype, uuid,
label + '_%c' % (ord('a') + grp_id)))
return start_lba
def _read_ini(self, block_size):
"""
Used to read a INI TLB partition file
"""
# sets a parser to read the INI TLB partition file
cfg = ConfigParser(strict=False)
try:
cfg.read(self.path)
except ParsingError:
error('Invalid TLB partition file: {0}'.format(self.path))
exit(-1)
# gpt.ini is not a "standard" ini file because keys are not uniques
start_part, slot_group_bsp, slot_group_aosp, end_part = self._preparse_partitions(cfg)
# sets the start lba value which the read value or uses the default
# value
try:
start_lba_prev = cfg.getint('base', 'start_lba')
debug('The start_lba value read in the TLB partition file')
except NoOptionError:
# set start lba to offset 1M bytes, align with kernelflinger
start_lba_prev = 1024 * 1024 // block_size
info('The start_lba value is undefined in the TLB partition file,'
' the default value is used: {0}'.format(start_lba_prev))
# contructs the TLB info
start_lba = self._contruct_tlb_info(start_lba_prev, cfg, block_size,
start_part)
start_lba = self._contruct_tlb_grp_info(start_lba, cfg, block_size,
slot_group_bsp)
start_lba = self._contruct_tlb_grp_info(start_lba, cfg, block_size,
slot_group_aosp)
self._contruct_tlb_info(start_lba, cfg, block_size, end_part)
def read(self, block_size):
"""
Read a TLB file
"""
# reads the JSON TLB partition file
if self.format == 'tbl':
self._read_json(block_size)
# reads the INI TLB partition file
else:
self._read_ini(block_size)
def _recompute_partition_begin(self):
"""
Ensure that partitions do not overlap
"""
new_begin = -1
for pos, entry in enumerate(self):
if new_begin == -1:
new_begin = self[pos].begin + self[pos].size
continue
self[pos] = self[pos]._replace(begin=new_begin)
new_begin += self[pos].size
def compute_last_size_entry(self, img_size, block_size, entry_size,
table_length):
"""
Compute the size of the last TLB entry
"""
last = -1
# reserve the size for primary and secondary gpt
MB = 1024 * 1024
remaining_size = (img_size - MB) // block_size - 2048
for pos, entry in enumerate(self):
debug('Entry size: {0}'.format(entry.size))
if entry.size < 0:
if (last == -1):
last = pos
continue
else:
error('Only one partition of size -1 allowed')
exit(-1)
remaining_size -= entry.size
# if all entries size are already defined
if last == -1:
debug('All entry sizes are already defined.')
return
if remaining_size < 0:
error('The image size is too small regarding partition mapping.')
missing = -remaining_size * block_size
error('Missing at least: {0} Bytes.'.format(missing))
exit(-1)
# Update the size of the partition with -1 size and recompute
# the start of each partitions after it
self[last] = self[last]._replace(size=remaining_size)
self._recompute_partition_begin()
class GPTImage(object):
"""
GPT/UEFI image.
"""
__slots__ = ('path', 'size', 'block_size', 'mbr',
'gpt_header', 'table')
ANDROID_PARTITIONS = [
'xen_dom0',
'xen_misc',
'xen_guest',
'xen_rootfs',
'sos_boot',
'uos_boot',
'android_guest',
'sos_rootfs',
'uos_rootfs',
'vbmeta',
'multiboot',
'esp',
'esp2',
'bootloader',
'bootloader2',
'bldr_utils',
'boot',
'recovery',
'misc',
'metadata',
'system',
'vendor',
'vendor_boot',
'product',
'odm',
'acpi',
'acpio',
'cache',
'data',
'userdata',
'persistent',
'factory',
'config',
'tos',
'mfos',
'teedata',
'super',
'reserved'
]
def __init__(self, path, size='5G', block_size=512, gpt_header_size=92):
self.path = path
self.size = GPTImage.convert_size_to_bytes(size)
self.block_size = block_size
self.mbr = MBRInfos(self.block_size)
self.gpt_header = GPTHeaderInfos(self.size, block_size,
gpt_header_size)
self.table = PartTableInfos()
def __repr__(self):
result = 'Read EFI information from {0}.\n'.format(self.path)
result = '{0}{1}'.format(result, self.mbr)
result = '{0}{1}'.format(result, self.gpt_header)
result = '{0}{1}'.format(result, self.table)
return result
@classmethod
def convert_size_to_bytes(cls, str_size):
"""
Checks and converts the image size to Bytes.
"""
units = ('B', 'K', 'M', 'G')
unit = str_size[-1:].upper()
# the image size is invalid
if unit not in units:
error('The size of GPT/UEFI image use an invalid unit: {0}'
.format(str_size))
exit(-1)
try:
# convert string size to an integer
value = int(str_size[:-1])
except ValueError:
error('The size of GPT/UEFI image is invalid: {0}'
.format(str_size))
exit(-1)
# the value is negative
if value < 0:
error('The size of GPT/UEFI image is a negative value: {0}'
.format(str_size))
exit(-1)
# the value is a Bytes
if unit == units[0]:
return int(str_size[:-1])
index = units.index(unit)
return value * 1024**index
def read(self):
"""
Read information from a GPT/UEFI image
"""
# opens and reads the image file
with open(self.path, 'rb') as img_file:
# reads the MBR of the image file
debug('Reading MBR from {0}'.format(self.path))
self.mbr.read(img_file)
# reads the GPT header of the image file
debug('Reading GPT header from {0}'.format(self.path))
offset = self.block_size
self.gpt_header.read(img_file, offset)
# reads the partition table of the image file
debug('Reading partition table from {0}'.format(self.path))
offset = self.block_size * self.gpt_header.lba_start
self.table.read(img_file, offset, self.gpt_header.table_length,
self.gpt_header.entry_size)
def _write_crc(self, img_file):
"""
Calculate and write CRC32 of GPT partition table, header and backup
"""
# reads partition tables
img_file.seek(2 * self.block_size)
raw_table = img_file.read(self.gpt_header.table_length *
self.gpt_header.entry_size)
img_file.seek((self.gpt_header.lba_backup - 32) * self.block_size)
raw_backup_table = img_file.read(self.gpt_header.table_length *
self.gpt_header.entry_size)
# computes CRC 32 partition tables
table_crc = crc32(raw_table) & 0xffffffff
backup_table_crc = crc32(raw_backup_table) & 0xffffffff
# creates raw with the calculated CRC32 of partition tables
raw_table_crc = pack('<I', table_crc)
raw_backup_table_crc = pack('<I', backup_table_crc)
# writes the calculated CRC 32 of partition table in GPT header
img_file.seek(self.block_size + 88)
img_file.write(raw_table_crc)
# writes the calculated CRC 32 of partition table in GPT backup
img_file.seek(self.size - self.block_size + 88)
img_file.write(raw_backup_table_crc)
# reads the GPT header
img_file.seek(self.block_size)
raw_header = img_file.read(self.gpt_header.size)
# calcultates the CRC 32 of GPT header
header_crc = crc32(raw_header) & 0xffffffff
# creates a raw with the calculated CRC32 of GPT header
raw_header_crc = pack('<I', header_crc)
# writes calculated CRC 32 of GPT header
img_file.seek(self.block_size + 16)
img_file.write(raw_header_crc)
# reads the GPT backup
img_file.seek(self.size - self.block_size)
raw_backup = img_file.read(self.gpt_header.size)