3DS:Cleaninty: Difference between revisions

cleaninty
Developer(s)	luigoalma
Platform	Microsoft Windows, macOS, Linux
Version	0.1.3 (March 18, 2023; 20 months ago)
Links
GitHub	luigoalma/cleaninty
Download
	GitHub release;
	v; t; e;

Revision as of 01:05, 5 March 2024

cleaninty is a PC tool used to communicate with Nintendo's SOAP servers. For a 3DS, these servers deal with managing eShop accounts, downloading eShop titles, and system transfers. It is also the tool used for what is informally known as a "SOAP Transfer".

Overview

There are two pieces of data a 3DS that give it a unique ID to Nintendo's eShop servers: its serial number and its otp.bin. If these are copied out of the console and used somewhere else, they can be used to imitate the console - meaning Nintendo's servers can act on commands without the console doing anything on its end.
However, the files cannot communicate on their own, and a connection to Nintendo's servers that acts identically to a console is still needed. This part is where cleaninty comes in.

The reason this allows for changing eShop regions easily, and at infinite range, are as follows:

Ease of Use: Tickets for both system software & purchased apps are stored on Nintendo's servers, and some of these tickets are 'sticky' - they refuse to be deleted when trying to delete the console's eShop account. (The most common sticky tickets are from preinstalled games and the Mii Plaza 3.x update.) The only way to remove these tickets is to transfer them to another console, and cleaninty is able to move only the tickets with a single command.
Infinite Range: System transfers are effectively divided into two parts: the content transfer (done entirely on consoles), and the NNID/title transfer (done entirely on servers).
On an actual console, these two must be done at the same time - but if cleaninty sends the commands for a server transfer, it doesn't start a content transfer and thus the consoles do not have to be next to each other. (Technically, this also means a Manual Movable Transfer is the exact opposite of a SOAP transfer.)

Features

When the required constants have been supplied through SetupConstants and you have the unique data (otp.bin and either SecureInfo.bin or the serial number) of a console, cleaninty can act as that console and do the following:

GenJson: Compiles the console's data into a single JSON file. This JSON is required for all other commands except RecoverIVS.
CheckReg: Obtains the console's eShop status, eShop region, and any titles attached to its eShop account, then updates the JSON file if any differences in the data are found.
SysTransfer: Moves the eShop titles of the source console to the target console. This is the secondary part of what is known informally as a "SOAP Transfer".
- A successful use of this command triggers a 7-day cooldown on system transfers for both consoles, the same as a full system transfer.
NNIDTransfer: (Still experimental. Use with caution.) Moves only the NNIDs of the source console to the target console. This is not affected by system transfer cooldowns and does not trigger one.
LastTransfer: Provides the date&time of the given console's last system transfer, the number of transfers it has ever done, and the time at which the current transfer cooldown will expire if there is one active.
GetIVS: Downloads the console's movable.sed from the SOAP servers, if the servers have a stored copy.
SetIVS: Uploads the chosen JSON's stored movable.sed to the SOAP servers. This will overwrite the current stored movable.
RecoverIVS: Tries to recover a console's movable.sed from only its raw otp.bin and eShop region data.
EShopDelete: Deletes the target console's eShop account.
EShopRegionChange: Attempts to delete and then recreate the target console's eShop account for the entered region. This is the main part of a "SOAP Transfer", but after a successful SysTransfer the console will do this automatically when it next connects to the eShop.
ETickets/ETicketDownload/ETikTitleDownload: Lists all owned eShop tickets / downloads all tickets / downloads the titles attached to all tickets, respectively, from the given console's eShop account.

Installation

Instructions for installation & setup are on the GitHub page, but the installation instructions may need to be interpreted for your OS.

Regardless of your OS, you will need a 3DS with both custom firmware and GodMode9 installed to dump the vast majority of the files required to do SetupConstants using ExtractSystemElements.gm9. A guide to legally deriving the only constant not dumped via this method, theAES Constant "C", can be found on this page.

