Difference between revisions of "Template:Keys/doc"

From The iPhone Wiki
Jump to: navigation, search
m (working on rewriting)
(Remove DisplayVersion)
 
(29 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
<noinclude><div style="font-size:smaller;">&#x2190; Go [[Template:Keys|back to the template]].</div>
 
<noinclude><div style="font-size:smaller;">&#x2190; Go [[Template:Keys|back to the template]].</div>
</noinclude>This is the ultimate 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. 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.
 
   
  +
If the device is an Apple TV (iOS versions), set <code>Version</code> to the marketing version with the internal version in parenthesis.
If this is a 1.x Firmware, delete the <code>UpdateRamdiskIV</code>, <code>UpdateRamdiskKey</code>, <code>RestoreRamdiskIV</code>, <code>RestoreRamdiskKey</code> tags, and every tags between <code>AppleLogoIV</code> and <code>RecoveryModeKey</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.
If this is not 8A293 (4.0), delete the <code>GMRootFSKey</code> row.
 
   
  +
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 this is not an iPhone or a 3G iPad, delete the <code>baseband</code>-like rows.
 
  +
  +
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             = 
| DisplayVersion =
+
| Build               = 
| Build               = 
+
| Device              
| Device              = 
+
| Codename            = 
| Codename            = 
+
| Baseband            = 
| Baseband            
+
| DownloadURL         = 
| DownloadURL         = 
 
 
 
| RootFS           = 
+
| RootFS           = 
| RootFSKey           = TODO
+
| RootFSKey           = Unknown
| GMRootFSKey         = TODO
 
 
 
| NoUpdateRamdisk     = 
+
| UpdateRamdisk      
  +
| UpdateRamdiskIV      = Unknown
| RamdiskNotEncrypted = 
 
  +
| UpdateRamdiskKey    = Unknown
  +
| UpdateRamdiskKBAG    =
 
 
| UpdateRamdisk       = 
+
| RestoreRamdisk       = 
| UpdateRamdiskIV     = TODO
+
| RestoreRamdiskIV   = Unknown
| UpdateRamdiskKey    = TODO
+
| RestoreRamdiskKey  = Unknown
  +
| RestoreRamdiskKBAG  =
 
 
| RestoreRamdisk      = 
+
| ADCPetra =
| RestoreRamdiskIV   = TODO
+
| ADCPetraIV = Unknown
| RestoreRamdiskKey  = TODO
+
| ADCPetraKey = Unknown
  +
| ADCPetraKBAG =
 
 
| AppleLogo         = TODO
+
| ARMFW =
| AppleLogoIV         = TODO
+
| ARMFWIV = Unknown
| AppleLogoKey        = TODO
+
| ARMFWKey = Unknown
  +
| ARMFWKBAG =
 
 
  +
| ANE =
| BatteryCharging0  = TODO
 
  +
| ANEIV = Unknown
| BatteryCharging0IV  = TODO
 
| BatteryCharging0Key = TODO
+
| ANEKey = Unknown
  +
| ANEKBAG =
 
 
| BatteryCharging1  = TODO
+
| AppleAVE =
  +
| AppleAVEIV = Unknown
| BatteryCharging1IV  = TODO
 
| BatteryCharging1Key = TODO
+
| AppleAVEKey = Unknown
  +
| AppleAVEKBAG =
 
 
| BatteryFull       = TODO
+
| AOPFirmware =
| BatteryFullIV       = TODO
+
| AOPFirmwareIV       = Unknown
| BatteryFullKey      = TODO
+
| AOPFirmwareKey     = Unknown
  +
| AOPFirmwareKBAG      =
 
 
| BatteryLow0       = TODO
+
| AppleLogo         =
| BatteryLow0IV       = TODO
+
| AppleLogoIV         = Unknown
| BatteryLow0Key      = TODO
+
| AppleLogoKey        = Unknown
  +
| AppleLogoKBAG       =
 
 
| BatteryLow1       = TODO
+
| AppleMaggie        =
| BatteryLow1IV       = TODO
+
| AppleMaggieIV       = Unknown
| BatteryLow1Key      = TODO
+
| AppleMaggieKey      = Unknown
  +
| AppleMaggieKBAG     =
 
 
| DeviceTree        = TODO
+
| BatteryCharging0   =
| DeviceTreeIV        = TODO
+
| BatteryCharging0IV   = Unknown
  +
| BatteryCharging0Key = Unknown
| DeviceTreeKey       = TODO
 
  +
| BatteryCharging0KBAG =
 
 
| GlyphCharging     = TODO
+
| BatteryCharging1   =
| GlyphChargingIV     = TODO
+
| BatteryCharging1IV   = Unknown
| GlyphChargingKey    = TODO
+
| BatteryCharging1Key = Unknown
  +
| BatteryCharging1KBAG =
 
 
| GlyphPlugin       = TODO
+
| BatteryFull       =
| GlyphPluginIV       = TODO
+
| BatteryFullIV       = Unknown
| GlyphPluginKey      = TODO
+
| BatteryFullKey      = Unknown
  +
| BatteryFullKBAG     =
 
 
| iBEC              = TODO
+
| BatteryLow0       =
| iBECIV              = TODO
+
| BatteryLow0IV       = Unknown
| iBECKey             = TODO
+
| BatteryLow0Key      = Unknown
  +
| BatteryLow0KBAG      =
 
 
| iBoot             = TODO
+
| BatteryLow1       =
| iBootIV             = TODO
+
| BatteryLow1IV       = Unknown
| iBootKey            = TODO
+
| BatteryLow1Key      = Unknown
  +
| BatteryLow1KBAG    =
 
 
| iBSS              = TODO
+
| CallanFirmware =
| iBSSIV              = TODO
+
| CallanFirmwareIV = Unknown
| iBSSKey             = TODO
+
| CallanFirmwareKey = Unknown
  +
| CallanFirmwareKBAG =
 
 
| Kernelcache       = TODO
+
| Dali =
| KernelcacheIV       = TODO
+
| DaliIV        = Unknown
| KernelcacheKey      = TODO
+
| DaliKey       = Unknown
  +
| DaliKBAG      =
 
 
| LLB               = TODO
+
| DeviceTree         =
| LLBIV               = TODO
+
| DeviceTreeIV        = Unknown
| LLBKey              = TODO
+
| DeviceTreeKey       = Unknown
  +
| DeviceTreeKBAG      =
 
 
| NeedService       = TODO
+
| GlyphCharging     =
| NeedServiceIV       = TODO
+
| GlyphChargingIV     = Unknown
| NeedServiceKey      = TODO
+
| GlyphChargingKey    = Unknown
  +
| GlyphChargingKBAG   =
 
 
| RecoveryMode      = TODO
+
| GlyphPlugin       =
| RecoveryModeIV      = TODO
+
| GlyphPluginIV       = Unknown
| RecoveryModeKey     = TODO
+
| GlyphPluginKey      = Unknown
  +
| GlyphPluginKBAG     =
 
 
| SEPFirmware      = TODO
+
| Homer        =
| SEPFirmwareIV      = TODO
+
| HomerIV       = Unknown
| SEPFirmwareKey      = TODO
+
| HomerKey      = Unknown
  +
| HomerKBAG     =
  +
  +
| iBEC              =
  +
| iBECIV              = Unknown
  +
| iBECKey             = Unknown
  +
| iBECKBAG            =
  +
  +
| iBoot             =
  +
| iBootIV             = Unknown
  +
| iBootKey            = Unknown
  +
| iBootKBAG          =
  +
  +
| iBSS              =
  +
| iBSSIV              = Unknown
  +
| iBSSKey             = Unknown
  +
| iBSSKBAG          =
  +
  +
| Kernelcache       =
  +
| KernelcacheIV       = Unknown
  +
| KernelcacheKey      = Unknown
  +
| KernelcacheKBAG    =
  +
  +
| LiquidDetect     =
  +
| LiquidDetectIV      = Unknown
  +
| LiquidDetectKey     = Unknown
  +
| LiquidDetectKBAG  =
  +
  +
| LLB               =
  +
| LLBIV               = Unknown
  +
| LLBKey              = Unknown
  +
| LLBKBAG             =
  +
  +
| LowPowerMode =
  +
| LowPowerModeIV = Unknown
  +
| LowPowerModeKey = Unknown
  +
| LowPowerModeKBAG =
  +
  +
| Multitouch =
  +
| MultitouchIV = Unknown
  +
| MultitouchKey = Unknown
  +
| MultitouchKBAG =
  +
  +
| NeedService       =
  +
| NeedServiceIV       = Unknown
  +
| NeedServiceKey      = Unknown
  +
| NeedServiceKBAG     =
  +
  +
| RecoveryMode       =
  +
| RecoveryModeIV      = Unknown
  +
| RecoveryModeKey     = Unknown
  +
| RecoveryModeKBAG   =
  +
  +
| SEPFirmware      =
  +
| SEPFirmwareIV      = Unknown
  +
| SEPFirmwareKey      = Unknown
  +
| SEPFirmwareKBAG     =
  +
  +
| SmartIOFirmware =
  +
| SmartIOFirmwareIV = Unknown
  +
| SmartIOFirmwareKey = Unknown
  +
| SmartIOFirmwareKBAG =
  +
  +
| WirelessPower =
  +
| WirelessPowerIV = Unknown
  +
| WirelessPowerKey = Unknown
  +
| WirelessPowerKBAG =
 
<nowiki>}}</nowiki>
 
