The iPhone Wiki is no longer updated. Visit this article on The Apple Wiki for current information.

Difference between revisions of "Template:Keys/doc"

From The iPhone Wiki
Jump to: navigation, search
(changed note of rootfskey and added gmrootfskey and gmrootfsdmg for 8a293 (4.0.0))
(add Cryptex1,AppOS and Cryptex1,SystemOS)
 
(92 intermediate revisions by 6 users not shown)
Line 1: Line 1:
  +
<noinclude><div style="font-size:smaller;">&#x2190; Go [[Template:Keys|back to the template]].</div>
−
=== Intro ===
  
−
This is the ultimate key template for the [[VFDecrypt Keys|key pages]]. Its syntax is described below.
 +
</noinclude>This is the key template for the [[Firmware Keys|key pages]]. When a page uses this template, it is added to the [[:Category:Key Pages|Key Pages]] category.
   
−
=== Syntax ===
 +
== Syntax ==
  +
If the device is not an iPhone or a cellular iPad, delete the <code>Baseband</code> parameter.
−
When using this, delete the ones that are not in the fw and put TODO on the ones that need to be done, otherwise they won't show up.
  
  +
−
<br />
  
  +
If the device is an Apple TV (iOS versions), set <code>Version</code> to the marketing version with the internal version in parenthesis.
−
Also, if this is a 1.x Firmware, place anything in the <code>is1xfirmware</code> tag and delete the <code>updateiv</code>, <code>updatekey</code>, <code>restoreiv</code>, <code>restorekey</code> tags, and every tags between <code>AppleLogoIV</code> and <code>WTFKey</code>.
  
  +
  +
For each *, *IV, and *Key section, put the file name on the first line. If the item is the Root FS or a ramdisk, remove the <code>.dmg</code> file extension. If that firmware item does not exist in that firmware, delete its parameter section. If the firmware item is not encrypted, set <code>*IV</code> to "<code>Not Encrypted</code>" and delete the <code>*Key</code> parameter. If the key/iv is not known, then the KBAG should be added.
  +
  +
For devices such as iPhone 6s that have two sets of files such as N71AP and N71mAP, then a second file can be added underneath with a "2" at the end of the name. For example, you can have AppleLogo and AppleLogo2 blocks.
  +
  +
If the page is created for a device/iOS with only an OTA, you don't need to use rootfs and must use UpdateRamdiskOTA instead of UpdateRamdisk (does not append the .dmg)
  +
  +
For <code>DownloadURL</code>, do '''not''' place anything other than URLs to ''free'' firmwares hosted on Apple Inc.'s servers. For beta firmwares, delete the parameter.
 
