Skip to content

Commit

Permalink
Merge pull request #652 from onekey-sec/update-docs
Browse files Browse the repository at this point in the history
update wiki
  • Loading branch information
qkaiser authored Sep 16, 2023
2 parents b5d14d7 + 5cc3fb2 commit 4328cb7
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 2 deletions.
32 changes: 30 additions & 2 deletions docs/formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ unblob supports more than 30 formats. You can see their code in
| ARC |||| [archive/arc.py][arc-handler] | [`unar`][arc-extractor] |
| ARJ |||| [archive/arj.py][arj-handler] | [`7z`][arj-extractor] |
| CAB |||| [archive/cab.py][cab-handler] | [`7z`][cab-extractor] |
| CPIO |||| [archive/cpio.py][cpio-handler] | [`7z`][cpio-extractor] |
| CPIO |||| [archive/cpio.py][cpio-handler] | unblob extractor |
| DMG |||| [archive/dmg.py][dmg-handler] | [`7z`][dmg-extractor] |
| RAR |||| [archive/rar.py][rar-handler] | [`unar`][rar-extractor] |
| 7ZIP |||| [archive/sevenzip.py][7zip-handler] | [`7z`][7zip-extractor] |
Expand All @@ -37,7 +37,6 @@ unblob supports more than 30 formats. You can see their code in
[cab-handler]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/archive/cab.py
[cab-extractor]: https://github.com/onekey-sec/unblob/blob/3008039881a0434deb75962e7999b7e35aca8271/unblob/handlers/archive/cab.py#L43
[cpio-handler]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/archive/cpio.py
[cpio-extractor]: https://github.com/onekey-sec/unblob/blob/3008039881a0434deb75962e7999b7e35aca8271/unblob/handlers/archive/cpio.py#L49
[dmg-handler]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/archive/dmg.py
[dmg-extractor]: https://github.com/onekey-sec/unblob/blob/3008039881a0434deb75962e7999b7e35aca8271/unblob/handlers/archive/dmg.py#L67-L69
[rar-handler]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/archive/rar.py
Expand Down Expand Up @@ -135,6 +134,35 @@ For compression formats, metadata cannot be preserved, as this information in mo
[yaffs-handler]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/filesystem/yaffs.py
[yaffs-extractor]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/filesystem/yaffs.py

## Vendors

| Format | Preserved metadata | Handler | Extractor command |
| ---------------------- | ---------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
| HP BDL || [archive/hp/bdl.py][hp-bdl] | unblob extractor |
| HP IPKG || [archive/hp/ipkg.py][hp-ipkg] | unblob extractor |
| Instar HD || [archive/instar/instar_hd.py][instar-hd] | unblob extractor |
| Instar BNEG || [archive/instar/bneg.py][instar-bneg] | unblob extractor |
| QNAP NAS || [archive/qnap/qnap_nas.py][qnap-nas] | unblob extractor |
| D-Link SHRS || [archive/dlink/encrpted_img.py][dlink-enc] | unblob extractor |
| D-Link encrpted (sic) || [archive/dlink/shrs.py][dlink-shrs] | unblob extractor |
| Engeniustech || [archive/engeniustech/engenius.py][engenius] | unblob extractor |
| Netgear TRX || [archive/netgear/trx.py][netgear-trx] | unblob extractor |
| Netgear CHK || [archive/netgear/chk.py][netgear-chk] | unblob extractor |
| Xiaomi HDR || [archive/xiaomi/hdr.py][xiaomi-hdr] | unblob extractor |


[hp-bdl]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/archive/hp/bdl.py
[hp-ipkg]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/archive/hp/ipkg.py
[instar-hd]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/archive/instar/instar_hd.py
[instar-bneg]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/archive/instar/bneg.py
[qnap-nas]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/archive/qnap/qnap_nas.py
[dlink-enc]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/archive/dlink/encrpted_img.py
[dlink-shrs]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/archive/dlink/shrs.py
[engenius]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/archive/engeniustech/engenius.py
[netgear-trx]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/archive/netgear/trx.py
[netgear-chk]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/archive/netgear/chk.py
[xiaomi-hdr]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/archive/xiaomi/hdr.py

## Didn't find your format supported yet?

unblob is easily extensible, and you can write your own handler and include your own extractors for proprietary formats.
Expand Down
9 changes: 9 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,15 @@ This might be the easiest method, depending on whether you have Python 3 install

unblob --show-external-dependencies

## Kali Linux

If you're on Kali Linux, unblob is available through the [distribution
repository](https://www.kali.org/tools/unblob/). You can install it with:

```
apt install unblob
```

## Docker image

unblob can be used right away from a `docker` image: `ghcr.io/onekey-sec/unblob:latest`,
Expand Down
3 changes: 3 additions & 0 deletions docs/publications.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@

## Demo & Workshop

- [BlackHat EU Arsenal 2023](https://www.blackhat.com/eu-23/arsenal/schedule/index.html#unblob-a-firmware-extraction-framework-35757)
- [IT-S NOW Vienna 2023](https://its-now.science/?schedule#1W13)
- [BlackHat Asia Arsenal 2023](https://www.blackhat.com/asia-23/arsenal/schedule/index.html#unblob-30358)
- [DEFCON Demo Labs 2022](https://forum.defcon.org/node/242253)
- [BlackHat USA Arsenal 2022](https://www.blackhat.com/us-22/arsenal/schedule/#unblob-26664)

Expand Down

0 comments on commit 4328cb7

Please sign in to comment.