Difference between revisions of "Template:Keys/doc"

From The iPhone Wiki
Jump to: navigation, search
(removed "NoUpdateRamdisk" and "RamdiskNotEncrypted", then pulled some info out of the poorly done syntax table and put it above the template)
(add Cryptex1,AppOS and Cryptex1,SystemOS)
 
(32 intermediate revisions by 4 users not shown)
Line 3: Line 3:
   
 
== Syntax ==
 
== Syntax ==
  +
If the device is not an iPhone or a cellular iPad, delete the <code>Baseband</code> parameter.
<!-- Undocumented voodoo:
 
-- If this is a 1.x firmware, delete the <code>UpdateRamdiskIV</code>, <code>UpdateRamdiskKey</code>, <code>RestoreRamdiskIV</code> and everything after.
 
--
 
-- If the build is not 8A293 (4.0), delete the <code>GMRootFSKey</code> parameter.
 
-->
 
   
If the device is not an iPhone or a 3G iPad, delete the <code>Baseband</code> parameter.
+
If the device is an Apple TV (iOS versions), set <code>Version</code> to the marketing version with the internal version in parenthesis.
   
If the device is an Apple TV, set <code>Version</code> to the marketing version (what the Apple TV reports) and set <code>DisplayVersion</code> to the marketing version with the internal version in parenthesis. For example, [[Brighton 10B144b (AppleTV2,1)|5.2/6.1 (10B144b)]] for the Apple TV 2G sets <code>Version</code> to <code>5.2</code> and <code>DisplayVersion</code> to <code>5.2 (6.1)</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 device is not an Apple TV, delete the <code>DisplayVersion</code> parameter.
 
   
  +
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 each *, *IV, and *Key section, put the file name on the first line. If the item is the Root FS or a ramdisk, don't put the ".dmg". If that item does not exist in that firmware, delete the section.
 
   
For <code>DownloadURL</code>, do '''not''' place anything other than URLs to free firmwares hosted on Apple Inc.'s servers. For beta firmwares, use the URL "displayed" on [[Apple Developer|Apple Developer Center]] as you will still need to log in to download.
+
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 -->
 
 
 
| UpdateRamdisk       = 
+
| UpdateRamdisk      
| UpdateRamdiskIV     = TODO
+
| UpdateRamdiskIV      = Unknown
| UpdateRamdiskKey    = TODO
+
| UpdateRamdiskKey    = Unknown
  +
| UpdateRamdiskKBAG    =
 
 
| RestoreRamdisk      = 
+
| UpdateRamdiskOTA =
| RestoreRamdiskIV   = TODO
+
| UpdateRamdiskOTAIV = Not Encrypted
| RestoreRamdiskKey  = TODO
 
 
 
| AppleLogo         = TODO
+
| RestoreRamdisk       = 
| AppleLogoIV         = TODO
+
| RestoreRamdiskIV   = Unknown
| AppleLogoKey        = TODO
+
| RestoreRamdiskKey   = Unknown
  +
| RestoreRamdiskKBAG   =
 
 
| BatteryCharging0  = TODO
+
| ACIBTFirmware =
  +
| ACIBTFirmwareIV = Not Encrypted
| BatteryCharging0IV  = TODO
 
| BatteryCharging0Key = TODO
 
 
 
| BatteryCharging1  = TODO
+
| ACIWiFiFirmware =
  +
| ACIWiFiFirmwareIV = Not Encrypted
| BatteryCharging1IV  = TODO
 
| BatteryCharging1Key = TODO
 
 
 
| BatteryFull       = TODO
+
| ADCPetra =
| BatteryFullIV       = TODO
+
| ADCPetraIV = Unknown
| BatteryFullKey      = TODO
+
| ADCPetraKey = Unknown
  +
| ADCPetraKBAG =
 
 
| BatteryLow0       = TODO
+
| ARMFW =
| BatteryLow0IV       = TODO
+
| ARMFWIV = Not Encrypted
| BatteryLow0Key      = TODO
 
 
 
