Update to v0.7.

Author: DarkMatterCore

README.md

@@ -6,12 +6,21 @@ Usage:
 --------------
 
 ```
-Usage: %s <keys file> <device.cert> <input WAD> <output dir> [parent title ID]
+wad2bin v0.7 (c) DarkMatterCore.
+Built: 16:57:46 Jul  1 2020.
 
-Paths must not exceed 1023 characters. Relative paths are supported.
+Usage: wad2bin <keys.txt> <device.cert> <input WAD> <output dir> [<parent title ID> [--nullkey]]
+
+Paths must not exceed 259 characters. Relative paths are supported.
 The required directory tree for the *.bin file(s) will be created at the output directory.
 You can set your SD card root directory as the output directory.
-Parent title ID is only required if the input WAD is a DLC. A 16 character long hex string is expected.
+
+Notes about DLC support:
+* Parent title ID is only required if the input WAD is a DLC. A 16 character long hex string is expected.
+* If "--nullkey" is set after the parent title ID, a null key will be used to encrypt DLC content data.
+  Some older games (like Rock Band 2) depend on this to properly load DLC data when launched via the Disc Channel.
+
+For more information, please visit: https://github.com/DarkMatterCore/wad2bin.
 ```
 
 Building instructions:
@@ -43,12 +52,20 @@ Guidelines:
 * Both ticket and TMD for each converted WAD package must be installed on the target Wii console in order for this to work.
     * For this matter, the program generates a bogus WAD package at the provided output directory, using the `<title_id>_bogus.wad` naming convention. It can be used with regular WAD Managers to install both ticket and TMD if needed.
     * Bogus WAD packages don't have any encrypted content data, thus they're expected to return errors like `-1022` during installation with regular WAD Managers - this is expected behaviour, so don't panic.
