libWiiPy.title.title Module

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 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 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 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 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#

class libWiiPy.title.title.Title#

Bases: object

A Title object that contains all components of a title, and allows altering them. Provides higher-level access than manually creating WAD, TMD, Ticket, and ContentRegion objects and ensures that any data that needs to match between files matches.

wad#

A WAD object of a WAD containing the title’s data.

Type:: WAD

cert_chain#

The chain of certificates used to verify the contents of a title.

Type:: CertificateChain

tmd#

A TMD object of the title’s TMD.

Type:: TMD

ticket#

A Ticket object of the title’s Ticket.

Type:: Ticket

content#

A ContentRegion object containing the title’s contents.

Type:: ContentRegion

add_content(dec_content: bytes, cid: int, content_type: int) → None#

Adds a new decrypted content to the end of the ContentRegion, and adds the provided Content ID, content type, content size, and content hash to a new record in the ContentRecord list. The index will be automatically assigned by incrementing the current highest index in the records.

This first gets the content hash and size from the provided data, and then encrypts the content with the Title Key before adding it to the ContentRegion.

Parameters:

dec_content (bytes) – The new decrypted content to add.
cid (int) – The Content ID to assign the new content in the content record.
content_type (int) – The type of the new content.

add_enc_content(enc_content: bytes, cid: int, index: int, content_type: int, content_size: int, content_hash: bytes) → None#

Adds a new encrypted content to the ContentRegion, and adds the provided Content ID, index, content type, content size, and content hash to a new record in the ContentRecord list.

Parameters:

enc_content (bytes) – The new encrypted content to add.
cid (int) – The Content ID to assign the new content in the content record.
index (int) – The index used when encrypting the new content.
content_type (int) – The type of the new content.
content_size (int) – The size of the new encrypted content when decrypted.
content_hash (bytes) – The hash of the new encrypted content when decrypted.

dump_wad() → bytes#

Dumps all title components (TMD, Ticket, and contents) back into the WAD object, and then dumps the WAD back into raw data and returns it.

Returns:: wad_data – The raw data of the WAD.
Return type:: bytes

fakesign() → None#

Fakesigns this Title for the trucha bug.

This is done by brute-forcing a TMD and Ticket body hash starting with 00, causing it to pass signature verification on older IOS versions that incorrectly check the hash using strcmp() instead of memcmp(). The TMD and Ticket signatures will also be erased and replaced with all NULL bytes.

This modifies the TMD and Ticket objects that are part of this Title in place. You will need to call this method after any changes to the TMD or Ticket, and before dumping the Title object into a WAD to ensure that the WAD is properly fakesigned.

get_content_by_cid(cid: int, skip_hash=False) → bytes#

Gets an individual content from the content region based on the provided Content ID, in decrypted form.

Parameters:

cid (int) – The Content ID of the content you want to get. Expected to be in decimal form.
skip_hash (bool, optional) – Skip the hash check and return the content regardless of its hash. Defaults to false.

Returns:

The decrypted content listed in the content record.

Return type:

bytes

get_content_by_index(index: id, skip_hash=False) → bytes#

Gets an individual content from the content region based on the provided index, in decrypted form.

Parameters:

index (int) – The index of the content you want to get.
skip_hash (bool, optional) – Skip the hash check and return the content regardless of its hash. Defaults to false.

Returns:

The decrypted content listed in the content record.

Return type:

bytes

get_is_fakesigned()#

Checks the Title object to see if it is currently fakesigned. This ensures that both the TMD and Ticket are fakesigned. For a description of fakesigning, refer to the fakesign() method.

Returns:: True if the Title is fakesigned, False otherwise.
Return type:: bool