upk-tool 0.1.0__tar.gz

upk_tool-0.1.0/.gitignore

@@ -0,0 +1,14 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+*.egg
+dist/
+build/
+.eggs/
+*.upk
+*.pem
+.env
+.venv/
+venv/
+.idea/

upk_tool-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 UGREEN UPK Tool Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

upk_tool-0.1.0/PKG-INFO

@@ -0,0 +1,215 @@
+Metadata-Version: 2.4
+Name: upk-tool
+Version: 0.1.0
+Summary: Inspect, extract, and create UGREEN NAS .upk package files
+Project-URL: Homepage, https://github.com/fuho/upk-tool
+Project-URL: Issues, https://github.com/fuho/upk-tool/issues
+Author: UGREEN UPK Tool Contributors
+License-Expression: MIT
+License-File: LICENSE
+Keywords: firmware,nas,package,ugreen,upk
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Archiving :: Packaging
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Provides-Extra: dev
+Requires-Dist: build>=1.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: twine>=4.0; extra == 'dev'
+Provides-Extra: signing
+Requires-Dist: cryptography>=3.0; extra == 'signing'
+Description-Content-Type: text/markdown
+
+# upk-tool
+
+Inspect, extract, and create **UGREEN NAS `.upk` package files** (UGREEN-PKG-V2-FORMAT).
+
+## What is a .upk file?
+
+`.upk` files are application packages used by UGREEN NAS devices. They contain:
+
+- **Cryptographic signatures** (RSA-2048) for file integrity and authenticity
+- **Public keys** for signer and manufacturer verification
+- **App icon** (PNG)
+- **App payload** (gzip → tar → XZ → tar with app binaries, configs, web UI)
+- **Hash chain** for additional integrity verification
+
+### Format structure
+
+```
+UGREEN-PKG-V2-FORMAT
+filesig:344:<base64 RSA signature>
+userpub:392:<base64 DER public key>
+usersig:344:<base64 RSA signature>
+midpub:392:<base64 DER public key>
+midsig:344:<base64 RSA signature>
+ico:31350:<raw PNG binary>
+ugb:15608334:<gzip compressed tar>
+obj2:10204:<hex hash chain>
+```
+
+Each field follows the pattern `key:length:value` where `length` is the byte count of `value`.
+
+## Installation
+
+```bash
+pip install upk-tool
+```
+
+For signing support:
+```bash
+pip install upk-tool[signing]
+```
+
+## Usage
+
+### Inspect a .upk file
+
+```bash
+upk-tool verify firmware.upk
+```
+
+Output:
+```
+File: firmware.upk
+Fields: 8
+  filesig: 344 bytes
+  userpub: 392 bytes
+  usersig: 344 bytes
+  midpub: 392 bytes
+  midsig: 344 bytes
+  ico: 31350 bytes
+  ugb: 15608334 bytes
+  obj2: 10204 bytes
+
+  ugb contents (gzip tar): 2 entries
+    uninstall.sh (657 bytes)
+    com.ugreen.comic.ugb (15602856 bytes)
+    -> com.ugreen.comic.ugb: XZ -> tar with 64 files
+
+Signature verification:
+  filesig: 256 bytes (RSA-2048)
+  usersig: 256 bytes (RSA-2048)
+  midsig: 256 bytes (RSA-2048)
+  userpub: 294 bytes DER
+  midpub: 294 bytes DER
+```
+
+### Extract a .upk file
+
+```bash
+upk-tool extract firmware.upk -o extracted/
+```
+
+This will:
+1. Save all raw fields to the output directory
+2. Create `metadata.json` with field metadata
+3. Decompress the `ugb` payload (gzip → tar)
+4. Decompress inner `.ugb` files (XZ → tar)
+5. Extract the final app contents
+
+Directory structure:
+```
+extracted/
+├── metadata.json
+├── ico.bin
+├── ugb.bin
+└── ugb_contents/
+    ├── uninstall.sh
+    ├── com.ugreen.app.ugb
+    ├── com.ugreen.app_files.tar
+    └── com.ugreen.app_app/
+        ├── sbin/
+        │   └── my_service
+        ├── config.json
+        ├── www/
+        │   └── assets/
+        └── ...
+```
+
+### Create a .upk file
+
+```bash
+upk-tool create ./my_app/ -o my_app.upk --icon icon.png --name myapp
+```
+
+Options:
+- `--icon` - PNG icon file (optional, uses 1x1 placeholder if omitted)
+- `--name` - App name used in the package (default: `app`)
+- `--uninstall` - Custom uninstall script (optional)
+- `--user-key` - RSA private key for user signing (PEM format)
+- `--mfg-key` - RSA private key for manufacturer signing (PEM format)
+
+### Create a signed .upk file
+
+```bash
+# Generate keys (for testing)
+openssl genrsa -out user_key.pem 2048
+openssl genrsa -out mfg_key.pem 2048
+
+# Create signed package
+upk-tool create ./my_app/ \
+    -o my_app.upk \
+    --icon icon.png \
+    --name myapp \
+    --user-key user_key.pem \
+    --mfg-key mfg_key.pem
+```
+
+> **Note**: Without real UGREEN private keys, the package will have valid structure but signatures won't verify on actual hardware.
+
+## Python API
+
+```python
+from upk_tool import parse_upk, extract_upk, create_upk, verify_upk
+
+# Parse and inspect
+fields = parse_upk("firmware.upk")
+print(fields.keys())  # ['filesig', 'userpub', 'usersig', ...]
+
+# Extract
+extract_upk("firmware.upk", "output_dir/")
+
+# Create
+create_upk(
+    app_dir="./my_app/",
+    output_path="output.upk",
+    icon_path="icon.png",
+    app_name="myapp",
+)
+
+# Verify/inspect
+verify_upk("firmware.upk")
+```
+
+## Development
+
+```bash
+# Clone and install in development mode
+git clone https://github.com/anomalyco/oc_analyze_ugreen_upk_package_file.git
+cd oc_analyze_ugreen_upk_package_file
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Build package
+python -m build
+
+# Upload to PyPI
+twine upload dist/*
+```
+
+## License
+
+MIT

