Example 9: Flash Modification

This example demonstrates how to use the flash component to unpack, modify, and repack a raw flash dump. The included dump has ECC data mixed in with useful data. We want to strip out the ECC then modify the data before repacking.

Example OFRAK script:

 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
import argparse
import os

import test_ofrak.components
from ofrak import OFRAK, OFRAKContext, ResourceFilter
from ofrak.core.binary import BinaryPatchConfig, BinaryPatchModifier
from ofrak.core.flash import (
    FlashAttributes,
    FlashEccAttributes,
    FlashField,
    FlashFieldType,
    FlashResource,
    FlashLogicalDataResource,
)
from ofrak.core.ecc.reedsolomon import ReedSolomon

TEST_FILE = os.path.join(test_ofrak.components.ASSETS_DIR, "flash_test_plain.bin")

FLASH_ATTRIBUTES = FlashAttributes(
    data_block_format=[
        FlashField(FlashFieldType.DATA, 223),
        FlashField(FlashFieldType.ECC, 32),
    ],
    ecc_attributes=FlashEccAttributes(
        ecc_class=ReedSolomon(nsym=32),
    ),
)


async def main(ofrak_context: OFRAKContext, in_file: str, out_file: str):
    # Create root resource and tag
    root_resource = await ofrak_context.create_root_resource_from_file(in_file)
    root_resource.add_tag(FlashResource)
    await root_resource.save()

    # Add our attributes
    root_resource.add_attributes(FLASH_ATTRIBUTES)
    await root_resource.save()

    # Unpack
    await root_resource.unpack_recursively()
    print(f"Unpacked:\n{await root_resource.summarize_tree()}")

    # Get the logical data
    logical_data_resource = await root_resource.get_only_descendant(
        r_filter=ResourceFilter.with_tags(FlashLogicalDataResource),
    )

    # Modify the logical data
    new_data = b"INSERT ME!"
    patch_config = BinaryPatchConfig(0x16, new_data)
    await logical_data_resource.run(BinaryPatchModifier, patch_config)

    # Repack and save to disk
    await root_resource.flush_data_to_disk(out_file)
    print(f"Saved repacked dump to {out_file}!")
    print(await root_resource.summarize_tree())


if __name__ == "__main__":
    parser = argparse.ArgumentParser()
    parser.add_argument("--input-file", default=TEST_FILE)
    parser.add_argument("--output-file", default="./repacked_flash_dump.bin")
    args = parser.parse_args()

    ofrak = OFRAK()
    ofrak.run(main, args.input_file, args.output_file)