Savegames
This page describes the format, de/encryption, etc. of savegames found in 3DS game cartridges/gamecards. You can find savegames from various 3DS games on the Games page.
Encryption
On the 3DS savegames are stored much like on the DS, that is on a FLASH chip in the gamecart. On the DS these savegames were stored in plain-text but on the 3DS a layer of encryption was added. This is highly likely a streamcipher, as the contents of several savegames exhibit the odd behavior that xor-ing certain parts of the savegame together will result in the plain-text appearing.
The reason this works is because the stream cipher used has a period of 512 bytes. That is to say, it will repeat the same keystream after 512 bytes. The way you encrypt with a stream cipher is you XOR your data with the keystream as it is produced. Unfortunately, if your streamcipher repeats and you are encrypting a known plain-text (in our case, zeros) you are basically giving away your valuable keystream.
So how do you use this to decrypt a savegame on a 3DS? First off, you chunk up the savegame into 512 byte chunks. Then, you bin these chunks by their contents, discarding any that contain only FF. Now look for the most common chunk. This is your keystream. Now XOR the keystream with your original savegame and you should have a fully decrypted savegame. XOR with the keystream again to produce an encrypted savegame.
Wear leveling
The 3DS employs a wear leveling scheme on the savegame FLASH chips. This is done through the usage of blockmaps and a journal. The blockmap is located at offset 0 of the flash chip, and is immediately followed by the journal. The initial state is dictated by the blockmap, and the journal is then applied to that.
First, there are 8 bytes whose purposes are currently unknown. Then comes the actual blockmap. The blockmap structure is simple:
struct header_entry {
uint8_t phys_sec; // when bit7 is set, block has checksums, otherwise checksums are all zero
uint8_t alloc_cnt;
uint8_t chksums[8];
} __attribute__((__packed__));
There's one entry per sector, counting from physical sector 1 (sector 0 contains the blockmap/journal).
The 2 bytes that follow the blockmap are the CRC16 (with starting value 0xFFFF (like modbus)) of the first 8 bytes and the blockmap.
Then comes the journal. The journal structure is as follows:
struct sector_entry {
uint8_t virt_sec; // Mapped to sector
uint8_t prev_virt_sec; // Physical sector previously mapped to
uint8_t phys_sec; // Mapped from sector
uint8_t prev_phys_sec; // Virtual sector previously mapped to
uint8_t phys_realloc_cnt; // Amount of times physical sector has been remapped
uint8_t virt_realloc_cnt; // Amount of times virtual sector has been remapped
uint8_t chksums[8];
} __attribute__((__packed__));
struct long_sector_entry{
struct sector_entry sector;
struct sector_entry dupe;
uint32_t magic;
}__attribute__((__packed__));
With magic being a constant 0x080d6ce0.
The checksums in the blockmap/journal entries work as follows:
- each byte is the checksum of an encrypted 0x200 bytes large block
- to calculate the checksum, a CRC16 of the block (with starting value 0xFFFF) is calculated, and the two bytes of the CRC16 are XORed together to produce the 8bit checksum
Partitions
There can be multiple partitions on the chip. For some games one is a backup partition, some other games seem to use only one partition, yet other games actually use multiple partitions. Partitions are defined at the start of the de-wearleveled blob. At offset 0x200 into the image, the DIFI blobs start. These 0x130 large blobs describe the partitions. Every DIFI blob describes a partition. In order to find the partitions, you will need the uint32_t at 0x9C into the DIFI block, and the uint32_t at 0xA4. The uint32_t at 0x9C describes the length of the hash table at the start of the partition, the uint32_t at 0xA4 is the length of the filesystem. Partitions are catted together, so the end of one partition is the beginning of the next.
The first partition starts at 0x2000. The hashtable at the start of the partitions describe each in-use block in the partition with a SHA256 of the 0x1000 sized block.
- The exact location of the partition can vary in each save/game.
- The first two hashes don't seem to be associated with any 0x1000 block.
- (edit) The last 0x20 bytes of the hash table, doesn't appear to change along with the rest of the data and repeats at the end of all other hash-tables, even when the hashes/data are different. (edit) The last 0x20 bytes of the hash table is NULL data, it is because the Hash table is only 0x1E0 in size and the XOR hash is 0x200 in size, so the 0x20 bytes you see at the end is actually 0x20 bytes of (FF) xor'd with the last 0x20 bytes of the key. Thus the data recurs. --Immortal 09:14, 19 August 2011 (GMT)
The hash in the DISA blob hashes 300 bytes of the first DIFI blob.
- If the uint32 before the hash in the DISA is 0x01, the first DIFI blob is hashed, if it's 0x00 the second DIFI is hashed. The offsets and size for each DIFI can be found beneath the DISA tag (10h, 20h and 18h, 30h relative to the DISA location).
The last 4 bytes in each DIFI blob are garbage; they appear as FF FF FF FF in an encrypted savegame.
Filesystem
Savefiles are stored on the FLASH in a custom filesystem called SAVE. SAVE has a header which describes where the various bits of the filesystem live.
The most important information in the savefile is the FST or filesystem table. You can find the FST by first finding the file base offset which is the offset to which all the entries in the FST are relative. The file base offset is a uint16_t at 0x58 from the filesystem start. The FST offset is a uint32_t at 0x6C and is in blocks (which are 0x200 bytes large).
For example, the Legend of Zelda: Ocarina of Time 3D SAVE header looks like this:
00001FF0: FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF ÿÿÿÿÿÿÿÿÿÿÿÿÿÿÿÿ 00002000: 53415645 00000400 20000000 00000000 SAVE.... ....... //Start of SAVE header 00002010: 68000000 00000000 00020000 00000000 h............... 00002020: 00000000 00020000 88000000 00000000 ........ˆ....... 00002030: 03000000 00020000 94000000 00000000 ........”....... 00002040: 09000000 00020000 B8000000 00000000 ........¸....... 00002050: 66000000 00020000 00040000 00000000 f............... //File base offset - 0x0400 (little endian byte ordering) 00002060: 66000000 00020000 00000000 01000000 f............... //FST offset - 0x00000001 (little endian byte ordering) * 0x200 00002070: 00000000 00020000 01000000 01000000 ................ 00002080: 08000000 00020000 01000000 00000000 ................ ...
Once you've found the FST, parsing it is fairly straightforward.
struct fs_entry {
u32 node_cnt;
u8 filename[0x10];
u32 index;
u32 unk1; // magic?
u32 block_offset;
u32 file_size;
u32 unk2;
u32 unk3; // flags and/or date?
u32 unk4;
}
The first entry is the root directory, easily identifiable by the node_cnt being larger than 1. The node_cnt includes the root directory itself, so there are node_cnt - 1 files in the root directory. The entries that follow after the root directory are the actual files. Reading them out is as simple as taking the file base offset and adding (block_offset * 0x200) to it.
Here's a follow-up example from the Legend of Zelda: Ocarina of Time 3D:
//FST entry = SAVE base + File base + (FST offset * 0x200) + (FST entry # * 0x30)
//0x2600 = 0x2000 + 0x400 + (0x1 * 0x200) + (0x0 * 0x30)
00002600: 03000000 09000000 00000000 00000000 ................
00002610: 00000000 00000000 00000000 00000000 ................
00002620: 00000000 00000000 00000000 00000000 ................
00002630: 01000000 73797374 656D2E64 61740000 ....system.dat..
00002640: 00000000 00000000 D57B1100 02000000 ........Õ{......
00002650: 22000000 00000000 E8121500 00000000 ".......è.......
00002660: 01000000 73617665 30302E62 696E0000 ....save00.bin..
00002670: 00000000 01000000 69921100 03000000 ........i’......
00002680: DC140000 00000000 04000000 00000000 Ü...............
Example for a different file with different SAVE structure:
00002400 53415645 00000400 20000000 00000000 SAVE.... ....... //Save from Steel Diver
00002410 28030000 00000000 00020000 00000000 (...............
00002420 00000000 00020000 88000000 00000000 ................
00002430 03000000 00020000 94000000 00000000 ................
00002440 43000000 00020000 A0010000 00000000 C...............
00002450 28030000 00020000 00000000 00000000 (............... //[0x58] = 0 and
00002460 28030000 00020000 E81A0000 00000000 (............... //[0x6C] = 0, but
00002470 00000000 00020000 381B0000 00000000 ........8....... //On offset 0x68 There's an exact offset to the FST
00002480 40000000 00020000 01000000 00000000 @............... //meaning a uint32_t at 0x68 into the SAVE struct
00002490 00000000 00000000 00000000 02000000 ................
00003F30 00000000 00000000 04000000 41000000 ............A... // first fs_entry '04 00 00 00'
00003F40 00000000 00000000 00000000 00000000 ................ //exectly 0x1B38 from the save header struct
00003F50 00000000 00000000 00000000 00000000 ................
00003F60 00000000 00000000 01000000 67686F73 ............ghos
00003F70 742E7374 30370000 00000000 00000000 t.st07..........
00003F80 D57B1100 00000000 7E290000 00000000 .{......~)......
00003F90 00000000 00000000 01000000 73617665 ............save
00003FA0 2E737562 00000000 00000000 01000000 .sub............
00003FB0 D57B1100 15000000 9C090000 00000000 .{..............
00003FC0 00000000 00000000 01000000 73617665 ............save
00003FD0 2E706572 69730000 00000000 02000000 .peris..........
00003FE0 D57B1100 1A000000 29070000 00000000 .{......).......
00003FF0 00000000 00000000 00000000 00000000 ................
known struct until now:
struct save_header {
char magic[4]; //'SAVE'
u8 unknown0[0x54];
u32 fst_offset;
u8 unknown1[0x10];
u32 fst_block_offset; //FST is in [fst_block_offset] * 0x200 + [fst_offset]
u8 unknown2[8]; //or
uint32 fst_exact_offset; //the exact offset from the header start
}
Initialization
When a save EEPROM contains all xFFFF blocks it's assumed uninitialized by the game cartridges and it initializes default data in place, without prompting the user.