Difference between revisions of "CIA"

From 3dbrew
Jump to navigation Jump to search
m (Add clarification for what TMD is)
 
(58 intermediate revisions by 13 users not shown)
Line 1: Line 1:
=== Overview ===
+
[[Category:File formats]]
CIA stands for '''C'''TR '''I'''mportable '''A'''rchive. These files contain a compiled application which can be installed on CTR NAND, TWL NAND (part of the NAND used by DSi applications) and on the SD card.  
+
== Overview ==
 +
CIA stands for '''C'''TR '''I'''mportable '''A'''rchive. This format allows the installation of titles to the 3DS. CIA files and titles on [[Title list|Nintendo's CDN]] contain identical data. As a consequence, valid CIA files can be generated from CDN content. This also means CIA files can contain anything that titles on Nintendo's CDN can contain.  
  
An example .CIA can be downloaded here [http://www.multiupload.com/5CJ2QQPOWE] Credit: [[User:Jl12|Jl12]]. It includes a .cia file, the .cia file in its extracted form, a screenshot of the application working and some information given by the 3DS.
+
Under normal circumstances CIA files are used where downloading a title is impractical or not possible. Such as distributing a [[Download Play]] child, or installing forced Gamecard updates. Those CIA(s) are stored by the titles in question, in an auxiliary [[NCCH#CFA|CFA]] file.
 +
 
 +
Development Units, are capable of manually installing CIA files via the [[3DS Development Unit Software#Dev Menu|Dev Menu]].
 +
 
 +
== Format ==
 +
 
 +
This is the current version of the CIA format, it was finalised in late 2010. (Older versions of the CIA format can be viewed on the [[Talk:CIA|Talk]] page)
  
=== Format ===
 
 
The CIA format has a similar structure to the [http://wiibrew.org/wiki/Wad WAD format].
 
The CIA format has a similar structure to the [http://wiibrew.org/wiki/Wad WAD format].
  
Line 11: Line 17:
 
The data is aligned in 64 byte blocks (if a content ends at the middle of the block, the next content will begin from a new block).
 
The data is aligned in 64 byte blocks (if a content ends at the middle of the block, the next content will begin from a new block).
  
== CIA Header ==
+
=== CIA Header ===
 
 
This is a 32 bytes long header (8 x uint32).
 
  
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
Line 23: Line 27:
 
|  0x00
 
|  0x00
 
|  0x04  
 
|  0x04  
|  Archive Header Size (=0x2020 bytes) (Starts with 0x80 @ offset 0x0020)
+
|  Archive Header Size (Usually = 0x2020 bytes)
 
|-
 
|-
 
|  0x04
 
|  0x04
Line 39: Line 43:
 
|  0x0C       
 
|  0x0C       
 
|  0x04
 
|  0x04
|  Ticket size
+
[[Ticket]] size
 
|-
 
|-
 
|  0x10     
 
|  0x10     
 
|  0x04
 
|  0x04
|  [[TMD]] file size
+
|  [[TMD]] (Title Metadata) file size
 
|-
 
|-
 
|  0x14     
 
|  0x14     
 
|  0x04
 
|  0x04
Banner size (0 if no banner)
+
Meta size (0 if no Meta data is present)
 
|-
 
|-
 
|  0x18     
 
|  0x18     
0x04
+
0x08
APP file size
+
Content size
 
|-
 
|-
0x1C
+
0x20
0x04
+
0x2000
0x80000000
+
Content Index
 
|}
 
|}
  
The order of the sections in the header also is the order of them in the CIA file:
+
The order of the sections in the CIA file:
 
* certificate chain
 
* certificate chain
 
* Ticket
 
* Ticket
 
* TMD file data
 
* TMD file data
* APP file data
+
* Content file data
* banner
+
* Meta file data (Not a necessary component)
The APP data can be either encrypted or cleartext, retail [[Download Play]] CIAs' APP data is always encrypted.
+
 
 +
The contents (NCCH/SRL) are encrypted using 128-bit AES-CBC. The encryption uses the decrypted titlekey from the [[Ticket#Structure|ticket]], and the content index from the TMD padded with zeros as the IV.
  
== Banner ==
+
=== Certificate Chain ===
The banner starts with a 0xF0 large data block, whose purpose is currently unknown.
+
 
 +
There are three [[Certificates|certificates]] in this chain:
  
Then at offset 0x400 into the banner section is the actual banner (or ICN file), which contains information about the creator, the first title and the second title (you can see them in the system settings):
 
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
START
+
CERTIFICATE
SIZE
+
SIGNATURE TYPE
 +
!  RETAIL CERT NAME
 +
!  DEBUG CERT NAME
 
!  DESCRIPTION
 
!  DESCRIPTION
 
|-
 
|-
0x00
+
CA
0x04
+
RSA-4096
Magic: 'SMDH'
+
CA00000003
|-  
+
| CA00000004
0x04
+
|  Used to verify the Ticket/TMD Certificates
0x04
+
|-
Reserved = 0
+
|  Ticket
 +
|  RSA-2048
 +
|  XS0000000c
 +
|  XS00000009
 +
|  Used to verify the Ticket signature
 +
|-
 +
|  TMD
 +
|  RSA-2048
 +
CP0000000b
 +
CP0000000a
 +
Used to verify the TMD signature
 
|}
 
|}
This header is immediately followed by meta-data:
 
  
=== Application Titles ===
+
The CA certificate is issued by 'Root', the public key for which is stored in NATIVE_FIRM.
 +
 
 +
=== Meta ===
 +
 
 +
The structure of this data is as follows:
  
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
Line 95: Line 115:
 
|-
 
|-
 
|  0x00
 
|  0x00
|  0x80
 
|  Short Description
 
|-
 
|  0x80
 
|  0x100
 
|  Long Description
 
|-
 
 
|  0x180
 
|  0x180
0x80
+
Title ID dependency list - Taken from the application's [[NCCH/Extended Header|ExHeader]]
Publisher
+
|-
 +
|  0x180
 +
|  0x180
 +
|  Reserved
 +
|-
 +
0x300
 +
|  0x4
 +
|  Core Version
 +
|-
 +
|  0x304
 +
|  0xFC
 +
|  Reserved
 +
|-
 +
|  0x400
 +
|  0x36C0
 +
|  [[SMDH|Icon Data]](.ICN) - Taken from the application's [[ExeFS]]
 
|}
 
|}
  
All encoded in UTF-16.
+
Obviously this section is not present in TWL CIA files, or any other CIA file which does not contain a [[NCCH#CXI|CXI]].
This order will repeat 11 times (each block for different language supported).
 
  
The languages by order of appearance:
+
== Tools ==
  
* 1st: Japanese title name
+
* [https://github.com/3dshax/ctr/tree/master/ctrtool ctrtool] - Reading/Extraction of CIA files. This can only decrypt the title-key for development CIAs, since retail CIAs use the [[AES]] hardware key-scrambler for the common-key keyslot.
* 2nd: English title name
 
* 3rd: French title name
 
* 4th: German title name
 
* 5th: Italian title name
 
* 6th: Spanish title name
 
* 7th: Chinese title name
 
* 8th: Korean title name
 
* 9th: Dutch title name
 
* 10th: Portuguese title name
 
* 11th: Russian title name
 
  
=== Icons ===
+
* [https://github.com/Tiger21820/ctr_toolkit/tree/master/make_cia make_cia] - Generating CIA files. Requires CommonKey and ticket/TMD RSA-2048 private exponents.
  
At offset 0x2400 into the banner (inside the Banner's meta-data) to the end, there are two icons:
+
* [https://github.com/Tiger21820/ctr_toolkit/tree/master/make_cdn_cia make_cdn_cia] - (CMD)(Windows/Linux) Generates CIA files from CDN Content
* Small- 24x24 (shown on top screen when pausing the app)  
 
* Large - 48x48 icon (the genral icon).
 
  
Both of the icons are encoded in RGB565 meaning 16bpp.
+
* [[makerom]] - Tool which can be used to create NCCH, CCI, and CIA files.
  
Don't be fooled though. The icons in offset 0x2400 in the banner (inside the Banner's meta-data) are not the actual icons the 3DS uses according to various tests!
+
== Title Key Encryption ==
  
Although both icons are known to be RGB565, developers have the option of encoding icons (and banners) with the following encodings :
+
The unencrypted Title Key is used to encrypt the data in a CIA. The encrypted Title Key of a CIA can be found at offset 0x1BF in a CIA's Ticket.
 +
Each Title Key is encrypted with AES-CBC to get the encrypted Title Key.
  
* RGBA8
+
To encrypt an unencrypted title key, you need:
* RGB8
 
* RGBA5551
 
* RGB565
 
* RGBA4
 
* LA8
 
* HILO8
 
* L8
 
* A8
 
* LA4
 
* L4
 
* A8
 
* ETC1
 
* ETC1A4
 
  
This does not necessarily mean the other encodings will be used, it is just that those are the options when compiling. Like we've seen with Super Mario 3D Land Nintendo has changed save file encryption, and likewise they can encode icons and banners differently ''should they choose to''. Currently we've seen just RGB565 so don't be fooled if an icon doesn't show up right! It is probably one of these formats above. Although we will probably not see other formats used for a while it's nice to know they have an opportunity to change.
+
* Common key (as byte array)
 +
* Title ID (as ulong)
 +
* (and of course the unencrypted title key you want to encrypt) (as byte array)
  
There's a header of 0x40 bytes and then comes the raw data.
+
The title key encryption process starts by converting the ulong (Title ID) into a byte array using by retrieving the bytes of the Title ID using BitConverter.GetBytes().
 +
If the converted bytes (title ID) are in Little Endian, reverse those bytes. (in C# it would be Array.Reverse(byte_array_from_bitconverter))
 +
This process makes the Title Key encryption IV.
  
The data is encoded in tiles (starting from size 8x8, continuing recursively).
+
Next, after you've gotten your Title Key's IV, you can start your cryptography transformation. Using AESManaged, where:
  
If the buffer is like this:
+
Key  = Common Key
  
{| class="wikitable" border="1"
+
IV  = the byte array found in the conversion process above
|-
+
 
!  0
+
Mode = CipherMode.CBC
!  1
+
 
!  2
+
Create the encryptor (AesManaged.CreateEncryptor(key, iv)) where the key and IV are both the same as above.
!  3
+
 
!  4
+
Then, create a CryptoStream and a MemoryStream. The Crypto stream should start with the arguments (memorystream, aes_transform_from_above, CryptoStreamMode.Write).
!  5
+
 
!  6
+
Write to the CryptoStream where buffer=unencrypted_titlekey, offset=0, and count=the length of the unencrypted title key.
!  7
+
 
!  8
+
Use FlushFinalBlock() on the CryptoStream.
!  9
+
 
!  10
+
Finally, then, the encrypted title key will be available from your memory
!  11
+
stream. (to output the calculated encrypted title key as a byte array, you can use memorystream.ToArray(), for example)
!  12
 
!  13
 
!  14
 
!  15
 
!  16
 
|-
 
|}
 
  
Then the image would look like this:
+
Example function: (C#)
  
{| class="wikitable" border="1"
+
<pre>
|-
+
        public static byte[] EncryptMyTitleKey(byte[] commonKey, byte[] titleKey, ulong titleId)
!  x=0
+
        {
!  x=1
+
            // Make encryption IV
!  x=2
+
            byte[] titleidasbytes = new byte[0x10];
!  x=3
+
            for (int i = 0; i < 0x10; i++)
!  x=4
+
            {
|-
+
                titleidasbytes[i] = 0;
| 0
+
            }
| 1
+
            byte[] bitBytes = BitConverter.GetBytes(titleId);
| 4
+
            if (BitConverter.IsLittleEndian)
| 5
+
            {
| 16
+
                Array.Reverse(bitBytes);
|-
+
            }
| 2
+
            bitBytes.CopyTo(titleidasbytes, 0);
| 3
+
            // Encrypt
| 6
+
            ICryptoTransform transform = new AesManaged { Key = commonKey, IV = titleidasbytes, Mode = CipherMode.CBC }.CreateEncryptor(commonKey, titleidasbytes);
| 7
+
            MemoryStream memstream = new MemoryStream();
| ...
+
            CryptoStream cryptostream = new CryptoStream(memstream, transform, CryptoStreamMode.Write);
|-
+
            cryptostream.Write(titleKey, 0, titleKey.Length);
| 8
+
            cryptostream.FlushFinalBlock();
| 9
+
            return memstream.ToArray();
| 12
+
        }
| 13
+
</pre>
|-
 
| 10
 
| 11
 
| 14
 
| 15
 
|-
 
|}
 

Latest revision as of 16:23, 31 December 2023

Overview[edit]

CIA stands for CTR Importable Archive. This format allows the installation of titles to the 3DS. CIA files and titles on Nintendo's CDN contain identical data. As a consequence, valid CIA files can be generated from CDN content. This also means CIA files can contain anything that titles on Nintendo's CDN can contain.

Under normal circumstances CIA files are used where downloading a title is impractical or not possible. Such as distributing a Download Play child, or installing forced Gamecard updates. Those CIA(s) are stored by the titles in question, in an auxiliary CFA file.

Development Units, are capable of manually installing CIA files via the Dev Menu.

Format[edit]

This is the current version of the CIA format, it was finalised in late 2010. (Older versions of the CIA format can be viewed on the Talk page)

The CIA format has a similar structure to the WAD format.

The file is represented in little-endian.

The data is aligned in 64 byte blocks (if a content ends at the middle of the block, the next content will begin from a new block).

CIA Header[edit]

START SIZE DESCRIPTION
0x00 0x04 Archive Header Size (Usually = 0x2020 bytes)
0x04 0x02 Type
0x06 0x02 Version
0x08 0x04 Certificate chain size
0x0C 0x04 Ticket size
0x10 0x04 TMD (Title Metadata) file size
0x14 0x04 Meta size (0 if no Meta data is present)
0x18 0x08 Content size
0x20 0x2000 Content Index

The order of the sections in the CIA file:

  • certificate chain
  • Ticket
  • TMD file data
  • Content file data
  • Meta file data (Not a necessary component)

The contents (NCCH/SRL) are encrypted using 128-bit AES-CBC. The encryption uses the decrypted titlekey from the ticket, and the content index from the TMD padded with zeros as the IV.

Certificate Chain[edit]

There are three certificates in this chain:

CERTIFICATE SIGNATURE TYPE RETAIL CERT NAME DEBUG CERT NAME DESCRIPTION
CA RSA-4096 CA00000003 CA00000004 Used to verify the Ticket/TMD Certificates
Ticket RSA-2048 XS0000000c XS00000009 Used to verify the Ticket signature
TMD RSA-2048 CP0000000b CP0000000a Used to verify the TMD signature

The CA certificate is issued by 'Root', the public key for which is stored in NATIVE_FIRM.

Meta[edit]

The structure of this data is as follows:

START SIZE DESCRIPTION
0x00 0x180 Title ID dependency list - Taken from the application's ExHeader
0x180 0x180 Reserved
0x300 0x4 Core Version
0x304 0xFC Reserved
0x400 0x36C0 Icon Data(.ICN) - Taken from the application's ExeFS

Obviously this section is not present in TWL CIA files, or any other CIA file which does not contain a CXI.

Tools[edit]

  • ctrtool - Reading/Extraction of CIA files. This can only decrypt the title-key for development CIAs, since retail CIAs use the AES hardware key-scrambler for the common-key keyslot.
  • make_cia - Generating CIA files. Requires CommonKey and ticket/TMD RSA-2048 private exponents.
  • make_cdn_cia - (CMD)(Windows/Linux) Generates CIA files from CDN Content
  • makerom - Tool which can be used to create NCCH, CCI, and CIA files.

Title Key Encryption[edit]

The unencrypted Title Key is used to encrypt the data in a CIA. The encrypted Title Key of a CIA can be found at offset 0x1BF in a CIA's Ticket. Each Title Key is encrypted with AES-CBC to get the encrypted Title Key.

To encrypt an unencrypted title key, you need:

  • Common key (as byte array)
  • Title ID (as ulong)
  • (and of course the unencrypted title key you want to encrypt) (as byte array)

The title key encryption process starts by converting the ulong (Title ID) into a byte array using by retrieving the bytes of the Title ID using BitConverter.GetBytes(). If the converted bytes (title ID) are in Little Endian, reverse those bytes. (in C# it would be Array.Reverse(byte_array_from_bitconverter)) This process makes the Title Key encryption IV.

Next, after you've gotten your Title Key's IV, you can start your cryptography transformation. Using AESManaged, where:

Key = Common Key

IV = the byte array found in the conversion process above

Mode = CipherMode.CBC

Create the encryptor (AesManaged.CreateEncryptor(key, iv)) where the key and IV are both the same as above.

Then, create a CryptoStream and a MemoryStream. The Crypto stream should start with the arguments (memorystream, aes_transform_from_above, CryptoStreamMode.Write).

Write to the CryptoStream where buffer=unencrypted_titlekey, offset=0, and count=the length of the unencrypted title key.

Use FlushFinalBlock() on the CryptoStream.

Finally, then, the encrypted title key will be available from your memory stream. (to output the calculated encrypted title key as a byte array, you can use memorystream.ToArray(), for example)

Example function: (C#)

        public static byte[] EncryptMyTitleKey(byte[] commonKey, byte[] titleKey, ulong titleId)
        {
            // Make encryption IV
            byte[] titleidasbytes = new byte[0x10];
            for (int i = 0; i < 0x10; i++)
            {
                titleidasbytes[i] = 0;
            }
            byte[] bitBytes = BitConverter.GetBytes(titleId);
            if (BitConverter.IsLittleEndian)
            {
                Array.Reverse(bitBytes);
            }
            bitBytes.CopyTo(titleidasbytes, 0);
            // Encrypt
            ICryptoTransform transform = new AesManaged { Key = commonKey, IV = titleidasbytes, Mode = CipherMode.CBC }.CreateEncryptor(commonKey, titleidasbytes);
            MemoryStream memstream = new MemoryStream();
            CryptoStream cryptostream = new CryptoStream(memstream, transform, CryptoStreamMode.Write);
            cryptostream.Write(titleKey, 0, titleKey.Length);
            cryptostream.FlushFinalBlock();
            return memstream.ToArray();
        }