Metadata-Version: 2.1
Name: lief
Version: 0.11.5
Summary: Library to instrument executable formats
Home-page: https://github.com/lief-project/LIEF
Author: Romain Thomas
Author-email: rthomas@quarkslab.com
License: Apache License 2.0
Project-URL: Documentation, https://lief.quarkslab.com/doc/latest
Project-URL: Funding, https://lief.quarkslab.com/about
Project-URL: Source, https://github.com/lief-project/LIEF/
Project-URL: Tracker, https://github.com/lief-project/LIEF/issues
Description: About
        =====
        
        The purpose of this project is to provide a cross platform library which can parse, modify and abstract ELF, PE and MachO formats.
        
        Main features:
        
          * **Parsing**: LIEF can parse ELF, PE, MachO, OAT, DEX, VDEX, ART and provides an user-friendly API to access to format internals.
          * **Modify**: LIEF enables to modify some parts of these formats
          * **Abstract**: Three formats have common features like sections, symbols, entry point... LIEF factors them.
          * **API**: LIEF can be used in C, C++ and Python
        
        
        Downloads / Install
        ===================
        
        First, make sure to have an updated version of setuptools:
        
        .. code-block:: console
        
           $ pip install setuptools --upgrade
        
        To install the latest **version** (release):
        
        .. code-block:: console
        
           $ pip install lief
        
        To install nightlty build:
        
        .. code-block:: console
        
           $ pip install [--user] --index-url  https://lief-project.github.io/packages lief
        
        
        Getting started
        ===============
        
        Python
        ------
        
        .. code-block:: python
        
          import lief
        
          # ELF
          binary = lief.parse("/usr/bin/ls")
          print(binary)
        
          # PE
          binary = lief.parse("C:\\Windows\\explorer.exe")
          print(binary)
        
          # Mach-O
          binary = lief.parse("/usr/bin/ls")
          print(binary)
        
        C++
        ---
        
        .. code-block:: cpp
        
          #include <LIEF/LIEF.hpp>
        
          int main(int argc, char** argv) {
            // ELF
            try {
              std::unique_ptr<LIEF::ELF::Binary> elf = LIEF::ELF::Parser::parse("/bin/ls");
              std::cout << *elf << std::endl;
            } catch (const LIEF::exception& err) {
              std::cerr << err.what() << std::endl;
            }
        
            // PE
            try {
              std::unique_ptr<LIEF::PE::Binary> pe = LIEF::PE::Parser::parse("C:\\Windows\\explorer.exe");
              std::cout << *pe << std::endl;
            } catch (const LIEF::exception& err) {
              std::cerr << err.what() << std::endl;
            }
        
            // Mach-O
            try {
              std::unique_ptr<LIEF::MachO::FatBinary> macho = LIEF::MachO::Parser::parse("/bin/ls");
              std::cout << *macho << std::endl;
            } catch (const LIEF::exception& err) {
              std::cerr << err.what() << std::endl;
            }
        
            return 0;
          }
        
        C (Limited API)
        ----------------
        
        .. code-block:: cpp
        
          #include <LIEF/LIEF.h>
        
          int main(int argc, char** argv) {
            Elf_Binary_t* elf = elf_parse("/usr/bin/ls");
        
            Elf_Section_t** sections = elf->sections;
        
            for (size_t i = 0; sections[i] != NULL; ++i) {
              printf("%s\n", sections[i]->name);
            }
        
            elf_binary_destroy(elf);
            return 0;
          }
        
        Documentation
        =============
        
        * `Main documentation <https://lief.quarkslab.com/doc/latest/index.html>`_
        * `Tutorial <https://lief.quarkslab.com/doc/latest/tutorials/index.html>`_
        * `API <https://lief.quarkslab.com/doc/latest/api/index.html>`_
        * `Doxygen <https://lief.quarkslab.com/doc/latest/doxygen/index.html>`_
        
        Contact
        =======
        
        * **Mail**: lief at quarkslab com
        * **Gitter**: `lief-project <https://gitter.im/lief-project>`_
        
        
        Authors
        =======
        
        Romain Thomas `@rh0main <https://twitter.com/rh0main>`_ - `Quarkslab <https://www.quarkslab.com>`_
        
        ----
        
        LIEF is provided under the `Apache 2.0 license <https://github.com/lief-project/LIEF/blob/0.10.1/LICENSE>`_
        
Keywords: parser,elf,pe,macho,reverse-engineering
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: C++
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.6
Description-Content-Type: text/x-rst; charset=UTF-8