forked from K0lb3/UnityPy
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathBundleFile.py
More file actions
625 lines (525 loc) · 22.2 KB
/
Copy pathBundleFile.py
File metadata and controls
625 lines (525 loc) · 22.2 KB
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
# TODO: implement encryption for saving files
from abc import ABC, ABCMeta
from enum import IntEnum, IntFlag
from typing import Annotated, List, Optional, Self, Union
from attr import define
from ..helpers import CompressionHelper
from ..helpers.ArchiveStorageManager import ArchiveStorageDecryptor
from ..helpers.Tpk import UnityVersion
from ..streams import EndianBinaryReader, EndianBinaryWriter
from .File import ContainerFile, DirectoryInfo, File, parseable_filetype
@define(slots=True)
class BlockInfo:
flags: int
compressed_size: int
decompressed_size: int
offset: int
class CompressionFlags(IntEnum):
NONE = 0
LZMA = 1
LZ4 = 2
LZ4HC = 3
LZHAM = 4
class ArchiveFlagsOld(IntFlag):
CompressionTypeMask = 0x3F
BlocksAndDirectoryInfoCombined = 0x40
BlocksInfoAtTheEnd = 0x80
OldWebPluginCompatibility = 0x100
UsesAssetBundleEncryption = 0x200
class ArchiveFlags(IntFlag):
CompressionTypeMask = 0x3F
BlocksAndDirectoryInfoCombined = 0x40
BlocksInfoAtTheEnd = 0x80
OldWebPluginCompatibility = 0x100
BlockInfoNeedPaddingAtStart = 0x200
UsesAssetBundleEncryption = 0x400
class BundleFile(ContainerFile, ABC, metaclass=ABCMeta):
signature: str
stream_version: int
unity_version: str
minimum_revision: str
block_infos: List[BlockInfo]
block_reader: EndianBinaryReader
def parse(self, reader: Optional[EndianBinaryReader] = None) -> Self:
reader = self._opt_get_set_reader(reader)
self.signature = reader.read_string_to_null()
self.stream_version = reader.read_u_int()
if self.stream_version > 0x1000000:
reader.seek(reader.tell() - 4)
reader.endian = "<" if reader.endian == ">" else ">"
self.stream_version = reader.read_u_int()
self.unity_version = reader.read_string_to_null()
self.minimum_revision = reader.read_string_to_null()
return self
def dump(self, writer: Optional[EndianBinaryWriter] = None) -> EndianBinaryWriter:
writer = writer or EndianBinaryWriter(endian=self.reader.endian)
writer.write_string_to_null(self.signature)
writer.write_u_int(self.stream_version)
writer.write_string_to_null(self.unity_version)
writer.write_string_to_null(self.minimum_revision)
return writer
@parseable_filetype
class BundleFileArchive(BundleFile):
@classmethod
def probe(cls, reader: EndianBinaryReader) -> bool:
signature = reader.read_string_to_null()
return signature == "UnityArchive"
def parse(self, reader: Optional[EndianBinaryReader] = None) -> Self:
super().parse(reader)
raise NotImplementedError("BundleFile - UnityArchive")
def dump(self, writer: Optional[EndianBinaryWriter] = None) -> EndianBinaryWriter:
raise NotImplementedError("BundleFile - UnityArchive")
@parseable_filetype
class BundleFileFS(BundleFile):
size: int
version: UnityVersion
dataflags: Union[ArchiveFlags, ArchiveFlagsOld]
decompressed_data_hash: Annotated[bytes, 16]
uses_block_alignment: bool = False
decryptor: Optional[ArchiveStorageDecryptor] = None
@classmethod
def probe(cls, reader: EndianBinaryReader) -> bool:
signature = reader.read_string_to_null()
endian = reader.endian
reader.endian = ">"
version = reader.read_u_int()
reader.endian = endian
return signature == "UnityFS" or (signature == "UnityRaw" and version == 6)
def parse(self, reader: Optional[EndianBinaryReader] = None) -> Self:
reader = self._opt_get_set_reader(reader)
super().parse(reader)
self.size = reader.read_long()
# header
header_compressed_size, header_uncompressed_size, dataflags = (
reader.read_u_int_array(3)
)
# https://issuetracker.unity3d.com/issues/files-within-assetbundles-do-not-start-on-aligned-boundaries-breaking-patching-on-nintendo-switch
# Unity CN introduced encryption before the alignment fix was introduced.
# Unity CN used the same flag for the encryption as later on the alignment fix,
# so we have to check the version to determine the correct flag set.
version = UnityVersion.fromString(self.minimum_revision)
self.version = version
if (
# < 2000, < 2020.3.34, < 2021.3.2, < 2022.1.1
version.major < 2020
or (version.major == 2020 and version < UnityVersion.fromList(2020, 3, 34))
or (version.major == 2021 and version < UnityVersion.fromList(2021, 3, 2))
or (version.major == 2022 and version < UnityVersion.fromList(2022, 1, 1))
):
self.dataflags = ArchiveFlagsOld(dataflags)
else:
self.dataflags = ArchiveFlags(dataflags)
if self.dataflags & self.dataflags.UsesAssetBundleEncryption:
self.decryptor = ArchiveStorageDecryptor(reader)
# check if we need to align the reader
# - align to 16 bytes and check if all are 0
# - if not, reset the reader to the previous position
if self.stream_version >= 7:
reader.align_stream(16)
self.uses_block_alignment = True
elif version >= UnityVersion.fromList(2019, 4):
pre_align = reader.tell()
align_data = reader.read((16 - pre_align % 16) % 16)
if any(align_data):
reader.seek(pre_align)
else:
self.uses_block_alignment = True
start = reader.tell()
seek_back = -1
if (
self.dataflags & ArchiveFlags.BlocksInfoAtTheEnd
): # kArchiveBlocksInfoAtTheEnd
seek_back = reader.tell()
reader.seek(reader.Length - header_compressed_size)
# else: # 0x40 kArchiveBlocksAndDirectoryInfoCombined
blocksInfoBytes = reader.read_bytes(header_compressed_size)
blocksInfoBytes = self._decompress_data(
blocksInfoBytes, header_uncompressed_size, self.dataflags
)
blocksInfoReader = EndianBinaryReader(blocksInfoBytes, offset=start)
self.decompressed_data_hash = blocksInfoReader.read_bytes(16)
blocksInfoCount = blocksInfoReader.read_int()
assert blocksInfoCount > 0, "blocksInfoCount <= 0"
block_offset = 0
def offset(compressed_size: int):
nonlocal block_offset
old_offset = block_offset
block_offset += compressed_size
return old_offset
self.block_infos = [
BlockInfo(
flags,
compressed_size,
decompressed_size,
offset(compressed_size),
)
for (
decompressed_size,
compressed_size,
flags,
) in blocksInfoReader.unpack_array("IIH", blocksInfoCount)
]
directory_count = blocksInfoReader.read_int()
self.directory_infos = [
DirectoryInfo(
offset=blocksInfoReader.read_long(), # offset
size=blocksInfoReader.read_long(), # size
flags=blocksInfoReader.read_u_int(), # flags
path=blocksInfoReader.read_string_to_null(), # path
)
for _ in range(directory_count)
]
if seek_back != -1:
reader.seek(seek_back)
if (
isinstance(self.dataflags, ArchiveFlags)
and self.dataflags & ArchiveFlags.BlockInfoNeedPaddingAtStart
):
reader.align_stream(16)
self.directory_reader = EndianBinaryReader(
b"".join(
self._decompress_data(
reader.read_bytes(blockInfo.compressed_size),
blockInfo.decompressed_size,
blockInfo.flags,
i,
)
for i, blockInfo in enumerate(self.block_infos)
),
offset=(blocksInfoReader.real_offset()),
)
return self
def dump(
self,
writer: Optional[EndianBinaryWriter] = None,
block_chunk_flag: Optional[int] = None,
block_chunk_size: Optional[int] = None,
) -> EndianBinaryWriter:
# File Structure:
# header:
# ...
# size
# compressedSize
# uncompressedSize
# dataflags
# ..align/seek to end
# compressed block info data
# hash
# blockCount
# blockInfos
# directoryCount
# directoryInfos
# compressed directory data (offset of previous in total)
writer = super().dump(writer)
# munch childs/files together
new_directory_infos: List[DirectoryInfo] = []
childs = self.childs or self.directory_infos
directory_info_flag = (
self.directory_infos[0].flags if self.directory_infos else 0
)
directory_datas = []
uncompressed_directory_datas_size = 0
childs = self.childs or self.directory_infos
for child in childs:
if isinstance(child, File):
child_data = child.dump().get_bytes()
path = child.name
else:
self.directory_reader.seek(child.offset)
child_data = self.directory_reader.read(child.size)
path = child.path
new_directory_infos.append(
DirectoryInfo(
path=path,
offset=uncompressed_directory_datas_size,
size=len(child_data),
flags=directory_info_flag,
)
)
directory_datas.append(child_data)
uncompressed_directory_datas_size += len(child_data)
directory_datas = b"".join(directory_datas)
# compress blocks
new_block_infos: List[BlockInfo] = []
compressed_directory_datas = []
compressed_directory_datas_size = 0
block_chunk_flag = block_chunk_flag or self.block_infos[0].flags
block_chunk_size = block_chunk_size or self.block_infos[0].decompressed_size
for chunk_start in range(0, len(directory_datas), block_chunk_size):
chunk = directory_datas[chunk_start : chunk_start + block_chunk_size]
compressed_chunk = self._compress_data(chunk, block_chunk_flag)
new_block_infos.append(
BlockInfo(
flags=block_chunk_flag,
compressed_size=len(compressed_chunk),
decompressed_size=len(chunk),
offset=compressed_directory_datas_size,
)
)
compressed_directory_datas.append(compressed_chunk)
compressed_directory_datas_size += len(compressed_chunk)
compressed_directory_datas = b"".join(compressed_directory_datas)
del directory_datas
# write block info
block_info_writer = EndianBinaryWriter(endian=">")
# decompressed_data_hash seems to be nearly always 16x 0
block_info_writer.write_bytes(self.decompressed_data_hash)
block_info_writer.write_int(len(new_block_infos))
for block_info in new_block_infos:
block_info_writer.write_int(block_info.decompressed_size)
block_info_writer.write_int(block_info.compressed_size)
block_info_writer.write_u_short(block_info.flags)
block_info_writer.write_int(len(new_directory_infos))
for directory_info in new_directory_infos:
block_info_writer.write_long(directory_info.offset)
block_info_writer.write_long(directory_info.size)
block_info_writer.write_u_int(directory_info.flags)
block_info_writer.write_string_to_null(directory_info.path)
uncompressed_block_info_size = block_info_writer.tell()
compressed_block_info = self._compress_data(
block_info_writer.bytes, self.dataflags
)
del block_info_writer
# estimate size
def align(alignment: int, value: int) -> int:
return (alignment - value % alignment) % alignment
size = writer.Position + 8 + 12 # total size, block header sizes & flag
if self.stream_version >= 7 or self.uses_block_alignment:
size += align(16, size)
if (
self.dataflags & ArchiveFlags.BlocksInfoAtTheEnd
): # kArchiveBlocksInfoAtTheEnd
if (
isinstance(self.dataflags, ArchiveFlags)
and self.dataflags & ArchiveFlags.BlockInfoNeedPaddingAtStart
):
size += align(16, size)
size += len(compressed_directory_datas)
size += len(compressed_block_info)
else:
size += len(compressed_block_info)
if (
isinstance(self.dataflags, ArchiveFlags)
and self.dataflags & ArchiveFlags.BlockInfoNeedPaddingAtStart
):
size += align(16, size)
size += len(compressed_directory_datas)
# write file
writer.write_long(size)
writer.write_u_int(len(compressed_block_info))
writer.write_u_int(uncompressed_block_info_size)
dataflags = self.dataflags
if dataflags & dataflags.UsesAssetBundleEncryption:
dataflags ^= dataflags.UsesAssetBundleEncryption
writer.write_u_int(dataflags)
if self.stream_version >= 7 or self.uses_block_alignment:
writer.align_stream(16)
if (
self.dataflags & ArchiveFlags.BlocksInfoAtTheEnd
): # kArchiveBlocksInfoAtTheEnd
if (
isinstance(self.dataflags, ArchiveFlags)
and self.dataflags & ArchiveFlags.BlockInfoNeedPaddingAtStart
):
writer.align_stream(16)
writer.write_bytes(compressed_directory_datas)
writer.write_bytes(compressed_block_info)
else:
writer.write_bytes(compressed_block_info)
if (
isinstance(self.dataflags, ArchiveFlags)
and self.dataflags & ArchiveFlags.BlockInfoNeedPaddingAtStart
):
writer.align_stream(16)
writer.write_bytes(compressed_directory_datas)
return writer
def _decompress_data(
self,
compressed_data: bytes,
uncompressed_size: int,
flags: Union[int, ArchiveFlags, ArchiveFlagsOld],
index: int = 0,
) -> bytes:
"""
Parameters
----------
compressed_data : bytes
The compressed data.
uncompressed_size : int
The uncompressed size of the data.
flags : int
The flags of the data.
Returns
-------
bytes
The decompressed data."""
comp_flag = CompressionFlags(flags & ArchiveFlags.CompressionTypeMask)
if comp_flag == CompressionFlags.LZMA: # LZMA
return CompressionHelper.decompress_lzma(compressed_data)
elif comp_flag in [CompressionFlags.LZ4, CompressionFlags.LZ4HC]: # LZ4, LZ4HC
if self.decryptor is not None and flags & 0x100:
compressed_data = self.decryptor.decrypt_block(compressed_data, index)
return CompressionHelper.decompress_lz4(compressed_data, uncompressed_size)
elif comp_flag == CompressionFlags.LZHAM: # LZHAM
raise NotImplementedError("LZHAM decompression not implemented")
else:
return compressed_data
def _compress_data(
self, data: bytes, flags: Union[int, ArchiveFlags, ArchiveFlagsOld]
) -> bytes:
"""
Parameters
----------
data : bytes
The data to compress.
flags : int
The flags of the data.
Returns
-------
bytes
The compressed data."""
comp_flag = CompressionFlags(flags & ArchiveFlags.CompressionTypeMask)
if comp_flag == CompressionFlags.LZMA: # LZMA
return CompressionHelper.compress_lzma(data)
elif comp_flag in [CompressionFlags.LZ4, CompressionFlags.LZ4HC]: # LZ4, LZ4HC
return CompressionHelper.compress_lz4(data)
elif comp_flag == CompressionFlags.LZHAM: # LZHAM
raise NotImplementedError("LZHAM compression not implemented")
else:
return data
@parseable_filetype
class BundleFileWeb(BundleFile):
byteStart: int
numberOfLevelsToDownloadBeforeStreaming: int
hash: Optional[Annotated[bytes, 16]]
crc: Optional[int]
completeFileSize = Optional[int]
fileInfoHeaderSize = Optional[int]
@classmethod
def probe(cls, reader: EndianBinaryReader) -> bool:
signature = reader.read_string_to_null()
endian = reader.endian
reader.endian = ">"
version = reader.read_u_int()
reader.endian = endian
return signature == "UnityWeb" or (signature == "UnityRaw" and version != 6)
def parse(self, reader: Optional[EndianBinaryReader] = None) -> Self:
reader = self._opt_get_set_reader(reader)
super().parse(reader)
version = self.stream_version
if version >= 4:
self.hash = reader.read_bytes(16)
self.crc = reader.read_u_int()
self.byteStart = reader.read_u_int()
headerSize = reader.read_u_int()
self.numberOfLevelsToDownloadBeforeStreaming = reader.read_u_int()
levelCount = reader.read_int()
self.block_infos = [
BlockInfo(
compressed_size=reader.read_u_int(), # compressedSize
decompressed_size=reader.read_u_int(), # uncompressedSize
flags=0,
offset=0,
)
for _ in range(levelCount)
]
block_offset = 0
for block in self.block_infos:
block.offset = block_offset
block_offset += block.compressed_size
if version >= 2:
self.completeFileSize = reader.read_u_int()
if version >= 3:
self.fileInfoHeaderSize = reader.read_u_int()
reader.seek(headerSize)
uncompressedBytes = reader.read_bytes(self.block_infos[-1].compressed_size)
if self.signature == "UnityWeb":
uncompressedBytes = CompressionHelper.decompress_lzma(
uncompressedBytes, True
)
directory_reader = EndianBinaryReader(uncompressedBytes, offset=headerSize)
self.directory_reader = directory_reader
nodesCount = directory_reader.read_int()
self.directory_infos = [
DirectoryInfo(
path=directory_reader.read_string_to_null(), # path
offset=directory_reader.read_u_int(), # offset
size=directory_reader.read_u_int(), # size
)
for _ in range(nodesCount)
]
return self
def dump(self, writer: Optional[EndianBinaryWriter] = None) -> EndianBinaryWriter:
writer = super().dump(writer)
# Calculate fileInfoHeaderSize for set offsets
file_info_header_size = 4 # for nodesCount
childs = self.childs or self.directory_infos
for child in childs:
file_info_header_size += (
len(child.name.encode("utf8")) + 1
) # +1 for null terminator
file_info_header_size += 4 * 2 # 4 bytes each for offset and size
file_info_header_padding_size = (
4 - (file_info_header_size % 4) if file_info_header_size % 4 != 0 else 0
)
file_info_header_size += file_info_header_padding_size
# Prepare directory info
directory_info_writer = EndianBinaryWriter()
directory_info_writer.write_int(len(self.files)) # nodesCount
file_content_writer = EndianBinaryWriter()
current_offset = file_info_header_size
for child in childs:
directory_info_writer.write_string_to_null(child.name)
directory_info_writer.write_u_int(current_offset)
# Get file content
if isinstance(child, File):
file_data = child.dump().get_bytes()
else:
self.directory_reader.seek(child.offset)
file_data = self.directory_reader.read_bytes(child.size)
file_size = len(file_data)
directory_info_writer.write_u_int(file_size)
file_content_writer.write_bytes(file_data)
current_offset += file_size
directory_info_writer.write(b"\x00" * file_info_header_padding_size)
uncompressed_directory_info = directory_info_writer.bytes
uncompressed_file_content = file_content_writer.bytes
# Combine directory info and file content
uncompressed_content = uncompressed_directory_info + uncompressed_file_content
compressed_content = uncompressed_content
if self.signature == "UnityWeb":
compressed_content = CompressionHelper.compress_lzma(
uncompressed_content, True
)
# Write header
header_size = writer.Position + 24 # assuming levelCount = 1
if self.stream_version >= 2:
header_size += 4
if self.stream_version >= 3:
header_size += 4
if self.stream_version >= 4:
header_size += 20
# pad to multiple of 4
header_size = (header_size + 3) & ~3
if self.stream_version >= 4:
writer.write_bytes(self.hash)
writer.write_u_int(self.crc)
writer.write_u_int(
header_size + len(compressed_content)
) # minimumStreamedBytes (same as completeFileSize)
writer.write_u_int(header_size) # headerSize
writer.write_u_int(1) # numberOfLevelsToDownloadBeforeStreaming (always 1)
writer.write_int(1) # levelCount (always 1)
writer.write_u_int(len(compressed_content)) # compressedSize
writer.write_u_int(len(uncompressed_content)) # uncompressedSize
if self.stream_version >= 2:
writer.write_u_int(
header_size + len(compressed_content)
) # completeFileSize
if self.stream_version >= 3:
writer.write_u_int(file_info_header_size) # file_info_header_size
# align header
writer.align_stream(4)
# Write compressed content
writer.write_bytes(compressed_content)
return writer