3dbrew

Changes

Extdata (edit)

Revision as of 20:55, 22 March 2024

8,228 bytes added ,  22 March
→‎Tools
Line 1: Line 1: −
This page describes the format and encryption of extdata, "extra data" stored on [[SD_Filesystem|SD card]] and [[Flash_Filesystem|NAND]].
+
This page describes the format and encryption of extdata, "extra data" stored on SD card and NAND, at:
−
At:
  −
* nand/data/<ID>/extdata/<ExtdataID-High>
  −
* sdmc/Nintendo 3DS/<ID0>/<ID1>/extdata/<ExtdataID-High>
     −
(ExtdataID-High is always 00000000 for SD, and always 00048000 for NAND) Some titles can have Quota.dat stored in these directories. The directory-name for these directories is the ExtdataID-Low. Then there's a sub-directory 00000000, which contains the actual extdata. Size and number of files in this dir varies per title.
+
* <code>nand/data/&lt;ID&gt;/extdata/&lt;ExtdataID-High&gt;</code>
−
NAND stores the shared extdata and is structured exactly the same way, see [[Flash Filesystem]].
+
* <code>sdmc/Nintendo 3DS/&lt;ID0&gt;/&lt;ID1&gt;/extdata/&lt;ExtdataID-High&gt;</code>
   −
Extdata image 00000001 contains a VSXE partition for the FST, the actual file data is stored in the following extdata images.
+
ExtdataID-High is always 00000000 for SD, and always 00048000 for NAND. Regular apps can only mount SD extdata using the same extdataID which is stored in the CXI exheader. Therefore, regular apps which have the exheader extdataID set to zero can't use extdata. This restriction doesn't apply for shared extdata with extdataID high bitmask 0x48000 stored on NAND. System apps with a certain access right can mount arbitrary extdata. All NAND extdata is shared extdata, while all SD extdata is normal extdata.
   −
