Metadata-Version: 2.1
Name: unblob-native
Version: 0.0.0
Summary: Performance-critical functionality for Unblob
Author-email: ONEKEY <support@onekey.com>
License: MIT License
        
        Copyright (c) 2022 ONEKEY GmbH
        
        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.
        
        --
        
        Logic for Unix Compress (unblob/handlers/compression/compress.py) is
        ported from the unlzw project
        (https://github.com/umeat/unlzw/).
        
        Original license:
        
        > Written by Brandon Owen, May 2016, brandon.owen@hotmail.com Adapted from original work by Mark Adler - orginal copyright notice below
        >
        > Copyright (C) 2014, 2015 Mark Adler This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:
        >
        >     The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
        >     Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
        >     This notice may not be removed or altered from any source distribution. Mark Adler madler@alumni.caltech.edu
        
Project-URL: homepage, https://unblob.org
Project-URL: repository, https://github.com/onekey-sec/unblob-native
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# unblob-native

Looking for Unblob? Check out at https://unblob.org.

This package holds performance-critical components of Unblob,
an _accurate, fast, and easy-to-use_ **extraction suite**. It parses
unknown binary blobs for more than 30 different _archive, compression, and
file-system formats_, **extracts** their **content recursively**, and **carves**
out **unknown chunks** that have not been accounted for.

Unblob is _free to use_, licensed with the _MIT license_. It has a
Command Line Interface and can be used as a Python library.
This turns unblob into the perfect companion for extracting, **analyzing**,
and **reverse engineering firmware images**.

## Development

This package is easiest to develop using [Nix](https://nixos.org). Refer to the
relevant section of [The Unblob Documentation](https://unblob.org/installation/#nix-package)
on how to install Nix.

Once ready, issue `nix develop`, and the required tools will be set-up for you.

The package is managed via [PDM](https://pdm.fming.dev/latest/). Just call `pdm
all`, and it will execute the required check and test steps for you. Use `pdm
run --list` to see what commands are being executed.
