/pelib-updated

The updated PE file manipulation library from RetDec project.

Primary LanguageC++MIT LicenseMIT

PeLib

This is the updated PE file manipulation library, taken from RetDec

The original project by Sebastian Porst was further modified by Avast Software to:

  • Modify directory structure, i.e. split sources and headers.
  • Fix bugs.
  • Handle corrupted and exotic PE files.
  • Parse additional structures:
    • COFF symbol table.
    • Delay import directory.
    • Rich header.
    • Security directory.

Use

A single target named pelib is exposed. It can be used as follows:

target_link_libraries(project-that-needs-pelib pelib)

Requirements

  • A compiler supporting C++17
    • On Windows, only Microsoft Visual C++ is supported (Visual Studio 2019 or older).
  • CMake (version >= 3.6)

Build and Installation

  • Clone the repository or download the sources into a directory named pelib.
    • git clone https://github.com/iArtorias/pelib-updated.git
  • Linux:
    • cd pelib-updated
    • mkdir build && cd build
    • cmake ..
    • make
  • Windows:
    • Open pelib_vs2022.sln in Visual Studio 2022 (or pelib_vs2019.sln in Visual Studio 2019) and build the library or follow the instructions below
    • Open a command prompt (e.g. cmd.exe)
    • cd pelib-updated
    • mkdir build && cd build
    • cmake .. -G<generator>
    • cmake --build . --config Release -- -m
    • Alternatively, you can open pelib.sln generated by cmake.

You must pass the following parameters to cmake:

  • (Windows only) -G<generator> is -G"Visual Studio 17 2022" -A Win32 for 32-bit build using Visual Studio 2022, or -G"Visual Studio 17 2022" -A x64 for 64-bit build using Visual Studio 2022. Older versions of Visual Studio may be used (Visual Studio 16 2019 by using Visual Studio 2019).

You can pass additional parameters to cmake:

  • -DCMAKE_BUILD_TYPE=Debug to build with debugging information, which is useful during development. By default, the project is built in the Release mode. This has no effect on Windows, but the same thing can be achieved by running cmake --build . with the --config Debug parameter.

License

The original PeLib modules:

Modules added by Avast Software:

  • Copyright (c) 2017 - 2020 Avast Software, licensed under the MIT license. See the MIT_LICENSE file for more details.