| BatteryLow1       = TODO
+
| ANSF =
| BatteryLow1IV       = TODO
+
| ANSFIV = Not Encrypted
| BatteryLow1Key      = TODO
 
 
 
| DeviceTree        = TODO
+
| ANE =
  +
| ANEIV = Not Encrypted
| DeviceTreeIV        = TODO
 
| DeviceTreeKey       = TODO
 
 
 
| GlyphCharging     = TODO
+
| AOPFirmware =
| GlyphChargingIV     = TODO
+
| AOPFirmwareIV       = Not Encrypted
| GlyphChargingKey    = TODO
 
 
 
| GlyphPlugin       = TODO
+
| AppleAVE =
| GlyphPluginIV       = TODO
+
| AppleAVEIV = Not Encrypted
| GlyphPluginKey      = TODO
 
 
 
| iBEC              = TODO
+
| AppleLogo         =
| iBECIV              = TODO
+
| AppleLogoIV         = Unknown
| iBECKey             = TODO
+
| AppleLogoKey         = Unknown
  +
| AppleLogoKBAG        =
 
 
| iBoot             = TODO
+
| AppleMaggie        =
| iBootIV             = TODO
+
| AppleMaggieIV       = Not Encrypted
| iBootKey            = TODO
 
 
 
| iBSS              = TODO
+
| AudioCodecFirmware =
  +
| AudioCodecFirmwareIV = Not Encrypted
| iBSSIV              = TODO
 
| iBSSKey             = TODO
 
 
 
| Kernelcache       = TODO
+
| BatteryCharging0   =
| KernelcacheIV       = TODO
+
| BatteryCharging0IV   = Unknown
| KernelcacheKey      = TODO
+
| BatteryCharging0Key = Unknown
  +
| BatteryCharging0KBAG =
 
 
| LLB               = TODO
+
| BatteryCharging1   =
| LLBIV               = TODO
+
| BatteryCharging1IV   = Unknown
  +
| BatteryCharging1Key = Unknown
| LLBKey              = TODO
 
  +
| BatteryCharging1KBAG =
 
 
| NeedService       = TODO
+
| BatteryFull       =
| NeedServiceIV       = TODO
+
| BatteryFullIV       = Unknown
| NeedServiceKey      = TODO
+
| BatteryFullKey       = Unknown
  +
| BatteryFullKBAG     =
 
 
| RecoveryMode      = TODO
+
| BatteryLow0       =
| RecoveryModeIV      = TODO
+
| BatteryLow0IV       = Unknown
| RecoveryModeKey     = TODO
+
| BatteryLow0Key       = Unknown
  +
| BatteryLow0KBAG       =
 
 
| SEPFirmware      = TODO
+
| BatteryLow1       =
| SEPFirmwareIV      = TODO
+
| BatteryLow1IV       = Unknown
| SEPFirmwareKey      = TODO
+
| BatteryLow1Key       = Unknown
  +
| BatteryLow1KBAG     =
<nowiki>}}</nowiki>
 
  +
 
  +
| Cryptex1,AppOS =
== <nowiki>{{{Device}}}</nowiki> Parameter Key ==
 
  +