The AES Constant, along with all other constants used by cleaninty, are copyrighted data. Obtaining them from your own console(s) is fine, but do not share the constants with anyone else.

Windows

Don't bother trying to install cleaninty on Windows directly. Windows has OpenSSL disabled in its curl.exe, but cleaninty requires OpenSSL to function. Working around this issue manually is obnoxious and not worth the time spent.

Instead, there are two options:

Install a Linux distro through WSL and then install cleaninty inside the WSL instance using the macOS/Linux instructions. (This is the simpler path, and WSL is useful for many other things. If you choose this instead of msys2, it is recommended that you also install the Windows Terminal.)
Install msys2 and then install cleaninty inside the msys2 instance using the below instructions.

To install cleaninty inside msys2, open the terminal mingw64.exe that is inside the msys2 installation folder, then run the following two commands one at a time:

pacman -Syu mingw-w64-x86_64-python mingw-w64-x86_64-python-defusedxml mingw-w64-x86_64-python-cryptography mingw-w64-x86_64-python-pycurl
python -m pip install cleaninty

Once this is completed, from here on out you will need to open the msys2 mingw64.exe terminal to use cleaninty.

Be aware that when using cleaninty through msys2, the place it will look in to find boot9.bin, SSLCertificates, and ctr_constants.json is a folder named 3ds inside your msys2 home folder.

macOS and Linux

First, ensure you have Python 3.7 or newer. You can check if your Python version is new enough by opening a terminal and running the command python3 --version. If you do not, install a compatible version from either your package manager or the Python website.

Then, either install cleaninty directly from pip or clone its repo via the command git clone https://github.com/luigoalma/cleaninty.git and then run the setup.py script.

Usage

Make sure the files for all consoles you compile into a json are accurate before using them in cleaninty, or else the commands may affect a different console than they "should be". The easiest way to do this is by checking the serial sticker(s) on the console against the copy of the serial in SecureInfo_A, and if none of the stickers agree with the SecureInfo, also check against the copy in inspect.log.

There is no graphical interface for cleaninty. All commands are ran through the command line.

Manual command line

The commands are the same on all operating systems. Run cleaninty ctr (command) --help for information on an individual command's syntax.

As an example, the minimum list of commands needed to set up two consoles' data and perform a SOAP transfer between them would be as follows:

cleaninty ctr GenJson --otp otp.bin --secureinfo secinfo.bin --out soap_donor.json
cleaninty ctr GenJson --otp otp1.bin --secureinfo secinfo1.bin --out soap_target.json
cleaninty ctr CheckReg -C soap_donor.json
cleaninty ctr CheckReg -C soap_target.json
- The CheckReg commands are not necessary if you are already certain the donor and target have the same region.
cleaninty ctr EShopRegionChange -C soap_target.json -r (new eShop region - required) -c (country in chosen region - required if region is not JPN/KOR/CHN) -l (language in chosen region - optional)
- If this succeeds, stop here. The next command is only needed if this one fails.
cleaninty ctr SysTransfer -s soap_target.json -t soap_donor.json

Autosoap script

If you are inexperienced with the command line or just don't want to type the commands manually every time, there is a SOAP bash script made by StarlitSkies that heavily simplifies the process.
The only downside is that if cleaninty has a nonstandard error, the script will be unable to tell you the exact text of the error - meaning you will need to revert back to manual commands anyway in order to debug.

Read the instructions on its page for setup and usage.

@@ Line 14: / Line 14: @@
 == Overview ==
