NDecrypt 3DS

NDecrypt
NDecrypt
General
Author	SabreTools
Type	File Operation
Version	0.2.4
License	Mixed
Last Updated	2022/11/01
Links
	Download
	Website
	Source

NDecrypt is a tool that allows you to encrypt and decrypt your personally dumped NDS and N3DS roms with minimal hassle. The only caveat right now is that you need a keys.bin file for your personally obtained encryption keys.

This is a code port of 3 different programs: 3ds_encrypt.py, 3ds_decrypt.py and woodsec (part of wooddumper).

User guide

How to use

NDecrypt.exe <operation> [flags] <path> ...

Possible values for <operation>:
e, encrypt - Encrypt the input files
d, decrypt - Decrypt the input files

Possible values for [flags] (one or more can be used):
-c, --citra           - Enable using aes_keys.txt instead of keys.bin
-dev, --development   - Enable using development keys, if available
-f, --force           - Force operation by avoiding sanity checks
-h, --hash            - Output size and hashes to a companion file
-k, --keyfile <path>  - Path to keys.bin or aes_keys.txt

<path> can be any file or folder that contains uncompressed items.
More than one path can be specified at a time.

Mixed folders or inputs are also accepted, you can decrypt or encrypt multiple files, regardless of their type.

Note: This overwrites the input files, so make backups if you're working on your original, personal dumps.

keys.bin

This is used only for Nintendo 3DS and New 3DS files. Without getting into the codes, you need the 9 16-bit keys in little endian format (most common extraction methods produce big endian, so keep that in mind).

It's recommended that you fill with 0x00 if you don't have access to a particular value so it doesn't mess up the read. They need to be in the following order:

Hardware constant
KeyX0x18
KeyX0x1B
KeyX0x25
KeyX0x2C
DevKeyX0x18
DevKeyX0x1B
DevKeyX0x25
DevKeyX0x2C

The last 4 are only required if you use the -dev flag. Once again, don't ask for these. If you're missing a required key, then things won't work.

Compatibility rates

Here's a list of the supported sets and their current compatibility percentages with woodsec and the Python scripts (as of 2020-12-19):

Nintendo DS - >99% compatible (Both encryption and decryption).
Nintendo DSi - 100% compatible (Both encryption and decryption).
Nintendo 3DS - 100% compatible (Both encryption and decryption).
Nintendo New 3DS - 100% compatible (Both encryption and decryption).

Please note the above numbers are based on the current, documented values.

The notable exceptions to this tend to be unlicensed carts which may be dumped incorrectly or have odd information stored in their secure area.

Changelog

v0.2.4 This release is mainly around some fixes related to .NET 6 (and internal cleanup):

.NET 5 support has been dropped
.NET 6 support (hashing and encrypt/decrypt) have been fixed
Internal structure changed to be more library-oriented

v0.2.3 It has been over a year since the last release and enough has changed to warrant something stable.

Add support for outputting file hashes to a companion file
Add support for alternate keyfile paths
Add support for Citra aes_keys.txt
Major internal cleanups and code separation
Converted core library to .NET Standard 2.0
Added .NET 6.0 as build target for main executable

v0.2.2

Added a couple of fixes for NDS Prince of Persia carts that have mastering oddities.
Added the .ids iQue DS extension to matching.
Fixed the matching criteria for some of the NDS signatures.
Added more improperly decrypted empty secure area NDS signatures.
Remove forced pause at end of program run.
Make keys.bin only required for 3DS and New 3DS processing.
Add some try/catch blocks around processing so it doesn't hard crash (issue with incorrectly-named BIOS files).

v0.2.1

Merged two projects into one again, based on the Core version from last time. No changes to supported frameworks due to this.
Reorganized a bit of the code internally in case other cart types get supported in the future.
Added a couple of fixes for NDS Dragon Quest V carts that have mastering oddities.

v0.2.0

Internal cleanup of most of the code.
Removed .NET Framework 4.6.1 build.
Added .NET Framework 4.8, .NET Core 3.1, and .NET 5.0 builds.
Fixed NDS secure areas.
Fixed larger game carts.
Fixed encrypting N3DS carts.
Add force flags for NDS and N3DS.

Credits

Thanks to the developers of the original programs for doing the actual hard work to figure things out.
Also thanks to everyone who helped to test this against the original programs and made code suggestions.

Disclaimer: This program is only for use with personally dumped files and keys and is not meant for enabling illegal activity.

External links

GitHub - https://github.com/SabreTools/NDecrypt