mirror of
https://github.com/QuasarApp/LIEF.git
synced 2025-05-09 18:29:34 +00:00
6dd8b10325
* Now examples are provided in packages (SDK) * Add an examples in the doc to use 'find_packges()' with LIEF
200 lines
4.1 KiB
ReStructuredText
200 lines
4.1 KiB
ReStructuredText
Installation and Integration
|
|
============================
|
|
|
|
SDK
|
|
---
|
|
|
|
For each platform there is a SDK which contains
|
|
|
|
* Static library
|
|
* Shared library
|
|
* Headers
|
|
|
|
To install the static or shared library one have to copy them in the right folder. For instance, on Linux it would be in ``/usr/lib`` and ``/usr/include``.
|
|
|
|
|
|
Python
|
|
------
|
|
|
|
To install the Python API (example with ``Python 3.5``):
|
|
|
|
.. code-block:: console
|
|
|
|
$ pip install lief-XX.YY.ZZ_py35.tar.gz
|
|
|
|
|
|
Visual Studio Integration
|
|
-------------------------
|
|
|
|
The pre-built SDK is compiled in release configuration with the *Multi-threaded* runtime library.
|
|
|
|
As example we compile the following snippet with Visual Studio 2015
|
|
|
|
.. code-block:: cpp
|
|
|
|
#include "stdafx.h"
|
|
|
|
#include <LIEF/LIEF.hpp>
|
|
|
|
int main()
|
|
{
|
|
LIEF::PE::Binary* pe_binary = LIEF::PE::Parser::parse("C:\\Windows\\explorer.exe");
|
|
std::cout << *pe_binary << std::endl;
|
|
delete pe_binary;
|
|
return 0;
|
|
}
|
|
|
|
First the build type must be set to ``Release``:
|
|
|
|
.. figure:: _static/windows_sdk/s1.png
|
|
:align: center
|
|
|
|
Build type set to ``Release``
|
|
|
|
|
|
Then we need to specify the location of the LIEF include directory:
|
|
|
|
.. figure:: _static/windows_sdk/s2.png
|
|
:align: center
|
|
|
|
LIEF include directory
|
|
|
|
and the location of the ``LIEF.lib`` library:
|
|
|
|
|
|
.. figure:: _static/windows_sdk/s5.png
|
|
:align: center
|
|
|
|
LIEF library
|
|
|
|
As ``LIEF.lib`` was compiled with the ``\MT`` flag we have to set it:
|
|
|
|
.. figure:: _static/windows_sdk/s3.png
|
|
:align: center
|
|
|
|
*Multi-threaded* as runtime library
|
|
|
|
LIEF makes use of ``and, or, not`` C++ keywords. As **MSVC** doesn't support these keywords by default, we need to add the special file ``iso646.h``:
|
|
|
|
.. figure:: _static/windows_sdk/s4.png
|
|
:align: center
|
|
|
|
Add ``iso646.h`` file
|
|
|
|
XCode Integration
|
|
-----------------
|
|
|
|
To integrate LIEF within a XCode project, one needs to follow these steps:
|
|
|
|
First we create a new project:
|
|
|
|
.. figure:: _static/xcode_integration/step1.png
|
|
:align: center
|
|
|
|
New Project
|
|
|
|
For this example we select a *Command Line Tool*:
|
|
|
|
.. figure:: _static/xcode_integration/step2.png
|
|
:align: center
|
|
|
|
Command Line Tool
|
|
|
|
|
|
.. figure:: _static/xcode_integration/step3.png
|
|
:align: center
|
|
|
|
Project options
|
|
|
|
Then we need to add the static library ``libLIEF.a`` or the shared one (``libLIEF.dylib``)
|
|
|
|
.. figure:: _static/xcode_integration/step4.png
|
|
:align: center
|
|
|
|
Project configuration - Build Phases
|
|
|
|
|
|
.. figure:: _static/xcode_integration/step5.png
|
|
:align: center
|
|
|
|
Project configuration - Build Phases
|
|
|
|
|
|
.. figure:: _static/xcode_integration/step6.png
|
|
:align: center
|
|
|
|
Project configuration - Build Phases
|
|
|
|
In the `Build Settings - Search Paths` one needs to specify the paths to the **include directory** and to location of the LIEF libraries (``libLIEF.a`` and/or ``libLIEF.dylib``)
|
|
|
|
.. figure:: _static/xcode_integration/step7.png
|
|
:align: center
|
|
|
|
Libraries and Include search paths
|
|
|
|
Once the new project configured we can use LIEF:
|
|
|
|
|
|
.. figure:: _static/xcode_integration/code.png
|
|
:align: center
|
|
|
|
Source code
|
|
|
|
and run it:
|
|
|
|
.. figure:: _static/xcode_integration/result.png
|
|
:align: center
|
|
|
|
Output
|
|
|
|
|
|
CMake Integration
|
|
-----------------
|
|
|
|
|
|
External Project
|
|
****************
|
|
|
|
Using `CMake External Project <https://cmake.org/cmake/help/v3.0/module/ExternalProject.html>`_:
|
|
|
|
.. literalinclude:: _static/CMakeExternalProject.cmake
|
|
:language: cmake
|
|
:lines: 1-42
|
|
|
|
And now, to be integrated within a project:
|
|
|
|
.. literalinclude:: _static/CMakeExternalProject.cmake
|
|
:language: cmake
|
|
:lines: 47-
|
|
|
|
For the compilation:
|
|
|
|
.. literalinclude:: _static/ReadmeExternalProject.rst
|
|
:language: rst
|
|
:lines: 1-42
|
|
|
|
A *full* example is available in the ``examples/cmake/external_project`` directory.
|
|
|
|
|
|
find_package()
|
|
**************
|
|
|
|
Using `CMake find_package() <https://cmake.org/cmake/help/v3.0/command/find_package.html>`_:
|
|
|
|
.. literalinclude:: _static/CMakeFindPackage.cmake
|
|
:language: cmake
|
|
:lines: 5-19
|
|
|
|
And now, to be integrated within a project:
|
|
|
|
.. literalinclude:: _static/CMakeFindPackage.cmake
|
|
:language: cmake
|
|
:lines: 20-
|
|
|
|
For the compilation:
|
|
|
|
.. literalinclude:: _static/ReadmeFindPackage.rst
|
|
:language: rst
|
|
|
|
A *full* example is available in the ``examples/cmake/find_package`` directory.
|