-There are two parts of a 3DS that give it a unique ID to Nintendo's eShop servers: its serial number and its [[3DS:System files|<code>otp.bin</code>]]. If these are pulled out of the console and used somewhere else, they can be used to imitate the console - meaning Nintendo's servers can act on commands without the console doing anything on its end.<br>
+There are two pieces of data a 3DS that give it a unique ID to Nintendo's eShop servers: its serial number and its [[3DS:System files|<code>otp.bin</code>]]. If these are copied out of the console and used somewhere else, they can be used to imitate the console - meaning Nintendo's servers can act on commands without the console doing anything on its end.<br>
-However, the files cannot communicate on their own, and a connection to Nintendo's servers that acts identically to a console is still needed. That is the purpose of cleaninty.
+However, the files cannot communicate on their own, and a connection to Nintendo's servers that acts identically to a console is still needed. This part is where cleaninty comes in.
 The reason this allows for changing eShop regions easily, and at infinite range, are as follows:
-* '''Ease of Use''': Tickets for both system software & purchased apps are stored on Nintendo's servers, and some of these tickets are 'sticky' - they refuse to be deleted when trying to delete the console's eShop account. (The most common sticky tickets are from preinstalled games and the [[3dbrew:StreetPass Mii Plaza|Mii Plaza 3.x]] update.) The only way to remove these tickets is to transfer them to another console, and this part can be made far easier if a donor console is used to collect the tickets.
+* '''Ease of Use''': Tickets for both system software & purchased apps are stored on Nintendo's servers, and some of these tickets are 'sticky' - they refuse to be deleted when trying to delete the console's eShop account. (The most common sticky tickets are from preinstalled games and the [[3dbrew:StreetPass Mii Plaza|Mii Plaza 3.x]] update.) The only way to remove these tickets is to transfer them to another console, and cleaninty is able to move ''only'' the tickets with a single command.
-* '''Infinite Range:''' System transfers are effectively divided into two parts: the content transfer (done entirely on consoles), and the NNID/title transfer (done entirely on servers).<br>On an actual console, these two must be done at the same time - but if cleaninty sends the commands for a server transfer, the consoles are never told to do the content transfer & Nintendo has no way of checking that a content transfer actually happened. (Technically, this also means a [[3DS:MMM|Manual Movable Transfer]] is the exact opposite of a SOAP transfer.)
+* '''Infinite Range:''' System transfers are effectively divided into two parts: the content transfer (done entirely on consoles), and the NNID/title transfer (done entirely on servers).<br>On an actual console, these two must be done at the same time - but if cleaninty sends the commands for a server transfer, it doesn't start a content transfer and thus the consoles do not have to be next to each other. (Technically, this also means a [[3DS:MMM|Manual Movable Transfer]] is the exact opposite of a SOAP transfer.)
 == Features ==
-When given the unique data (<code>otp.bin</code> and either <code>SecureInfo.bin</code> or the serial number & eShop region data) of a console and the required basic constants, cleaninty can act as the console it's given and do the following:
+When the required constants have been supplied through <code>SetupConstants</code> and you have the unique data (<code>otp.bin</code> and either <code>SecureInfo.bin</code> or the serial number) of a console, cleaninty can act as that console and do the following:
 * <code>GenJson</code>: Compiles the console's data into a single JSON file. This JSON is required for all other commands except <code>RecoverIVS</code>.
-* <code>CheckReg</code>: Obtains the console's eShop status and any titles attached to its eShop account, then updates the JSON file if any differences in the data are found.
+* <code>CheckReg</code>: Obtains the console's eShop status, eShop region, and any titles attached to its eShop account, then updates the JSON file if any differences in the data are found.
 * <code>SysTransfer</code>: Moves the eShop titles of the source console to the target console. This is the secondary part of what is known informally as a "SOAP Transfer".
 ** A successful use of this command triggers a 7-day cooldown on system transfers for both consoles, the same as a full system transfer.
 * <code>NNIDTransfer</code>: <u>(Still experimental. Use with caution.)</u> Moves only the NNIDs of the source console to the target console. This is not affected by system transfer cooldowns and does not trigger one.
 * <code>LastTransfer</code>: Provides the date&time of the given console's last system transfer, the number of transfers it has ever done, and the time at which the current transfer cooldown will expire if there is one active.
