Skip to content

Latest commit

 

History

History
263 lines (215 loc) · 8.26 KB

COMPILING.md

File metadata and controls

263 lines (215 loc) · 8.26 KB

Linux

Debian Testing and above

This program has only been tested on Debian Testing and above. It requires the following packages to be installed:

  • cmake
  • gcc (version 10 or higher)
  • g++ (version 10 or higher)
  • libboost-dev (version 1.71 or above)
  • libboost-program-options-dev
  • libncurses-dev
  • libpcap-dev
  • libpthread-stubs0-dev
  • libnl-3-dev
  • libnl-genl-3-dev
  • libnl-nf-3-dev
  • libnl-route-3-dev

Arch Linux

  • libnl
  • cmake
  • boost
  • boost-libs
  • libpcap
  • ncurses
  • ncurses5-compat-libs
  • gcc
  • libpthread-stubs

If those packages are installed, you can compile the program using the following command (from the project's root):

mkdir build && cd build && cmake .. && cmake --build . -- -j`nproc`

Windows

Ansible

There is an ansibile playbook install.yml avaiable in Resources/Ansible_Windows. The playbook needs a vaulted ssh private key to be availabe as id_rsa.vault. This script will update your computer and install all the required tools to build xlinkhandheldassistant. It will install everything in build_tools, on the root of your harddrive except for 7-zip and git, as those don't have configurable install paths using chocolatey. After the script has ran you should immediately be able to check out xlinknhandheldassistant using git, create a build folder and run in an MingW32 terminal:

cmake .. -G "MinGW Makefiles" \
-DBOOST_ROOT=/c/build_tools/boost \
-DPDCURSES_ROOT_DIR=/c/build_tools/pdcurses \
-DPCAP_ROOT_DIR=/c/build_tools/npcapsdk \
-DNPCAP_DLL_PATH=/c/build_tools/npcapsdk \
-DBUILD_X32=ON

If you are unfamiliar with ansible, information to use ansible at all can be found here:

Manually with MSYS2

Releases on Windows are compiled using MSYS2 is the only method that will be supported.

Note: Monitor mode is not available on Windows. NPcap does not support packet injection, see: nmap/npcap#85 .

The following programs are needed:

  • MSYS2 with a GCC version of atleast 10. The official releases use the MSYS2 Mingw32 Command-Line to compile XLHA. Installed in MSYS2:

    • bison
    • mingw-w64-i686-cmake
    • mingw-w64-i686-gcc
    • mingw-w64-i686-make
    • mingw-w64-i686-tools-git

  • CMake

The following libraries are needed:

  • Boost 0.7.1 or higher https://www.boost.org/users/download/ (system and program_options required Commands used (from root of boost dir (in MSYS2 MINGW32)):

    • cd tools/build

    • ./bootstrap.bat mingw

    • cp b2 ../..

    • cd ../..

    • For 64-bit:

      ./tools/build/b2.exe --build-type=minimal --toolset=gcc variant=release link=static runtime-link=static
threading=multi --with-system --with-program_options stage

      Or for 32-bit:

      ./tools/build/b2.exe --build-type=minimal --toolset=gcc variant=release link=static runtime-link=static
address-model=32 threading=multi --with-system --with-program_options stage

  • PDCurses or other ncurses compatible library (only pdcurses tested) https://github.com/Bill-Gray/PDCursesMod Commands used (from root of pdcurses dir)

    • cd wincon
    • mingw32-make -j3 WIDE=Y CHTYPE_32=Y

  • NPcap and NPcap SDK
    https://nmap.org/npcap/dist/npcap-1.60.exe
    https://nmap.org/npcap/dist/npcap-sdk-1.06.zip

After installing these, open the CMakeLists.txt and set the paths to the libraries to the paths you installed these libraries to.
By default it looks in the following paths:

  • c:\boost\
  • c:\pdcurses\
  • c:\npcapsdk\

Build using the following commands:

mkdir build 
cd build

For 64-bit:

cmake .. -G "MinGW Makefiles"

Or for 32-bit:

cmake .. -G "MinGW Makefiles" -DBUILD_X32=1

And lastly:

mingw32-make -j`nproc`

Manually with Visual Studio 2019

Support for compiling with Visual Studio will not be provided.

Note: Monitor mode is not available on Windows. NPcap does not support packet injection, see: nmap/npcap#85

The following libraries are needed:

  • Boost 0.7.1 or higher https://www.boost.org/users/download/
    • Open x86 native tools command prompt, navigate to boost folder
    • Run bootstrap.bat
    • Run .\b2.exe --build-type=minimal --toolset=msvc address-model=32 variant=debug link=static runtime-link=static threading=multi --with-system --with-program_options stage

PDCurses:

  • PDCurses 4.3.7 library https://github.com/Bill-Gray/PDCursesMod/releases/tag/v4.3.7

    • Go to pdcurses/wincon folder in x86 native tools command prompt
    • Edit Makefile.vc and add /MTd to CFLAGS on line 32
    • Run nmake -f Makefile.vc WIDE=Y CHTYPE_32=Y DEBUG=Y

  • NPcap and NPcap SDK

  • Compiling XLHA

    • Launch Visual Studio 2019
    • Open the xlinkhandheldassistant folder using the `Open a local folder' option
    • In the Solution Explorer pane right click CMakeLists.txt and select CMake Settings
    • Select the x86-Debug configuration
    • Under CMake variables set the paths for BOOST_ROOT, PCAP_ROOT_DIR and PDCURSES_ROOT_DIR
    • Make sure BUILD_STATIC and BUILD_X32 are checked
    • From the top toolbar select Project then CMake Cache then Delete Cache
    • From the top toolbar select Project then Generate Cache
    • From the top toolbar select Build then Build All

MacOS

For MacOS you need Brew and XCode. You need the following packages:

  • boost
  • ncurses
  • libpcap
  • cmake

If those packages are installed, you can compile the program using the following command (from the project's root):

mkdir build && cd build && cmake .. -G"XCode" && cmake --build . -- -j`nproc`

Then you can optionally sign the executable with the following command
(Note: you need to be in the Apple Developer Program for this or have AMFI disabled).

codesign --force --sign --deep --entitlements ./entitlements.plist -s "NAME-OF-CERT" ./xlinkhandheldassistant

And to check if that command did its job:

codesign -d --entitlements - ./xlinkhandheldassistant

After that the program should be able to run.

Building Statically

For Linux and MacOS a static build can be done by adding the following to the cmake command:
-DBUILD_STATIC=1

The libraries should be statically compiled and put in the parent folder above XLHA. Then compiling should be done in the same way as described above for your Operating System.

The Windows version is always statically compiled!

Compile instructions used for building statically

Linux

Using Docker

In Resources/Docker is a file name release-runner.Dockerfile.

  • Rename this file to Dockerfile
docker build -t xlha_release_builder ../Docker
docker run -it --name xlha_release_builder su -c /bin/bash runner
cd ~
git clone git@github.com:codedwrench/xlinkhandheldassistant.git
cd xlinkhandheldassistant
mkdir build
cd build
cmake .. -DBUILD_STATIC=1
make -j`nproc`

Manually

  • NCurses
./configure --with-terminfo-dirs="/etc/terminfo:/lib/terminfo:/usr/share/terminfo:/usr/lib/terminfo" --without-debug --enable-widec
make -j`nproc`
  • Boost
./bootstrap.sh 
./b2 link=static variant=release threading=multi runtime-link=static --with-system --with-program_options
  • LibPCAP
./configure --enable-ipv6 --disable-usb --disable-dbus --without-libnl --disable-universal
make -j`nproc`
  • LibNL
./configure
make -j`nproc`

MacOS

  • NCurses
export MACOSX_DEPLOYMENT_TARGET=10.11
./configure CFLAGS="-isysroot /path/to/MacOSX10.11.sdk -arch x86_64" CXXFLAGS="-isysroot /path/to/MacOSX10.11.sdk -arch x86_64" --with-terminfo-dirs="/etc/terminfo:/lib/terminfo:/usr/share/terminfo:/usr/lib/terminfo" --without-debug --enable-widec
make -j`nproc`
  • Boost
export MACOSX_DEPLOYMENT_TARGET=10.11
./bootstrap.sh clang
./b2 cxxflags="-stdlib=libc++ -std=c++11 -mmacosx-version-min=10.11 -isysroot /path/to/MacOSX10.11.sdk"  link=static variant=release threading=multi runtime-link=static --with-system --with-program_options
  • LibPCAP
export MACOSX_DEPLOYMENT_TARGET=10.11
./configure CFLAGS="-isysroot /path/to/MacOSX10.11.sdk -arch x86_64" CXXFLAGS="-isysroot /path/to/MacOSX10.11.sdk -arch x86_64" --enable-ipv6 --disable-usb --disable-dbus --without-libnl --disable-universal
make -j`nproc`