upk_tool-0.1.0/README.md

@@ -0,0 +1,183 @@
+# upk-tool
+
+Inspect, extract, and create **UGREEN NAS `.upk` package files** (UGREEN-PKG-V2-FORMAT).
+
+## What is a .upk file?
+
+`.upk` files are application packages used by UGREEN NAS devices. They contain:
+
+- **Cryptographic signatures** (RSA-2048) for file integrity and authenticity
+- **Public keys** for signer and manufacturer verification
+- **App icon** (PNG)
+- **App payload** (gzip → tar → XZ → tar with app binaries, configs, web UI)
+- **Hash chain** for additional integrity verification
+
+### Format structure
+
+```
+UGREEN-PKG-V2-FORMAT
+filesig:344:<base64 RSA signature>
+userpub:392:<base64 DER public key>
+usersig:344:<base64 RSA signature>
+midpub:392:<base64 DER public key>
+midsig:344:<base64 RSA signature>
+ico:31350:<raw PNG binary>
+ugb:15608334:<gzip compressed tar>
+obj2:10204:<hex hash chain>
+```
+
+Each field follows the pattern `key:length:value` where `length` is the byte count of `value`.
+
+## Installation
+
+```bash
+pip install upk-tool
+```
+
+For signing support:
+```bash
+pip install upk-tool[signing]
+```
+
+## Usage
+
+### Inspect a .upk file
+
+```bash
+upk-tool verify firmware.upk
+```
+
+Output:
+```
+File: firmware.upk
+Fields: 8
+  filesig: 344 bytes
+  userpub: 392 bytes
+  usersig: 344 bytes
+  midpub: 392 bytes
+  midsig: 344 bytes
+  ico: 31350 bytes
+  ugb: 15608334 bytes
+  obj2: 10204 bytes
+
+  ugb contents (gzip tar): 2 entries
+    uninstall.sh (657 bytes)
+    com.ugreen.comic.ugb (15602856 bytes)
+    -> com.ugreen.comic.ugb: XZ -> tar with 64 files
+
+Signature verification:
+  filesig: 256 bytes (RSA-2048)
+  usersig: 256 bytes (RSA-2048)
+  midsig: 256 bytes (RSA-2048)
+  userpub: 294 bytes DER
+  midpub: 294 bytes DER
+```
+
+### Extract a .upk file
+
+```bash
+upk-tool extract firmware.upk -o extracted/
+```
+
+This will:
+1. Save all raw fields to the output directory
+2. Create `metadata.json` with field metadata
+3. Decompress the `ugb` payload (gzip → tar)
+4. Decompress inner `.ugb` files (XZ → tar)
+5. Extract the final app contents
+
+Directory structure:
+```
+extracted/
+├── metadata.json
+├── ico.bin
+├── ugb.bin
+└── ugb_contents/
+    ├── uninstall.sh
+    ├── com.ugreen.app.ugb
+    ├── com.ugreen.app_files.tar
+    └── com.ugreen.app_app/
+        ├── sbin/
+        │   └── my_service
+        ├── config.json
+        ├── www/
+        │   └── assets/
+        └── ...
+```
+
+### Create a .upk file
+
+```bash
+upk-tool create ./my_app/ -o my_app.upk --icon icon.png --name myapp
+```
+
+Options:
+- `--icon` - PNG icon file (optional, uses 1x1 placeholder if omitted)
+- `--name` - App name used in the package (default: `app`)
+- `--uninstall` - Custom uninstall script (optional)
+- `--user-key` - RSA private key for user signing (PEM format)
+- `--mfg-key` - RSA private key for manufacturer signing (PEM format)
+
+### Create a signed .upk file
+
+```bash
+# Generate keys (for testing)
+openssl genrsa -out user_key.pem 2048
+openssl genrsa -out mfg_key.pem 2048
+
+# Create signed package
+upk-tool create ./my_app/ \
+    -o my_app.upk \
+    --icon icon.png \
+    --name myapp \
+    --user-key user_key.pem \
+    --mfg-key mfg_key.pem
+```
+
+> **Note**: Without real UGREEN private keys, the package will have valid structure but signatures won't verify on actual hardware.
+
+## Python API
+
+```python
+from upk_tool import parse_upk, extract_upk, create_upk, verify_upk
+
+# Parse and inspect
+fields = parse_upk("firmware.upk")
+print(fields.keys())  # ['filesig', 'userpub', 'usersig', ...]
+
+# Extract
+extract_upk("firmware.upk", "output_dir/")
+
+# Create
+create_upk(
+    app_dir="./my_app/",
+    output_path="output.upk",
+    icon_path="icon.png",
+    app_name="myapp",
+)
+
+# Verify/inspect
+verify_upk("firmware.upk")
+```
+
+## Development
+
+```bash
+# Clone and install in development mode
+git clone https://github.com/anomalyco/oc_analyze_ugreen_upk_package_file.git
+cd oc_analyze_ugreen_upk_package_file
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Build package
+python -m build
+
+# Upload to PyPI
+twine upload dist/*
+```
+
+## License
+
+MIT