-* <code>GetIVS</code>: Obtains the console's <code>movable.sed</code> from the SOAP servers, if the servers have a stored copy.
+* <code>GetIVS</code>: Downloads the console's <code>movable.sed</code> from the SOAP servers, if the servers have a stored copy.
 * <code>SetIVS</code>: Uploads the chosen JSON's stored <code>movable.sed</code> to the SOAP servers. This will overwrite the current stored movable.
 * <code>RecoverIVS</code>: Tries to recover a console's <code>movable.sed</code> from only its raw <code>otp.bin</code> and eShop region data.
 * <code>EShopDelete</code>: Deletes the target console's eShop account.
-* <code>EShopRegionChange</code>: Attempts to delete and then recreate the target console's eShop account for the entered region. This is the main part of a "SOAP Transfer", but after a successful SysTransfer the console will do this automatically.
+* <code>EShopRegionChange</code>: Attempts to delete and then recreate the target console's eShop account for the entered region. This is the main part of a "SOAP Transfer", but after a successful SysTransfer the console will do this automatically when it next connects to the eShop.
 * <code>ETickets</code>/<code>ETicketDownload</code>/<code>ETikTitleDownload</code>: Lists all owned eShop tickets / downloads all tickets / downloads the titles attached to all tickets, respectively, from the given console's eShop account.
