Pkg2zip Vita: Difference between revisions

pkg2zip
pkg2zip
General
Author	Yoti, mmozeiko, lusid1
Type	PC Utilities
Version	2.6
License	Public Domain
Last Updated	2024/06/29
Links
	Download
	Website
	Source

Latest revision as of 06:43, 30 Haziran 2024

Pkg2zip, an utility that decrypts PlayStation Vita pkg file and creates zip package.

Supported pkg files - main application, DLC, patch, theme and PSM files. Also supported PKG, PSX and PSP PKG files for use with Adrenaline.

Optionally writes NoNpDrm or NoPsmDrm fake license file from zRIF string. You must provide license key.

Features

Portable, written in cross-platform C code, runs on Windows, GNU/Linux, macOS (system dependent functionality is isolated in sys.c file).
Small, has no external library dependencies and uses very minimal dynamic memory allocations.
Fast, uses AESNI hardware accelerated AES decryption if supported by CPU (requires AESNI and SSSE3 instructions).
Simple, creates zip package with same folder structure that Vita expects (just drag & drop all file from zip archive to ux0:). Zip file is created directly from pkg without any intermediate temporary files.
Vita DLC, Vita PATCH and PSM pkg unpacking.
PSX, PSP, PSP Updates, PSP DLC, and PSP THEME pkg unpacking.

User guide

Requirements

HENkaku / enso.
NoNpDrm.
NoPsmDrm for PSM titles.
VitaShell v1.76 or newer required for DLC installation.
Adrenaline for PSX or PSP titles.
Npdrm free for PSP titles in eboot format.

How to use

Use the following command if you have zRIF fake license.
This will create title [id] [region].zip file. Title, ID and region is automatically detected from pkg file. It will include work.bin file. Example:

pkg2zip package.pkg zRIF_STRING

Omit last argument if you don't have zRIF fake license, but just want to unpack files.
Resulting zip file will not include work.bin. This is useful for patch pkg files. Example:

pkg2zip package.pkg

Use -l to get output file name of the zip (must come before pkg file and cannot be used with -x). Example:

pkg2zip -l package.pkg

Use -x argument to avoid zipping process and create individual files (must come before pkg file).
PSX or PSP pkg files do not require zRIF argument. It will be ignored. Example:

pkg2zip -x package.pkg [zRIF_STRING]

For PSP files pkg2zip by default will create .ISO file.
To create compressed .CSO file pass -cN argument where N is compression factor (1 for the fastest compression). Example:

pkg2zip -c1 package.pkg

Use -c9, or anything inbetween to create smaller cso file (more compression will require more time). Example:

pkg2zip -c9 package.pkg

You can combine -cN argument together with -x. Example:

pkg2zip -x -c9 package.pkg

Use the -p argument to extract PSP files in their original EBOOT.PBP format. Example:

pkg2zip -p package.pkg

Note: On PSP hardware titles with DLC should be kept in ISO/CSO format due to limitations on the CFW NoDRM Engine.

Generating zRIF string

If you have working NoNpDrm license file (work.bin or 6488b73b912a753a492e2714e9b38bc7.rif) you can create zRIF string with rif2zrif.py python script.
Example (it will print zRIF string to stdout):

$ python rif2zrif.py path/to/work.bin

To generate work.bin from zRIF string use zrif2rif.py script.
Example (last argument is optional, it specifies where to save file and defaults to work.bin name):

$ python zrif2rif.py zRIF work.bin

Limitations

No actual title name is extracted for PSM pkg files.

Alternatives

Screenshots

Changelog

v2.6

enhanced pkg file support (Yoti).
additional languages (Yoti).
PSM extraction for android (LiEnby).

v2.5 (by Yoti)

Added support for more regions.

v2.4 (by Yoti)

Added support to decrypt/extract PKG type 1.
Added support for KEYS.BIN for PKG type 1.
Added region detection for PS1 games.
Fixed some messages here and there.

v2.3 (by lusid1)

Only decrypt PSP EDAT files in ISO mode.
Fixes PCEngine extraction in PBP mode (-p).
Fixes DLC compatibility in PBP mode (-p).
Added -d switch to force EDAT decryption
Merged cli improvements and other fixes from sigmaboy

v2.2 (by lusid1)

PSP Theme names are now used for zip file names.

v2.1 (by lusid1)

PSX pkg unpacking now includes keys.bin

v2.0 (by lusid1)

Added support for VITA Theme pkg.
Added support for PSP Theme pkg.
Added support for PSP DLC pkg.
Added support for pocketstation pkg.
Added option to unpack PSP pkg to EBOOT.PBP.
Fixed CSO compression.
Fixed psm dev kit cert.bin extraction.

