Difference between revisions of "Title metadata"

From WiiBrew
Jump to navigation Jump to search
(fixing errors from earlier edit)
(Rewrote the system version cell)
 
(20 intermediate revisions by 13 users not shown)
Line 1: Line 1:
'''Title metadata''' is a format used to store information about a title (a single standalone game, channel, etc.) and all its installed contents, including which contents they consist of and their SHA1 hashes.
+
'''Title metadata''' is a format used to store information about a [[title]] and all its installed contents, including which contents they consist of and their SHA1 hashes.
 
Many operations are done in terms of 64-byte blocks, which means you will often see padding out to the nearest 64-byte boundary at the end of a field.
 
  
 
== Structure ==
 
== Structure ==
Line 21: Line 19:
 
| 0x104
 
| 0x104
 
| 60
 
| 60
| Padding modulo 64
+
| Padding for 64-byte alignment
 
|-
 
|-
 
| 0x140
 
| 0x140
Line 41: Line 39:
 
| 0x183
 
| 0x183
 
| 1
 
| 1
| Padding modulo 64
+
| Is vWii (1 for vWii titles, 0 for normal titles)
 
|-
 
|-
 
| 0x184
 
| 0x184
 
| 8
 
| 8
| System Version
+
| System Version - if this is set to something other than "title" 0-0, then when launching this title, if [[:/sys/launch.sys]] does not exist, the parameters to ES_LaunchTitle are written to that file, then the title ID in this field is launched. This is typically used to force titles to run under a certain IOS, but it can theoretically be any title, and this can be chained. For [[boot2]], this is set to the Boot2 version (for example, 0-4 for [[boot2v4]])
 
|-
 
|-
 
| 0x18C
 
| 0x18C
Line 60: Line 58:
 
|-
 
|-
 
| 0x19A
 
| 0x19A
| 62
+
| 2
| reserved
+
| Zero
 +
|-
 +
| 0x19C
 +
| 2
 +
| Region (0: Japan, 1: USA, 2: Europe, 3: Region Free, 4: Korea)
 +
|-
 +
| 0x19E
 +
| 16
 +
| Ratings
 +
|-
 +
| 0x1AE
 +
| 12
 +
| Reserved
 +
|-
 +
| 0x1BA
 +
| 12
 +
| IPC Mask
 +
|-
 +
| 0x1C6
 +
| 18
 +
| Reserved
 
|-
 
|-
 
| 0x1D8
 
| 0x1D8
 
| 4
 
| 4
| Access rights
+
| Access rights (flags for [[DVDX|DVD-video access]] and [http://hackmii.com/2009/08/of-tmds-and-hardware/ full PPC hardware access])
 
|-
 
|-
 
| 0x1DC
 
| 0x1DC
Line 77: Line 95:
 
| 0x1E0
 
| 0x1E0
 
| 2
 
| 2
| boot index
+
| boot index (content index for [[apploader]] [[DOL]])
 
|-
 
|-
 
| 0x1E2
 
| 0x1E2
 
| 2
 
| 2
| Padding modulo 64
+
| Unused
 
|-
 
|-
 
| 0x1E4
 
| 0x1E4
Line 105: Line 123:
 
| 0x06
 
| 0x06
 
| 2
 
| 2
| Type
+
| Type (0x0001: Normal, 0x4001: DLC, 0x8001: [[:/shared1|Shared]])
 
|-
 
|-
 
| 0x08
 
| 0x08
Line 132: Line 150:
 
|-
 
|-
 
| 0x104
 
| 0x104
| 32
+
| 64
 
| Issuer
 
| Issuer
 
|-
 
|-
Line 160: Line 178:
 
   u32 cid; // content id
 
   u32 cid; // content id
 
   u16 index; // # number of the file
 
   u16 index; // # number of the file
   u16  type;
+
   u16  type; // normal: 0x0001; dlc: 0x4001; shared: 0x8001
 
   u64 size;
 
   u64 size;
 
   u8  hash [20]; //  SHA1 hash content
 
   u8  hash [20]; //  SHA1 hash content
Line 166: Line 184:
 
</source>
 
</source>
 
<source lang="c">
 
<source lang="c">
enum sig_type {
+
enum sig_type {
      RSA_2048 = 0x00010001,
+
  RSA_2048 = 0x00010001,
      RSA_4096 = 0x00010000
+
  RSA_4096 = 0x00010000
};
+
};
 +
 
 +
// High 32 bits of the title ID
 +
enum title_type : u32 {
 +
  System = 0x00000001,
 +
  Game = 0x00010000,
 +
  Channel = 0x00010001,
 +
  SystemChannel = 0x00010002,
 +
  GameWithChannel = 0x00010004,
 +
  DLC = 0x00010005,
 +
  HiddenChannel = 0x00010008,
 +
};
 +
 
 +
// title_type (offset 0x194)
 +
enum title_flags {
 +
  // All official titles have this flag set.
 +
  Default = 0x1,
 +
  Unknown_0x4 = 0x4,
 +
  // Used for DLC titles.
 +
  Data = 0x8,
 +
  Unknown_0x10 = 0x10,
 +
  // Seems to be used for WFS titles.
 +
  Maybe_WFS = 0x20,
 +
  Unknown_CT = 0x40,
 +
};
 
</source>
 
</source>
 
<source lang="c">
 
<source lang="c">
Line 180: Line 222:
 
         u8 ca_crl_version;
 
         u8 ca_crl_version;
 
         u8 signer_crl_version;
 
         u8 signer_crl_version;
         u8 fill2;
+
         u8 vwii;
 
         u64 sys_version;
 
         u64 sys_version;
 
         u64 title_id;
 
         u64 title_id;
Line 190: Line 232:
 
         u16 num_contents;
 
         u16 num_contents;
 
         u16 boot_index;
 
         u16 boot_index;
         u16 fill3;
+
         u16 fill2;
 
         content_record contents[num_contents];
 
         content_record contents[num_contents];
 
  } tmd;
 
  } tmd;