<nowiki>}}</nowiki>
 
== Syntax Explanation ==
 
{| class="wikitable"
 
|-
 
! style="width:10%" | Tag
 
! style="width:90%" | Explanation
 
|-
 
! Version
 
| The version of the build (ex: for [[Durango 8K2 (iPhone 3GS)]], you would put <code>4.3.4</code>).
 
|-
 
! DisplayVersion
 
| Alternate version to display. For use with Apple TV firmwares. Should be in the format of "{MarketingVersion} ({InternalVersion})".
 
|-
 
! Build
 
| The build number.
 
|-
 
! Device
 
| [[#Device|See below]].
 
|-
 
! Baseband
 
| The baseband (ex: page is [[Jasper 8C148 (iPad)]], you would put <code>07.10.00</code>). Leave blank if unknown. Remove if not a device with a baseband chip.
 
|-
 
! DownloadURL
 
| Only firmwares available on Apple Inc. owned domains. Public firmware links are available on [[Firmware]]. [[Beta Firmware|beta firmware]] links '''''must''''' be available from the [[Apple Developer|Apple Developer Center]]
 
|-
 
! RootFS
 
| The name of the Root FS file (without the <code>.dmg</code>)
 
|-
 
! RootFSKey
 
| The key for the Root FS
 
|-
 
! GMRootFSKey
 
| The key for the GM Root FS (used only on iOS 4.0 8A293)
 
|-
 
! NoUpdateRamdisk
 
| If this is <code>true</code>, the "Update Ramdisk" section will not be displayed. Remove if there is an update ramdisk.
 
|-
 
! RamdiskNotEncrypted
 
| If this is <code>true</code>, the [[ramdisk]]s will show "Not Encrypted" instead of "IV" and "Key" lines. Remove if the ramdisks are encrypted.
 
|-
 
! UpdateRamdisk
 
| The name of the [[Update Ramdisk]] file (without <code>.dmg</code>) (can be deleted if <code>noupdateramdisk</code> is filled or it is a 1.x firmware)
 
|-
 
! UpdateRamdiskIV
 
| The IV of the [[Update Ramdisk]] (can be deleted if <code>NoUpdateRamdisk</code> is filled or it is a 1.x firmware)
 
|-
 
! UpdateRamdiskKey
 
| The Key of the [[Update Ramdisk]] (can be deleted if <code>NoUpdateRamdisk</code> is filled or it is a 1.x firmware)
 
|-
 
! RestoreRamdisk
 
| The name of the [[Restore Ramdisk]] file (without <code>.dmg</code>)
 
|-
 
! RestoreRamdiskIV
 
| The IV of the [[Restore Ramdisk]] (can be deleted if is a 1.x firmware)
 
|-
 
! RestoreRamdiskKey
 
| The Key of the [[Restore Ramdisk]] (can be deleted if is a 1.x firmware)
 
|-
 
! *
 
| The file name for the * (can be deleted if it is a 1.x firmware)
 
|-
 
! *IV
 
| The IV for the * (can be deleted if is a 1.x firmware)
 
|-
 
! *Key
 
| The Key for the * (can be deleted if is a 1.x firmware)
 
|}
 
 
== Device ==
 
<!-- Needs to be redone -->
 
{| class="wikitable"
 
|-
 
! Value
 
! Device
 
|-
 
| appletv21
 
| [[k66ap|Apple TV 2G]]
 
|-
 
| appletv31
 
| [[j33ap|Apple TV 3G]]
 
|-
 
| appletv32
 
| [[j33ap|Apple TV 3G Rev A]]
 
|-
 
| ipad11
 
| [[k48ap|iPad 1G]]
 
|-
 
| ipad21
 
| [[k93ap|iPad 2]] (Wi-Fi)
 
|-
 
| ipad22
 
| [[k94ap|iPad 2]] (GSM)
 
|-
 
| ipad23
 
| [[k95ap|iPad 2]] (CDMA)
 
|-
 
| ipad24
 
| [[k93aap|iPad 2]] (Wi-Fi) [Rev A]
 
|-
 
| ipad25
 
| [[p105ap|iPad mini 1G]] (Wi-Fi)
 
|-
 
| ipad26
 
| [[p106ap|iPad mini 1G]] (GSM)
 
|-
 
| ipad27
 
| [[p107ap|iPad mini 1G]] (Global)
 
|-
 
| ipad31
 
| [[j1ap|iPad 3]] (Wi-Fi)
 
|-
 
| ipad32
 
| [[j2ap|iPad 3]] (CDMA)
 
|-
 
| ipad33
 
| [[j2aap|iPad 3]] (Global)
 
|-
 
| ipad34
 
| [[p101ap|iPad 4]] (Wi-Fi)
 
|-
 
| ipad35
 
| [[p102ap|iPad 4]] (GSM)
 
|-
 
| ipad36
 
| [[p103ap|iPad 4]] (Global)
 
|-
 
| iphone11
 
| [[m68ap|iPhone 2G]]
 
|-
 
| iphone12
 
| [[n82ap|iPhone 3G]]
 
|-
 
| iphone21
 
| [[n88ap|iPhone 3GS]]
 
|-
 
| iphone31
 
| [[n90ap|iPhone 4]] (GSM)
 
|-
 
| iphone32
 
| [[n90bap|iPhone 4]] (GSM) [Rev A]
 
|-
 
| iphone33
 
| [[n92ap|iPhone 4]] (CDMA)
 
|-
 
| iphone41
 
| [[n94ap|iPhone 4S]]
 
|-
 
| iphone51
 
| [[n41ap|iPhone 5]] (GSM)
 
|-
 
| iphone52
 
| [[n42ap|iPhone 5]] (Global)
 
|-
 
| iphone53
 
| [[n49ap|iPhone 5c]] (GSM)
 
|-
 
| iphone54
 
| [[n48ap|iPhone 5c]] (Global)
 
|-
 
| iphone61
 
| [[n51ap|iPhone 5s]] (GSM)
 
|-
 
| iphone62
 
| [[n53ap|iPhone 5s]] (Global)
 
|-
 
| ipod11
 
| [[n45ap|iPod touch 1G]]
 
|-
 
| ipod21
 
| [[n72ap|iPod touch 2G]]
 
|-
 
| ipod31
 
| [[n18ap|iPod touch 3G]]
 
|-
 
| ipod41
 
| [[n81ap|iPod touch 4G]]
 
|-
 
| ipod51
 
| [[iPod touch 5G]]
 
|}
 

Latest revision as of 00:07, 14 June 2019

← 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.

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    =

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

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

 | ARMFW                =
 | ARMFWIV              = Unknown
 | ARMFWKey             = Unknown
 | ARMFWKBAG            =

 | ANE                  =
 | ANEIV                = Unknown
 | ANEKey               = Unknown
 | ANEKBAG              =

 | AppleAVE             =
 | AppleAVEIV           = Unknown
 | AppleAVEKey          = Unknown
 | AppleAVEKBAG         =

 | AOPFirmware          = 
 | AOPFirmwareIV        = Unknown
 | AOPFirmwareKey       = Unknown
 | AOPFirmwareKBAG      =

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

 | AppleMaggie          = 
 | AppleMaggieIV        = Unknown
 | AppleMaggieKey       = Unknown
 | AppleMaggieKBAG      = 

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

 | CallanFirmware       =
 | CallanFirmwareIV     = Unknown
 | CallanFirmwareKey    = Unknown
 | CallanFirmwareKBAG   =

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

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

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

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

 | Homer                = 
 | HomerIV              = Unknown
 | HomerKey             = Unknown
 | HomerKBAG            = 

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

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

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

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

 | LiquidDetect         = 
 | LiquidDetectIV       = Unknown
 | LiquidDetectKey      = Unknown
 | LiquidDetectKBAG     =

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

 | LowPowerMode         =
 | LowPowerModeIV       = Unknown
 | LowPowerModeKey      = Unknown
 | LowPowerModeKBAG     =

 | Multitouch           =
 | MultitouchIV         = Unknown
 | MultitouchKey        = Unknown
 | MultitouchKBAG       =

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

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

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

 | SmartIOFirmware      =
 | SmartIOFirmwareIV    = Unknown
 | SmartIOFirmwareKey   = Unknown
 | SmartIOFirmwareKBAG  = 

 | WirelessPower        =
 | WirelessPowerIV      = Unknown
 | WirelessPowerKey     = Unknown
 | WirelessPowerKBAG    =
}}