Regular apps can only mount SD extdata using the same extdataID which is stored in the [[NCCH#CXI|CXI]] exheader. Therefore, regular apps which have the exheader extdataID set to zero can't use extdata. This restriction doesn't apply for shared extdata with extdataID high bitmask 0x48000 stored on NAND. System apps with a certain access right can mount arbitrary extdata.
+
All data in this page is little-endian. All &quot;unused / padding&quot; fields can contain uninitialized data unless otherwise specified.
−
All NAND extdata is shared extdata, while all SD extdata is normal extdata. Thus, normal extdata doesn't exist on NAND, and shared extdata doesn't exist on SD. The extdataID high excluding that bitmask is always zero for shared extdata.
     −
=== Encryption ===
+
= Format =
   −
These files are [[AES|encrypted]] with AES-CTR, the keyslot is initialized by [[nand/private/movable.sed|movable.sed]]. The same keyslot is used for the NAND/SD extdata MAC. The NAND extdata images are stored in cleartext. The WCHAR LowPath "/extdata/<ExtdataIDHigh>/<ExtdataIDLow>/<PathToImage>" text path is hashed with SHA-256, including the WCHAR null-terminator. A separate hash is used for Quota.dat. The base CTR seems to be then generated by XORing the calculated hash: CTRword[i] = Hashword[i] ^ Hashword[4+i].
+
To avoid confusion, the terms '''device directory / file''' and '''virtual directory / file''' are used with the following meanings:
   −
The base CTR is fixed therefore the CTR never changes after each write. Thus it is possible to obtain some cleartext by XORing one file(like newly created extdata) with a newer file, where the newer file overwrote zeros in the original file with non-zero data.
+
* '''Device directory / file''' are the real directory / file stored on SD / NAND that can be seen under path <code>nand/data/&lt;ID&gt;/extdata/</code> or <code>sdmc/Nintendo 3DS/&lt;ID0&gt;/&lt;ID1&gt;/extdata/</code>.
 +
* '''Virtual directory / file''' are directory / file stored inside extdata virtual file system, which can be seen by applications in the mounted extdata archives.
   −
=== Filesystem ===
+
An extdata consists of several device directories and files, which forms a file system consisting of multiple virtual directories and files.
   −
Most extdata uses the same FS as [[savegames]], except extdata uses [[Savegames|DIFF]] instead of DISA. However some extdata files are raw, without any FS.
+
An extdata with ID <code>ExtdataId</code> has the following device files:
−
Quota.dat is an extdata image, however it's unknown what this is used for.
     −
'''QUOT'''
+
* <code>.../extdata/&lt;ExtdataID-High&gt;/&lt;ExtdataId-Low&gt;/Quota.dat</code> (optional)
 +
* <code>.../extdata/&lt;ExtdataID-High&gt;/&lt;ExtdataId-Low&gt;/&lt;SubDirID&gt;/&lt;SubFileID&gt;</code>
   −
* This is contained in the Quota.dat extdata image.
+
Note:
   −
{| class="wikitable"
+
* All device files are [[DISA and DIFF|DIFF containers]]. '''All format description below is about the inner content of the containers'''. Please unwrap these files first according to the DIFF format description before reading them using the extdata format description below.
−
|-
+
* <code>Quota.dat</code> is only observed existing for NAND shared extdata.
−
! Start
+
* <code>&lt;SubDirID&gt;</code> and <code>&lt;SubFileID&gt;</code> are 8-digit hex strings.
 +
* Device file with <code>SubDirID = SubFileID = 00000000</code> doesn't exist. Other ID combinations can exists.
 +
* Device file with <code>SubDirID = 00000000</code> and <code>SubFileID = 00000001</code> is the VSXE metadata file and must exist.
 +
* Other files, besides <code>Quota.dat</code> and <code>00000000/00000001</code>, are normal sub files, are these device files one-to-one correspond to virtual files. They contain raw virtual file data in the DIFF inner content.
 +
* <code>SubDirID = 00000000</code> is usually the only one device directory that can be seen. See [[#Device Directory Capacity]] for more information.
 +
 
 +
== Quota File ==
 +
 
 +
The inner data of <code>Quota.dat</code> is 0x48 bytes with the following format. The file seems to limit the extdata total size.
 +
 
 +
{| class="wikitable" border="1"
 +
! Offset
 
! Length
 
! Length
 
! Description
 
! Description
 
|-
 
|-
−
| 0x0
+
| 0x00
 +
| 4
 +
| Magic &quot;QUOT&quot;
 +
|-
 +
| 0x04
 
| 4
 
| 4
−
| Magic ("QUOT")
+
| Magic 0x30000
 
|-
 
|-
−
| 0x4
+
| 0x08
 
| 4
 
| 4
−
| Magic Number (0x30000)
+
| 0x1000, block size
 
|-
 
|-
−
| 0x8
+
| 0x0C
−
| 8
+
| 4
−
| Unknown
+
| Always 126. Probably device directory capacity. See the [[#Device Directory Capacity]] more information.
 
|-
 
|-
 
| 0x10
 
| 0x10
 +
| 4
 +
| Always 0?
 +
|-
 +
| 0x14
 +
| 4
 +
| Max number of blocks
 +
|-
 +
| 0x18
 +
| 4
 +
| Always 0?
 +
|-
 +
| 0x1C
 +
| 4
 +
| Free blocks remained
 +
|-
 +
| 0x20
 +
| 4
 +
| Always 0?
 +
|-
 +
| 0x24
 +
| 4
 +
| Always 0?
 +
|-
 +
| 0x28
 +
| 4
 +
| Free blocks remained + (blocks occupied by the recently mounted file, specified by the ID below (0 if recently deleted))
 +
|-
 +
| 0x2C
 +
| 4
 +
| Always 0?
 +
|-
 +
| 0x30
 +
| 4
 +
| ID of most recently mounted file. Same as the one in [[Inner_FAT#Filesystem Header]]
 +
|-
 +
| 0x34
 +
| 4
 +
| Always 0?
 +
|-
 
| 0x38
 
| 0x38
−
| Unknown
+
| 4
 +
| Always 0?
 +
|-
 +
| 0x3C
 +
| 4
 +
| Always 0?
 +
|-
 +
| 0x40
 +
| 4
 +
| Size in bytes of most recently mounted file (device file size). 0 if recently deleted
 +
|-
 +
| 0x44
 +
| 4
 +
| Always 0?
 
|}
 
|}
   −
==== Filesystem structure ====
+
== Device Directory Capacity ==
 +
 
 +
A device directory in an extdata (a <code>&lt;SubDirID&gt;</code> directory) seems to have a maximum number of device files it can contain. For SD extdata, this maximum number seems to be hard-coded as 126. For NAND extdata, the number is probably indicated by a field in Quota.dat, which is, again, always 126 as observed. 3DS FS tries to put all device files in the device directory <code>00000000</code> if possible, and only when more than 126 files needed to add, a second device directory <code>00000001</code> and so on are created. However, few extdata have such amount of files to store, so the behavior lacks of use cases to confirm.
 +
 
 +
The number 126 is probably from some kind of other capacity of 128 with <code>&quot;.&quot;</code> and <code>&quot;..&quot;</code> entries reserved. It is theorized that this is to keep a FAT directory table, with 0x20 bytes for each entry, in one 0x1000 cluster. The motivation is unclear.
 +
 
 +
== VSXE Filesystem ==
 +
 
 +
This is one variant of the [[Inner FAT|FAT filesystem]]. Please refer to its page for the description of the filesystem. In general, device file <code>00000000/00000001</code> contains the metadata of the filesystem, while other device files (except for the Quota file) contains normal sub-files
 +
 
 +
Each non-dummy file entry corresponds to a device file. The path to the device file is generated by the following computation:
 +
 
 +
<pre>// See previous section about this capacity
 +
const uint32_t device_dir_capacity = 126;
 +
 
 +
// entry index is the index in the file entry table, with the first dummy entry as
 +
// index = 0, which is never used for a real file.
 +
// file_index = 1 is reserved for the VSXE Filesystem Metadata itself, so real files
 +
// started from file_index = 2.
 +
uint32_t file_index = entry_index + 1;
 +
 
 +
uint32_t SubDirID = file_index / device_dir_capacity;
 +
uint32_t SubFileID = file_index % pdevice_dir_capacity;
 +
 
 +
char extdata_path[...]; // &quot;.../extdata/&lt;ExtdataID-High&gt;/&lt;ExtdataId-Low&gt;&quot;
 +
char device_path[...]; // output path
 +
sprintf(device_path, &quot;%s/%08x/%08x&quot;, extdata_path, SubDirID, SubFileID);
 +
</pre>
 +
When mounting extdata, the unique identifier is used to match the ID stored in subfile's [[DISA and DIFF#DIFF header|DIFF header]]. If the ID doesn't match, mounting will fail.
 +
 
 +
== Virtual File System Structure ==
 +
 
 +
When extdata is created, these are ''always'' created regardless of whether the title actually uses them.
 +
 
 +
* <code>/icon</code> This virtual file contains the extdata icon displayed in data management. This icon can only be written to by titles when creating extdata, titles would have to recreate extdata to change the icon. This file can't be read directly, instead it is read via FS:ReadExtSaveDataIcon.
 +
* <code>/user/</code> This virtual directory contains the title's actual extdata files.
 +
* <code>/boss/</code> This virtual directory can contain SpotPass content. SpotPass content can only be downloaded to this <code>/boss</code> virtual directory.
   −
When extdata is created, these are *always* created regardless of whether the title actually uses them.
+
User extdata and SpotPass extdata use separate mount points at <code>/user</code> and <code>/boss</code>. Therefore one mount can't access the other virtual directory, and also can't access <code>/icon</code>.(The title's SpotPass extdata can be mounted by the title itself, if it uses SpotPass)
−
User extdata and SpotPass extdata use separate [[FS:OpenArchive|mount]] points at /user and /boss. Therefore one mount can't access the other directory, and also can't access /icon.(The title's SpotPass extdata can be mounted by the title itself, if it uses SpotPass)
     −
* /icon This file contains the extdata [[SMDH|icon]] displayed in data management. This icon can only be written to by titles when creating extdata, titles would have to recreate extdata to change the icon. This file can't be read directly, instead it is read via [[FS:ReadExtSaveDataIcon]].
+
Other optional but notable directories include:
−
* /user/ Contains the title's actual extdata files.
  −
* /boss/ Can contain [[SpotPass]] content. SpotPass content can only be downloaded to this /boss directory.
     −
* /user/ExBanner This directory can optionally store [[Extended_Banner| extended banners]]. When this is available, this banner is displayed instead of the [[CXI]] ExeFS banner. COMMON.bin stores the common exbanner, while <regionlang_code>.bin stores an optional separate region/language specific banner.(regionlang_code can be "JPN_JP", "USA_EN", etc)
+
* <code>/user/ExBanner</code> This virtual directory can optionally store extended banners. When this is available, this banner is displayed instead of the CXI ExeFS banner. <code>COMMON.bin</code> stores the common exbanner, while <code>&lt;regionlang_code&gt;.bin</code> stores an optional separate region/language specific banner.(regionlang_code can be &quot;JPN_JP&quot;, &quot;USA_EN&quot;, etc)
   −
=== SD Extdata ===
+
== SD Extdata ==
 
Usually the ExtdataID low is in the format '00<Unique ID>'
 
Usually the ExtdataID low is in the format '00<Unique ID>'
   Line 75: Line 172:  
| 0000008f
 
| 0000008f
 
| 00000098
 
| 00000098
−
| Homemenu extdata, this contains home-menu savedata and cached icons for applications.
+
| [[Home Menu]] extdata, this contains home-menu savedata and cached icons for applications.
 
|  
 
|  
 
|-
 
|-
Line 87: Line 184:  
| 00000217
 
| 00000217
 
| 00000227
 
| 00000227
−
| Mii Maker, contains an ExBanner
+
| [[Mii Maker]], contains an ExBanner
 
| [https://dl.dropbox.com/u/20520664/extdata00000217.zip cleartext]
 
| [https://dl.dropbox.com/u/20520664/extdata00000217.zip cleartext]
 
|-
 
|-
 
| 00000208
 
| 00000208
−
| 00000217
+
| 00000218
 
| 00000228
 
| 00000228
 
| Streetpass Mii Plaza
 
| Streetpass Mii Plaza
Line 99: Line 196:  
| 00000219
 
| 00000219
 
| 00000229
 
| 00000229
−
| eShop
+
| [[eShop]], contains store music in AAC format.
 +
|
 +
|-
 +
| 0000020b
 +
| 0000021b
 +
| 0000022b
 +
| Nintendo Zone
 
|  
 
|  
 
|-
 
|-
Line 108: Line 211:  
|  
 
|  
 
|-
 
|-
−
| 0000020b
+
| 000002cc
−
| 0000021b
+
| 000002cd
−
| 0000022b
+
| 000002ce
−
| Nintendo Zone
+
| [[Home Menu]] theme
 
|  
 
|  
 
|-
 
|-
Line 121: Line 224:  
|  
 
|  
 
|-
 
|-
−
|?
+
|00000306
 
|00000308
 
|00000308
 
|00000307
 
|00000307
Line 133: Line 236:  
|  
 
|  
 
|-
 
|-
−
| ?
+
| 00000326
 
| 00000326
 
| 00000326
 
| 00000326
 
| 00000326
Line 170: Line 273:  
|-
 
|-
 
| ?
 
| ?
 +
| 00000517
 +
| 00000518
 +
| Swapnote
 +
|
 +
|-
 +
| 0000055d
 +
| 0000055d
 +
| 0000055d
 +
| Pokémon X<br>Pokémon Y
 +
|
 +
|-
 +
| ?
 +
| 00000725
 +
| 00000724
 +
| Ambassador Certificate
 +
|
 +
|-
 +
| ?
 +
| ?
 +
| 000007af
 +
| New Super Mario Bros. 2
 +
|
 +
|-
 +
| ?
 +
| 00000863
 +
| 00000864
 +
| Animal Crossing: New Leaf
 +
|
 +
|-
 
| ?
 
| ?
 +
| 00000a85
 
| 00000a86
 
| 00000a86
−
| Professor Layton and the Miracle Mask
+
| Professor Layton and the Miracle Mask<br>Professor Layton and the Azran Legacy
 +
German Version ExtdataID is 00000a87
 +
|
 +
|-
 +
| ?
 +
| ?
 +
| 00000b4f
 +
| Fullblox / Crashmo
 +
|
 +
|-
 +
| ?
 +
| ?
 +
| 00000ba9
 +
| Pokémon Mystery Dungeon: Gates to Infinity
 
|  
 
|  
 
|-
 
|-
Line 181: Line 327:  
|  
 
|  
 
|-
 
|-
−
| ?
+
| 00000c73
 
| 00000c73
 
| 00000c73
 
| 00000c73
 
| 00000c73
Line 190: Line 336:  
| ?
 
| ?
 
| 00000d9a
 
| 00000d9a
−
| Donkey Kong Country Returns 3d Trialer
+
| Donkey Kong Country™<br>Returns 3D: Trailer
 +
|
 +
|-
 +
| ?
 +
| ?
 +
| 00000ea6
 +
| Etrian Odyssey IV
 +
|
 +
|-
 +
| ?
 +
| 00000edf
 +
| 00000ee0
 +
| Super Smash Bros. for Nintendo 3DS
 +
|
 +
|-
 +
| ?
 +
| 00000f14
 +
| 00000f1e
 +
| Phoenix Wright: Ace Attorney - Dual Destinies
 +
|
 +
|-
 +
| ?
 +
| 00001007
 +
| 00001005
 +
| Professor Layton vs Phoenix Wright: Ace Attorney
 +
|
 +
|-
 +
| ?
 +
| ?
 +
| 00001062
 +
| Nintendo Pocket Football Club
 +
|
 +
|-
 +
| ?
 +
| ?
 +
| 0000111c
 +
| Yoshi's New Island
 +
|
 +
|-
 +
| ?
 +
| 00001132
 +
| 00001131
 +
| Fantasy Life
 +
|
 +
|-
 +
| 000011c5
 +
| 000011c5
 +
| 000011c5
 +
| Pokémon Omega Ruby<br>Pokémon Alpha Sapphire
 +
|
 +
|-
 +
| ?
 +
| 000012c8
 +
| 000012ca
 +
| Mario vs. Donkey Kong: Tipping Stars
 +
|
 +
|-
 +
| ?
 +
| ?
 +
| 00001499
 +
| Korg DSN-12
 +
|
 +
|-
 +
| ?
 +
| ?
 +
| 000014f2
 +
| Animal Crossing: Happy Home Designer
 +
|
 +
|-
 +
| 000014d1
 +
| 000014d1
 +
| 000014d1
 +
| [[Home Menu]] badge
 +
|
 +
|-
 +
| ?
 +
| ?
 +
| 00001632
 +
| Fullblox / Stretchmo
 +
|
 +
|-
 +
| ?
 +
| ?
 +
| 00001646
 +
| Pokémon Rumble World
 +
|
 +
|-
 +
| 00001648
 +
| 00001648
 +
| 00001648
 +
| Pokémon Sun<br>Pokémon Moon
 +
|
 +
|-
 +
| 0000165c
 +
| 0000165c
 +
| 0000165c
 +
| [[Home Menu]] saved theme layouts
 +
|
 +
|-
 +
| 000016C6
 +
| ?
 +
| 00001678
 +
| Yo-kai Watch
 +
|
 +
|-
 +
| ?
 +
| ?
 +
| 000018fa
 +
| Phoenix Wright: Ace Attorney - Spirit of Justice
 +
|
 +
|-
 +
| ?
 +
| 0000198e
 +
| 0000198f
 +
| Animal Crossing: New Leaf - Welcome amiibo
 +
|
 +
|-
 +
| ?
 +
| ?
 +
| 00001a05
 +
| Super Mario Maker
 +
|
 +
|-
 +
| ?
 +
| ?
 +
| 00001a2e
 +
| Swapdoodle
 
|  
 
|  
 
|}
 
|}
   −
=== NAND Shared Extdata ===
+
== NAND Shared Extdata ==
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
 
!  ExtdataID
 
!  ExtdataID
 
!  Description
 
!  Description
 +
|-
 +
| 0xe0000000
 +
| Home Menu attempts to open this archive during boot, if [[FS:OpenArchive]] doesn't return an error Home Menu seems to then launch the [[System Transfer]] application. Home Menu doesn't actually use this archive at all except for checking whether it exists.
 
|-
 
|-
 
|  0xf0000001
 
|  0xf0000001
Line 207: Line 482:  
|-
 
|-
 
|  0xf0000009
 
|  0xf0000009
−
|  ?
+
|  Used for [[BOSS_Services|SpotPass]] content storage for [[News_Services|notifications]].
 
|-
 
|-
 
|  0xf000000b
 
|  0xf000000b
Line 216: Line 491:  
|-
 
|-
 
|  0xf000000d
 
|  0xf000000d
−
|  ?
+
|  Home Menu SpotPass content data [[BOSS_Services|storage]].
 +
|-
 +
|  0xf000000e
 +
|  Contains [[VersionList|versionlist.dat]], used by Home Menu for the software update notification added with [[7.0.0-13]].
 
|}
 
|}
 +
 +
==== Shared Extdata 0xf000000b gamecoin.dat ====
 +
{| class="wikitable" border="1"
 +
|-
 +
!  Offset
 +
!  Size
 +
!  Description
 +
|-
 +
| 0x0
 +
| 0x4
 +
| Magic number: 0x4F00
 +
|-
 +
| 0x4
 +
| 0x2
 +
| Total Play Coins
 +
|-
 +
| 0x6
 +
| 0x2
 +
| Total Play Coins obtained on the date stored below. When the below date does not match the current date, this field is reset to zero, then the date(and other fields) are updated. Once this value is >=10, no more Play Coins can be obtained until the current date changes.
 +
|-
 +
| 0x8
 +
| 0x4
 +
| Total step [[PTM:GetTotalStepCount|count]] at the time a new Play Coin was obtained.
 +
|-
 +
| 0xC
 +
| 0x4
 +
| Step count for the day the last Play Coin was obtained, for that day's step count(same as the step count displayed by home-menu when this file was updated).
 +
|-
 +
| 0x10
 +
| 0x2
 +
| Year
 +
|-
 +
| 0x12
 +
| 0x1
 +
| Month
 +
|-
 +
| 0x13
 +
| 0x1
 +
| Day
 +
|}
 +
 +
The above date stores the last time new Play Coin(s) were obtained. The contents of this file is updated by home-menu. [[PTM:GetTotalStepCount]] is not checked constantly, after home-menu boot this is only checked when waking from sleep-mode. Each time home-menu updates the contents of this file, home-menu will set the Play Coin total to 300 if it's higher than the 300 Play Coin limit.
 +
 +
[[Home Menu]] loads this file / opens this archive during [[Home Menu|startup]]. When accessing this file fails, like when the file/archive is corrupted(or at least on older system-versions), the result is a brick due to Home Menu using [[SVC|svcBreak]]. [[User:Yellows8|Yellows8]] bricked a 3DS this way due to corruption via invalid [[FSFile:Write]] flush flags. When opening this extdata archive(0xf000000b) fails, Home Menu executes svcBreak.
 +
 +
==== Shared Extdata 0xf000000b ubll.lst ====
 +
List of blocked users.
 +
 +
Empty space is filled with 0xC-long sequences of 00 00 ... 07
 +
 +
== Tools ==
 +
* [https://github.com/wwylele/3ds-save-tool 3ds-save-tool] - Extract/verifies extdata
Meleemeister
68

edits

Retrieved from "https://www.3dbrew.org/wiki/Special:MobileDiff/7280...22521"