v1.8 (by mmozeiko/Mārtiņš Možeiko)

Support PSP pkg file unpacking, including NeoGeo, Mini, Go, PC Engine pkg files.
Unpack PSP pkg files to ISO or CSO.
Better output with UTF-8 encoding on Windows for title names.
Show unpacking progress in percents.

v1.7

Fix issue with patch file unpacking in -x mode.

v1.6

Much faster zip file creation - depending on CPU and disk speed it is now ~2 to 3 times faster.
Add -x argument which makes unpacking files in extracted form - with same layout as ux0.
Unpacking PSM pkg files for use with NoPsmDrm.
Unpacking PSX pkg files for use with Adrenaline.
Unpacking PSP pkg files. Result is not yet directly usable on Vita - it produces EBOOT.PBP which requires to be unpacked further with different 3rd party tool.

v1.5

Adjust size of tail.bin - now it uses all remaining data after encrypted blob.

v1.4

Add support for DLC and PATCH pkg file unpacking.
Supports unlimited amount of files inside zip file.
Fix for zip files larger than 4GB.
Drop support for dummy work.bin generation (without key inside).
Drop support for hexkey argument to try generate work.bin.

v1.3

Fix a bug when wrong title id was put in work.bin when generating it from raw key.
Display minimum required firmware version to run the game.
Verify integrity of zRIF before starting to unpack pkg file, and display error if it is not correct zRIF.
Allow utf-8 characters in automatic zip filename, useful for non-english game names.
Increase limit of max allowed files in zip file.

v1.2

Support zRIF strings for generating work.bin file.
Add rif2zrif python script to create zRIF string.
Identify PCSD prefix as JPN region.

v1.1

Fixes wrong head.bin when it is larger than 64KB.

v1.0

First Release..

External links

GitHub - https://github.com/Yoti/pkg2zip
GitHub - https://github.com/lusid1/pkg2zip
GitHub - https://github.com/mmozeiko/pkg2zip
VitaDB - https://vitadb.rinnegatamante.it/#/info/342

@@ Line 1: / Line 1: @@
-{{#seo:
-|title=Vita Homebrew PC Tools (PC Utilities) - GameBrew!
-|title_mode=append
-|image=pkg2zipvita.jpg
-|image_alt=pkg2zip
-}}
 {{Infobox Vita Homebrews
 |title=pkg2zip
-|image=pkg2zipvita.jpg
+|image=pkg2zipvita2.png
 |description=Convert pkg files to zip ones.
-|author=mmozeiko, lusid1
+|author=Yoti, mmozeiko, lusid1
-|lastupdated=2021/05/30
+|lastupdated=2024/06/29
 |type=PC Utilities
-|version=2.3
+|version=2.6
-|license=Unlicense
+|license=Public Domain
 |download=https://dlhb.gamebrew.org/vitahomebrews/pkg2zipvita.7z
-|website=
+|website=https://github.com/lusid1/pkg2zip
-|source=https://github.com/mmozeiko/pkg2zip
+|source=https://github.com/lusid1/pkg2zip
 }}
