Difference between revisions of "Template:Keys/doc"

From The iPhone Wiki
Jump to: navigation, search
m
(17 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 keys for <code>*</code> do not exist, add <code>*KBAG</code> and set it to <code>*</code>'s KBAG
 
-->
 
   
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, 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 <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.
 
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           = Unknown
+
| 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
 
 
| UpdateRamdisk       = 
+
| ADCPetra =
| UpdateRamdiskIV     = Unknown
+
| ADCPetraIV = Unknown
| UpdateRamdiskKey    = Unknown
+
| ADCPetraKey = Unknown
| UpdateRamdiskKBAG   =
+
| ADCPetraKBAG =
 
 
| RestoreRamdisk      = 
+
| ARMFW =
| RestoreRamdiskIV   = Unknown
+
| ARMFWIV = Not Encrypted
| RestoreRamdiskKey  = Unknown
 
| RestoreRamdiskKBAG  =
 
 
 
| AppleLogo         = Unknown
+
| ANSF =
| AppleLogoIV         = Unknown
+
| ANSFIV = Not Encrypted
| AppleLogoKey        = Unknown
 
| AppleLogoKBAG       =
 
 
 
  +
| ANE =
| BatteryCharging0  = Unknown
 
  +
| ANEIV = Not Encrypted
| BatteryCharging0IV  = Unknown
 
  +
| BatteryCharging0Key = Unknown
 
  +
| 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 =
 
| BatteryCharging0KBAG =
 
 
| BatteryCharging1  = Unknown
+
| BatteryCharging1   =
| BatteryCharging1IV  = Unknown
+
| BatteryCharging1IV   = Unknown
| BatteryCharging1Key = Unknown
+
| BatteryCharging1Key = Unknown
 
| BatteryCharging1KBAG =
 
| BatteryCharging1KBAG =
 
 
| BatteryFull       = Unknown
+
| BatteryFull       =
| BatteryFullIV       = Unknown
+
| BatteryFullIV       = Unknown
| BatteryFullKey      = Unknown
+
| BatteryFullKey      = Unknown
| BatteryFullKBAG     =
+
| BatteryFullKBAG     =
 
 
| BatteryLow0       = Unknown
+
| BatteryLow0       =
| BatteryLow0IV       = Unknown
+
| BatteryLow0IV       = Unknown
| BatteryLow0Key      = Unknown
+
| BatteryLow0Key      = Unknown
| BatteryLow0KBAG     =
+
| BatteryLow0KBAG      =
 
 
| BatteryLow1       = Unknown
+
| BatteryLow1       =
| BatteryLow1IV       = Unknown
+
| BatteryLow1IV       = Unknown
| BatteryLow1Key      = Unknown
+
| BatteryLow1Key      = Unknown
| BatteryLow1KBAG    =
+
| BatteryLow1KBAG    =
 
 
| DeviceTree        = Unknown
+
| Dali =
| DeviceTreeIV        = Unknown
+
| DaliIV        = Unknown
| DeviceTreeKey       = Unknown
+
| DaliKey       = Unknown
| DeviceTreeKBAG      =
+
| DaliKBAG      =
 
 
| GlyphCharging     = Unknown
+
| DeviceTree         =
| GlyphChargingIV     = Unknown
+
| DeviceTreeIV        = Unknown
| GlyphChargingKey    = Unknown
+
| DeviceTreeKey       = Unknown
| GlyphChargingKBAG   =
+
| DeviceTreeKBAG      =
 
 
| GlyphPlugin       = Unknown
+
| GlyphCharging     =
| GlyphPluginIV       = Unknown
+
| GlyphChargingIV     = Unknown
| GlyphPluginKey      = Unknown
+
| GlyphChargingKey    = Unknown
| GlyphPluginKBAG     =
+
| GlyphChargingKBAG   =
 
 
| iBEC              = Unknown
+
| GlyphPlugin       =
| iBECIV              = Unknown
+
| GlyphPluginIV       = Unknown
| iBECKey             = Unknown
+
| GlyphPluginKey      = Unknown
| iBECKBAG            =
+
| GlyphPluginKBAG     =
 
 
| iBoot             = Unknown
+
| HapticAssets        =
| iBootIV             = Unknown
+
| HapticAssetsIV      = Not Encrypted
| iBootKey            = Unknown
 
| iBootKBAG          =
 
 
 
| iBSS              = Unknown
+
| Homer        =
| iBSSIV              = Unknown
+
| HomerIV       = Not Encrypted
| iBSSKey             = Unknown
 
| iBSSKBAG          =
 
 
 
| Kernelcache       = Unknown
+
| iBEC              =
| KernelcacheIV       = Unknown
+
| iBECIV              = Unknown
| KernelcacheKey      = Unknown
+
| iBECKey             = Unknown
| KernelcacheKBAG    =
+
| iBECKBAG            =
  +
  +
| iBoot             =
  +
| iBootIV             = Unknown
  +
| iBootKey            = Unknown
  +
| iBootKBAG          =
  +
  +
| 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
  +
  +
| MConnector =
  +
| MConnectorIV = Not Encrypted
  +
  +
| Multitouch =
  +
| MultitouchIV = Not Encrypted
  +
  +
| NeedService       =
  +
| NeedServiceIV       = Unknown
  +
| NeedServiceKey      = Unknown
  +
| NeedServiceKBAG     =
  +
  +
| PMP        =
  +
| PMPIV       = Not Encrypted
  +
  +
| RANS        =
  +
| RANSIV       = Not Encrypted
 
 
| LLB               = Unknown
+
| RecoveryMode       =
| LLBIV               = Unknown
+
| RecoveryModeIV      = Unknown
| LLBKey              = Unknown
+
| RecoveryModeKey     = Unknown
| LLBKBAG             =
+
| RecoveryModeKBAG   =
 
 
| NeedService       = Unknown
+
| SEPFirmware      =
| NeedServiceIV       = Unknown
+
| SEPFirmwareIV      = Unknown
| NeedServiceKey      = Unknown
+
| SEPFirmwareKey      = Unknown
| NeedServiceKBAG     =
+
| SEPFirmwareKBAG     =
 
 
| RecoveryMode      = Unknown
+
| SmartIOFirmware =
  +
| SmartIOFirmwareIV = Not Encrypted
| RecoveryModeIV      = Unknown
 
| RecoveryModeKey     = Unknown
 
| RecoveryModeKBAG   =
 
 
 
| SEPFirmware      = Unknown
+
| WirelessPower =
| SEPFirmwareIV      = Unknown
+
| WirelessPowerIV = Not Encrypted
| SEPFirmwareKey      = Unknown
 
| SEPFirmwareKBAG    =
 
 
<nowiki>}}</nowiki>
 
<nowiki>}}</nowiki>

Revision as of 04:51, 30 September 2020

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

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

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

 | 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

 | MConnector           =
 | MConnectorIV         = Not Encrypted

 | Multitouch           =
 | MultitouchIV         = Not Encrypted

 | NeedService          = 
 | NeedServiceIV        = Unknown
 | NeedServiceKey       = Unknown
 | NeedServiceKBAG      =
 | PMP                  = 
 | PMPIV                = Not Encrypted
 | RANS                 = 
 | RANSIV               = Not Encrypted

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

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

 | SmartIOFirmware      =
 | SmartIOFirmwareIV    = Not Encrypted

 | WirelessPower        =
 | WirelessPowerIV      = Not Encrypted
}}