GitLocker: The Coding Marketplace

Description:

reolinkfw 2.0.0

reolinkfw

Description
Requirements
Installation
Usage
Notes

Description
This is a tool and library to read and extract Reolink firmwares.
It supports ZIP and PAK files, local or remote.
Information is retrieved directly from the files contained inside a firmware.
It can extract:

File systems
Decompressed U-Boot
Decompressed kernel
Kernel config (some firmwares)
Devicetree source (some firmwares)

This is what powers the
firmware archive
where you can also find
details
about all of the firmwares it lists without having to install the tool yourself.
Requirements

Python 3.9+
python-lzo

Installation
pip install -i https://test.pypi.org/simple/ python-lzo
pip install reolinkfw

python-lzo doesn't have wheels on PyPI for Linux and for Python 3.9+ on macOS yet.
A PR has been merged to provide
wheels for all version on all platforms but there needs to be a new release first.
In the meantime you can install wheels from
TestPyPI as shown above.

[!IMPORTANT]
No Python 3.12 wheels exist yet for lz4. To build it from source see
here.

Usage
Command line
Info
usage: reolinkfw info [-h] [--no-cache] [-j [indent]] file_or_url

positional arguments:
file_or_url URL or on-disk file

options:
-h, --help show this help message and exit
--no-cache don't use cache for remote files (URLs)
-j [indent], --json [indent] JSON output with optional indentation level for pretty print

Example:
$ reolinkfw info RLC-410-5MP_20_20052300.zip
IPC_51516M5M.20_20052300.RLC-410-5MP.OV05A10.5MP.REOLINK.pak
Model: RLC-410-5MP
Hardware info: IPC_51516M5M
Device type: IPC
Firmware version: v3.0.0.20_20052300
Build date: 2020-05-23
Architecture: MIPS
OS: Linux
Kernel image name: Linux-4.1.0
Linux banner: Linux version 4.1.0 (lwy@ubuntu) (gcc version 4.9.3 (Buildroot 2015.11.1-00003-gfd1edb1) ) #1 PREEMPT Tue Feb 26 18:19:48 CST 2019
U-Boot version: U-Boot 2014.07 (Feb 26 2019 - 18:20:07)
U-Boot compiler: mipsel-24kec-linux-uclibc-gcc.br_real (Buildroot 2015.11.1-00003-gfd1edb1) 4.9.3
U-Boot linker: GNU ld (GNU Binutils) 2.24
File system: squashfs
File system sections: fs
Board vendor: Novatek
Board: Novatek NA51023 evaluation board

Or with JSON output:
$ reolinkfw info RLC-410-5MP_20_20052300.zip -j 2
[
{
"firmware_version_prefix": "v3.0.0",
"board_type": "IPC_51516M5M",
"board_name": "IPC_51516M5M",
"build_date": "200523",
"display_type_info": "RLC-410-5MP",
"detail_machine_type": "IPC_51516M5M",
"type": "IPC",
"version_file": "20_20052300",
"os": "Linux",
"architecture": "MIPS",
"kernel_image_name": "Linux-4.1.0",
"uboot_version": "U-Boot 2014.07 (Feb 26 2019 - 18:20:07)",
"uboot_compiler": "mipsel-24kec-linux-uclibc-gcc.br_real (Buildroot 2015.11.1-00003-gfd1edb1) 4.9.3",
"uboot_linker": "GNU ld (GNU Binutils) 2.24",
"linux_banner": "Linux version 4.1.0 (lwy@ubuntu) (gcc version 4.9.3 (Buildroot 2015.11.1-00003-gfd1edb1) ) #1 PREEMPT Tue Feb 26 18:19:48 CST 2019",
"board": "Novatek NA51023 evaluation board",
"board_vendor": "Novatek",
"filesystems": [
{
"name": "fs",
"type": "squashfs"
}
],
"sha256": "6ef371a51b61d7b21d8f7016d90b5fc1ed3eaa8a3f30f1e202a3474bfb4807e5",
"file": "RLC-410-5MP_20_20052300.zip",
"pak": "IPC_51516M5M.20_20052300.RLC-410-5MP.OV05A10.5MP.REOLINK.pak"
}
]

file is the given argument, a file or URL. The value of pak depends on the
argument. If it's a local or remote ZIP file it will be the path of the PAK file
inside it. If it's a remote PAK file, it will be the value of the name query
parameter or None if not found. And finally for a local PAK file it will be
the file name.
Extract
usage: reolinkfw extract [-h] [--no-cache] [-d DEST] [-f] file_or_url

Extract the file system and a few other files from a Reolink firmware

positional arguments:
file_or_url URL or on-disk file

options:
-h, --help show this help message and exit
--no-cache don't use cache for remote files (URLs)
-d DEST, --dest DEST destination directory. Default: current directory
-f, --force overwrite existing files. Does not apply to UBIFS. Default: False

A firmware's file system can be laid out in two different ways inside a PAK file:

In a single section named fs or rootfs containing the whole file system
In two sections with the second one named app containing the files that go in /mnt/app

In the second case, the contents of app will be extracted to the appropriate
location so that the files are organized the same way as they are when the
camera is running.
Consider the result of this command a one-way operation.
You should not use it to repack a custom firmware.
As a library
import asyncio
from reolinkfw import ReolinkFirmware, firmware_info

async def main():
url = "https://reolink-storage.s3.amazonaws.com/website/firmware/20200523firmware/RLC-410-5MP_20_20052300.zip"
print(await firmware_info(url))
pak = "/home/ben/RLC-410-5MP_20_20052300.pak"
with ReolinkFirmware.from_file(pak) as fw:
print(await fw.get_info())
fw.extract()

asyncio.run(main())

In most cases where a URL is used, it will be a direct link to the file
(meaning if you were to open it in a browser, the download would start).
But in some cases (for example beta firmwares) Reolink gives a Google Drive or
a bit.ly link (that redirects to a Google Drive link).
These URLs are automatically handled so that you don't have to figure out the
"real" download link, and in this case the file value(s) in the result JSON
will not be the link that you gave but the direct download one.
However the Google Drive folder links (drive.google.com/drive/folders) are not
handled and in these cases you must find the real URL, or you can also download
the file.
Notes
There are 3 types of file systems used for Reolink firmwares:

cramfs (handled by pycramfs)
squashfs (handled by PySquashfsImage)
UBIFS (handled by ubi_reader)

Some ZIP files provided by Reolink contain multiple PAKs. This is why
firmware_info always returns a list.
Here's a map of vendors to hardware versions:
Cameras:

MStar/SigmaStar: IPC_30, IPC_32, IPC_MS
Grain Media: IPC_35, IPC_36, IPC_38
Novatek: DB_56, FE_52, IPC_51, IPC_52, IPC_56, IPC_NT

NVRs:

Novatek: hardware version is H3MB18 or starts with N
HiSilicon: hardware version starts with H (except H3MB18)

Grain Media was
transferred
to Novatek around 2017.