| Cryptex1,AppOSIV = Unknown
{| class="wikitable"
 
  +
| Cryptex1,AppOSKey = Unknown
|-
 
  +
| Cryptex1,AppOSKBAG =
! colspan="2" | Device
 
  +
! Value
 
  +
| Cryptex1,SystemOS =
|-
 
  +
| Cryptex1,SystemOSIV = Unknown
| colspan="2" | [[k66ap|Apple TV 2G]]
 
  +
| Cryptex1,SystemOSKey = Unknown
| appletv21
 
  +
| Cryptex1,SystemOSKBAG =
|-
 
  +
| rowspan="2" | [[Apple TV 3G]]
 
  +
| Dali =
| [[j33ap|AppleTV3,1]]
 
  +
| DaliIV         = Unknown
| appletv31
 
  +
| DaliKey       = Unknown
|-
 
  +
| DaliKBAG      =
| [[j33iap|AppleTV3,2]]
 
  +
| appletv32
 
  +
| DCP =
|-
 
  +
| DCPIV = Not Encrypted
! colspan="3" |
 
  +
|-
 
  +
| DeviceTree         =
| colspan="2" | [[k48ap|iPad]]
 
  +
| DeviceTreeIV         = Unknown
| ipad11
 
  +
| DeviceTreeKey       = Unknown
|-
 
  +
| DeviceTreeKBAG      =
| rowspan="4" | [[iPad 2]]
 
  +
| [[k93ap|iPad2,1]]
 
  +
| GlyphCharging     =
| ipad21
 
  +
| GlyphChargingIV     = Unknown
|-
 
  +
| GlyphChargingKey     = Unknown
| [[k94ap|iPad2,2]]
 
  +
| GlyphChargingKBAG    =
| ipad22
 
  +
|-
 
  +
| GlyphPlugin       =
| [[k95ap|iPad2,3]]
 
  +
| GlyphPluginIV       = Unknown
| ipad23
 
  +
| GlyphPluginKey       = Unknown
|-
 
  +
| GlyphPluginKBAG      =
| [[k93aap|iPad2,4]]
 
  +
| ipad24
 
  +
| HapticAssets        =
|-
 
  +
| HapticAssetsIV       = Not Encrypted
| rowspan="3" | [[iPad 3]]
 
  +
| [[j1ap|iPad3,1]]
 
  +
| Homer        =
| ipad31
 
  +
| HomerIV       = Not Encrypted
|-
 
  +
| [[j2ap|iPad3,2]]
 
  +
| iBEC               =
| ipad32
 
  +
| iBECIV               = Unknown
|-
 
  +
| iBECKey             = Unknown
| [[j2aap|iPad3,3]]
 
  +
| iBECKBAG            =
| ipad33
 
  +
|-
 
  +
| iBoot             =
| rowspan="3" | [[iPad 4]]
 
  +
| iBootIV             = Unknown
| [[p101ap|iPad3,4]]
 
  +
| iBootKey             = Unknown
| ipad34
 
  +
| iBootKBAG           =
|-
 
  +
| [[p102ap|iPad3,5]]
 
  +
| iBootData =
| ipad35
 
  +
| iBootDataIV = Unknown
|-
 
  +
| iBootDataKey = Unknown
| [[p103ap|iPad3,6]]
 
  +
| iBootDataKBAG =
| ipad36
 
  +
|-
 
  +
| iBSS               =
| rowspan="3" | [[iPad Air]]
 
  +
| iBSSIV               = Unknown
| [[j71ap|iPad4,1]]
 
  +
| iBSSKey             = Unknown
| ipad41
 
  +
| iBSSKBAG          =
|-
 
  +
| [[j72ap|iPad4,2]]
 
  +
| ISP =
| ipad42
 
  +
| ISPIV = Not Encrypted
|-
 
  +
| [[j73ap|iPad4,3]]
 
  +
| Kernelcache       =
| ipad43
 
  +
| KernelcacheIV       = Unknown
|-
 
  +
| KernelcacheKey       = Unknown
| rowspan="2" | [[iPad Air 2]]
 
  +
| KernelcacheKBAG    =
| [[j81ap|iPad5,3]]
 
  +
| ipad53
 
  +
| LeapHaptics        =
|-
 
  +
| LeapHapticsIV       = Not Encrypted
| [[j82ap|iPad5,4]]
 
  +
| ipad54
 
  +
| LiquidDetect     =
|-
 
  +
| LiquidDetectIV      = Not Encrypted
! colspan="3" |
 
  +
|-
 
  +
| LLB               =
| rowspan="3" | [[iPad mini 1G]]
 
  +
| LLBIV               = Unknown
| [[p105ap|iPad2,5]]
 
  +
| LLBKey               = Unknown
| ipad25
 
  +
| LLBKBAG              =
|-
 
  +
| [[p106ap|iPad2,6]]
 
  +
| LowPowerMode =
| ipad26
 
  +
| LowPowerModeIV = Not Encrypted
|-
 
  +
| [[p107ap|iPad2,7]]
 
  +
| LowPowerFindMyMode =
| ipad27
 
  +
| LowPowerFindMyModeIV = Not Encrypted
|-
 
  +
| rowspan="3" | [[iPad mini 2]]
 
  +
| MConnector =
| [[j85ap|iPad4,4]]
 
  +
| MConnectorIV = Not Encrypted
| ipad44
 
  +
|-
 
  +
| Multitouch =
| [[j86ap|iPad4,5]]
 
  +
| MultitouchIV = Not Encrypted
| ipad45
 
  +
|-
 
  +
| NeedService       =
| [[j87ap|iPad4,6]]
 
  +
| NeedServiceIV       = Unknown
| ipad46
 
  +
| NeedServiceKey       = Unknown
|-
 
  +
| NeedServiceKBAG     =
| rowspan="3" | [[iPad mini 3]]
 
  +
| [[j85map|iPad4,7]]
 
  +
| PMP        =
| ipad47
 
  +
| PMPIV       = Not Encrypted
|-
 
  +
| [[j86map|iPad4,8]]
 
  +
| RANS        =
| ipad48
 
  +
| RANSIV       = Not Encrypted
|-
 
  +
| [[j87map|iPad4,9]]
 
  +
| RTPFirmware =
| ipad49
 
  +
| RTPFirmwareIV = Not Encrypted
|-
 
  +
! colspan="3" |
 
  +
| RecoveryMode       =
|-
 
  +
| RecoveryModeIV       = Unknown
| colspan="2" | [[m68ap|iPhone]]
 
  +
| RecoveryModeKey     = Unknown
| iphone11
 
  +
| RecoveryModeKBAG   =
|-
 
  +
| colspan="2" | [[n82ap|iPhone 3G]]
 
  +
| SEPFirmware       =
| iphone12
 
  +
| SEPFirmwareIV       = Unknown
|-
 
  +
| SEPFirmwareKey       = Unknown
| colspan="2" | [[n88ap|iPhone 3GS]]
 
  +
| SEPFirmwareKBAG      =
| iphone21
 
  +
|-
 
  +
| SmartIOFirmware =
| rowspan="3" | [[iPhone 4]]
 
  +
| SmartIOFirmwareIV = Not Encrypted
| [[n90ap|iPhone3,1]]
 
  +
| iphone31
 
  +
| WirelessPower =
|-
 
  +
| WirelessPowerIV = Not Encrypted
| [[n90bap|iPhone3,2]]
 
  +
<nowiki>}}
| iphone32
 
  +
