Editing PUP

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
PUP (Playstation Update Package) is the file format of the PSP, PS3, PSVita, PS4, and PS5 system software update packages. It contains updated firmware and files for devices such as the GameOS, Syscon, Wi-Fi, Bluetooth, Communication Processor, Southbridge, Bluray Drive, and more.
PUP (Playstation Update Package) is the file format of the PSP, PS3, PSVita and PS4 system software update packages.


== PUP Structure ==
PUP embed updates for devices such as the GameOS, Syscon, Wi-Fi, Bluetooth, Communication Processor, Southbridge, BD drive.


PS4 update files differ from previous PlayStation consoles in that they embed multiple PUP fragments. The "main" file that is distributed and downloaded to the PS4 console is a SLB2-packed (or "BLS") file which contains PUP fragment files. On retail and TestKit, it typically contains two PUPs (`PS4UPDATE1.PUP` and `PS4UPDATE2.PUP`), while DevKit may have four. These PS4 PUP files are similar in structure to PS4 Signed ELFs (SELFs). Each PUP fragment is responsible for containing different sets of files.
== Structure ==


* PS4UPDATE1 is the "core" update file and contains updates for GameOS/x86 kernel and usermode, Bluray Drive, EAP, EMC, Syscon, SAM, and other firmware stored on the SPI flash.
PS4 PUP is special because it embeds single other PUPs.
* PS4UPDATE2 contains the `system_ex` partition of system applications.
* PS4UPDATE3 (DevKit only) contains the preinstall image for DevKit.
* PS4UPDATE4 (DevKit only) contains a seemingly empty preinstall part 2 image for DevKit (maybe reserved?).


All PUP fragments contain the end-user license agreement, the Orbis Software Updater (orbis_swu), and a watermark.
=== Header ===


=== File Header ===
Have a feeling the header for the new PS4 PUPs ends with a LZMA dictionary and file size… (ie a normal lzma header without the properties byte) anyone else done research into that? As in:
 
The file header for the main PUP file is an SLB2 file. Each PUP fragment packed into it has the following header (note: after the initial 0x10 bytes, the remaining 0x10 bytes are encrypted along with the metadata that follows it).
 
<source lang="c">
struct ScePupHeader {
uint32_t magic;                 // 0x00 - PS4PUPMAGIC "\x4F\x15\x3D\x1D"
uint16_t version;              // 0x04 - Big Endian (??)
uint16_t unknown_one;          // 0x06
uint16_t unknown_two;          // 0x08
uint16_t flags;                // 0x0A
uint16_t header_size;          // 0x0C
uint16_t metadata_size;        // 0x0E
 
// From this point on, the header is encrypted...
uint16_t file_size;            // 0x10
uint16_t segment_count;        // 0x18
uint16_t metadata_entries;      // 0x1A
uint32_t unknown_three;        // 0x1C
}; // Size: 0x20
</source>
 
=== Segments ===
 
From this point on, the remaining structures are encrypted in raw update files (though this section can be seen by using the system as an oracle to decrypt PUPs). Following the header is the segment table, which has segment entries that contain information about update entries (a list of which can be found in the "Indices" section).
 
<source lang="c">
struct ScePupSegmentHeader {
uint64_t flags;                // 0x00
uint64_t offset;                // 0x08
uint64_t compressed_size;      // 0x10
uint64_t uncompressed_size;    // 0x18
}; // Size: 0x20
</source>
 
While offset, compressed_size, and uncompressed_size fields are self-explanatory, the flags field packs a lot of information. Below are known flags:
 
<source lang="c">
#define PUP_SEGMENT_ID(x)                  (x->flags >> 20)
#define PUP_SEGMENT_IS_INFO(x)              ((x->flags & (1 << 0)) != 0)
#define PUP_SEGMENT_IS_ENCRYPTED(x)        ((x->flags & (1 << 1)) != 0)
#define PUP_SEGMENT_IS_SIGNED(x)            ((x->flags & (1 << 2)) != 0)
#define PUP_SEGMENT_IS_COMPRESSED(x)        ((x->flags & (1 << 3)) != 0)
#define PUP_SEGMENT_HAS_BLOCKS(x)          ((x->flags & (1 << 11)) != 0)
#define PUP_SEGMENT_HAS_DIGESTS(x)          ((x->flags & (1 << 16)) != 0)
#define PUP_SEGMENT_BLOCK_SIZE(x)          (1 << (((x->flags >> 12) & 0xF) + PAGE_SHIFT)) // Note: PAGE_SHIFT = 0xC
</source>
 