<nowiki>{{keys</nowiki>
  
<nowiki>{{keys</nowiki>
−
| version =
+
| Version             = 
−
| build =
+
| Build               = 
−
| device =
+
| Device               = 
−
| downloadurl =
+
| Codename             = 
  +
| Baseband             = 
  +
| DownloadURL         = 
 
 
−
| rootfsdmg =
+
| RootFS           = 
−
| rootfskey =
+
| RootFSKey           = Unknown
−
| gmrootfsdmg =
 
−
| gmrootfskey =
 
 
 
−
| noupdateramdisk =
+
| UpdateRamdisk       = 
  +
| UpdateRamdiskIV      = Unknown
−
| ramdisknotencrypted =
 
  +
| UpdateRamdiskKey    = Unknown
  +
| UpdateRamdiskKBAG    =
 
 
−
| updatedmg =
+
| UpdateRamdiskOTA =
−
| updateiv =
+
| UpdateRamdiskOTAIV = Not Encrypted
−
| updatekey =
 
 
 
−
| restoredmg =
+
| RestoreRamdisk       = 
−
| restoreiv =
+
| RestoreRamdiskIV   = Unknown
−
| restorekey =
+
| RestoreRamdiskKey   = Unknown
  +
| RestoreRamdiskKBAG   =
 
 
−
| is1xfirmware =
+
| ACIBTFirmware =
−
| is8a293 =
+
| ACIBTFirmwareIV = Not Encrypted
 
 
−
| AppleLogoIV =
+
| ACIWiFiFirmware =
−
| AppleLogoKey =
+
| ACIWiFiFirmwareIV = Not Encrypted
 
 
−
| BatteryChargingIV =
+
| ADCPetra =
−
| BatteryChargingKey =
+
| ADCPetraIV = Unknown
  +
| ADCPetraKey = Unknown
  +
| ADCPetraKBAG =
 
 
  +
| ARMFW =
−
| BatteryCharging0IV =
 
  +
| ARMFWIV = Not Encrypted
−
| BatteryCharging0Key =
 
 
 
  +
| ANSF =
−
| BatteryCharging1IV =
 
  +
| ANSFIV = Not Encrypted
−
| BatteryCharging1Key =
 
 
 
−
| BatteryFullIV =
+
| ANE =
−
| BatteryFullKey =
+
| ANEIV = Not Encrypted
 
 
−
| BatteryLow0IV =
+
| AOPFirmware =
−
| BatteryLow0Key =
+
| AOPFirmwareIV       = Not Encrypted
 
 
−
| BatteryLow1IV =
+
| AppleAVE =
−
| BatteryLow1Key =
+
| AppleAVEIV = Not Encrypted
 
 
−
| DeviceTreeIV =
+
| AppleLogo         =
−
| DeviceTreeKey =
+
| AppleLogoIV         = Unknown
  +
| AppleLogoKey         = Unknown
  +
| AppleLogoKBAG        =
 
 
−
| GlyphChargingIV =
+
| AppleMaggie        =
−
| GlyphChargingKey =
+
| AppleMaggieIV       = Not Encrypted
 
 
−
| GlyphPluginIV =
+
| AudioCodecFirmware =
−
| GlyphPluginKey =
+
| AudioCodecFirmwareIV = Not Encrypted
 
 
−
| iBECIV =
+
| BatteryCharging0   =
−
| iBECKey =
+
| BatteryCharging0IV   = Unknown
  +
| BatteryCharging0Key = Unknown
  +
| BatteryCharging0KBAG =
 
 
−
| iBootIV =
+
| BatteryCharging1   =
−
| iBootKey =
+
| BatteryCharging1IV   = Unknown
  +
| BatteryCharging1Key = Unknown
  +
| BatteryCharging1KBAG =
 
 
−
| iBSSIV =
+
| BatteryFull       =
−
| iBSSKey =
+
| BatteryFullIV       = Unknown
  +
| BatteryFullKey       = Unknown
  +
| BatteryFullKBAG     =
 
 
−
| KernelcacheIV =
+
| BatteryLow0       =
−
| KernelcacheKey =
+
| BatteryLow0IV       = Unknown
  +
| BatteryLow0Key       = Unknown
  +
| BatteryLow0KBAG       =
 
 
−
| LLBIV =
+
| BatteryLow1       =
−
| LLBKey =
+
| BatteryLow1IV       = Unknown
  +
| BatteryLow1Key       = Unknown
  +
| BatteryLow1KBAG     =
 
 
−
| NeedServiceIV =
+
| Cryptex1,AppOS =
−
| NeedServiceKey =
+
| Cryptex1,AppOSIV = Unknown
  +
| Cryptex1,AppOSKey = Unknown
  +
| Cryptex1,AppOSKBAG =
 
 
−
| RecoveryModeIV =
+
| Cryptex1,SystemOS =
−
| RecoveryModeKey =
+
| Cryptex1,SystemOSIV = Unknown
  +
| Cryptex1,SystemOSKey = Unknown
  +
| Cryptex1,SystemOSKBAG =
 
 
−
| WTFIV =
+
| Dali =
−
| WTFKey =
+
| DaliIV         = Unknown
  +
| DaliKey       = Unknown
−
<nowiki>}}</nowiki>
  
  +
| DaliKBAG      =
−  
  +
−
=== Syntax Explicitation :) ===
  
  +
| DCP =
−
{| class="wikitable"
  
  +
| DCPIV = Not Encrypted
−
|-
  
  +
−
! style="width:10%" | Tag
  
  +
| DeviceTree         =
−
! style="width:90%" | Explanation
  
  +
| DeviceTreeIV         = Unknown
−
|-
  
  +
| DeviceTreeKey       = Unknown
−
! version
  
  +
| DeviceTreeKBAG      =
−
| The version of the build (Ex. page is [[Durango 8K2 (iPhone 3GS)]], you would put <code>4.3.4</code>)
  
  +
−
|-
  
  +
| GlyphCharging     =
−
! build
  
  +
| GlyphChargingIV     = Unknown
−
| Explains itself
  
  +
| GlyphChargingKey     = Unknown
−
|-
  
  +
| GlyphChargingKBAG    =
−
! device
  
  +
−
| [[#Device|See below (v)]]<!-- Opposite of ^ -->
  
  +
| GlyphPlugin       =
−
|-
  
  +
| GlyphPluginIV       = Unknown
−
! downloadurl
  
  +
| GlyphPluginKey       = Unknown
−
| Only PUBLIC Apple firmwares that Apple has made available to everyone for free (copy from [[Firmware]])
  
  +
| GlyphPluginKBAG      =
−
|-
 
  +
−
! rootfsdmg
  
  +
| HapticAssets        =
−
| The name of the Root FS file (W/O .DMG)
  
  +
| HapticAssetsIV       = Not Encrypted
−
|-
  
  +
−
! rootfskey
  
  +
| Homer        =
−
| The key for the Root FS
  
  +
| HomerIV       = Not Encrypted
−
|-
  
  +
−
! gmfootfsdmg
  
  +
| iBEC               =
−
| The name of the GM Root FS file (W/O .DMG)
  
  +
| iBECIV               = Unknown
−
|-
  
  +
| iBECKey             = Unknown
−
! gmrootfskey
  
  +
| iBECKBAG            =
−
| The key for the GM Root FS
  
  +
−
|-
  
  +
| iBoot             =
−
! noupdateramdisk
  
  +
| iBootIV             = Unknown
−
| If this has anything (yes, even no), the "Update Ramdisk" section will not be displayed
  
  +
| iBootKey             = Unknown
−
|-
  
  +
| iBootKBAG           =
−
! ramdisknotencrypted
  
  +
−
| If this has anything (yes, even no), the Ramdisks will display "Not Encrypted"
  
  +
| iBootData =
−
|-
  
  +
| iBootDataIV = Unknown
−
! updatedmg
  
  +
| iBootDataKey = Unknown
−
| The name of the [[Update Ramdisk]] file (W/O .DMG) (can be deleted if <code>noupdateramdisk</code> is filled)
  
  +
| iBootDataKBAG =
−
|-
  
  +
−
! updateiv
  
  +
| iBSS               =
−
| The IV of the [[Update Ramdisk]] (can be deleted if <code>noupdateramdisk</code> is filled)
  
  +
| iBSSIV               = Unknown
−
|-
  
  +
| iBSSKey             = Unknown
−
! updatekey
  
  +
| iBSSKBAG          =
−
| The Key of the [[Update Ramdisk]] (can be deleted if <code>noupdateramdisk</code> is filled)
  
  +
−
|-
  
  +
| ISP =
−
! restoredmg
  
  +
| ISPIV = Not Encrypted
−
| The name of the [[Restore Ramdisk]] file (W/O .DMG)
  
  +
−
|-
  
  +
| Kernelcache       =
−
! restoreiv
  
  +
| KernelcacheIV       = Unknown
−
| The IV of the [[Restore Ramdisk]] (can be deleted if <code>is1xfirmware</code> is filled)
  
  +
| KernelcacheKey       = Unknown
−
|-
  
  +
| KernelcacheKBAG    =
−
! restorekey
  
  +
−
| The Key of the [[Restore Ramdisk]] (can be deleted if <code>is1xfirmware</code> is filled)
  
  +
| LeapHaptics        =
−
|-
  
  +
| LeapHapticsIV       = Not Encrypted
−
! is1xfirmware
  
  +
−
| If this is a 1.x firmware, place anything (even no) here to get a message instead of Key and IV tags.
  
  +
| LiquidDetect     =
−
|-
  
  +
| LiquidDetectIV      = Not Encrypted
−
! is8a293
  
  +
−
| If this is a 4.0 (8A293) firmware, place anything (even no) here to get a line for the GM Root File System Key. If it is not, delete this and the <code>gmrootfs***</code> lines.
  
  +
| LLB               =
−
|-
  
  +
| LLBIV               = Unknown
−
! *IV
  
  +
| LLBKey               = Unknown
−
| The IV for the *
  
  +
| LLBKBAG              =
−
|-
  
  +
−
! *Key
  
  +
| LowPowerMode =
−
| The Key for the *
  
  +
| LowPowerModeIV = Not Encrypted
−
|}
  
  +
−  
  +
| LowPowerFindMyMode =
−
=== Device ===
  
  +
| LowPowerFindMyModeIV = Not Encrypted
−
{| class="wikitable"
  
  +
−
|-
  
  +
| MConnector =
−
! key
  
  +
| MConnectorIV = Not Encrypted
−
! Device
  
  +
−
|-
  
  +
| Multitouch =
−
| appletv21
  
  +
| MultitouchIV = Not Encrypted
−
| [[k66ap|Apple TV 2G]]
  
  +
−
|-
  
  +
| NeedService       =
−
| ipad11
  
  +
| NeedServiceIV       = Unknown
−
| [[k48ap|iPad 1G]]
  
  +
| NeedServiceKey       = Unknown
−
|-
  
  +
| NeedServiceKBAG     =
−
| ipad21
  
  +
−
| [[k93ap|iPad 2]] (Wi-Fi)
  
  +
| PMP        =
−
|-
  
  +
| PMPIV       = Not Encrypted
−
| ipad22
  
  +
−
| [[k94ap|iPad 2]] (GSM)
  
  +
| RANS        =
−
|-
  
  +
| RANSIV       = Not Encrypted
−
| ipad23
  
  +
−
| [[k95ap|iPad 2]] (CDMA)
  
  +
| RTPFirmware =
−
|-
  
  +
| RTPFirmwareIV = Not Encrypted
−
| iphone11
  
  +
−
| [[m68ap|iPhone 2G]]
  
  +
| RecoveryMode       =
−
|-
  
  +
| RecoveryModeIV       = Unknown
−
| iphone12
  
  +
| RecoveryModeKey     = Unknown
−
| [[n82ap|iPhone 3G]]
  
  +
| RecoveryModeKBAG   =
−
|-
  
  +
−
| iphone21
  
  +
| SEPFirmware       =
−
| [[n88ap|iPhone 3GS]]
  
  +
| SEPFirmwareIV       = Unknown
−
|-
  
  +
| SEPFirmwareKey       = Unknown
−
| iphone31
  
  +
| SEPFirmwareKBAG      =
−
| [[n90ap|iPhone 4]] (GSM)
  
  +
−
|-
  
  +
| SmartIOFirmware =
−
| iphone33
  
  +
| SmartIOFirmwareIV = Not Encrypted
−
| [[n92ap|iPhone 4]] (CDMA)
  
  +
−
|-
  
  +
| WirelessPower =
−
| ipod11
  
  +
| WirelessPowerIV = Not Encrypted
−
| [[n45ap|iPod touch 1G]]
  
  +
<nowiki>}}
−
|-
  
  +
</nowiki>
−
| ipod21
  
−
| [[n72ap|iPod touch 2G]]
  
−
|-
  
−
| ipod31
  
−
| [[n18ap|iPod touch 3G]]
  
−
|-
  
−
| ipod41
  
−
| [[n81ap|iPod touch 4G]]
  
−
|}
  

Latest revision as of 02:25, 18 June 2022

← Go back to the template.

This is the key template for the key pages. When a page uses this template, it is added to the Key Pages category.

Syntax

If the device is not an iPhone or a cellular iPad, delete the Baseband parameter.

If the device is an Apple TV (iOS versions), set Version to the marketing version with the internal version in parenthesis.

For each *, *IV, and *Key section, put the file name on the first line. If the item is the Root FS or a ramdisk, remove the .dmg file extension. If that firmware item does not exist in that firmware, delete its parameter section. If the firmware item is not encrypted, set *IV to "Not Encrypted" and delete the *Key parameter. If the key/iv is not known, then the KBAG should be added.

For devices such as iPhone 6s that have two sets of files such as N71AP and N71mAP, then a second file can be added underneath with a "2" at the end of the name. For example, you can have AppleLogo and AppleLogo2 blocks.

If the page is created for a device/iOS with only an OTA, you don't need to use rootfs and must use UpdateRamdiskOTA instead of UpdateRamdisk (does not append the .dmg)

For DownloadURL, do not place anything other than URLs to free firmwares hosted on Apple Inc.'s servers. For beta firmwares, delete the parameter. 

{{keys
 | Version                = 
 | Build                  = 
 | Device                 = 
 | Codename               = 
 | Baseband               = 
 | DownloadURL            = 

 | RootFS                 = 
 | RootFSKey              = Unknown

 | UpdateRamdisk          = 
 | UpdateRamdiskIV        = Unknown
 | UpdateRamdiskKey       = Unknown
 | UpdateRamdiskKBAG      =

 | UpdateRamdiskOTA       = 
 | UpdateRamdiskOTAIV     = Not Encrypted

 | RestoreRamdisk         = 
 | RestoreRamdiskIV       = Unknown
 | RestoreRamdiskKey      = Unknown
 | RestoreRamdiskKBAG     = 

 | ACIBTFirmware          = 
 | ACIBTFirmwareIV        = Not Encrypted

 | ACIWiFiFirmware        = 
 | ACIWiFiFirmwareIV      = Not Encrypted

 | ADCPetra               =
 | ADCPetraIV             = Unknown
 | ADCPetraKey            = Unknown
 | ADCPetraKBAG           =

 | ARMFW                  =
 | ARMFWIV                = Not Encrypted

 | ANSF                   =
 | ANSFIV                 = Not Encrypted

 | ANE                    =
 | ANEIV                  = Not Encrypted

 | AOPFirmware            = 
 | AOPFirmwareIV          = Not Encrypted

 | AppleAVE               =
 | AppleAVEIV             = Not Encrypted

 | AppleLogo              = 
 | AppleLogoIV            = Unknown
 | AppleLogoKey           = Unknown
 | AppleLogoKBAG          = 

 | AppleMaggie            = 
 | AppleMaggieIV          = Not Encrypted

 | AudioCodecFirmware     = 
 | AudioCodecFirmwareIV   = Not Encrypted

 | BatteryCharging0       = 
 | BatteryCharging0IV     = Unknown
 | BatteryCharging0Key    = Unknown
 | BatteryCharging0KBAG   = 

 | BatteryCharging1       = 
 | BatteryCharging1IV     = Unknown
 | BatteryCharging1Key    = Unknown
 | BatteryCharging1KBAG   = 

 | BatteryFull            = 
 | BatteryFullIV          = Unknown
 | BatteryFullKey         = Unknown
 | BatteryFullKBAG        = 

 | BatteryLow0            = 
 | BatteryLow0IV          = Unknown
 | BatteryLow0Key         = Unknown
 | BatteryLow0KBAG        = 

 | BatteryLow1            = 
 | BatteryLow1IV          = Unknown
 | BatteryLow1Key         = Unknown
 | BatteryLow1KBAG        =

 | Cryptex1,AppOS         = 
 | Cryptex1,AppOSIV       = Unknown
 | Cryptex1,AppOSKey      = Unknown
 | Cryptex1,AppOSKBAG     =

 | Cryptex1,SystemOS      = 
 | Cryptex1,SystemOSIV    = Unknown
 | Cryptex1,SystemOSKey   = Unknown
 | Cryptex1,SystemOSKBAG  =

 | Dali                   = 
 | DaliIV                 = Unknown
 | DaliKey                = Unknown
 | DaliKBAG               = 

 | DCP                    =
 | DCPIV                  = Not Encrypted

 | DeviceTree             = 
 | DeviceTreeIV           = Unknown
 | DeviceTreeKey          = Unknown
 | DeviceTreeKBAG         = 

 | GlyphCharging          = 
 | GlyphChargingIV        = Unknown
 | GlyphChargingKey       = Unknown
 | GlyphChargingKBAG      = 

 | GlyphPlugin            = 
 | GlyphPluginIV          = Unknown
 | GlyphPluginKey         = Unknown
 | GlyphPluginKBAG        = 

 | HapticAssets           = 
 | HapticAssetsIV         = Not Encrypted

 | Homer                  = 
 | HomerIV                = Not Encrypted

 | iBEC                   = 
 | iBECIV                 = Unknown
 | iBECKey                = Unknown
 | iBECKBAG               =

 | iBoot                  = 
 | iBootIV                = Unknown
 | iBootKey               = Unknown
 | iBootKBAG              = 

 | iBootData              = 
 | iBootDataIV            = Unknown
 | iBootDataKey           = Unknown
 | iBootDataKBAG          = 

 | iBSS                   = 
 | iBSSIV                 = Unknown
 | iBSSKey                = Unknown
 | iBSSKBAG               = 

 | ISP                    = 
 | ISPIV                  = Not Encrypted

 | Kernelcache            = 
 | KernelcacheIV          = Unknown
 | KernelcacheKey         = Unknown
 | KernelcacheKBAG        = 

 | LeapHaptics            = 
 | LeapHapticsIV          = Not Encrypted

 | LiquidDetect           = 
 | LiquidDetectIV         = Not Encrypted

 | LLB                    = 
 | LLBIV                  = Unknown
 | LLBKey                 = Unknown
 | LLBKBAG                = 

 | LowPowerMode           =
 | LowPowerModeIV         = Not Encrypted

 | LowPowerFindMyMode     =
 | LowPowerFindMyModeIV   = Not Encrypted

 | MConnector             =
 | MConnectorIV           = Not Encrypted

 | Multitouch             =
 | MultitouchIV           = Not Encrypted

 | NeedService            = 
 | NeedServiceIV          = Unknown
 | NeedServiceKey         = Unknown
 | NeedServiceKBAG        =

 | PMP                    = 
 | PMPIV                  = Not Encrypted

 | RANS                   = 
 | RANSIV                 = Not Encrypted

 | RTPFirmware            = 
 | RTPFirmwareIV          = Not Encrypted

 | RecoveryMode           = 
 | RecoveryModeIV         = Unknown
 | RecoveryModeKey        = Unknown
 | RecoveryModeKBAG       = 

 | SEPFirmware            = 
 | SEPFirmwareIV          = Unknown
 | SEPFirmwareKey         = Unknown
 | SEPFirmwareKBAG        =

 | SmartIOFirmware        =
 | SmartIOFirmwareIV      = Not Encrypted

 | WirelessPower          =
 | WirelessPowerIV        = Not Encrypted
}}
Retrieved from "https://www.theiphonewiki.com/w/index.php?title=Template:Keys/doc&oldid=123243"