UPLOAD
This commit is contained in:
Mike
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2017 Willem Hengeveld <itsme@xs4all.nl>
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,129 @@
|
||||
UBIFS Dumper
|
||||
============
|
||||
|
||||
This tool can be used to view or extract the contents of UBIFS images.
|
||||
|
||||
About UBIFS
|
||||
===========
|
||||
|
||||
UBIFS is a filesystem specifically designed for used on NAND flash chips.
|
||||
NAND flash is organized in _eraseblocks_. _Eraseblocks_ can be erased,
|
||||
appended to, and read. Erasing is a relatively expensive operation, and can
|
||||
be done only a limited number of times.
|
||||
|
||||
An UBIFS image contains four abstraction layers:
|
||||
* eraseblocks
|
||||
* volumes
|
||||
* b-tree nodes
|
||||
* inodes
|
||||
|
||||
Each eraseblock contains info on how often it has been erased, and which volume it belongs to.
|
||||
A volume contains a b-tree database with keys for:
|
||||
* inodes, indexed by inode number
|
||||
* direntries, indexed by inode number + name hash
|
||||
* datablocks, indexed by inode number + block number
|
||||
|
||||
The inodes are basically a standard unix filesystem, with direntries, regular files, symlinks, devices, etc.
|
||||
|
||||
mounting images on linux
|
||||
------------------------
|
||||
|
||||
modprobe nandsim first_id_byte=0x2c second_id_byte=0xac third_id_byte=0x90 fourth_id_byte=0x26
|
||||
nandwrite /dev/mtd0 firmware-image.ubi
|
||||
modprobe ubi mtd=/dev/mtd0,4096
|
||||
mount -t ubifs -o ro /dev/ubi0_0 mnt
|
||||
|
||||
This will mount a ubi image for a device with eraseblock size 0x40000.
|
||||
If your image has a blocksize of 0x20000, use `fourth_id_byte=0x15`, and specify a pagesize of `2048`
|
||||
with the second modprobe line.
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
View the contents of the `/etc/passwd` file in the filesystem image `image.ubi`:
|
||||
|
||||
python ubidump.py -c /etc/passwd image.ubi
|
||||
|
||||
List the files in all the volumes in `image.ubi`:
|
||||
|
||||
python ubidump.py -l image.ubi
|
||||
|
||||
View the contents of b-tree database from the volumes in `image.ubi`:
|
||||
|
||||
python ubidump.py -d image.ubi
|
||||
|
||||
Extract an unsupported volume type, so you can analyze it with other tools:
|
||||
|
||||
python ubidump.py -v 0 --saveraw unknownvol.bin image.ubi
|
||||
|
||||
Note that often ubi images contain squashfs volumes, which can be extracted using tools like
|
||||
[unsquashfs](https://github.com/plougher/squashfs-tools) or [rdsquashfs](https://github.com/AgentD/squashfs-tools-ng)
|
||||
|
||||
Install
|
||||
=======
|
||||
|
||||
Install the required python modules using:
|
||||
|
||||
pip install -r requirements.txt
|
||||
|
||||
or as a pip package:
|
||||
|
||||
pip install ubidump
|
||||
|
||||
You may need to manually install your operarating system libraries for lzo first:
|
||||
|
||||
on linux:
|
||||
|
||||
apt install liblzo2-dev
|
||||
|
||||
on MacOS:
|
||||
|
||||
brew install lzo
|
||||
|
||||
maybe you need to build the python library like this:
|
||||
|
||||
LDFLAGS=-L/usr/local/lib CFLAGS=-I/usr/local/include/lzo pip3 install python-lzo
|
||||
|
||||
|
||||
When you need zstd compression, you will need to install the `zstandard` module.
|
||||
|
||||
|
||||
Dependencies
|
||||
============
|
||||
|
||||
* python2 or python3
|
||||
* python-lzo ( >= 1.09, which introduces the 'header=False' argument )
|
||||
* crcmod
|
||||
* optional: zstandard
|
||||
|
||||
TODO
|
||||
====
|
||||
|
||||
* add option to select a volume
|
||||
* add option to select a older `master` node
|
||||
* parse the journal
|
||||
* analyze b-tree structure for unused nodes
|
||||
* analyze fs structure for unused inodes, dirents
|
||||
* verify that data block size equals the size mentioned in the inode.
|
||||
* add support for ubifs ( without the ubi layer )
|
||||
* add option to extract a raw volume.
|
||||
|
||||
References
|
||||
==========
|
||||
|
||||
* the ubifs/mtd tools http://linux-mtd.infradead.org/
|
||||
* git repos can be found [here](http://git.infradead.org/)
|
||||
|
||||
Similar tools
|
||||
=============
|
||||
|
||||
* another python tool [on github](https://github.com/jrspruitt/ubi_reader/)
|
||||
* does not support listing files.
|
||||
* a closed source windows tool [here](http://ubidump.oozoon.de/)
|
||||
* ubi-utils/ubidump.c [on the mtd mailinglist](http://lists.infradead.org/pipermail/linux-mtd/2014-July/054547.html)
|
||||
|
||||
Author
|
||||
======
|
||||
|
||||
Willem Hengeveld <itsme@xs4all.nl>
|
||||
|
||||
@@ -0,0 +1,2 @@
|
||||
python-lzo>=1.11
|
||||
crcmod>=1.7
|
||||
@@ -0,0 +1,48 @@
|
||||
from setuptools import setup
|
||||
setup(
|
||||
name = "ubidump",
|
||||
version = "1.0.0",
|
||||
entry_points = {
|
||||
'console_scripts': ['ubidump=ubidump:main'],
|
||||
},
|
||||
install_requires=[
|
||||
"python-lzo>=1.11",
|
||||
"crcmod>=1.7",
|
||||
],
|
||||
py_modules=['ubidump'],
|
||||
author = "Willem Hengeveld",
|
||||
author_email = "itsme@xs4all.nl",
|
||||
description = "Commandline tool for viewing or extracting UBIFS images.",
|
||||
long_description="""
|
||||
This tool can be used to view or extract the contents of UBIFS images.
|
||||
|
||||
View the contents of the `/etc/passwd` file in the filesystem image `image.ubi`:
|
||||
|
||||
ubidump -c /etc/passwd image.ubi
|
||||
|
||||
List the files in all the volumes in `image.ubi`:
|
||||
|
||||
ubidump -l image.ubi
|
||||
|
||||
View the contents of b-tree database from the volumes in `image.ubi`:
|
||||
|
||||
ubidump -d image.ubi
|
||||
""",
|
||||
|
||||
license = "MIT",
|
||||
keywords = "ubifs commandline",
|
||||
url = "https://github.com/nlitsme/ubidump/",
|
||||
classifiers = [
|
||||
'Environment :: Console',
|
||||
'Intended Audience :: End Users/Desktop',
|
||||
'Intended Audience :: Developers',
|
||||
'License :: OSI Approved :: MIT License',
|
||||
'Operating System :: OS Independent',
|
||||
'Programming Language :: Python :: 2',
|
||||
'Programming Language :: Python :: 3',
|
||||
'Topic :: Utilities',
|
||||
'Topic :: Software Development :: Version Control :: Git',
|
||||
'Topic :: System :: Filesystems',
|
||||
],
|
||||
)
|
||||
|
||||
Executable
+1812
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user