Line 228: Line 270:
 
};
 
};
 
</source>
 
</source>
 +
 +
[[Category:File formats]]

Latest revision as of 21:20, 8 October 2021

Title metadata is a format used to store information about a title and all its installed contents, including which contents they consist of and their SHA1 hashes.

Structure

Header

Start Length Description
0x000 4 Signature type
0x004 256 Signature
0x104 60 Padding for 64-byte alignment
0x140 64 Issuer
0x180 1 Version
0x181 1 ca_crl_version
0x182 1 signer_crl_version
0x183 1 Is vWii (1 for vWii titles, 0 for normal titles)
0x184 8 System Version - if this is set to something other than "title" 0-0, then when launching this title, if /sys/launch.sys does not exist, the parameters to ES_LaunchTitle are written to that file, then the title ID in this field is launched. This is typically used to force titles to run under a certain IOS, but it can theoretically be any title, and this can be chained. For boot2, this is set to the Boot2 version (for example, 0-4 for boot2v4)
0x18C 8 Title ID
0x194 4 Title type
0x198 2 Group ID
0x19A 2 Zero
0x19C 2 Region (0: Japan, 1: USA, 2: Europe, 3: Region Free, 4: Korea)
0x19E 16 Ratings
0x1AE 12 Reserved
0x1BA 12 IPC Mask
0x1C6 18 Reserved
0x1D8 4 Access rights (flags for DVD-video access and full PPC hardware access)
0x1DC 2 Title version
0x1DE 2 Number of contents (nbr_cont)
0x1E0 2 boot index (content index for apploader DOL)
0x1E2 2 Unused
0x1E4 36*nbr_cont Contents

Content

Start Length Description
0x00 4 Content ID
0x04 2 Index
0x06 2 Type (0x0001: Normal, 0x4001: DLC, 0x8001: Shared)
0x08 8 Size
0x10 20 SHA1 hash

Certificates

Start Length Description
0x000 4 Signature type
0x004 256 Signature
0x104 64 Issuer
0x124 4 Tag
0x128 64 Name
0x168 Key

Example code application

 typedef unsigned char  u8;
 typedef unsigned short u16;
 typedef unsigned int   u32; 
/* On a 32bit system, long is only 4 bytes- use long long instead */
 typedef unsigned long u64;
 typedef struct {
   u32 cid;		// content id
   u16 index;		// # number of the file
   u16  type;		// normal: 0x0001; dlc: 0x4001; shared: 0x8001
   u64 size;
   u8  hash [20]; 		//  SHA1 hash content
 } content_record; 			// size: 0x24 bytes
enum sig_type {
  RSA_2048 = 0x00010001,
  RSA_4096 = 0x00010000
};

// High 32 bits of the title ID
enum title_type : u32 {
  System = 0x00000001,
  Game = 0x00010000,
  Channel = 0x00010001,
  SystemChannel = 0x00010002,
  GameWithChannel = 0x00010004,
  DLC = 0x00010005,
  HiddenChannel = 0x00010008,
};

// title_type (offset 0x194)
enum title_flags {
  // All official titles have this flag set.
  Default = 0x1,
  Unknown_0x4 = 0x4,
  // Used for DLC titles.
  Data = 0x8,
  Unknown_0x10 = 0x10,
  // Seems to be used for WFS titles.
  Maybe_WFS = 0x20,
  Unknown_CT = 0x40,
};
 typedef struct {
        u32 sig_type; 
        u8 sig[256];
        u8 fill1[60];
        u8 issuer[64]; // Root-CA%08x-CP%08x
        u8 version;
        u8 ca_crl_version;
        u8 signer_crl_version;
        u8 vwii;
        u64 sys_version;
        u64 title_id;
        u32 title_type;
        u16 group_id; // publisher
        u8 reserved[62];
        u32 access_rights;
        u16 title_version;
        u16 num_contents;
        u16 boot_index;
        u16 fill2;
        content_record contents[num_contents];
 } tmd;

The tmd is then followed by a chain of certificates, where each certificate is of the general form

  u32 sig_type;  //
  u8 sig[256];   // 256 for RSA_2048, 512 for RSA_4096
  u8 issuer[32];
  u32 tag;  // identifies what is being signed
  u8 name[64]; // name of thing being signed
  u8 key[...];

There is also a structure called a TmdView which is select sections of the Tmd. It has a length of 0x60+0x10*number_of_contents. The structure is somewhat like this [as returned by ES_GetTmdView] :

struct tmd_view_content_t
{
	uint32_t id;
	uint16_t index;
	uint16_t type;
	uint64_t size;
};

struct tmd_view_t
{
	uint8_t version; // 0x0000;
	uint8_t filler[3];
	uint64_t ios_title_id; //0x0004
	uint64_t title_id; // 0x00c
	uint32_t title_type; //0x0014
	uint16_t group_id; //0x0018
	uint8_t reserved[0x3e]; //0x001a this is the same reserved 0x3e bytes from the tmd
	uint16_t title_version; //0x0058
	uint16_t number_contents; //0x005a
	tmd_view_content_t contents[]; //0x005c
};