Releases: DarkMatterCore/nxdumptool
Releases · DarkMatterCore/nxdumptool
v1.1.6
- Added sequential dump support: it is now possible to start a XCI/NSP dump procedure even if there's not enough space available in the SD card!
- No setting has to be modified in order to enable this feature - the application will automatically ask the user if they want to use this mode if there's not enough space for the full dump.
- At least 1 GiB (2^30 bytes) of free space must be available in order to trigger this feature.
- A file-based checkpoint system is used to keep track of the already dumped parts (à la Hekate).
- The part(s) generated in each run must be transferred to a PC before continuing the process - except for the
.xci.seq
/.nsp.seq
files used to keep track of the current dump status. - NSPs generated using this method will also include a
.nsp.hdr
file, which holds the PFS0 header data. The information from this header is filled after writing all the NCAs, thus it is saved as an additional file. This must be used as the first file (placed before.nsp.00
) when merging all the parts into a full NSP. - The following options are ignored when this feature is triggered:
Split output dump (FAT32 support)
(XCI/NSP). File splitting will take place, regardless of the filesystem used by the SD card. Additionally, the creation of a directory with the archive bit set isn't performed with NSP dumps.Create directory with archive bit set
(XCI only).CRC32 checksum calculation
(NSP only). CRC32 checksum calculation is still available for XCI dumps.
- This feature is not compatible with batch dump operations.
- General changes to batch dump operations:
- Entries from the summary list displayed in the batch dump menu can now be manually excluded from the dump operation before starting it.
- It is possible to disable all entries, enable all entries and/or handpick specific titles from the summary list, thus letting the user further customize the batch dump process.
- A new option has been added to keep track of previous successful dumps created using batch mode: "Remember dumped titles".
- If enabled, a 0-byte file will be created for each successful dump in a separate subdirectory.
- These files act as an override: they will make the application skip the titles they represent in later batch mode operations even if the "Skip already dumped titles" option is disabled.
- This is specially useful if someone wants to skip titles that have already been successfully dumped using batch mode - even more so if their NSPs have already been moved or deleted from the SD card.
- To restore the original behaviour, simply delete the contents from the "BatchOverrides" subdirectory inside "NSP".
- Free storage space is now properly recalculated after each successful dump during a batch mode operation.
- Entries from the summary list displayed in the batch dump menu can now be manually excluded from the dump operation before starting it.
- UI code cleanup:
uiDrawString()
,uiGetStrWidth()
anduiPrintOption()
are now compatible with variable argument lists, removing the need to format a string beforehand and pass its variable to any of those functions.- Preprocessor definitions are now used to specify RGB colors and for calculating vertical line coordinates, greatly simplifying calls to UI functions.
- Menu code now properly waits for any user input before drawing changes to the screen.
- Other minor coordinate fixes.
- The application is now capable of automatically reading/saving dump settings from/to a configuration file.
- The "Split output dump" option is, once again, enabled by default. FAT32 is the recommended filesystem for Switch SD cards if someone wants to use homebrew applications, so it's only logical to do this.
- Filenames for NACP icons in NSPs now properly reflect the NCA ID from its respective content file if it was modified.
- Fixed a bug that prevented to dump a specific file in the RomFS section from any update.
- Fixed a bug in the RomFS block collision check code that prevented to generate NSP dumps from certain titles with a RomFS section in Control/Manual NCAs that falls under an edge case that wasn't being handled properly. Thanks to Zet-sensei for reporting this problem!
Thanks to FennecTECH for providing with testing!
v1.1.5
- Built with latest libnx release, in order to fix HID problems under HOS 9.0.0+.
- Added support for Korean and Chinese character sets.
- Added browsing/dumping support for RomFS sections in Data NCAs from DLCs.
- Compatible with orphan DLCs (Y button) as well.
- Output directories for ExeFS/RomFS operations are now properly tagged as "(BASE)", "(UPD)" or "(DLC)" (RomFS only), depending on the title type being processed.
- Some measures have been taken to help speed up dumping operations:
- CPU boost mode type 1 is now used with
appletSetCpuBoostMode
- only effective under HOS 7.0.0+! - Removed the need for dynamic memory allocations in NCA AES-CTR block decryption/encryption steps.
- Although these changes get me some extra ~4 MiB/s in most operations, keep in mind this doesn't do much to help with RomFS dumps from titles with lots of (small) file entries. Even so, although the calculated ETA can sometimes be discouraging, the dump most likely won't take that much time - just let the process advance until it hits bigger files. Sequential write speeds for the inserted SD card still play a huge role in these cases.
- CPU boost mode type 1 is now used with
- Moved base output directory from "sdmc:/nxdumptool/" to "sdmc:/switch/nxdumptool/". Both the NSWreleases.xml file and the NRO binary are also expected to be inside this directory.
v1.1.4
UPDATE: If you downloaded the NRO binary before 2019-08-17 07:25 AM (UTC -4), please re-download it again. A quick fix was applied to avoid a crash while generating NSP dumps.
- Fixed building with latest libnx release.
- Optimized RomFS recursive file dump function to not rely on code recursion as much as before, avoiding stack memory exhaustion problems. Fixes crashes while dumping RomFS data from games with lots of file entries.
- Fixed a bug that made file splitting not take place while manually dumping a file bigger than 4 GiB from the RomFS section of any title.
- Reduced max part size for split files to
0xFFFF0000
bytes in all operations (except for XCI dumps when the "Create directory with archive bit set" option is disabled). Fixes file access problems if the parts are used inside a directory with the archive bit set. - Removed the
removeDirectory()
function.fsdevDeleteDirectoryRecursively()
is now used instead. - If a HFS0/ExeFS/RomFS data dump operation is cancelled or fails, a message telling the user to wait until the output directory is fully deleted will now be displayed.
- Improved the cancel button detection mechanism. Regardless of the ongoing operation, holding the button for 2 seconds will now consistently cancel it.
- Progress bar movement is now smoother.
v1.1.3
- General changes to the NSP dumping procedure:
- Corrected and updated CNMT XML and NACP XML generation. Thanks to 0Liam!
- Added NACP icon retrieval for each available language.
- Added legalinfo.xml retrieval.
- Added programinfo.xml generation.
- Changed the PFS0 file order to the following:
- NCA content files.
- CNMT NCA.
- CNMT XML.
- programinfo.xml (if available).
- NACP icons (if available).
- NACP XML (if available).
- legalinfo.xml (if available).
- Ticket + Certificate chain (if available).
- These changes essentially make the NSP dumps generated by the application comparable to Scene releases that follow the
AuditingTool
format (like those from groups like BigBlueBox or JRP), as long as the "Remove console specific data" option is enabled and the "Generate ticket-less dump" option is disabled. Happy dumping! - Because of this, dumping update NSPs from gamecards will require the keys file at "sdmc:/switch/prod.keys" from now on (but only if the bundled update uses titlekey crypto). Base applications and DLCs can still be dumped from gamecards without needing a keys file.
- Added ExeFS/RomFS browsing/dumping from game updates.
- Upon entering ExeFS/RomFS menus, it is now possible to select which update is going to be used for ExeFS/RomFS procedures.
- In order to dump ExeFS/RomFS content from a installed update for a gamecard title, its respective gamecard must be inserted in the console.
- Likewise, in order to dump ExeFS/RomFS content from a installed update for a SD/eMMC title, its respective base application must be already installed as well.
- Added NSP batch dump mode. Press X while on the SD/eMMC title list to configure the batch dump options and start the process. Supports skipping already dumped titles, dumping selected title types (base applications, updates, DLCs) and dumping titles from a specific source storage (SD, eMMC).
- Added manual directory dumping feature to the RomFS browser. Just enter the directory to be dumped and then press the Y button.
- Added a forced XCI dump option when either the gamecard base application count or their Title IDs can't be retrieved (useful for rare Kiosk gamecards). Press Y at the error message screen to dump the cartridge image to "gamecard.xci".
- Dumped content information is now displayed in the gamecard menu.
- Additionally, if the XCI has already been dumped, information about it will be displayed as well.
- The displayed information about dumped content is now updated after each new dump procedure in both gamecard and SD/eMMC menus.
- The NPDM ACID patching procedure is now performed with Program NCAs from bundled gamecard updates and SD/eMMC titles if the "Generate ticket-less dump" option is enabled.
- Fixed XCI dumping under SX OS.
- Fixed a bug in the DLC NSP dump submenu that made it impossible to change the DLC to be dumped from the selected base application if more than a single DLC is available for it. Thanks to ckurtz22!
- Fixed a bug that made the application get stuck in an endless loop after selecting the SD/eMMC dump option from the main menu if no SD/eMMC titles are available. Thanks to ckurtz22!
- Fixed a bug that made the application return an empty title list if no SD card is inserted or if it contains a "Nintendo" directory from another console (even if there are installed titles in the eMMC). Thanks to ckurtz22!
v1.1.2
- Delta fragment NCAs are now included in update NSPs dumped from SD/eMMC if the "Generate ticket-less dump" option is disabled.
- It is now possible to generate ticket-less NSP dumps from bundled updates in gamecards. Please bear in mind that this option requires the external "sdmc:/switch/prod.keys" file.
- UI tweaks:
- The application now keeps track of the selected title in SD/eMMC and "orphan" content modes when entering a menu and then going back to the list.
- After selecting a title in the SD/eMMC menu, information about content already dumped related to the selected title will now be displayed (BASE / UPD / DLC).
- Likewise, after selecting a title in the "orphan" title list (Y button), an additional line will now display if the selected title has been dumped or not.
- This also informs the user if the dumps contain console-specific data.
- Three additional entries will now be displayed in the "orphan" title list.
- Upwards and downwards arrows will now be displayed for lists that exceed the max element count.
- Because of this change, max element count for the SD/eMMC title list had to be reduced from 4 to 3.
- Leftwards and rightwards arrowheads are now displayed in menus with options.
- A "hint" message is now displayed in the "orphan" content mode to let the user know they'll be able to find gamecard updates in that section.
- If a file has been already dumped, the application will display a prompt asking the user if they want to proceed anyway or not. This doesn't apply to full HFS0/ExeFS/RomFS data dumps.
- It is now possible to jump from the first list element to the last one and viceversa using the D-Pad Up/Down and Left Stick Up/Down. The Right Stick is still used exclusively for fast scrolling and won't be affected by this change.
- Fixed a bug where NSP/ExeFS/RomFS dumping would fail if the written entry count returned by
ncmContentMetaDatabaseListApplication()
didn't match the total entry count for the selected NSP dump type. - Fixed a bug where NSP/ExeFS/RomFS dumping would fail if an invalid title index was used with
ncmContentMetaDatabaseGet()
.
Thanks to Maschell, DuIslingr and MUXI from PSXTools forums for reporting these bugs and providing with testing!
v1.1.1
- Project name changed to
nxdumptool
. This is no longer a gamecard-only tool. - Added ExeFS dumping/browsing support. This feature, along with the already available RomFS options, makes the application an excellent tool for modders!
- Added compatibility with FS process memory layout in the key retrieval procedure while using emuMMC. Thanks to shchmue!
- Due to public demand, NSP dumping, ExeFS dumping/browsing and RomFS dumping/browsing support has been added for base applications, updates and DLCs available in both SD card and eMMC!
- Now it's possible to select the source storage device (gamecard, SD card / eMMC) for any operation right after launching the application.
- The gamecard submenu works exactly like the main menu has worked up to this point (except for the update options, which are now displayed in the new main menu).
- The SD card / eMMC submenu shows installed base applications along with their icons. Upon selecting a title, a submenu with NSP and RomFS options will show up. It's also possible to dump updates/DLCs for an installed base application this way.
- If there's installed content (updates/DLCs) with missing base application titles, pressing Y on the SD card / eMMC submenu will display this "orphan" content list and let you dump titles from it nonetheless.
- It is possible to generate console-specific NSP dumps, dumps with modified tickets to remove console-specific data, and ticket-less dumps with standard NCA key area crypto.
- Two new options are available in the NSP dump submenus for SD/eMMC titles: "Remove console specific data" and "Generate ticket-less dump". The latter won't appear if the former isn't enabled.
- "Remove console specific data" cleans console specific data fields from a "personalized" ticket and replaces its RSA titlekey block with a 16-byte encrypted titlekey, essentially converting it to a "common" ticket. This option has no effect if the title already uses a "common" ticket.
- "Generate ticket-less dump" goes another step ahead by cleaning up the Rights ID field in every NCA content file that includes it, stores the decrypted titlekey in the NCA key area and then encrypts this area using standard crypto, removing the need for a tik/cert combination.
- Console-specific NSP dumps and dumps with modified tickets include both
tik
andcert
files. - All NSP dumps generated from installed SD/eMMC titles include both
.cnmt.xml
and.nacp.xml
files whenever possible.
- Two new options are available in the NSP dump submenus for SD/eMMC titles: "Remove console specific data" and "Generate ticket-less dump". The latter won't appear if the former isn't enabled.
- Sadly, due to limitations in the methods currently used to perform key retrieval/derivation at runtime, NSP dumping, ExeFS dumping/browsing and RomFS dumping/browsing for SD/eMMC titles require the "sdmc:/switch/prod.keys" file. Specifically, these are the needed keys:
eticket_rsa_kek
.titlekek_##
(varies from00
to1F
).
- Additionally, ticket-less NSP dumps for SD/eMMC titles also require the following keys:
key_area_key_application_##
(varies from00
to1F
).key_area_key_ocean_##
(varies from00
to1F
).key_area_key_system_##
(varies from00
to1F
).
- All gamecard-related operations can still be performed without the need for a keys file!
- Now it's possible to select the source storage device (gamecard, SD card / eMMC) for any operation right after launching the application.
- Output data generated by the application will now be saved to its corresponding subdirectory in "sdmc:/nxdumptool/":
- XCI dumps: "sdmc:/nxdumptool/XCI/".
- NSP dumps: "sdmc:/nxdumptool/NSP/".
- HFS0 data: "sdmc:/nxdumptool/HFS0/".
- ExeFS data: "sdmc:/nxdumptool/ExeFS/".
- RomFS data: "sdmc:/nxdumptool/RomFS/".
- Certificate dumps: "sdmc:/nxdumptool/Certificate/".
- The location for the NSWDB.COM XML database has been moved to "sdmc:/nxdumptool/NSWreleases.xml".
- Tickets from updates with titlekey crypto dumped from gamecards are now converted to regular "common" tickets before being written to the output NSP dump.
- The content distribution type for updates dumped from custom XCIs mounted through SX OS is now set to "download".
- Fixed a NCM service handle exhaustion bug if an error ocurred while reading the RomFS section entry from the Program NCA for any base application.
- Changed the application icon yet again. Big thanks to RattletraPM!
- Minor changes and other various general fixes.
Thanks to simontime for helping me out with the RSA certificate chain retrieval process! Also thanks to MUXI from PSXTools forums for providing with testing!
v1.1.0
- Replaced the application icon with a new, stylish one made by RattletraPM. Thanks a lot!
- Gamecard base application icons are now retrieved and displayed in the menu.
- L/ZL/R/ZR buttons can now be used to change the displayed base application info if a multigame cart is inserted, instead of displaying everything right away.
- The Nintendo Extension shared font is now used to display bitmaps representing controller buttons and sticks instead of just using text to reference them.
- Replaced the mbedtls-based AES and SHA-256 implementations with functions from the hardware accelerated cryptography API from libnx.
- Added an option to generate split XCI dumps using a directory with the archive bit set, just like split NSP dumps. It will only appear if "Split output dump" is enabled.
- Fixed ETA calculation.
- Enabled ETA calculation in full HFS0 partition data dumps.
- Fixed CRC32 checksum calculation for gamecard certificate dumps.
- Added Program NCA RomFS section parser:
- Supports filesystem dumping, filesystem browsing, manual file dumping and file splitting. Enjoy datamining your gamecards!
- Compatible with multigame carts. You'll be able to choose which base application RomFS will be dumped/browsed from a submenu.
- Output files will be saved to: "sdmc:/[GameName] v[GameVersion] ([TitleID]) (RomFS)/".
- Added high contrast directory/file icons from GNOME project to file browsing modes (HFS0 / RomFS).
- Fixed the NSP generation code (based on 4NXCI / hacPack):
- Delta Fragment NCAs are now discarded.
- The SHA-256 checksum is recalculated for every NCA content after being modified, resulting in new NCA IDs.
- The ACID public key is replaced in the NPDM section from the Program NCA. All the related NCA/PFS0 Superblock SHA-256 hashes are recalculated.
- The NPDM signature in the Program NCA header is now replaced as well.
- The content records from the Application CNMT are updated with proper SHA-256 hashes and new NCA IDs. All the related NCA/PFS0 Superblock hashes are recalculated.
- NACP XMLs are now generated as well.
- Because of all these changes, the CRC32 checksum can't be calculated until the dump procedure is complete.
- If this option is enabled, the application will take extra time after the NSP dump has been completed to calculate the CRC32 checksum. Nonetheless, you'll be able to cancel this procedure.
- A warning message will appear in the NSP dump menu if CRC32 checksum calculation is enabled to inform the user about this extra step.
- Furthermore, the output CRC32 checksum will be different on each new dump. This is because the NPDM signature in the Program NCA header uses a random seed.
- This effectively makes the generated NSPs only need ES patches to work. ACID patches shouldn't be needed anymore.
- Added NSP dumping support for Patch and AddOnContent title types with gamecards that include bundled Updates/DLCs:
- The information displayed in the main menu now shows how many Updates/DLCs are bundled in the inserted gamecard (per application and in total).
- If a bundled gamecard update features a populated Rights ID bitfield, both its Ticket and Certificate will get added to the output NSP.
- Additionally, the NSP dump menu has been divided in three subcategories: base application, update and DLC.
- Each submenu will only appear if the inserted gamecard holds at least one title belonging to the category it represents.
- If only the base application is included, like most gamecards, choosing the NSP dump option in the main menu will take you right to the base application dump menu.
- Once you enter a submenu, you'll be able to choose exactly which title to dump belonging to that category.
- Output update NSPs will not be modified in any way. Thus, unlike NSPs from base applications and DLCs, their CRC32 checksums will always be the same.
- Fixed the minimum system version field size in the extended CNMT header struct. Thanks to @0Liam !
- Changed the naming convention for output NSP dumps:
- Base application: "sdmc:/[GameName] v[GameVersion] ([TitleID]) (BASE).nsp".
- Update: "sdmc:/[GameName] v[UpdateVersion] ([UpdateTitleID]) (UPD).nsp".
- If a matching base application isn't found: "sdmc:/[UpdateTitleID] v[UpdateVersion] (UPD).nsp".
- DLC: "sdmc:/[GameName] v[DLCVersion] ([DLCTitleID]) (DLC).nsp".
- If a matching base application isn't found: "sdmc:/[DLCTitleID] v[DLCVersion] (DLC).nsp".
- The application is now able to retrieve the NCA header key and perform NCA key area decryption at runtime, using the SPL services. Thus, is isn't needed to run Lockpick beforehand anymore to dump NSPs (nor to dump/browse RomFS data).
- If the inserted gamecard includes a bundled update, its version number will now be used in the output filename for XCI, HFS0 and gamecard certificate dumps.
- Minor improvements to the file splitting code.
- Additionally, the filename for the current part will now be displayed and updated for all operations if file splitting is enabled.
- The application update feature will now use the launch path from argv if it's available. Otherwise, it defaults to "sdmc:/switch/gcdumptool.nro".
- Cosmetic fixes to the UI layout.
- NCM service resources are now properly closed.
- Removed unnecessary service (de)initializations.
Big thanks to PatrickD85, unvaluablespace, wartutor and Slim45 for testing these changes!
v1.0.8
- Added proper metadata reading from multigame carts.
- Added gamecard -> NSP dump option:
- Compatible with file splitting (for FAT32 support). The same layout from splitNSP.py is used: a directory with numbered part files (00, 01, etc.). The archive bit is enabled right away in this directory to allow HOS to treat it as if it were a whole file. This way, it can be used with any application with NSP-handling capabilities.
- Compatible with CRC32 checksum calculation. Disclaimer: NSP dumps can't be verified against the XML database.
- Output NSPs contain a metadata XML file based on the information from the CNMT NCA for the application, which is decrypted using code from hactool. The necessary keyset is loaded from "sdmc:/switch/prod.keys", which can be generated using Lockpick.
- If a multigame cart is used, you'll be able to choose which application to dump from the menu.
- Dump verification process tweaked for multigame carts: it'll now look for a possible checksum match using the Title IDs from all bundled applications.
- Improved error reporting in dumper.c when a write operation fails. Furthermore, if a write error is produced when trying to write data to an offset past the FAT32 file size limit (0xFFFFFFFF bytes), the application will suggest the user to enable the file splitting option.
- Tweaked part sizes for splitted dumps: XCI/raw partition/manual file dump part size now matches the one used by XCI-Cutter, while the NSP part size matches the one used by splitNSP.py.
- Minor fixes to the UI code.
v1.0.7
v1.0.7:
- Fixed a segmentation fault when trying to free an invalid XML node data pointer when a Scene release from NSWReleases.xml with a matching Title ID misses data related to that node.
- Added a message suggesting the user to restart the application after a successful update.
Big kudos to @Matt07211 for testing the XML parsing changes!
v1.0.6
v1.0.6:
- Updated application codebase in order to make it compatible with the latest devkitA64 and libnx releases.
- Removed some fs-srv service functions from fsext.c/h that have been included in libnx (and fixed the ones that haven't).
- Revamped the GFX code to replace the 8x8 ASCII font with the shared system font, using the pl service and FreeType.
- Enabled (and fixed) the in-app update option. HTTPS compatibility is achieved through the mbedtls portlib.
- Disabled screen dimming and auto sleep.
- Added file counter to partition browser.
- Changed the naming convention for split gamecard dumps to *.xc[part number], in order to make them compatible with SX OS and other tools right away.
- Increased the delay after inserting a new gamecard by 1 second.
- Added a gamecard detection thread to monitor gamecard state changes in a better way. This thread is hooked to a gamecard detection kernel handle retrieved through an IEventNotifier object.
- Replaced partition filesystem mounting through fs-srv service calls with manual HFS0 partition header parsing. This should fix issues when browsing the Logo partition from type 0x02 gamecards.
- Blocked HOME button presses when running as a regular/system application instead of an applet. A warning message will be displayed whenever any operation is started if the application is running as an applet.
- Added detection for bundled FW versions 6.0.0 - 8.0.0.
Big kudos to @fennectech for doing tests with a type 0x02 gamecard!