Difference between revisions of "IMG3 File Format"

From The iPhone Wiki
Jump to: navigation, search
m (Reworded for a little more future-proofing.)
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
This is the replacement for the [[S5L File Formats#IMG2|IMG2 file format]] for iOS 2.0 and onward. iOS 7 introduced the [[IM4P File Format]] and the [[IMG4 File Format]] for [[A7]] devices.
+
The '''IMG3''' file format was introduced with [[iOS|iPhone OS]] 2.0b4 to replace the broken [[S5L File Formats|IMG2 format]]. This format is used on all devices with an [[S5L8920]] or older; [[S5L8960|A7]] and newer devices use [[IM4P File Format|IM4P]] and [[IMG4 File Format|IMG4]] files.
   
==Header==
+
==Encryption==
  +
Apple got smarter this time, requiring the Hardware AES engine to be run per file. Decrypt the [[KBAG]] tag data with the [[GID Key]] to get the key and IV, and use those to decrypt the [[DATA]] section of the firmware file.
typedef struct Img3_t {
 
  +
uint32_t magic; // ASCII_LITTLE_ENDIAN("Img3")
 
  +
In the current method, iBoot will always use the first 16 bytes of the [[KBAG]] as the IV, then the remaining 16 (aes-128, used with [[S5L8900]] and [[S5L8720]]), 24 (aes-192), or 32 (aes-256, used with [[S5L8920]]) bytes for the key.
  +
  +
== Contents ==
  +
All numbers are stored in [[wikipedia:Endianness#Little-endian|little endian]] byte order; this includes the magic ''numbers'' (<code>magic</code> and <code>ident</code>).
  +
typedef struct img3File {
  +
uint32_t magic; // ASCII_LE("Img3")
 
uint32_t fullSize; // full size of fw image
 
uint32_t fullSize; // full size of fw image
 
uint32_t sizeNoPack; // size of fw image without header
 
uint32_t sizeNoPack; // size of fw image without header
Line 9: Line 15:
 
// size of the start of the data section (the code) up to
 
// size of the start of the data section (the code) up to
 
// the start of the RSA signature (SHSH section)
 
// the start of the RSA signature (SHSH section)
uint32_t iden; // identifier of image, used when bootrom is parsing images
+
uint32_t ident; // identifier of image, used when bootrom is parsing images
 
// list to find LLB (illb), LLB parsing it to find iBoot (ibot),
 
// list to find LLB (illb), LLB parsing it to find iBoot (ibot),
// etc.
+
// etc.
Img3Tag_t tags[]; // continues until end of file
+
img3Tag tags[]; // continues until end of file
 
};
 
};
   
  +
typedef struct img3Tag {
==Tag Format==
 
  +
uint32_t magic; // [[#Tags|see below]]
typedef struct Img3Tag_t {
 
uint32_t magic; // [[#Tags|see below]]
+
uint32_t totalLength; // length of tag including "magic" and these two length values
uint32_t total_length; // length of tag including "magic"
+
uint32_t dataLength; // length of tag data
  +
uint8_t data[dataLength];
// and these two length values
 
  +
uint8_t pad[totalLength - dataLength - 12]; // Typically padded to 4 byte multiple
uint32_t data_length; // length of tag data
 
uint8_t data[data_length];
 
uint8_t pad[total_length - data_length - 12]; // padding
 
 
};
 
};
   
==Tags==
+
== Tags ==
  +
Due to being written in little-endian byte order, these tags are actually backwards when written to the file (e.g. <code>VERS</code> is stored as <code>S&nbsp;R&nbsp;E&nbsp;V</code>).
[[VERS]]: iBoot version of the image
 
  +
[[VERS]]: [[iBoot]] version of the image
 
[[SEPO]]: Security Epoch
 
[[SEPO]]: Security Epoch
 
[[SDOM]]: Security Domain
 
[[SDOM]]: Security Domain
 
[[PROD]]: Production Mode
 
[[PROD]]: Production Mode
[[CHIP]]: Chip to be used with. example: "0x8900" for [[S5L8900]].
+
[[CHIP]]: Chip to be used with. example: <code>0x8900</code> for [[S5L8900]].
 
[[BORD]]: Board to be used with
 
[[BORD]]: Board to be used with
[[KBAG]]: contains the KEY and IV required to decrypt encrypted with the [[GID Key]]
+
[[KBAG]]: Contains the IV and key required to decrypt; encrypted with the [[GID Key]]
 
[[SHSH]]: RSA encrypted SHA1 hash of the file
 
[[SHSH]]: RSA encrypted SHA1 hash of the file
 
[[CERT]]: Certificate
 
[[CERT]]: Certificate
[[ECID]]: Exclusive Chip ID unique to every device with iPhone OS.
+
[[ECID]]: Exclusive Chip ID unique to every device
[[TYPE]]: Type of image, should contain the same string as 'iden' of the header
+
[[TYPE]]: Type of image, should contain the same string as the header's <code>ident</code>
 
[[DATA]]: Real content of the file
 
[[DATA]]: Real content of the file
  +
[[Nonce|NONC]]: [[Nonce]] used when file was signed.
  +
[[CEPO]]: Chip epoch
  +
[[OVRD]]:
  +
[[RAND]]:
  +
[[SALT]]:
   
 
==Signature Check==
 
==Signature Check==
 
Decryption is done using the modulus at cert + 0xA15
 
Decryption is done using the modulus at cert + 0xA15
 
0xC to [[SHSH]] is SHAed
 
0xC to [[SHSH]] is SHAed
 
==Encryption==
 
Apple got smarter this time, requiring the Hardware AES engine to be run per file. Decrypt the [[KBAG]] tag data with the [[GID Key]] to get the key and IV, and use those to decrypt the [[DATA]] section of the firmware file.
 
 
In the current method, iBoot will always use the first 16 bytes of the [[KBAG]] as the IV, then the remaining 16 (aes-128, used with [[S5L8900]] and [[S5L8720]]), 24 (aes-192), or 32 (aes-256, used with [[S5L8920]]) bytes for the key.
 
   
 
[[Category:File Formats]]
 
[[Category:File Formats]]

Latest revision as of 18:35, 2 March 2023

The IMG3 file format was introduced with iPhone OS 2.0b4 to replace the broken IMG2 format. This format is used on all devices with an S5L8920 or older; A7 and newer devices use IM4P and IMG4 files.

Encryption

Apple got smarter this time, requiring the Hardware AES engine to be run per file. Decrypt the KBAG tag data with the GID Key to get the key and IV, and use those to decrypt the DATA section of the firmware file.

In the current method, iBoot will always use the first 16 bytes of the KBAG as the IV, then the remaining 16 (aes-128, used with S5L8900 and S5L8720), 24 (aes-192), or 32 (aes-256, used with S5L8920) bytes for the key.

Contents

All numbers are stored in little endian byte order; this includes the magic numbers (magic and ident).

typedef struct img3File {
    uint32_t magic;       // ASCII_LE("Img3")
    uint32_t fullSize;    // full size of fw image
    uint32_t sizeNoPack;  // size of fw image without header
    uint32_t sigCheckArea;// although that is just my name for it, this is the
                          // size of the start of the data section (the code) up to
                          // the start of the RSA signature (SHSH section)
    uint32_t ident;       // identifier of image, used when bootrom is parsing images
                          // list to find LLB (illb), LLB parsing it to find iBoot (ibot),
                          // etc. 
    img3Tag  tags[];      // continues until end of file
};
typedef struct img3Tag {
    uint32_t magic;            // see below
    uint32_t totalLength;      // length of tag including "magic" and these two length values
    uint32_t dataLength;       // length of tag data
    uint8_t  data[dataLength];
    uint8_t  pad[totalLength - dataLength - 12]; // Typically padded to 4 byte multiple
};

Tags

Due to being written in little-endian byte order, these tags are actually backwards when written to the file (e.g. VERS is stored as S R E V).

VERS: iBoot version of the image
SEPO: Security Epoch
SDOM: Security Domain
PROD: Production Mode
CHIP: Chip to be used with. example: 0x8900 for S5L8900.
BORD: Board to be used with
KBAG: Contains the IV and key required to decrypt; encrypted with the GID Key
SHSH: RSA encrypted SHA1 hash of the file
CERT: Certificate
ECID: Exclusive Chip ID unique to every device
TYPE: Type of image, should contain the same string as the header's ident
DATA: Real content of the file
NONC: Nonce used when file was signed.
CEPO: Chip epoch
OVRD: 
RAND: 
SALT:

Signature Check

Decryption is done using the modulus at cert + 0xA15
0xC to SHSH is SHAed