Re-add wiiload module post-merge

docs/source/api.md

@@ -0,0 +1,23 @@
+# API Documentation
+
+libWiiPy is divided up into a few subpackages to organize related features.
+
+| Package                              | Description                                                     |
+|--------------------------------------|-----------------------------------------------------------------|
+| [libWiiPy.archive](/archive/archive) | Used to pack and extract archive formats used on the Wii        |
+| [libWiiPy.media](/media/media)       | Used for parsing and manipulating media formats used on the Wii |
+| [libWiiPy.nand](/nand/nand)          | Used for working with EmuNANDs and core system files on the Wii |
+| [libWiiPy.title](/title/title)       | Used for parsing and manipulating Wii titles                    |
+
+When using libWiiPy in your project, you can choose to either only import the package that you need, or you can use `import libWiiPy` to import the entire package, which each module being available at `libWiiPy.<package>.<module>`.
+
+## Full Package Contents
+
+```{toctree}
+:maxdepth: 8
+
+/archive/archive
+/media/media
+/nand/nand
+/title/title
+```

docs/source/archive/archive.md

@@ -0,0 +1,20 @@
+# libWiiPy.archive Package
+
+## Modules
+The `libWiiPy.archive` package contains modules for packing and extracting archive formats used by the Wii. This currently includes packing and unpacking support for U8 archives and decompression support for ASH archives.
+
+| Module                                 | Description                                             |
+|----------------------------------------|---------------------------------------------------------|
+| [libWiiPy.archive.ash](/archive/ash)   | Provides support for decompressing ASH archives         |
+| [libWiiPy.archive.lz77](/archive/lz77) | Provides support for the LZ77 compression scheme        |
+| [libWiiPy.archive.u8](/archive/u8)     | Provides support for packing and extracting U8 archives |
+
+### libWiiPy.archive Package Contents
+
+```{toctree}
+:maxdepth: 4
+
+/archive/ash
+/archive/lz77
+/archive/u8
+```

docs/source/archive/ash.md

@@ -0,0 +1,14 @@
+# libWiiPy.archive.ash Module
+
+The `libWiiPy.archive.ash` module provides support for handling ASH files, which are a compressed format primarily used in the Wii Menu, but also in some other titles such as My Pokémon Ranch.
+
+At present, libWiiPy only has support for decompressing ASH files, with compression as a planned feature for the future.
+
+## Module Contents
+
+```{eval-rst}
+.. automodule:: libWiiPy.archive.ash
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/source/archive/lz77.md

@@ -0,0 +1,12 @@
+# libWiiPy.archive.lz77 Module
+
+The `libWiiPy.archive.lz77` module provides support for handling LZ77 compression, which is a compression format used across the Wii and other Nintendo consoles.
+
+## Module Contents
+
+```{eval-rst}
+.. automodule:: libWiiPy.archive.lz77
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/source/archive/u8.md

@@ -0,0 +1,14 @@
+# libWiiPy.archive.u8 Module
+
+The `libWiiPy.archive.u8` module provides support for handling U8 archives, which are a non-compressed archive format used extensively on the Wii to join multiple files into one.
+
+This module exposes functions for both packing and unpacking U8 archives, as well as code to parse IMET headers. IMET headers are a header format used specifically for U8 archives containing the banner of a channel, as they store the localized name of the channel along with other banner metadata.
+
+## Module Contents
+
+```{eval-rst}
+.. automodule:: libWiiPy.archive.u8
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/source/conf.py

@@ -11,6 +11,7 @@ from datetime import date
 project = 'libWiiPy'
 copyright = f'{date.today().year}, NinjaCheetah & Contributors'
 author = 'NinjaCheetah & Contributors'
+version = 'main'
 release = 'main'
 
 # -- General configuration ---------------------------------------------------

docs/source/index.md

@@ -4,9 +4,11 @@ sd_hide_title: true
 
 # Overview
 
-# libWiiPy API Docs
+# libWiiPy Documentation
 
-Welcome to the API documentation website for libWiiPy! libWiiPy is a modern Python 3 library for handling the various files and formats found on the Wii.
+Welcome to the documentation website for libWiiPy! libWiiPy is a modern Python 3 library for handling the various files and formats found on the Wii.
+
+Just need to see the API? [libWiiPy API Documentation](/api)
 
 ```{toctree}
 :hidden:
@@ -34,13 +36,12 @@ titles/nus-downloading.md
 
 ```{toctree}
 :hidden:
-:caption: Other Useful Pages
+:caption: More
 
-modules.md
+api.md
 ```
 
 ## Indices and tables
 
 * [Full Index](<project:#genindex>)
-* [Module Index](<project:#modules>)
 * <project:#search>

docs/source/libWiiPy.archive.md

@@ -1,28 +0,0 @@
-# libWiiPy.archive package
-
-## Submodules
-
-### libWiiPy.archive.ash module
-
-```{eval-rst}
-.. automodule:: libWiiPy.archive.ash
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-### libWiiPy.archive.u8 module
-
-```{eval-rst}
-.. automodule:: libWiiPy.archive.u8
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-## Module contents
-
-```{eval-rst}
-.. automodule:: libWiiPy.archive
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```

docs/source/libWiiPy.md

@@ -1,36 +0,0 @@
-# libWiiPy package
-
-## Subpackages
-
-```{toctree}
-:maxdepth: 4
-
-libWiiPy.archive
-libWiiPy.media
-libWiiPy.nand
-libWiiPy.title
-```
-
-## Submodules
-
-### libWiiPy.shared module
-
-libWiiPy's ``shared`` module is private and contains only private functions used by other modules.
-
-```{eval-rst}
-.. automodule:: libWiiPy.shared
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
-### libWiiPy.types module
-
-libWiiPy's ``types`` module is private and contains only private classes used by other modules.
-
-```{eval-rst}
-.. automodule:: libWiiPy.types
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```

docs/source/libWiiPy.media.md

@@ -1,11 +0,0 @@
-# libWiiPy.media package
-
-## Submodules
-
-### libWiiPy.media.banner module
-```{eval-rst}
-.. automodule:: libWiiPy.media.banner
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```

docs/source/libWiiPy.nand.md

@@ -1,27 +0,0 @@
-# libWiiPy.nand package
-
-## Submodules
-
-### libWiiPy.nand.emunand module
-```{eval-rst}
-.. automodule:: libWiiPy.nand.emunand
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
-### libWiiPy.nand.setting module
-```{eval-rst}
-.. automodule:: libWiiPy.nand.setting
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
-### libWiiPy.nand.sys module
-```{eval-rst}
-.. automodule:: libWiiPy.nand.sys
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```

docs/source/libWiiPy.title.md

@@ -1,99 +0,0 @@
-# libWiiPy.title package
-
-## Submodules
-
-### libWiiPy.title.cert module
-```{eval-rst}
-.. automodule:: libWiiPy.title.cert
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
-### libWiiPy.title.commonkeys module
-```{eval-rst}
-.. automodule:: libWiiPy.title.commonkeys
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
-### libWiiPy.title.content module
-```{eval-rst}
-.. automodule:: libWiiPy.title.content
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
-### libWiiPy.title.crypto module
-```{eval-rst}
-.. automodule:: libWiiPy.title.crypto
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
-### libWiipy.title.iospatcher module
-```{eval-rst}
-.. automodule:: libWiiPy.title.iospatcher
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
-### libWiiPy.title.nus module
-```{eval-rst}
-.. automodule:: libWiiPy.title.nus
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
-### libWiiPy.title.ticket module
-```{eval-rst}
-.. automodule:: libWiiPy.title.ticket
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
-### libWiiPy.title.title module
-```{eval-rst}
-.. automodule:: libWiiPy.title.title
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
-### libWiiPy.title.tmd module
-```{eval-rst}
-.. automodule:: libWiiPy.title.tmd
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
-### libWiiPy.title.util module
-```{eval-rst}
-.. automodule:: libWiiPy.title.util
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
-### libWiiPy.title.wad module
-```{eval-rst}
-.. automodule:: libWiiPy.title.wad
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
-## Module contents
-```{eval-rst}
-.. automodule:: libWiiPy.title
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```

docs/source/media/banner.md

@@ -0,0 +1,12 @@
+# libWiiPy.media.banner Module
+
+The `libWiiPy.media.banner` module is essentially a stub at this point in time. It only provides one dataclass that is likely to become a traditional class when fully implemented. It is not recommended to use this module for anything yet.
+
+## Module Contents
+
+```{eval-rst}
+.. automodule:: libWiiPy.media.banner
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/source/media/media.md

@@ -0,0 +1,16 @@
+# libWiiPy.media Package
+
+## Modules
+The `libWiiPy.media` package contains modules used for parsing and editing media formats used by the Wii. This currently only includes limited support for parsing channel banners.
+
+| Module                                 | Description                                       |
+|----------------------------------------|---------------------------------------------------|
+| [libWiiPy.media.banner](/media/banner) | Provides support for basic channel banner parsing |
+
+### libWiiPy.media Package Contents
+
+```{toctree}
+:maxdepth: 4
+
+/media/banner
+```

docs/source/modules.md

@@ -1,7 +0,0 @@
-# Modules Overview
-
-```{toctree}
-:maxdepth: 4
-
-libWiiPy
-```

docs/source/nand/emunand.md

@@ -0,0 +1,12 @@
+# libWiiPy.nand.emunand Module
+
+The `libWiiPy.nand.emunand` module provides support for creating and managing Wii EmuNANDs. At present, you cannot create an EmuNAND compatible with something like NEEK on a real Wii with the features provided by this library, but you can create an EmuNAND compatible with Dolphin.
+
+## Module Contents
+
+```{eval-rst}
+.. automodule:: libWiiPy.nand.emunand
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/source/nand/nand.md

@@ -0,0 +1,20 @@
+# libWiiPy.nand Package
+
+## Modules
+The `libWiiPy.nand` package contains modules for parsing and manipulating EmuNANDs as well as modules for parsing and editing core system files found on the Wii's NAND.
+
+| Module                                 | Description                                                                                                                      |
+|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|
+| [libWiiPy.nand.emunand](/nand/emunand) | Provides support for parsing, creating, and editing EmuNANDs                                                                     |
+| [libWiiPy.nand.setting](/nand/setting) | Provides support for parsing, creating, and editing `setting.txt`, which is used to store the console's region and serial number |
+| [libWiiPy.nand.sys](/nand/sys)         | Provides support for parsing, creating, and editing `uid.sys`, which is used to store a log of all titles run on a console       |
+
+### libWiiPy.nand Package Contents
+
+```{toctree}
+:maxdepth: 4
+
+/nand/emunand
+/nand/setting
+/nand/sys
+```

docs/source/nand/setting.md

@@ -0,0 +1,14 @@
+# libWiiPy.nand.setting Module
+
+The `libWiiPy.nand.setting` module provides support for handling the Wii's `setting.txt` file. This file is stored as part of the Wii Menu's save data (stored in `/title/00000001/00000002/data/`) and is an encrypted text file that's primarily used to store your console's serial number and region information.
+
+This module allows you to encrypt or decrypt this file, and exposes the keys stored in it for editing.
+
+## Module Contents
+
+```{eval-rst}
+.. automodule:: libWiiPy.nand.setting
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/source/nand/sys.md

@@ -0,0 +1,12 @@
+# libWiiPy.nand.sys Module
+
+The `libWiiPy.nand.sys` module provides support for editing system files used on the Wii. Currently, it only offers support for `uid.sys`, which keeps a record of the Title IDs of every title launched on the console, assigning each one a unique ID.
+
+## Module Contents
+
+```{eval-rst}
+.. automodule:: libWiiPy.nand.sys
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/source/title/cert.md

@@ -0,0 +1,14 @@
+# libWiiPy.title.cert Module
+
+The `libWiiPy.title.cert` module provides support for parsing the various signing certificates used by the Wii for content validation.
+
+This module allows you to write your own code for validating the authenticity of a TMD or Ticket by providing the certificates from the Wii's certificate chain. Both retail and development certificate chains are supported.
+
+## Module Contents
+
+```{eval-rst}
+.. automodule:: libWiiPy.title.cert
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/source/title/commonkeys.md

@@ -0,0 +1,12 @@
+# libWiiPy.title.commonkeys Module
+
+The `libWiiPy.title.commonkeys` module simply provides easy access to the Wii's common encryption keys.
+
+## Module Contents
+
+```{eval-rst}
+.. automodule:: libWiiPy.title.commonkeys
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/source/title/content.md

@@ -0,0 +1,12 @@
+# libWiiPy.title.content Module
+
+The `libWiiPy.title.content` module provides support for parsing, adding, removing, and editing content files from a digital Wii title.
+
+## Module Contents
+
+```{eval-rst}
+.. automodule:: libWiiPy.title.content
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/source/title/crypto.md

@@ -0,0 +1,12 @@
+# libWiiPy.title.crypto Module
+
+The `libWiiPy.title.crypto` module provides low-level cryptography functions required for handling digital Wii titles. It does not expose many functions that are likely to be required during typical use, and instead acts more as a dependency for other modules.
+
+## Module Contents
+
+```{eval-rst}
+.. automodule:: libWiiPy.title.crypto
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/source/title/iospatcher.md

@@ -0,0 +1,12 @@
+# libWiiPy.title.iospatcher Module
+
+The `libWiiPy.title.iospatcher` module provides support for applying various binary patches to IOS' ES module. These patches and what they do can be found attached to the methods used to apply them.
+
+## Module Contents
+
+```{eval-rst}
+.. automodule:: libWiiPy.title.iospatcher
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/source/title/nus.md

@@ -0,0 +1,12 @@
+# libWiiPy.title.nus Module
+
+The `libWiiPy.title.nus` module provides support for downloading digital Wii titles from the Nintendo Update Servers. This module provides easy methods for downloading TMDs, common Tickets (when present), encrypted content, and the certificate chain.
+
+## Module Contents
+
+```{eval-rst}
+.. automodule:: libWiiPy.title.nus
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/source/title/ticket.md

@@ -0,0 +1,12 @@
+# libWiiPy.title.ticket Module
+
+The `libWiiPy.title.ticket` module provides support for handling Tickets, which are the license files used to decrypt the content of digital titles during installation. This module allows for easy parsing and editing of Tickets.
+
+## Module Contents
+
+```{eval-rst}
+.. automodule:: libWiiPy.title.ticket
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/source/title/title.md

@@ -0,0 +1,36 @@
+# libWiiPy.title Package
+
+## Modules
+The `libWiiPy.title` package contains modules for interacting with Wii titles. This is the most complete package in libWiiPy, and therefore offers the most functionality.
+
+| Module                                         | Description                                                                                                                   |
+|------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
+| [libWiiPy.title.cert](/title/cert)             | Provides support for parsing and validating the certificates used for title verification                                      |
+| [libWiiPy.title.commonkeys](/title/commonkeys) | Provides easy access to all common encryption keys                                                                            |
+| [libWiiPy.title.content](/title/content)       | Provides support for parsing and editing content included as part of digital titles                                           |
+| [libWiiPy.title.crypto](/title/crypto)         | Provides low-level cryptography functions used to handle encryption in other modules                                          |
+| [libWiiPy.title.iospatcher](/title/iospatcher) | Provides an easy interface to apply patches to IOSes                                                                          |
+| [libWiiPy.title.nus](/title/nus)               | Provides support for downloading TMDs, Tickets, encrypted content, and the certificate chain from the Nintendo Update Servers |
+| [libWiiPy.title.ticket](/title/ticket)         | Provides support for parsing and editing Tickets used for content decryption                                                  |
+| [libWiiPy.title.title](/title/title.title)     | Provides high-level support for parsing and editing an entire title with the context of each component                        |
+| [libWiiPy.title.tmd](/title/tmd)               | Provides support for parsing and editing TMDs (Title Metadata)                                                                |
+| [libWiiPy.title.util](/title/util)             | Provides some simple utility functions relating to titles                                                                     |
+| [libWiiPy.title.wad](/title/wad)               | Provides support for parsing and editing WAD files, allowing you to load each component into the other available classes      |
+
+### libWiiPy.title Package Contents
+
+```{toctree}
+:maxdepth: 4
+
+/title/cert
+/title/commonkeys
+/title/content
+/title/crypto
+/title/iospatcher
+/title/nus
+/title/ticket
+/title/title.title
+/title/tmd
+/title/util
+/title/wad
+```

docs/source/title/title.title.md

@@ -0,0 +1,16 @@
+# libWiiPy.title.title Module
+
+The `libWiiPy.title.title` module provides a high-level interface for handling all the components of a digital Wii title through one class. It allows for directly importing a WAD, and will automatically extract the various components and load them into their appropriate classes. Additionally, it provides duplicates of some methods found in those classes that require fewer arguments, as it has the context of the other components and is able to retrieve additional data automatically.
+
+An example of that idea can be seen with the method `get_content_by_index()`. In its original definition, which can be seen at <project:#libWiiPy.title.content.ContentRegion.get_content_by_index>, you are required to supply the Title Key for the title that the content is sourced from. In contrast, when using <project:#libWiiPy.title.title.Title.get_content_by_index>, you do not need to supply a Title Key, as the Title object already has the context of the Ticket and can retrieve the Title Key from it automatically. In a similar vein, this module provides the easiest route for verifying that a title is legitimately signed by Nintendo. The method <project:#libWiiPy.title.title.Title.get_is_signed> is able to access the entire certificate chain, the TMD, and the Ticket, and is therefore able to verify all components of the title by itself.
+
+Because using <project:#libWiiPy.title.title.Title> allows many operations to be much simpler than if you manage the components separately, it's generally recommended to use it whenever possible.
+
+## Module Contents
+
+```{eval-rst}
+.. automodule:: libWiiPy.title.title
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/source/title/tmd.md

@@ -0,0 +1,12 @@
+# libWiiPy.title.tmd Module
+
+The `libWiiPy.title.tmd` module provides support for handling TMD (Title Metadata) files, which contain the metadata of both digital and physical Wii titles. This module allows for easy parsing and editing of TMDs.
+
+## Module Contents
+
+```{eval-rst}
+.. automodule:: libWiiPy.title.tmd
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/source/title/util.md

@@ -0,0 +1,12 @@
+# libWiiPy.title.util Module
+
+The `libWiiPy.title.util` module provides common utility functions internally. It is not designed to be used directly.
+
+## Module Contents
+
+```{eval-rst}
+.. automodule:: libWiiPy.title.util
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/source/title/wad.md

@@ -0,0 +1,12 @@
+# libWiiPy.title.wad Module
+
+The `libWiiPy.title.wad` module provides support for handling WAD (Wii Archive Data) files, which is the format used to deliver digital Wii titles. This module allows for extracting the various components for a WAD, as well as properly padding and writing out that data when it has been edited using other modules.
+
+## Module Contents
+
+```{eval-rst}
+.. automodule:: libWiiPy.title.wad
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/source/titles/extracting-titles.md

@@ -34,7 +34,7 @@ And viola! We have a WAD object that we can use to get each separate part of our
 
 ## Picking the WAD Apart
 
-Now that we have our WAD loaded, we need to separate it out into its components. On top of the parts we already established, a WAD also contains a certificate, checked by IOS during official title installations to ensure that a title was signed by Nintendo, and potentially two more areas called the footer and the CRL. Footers aren't a necessary part of a WAD, and when they do exist, they typically only contain the build timestamp and the machine it was built on. CRLs are even less common, and have never actually been found inside any WAD, but we know they exist because of things we've seen that Nintendo would really rather we hadn't. Because these three components don't have data we can edit, they're only ever represented as bytes, and do not have their own classes.
+Now that we have our WAD loaded, we need to separate it out into its components. On top of the parts we already established, a WAD also contains a certificate chain, which is used by IOS during official title installations to ensure that a title was signed by Nintendo, and potentially two more areas called the footer and the CRL. Footers aren't a necessary part of a WAD, and when they do exist, they typically only contain the build timestamp and the machine it was built on. CRLs are even less common, and have never actually been found inside any WAD, but we know they exist because of things we've seen that Nintendo would really rather we hadn't. Certificate chains also have a class that we'll cover after the main three components, but the latter two components don't have data we can edit, so they're only ever represented as bytes and do not have their own classes.
 
 ### The TMD
 
@@ -110,11 +110,19 @@ Now that we know things are working, why don't we speed things up a little by us
 
 And just like that, we have our TMD, Ticket, and decrypted content all extracted! From here, what you do with them is up to you and whatever program you're working on. For example, to make a simple WAD extractor, you may want to write all these files to an output directory.
 
+### The Certificate Chain
+
+As mentioned at the start of this guide, WADs also contain a certificate chain. We don't necessarily need this data right now, but getting it is very similar to the other components:
+```pycon
+>>> certificate_chain = libWiiPy.title.CertificateChain()
+>>> certificate_chain.load(wad.get_cert_data())
+>>>
+```
+
 ### The Other Data
 
-As mentioned earlier in this guide, WADs also contain up to three extra regions of data: the certificate, the footer, and the CRL. The procedure for extracting all of these is pretty simple, and follows the same formula as any other data in a WAD:
+Also mentioned earlier in this guide, WADs may contain two additional regions of data know as the footer (or "meta"), and the CRL. The procedure for extracting all of these is pretty simple, and follows the same formula as any other data in a WAD:
 ```pycon
->>> certificate = wad.get_cert_data()
 >>> footer = wad.get_meta_data()
 >>> crl = wad.get_crl_data()
 >>>
@@ -123,7 +131,7 @@ As mentioned earlier in this guide, WADs also contain up to three extra regions
 Beyond getting their raw data, there isn't anything you can directly do with these components with libWiiPy. If one of these components doesn't exist, libWiiPy will simply return an empty bytes object.
 
 :::{note}
-Managed to find a WAD somewhere with CRL data? I'd love to here more, so feel free to email me at [ninjacheetah@ncxprogramming.com](mailto:ninjacheetah@ncxprogramming.com).
+Managed to find a WAD somewhere with CRL data? I'd love to hear more, so feel free to email me at [ninjacheetah@ncxprogramming.com](mailto:ninjacheetah@ncxprogramming.com).
 :::
 
 <hr>

src/libWiiPy/archive/__init__.py

@@ -2,4 +2,5 @@
 # https://github.com/NinjaCheetah/libWiiPy
 
 from .ash import *
+from .lz77 import *
 from .u8 import *

src/libWiiPy/archive/ash.py

@@ -5,7 +5,7 @@
 # co-authored by NinjaCheetah.
 # https://github.com/NinjaCheetah/ASH0-tools
 #
-# See <link pending> for details about the ASH archive format.
+# See <link pending> for details about the ASH compression format.
 
 import io
 from dataclasses import dataclass as _dataclass

src/libWiiPy/archive/lz77.py

@@ -0,0 +1,211 @@
+# "archive/lz77.py" from libWiiPy by NinjaCheetah & Contributors
+# https://github.com/NinjaCheetah/libWiiPy
+#
+# See https://wiibrew.org/wiki/LZ77 for details about the LZ77 compression format.
+
+import io
+from dataclasses import dataclass as _dataclass
+
+
+_LZ_MIN_DISTANCE = 0x01   # Minimum distance for each reference.
+_LZ_MAX_DISTANCE = 0x1000   # Maximum distance for each reference.
+_LZ_MIN_LENGTH = 0x03   # Minimum length for each reference.
+_LZ_MAX_LENGTH = 0x12   # Maximum length for each reference.
+
+
+@_dataclass
+class _LZNode:
+    dist: int = 0
+    len: int = 0
+    weight: int = 0
+
+
+def _compress_compare_bytes(byte1: bytes, offset1: int, byte2: bytes, offset2: int, abs_len_max: int) -> int:
+    # Compare bytes up to the maximum length we can match.
+    num_matched = 0
+    while num_matched < abs_len_max:
+        if byte1[offset1 + num_matched] != byte2[offset2 + num_matched]:
+            break
+        num_matched += 1
+    return num_matched
+
+
+def _compress_search_matches(buffer: bytes, pos: int) -> (int, int):
+    bytes_left = len(buffer) - pos
+    global _LZ_MAX_DISTANCE, _LZ_MAX_LENGTH, _LZ_MIN_DISTANCE
+    # Default to only looking back 4096 bytes, unless we've moved fewer than 4096 bytes, in which case we should
+    # only look as far back as we've gone.
+    max_dist = min(_LZ_MAX_DISTANCE, pos)
+    # Default to only matching up to 18 bytes, unless fewer than 18 bytes remain, in which case we can only match
+    # up to that many bytes.
+    max_len = min(_LZ_MAX_LENGTH, bytes_left)
+    # Log the longest match we found and its offset.
+    biggest_match, biggest_match_pos = 0, 0
+    # Search for matches.
+    for i in range(_LZ_MIN_DISTANCE, max_dist + 1):
+        num_matched = _compress_compare_bytes(buffer, pos - i, buffer, pos, max_len)
+        if num_matched > biggest_match:
+            biggest_match = num_matched
+            biggest_match_pos = i
+            if biggest_match == max_len:
+                break
+    return biggest_match, biggest_match_pos
+
+
+def _compress_node_is_ref(node: _LZNode) -> bool:
+    return node.len >= _LZ_MIN_LENGTH
+
+
+def _compress_get_node_cost(length: int) -> int:
+    if length >= _LZ_MIN_LENGTH:
+        num_bytes = 2
+    else:
+        num_bytes = 1
+    return 1 + (num_bytes * 8)
+
+
+def compress_lz77(data: bytes) -> bytes:
+    """
+    Compresses data using the Wii's LZ77 compression algorithm and returns the compressed result.
+
+    Parameters
+    ----------
+    data: bytes
+        The data to compress.
+
+    Returns
+    -------
+    bytes
+        The LZ77-compressed data.
+    """
+    nodes = [_LZNode() for _ in range(len(data))]
+    # Iterate over the uncompressed data, starting from the end.
+    pos = len(data)
+    global _LZ_MAX_LENGTH, _LZ_MIN_LENGTH, _LZ_MIN_DISTANCE
+    while pos:
+        pos -= 1
+        node = nodes[pos]
+        # Limit the maximum search length when we're near the end of the file.
+        max_search_len = min(_LZ_MAX_LENGTH, len(data) - pos)
+        if max_search_len < _LZ_MIN_DISTANCE:
+            max_search_len = 1
+        # Initialize as 1 for each, since that's all we could use if we weren't compressing.
+        length, dist = 1, 1
+        if max_search_len >= _LZ_MIN_LENGTH:
+            length, dist = _compress_search_matches(data, pos)
+        # Treat as direct bytes if it's too short to copy.
+        if length == 0 or length < _LZ_MIN_LENGTH:
+            length = 1
+        # If the node goes to the end of the file, the weight is the cost of the node.
+        if (pos + length) == len(data):
+            node.len = length
+            node.dist = dist
+            node.weight = _compress_get_node_cost(length)
+        # Otherwise, search for possible matches and determine the one with the best cost.
+        else:
+            weight_best = 0xFFFFFFFF  # This was originally UINT_MAX, but that isn't a thing here so 32-bit it is!
+            len_best = 1
+            while length:
+                weight_next = nodes[pos + length].weight
+                weight = _compress_get_node_cost(length) + weight_next
+                if weight < weight_best:
+                    len_best = length
+                    weight_best = weight
+                length -= 1
+                if length != 0 and length < _LZ_MIN_LENGTH:
+                    length = 1
+            node.len = len_best
+            node.dist = dist
+            node.weight = weight_best
+    # Write the header data.
+    with io.BytesIO() as buffer:
+        # Write the header data.
+        buffer.write(b'LZ77\x10')  # The LZ type on the Wii is *always* 0x10.
+        buffer.write(len(data).to_bytes(3, 'little'))
+
+        src_pos = 0
+        while src_pos < len(data):
+            head = 0
+            head_pos = buffer.tell()
+            buffer.write(b'\x00')  # Reserve a byte for the chunk head.
+
+            i = 0
+            while i < 8 and src_pos < len(data):
+                current_node = nodes[src_pos]
+                length = current_node.len
+                dist = current_node.dist
+                # This is a reference node.
+                if _compress_node_is_ref(current_node):
+                    encoded = (((length - _LZ_MIN_LENGTH) & 0xF) << 12) | ((dist - _LZ_MIN_DISTANCE) & 0xFFF)
+                    buffer.write(encoded.to_bytes(2))
+                    head = (head | (1 << (7 - i))) & 0xFF
+                # This is a direct copy node.
+                else:
+                    buffer.write(data[src_pos:src_pos + 1])
+                src_pos += length
+                i += 1
+
+            pos = buffer.tell()
+            buffer.seek(head_pos)
+            buffer.write(head.to_bytes(1))
+            buffer.seek(pos)
+
+        buffer.seek(0)
+        out_data = buffer.read()
+    return out_data
+
+
+def decompress_lz77(lz77_data: bytes) -> bytes:
+    """
+    Decompresses LZ77-compressed data and returns the decompressed result. Supports data both with and without the
+    magic number 'LZ77' (which may not be present if the data is embedded in something else).
+
+    Parameters
+    ----------
+    lz77_data: bytes
+        The LZ77-compressed data to decompress.
+
+    Returns
+    -------
+    bytes
+        The decompressed data.
+    """
+    with io.BytesIO(lz77_data) as data:
+        magic = data.read(4)
+        # Assume if we didn't get the magic number that this data starts without it.
+        if magic != b'LZ77':
+            data.seek(0)
+        # Other compression types are used by Nintendo, but only type 0x10 was used on the Wii.
+        compression_type = int.from_bytes(data.read(1))
+        if compression_type != 0x10:
+            raise ValueError("This data is using an unsupported compression type!")
+        decompressed_size = int.from_bytes(data.read(3), byteorder='little')
+        # Use an integer list for storing decompressed data, this is much faster than using (and appending to) a
+        # bytes object.
+        out_data = [0] * decompressed_size
+        pos = 0
+        while pos < decompressed_size:
+            flag = int.from_bytes(data.read(1))
+            # Read bits in the flag from most to least significant.
+            for x in range(7, -1, -1):
+                # Avoids a buffer overrun if the final flag isn't fully used.
+                if pos >= decompressed_size:
+                    break
+                # Result of 1, this means we're copying bytes from earlier in the data.
+                if flag & (1 << x):
+                    reference = int.from_bytes(data.read(2))
+                    length = 3 + ((reference >> 12) & 0xF)
+                    offset = pos - (reference & 0xFFF) - 1
+                    for _ in range(length):
+                        out_data[pos] = out_data[offset]
+                        pos += 1
+                        offset += 1
+                        # Avoids a buffer overrun if the copy length would extend past the end of the file.
+                        if pos >= decompressed_size:
+                            break
+                # Result of 0, use the next byte directly.
+                else:
+                    out_data[pos] = int.from_bytes(data.read(1))
+                    pos += 1
+        out_bytes = bytes(out_data)
+        return out_bytes

src/libWiiPy/nand/emunand.py

@@ -199,8 +199,8 @@ class EmuNAND:
             valid_lows = []
             for low in tid_lows:
                 if low.joinpath("content", "title.tmd").exists():
-                    valid_lows.append(low.name)
-            installed_titles.append(self.InstalledTitles(high.name, valid_lows))
+                    valid_lows.append(low.name.upper())
+            installed_titles.append(self.InstalledTitles(high.name.upper(), valid_lows))
         return installed_titles
 
     def get_title_tmd(self, tid: str) -> TMD:

src/libWiiPy/title/nus.py

@@ -88,7 +88,14 @@ def download_tmd(title_id: str, title_version: int = None, wiiu_endpoint: bool =
     if title_version is not None:
         tmd_url += "." + str(title_version)
     # Make the request.
-    tmd_request = requests.get(url=tmd_url, headers={'User-Agent': 'wii libnup/1.0'}, stream=True)
+    try:
+        tmd_request = requests.get(url=tmd_url, headers={'User-Agent': 'wii libnup/1.0'}, stream=True)
+    except requests.exceptions.ConnectionError:
+        if endpoint_override:
+            raise ValueError("A connection could not be made to the NUS endpoint. Please make sure that your endpoint "
+                             "override is valid.")
+        else:
+            raise Exception("A connection could not be made to the NUS endpoint. The NUS may be unavailable.")
     # Handle a 404 if the TID/version doesn't exist.
     if tmd_request.status_code != 200:
         raise ValueError("The requested Title ID or TMD version does not exist. Please check the Title ID and Title"
@@ -133,7 +140,14 @@ def download_ticket(title_id: str, wiiu_endpoint: bool = False, endpoint_overrid
             endpoint_url = _nus_endpoint[0]
     ticket_url = endpoint_url + title_id + "/cetk"
     # Make the request.
-    ticket_request = requests.get(url=ticket_url, headers={'User-Agent': 'wii libnup/1.0'}, stream=True)
+    try:
+        ticket_request = requests.get(url=ticket_url, headers={'User-Agent': 'wii libnup/1.0'}, stream=True)
+    except requests.exceptions.ConnectionError:
+        if endpoint_override:
+            raise ValueError("A connection could not be made to the NUS endpoint. Please make sure that your endpoint "
+                             "override is valid.")
+        else:
+            raise Exception("A connection could not be made to the NUS endpoint. The NUS may be unavailable.")
     if ticket_request.status_code != 200:
         raise ValueError("The requested Title ID does not exist, or refers to a non-free title. Tickets can only"
                          " be downloaded for titles that are free on the NUS.")
@@ -173,8 +187,15 @@ def download_cert_chain(wiiu_endpoint: bool = False, endpoint_override: str = No
             endpoint_url = _nus_endpoint[0]
     tmd_url = endpoint_url + "0000000100000002/tmd.513"
     cetk_url = endpoint_url + "0000000100000002/cetk"
-    tmd = requests.get(url=tmd_url, headers={'User-Agent': 'wii libnup/1.0'}, stream=True).content
-    cetk = requests.get(url=cetk_url, headers={'User-Agent': 'wii libnup/1.0'}, stream=True).content
+    try:
+        tmd = requests.get(url=tmd_url, headers={'User-Agent': 'wii libnup/1.0'}, stream=True).content
+        cetk = requests.get(url=cetk_url, headers={'User-Agent': 'wii libnup/1.0'}, stream=True).content
+    except requests.exceptions.ConnectionError:
+        if endpoint_override:
+            raise ValueError("A connection could not be made to the NUS endpoint. Please make sure that your endpoint "
+                             "override is valid.")
+        else:
+            raise Exception("A connection could not be made to the NUS endpoint. The NUS may be unavailable.")
     # Assemble the certificate chain.
     cert_chain = b''
     # Certificate Authority data.
@@ -184,8 +205,9 @@ def download_cert_chain(wiiu_endpoint: bool = False, endpoint_override: str = No
     # XS (Ticket certificate) data.
     cert_chain += cetk[0x2A4:0x2A4 + 768]
     # Since the cert chain is always the same, check the hash to make sure nothing went wildly wrong.
-    if hashlib.sha1(cert_chain).hexdigest() != "ace0f15d2a851c383fe4657afc3840d6ffe30ad0":
-        raise Exception("An unknown error has occurred downloading and creating the certificate.")
+    # This is currently disabled because of the possibility that one may be downloading non-retail certs (gasp!).
+    #if hashlib.sha1(cert_chain).hexdigest() != "ace0f15d2a851c383fe4657afc3840d6ffe30ad0":
+    #    raise Exception("An unknown error has occurred downloading and creating the certificate.")
     return cert_chain
 
 
@@ -224,7 +246,14 @@ def download_content(title_id: str, content_id: int, wiiu_endpoint: bool = False
             endpoint_url = _nus_endpoint[0]
     content_url = endpoint_url + title_id + "/000000" + content_id_hex
     # Make the request.
-    content_request = requests.get(url=content_url, headers={'User-Agent': 'wii libnup/1.0'}, stream=True)
+    try:
+        content_request = requests.get(url=content_url, headers={'User-Agent': 'wii libnup/1.0'}, stream=True)
+    except requests.exceptions.ConnectionError:
+        if endpoint_override:
+            raise ValueError("A connection could not be made to the NUS endpoint. Please make sure that your endpoint "
+                             "override is valid.")
+        else:
+            raise Exception("A connection could not be made to the NUS endpoint. The NUS may be unavailable.")
     if content_request.status_code != 200:
         raise ValueError("The requested Title ID does not exist, or an invalid Content ID is present in the"
                          " content records provided.\n Failed while downloading Content ID: 000000" +

src/libWiiPy/title/ticket.py

@@ -160,7 +160,8 @@ class Ticket:
                 limit_value = int.from_bytes(ticket_data.read(4))
                 self.title_limits_list.append(_TitleLimit(limit_type, limit_value))
         # Check certs to see if this is a retail or dev ticket. Treats unknown certs as being retail for now.
-        if self.signature_issuer.find("Root-CA00000002-XS00000006") != -1:
+        if (self.signature_issuer.find("Root-CA00000002-XS00000006") != -1 or
+                self.signature_issuer.find("Root-CA00000002-XS00000004") != -1):
             self.is_dev = True
         else:
             self.is_dev = False

src/libWiiPy/title/title.py

@@ -4,11 +4,13 @@
 # See https://wiibrew.org/wiki/Title for details about how titles are formatted
 
 import math
-from .cert import CertificateChain
-from .content import ContentRegion
-from .ticket import Ticket
-from .tmd import TMD
-from .wad import WAD
+from .cert import (CertificateChain as _CertificateChain,
+                   verify_ca_cert as _verify_ca_cert, verify_cert_sig as _verify_cert_sig,
+                   verify_tmd_sig as _verify_tmd_sig, verify_ticket_sig as _verify_ticket_sig)
+from .content import ContentRegion as _ContentRegion
+from .ticket import Ticket as _Ticket
+from .tmd import TMD as _TMD
+from .wad import WAD as _WAD
 from .crypto import encrypt_title_key
 
 
@@ -32,11 +34,11 @@ class Title:
         A ContentRegion object containing the title's contents.
     """
     def __init__(self):
-        self.wad: WAD = WAD()
-        self.cert_chain: CertificateChain = CertificateChain()
-        self.tmd: TMD = TMD()
-        self.ticket: Ticket = Ticket()
-        self.content: ContentRegion = ContentRegion()
+        self.wad: _WAD = _WAD()
+        self.cert_chain: _CertificateChain = _CertificateChain()
+        self.tmd: _TMD = _TMD()
+        self.ticket: _Ticket = _Ticket()
+        self.content: _ContentRegion = _ContentRegion()
 
     def load_wad(self, wad: bytes) -> None:
         """
@@ -49,19 +51,19 @@ class Title:
             The data for the WAD you wish to load.
         """
         # Create a new WAD object based on the WAD data provided.
-        self.wad = WAD()
+        self.wad = _WAD()
         self.wad.load(wad)
         # Load the certificate chain.
-        self.cert_chain = CertificateChain()
+        self.cert_chain = _CertificateChain()
         self.cert_chain.load(self.wad.get_cert_data())
         # Load the TMD.
-        self.tmd = TMD()
+        self.tmd = _TMD()
         self.tmd.load(self.wad.get_tmd_data())
         # Load the ticket.
-        self.ticket = Ticket()
+        self.ticket = _Ticket()
         self.ticket.load(self.wad.get_ticket_data())
         # Load the content.
-        self.content = ContentRegion()
+        self.content = _ContentRegion()
         self.content.load(self.wad.get_content_data(), self.tmd.content_records)
         # Ensure that the Title IDs of the TMD and Ticket match before doing anything else. If they don't, throw an
         # error because clearly something strange has gone on with the WAD and editing it probably won't work.
@@ -418,3 +420,34 @@ class Title:
             return True
         else:
             return False
+
+    def get_is_signed(self) -> bool:
+        """
+        Uses the certificate chain to verify whether the Title object contains a properly signed title or not. This
+        verifies both the TMD and Ticket, and if either one fails verification then the title is not considered valid.
+
+        This will validate the entire certificate chain. If any part of the chain doesn't match the other pieces, then
+        this method will raise an exception.
+
+        Returns
+        -------
+        bool
+            Whether the title is properly signed or not.
+
+        See Also
+        --------
+        libWiiPy.title.cert
+        """
+        # The entire chain needs to be verified, so start with the CA cert and work our way down. If anything fails
+        # along the way, future steps don't matter so exit the descending if's and return False.
+        try:
+            if _verify_ca_cert(self.cert_chain.ca_cert) is True:
+                if _verify_cert_sig(self.cert_chain.ca_cert, self.cert_chain.tmd_cert) is True:
+                    if _verify_tmd_sig(self.cert_chain.tmd_cert, self.tmd) is True:
+                        if _verify_cert_sig(self.cert_chain.ca_cert, self.cert_chain.ticket_cert) is True:
+                            if _verify_ticket_sig(self.cert_chain.ticket_cert, self.ticket) is True:
+                                return True
+        except ValueError:
+            raise ValueError("This title's certificate chain is not valid, or does not match the signature type of "
+                             "the TMD/Ticket.")
+        return False

src/libWiiPy/title/wiiload.py

@@ -0,0 +1,62 @@
+# "title/wiiload.py" from libWiiPy by NinjaCheetah & Contributors
+# https://github.com/NinjaCheetah/libWiiPy
+#
+# This code is adapted from "wiiload.py", which can be found on the WiiBrew page for Wiiload.
+# https://pastebin.com/4nWAkBpw
+#
+# See https://wiibrew.org/wiki/Wiiload for details about how Wiiload works
+
+import sys
+import zlib
+import socket
+import struct
+
+
+def send_bin_wiiload(target_ip: str, bin_data: bytes, name: str) -> None:
+    """
+    Sends an ELF or DOL binary to The Homebrew Channel via Wiiload. This requires the IP address of the console you
+    want to send the binary to.
+
+    Parameters
+    ----------
+    target_ip: str
+        The IP address of the console to send the binary to.
+    bin_data: bytes
+        The data of the ELF or DOL to send.
+    name: str
+        The name of the application being sent.
+    """
+    wii_ip = (target_ip, 4299)
+
+    WIILOAD_VERSION_MAJOR=0
+    WIILOAD_VERSION_MINOR=5
+
+    len_uncompressed = len(bin_data)
+    c_data = zlib.compress(bin_data, 6)
+
+    chunk_size = 1024*128
+    chunks = [c_data[i:i+chunk_size] for i  in range(0, len(c_data), chunk_size)]
+
+    args = [name]
+    args = "\x00".join(args) + "\x00"
+
+    s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+    s.connect(wii_ip)
+
+    s.send("HAXX")
+    s.send(struct.pack("B", WIILOAD_VERSION_MAJOR)) # one byte, unsigned
+    s.send(struct.pack("B", WIILOAD_VERSION_MINOR)) # one byte, unsigned
+    s.send(struct.pack(">H",len(args))) # bigendian, 2 bytes, unsigned
+    s.send(struct.pack(">L",len(c_data))) # bigendian, 4 bytes, unsigned
+    s.send(struct.pack(">L",len_uncompressed)) # bigendian, 4 bytes, unsigned
+
+    print(len(chunks),"chunks to send")
+    for piece in chunks:
+        s.send(piece)
+        sys.stdout.write("."); sys.stdout.flush()
+    sys.stdout.write("\n")
+
+    s.send(args)
+
+    s.close()
+    print("done")