-'''Pkg2zip''' is an utility that decrypts PlayStation Vita pkg file and creates zip package. Optionally saves NoNpDrm license into work.bin file. You must provide license key.
+{{#seo:
+|title=Vita Homebrew PC Tools (PC Utilities) - GameBrew
+|title_mode=append
+|image=pkg2zipvita2.png
+|image_alt=pkg2zip
+}}
+Pkg2zip, an utility that decrypts PlayStation Vita pkg file and creates zip package.
-== What is pkg2zip all about? ==
+Supported pkg files - main application, DLC, patch, theme and PSM files. Also supported PKG, PSX and PSP PKG files for use with [[Adrenaline Vita|Adrenaline]].
-Pkg2zip, an utility that decrypts PlayStation Vita pkg file and creates zip package. Supported pkg files - main application, DLC, patch and PSM files. Also supports PSX and PSP pkg files for use with [[Adrenaline Vita|Adrenaline]].
-Optionally writes [[Nonpdrm Vita|NoNpDrm]] or [[Nopsmdrm Vita|NoPsmDrm]] fake license file from zRIF string. You must provide license key.
+Optionally writes [[NoNpDrm Vita|NoNpDrm]] or [[NoPsmDrm Vita|NoPsmDrm]] fake license file from zRIF string. You must provide license key.
-== Requirements ==
+==Features==
-* [[Henkaku Vita|HENkaku]] / [[Enso Ex Installer Vita|enso]]
+*Portable, written in cross-platform C code, runs on Windows, GNU/Linux, macOS (system dependent functionality is isolated in sys.c file).
-* [[Nonpdrm Vita|NoNpDrm]]
+*Small, has no external library dependencies and uses very minimal dynamic memory allocations.
-* [[Nopsmdrm Vita|NoPsmDrm]] for PSM titles
+*Fast, uses AESNI hardware accelerated AES decryption if supported by CPU (requires AESNI and SSSE3 instructions).
-* [[Vitashell Vita|VitaShell]] '''v1.76''' or newer required for DLC installation
+*Simple, creates zip package with same folder structure that Vita expects (just drag & drop all file from zip archive to ux0:). Zip file is created directly from pkg without any intermediate temporary files.
-* [[Adrenaline Vita|Adrenaline]] for PSX or PSP titles
+*Vita DLC, Vita PATCH and PSM pkg unpacking.
+*PSX, PSP, PSP Updates, PSP DLC, and PSP THEME pkg unpacking.
-== Features ==
+==User guide==
-* '''portable''', written in cross-platform C code, runs on Windows, GNU/Linux, macOS (system dependent functionality is isolated in sys.c file).
+===Requirements===
-* '''small''', has no external library dependencies and uses very minimal dynamic memory allocations.
+* [https://henkaku.xyz/ HENkaku] / [https://enso.henkaku.xyz/ enso].
-* '''fast''', uses AESNI hardware accelerated AES decryption if supported by CPU (requires [https://en.wikipedia.org/wiki/AES_instruction_set AESNI] and [https://en.wikipedia.org/wiki/SSSE3 SSSE3] instructions).
+* [[NoNpDrm Vita|NoNpDrm]].
-* '''simple''', creates zip package with same folder structure that Vita expects (just drag &amp; drop all file from zip archive to ux0:). Zip file is created directly from pkg without any intermediate temporary files.
+* [[NoPsmDrm Vita|NoPsmDrm]] for PSM titles.
-* '''Vita DLC''', '''Vita PATCH''' and '''PSM''' pkg unpacking.
+* [[VitaShell]] v1.76 or newer required for DLC installation.
-* '''PSX''' and '''PSP''' pkg unpacking.
+* [[Adrenaline Vita|Adrenaline]] for PSX or PSP titles.
+* [[Npdrm free PSP|Npdrm free]] for PSP titles in eboot format.
-Limitations:
-* no PSP DLC pkg files are supported.
-* no actual title name is extracted for PSM pkg files.
-==Media==
-<youtube>4qPXqXwrY5A</youtube>
-==Screenshot==
-[[image:pkg2zipvita.jpg|600px]]
-== How To Use Pkg2zip ==
-If you have zRIF fake license, then execute:
+===How to use===
+Use the following command if you have zRIF fake license. <br>
+This will create <code>title [id] [region].zip</code> file. Title, ID and region is automatically detected from pkg file. It will include work.bin file. Example:
 <pre>pkg2zip package.pkg zRIF_STRING</pre>
-This will create <code>title [id] [region].zip</code> file. Title, ID and region is automatically detected from pkg file. It will include work.bin file.
+Omit last argument if you don't have zRIF fake license, but just want to unpack files. <br>
+Resulting zip file will not include work.bin. This is useful for patch pkg files. Example:
-If you don't have zRIF fake license, but just want to unpack files, then omit last argument:
 <pre>pkg2zip package.pkg</pre>
-Resulting zip file will not include work.bin. This is useful for patch pkg files.
+Use <code>-l</code> to get output file name of the zip (must come before pkg file and cannot be used with <code>-x</code>). Example:
-To get output file name of the zip, use <code>-l</code> (must come before pkg file and cannot be used with <code>-x</code>):
 <pre>pkg2zip -l package.pkg</pre>
-To avoid zipping process and create individual files, use <code>-x</code> argument (must come before pkg file):
+Use <code>-x</code> argument to avoid zipping process and create individual files (must come before pkg file). <br>
+PSX or PSP pkg files do not require zRIF argument. It will be ignored. Example:
 <pre>pkg2zip -x package.pkg [zRIF_STRING]</pre>
-PSX or PSP pkg files do not require zRIF argument. It will be ignored.
+For PSP files pkg2zip by default will create .ISO file.  <br>
+To create compressed .CSO file pass <code>-cN</code> argument where N is compression factor (1 for the fastest compression). Example:
-For PSP files pkg2zip by default will create .ISO file. To create compressed .CSO file pass -cN argument where N is compression factor. For example, for fastest compression use:
 <pre>pkg2zip -c1 package.pkg</pre>
-To create smaller cso file (more compression will require more time) use -c9, or anything inbetween:
+Use <code>-c9</code>, or anything inbetween to create smaller cso file (more compression will require more time). Example:
+<pre>pkg2zip -c9 package.pkg</pre>
-<pre>pkg2zip -c9 package.pkg</pre>
+You can combine <code>-cN</code> argument together with <code>-x</code>. Example:
+<pre>pkg2zip -x -c9 package.pkg</pre>
-You can combine -cN argument together with -x:
+Use the <code>-p</code> argument to extract PSP files in their original EBOOT.PBP format. Example:
+<pre>pkg2zip -p package.pkg</pre>
-<pre>pkg2zip -x -c9 package.pkg</pre>
+Note: On PSP hardware titles with DLC should be kept in ISO/CSO format due to limitations on the CFW NoDRM Engine.
 === Generating zRIF string ===
-If you have working NoNpDrm license file (work.bin or 6488b73b912a753a492e2714e9b38bc7.rif) you can create zRIF string with <code>rif2zrif.py</code> python script:
+If you have working NoNpDrm license file (work.bin or 6488b73b912a753a492e2714e9b38bc7.rif) you can create zRIF string with <code>rif2zrif.py</code> python script.<br>
+Example (it will print zRIF string to stdout):
 <pre>$ python rif2zrif.py path/to/work.bin</pre>
-It will print zRIF string to stdout.
+To generate work.bin from zRIF string use <code>zrif2rif.py</code> script.<br>
+Example (last argument is optional, it specifies where to save file and defaults to work.bin name):
-To generate work.bin from zRIF string use <code>zrif2rif.py</code> script:
+<pre>$ python zrif2rif.py zRIF work.bin</pre>
-<div class="snippet-clipboard-content notranslate position-relative overflow-auto">
+===Limitations===
+No actual title name is extracted for PSM pkg files.
-<pre>$ python zrif2rif.py zRIF work.bin</pre>
+=== Alternatives ===
+* [[Unpkg Vita|unpkg_vita]]
+* [[PkgDecrypt Vita|PkgDecrypt]]
-Last argument is optional, it specifies where to save file and defaults to work.bin name.
+==Screenshots==
+https://dlhb.gamebrew.org/vitahomebrews/pkg2zipvita3.png
-== Alternatives ==
+==Changelog==
-* [[Unpkg Vita]]
+'''v2.6'''
-* [[Pkgdecrypt Vita]]
+* enhanced pkg file support (Yoti).
+* additional languages (Yoti).
-== Compiling Pkg2zip ==
+* PSM extraction for android (LiEnby).
-Execute <code>make</code> if you are on GNU/Linux or macOS.
-On Windows you can build either with MinGW (get [http://www.msys2.org/ MinGW-w64]) or [https://www.visualstudio.com/vs/community/ Visual Studio 2017 Community Edition].
+'''v2.5''' (by Yoti)
+*Added support for more regions.
-* for MinGW make sure you have make installed, and then execute <code>mingw32-make</code>
+'''v2.4''' (by Yoti)
-* for Visual Studio run <code>build.cmd</code>
+* Added support to decrypt/extract PKG type 1.
+* Added support for KEYS.BIN for PKG type 1.
+* Added region detection for PS1 games.
+* Fixed some messages here and there.
-==Changelog==
+'''v2.3''' (by lusid1)
-'''(v.2.3 - by lusid1)'''
 * Only decrypt PSP EDAT files in ISO mode.
-* fixes PCEngine extraction in PBP mode (-p).
+* Fixes PCEngine extraction in PBP mode (-p).
-* fixes DLC compatibility in PBP mode (-p).
+* Fixes DLC compatibility in PBP mode (-p).
 * Added -d switch to force EDAT decryption
 * Merged cli improvements and other fixes from sigmaboy
-'''(v.2.2 - by lusid1)'''
+'''v2.2''' (by lusid1)
 *PSP Theme names are now used for zip file names.
-'''(v.2.1 - by lusid1)'''
+'''v2.1''' (by lusid1)
 * PSX pkg unpacking now includes keys.bin
-'''(v.2.0 - by lusid1)'''
+'''v2.0''' (by lusid1)
-* Added support for VITA Theme pkg
+* Added support for VITA Theme pkg.
-* Added support for PSP Theme pkg
+* Added support for PSP Theme pkg.
-* Added support for PSP DLC pkg
+* Added support for PSP DLC pkg.
-* Added support for pocketstation pkg
+* Added support for pocketstation pkg.
-* Added option to unpack PSP pkg to EBOOT.PBP
+* Added option to unpack PSP pkg to EBOOT.PBP.
-* Fixed CSO compression
+* Fixed CSO compression.
-* Fixed psm dev kit cert.bin extraction
+* Fixed psm dev kit cert.bin extraction.
-'''(v.1.8)'''
-*support PSP pkg file unpacking, including NeoGeo, Mini, Go, PC Engine pkg files
-*unpack PSP pkg files to ISO or CSO
-*better output with UTF-8 encoding on Windows for title names
-*show unpacking progress in percents
-'''(v.1.7)'''
-*fix issue with patch file unpacking in -x mode
-'''(v.1.6)'''
+'''v1.8''' (by mmozeiko/Mārtiņš Možeiko)
-*much faster zip file creation - depending on CPU and disk speed it is now ~2 to 3 times faster
+*Support PSP pkg file unpacking, including NeoGeo, Mini, Go, PC Engine pkg files.
-*add -x argument which makes unpacking files in extracted form - with same layout as ux0
+*Unpack PSP pkg files to ISO or CSO.
-*unpacking PSM pkg files for use with NoPsmDrm
+*Better output with UTF-8 encoding on Windows for title names.
-*unpacking PSX pkg files for use with Adrenaline
+*Show unpacking progress in percents.
-*unpacking PSP pkg files. Result is not yet directly usable on Vita - it produces EBOOT.PBP which requires to be unpacked further with different 3rd party tool
-'''(v.1.5)'''
+'''v1.7'''
-*adjust size of tail.bin - now it uses all remaining data after encrypted blob
+*Fix issue with patch file unpacking in -x mode.
-'''(v.1.4)'''
+'''v1.6'''
-*add support for DLC and PATCH pkg file unpacking
+*Much faster zip file creation - depending on CPU and disk speed it is now ~2 to 3 times faster.
-*supports unlimited amount of files inside zip file
+*Add -x argument which makes unpacking files in extracted form - with same layout as ux0.
-*fix for zip files larger than 4GB
+*Unpacking PSM pkg files for use with NoPsmDrm.
-*drop support for dummy work.bin generation (without key inside)
+*Unpacking PSX pkg files for use with Adrenaline.
-*drop support for hexkey argument to try generate work.bin
+*Unpacking PSP pkg files. Result is not yet directly usable on Vita - it produces EBOOT.PBP which requires to be unpacked further with different 3rd party tool.
-'''(v.1.3)'''
+'''v1.5'''
-*fix a bug when wrong title id was put in work.bin when generating it from raw key
+*Adjust size of tail.bin - now it uses all remaining data after encrypted blob.
-*display minimum required firmware version to run the game
-*verify integrity of zRIF before starting to unpack pkg file, and display error if it is not correct zRIF
-*allow utf-8 characters in automatic zip filename, useful for non-english game names
-*increase limit of max allowed files in zip file
-'''(v.1.2)'''
+'''v1.4'''
-*support zRIF strings for generating work.bin file
+*Add support for DLC and PATCH pkg file unpacking.
-*add rif2zrif python script to create zRIF string
+*Supports unlimited amount of files inside zip file.
-*identify PCSD prefix as JPN region
+*Fix for zip files larger than 4GB.
+*Drop support for dummy work.bin generation (without key inside).
+*Drop support for hexkey argument to try generate work.bin.
-'''(v.1.1)'''
+'''v1.3'''
-* fixes wrong head.bin when it is larger than 64KB
+*Fix a bug when wrong title id was put in work.bin when generating it from raw key.
+*Display minimum required firmware version to run the game.
+*Verify integrity of zRIF before starting to unpack pkg file, and display error if it is not correct zRIF.
+*Allow utf-8 characters in automatic zip filename, useful for non-english game names.
+*Increase limit of max allowed files in zip file.
-'''(v.1.0)'''
+'''v1.2'''
-* First Release.
+*Support zRIF strings for generating work.bin file.
+*Add rif2zrif python script to create zRIF string.
+*Identify PCSD prefix as JPN region.
-== License ==
+'''v1.1'''
-This is free and unencumbered software released into the public domain.
+* Fixes wrong head.bin when it is larger than 64KB.
-Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
+'''v1.0'''
+* First Release..
 == External links ==
-* Github - https://github.com/mmozeiko/pkg2zip
+* GitHub - https://github.com/Yoti/pkg2zip
+* GitHub - https://github.com/lusid1/pkg2zip
+* GitHub - https://github.com/mmozeiko/pkg2zip
 * VitaDB - https://vitadb.rinnegatamante.it/#/info/342