Difference between revisions of "Template:Keys/doc"

From The iPhone Wiki
Jump to: navigation, search
(Syntax Explicitation :))
(add Cryptex1,AppOS and Cryptex1,SystemOS)
 
(116 intermediate revisions by 7 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.
<nowiki>{{keys</nowiki>
 
| previouspage =
 
| nextpage =
 
| version =
 
| build =
 
| device =
 
| downloadurl =
 
| rootfsdmg =
 
| rootfskey =
 
| noupdateramdisk =
 
| ramdisknotencrypted =
 
| updatedmg =
 
| updateiv =
 
| updatekey =
 
| restoredmg =
 
| restoreiv =
 
| restorekey =
 
| extra01 =
 
| extra01iv =
 
| extra01key =
 
| extra02 =
 
| extra02iv =
 
| extra02key =
 
| extra03 =
 
| extra03iv =
 
| extra03key =
 
| extra04 =
 
| extra04iv =
 
| extra04key =
 
| extra05 =
 
| extra05iv =
 
| extra05key =
 
| extra06 =
 
| extra06iv =
 
| extra06key =
 
| extra07 =
 
| extra07iv =
 
| extra07key =
 
| extra08 =
 
| extra08iv =
 
| extra08key =
 
| extra09 =
 
| extra09iv =
 
| extra09key =
 
| extra10 =
 
| extra10iv =
 
| extra11key =
 
| extra11 =
 
| extra11iv =
 
| extra11key =
 
| extra12 =
 
| extra12iv =
 
| extra12key =
 
| extra13 =
 
| extra13iv =
 
| extra13key =
 
| extra14 =
 
| extra14iv =
 
| extra14key =
 
| extra15 =
 
| extra15iv =
 
| extra15key =
 
| extra16 =
 
| extra16iv =
 
| extra16key =
 
| extra17 =
 
| extra17iv =
 
| extra17key =
 
| extra18 =
 
| extra18iv =
 
| extra18key =
 
| extra19 =
 
| extra19iv =
 
| extra19key =
 
| extra20 =
 
| extra20iv =
 
| extra20key =
 
<nowiki>}}</nowiki>
 
   
  +
If the device is an Apple TV (iOS versions), set <code>Version</code> to the marketing version with the internal version in parenthesis.
== Syntax Explicitation :) ==
 
  +
{| class="wikitable"
 
  +
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.
|-
 
  +
! style="width:10%" | Tag
 
  +
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.
! style="width:90%" | Explicitation
 
  +
|-
 
  +
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)
! previouspage
 
  +
| The complete tile of the previous fw page. (Ex. page is [[Durango 8K2 (iPhone 3GS)]], you would put <code>Durango 8J2 (iPhone 3GS)</code>)
 
  +
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>
! nextpage
 
  +
| Version             = 
| Exact opposite of '''previouspage'''
 
  +
| Build               = 
|-
 
  +
| Device               = 
! version
 
  +
| Codename             = 
| The version of the build (Ex. page is [[Durango 8K2 (iPhone 3GS)]], you would put <code>4.3.4</code>)
 
  +
| Baseband             = 
|-
 
  +
| DownloadURL         = 
! build
 
  +
| Explains itself
 
  +
| RootFS           = 
|-
 
  +
| RootFSKey           = Unknown
! device
 
  +
| [[#Device|See below (v)]]<!-- Opposite of ^ -->
 
  +
| UpdateRamdisk       = 
|-
 
  +
| UpdateRamdiskIV      = Unknown
! downloadurl
 
  +
| UpdateRamdiskKey    = Unknown
| Only PUBLIC Apple firmwares (no protected:// URIs)
 
  +
| UpdateRamdiskKBAG    =
|-
 
  +
! rootfsdmg
 
  +
| UpdateRamdiskOTA =
| The name of the Root FS file (W/O .DMG)
 
  +
| 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
  +
<nowiki>}}
  +
</nowiki>

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