-    * If you can't get your converted WAD package to work, try "uninstalling" the bogus WAD before installing it. It fixes the problem most of the time.
-* If the WAD ticket wasn't issued for the target console, or if the WAD isn't legit (e.g. homebrew WAD), the IOS used by the System Menu must be patched to enable the [signing bug](https://wiibrew.org/wiki/Signing_bug) on it.
-    * Regular Wii consoles: use [Simple IOS Patcher](https://gbatemp.net/download/simple-ios-patcher.25749) to install a patched System Menu IOS (IOS60 for 4.0 and 4.1, IOS70 for 4.2 and IOS80 for 4.3).
-    * Wii U consoles (vWii): use [Patched IOS80 Installer for vWii](https://gbatemp.net/threads/patched-ios80-installer-for-vwii-allows-sd-menu-custom-channels.344882) to install a patched IOS80.
+    * If you can't get your converted WAD package to work, try uninstalling the bogus WAD before installing it (for real). This fixes the problem most of the time.
 * Channel WADs get converted to `content.bin` files, while DLC WADs get converted to `<index>.bin` files.
 * If a DLC WAD is provided, it doesn't matter if it's an uncomplete WAD with missing contents, a WAD with a tampered TMD that only references the packaged contents or a full WAD with all contents: all cases are supported by wad2bin. There's no need to provide any content indexes.
+* DLCs can use a parent title ID that's different from the title ID from the game they belong if other games are capable of using them. That's why a parent title ID is required to convert DLCs.
+* Converted DLC data can be encrypted using either a null key (used by older games) or the console-specific PRNG key (used by newer games, and also old games when launched with a cIOS).
+* If the WAD ticket wasn't issued for the target console, or if the WAD isn't legit (e.g. homebrew WAD), a patched IOS must be installed and used. This varies depending on the converted WAD type:
+    * **Channels:** the IOS used by the System Menu must be patched to enable the [signing bug](https://wiibrew.org/wiki/Signing_bug) on it:
+        * **Regular Wii consoles:** use [Simple IOS Patcher](https://gbatemp.net/download/simple-ios-patcher.25749) to install a patched System Menu IOS (IOS60 for 4.0 and 4.1, IOS70 for 4.2 and IOS80 for 4.3).
+        * **Wii U consoles (vWii):** use [Patched IOS80 Installer for vWii](https://gbatemp.net/threads/patched-ios80-installer-for-vwii-allows-sd-menu-custom-channels.344882) to install a patched IOS80.
+    * **DLCs:** the game must be launched using a cIOS, or its required IOS version must be patched to enable the [signing bug](https://wiibrew.org/wiki/Signing_bug) on it. This greatly depends on:
+        * **How old the game is:** if it enforces the usage of a null key when launched through the Disc Channel.
+        * **The used launch method:** cIOS enforce the usage of the PRNG key, even on older games.
+        * **Ticket/TMD signature validity:** if it's not valid, or if the ticket wasn't issued for the target console, a patched IOS or a cIOS will always be necessary.
+        * Because of all these reasons, it's difficult to establish a clear procedure that works for every single case. Further trial and error by the user is encouraged.
 
 Supported DLCs:
 --------------
@@ -65,7 +82,7 @@ The title ID from the parent game must be provided as an additional command line
     * `00010005-735A45xx` (`sZEx`).
     * `00010005-735A46xx` (`sZFx`).
 
-* The Beatles Rock Band (`00010000-52394Axx`) (`R9Jx`):
+* The Beatles: Rock Band (`00010000-52394Axx`) (`R9Jx`):
     * `00010005-72394Axx` (`r9Jx`).
 
 * Rock Band 3 (`00010000-535A42xx`) (`SZBx`):
@@ -133,6 +150,21 @@ wad2bin is licensed under GPLv3 or (at your option) any later version.
 Changelog:
 --------------
 
+**v0.7:**
+
+* Removed parent title ID generation for DLC WADs. This doesn't work properly with games that are capable of using DLCs from other games.
+    * The hardcoded DLC title ID list is still being used as a filter to know if any converted DLCs will work or not.
+* Added support for encrypting converted DLC data with a null key. Fixes issues with older games launched through the Disc Channel, such as `Rock Band 2`.
+    * Please read the guidelines from the readme! Even if a null key is used, a patched IOS is still needed if the DLC ticket wasn't issued for the target console and you intend to launch the game through the Disc Channel.
+* Added `The Beatles: Rock Band` DLC to the hardcoded DLC title ID list.
+* Written content padding is now encrypted as well.
+* Several fixes to the U8 archive parsing code.
+* Fixed a silly `ECSDA` -> `ECDSA` typo.
+* Reworked certificate chain, ticket and TMD handling.
+* Implemented RSA signature verification in certificates, tickets and TMDs.
+    * Fixes a bug where the ticket would have been fakesigned even if it was perfectly valid.
+* Useful info is now displayed at the end of the conversion process. Please read it.
+
 **v0.6:**
 
 * Added a hardcoded list with title IDs from DLCs that can be converted to the `<index>.bin` format. Any other DLCs will return an error. Thanks to this, it's no longer necessary to input a parent title ID.

source/bin.c

@@ -507,7 +507,7 @@ bool binGenerateContentBinFromUnpackedInstallableWadPackage(os_char_t *unpacked_
     return success;
 }
 
-bool binGenerateIndexedPackagesFromUnpackedInstallableWadPackage(os_char_t *unpacked_wad_path, os_char_t *out_path, TitleMetadata *tmd, u64 parent_tid)
+bool binGenerateIndexedPackagesFromUnpackedInstallableWadPackage(os_char_t *unpacked_wad_path, os_char_t *out_path, TitleMetadata *tmd, u64 parent_tid, bool use_null_key)
 {
     size_t unpacked_wad_path_len = 0;
     size_t out_path_len = 0, new_out_path_len = 0;
@@ -639,7 +639,7 @@ bool binGenerateIndexedPackagesFromUnpackedInstallableWadPackage(os_char_t *unpa
         }
 
         /* Write encrypted content file. */
-        write_res = wadWriteUnpackedContentToPackage(indexed_bin, prng_key, cnt_iv, NULL, cnt_fd, cnt_idx, cnt_size, &aligned_cnt_size);
+        write_res = wadWriteUnpackedContentToPackage(indexed_bin, (use_null_key ? null_key : prng_key), cnt_iv, NULL, cnt_fd, cnt_idx, cnt_size, &aligned_cnt_size);
         if (!write_res) ERROR_MSG("Failed to write content file \"" OS_PRINT_STR "\" to \"" OS_PRINT_STR "\"!", unpacked_wad_path, out_path);
 
         /* Close files. */

source/bin.h

@@ -89,6 +89,6 @@ bool binIsDlcTitleConvertible(u64 tid);
 bool binGenerateContentBinFromUnpackedInstallableWadPackage(os_char_t *unpacked_wad_path, os_char_t *out_path, TitleMetadata *tmd);
 
 /// Generates <index>.bin file(s) using an unpacked WAD data directory, TMD data loaded into memory and a parent title ID.
-bool binGenerateIndexedPackagesFromUnpackedInstallableWadPackage(os_char_t *unpacked_wad_path, os_char_t *out_path, TitleMetadata *tmd, u64 parent_tid);
+bool binGenerateIndexedPackagesFromUnpackedInstallableWadPackage(os_char_t *unpacked_wad_path, os_char_t *out_path, TitleMetadata *tmd, u64 parent_tid, bool use_null_key);
 
 #endif /* __BIN_H__ */

source/main.c

@@ -23,14 +23,15 @@
 #include "keys.h"
 #include "bin.h"
 
-#define ARG_COUNT   4
+#define PATH_COUNT       4
+#define NULL_KEY_ARG    "--nullkey"
 
 int main(int argc, char **argv)
 {
     int ret = 0;
 
     /* Reserve memory for an extra temporary path. */
-    os_char_t *paths[ARG_COUNT + 1] = {0};
+    os_char_t *paths[PATH_COUNT + 1] = {0};
 
     CertificateChain *cert_chain = NULL;
 
@@ -41,18 +42,23 @@ int main(int argc, char **argv)
 
     u64 title_id = 0, parent_tid = 0;
     u32 required_ios = 0, tid_upper = 0;
+    bool use_null_key = false;
 
     printf("\nwad2bin v%s (c) DarkMatterCore.\n", VERSION);
     printf("Built: %s %s.\n\n", __TIME__, __DATE__);
 
-    if (argc < (ARG_COUNT + 1) || argc > (ARG_COUNT + 2) || strlen(argv[1]) >= MAX_PATH || strlen(argv[2]) >= MAX_PATH || strlen(argv[3]) >= MAX_PATH || \
-        (strlen(argv[4]) + SD_CONTENT_PATH_MAX_LENGTH) >= MAX_PATH || (argc == (ARG_COUNT + 2) && strlen(argv[5]) != 16))
+    if (argc < (PATH_COUNT + 1) || argc > (PATH_COUNT + 3) || strlen(argv[1]) >= MAX_PATH || strlen(argv[2]) >= MAX_PATH || strlen(argv[3]) >= MAX_PATH || \
+        (strlen(argv[4]) + SD_CONTENT_PATH_MAX_LENGTH) >= MAX_PATH || (argc >= (PATH_COUNT + 2) && strlen(argv[5]) != 16) || (argc == (PATH_COUNT + 3) && (strlen(argv[6]) != strlen(NULL_KEY_ARG) || \
+        strcmp(argv[6], NULL_KEY_ARG) != 0)))
     {
-        printf("Usage: %s <keys file> <device.cert> <input WAD> <output dir> [parent title ID]\n\n", argv[0]);
+        printf("Usage: %s <keys.txt> <device.cert> <input WAD> <output dir> [<parent title ID> [" NULL_KEY_ARG "]]\n\n", argv[0]);
         printf("Paths must not exceed %u characters. Relative paths are supported.\n", MAX_PATH - 1);
         printf("The required directory tree for the *.bin file(s) will be created at the output directory.\n");
-        printf("You can set your SD card root directory as the output directory.\n");
-        printf("Parent title ID is only required if the input WAD is a DLC. A 16 character long hex string is expected.\n\n");
+        printf("You can set your SD card root directory as the output directory.\n\n");
+        printf("Notes about DLC support:\n");
+        printf("* Parent title ID is only required if the input WAD is a DLC. A 16 character long hex string is expected.\n");
+        printf("* If \"" NULL_KEY_ARG "\" is set after the parent title ID, a null key will be used to encrypt DLC content data.\n");
+        printf("  Some older games (like Rock Band 2) depend on this to properly load DLC data when launched via the Disc Channel.\n\n");
         printf("For more information, please visit: https://github.com/DarkMatterCore/wad2bin.\n\n");
         ret = -1;
         goto out;
@@ -70,7 +76,7 @@ int main(int argc, char **argv)
     }
 
     /* Generate path buffers. */
-    for(u32 i = 0; i <= ARG_COUNT; i++)
+    for(u32 i = 0; i <= PATH_COUNT; i++)
     {
         /* Allocate memory for the current path. */
         paths[i] = (os_char_t*)calloc(MAX_PATH, sizeof(os_char_t));
@@ -81,7 +87,7 @@ int main(int argc, char **argv)
             goto out;
         }
 
-        if (i == ARG_COUNT)
+        if (i == PATH_COUNT)
         {
             /* Save temporary path and create it. */
             os_snprintf(paths[i], MAX_PATH, "." OS_PATH_SEPARATOR "wad2bin_wad_data");
@@ -104,12 +110,12 @@ int main(int argc, char **argv)
             /* Check if the output directory string ends with a path separator. */
             /* If so, remove it. */
             u64 path_len = strlen(argv[i + 1]);
-            if (i == (ARG_COUNT - 1) && argv[i + 1][path_len - 1] == *((u8*)OS_PATH_SEPARATOR)) paths[i][path_len - 1] = (os_char_t)0;
+            if (i == (PATH_COUNT - 1) && argv[i + 1][path_len - 1] == *((u8*)OS_PATH_SEPARATOR)) paths[i][path_len - 1] = (os_char_t)0;
         }
     }
 
     /* Check if the user provided a parent title ID. */
-    if (argc == (ARG_COUNT + 2))
+    if (argc >= (PATH_COUNT + 2))
     {
         /* Parse parent title ID. */
         if (!keysParseHexKey((u8*)&parent_tid, NULL, argv[5], 8, false))
@@ -130,6 +136,9 @@ int main(int argc, char **argv)
             ret = -6;
             goto out;
         }
+        
+        /* Enable null key usage if needed. */
+        use_null_key = (argc == (PATH_COUNT + 3));
     }
 
     /* Load keydata and device certificate. */
@@ -160,7 +169,7 @@ int main(int argc, char **argv)
     if (tid_upper == TITLE_TYPE_DLC)
     {
         /* Check if a parent title ID was provided. */
-        if (argc != (ARG_COUNT + 2))
+        if (argc < (PATH_COUNT + 2))
         {
             ERROR_MSG("Error: parent title ID not provided! This is required for DLC titles.\n");
             ret = -9;
@@ -176,7 +185,7 @@ int main(int argc, char **argv)
         }
 
         /* Generate <index>.bin file(s). */
-        if (!binGenerateIndexedPackagesFromUnpackedInstallableWadPackage(paths[4], paths[3], tmd, parent_tid))
+        if (!binGenerateIndexedPackagesFromUnpackedInstallableWadPackage(paths[4], paths[3], tmd, parent_tid, use_null_key))
         {
             ret = -11;
             goto out;
@@ -206,13 +215,33 @@ int main(int argc, char **argv)
 
         if (tid_upper == TITLE_TYPE_DLC)
         {
-            printf("In order to use the converted DLC package, you'll either need to launch the game using a cIOS (NeoGamma, USB Loader),\n");
-            printf("or install a patched IOS%u (if you wish to use the disc channel).\n\n", required_ios);
+            if (use_null_key)
+            {
+                printf("In order to use the converted DLC, you'll need to install a patched IOS%u and launch the game via the Disc Channel.\n", required_ios);
+                printf("The converted DLC won't work if you launch the game using a cIOS (e.g. NeoGamma, USB Loader).\n");
+            } else {
+                printf("In order to use the converted DLC, you'll need to launch the game using a cIOS (NeoGamma, USB Loader),\n");
+                printf("or install a patched IOS%u (if you wish to use the Disc Channel).\n", required_ios);
+            }
         } else {
             printf("You'll need to install a patched System Menu IOS in order to run this channel from the SD card menu.\n\n");
         }
+    } else {
+        printf("Both ticket/TMD signatures are valid.\n");
+        
+        if (tid_upper == TITLE_TYPE_DLC)
+        {
+            printf("This DLC should work right away on your console without having to launch the game using a cIOS, nor having to\n");
+            printf("install a patched IOS%u.\n", required_ios);
+        } else {
+            printf("This channel should work right away on your console without having to install a patched System Menu IOS.\n\n");
+        }
     }
 
+    if (tid_upper == TITLE_TYPE_DLC) printf("If it doesn't work anyway, try converting the DLC %s \"" NULL_KEY_ARG "\".\n\n", (use_null_key ? "without" : "with"));
+    
+    printf("Remember to install the generated bogus WAD file! If it doesn't work, try uninstalling it first (for real).\n\n");
+    
 out:
     if (ret < 0 && ret != -1) printf("Process failed!\n\n");
 
@@ -237,7 +266,7 @@ int main(int argc, char **argv)
     /* Remove unpacked WAD directory. */
     if (paths[4]) utilsRemoveDirectoryRecursively(paths[4]);
 
-    for(u32 i = 0; i <= ARG_COUNT; i++)
+    for(u32 i = 0; i <= PATH_COUNT; i++)
     {
         if (paths[i]) free(paths[i]);
     }