@@ Line 44: / Line 44: @@
 Instructions for installation & setup are {{GitHub|luigoalma/cleaninty#Installing|on the GitHub page}}, but the installation instructions may need to be interpreted for your OS.
-A guide to legally deriving the [[wikipedia:Advanced_Encryption_Standard|AES]] Constant, "C", can be found [https://3ds.goombi.fr/convertMii/0x31.html on this page].
-{{critical|The AES Constant, along with all other constants used by cleaninty, are copyrighted data. Obtaining them from your own console is fine, but '''do not''' share the constants with anyone else.}}
+Regardless of your OS, you will need a 3DS with both custom firmware and [[3DS:GodMode9|GodMode9]] installed to dump the vast majority of the files required to do <code>SetupConstants</code> using [https://raw.githubusercontent.com/luigoalma/cleaninty/master/gm9scripts/ExtractSystemElements.gm9 ExtractSystemElements.gm9]. A guide to legally deriving the only constant ''not'' dumped via this method, the[[wikipedia:Advanced_Encryption_Standard|AES]] Constant "C", can be found [https://3ds.goombi.fr/convertMii/0x31.html on this page].
+{{critical|The AES Constant, along with all other constants used by cleaninty, are copyrighted data. Obtaining them from your own console(s) is fine, but '''do not''' share the constants with anyone else.}}
 === Windows ===
-Don't bother trying to use cleaninty through Command Prompt or PowerShell. Windows has OpenSSL disabled in its <code>curl.exe</code>, but cleaninty requires OpenSSL to function. Working around this issue manually is obnoxious and not worth the time spent.
+Don't bother trying to install cleaninty on Windows directly. Windows has OpenSSL disabled in its <code>curl.exe</code>, but cleaninty requires OpenSSL to function. Working around this issue manually is obnoxious and not worth the time spent.
 Instead, there are two options:
-# Install a Linux distro through [https://learn.microsoft.com/en-us/windows/wsl/install WSL] and then install cleaninty inside the WSL instance using the macOS/Linux instructions.
+# Install a Linux distro through [https://learn.microsoft.com/en-us/windows/wsl/install WSL] and then install cleaninty inside the WSL instance using the macOS/Linux instructions. (This is the simpler path, and WSL is useful for many other things. If you choose this instead of msys2, it is recommended that you also install the {{GitHub|microsoft/terminal|Windows Terminal}}.)
 # Install [https://www.msys2.org/ msys2] and then install cleaninty inside the msys2 instance using the below instructions.
@@ Line 58: / Line 59: @@
 * <code>python -m pip install cleaninty</code>
-Once this is completed, from here on out you will need to open the terminal <code>mingw64.exe</code> to use cleaninty.
+Once this is completed, from here on out you will need to open the msys2 <code>mingw64.exe</code> terminal to use cleaninty.
 {{info|Be aware that when using cleaninty through msys2, the place it will look in to find <code>boot9.bin</code>, <code>SSLCertificates</code>, and <code>ctr_constants.json</code> is a folder named <code>3ds</code> inside your msys2 <code>home</code> folder.}}
@@ Line 64: / Line 65: @@
 === macOS and Linux ===
-First, ensure you have a python version of 3.7 or newer. You can check if your python version is new enough by opening a terminal and running the command <code>python3 --version</code>.
+First, ensure you have Python 3.7 or newer. You can check if your Python version is new enough by opening a terminal and running the command <code>python3 --version</code>. If you do not, install a compatible version from either your package manager or [https://www.python.org/downloads/ the Python website].
-For the method that involves <code>pip</code>, you can follow the instructions on the GitHub page with no modifications.
+Then, either install cleaninty directly from <code>pip</code> or clone its repo via the command <code>git clone https://github.com/luigoalma/cleaninty.git</code> and then run the <code>setup.py</code> script.
-For the method that involves <code>setup.py</code>, it is recommended to obtain the source code via the command <code>git clone https://github.com/luigoalma/cleaninty.git</code>. This will guarantee the files are in the correct layout.
+== Usage ==
+{{critical|Make sure the files for all consoles you compile into a json are accurate before using them in cleaninty, or else the commands may affect a different console than they "should be".
-== Usage ==
+The easiest way to do this is by checking the serial sticker(s) on the console against the copy of the serial in [[3dbrew:Nandrw/sys/SecureInfo_A|SecureInfo_A]], and if none of the stickers agree with the SecureInfo, also check against the copy in [[3dsbrew:Twln/sys/log/inspect.log|inspect.log]].}}
 There is no graphical interface for cleaninty. All commands are ran through the command line.
-=== Command line ===
+=== Manual command line ===
 The commands are the same on all operating systems. Run <code>cleaninty ctr (command) --help</code> for information on an individual command's syntax.
@@ Line 84: / Line 86: @@
 # <code>cleaninty ctr CheckReg -C soap_donor.json</code>
 # <code>cleaninty ctr CheckReg -C soap_target.json</code>
-#* The CheckReg commands are not necessary if you are already certain the donor and target are in the same region.
+#* The CheckReg commands are not necessary if you are already certain the donor and target have the same region.
-# <code>cleaninty ctr EShopRegionChange -C soap_target.json -r (new eShop region - required) -c  (country in chosen region - usually required) -l (language in chosen region/country - optional)</code>
+# <code>cleaninty ctr EShopRegionChange -C soap_target.json -r (new eShop region - required) -c  (country in chosen region - required if region is not JPN/KOR/CHN) -l (language in chosen region - optional)</code>
-#* If this succeeds, '''stop here'''. The next two commands are only needed if this one fails.
+#* If this succeeds, '''stop here'''. The next command is only needed if this one fails.
 # <code>cleaninty ctr SysTransfer -s soap_target.json -t soap_donor.json</code>
-# <code>cleaninty ctr EShopRegionChange -C soap_target.json -r (new eShop region - required) -c (country in chosen region - usually required) -l (language in chosen region/country - optional)</code>
+=== Autosoap script ===
+If you are inexperienced with the command line or just don't want to type the commands manually every time, there is a {{GitHub|StarlitSkies/autosoap|SOAP bash script}} made by StarlitSkies that heavily simplifies the process.
+<br>The only downside is that if cleaninty has a nonstandard error, the script will be unable to tell you the exact text of the error - meaning you will need to revert back to manual commands anyway in order to debug.
+Read the instructions on its page for setup and usage.
 [[Category:Nintendo 3DS guides]]