upk_tool-0.1.0/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "upk-tool"
+version = "0.1.0"
+description = "Inspect, extract, and create UGREEN NAS .upk package files"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.8"
+authors = [
+    { name = "UGREEN UPK Tool Contributors" },
+]
+keywords = ["ugreen", "nas", "upk", "package", "firmware"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: System :: Archiving :: Packaging",
+    "Topic :: Utilities",
+]
+dependencies = []
+
+[project.optional-dependencies]
+signing = ["cryptography>=3.0"]
+dev = [
+    "pytest>=7.0",
+    "build>=1.0",
+    "twine>=4.0",
+]
+
+[project.scripts]
+upk-tool = "upk_tool.cli:main"
+upk_tool = "upk_tool.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/fuho/upk-tool"
+Issues = "https://github.com/fuho/upk-tool/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["upk_tool"]

upk_tool-0.1.0/upk_tool/__init__.py

@@ -0,0 +1,27 @@
+"""
+upk_tool - UGREEN-PKG-V2-FORMAT (.upk) packer/unpacker
+
+A tool for inspecting, extracting, and creating UGREEN NAS
+application package files (.upk).
+"""
+
+__version__ = "0.1.0"
+__author__ = "UGREEN UPK Tool Contributors"
+
+from .core import (
+    MAGIC,
+    parse_upk,
+    serialize,
+    extract_upk,
+    create_upk,
+    verify_upk,
+)
+
+__all__ = [
+    "MAGIC",
+    "parse_upk",
+    "serialize",
+    "extract_upk",
+    "create_upk",
+    "verify_upk",
+]

upk_tool-0.1.0/upk_tool/__main__.py

@@ -0,0 +1,3 @@
+from .cli import main
+
+main()

upk_tool-0.1.0/upk_tool/cli.py

@@ -0,0 +1,63 @@
+import argparse
+from .core import extract_upk, create_upk, verify_upk
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog="upk_tool",
+        description="UGREEN-PKG-V2-FORMAT (.upk) packer/unpacker",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=f"%(prog)s {_get_version()}",
+    )
+    sub = parser.add_subparsers(dest="command")
+
+    p_extract = sub.add_parser("extract", help="Extract a .upk file")
+    p_extract.add_argument("input", help="Input .upk file")
+    p_extract.add_argument(
+        "-o", "--output", default="extracted", help="Output directory (default: extracted)"
+    )
+
+    p_create = sub.add_parser("create", help="Create a .upk file")
+    p_create.add_argument("app_dir", help="Directory with app files to package")
+    p_create.add_argument(
+        "-o", "--output", default="output.upk", help="Output .upk file (default: output.upk)"
+    )
+    p_create.add_argument("--icon", help="PNG icon file")
+    p_create.add_argument("--user-key", help="User RSA private key (PEM)")
+    p_create.add_argument("--mfg-key", help="Manufacturer RSA private key (PEM)")
+    p_create.add_argument("--uninstall", help="Uninstall script")
+    p_create.add_argument("--name", default="app", help="App name (default: app)")
+
+    p_verify = sub.add_parser("verify", help="Verify/inspect a .upk file")
+    p_verify.add_argument("input", help="Input .upk file")
+
+    args = parser.parse_args()
+
+    if args.command == "extract":
+        extract_upk(args.input, args.output)
+    elif args.command == "create":
+        create_upk(
+            app_dir=args.app_dir,
+            icon_path=args.icon,
+            user_key_path=args.user_key,
+            mfg_key_path=args.mfg_key,
+            uninstall_script=args.uninstall,
+            app_name=args.name,
+            output_path=args.output,
+        )
+    elif args.command == "verify":
+        verify_upk(args.input)
+    else:
+        parser.print_help()
+
+
+def _get_version():
+    try:
+        from . import __version__
+        return __version__
+    except ImportError:
+        return "unknown"