NinjaCheetah/libWiiPy
1
0
Fork 0
mirror of https://github.com/NinjaCheetah/libWiiPy.git synced 2025-04-27 22:01:01 -04:00
Code Issues Packages Projects Releases Wiki Activity

Rewrote most of the content module, code is much cleaner now

Browse Source 
It also has more checks, so that should ensure that more errors get caught and aren't either ignored or allowed to fall through to the interpreter.
Also, part of this cleanup is that the content module now entirely operates on content indexes and not literal indexes, so this makes sure that WADs where the content and literal indexes don't match are handed properly
This commit is contained in:
Campbell 2024-07-25 17:15:26 -04:00
parent 39eecec864
commit f7f67d3414
Signed by: NinjaCheetah
GPG Key ID: 670C282B3291D63D
2 changed files with 221 additions and 106 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

262
src/libWiiPy/title/content.py
View File

@ -107,6 +107,10 @@ class ContentRegion:
""" """
Gets an individual content from the content region based on the provided index, in encrypted form. Gets an individual content from the content region based on the provided index, in encrypted form.
This uses the content index, which is the value tied to each content and used as the IV for encryption, rather
than the literal index in the array of content, because sometimes the contents end up out of order in a WAD
while still retaining the original indices.
Parameters Parameters
---------- ----------
index : int index : int
@ -117,7 +121,17 @@ class ContentRegion:
bytes bytes
The encrypted content listed in the content record. The encrypted content listed in the content record.
""" """
content_enc = self.content_list[index] # Get a list of the current content indices, so we can make sure the target one exists. Doing it this way
# ensures we can find the target, even if the highest content index is greater than the highest literal index.
current_indices = []
for record in self.content_records:
current_indices.append(record.index)
if index not in current_indices:
raise ValueError("You are trying to get the content at index " + str(index) + ", but no content with that "
"index exists!")
# This is the literal index in the list of content that we're going to get.
target_index = current_indices.index(index)
content_enc = self.content_list[target_index]
return content_enc return content_enc
def get_enc_content_by_cid(self, cid: int) -> bytes: def get_enc_content_by_cid(self, cid: int) -> bytes:
@ -134,16 +148,16 @@ class ContentRegion:
bytes bytes
The encrypted content listed in the content record. The encrypted content listed in the content record.
""" """
# Find the index of the requested Content ID. # Get a list of the current Content IDs, so we can make sure the target one exists.
content_index = None content_ids = []
for content in self.content_records: for record in self.content_records:
if content.content_id == cid: content_ids.append(record.content_id)
content_index = content.index if cid not in content_ids:
# If finding a matching ID was unsuccessful, that means that no content with that ID is in the TMD, so raise ValueError("You are trying to get a content with Content ID " + str(cid) + ", but no content with "
# return a Value Error. "that ID exists!")
if content_index is None: # Get the content index associated with the CID we now know exists.
raise ValueError("The Content ID requested does not exist in the TMD's content records.") target_index = content_ids.index(cid)
# Call get_enc_content_by_index() using the index we just found. content_index = self.content_records[target_index].index
content_enc = self.get_enc_content_by_index(content_index) content_enc = self.get_enc_content_by_index(content_index)
return content_enc return content_enc
@ -162,10 +176,14 @@ class ContentRegion:
""" """
Gets an individual content from the content region based on the provided index, in decrypted form. Gets an individual content from the content region based on the provided index, in decrypted form.
This uses the content index, which is the value tied to each content and used as the IV for encryption, rather
than the literal index in the array of content, because sometimes the contents end up out of order in a WAD
while still retaining the original indices.
Parameters Parameters
---------- ----------
index : int index : int
The index of the content you want to get. The content index of the content you want to get.
title_key : bytes title_key : bytes
The Title Key for the title the content is from. The Title Key for the title the content is from.
@ -174,14 +192,19 @@ class ContentRegion:
bytes bytes
The decrypted content listed in the content record. The decrypted content listed in the content record.
""" """
# Load the encrypted content at the specified index and then decrypt it with the Title Key. # Get a list of the current content indices, so we can make sure the target one exists. Doing it this way
# ensures we can find the target, even if the highest content index is greater than the highest literal index.
current_indices = []
for record in self.content_records:
current_indices.append(record.index)
# This is the literal index in the list of content that we're going to get.
target_index = current_indices.index(index)
content_enc = self.get_enc_content_by_index(index) content_enc = self.get_enc_content_by_index(index)
content_dec = decrypt_content(content_enc, title_key, self.content_records[index].index, content_dec = decrypt_content(content_enc, title_key, index, self.content_records[target_index].content_size)
self.content_records[index].content_size)
# Hash the decrypted content and ensure that the hash matches the one in its Content Record. # Hash the decrypted content and ensure that the hash matches the one in its Content Record.
# If it does not, then something has gone wrong in the decryption, and an error will be thrown. # If it does not, then something has gone wrong in the decryption, and an error will be thrown.
content_dec_hash = hashlib.sha1(content_dec).hexdigest() content_dec_hash = hashlib.sha1(content_dec).hexdigest()
content_record_hash = str(self.content_records[index].content_hash.decode()) content_record_hash = str(self.content_records[target_index].content_hash.decode())
# Compare the hash and throw a ValueError if the hash doesn't match. # Compare the hash and throw a ValueError if the hash doesn't match.
if content_dec_hash != content_record_hash: if content_dec_hash != content_record_hash:
raise ValueError("Content hash did not match the expected hash in its record! The incorrect Title Key may " raise ValueError("Content hash did not match the expected hash in its record! The incorrect Title Key may "
@ -206,16 +229,16 @@ class ContentRegion:
bytes bytes
The decrypted content listed in the content record. The decrypted content listed in the content record.
""" """
# Find the index of the requested Content ID. # Get a list of the current Content IDs, so we can make sure the target one exists.
content_index = None content_ids = []
for content in self.content_records: for record in self.content_records:
if content.content_id == cid: content_ids.append(record.content_id)
content_index = content.index if cid not in content_ids:
# If finding a matching ID was unsuccessful, that means that no content with that ID is in the TMD, so raise ValueError("You are trying to get a content with Content ID " + str(cid) + ", but no content with "
# return a Value Error. "that ID exists!")
if content_index is None: # Get the content index associated with the CID we now know exists.
raise ValueError("The Content ID requested does not exist in the TMD's content records.") target_index = content_ids.index(cid)
# Call get_content_by_index() using the index we just found. content_index = self.content_records[target_index].index
content_dec = self.get_content_by_index(content_index, title_key) content_dec = self.get_content_by_index(content_index, title_key)
return content_dec return content_dec
@ -239,16 +262,16 @@ class ContentRegion:
dec_contents.append(self.get_content_by_index(content, title_key)) dec_contents.append(self.get_content_by_index(content, title_key))
return dec_contents return dec_contents
def set_enc_content(self, enc_content: bytes, cid: int, index: int, content_type: int, content_size: int, def add_enc_content(self, enc_content: bytes, cid: int, index: int, content_type: int, content_size: int,
content_hash: bytes) -> None: content_hash: bytes) -> None:
""" """
Sets the provided index to a new content with the provided Content ID. Hashes and size of the content are Adds a new encrypted content to the ContentRegion, and adds the provided Content ID, index, content type,
set in the content record, with a new record being added if necessary. content size, and content hash to a new record in the ContentRecord list.
Parameters Parameters
---------- ----------
enc_content : bytes enc_content : bytes
The new encrypted content to set. The new encrypted content to add.
cid : int cid : int
The Content ID to assign the new content in the content record. The Content ID to assign the new content in the content record.
index : int index : int
@ -260,54 +283,117 @@ class ContentRegion:
content_hash : bytes content_hash : bytes
The hash of the new encrypted content when decrypted. The hash of the new encrypted content when decrypted.
""" """
# Save the number of contents currently in the content region and records. # Check to make sure this isn't reusing an already existing Content ID or index first.
num_contents = len(self.content_records) for record in self.content_records:
# Check if a record already exists for this index. If it doesn't, create it. if record.content_id == cid:
if (index + 1) > num_contents: raise ValueError("Content with a Content ID of " + str(cid) + " already exists!")
# Ensure that you aren't attempting to create a gap before appending. elif record.index == index:
if (index + 1) > num_contents + 1: raise ValueError("Content with an index of " + str(index) + " already exists!")
raise ValueError("You are trying to set the content at position " + str(index) + ", but no content " # If we're good, then append all the data and create a new ContentRecord().
"exists at position " + str(index - 1) + "!")
self.content_records.append(_ContentRecord(cid, index, content_type, content_size, content_hash))
# If it does, reassign the values in it.
else:
self.content_records[index].content_id = cid
self.content_records[index].content_type = content_type
self.content_records[index].content_size = content_size
self.content_records[index].content_hash = content_hash
# Check if a content already occupies the provided index. If it does, reassign it to the new content, if it
# doesn't, then append a new entry.
if (index + 1) > num_contents:
self.content_list.append(enc_content) self.content_list.append(enc_content)
else: self.content_records.append(_ContentRecord(cid, index, content_type, content_size, content_hash))
self.content_list[index] = enc_content
def set_content(self, dec_content: bytes, cid: int, index: int, content_type: int, title_key: bytes) -> None: def add_content(self, dec_content: bytes, cid: int, index: int, content_type: int, title_key: bytes) -> None:
""" """
Sets the provided index to a new content with the provided Content ID. Hashes and size of the content are Adds a new decrypted content to the ContentRegion, and adds the provided Content ID, index, content type,
set in the content record, with a new record being added if necessary. content size, and content hash to a new record in the ContentRecord list.
This first gets the content hash and size from the provided data, and then encrypts the content with the
provided Title Key before adding it to the ContentRegion.
Parameters Parameters
---------- ----------
dec_content : bytes dec_content : bytes
The new decrypted content to set. The new decrypted content to add.
cid : int cid : int
The Content ID to assign the new content in the content record. The Content ID to assign the new content in the content record.
index : int index : int
The index to place the new content at. The index to place the new content at.
content_type : int content_type : int
The type of the new content. The type of the new content.
title_key : bytes
The Title Key that matches the other content in the ContentRegion.
"""
content_size = len(dec_content)
content_hash = str.encode(hashlib.sha1(dec_content).hexdigest())
enc_content = encrypt_content(dec_content, title_key, index)
self.add_enc_content(enc_content, cid, index, content_type, content_size, content_hash)
def set_enc_content(self, enc_content: bytes, index: int, content_size: int, content_hash: bytes, cid: int = None,
content_type: int = None) -> None:
"""
Sets the content at the provided content index to the provided new encrypted content. The provided hash and
content size are set in the corresponding content record. A new Content ID or content type can also be
specified, but if it isn't than the current values are preserved.
This uses the content index, which is the value tied to each content and used as the IV for encryption, rather
than the literal index in the array of content, because sometimes the contents end up out of order in a WAD
while still retaining the original indices.
Parameters
----------
enc_content : bytes
The new encrypted content to set.
index : int
The target content index to set the new content at.
content_size : int
The size of the new encrypted content when decrypted.
content_hash : bytes
The hash of the new encrypted content when decrypted.
cid : int, optional
The Content ID to assign the new content in the content record. Current value will be preserved if not set.
content_type : int, optional
The type of the new content. Current value will be preserved if not set.
"""
# Get a list of the current content indices, so we can make sure the target one exists. Doing it this way
# ensures we can find the target, even if the highest content index is greater than the highest literal index.
current_indices = []
for record in self.content_records:
current_indices.append(record.index)
if index not in current_indices:
raise ValueError("You are trying to set the content at index " + str(index) + ", but no content with that "
"index currently exists!")
# This is the literal index in the list of content/content records that we're going to change.
target_index = current_indices.index(index)
# Reassign the values, but only set the optional ones if they were passed.
self.content_records[target_index].content_size = content_size
self.content_records[target_index].content_hash = content_hash
if cid is not None:
self.content_records[target_index].content_id = cid
if content_type is not None:
self.content_records[target_index].content_type = content_type
self.content_list[target_index] = enc_content
def set_content(self, dec_content: bytes, index: int, title_key: bytes, cid: int = None,
content_type: int = None) -> None:
"""
Sets the content at the provided content index to the provided new decrypted content. The hash and content size
of this content will be generated and then set in the corresponding content record. A new Content ID or content
type can also be specified, but if it isn't than the current values are preserved.
The provided Title Key is used to encrypt the content so that it can be set in the ContentRegion.
Parameters
----------
dec_content : bytes
The new decrypted content to set.
index : int
The index to place the new content at.
title_key : bytes title_key : bytes
The Title Key that matches the new decrypted content. The Title Key that matches the new decrypted content.
cid : int
The Content ID to assign the new content in the content record.
content_type : int
The type of the new content.
""" """
# Store the size of the new content. # Store the size of the new content.
dec_content_size = len(dec_content) content_size = len(dec_content)
# Calculate the hash of the new content. # Calculate the hash of the new content.
dec_content_hash = str.encode(hashlib.sha1(dec_content).hexdigest()) content_hash = str.encode(hashlib.sha1(dec_content).hexdigest())
# Encrypt the content using the provided Title Key and index. # Encrypt the content using the provided Title Key and index.
enc_content = encrypt_content(dec_content, title_key, index) enc_content = encrypt_content(dec_content, title_key, index)
# Pass values to set_enc_content() # Pass values to set_enc_content()
self.set_enc_content(enc_content, cid, index, content_type, dec_content_size, dec_content_hash) self.set_enc_content(enc_content, index, content_size, content_hash, cid, content_type)
def load_enc_content(self, enc_content: bytes, index: int) -> None: def load_enc_content(self, enc_content: bytes, index: int) -> None:
""" """
@ -315,6 +401,10 @@ class ContentRegion:
it matches the record at that index. Not recommended for most use cases, use decrypted content and it matches the record at that index. Not recommended for most use cases, use decrypted content and
load_content() instead. load_content() instead.
This uses the content index, which is the value tied to each content and used as the IV for encryption, rather
than the literal index in the array of content, because sometimes the contents end up out of order in a WAD
while still retaining the original indices.
Parameters Parameters
---------- ----------
enc_content : bytes enc_content : bytes
@ -322,18 +412,30 @@ class ContentRegion:
index : int index : int
The content index to load the content at. The content index to load the content at.
""" """
if (index + 1) > len(self.content_records) or len(self.content_records) == 0: # Get a list of the current content indices, so we can make sure the target one exists. Doing it this way
raise IndexError("No content records have been loaded, or that index is higher than the highest entry in " # ensures we can find the target, even if the highest content index is greater than the highest literal index.
"the content records.") current_indices = []
if (index + 1) > len(self.content_list): for record in self.content_records:
self.content_list.append(enc_content) current_indices.append(record.index)
else: if index not in current_indices:
self.content_list[index] = enc_content raise ValueError("You are trying to load the content at index " + str(index) + ", but no content with that "
"index currently exists! Make sure the correct content records have been loaded.")
# Add blank entries to the list to ensure that its length matches the length of the content record list.
while len(self.content_list) < len(self.content_records):
self.content_list.append(b'')
# This is the literal index in the list of content/content records that we're going to change.
target_index = current_indices.index(index)
self.content_list[target_index] = enc_content
def load_content(self, dec_content: bytes, index: int, title_key: bytes) -> None: def load_content(self, dec_content: bytes, index: int, title_key: bytes) -> None:
""" """
Loads the provided decrypted content into the content region at the specified index, but first checks to make Loads the provided decrypted content into the ContentRegion at the specified index, but first checks to make
sure it matches the record at that index before loading. This content will be encrypted when loaded. sure that it matches the corresponding record. This content will then be encrypted using the provided Title Key
before being loaded.
This uses the content index, which is the value tied to each content and used as the IV for encryption, rather
than the literal index in the array of content, because sometimes the contents end up out of order in a WAD
while still retaining the original indices.
Parameters Parameters
---------- ----------
@ -344,22 +446,28 @@ class ContentRegion:
title_key: bytes title_key: bytes
The Title Key that matches the decrypted content. The Title Key that matches the decrypted content.
""" """
# Make sure that content records exist and that the provided index exists in them. # Get a list of the current content indices, so we can make sure the target one exists. Doing it this way
if (index + 1) > len(self.content_records) or len(self.content_records) == 0: # ensures we can find the target, even if the highest content index is greater than the highest literal index.
raise IndexError("No content records have been loaded, or that index is higher than the highest entry in " current_indices = []
"the content records.") for record in self.content_records:
current_indices.append(record.index)
if index not in current_indices:
raise ValueError("You are trying to load the content at index " + str(index) + ", but no content with that "
"index currently exists! Make sure the correct content records have been loaded.")
# This is the literal index in the list of content/content records that we're going to change.
target_index = current_indices.index(index)
# Check the hash of the content against the hash stored in the record to ensure it matches. # Check the hash of the content against the hash stored in the record to ensure it matches.
content_hash = hashlib.sha1(dec_content).hexdigest() content_hash = hashlib.sha1(dec_content).hexdigest()
if content_hash != self.content_records[index].content_hash.decode(): if content_hash != self.content_records[target_index].content_hash.decode():
raise ValueError("The decrypted content provided does not match the record at the provided index. \n" raise ValueError("The decrypted content provided does not match the record at the provided index. \n"
"Expected hash is: {}\n".format(self.content_records[index].content_hash.decode()) + "Expected hash is: {}\n".format(self.content_records[index].content_hash.decode()) +
"Actual hash is: {}".format(content_hash)) "Actual hash is: {}".format(content_hash))
# Add blank entries to the list to ensure that its length matches the length of the content record list.
while len(self.content_list) < len(self.content_records):
self.content_list.append(b'')
# If the hash matches, encrypt the content and set it where it belongs. # If the hash matches, encrypt the content and set it where it belongs.
# This uses the index from the content records instead of just the index given, because there are some strange # This uses the index from the content records instead of just the index given, because there are some strange
# circumstances where the actual index in the array and the assigned content index don't match up, and this # circumstances where the actual index in the array and the assigned content index don't match up, and this
# needs to accommodate that. Seems to only apply to cIOS WADs? # needs to accommodate that. Seems to only apply to custom WADs ? (Like cIOS WADs?)
enc_content = encrypt_content(dec_content, title_key, self.content_records[index].index) enc_content = encrypt_content(dec_content, title_key, index)
if (index + 1) > len(self.content_list): self.content_list[target_index] = enc_content
self.content_list.append(enc_content)
else:
self.content_list[index] = enc_content

63
src/libWiiPy/title/title.py
View File

@ -159,10 +159,7 @@ class Title:
bytes bytes
The decrypted content listed in the content record. The decrypted content listed in the content record.
""" """
# Load the Title Key from the Ticket. dec_content = self.content.get_content_by_index(index, self.ticket.get_title_key())
title_key = self.ticket.get_title_key()
# Get the decrypted content and return it.
dec_content = self.content.get_content_by_index(index, title_key)
return dec_content return dec_content
def get_content_by_cid(self, cid: int) -> bytes: def get_content_by_cid(self, cid: int) -> bytes:
@ -179,65 +176,75 @@ class Title:
bytes bytes
The decrypted content listed in the content record. The decrypted content listed in the content record.
""" """
# Load the Title Key from the Ticket. dec_content = self.content.get_content_by_cid(cid, self.ticket.get_title_key())
title_key = self.ticket.get_title_key()
# Get the decrypted content and return it.
dec_content = self.content.get_content_by_cid(cid, title_key)
return dec_content return dec_content
def set_enc_content(self, enc_content: bytes, cid: int, index: int, content_type: int, content_size: int, def set_enc_content(self, enc_content: bytes, index: int, content_size: int, content_hash: bytes, cid: int = None,
content_hash: bytes) -> None: content_type: int = None) -> None:
""" """
Sets the provided index to a new content with the provided Content ID. Hashes and size of the content are Sets the content at the provided content index to the provided new encrypted content. The provided hash and
set in the content record, with a new record being added if necessary. The TMD is also updated to match the new content size are set in the corresponding content record. A new Content ID or content type can also be
records. specified, but if it isn't than the current values are preserved.
This uses the content index, which is the value tied to each content and used as the IV for encryption, rather
than the literal index in the array of content, because sometimes the contents end up out of order in a WAD
while still retaining the original indices.
This also updates the content records in the TMD after the content is set.
Parameters Parameters
---------- ----------
enc_content : bytes enc_content : bytes
The new encrypted content to set. The new encrypted content to set.
cid : int
The Content ID to assign the new content in the content record.
index : int index : int
The index to place the new content at. The index to place the new content at.
content_type : int
The type of the new content.
content_size : int content_size : int
The size of the new encrypted content when decrypted. The size of the new encrypted content when decrypted.
content_hash : bytes content_hash : bytes
The hash of the new encrypted content when decrypted. The hash of the new encrypted content when decrypted.
cid : int
The Content ID to assign the new content in the content record.
content_type : int
The type of the new content.
""" """
# Set the encrypted content. # Set the encrypted content.
self.content.set_enc_content(enc_content, cid, index, content_type, content_size, content_hash) self.content.set_enc_content(enc_content, index, content_size, content_hash, cid, content_type)
# Update the TMD to match. # Update the TMD to match.
self.tmd.content_records = self.content.content_records self.tmd.content_records = self.content.content_records
def set_content(self, dec_content: bytes, cid: int, index: int, content_type: int) -> None: def set_content(self, dec_content: bytes, index: int, cid: int = None, content_type: int = None) -> None:
""" """
Sets the provided index to a new content with the provided Content ID. Hashes and size of the content are Sets the content at the provided content index to the provided new decrypted content. The hash and content size
set in the content record, with a new record being added if necessary. The Title Key is sourced from this of this content will be generated and then set in the corresponding content record. A new Content ID or content
title's loaded ticket. The TMD is also updated to match the new records. type can also be specified, but if it isn't than the current values are preserved.
This also updates the content records in the TMD after the content is set.
Parameters Parameters
---------- ----------
dec_content : bytes dec_content : bytes
The new decrypted content to set. The new decrypted content to set.
cid : int
The Content ID to assign the new content in the content record.
index : int index : int
The index to place the new content at. The index to place the new content at.
content_type : int cid : int, optional
The Content ID to assign the new content in the content record.
content_type : int, optional
The type of the new content. The type of the new content.
""" """
# Set the decrypted content. # Set the decrypted content.
self.content.set_content(dec_content, cid, index, content_type, self.ticket.get_title_key()) self.content.set_content(dec_content, index, self.ticket.get_title_key(), cid, content_type)
# Update the TMD to match. # Update the TMD to match.
self.tmd.content_records = self.content.content_records self.tmd.content_records = self.content.content_records
def load_content(self, dec_content: bytes, index: int) -> None: def load_content(self, dec_content: bytes, index: int) -> None:
""" """
Loads the provided decrypted content into the content region at the specified index, but first checks to make Loads the provided decrypted content into the ContentRegion at the specified index, but first checks to make
sure it matches the record at that index before loading. This content will be encrypted when loaded. sure that it matches the corresponding record. This content will then be encrypted using the title's Title Key
before being loaded.
This uses the content index, which is the value tied to each content and used as the IV for encryption, rather
than the literal index in the array of content, because sometimes the contents end up out of order in a WAD
while still retaining the original indices.
Parameters Parameters
---------- ----------