In most cases (ie. "data" segments as opposed to info segments), the segment ID indicates the type of firmware or file to update (see [[#Indices]] table). In the case of info segments, the segment ID points to the index of the "data" segment it contains information for. Info segments are typically only seen when the file or firmware utilizes block-based segments.
 
=== PUP Info ===
 
After the segment table is a section that has additional information on the PUP, such as its target firmware and various flags.


<source lang="c">
<source lang="c">
struct ScePupInfo {
struct PUPPS4Header {
uint32_t fw_ver;               // 0x00 - Firmware version in integer format (ie. FW 9.50 is 0x95080000000)
uint32_t magic; // PS4PUPMAGIC "\x4F\x15\x3D\x1D"
char unknown_one[0x14];         // 0x04
uint16_t version; // Big Endian (??)
uint32_t type;                 // 0x18 - Beta/Retail/Testkit/Devkit/Proto
uint16_t unknownOne;
char unknown_two[0x4];         // 0x1C
uint16_t unknownTwo;
uint32_t flags;                 // 0x20
uint16_t unknownThree;
uint32_t req_fw_ver;           // 0x24
uint32_t dictSize; // LE afaics
char unknown_three[0x8];       // 0x28
uint32_t uncompressedSize; // LE afaics
}
}
</source>
</source>
=== Metadata ===
Following the info structure is the metadata table. These entries contain crypto material such as intermediate keys for decrypting and verifying segments. Each segment should have a metadata table entry.
<source lang="c">
struct ScePupMetadataEntry {
char aes128_key[0x10];          // 0x00 - AES128 data decryption key
char aes128_iv[0x10];          // 0x10 - AES128 data decryption initialization vector
char digest[0x20];              // 0x20 - SHA256 digest
char digest_key[0x10];          // 0x40 - SHA256 digest HMAC key
}; // Size: 0x50
</source>
=== Unpacking Notes ===
* Encryption is applied on segments post-compression.
* Non-blocked segments are a straight copy or decompression operation.
* Processing blocked segments requires looking up the accompanying info segments and parsing the block tables within them.
* Large disk images and most SLB2/BLS files will be block-based.


== Tools ==
== Tools ==
Line 102: Line 27:
=== Decrypter (first step) ===
=== Decrypter (first step) ===


* [https://github.com/zecoxao/ps5-pup-decrypt PS5 PUP decryptor based on the one for PS4 (2022-10-14 to 2024-05-25)]
* [https://github.com/idc/ps4-pup_decrypt ps4-pup_decrypt by idc]
* [https://github.com/EchoStretch/ps4-pup-decrypt PS4 PUP decryptor based on idc's by EchoStretch (2024-06-07)]
* [https://github.com/andy-man/ps4-pup-decrypt PS4 PUP decryptor based on idc's by andy-man (2024-04-07)]
* [https://github.com/Creeeeger/PS4-dec PS4 PUP decryptor based on idc's by Creeger (2024-02-20)]
* [https://github.com/SocraticBliss/ps4-pup_decrypt PS4 PUP decryptor based on idc's by SocraticBliss and l0lhax (2019-05-28)]
* [https://github.com/idc/ps4-pup_decrypt ps4-pup_decrypt by idc (2016-06-05 to 2017-11-24)]


=== Unpacker (second step) ===
=== Unpacker (second step) ===


* [https://github.com/seregonwar/PFU-PupFileUnpacker PupFileUnpacker by seregonwar (2023-04-08 to 2024-09-30)] (based on ps4_dec_pup_info by SocraticBliss)
* [https://github.com/idc/ps4-pup_unpack ps4-pup-unpack by idc]
* [https://github.com/SocraticBliss/ps4_dec_pup_info ps4_dec_pup_info by SocraticBliss (2020-09-23)]
* [https://github.com/Zer0xFF/ps4-pup-unpacker ps4-pup-unpacker by Zer0xFF] (based on ps4-pup-unpack by idc)
* [https://github.com/Zer0xFF/ps4-pup-unpacker ps4-pup-unpacker by Zer0xFF (2017-11-24 to 2018-01-14)] (based on ps4-pup-unpack by idc)
 
* [https://github.com/idc/ps4-pup_unpack ps4-pup-unpack by idc (2016-06-05 to 2017-12-12)]


== Indices ==
== Indices ==
{| class="wikitable sortable"
{| class="wikitable sortable"
|-
|-
! Index !! Decimal !! Description !! Perconsole? !! Notes !! Added !! Deprecated? || Cipher Note || Component Name
! Index !! Decimal !! Description !! Perconsole? !! Notes !! Added !! Deprecated?
|-
| 1 || 1 || EMC IPL || {{no}} || sflash0s0x32/b Aeolia 1st Revision || [[0.910.040]] || {{yes}} , since 2.00 || Same body as 0x0D || ??
|-
| 2 || 2 || EAP KBL || {{no}} || sflash0s0x33 Aeolia 1st Revision || [[0.910.040]] || {{yes}} , since 2.00 || Same body as 0x0E || ??
|-
|-
| 3 || 3 || WIFI FW || {{no}} || torus2 Aeolia A2 || [[0.910.040]] || || || --
| 1 || 1 || EMC IPL || {{no}} || sflash0s0x32/b Aeolia 1st Revision || [[0.910.040]] ||  
|-
|-
| 4 || 4 || SECURE LOADER || {{yes}} || sflash0s1.cryptx2/b 1st SOCUID || [[0.910.040]] || || (Confirmed by anon) Same body as 0x23 || [[CXD90026G]]
| 2 || 2 || EAP KBL || {{no}} || sflash0s0x33 Aeolia 1st Revision || [[0.910.040]] ||
|-
|-
| 5 || 5 || COREOS || {{no}} || secure_modules || [[0.910.040]] || || || GEN1,2,3 Universal
| 3 || 3 || WIFI FW || {{no}} || torus2 || [[0.910.040]] ||
|-
|-
| 6 || 6 || SYSTEM || {{no}} || system fs (FAT32/TEXFAT later)  || [[0.910.040]] || || || GEN1,2,3 Universal
| 4 || 4 || SAM IPL || {{yes}} || sflash0s1.cryptx2/b 1st SOCUID || [[0.910.040]] ||
|-
|-
| 7 || 7 || EAP KERNEL || {{no}} || da0x2 || [[0.910.040]] || || || GEN1,2,3 Universal
| 5 || 5 || COREOS || {{no}} || secure_modules || [[0.910.040]] ||
|-
|-
| 8 || 8 || EAP VSH || {{no}} || eap_vsh fs (FAT16) || [[0.910.040]] || || || GEN1,2,3 Universal
| 6 || 6 || SYSTEM || {{no}} || system fs (FAT32/TEXFAT later) || [[0.910.040]] ||
|-
|-
| 9 || 9 || PREINST || {{no}} || preinst fs (FAT32) || [[0.910.040]] || || || GEN1,2,3 Universal
| 7 || 7 || EAP KERNEL || {{no}} || da0x2 || [[0.910.040]] ||
|-
|-
| 0xA || 10 || ??? || {{no}} || sflash0s1.cryptx40 || {{no}} || || || ??
| 8 || 8 || EAP VSH || {{no}} || eap_vsh fs (FAT16) || [[0.910.040]] ||
|-
|-
| 0xB || 11 || PREINST2 || {{no}} || preinst2 fs (FAT32) || [[0.910.040]] || || || GEN1,2,3 Universal
| 9 || 9 || PREINST || {{no}} || preinst fs (FAT32) || [[0.910.040]] ||
|-
|-
| 0xC || 12 || SYSTEM_EX || {{no}} || system_ex fs (FAT32/TEXFAT later) || [[0.910.040]] || || || GEN1,2,3 Universal
| 0xA || 10 || ??? || {{no}} || sflash0s1.cryptx40 || ||
|-
|-
| 0xD || 13 || EMC IPL || {{no}} || sflash0s0x32/b Aeolia A2 || [[0.910.040]] || || Same body as 0x1 || [[CXD90025G]]
| 0xB || 11 || PREINST2 || {{no}} || preinst2 fs (FAT32) || [[0.910.040]] ||
|-
|-
| 0xE || 14 || EAP KBL || {{no}} || sflash0s0x33 Aeolia A2 || [[0.910.040]] || || Same body as 0x2 || [[CXD90025G]]
| 0xC || 12 || SYSTEM_EX || {{no}} || system_ex fs (FAT32/TEXFAT later) || [[0.910.040]] ||
|-
|-
| 0xF || 15 || ??? || {{no}} || test || {{no}} || || || ??
| 0xD || 13 || EMC IPL || {{no}} || sflash0s0x32/b Aeolia 2nd Revision || [[0.910.040]] ||
|-
|-
| 0x10-0x16 || 16-22 || ??? || {{no}} || sbram0 || {{no}} || || || ??
| 0xE || 14 || EAP KBL || {{no}} || sflash0s0x33 Aeolia 2nd Revision || [[0.910.040]] ||
|-
|-
| 0x20 || 32 || EMC IPL || {{no}} || sflash0s0x32/b Belize 1st Revision || 2.00 || || Same body as 0x2A || [[CXD90036G]]
| 0xF || 15 || ??? || {{no}} || test || ||
|-
|-
| 0x21 || 33 || EAP KBL || {{no}} || sflash0s0x33 Belize 1st Revision || 2.00 || ||  Same body as 0x2B and 0x25 || [[CXD90036G]]
| 0x10-0x16 || 16-22 || ??? || {{no}} || sbram0 || ||
|-
|-
| 0x22 || 34 || WIFI FW || {{no}} || torus2 || 2.00 || || || ??
| 0x20 || 32 || EMC IPL || {{no}} || sflash0s0x32/b Belize 1st Revision || 2.00 ||
|-
|-
| 0x23 || 35 || SECURE LOADER || {{yes}} || sflash0s1.cryptx2/b 2nd SOCUID || 2.00 || || (Confirmed by anon) Same body as 0x04 || [[CXD90026AG]]
| 0x21 || 33 || EAP KBL || {{no}} || sflash0s0x33 Belize 1st Revision || 2.00 ||
|-
|-
| 0x24 || 36 || EMC IPL || {{no}} || sflash0s0x32/b Baikal B1  || 3.00 || || || [[CXD90046GG]]
| 0x22 || 34 || WIFI FW || {{no}} || torus2 || 2.00 ||
|-
|-
| 0x25 || 37 || EAP KBL || {{no}} || sflash0s0x33 Baikal B1  || 3.00 || || Same body as 0x2B and 0x21 || [[CXD90046GG]]
| 0x23 || 35 || SAM IPL || {{yes}} || sflash0s1.cryptx2/b 2nd SOCUID || 2.00 ||
|-
|-
| 0x26 || 38 || SECURE LOADER || {{yes}} || sflash0s1.cryptx2/b 3rd SOCUID || 3.00 || || (Confirmed by anon) Same body as 0x2D and 0x32 || [[CXD90037G]]
| 0x24 || 36 || EMC IPL || {{no}} || sflash0s0x32/b Belize 2nd Revision || ||
|-
|-
| 0x27 || 39 || SECURE LOADER || {{yes}} || sflash0s1.cryptx2/b 4th SOCUID || 3.00 || || (Confirmed by anon) Same body as 0x31 || [[CXD90043GB]]
| 0x25 || 37 || EAP KBL || {{no}} || sflash0s0x33 Belize 2nd Revision || ||
|-
|-
| 0x28 || 40 || EMC IPL || {{no}} || sflash0s0x32/b Baikal 1st Revision || 3.00 || || Same body as 0x2C ||
| 0x26 || 38 || SAM IPL || {{yes}} || sflash0s1.cryptx2/b 3rd SOCUID || ||
|-
|-
| 0x2A || 42 || EMC IPL || {{no}} || sflash0s0x32/b Belize 2 A0  || 4.00 ||  || Same body as 0x20 ||
| 0x27 || 39 || SAM IPL || {{yes}} || sflash0s1.cryptx2/b 4th SOCUID || ||
|-
|-
| 0x2B || 43 || EAP KBL || {{no}} || sflash0s0x33 Belize 2 A0 || 4.00 || || Same body as 0x25 and 0x21 ||
| 0x28 || 40 || EMC IPL || {{no}} || sflash0s0x32/b Belize 2 1st Revision || ||
|-
|-
| 0x2C || 44 || EMC IPL || {{no}} || sflash0s0x32/b Baikal2 1st Revision || 4.00 || || Same body as 0x28 ||
| 0x2A || 42 || EMC IPL || {{no}} || sflash0s0x32/b Belize 2 2nd Revision || ||
|-
|-
| 0x2D || 45 || SECURE LOADER || {{yes}} || sflash0s1.cryptx2/b 5th SOCUID || 4.50 || || (Confirmed by anon) Same body as 0x26 and 0x32 || [[CXD90044GB]]
| 0x2B || 43 || EAP KBL || {{no}} || sflash0s0x33 Belize 2 1st/2nd Revision || ||
|-
|-
| 0x2E || 46 || EMC IPL || {{no}} || sflash0s0x32/b Belize2 3rd Revision?  || 5.00 || || ||
| 0x2C || 44 || EMC IPL || {{no}} || sflash0s0x32/b Baikal 1st Revision || ||
|-
|-
| 0x30 || 48 || WIFI FW || {{no}} || sflash0s0x38 trooper Belize 2 A0 || 5.00 || || || --
| 0x2D || 45 || SAM IPL || {{yes}} || sflash0s1.cryptx2/b 5th SOCUID || ||
|-
|-
| 0x31 || 49 || SECURE LOADER || {{yes}} || sflash0s1.cryptx2/b 6th SOCUID || 5.50 || || (Confirmed by anon) Same body as 0x27 || [[CXD90051GB]]
| 0x2E || 46 || EMC IPL || {{no}} || sflash0s0x32/b Baikal 2nd Revision || ||
|-
|-
| 0x32 || 50 || SECURE LOADER || {{yes}} || sflash0s1.cryptx2/b 7th SOCUID || 6.50 || || (Confirmed by anon) Same body as 0x26 and 0x2D || [[CXD90055GB]]
| 0x30 || 48 || WIFI FW || {{no}} || sflash0s0x38 trooper || ||
|-
|-
| 0x101 || 257 || EULA.XML || {{no}} || Sony Agreement XML || 1.00 || || || Universal
| 0x101 || 257 || EULA.XML || {{no}} || Sony Agreement XML || 1.00 ||  
|-
|-
| 0x200 || 512 || ORBIS_SWU.SELF || {{no}} || Sony SoftWareUpdater (ELF) || [[0.910.040]] || || || Universal
| 0x200 || 512 || ORBIS_SWU.SELF || {{no}} || Sony SoftWareUpdater (ELF) || [[0.910.040]] ||
|-
|-
| 0x202 || 514 || ORBIS_SWU.SELF || {{no}} || Sony SoftWareUpdater (Encrypted SELF) || [[0.920.030]] || || || Universal
| 0x202 || 514 || ORBIS_SWU.SELF || {{no}} || Sony SoftWareUpdater (Encrypted SELF) || [[0.920.030]] ||
|-
|-
| 0x301 || 769 || ??? || {{no}} || /update related || {{no}} || || || ??
| 0x301 || 769 || ??? || {{no}} || /update related || ||
|-
|-
| 0x302 || 770 || ??? || {{no}} || /update related || {{no}} || || || ??
| 0x302 || 770 || ??? || {{no}} || /update related || ||
|-
|-
| 0xD00 || 3328 || SYSCON FW || {{no}} || sc_fw_update0 firmware (4000XXXX)  || [[0.915.010]] || || || Universal Syscon
| 0xD00 || 3328 || SYSCON FW || {{no}} || sc_fw_update0 firmware (4000XXXX)  || [[0.915.010]] ||
|-
|-
| 0xD01 || 3329 || BLURAY DRIVE FW || {{no}} || Bluray drive firmware (all revisions) (4XXR) || [[0.920.030]] || || || Universal Bluray Drive
| 0xD01 || 3329 || BLURAY FW || {{no}} || bluray firmware (all revisions) (4XXR) || [[0.920.030]] ||
|-
|-
| 0xD02 || 3330 || USB SATA BRIDGE FW || {{no}} || USB SATA bridge firmware (da0) || 1.00 || || || [[MB86C311B]]
| 0xD02 || 3330 || USB SATA BRIDGE FW || {{no}} || usb sata bridge firmware (da0) || 1.00 ||  
|-
|-
| 0xD07 || 3335 || SYSCON PATCH || {{no}} || sc_fw_update0 patch (4001XXXX)  || 2.50 Test/Retail || || || Universal Syscon
| 0xD07 || 3335 || SYSCON PATCH || {{no}} || sc_fw_update0 patch (4001XXXX)  || ||
|-
|-
| 0xD08 || 3336 || SYSCON FW || {{no}} || sc_fw_update0 firmware (4000XXXX)  || 1.00 Devkit || || || Universal Syscon
| 0xD08 || 3336 || SYSCON FW || {{no}} || sc_fw_update0 firmware (4000XXXX)  || ||
|-
|-
| 0xD09 || 3337 || COMMUNICATION PROCESSOR FW || {{no}} || cpfirm || 3.50 Devkit || || || Neo DevKit Component (unknown)
| 0xD09 || 3337 || COMMUNICATION PROCESSOR FW || {{no}} || cpfirm || 3.50 Devkit ||
|-
|-
|}
|}
Please note that all contributions to PS4 Developer wiki are considered to be released under the GNU Free Documentation License 1.2 (see PS4 Developer wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To protect the wiki against automated edit spam, we kindly ask you to solve the following hCaptcha:

Cancel Editing help (opens in new window)

Templates used on this page:

Retrieved from "http://www.psdevwiki.com/ps4/PUP"