</nowiki>
|-
 
| [[n92ap|iPhone3,3]]
 
| iphone33
 
|-
 
| colspan="2" | [[n94ap|iPhone 4S]]
 
| iphone41
 
|-
 
| rowspan="2" | [[iPhone 5]]
 
| [[n41ap|iPhone5,1]]
 
| iphone51
 
|-
 
| [[n42ap|iPhone5,2]]
 
| iphone52
 
|-
 
| rowspan="2" | [[iPhone 5c]]
 
| [[n49ap|iPhone5,3]]
 
| iphone53
 
|-
 
| [[n48ap|iPhone5,4]]
 
| iphone54
 
|-
 
| rowspan="2" | [[iPhone 5s]]
 
| [[n51ap|iPhone6,1]]
 
| iphone61
 
|-
 
| [[n53ap|iPhone6,2]]
 
| iphone62
 
|-
 
| colspan="2" | [[n61ap|iPhone 6]]
 
| iphone72
 
|-
 
| colspan="2" | [[n56ap|iPhone 6 Plus]]
 
| iphone71
 
|-
 
! colspan="3" |
 
|-
 
| colspan="2" | [[n45ap|iPod touch]]
 
| ipod11
 
|-
 
| colspan="2" | [[n72ap|iPod touch 2G]]
 
| ipod21
 
|-
 
| colspan="2" | [[n18ap|iPod touch 3G]]
 
| ipod31
 
|-
 
| colspan="2" | [[n81ap|iPod touch 4G]]
 
| ipod41
 
|-
 
| colspan="2" | [[iPod touch 5G]]
 
| ipod51
 
|}
 

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