Added nus.py for handling NUS downloads, more or less completed already

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "libWiiPy"
-version = "0.2.0"
+version = "0.2.1"
 authors = [
     { name="NinjaCheetah", email="ninjacheetah@ncxprogramming.com" },
     { name="Lillian Skinner", email="lillian@randommeaninglesscharacters.com" }
@@ -15,6 +15,7 @@ classifiers = [
 ]
 dependencies = [
     "pycryptodome",
+    "urllib3"
 ]
 
 [project.urls]

requirements.txt

@@ -1,2 +1,3 @@
 build
 pycryptodome
+urllib3

src/libWiiPy/__init__.py

@@ -9,3 +9,4 @@ from .ticket import *
 from .title import *
 from .tmd import *
 from .wad import *
+from .nus import *

src/libWiiPy/nus.py

@@ -0,0 +1,197 @@
+# "nus.py" from libWiiPy by NinjaCheetah & Contributors
+# https://github.com/NinjaCheetah/libWiiPy
+#
+# See https://wiibrew.org/wiki/NUS for details about the NUS
+
+import io
+import urllib3
+import hashlib
+from typing import List
+from .title import Title
+from .tmd import TMD
+from .ticket import Ticket
+
+
+class NUSDownloader:
+    """
+    An NUS Downloader class that allows for easy downloading of a title from the NUS.
+
+    Parameters
+    ----------
+    title_id : str
+        The Title ID of the title you wish to download data for.
+    title_version : int, default: None
+        The version of the title you wish to download data for. Will assume latest if this is "None".
+    """
+    def __init__(self, title_id: str, title_version: int = None):
+        self.title_id = title_id
+        self.title_version = title_version
+        # Data from the NUS
+        self.raw_tmd: bytes = b''
+        self.tmd: bytes = b''
+        self.cetk: bytes = b''
+        self.cert: bytes = b''
+        self.ticket: bytes = b''
+        self.content_list: List[bytes] = []
+
+    def download_title(self) -> Title:
+        """
+        Download an entire title and all of its contents, then load the downloaded components into a Title object for
+        further use.
+
+        Returns
+        -------
+        Title
+            A Title object containing all the data from the downloaded title.
+        """
+        # First, create the new title.
+        title = Title()
+        # Download and load the TMD, Ticket, and certs.
+        title.load_tmd(self.download_tmd())
+        title.load_ticket(self.download_ticket())
+        title.wad.set_cert_data(self.download_cert())
+        # Download all contents
+        title.load_content_records()
+        title.content.content_list = self.download_contents(title.tmd)
+        # Return the completed title.
+        return title
+
+    def download_tmd(self) -> bytes:
+        """
+        Downloads the TMD of the Title specified in the object. Will download the latest version by default, or another
+        version if it was manually specified in the object.
+
+        Returns
+        -------
+        bytes
+            The TMD file from the NUS.
+        """
+        # Build the download URL. The structure is download/<TID>/tmd for latest and download/<TID>/tmd.<version> for
+        # when a specific version is requested.
+        tmd_url = "http://ccs.shop.wii.com/ccs/download/" + self.title_id + "/tmd"
+        # Add the version to the URL if one was specified.
+        if self.title_version is not None:
+            tmd_url += "." + str(self.title_version)
+        # Make the request.
+        tmd_response = urllib3.request(method='GET', url=tmd_url, headers={'User-Agent': 'wii libnup/1.0'})
+        # Handle a 404 if the TID/version doesn't exist.
+        if tmd_response.status != 200:
+            raise ValueError("The requested Title ID or TMD version does not exist. Please check the Title ID and Title"
+                             " version and then try again.")
+        # Save the raw TMD.
+        self.raw_tmd = tmd_response.data
+        # Use a TMD object to load the data and then return only the actual TMD.
+        tmd_temp = TMD()
+        tmd_temp.load(self.raw_tmd)
+        self.tmd = tmd_temp.dump()
+        return self.tmd
+
+    def download_ticket(self) -> bytes:
+        """
+        Downloads the Ticket of the Title specified in the object. This will only work if the Title ID specified is for
+        a free title.
+
+        Returns
+        -------
+        bytes
+            The Ticket file from the NUS.
+        """
+        # Build the download URL. The structure is download/<TID>/cetk, and cetk will only exist if this is a free
+        # title.
+        ticket_url = "http://ccs.shop.wii.com/ccs/download/" + self.title_id + "/cetk"
+        # Make the request.
+        ticket_response = urllib3.request(method='GET', url=ticket_url, headers={'User-Agent': 'wii libnup/1.0'})
+        if ticket_response.status != 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.")
+        # Save the raw cetk file.
+        self.cetk = ticket_response.data
+        # Use a Ticket object to load only the Ticket data from cetk and return it.
+        ticket_temp = Ticket()
+        ticket_temp.load(self.cetk)
+        self.ticket = ticket_temp.dump()
+        return self.ticket
+
+    def download_cert(self) -> bytes:
+        """
+        Downloads the signing certificate used by all WADs. This uses System Menu 4.3U as the source.
+
+        Returns
+        -------
+        bytes
+            The cert file.
+        """
+        # Download the TMD and cetk for the System Menu 4.3U.
+        tmd = urllib3.request(method='GET', url='http://ccs.shop.wii.com/ccs/download/0000000100000002/tmd.513',
+                              headers={'User-Agent': 'wii libnup/1.0'}).data
+        cetk = urllib3.request(method='GET', url='http://ccs.shop.wii.com/ccs/download/0000000100000002/cetk',
+                               headers={'User-Agent': 'wii libnup/1.0'}).data
+        # Assemble the certificate.
+        with io.BytesIO() as cert_data:
+            # Certificate Authority data.
+            cert_data.write(cetk[0x2A4 + 768:])
+            # Certificate Policy data.
+            cert_data.write(tmd[0x328:0x328 + 768])
+            # XS data.
+            cert_data.write(cetk[0x2A4:0x2A4 + 768])
+            cert_data.seek(0x0)
+            self.cert = cert_data.read()
+        # Since the cert is always the same, check the hash to make sure nothing went wildly wrong.
+        if hashlib.sha1(self.cert).hexdigest() != "ace0f15d2a851c383fe4657afc3840d6ffe30ad0":
+            raise Exception("An unknown error has occurred downloading and creating the certificate.")
+        return self.cert
+
+    def download_content(self, content_id) -> bytes:
+        """
+        Downloads a specified content for the title specified in the object.
+
+        Parameters
+        ----------
+        content_id : int
+            The Content ID of the content you wish to download.
+
+        Returns
+        -------
+        bytes
+            The downloaded content.
+        """
+        # Build the download URL. The structure is download/<TID>/<Content ID>.
+        content_id_hex = hex(content_id)[2:]
+        if len(content_id_hex) < 2:
+            content_id_hex = "0" + content_id_hex
+        content_url = "http://ccs.shop.wii.com/ccs/download/" + self.title_id + "/000000" + content_id_hex
+        # Make the request.
+        content_response = urllib3.request(method='GET', url=content_url, headers={'User-Agent': 'wii libnup/1.0'})
+        if content_response.status != 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" +
+                             content_id_hex)
+        return content_response.data
+
+    def download_contents(self, tmd: TMD) -> List[bytes]:
+        """
+        Downloads all the contents for the title specified in the object. This requires a TMD to already be available
+        so that the content records can be accessed.
+
+        Parameters
+        ----------
+        tmd : TMD
+            The TMD that matches the title that the contents being downloaded are from.
+
+        Returns
+        -------
+        List[bytes]
+            A list of all the downloaded contents.
+        """
+        # Retrieve the content records from the TMD.
+        content_records = tmd.content_records
+        # Create a list of Content IDs to download.
+        content_ids = []
+        for content_record in content_records:
+            content_ids.append(content_record.content_id)
+        # Iterate over that list and download each content in it, then add it to the array of contents.
+        for content_id in content_ids:
+            # Call self.download_content() for each Content ID.
+            content = self.download_content(content_id)
+            self.content_list.append(content)
+        return self.content_list