Skip to content

Latest commit

 

History

History
126 lines (102 loc) · 3.38 KB

install_manual.md

File metadata and controls

126 lines (102 loc) · 3.38 KB
Raw

Install (Linux / macOS)

Dependencies

  • ocaml >= 4.02.3 && < 4.06 / check that type value = long in the include header caml/mlvalues.h (compiled with -fPIC for amd-64)
  • cppo
  • ocamlfind
  • zarith library >=1.4
  • newspeak (https://github.com/airbus-seclab/c2newspeak)
  • python 2.7
  • pytest for tests
  • ocamldoc for the ocaml documentation generation
  • python2-sphinx for the python documentation generation
  • menhir for the configuration parsing in ocaml
  • the ocamlgraph library
  • IDA >= 6.9 (for the plugin)

Installing linux packages

All these dependencies except ida and newspeak are usually packaged by linux distributions.

on Debian Sid:
apt install ocaml menhir ocaml-findlib libzarith-ocaml-dev \
  libocamlgraph-ocaml-dev python-setuptools python-dev \
  libppx-tools-ocaml-dev ocaml-compiler-libs libppx-tools-ocaml-dev cppo
on Ubuntu 16.04:

Enable the universe repository.

apt install make python python-pip python-setuptools python-dev python-pytest \
        nasm libc6-dev-i386 gcc-multilib ocaml menhir ocaml-findlib \
        libzarith-ocaml-dev libocamlgraph-ocaml-dev libppx-tools-ocaml-dev \
        cppo

If you also want to run bincat tests, install the following packages:

  • gcc-aarch64-linux-gnu
  • gcc-arm-linux-gnueabi
  • qemu
on Archlinux:

Install packages first

pacman -S base-devel ocaml-findlib opam rsync git python2-pytest python2-sphinx

Add a symlink to caml includes:

ln -s /usr/lib/ocaml/caml /usr/include/caml

Install ocaml packages using opam

opam init --use-internal-solver
eval `opam config env`
opam install zarith ocamlgraph menhir ppx_tools cppo --use-internal-solver

If you also want to run bincat tests, install the following packages, and run the following commands:

  • aarch64-linux-gnu-gcc
  • arm-linux-gnueabihf-gcc (from AUR)
  • arm-linux-gnueabihf-gcc (from AUR)
  • qemu-arch-extra
ln -s /usr/bin/arm-linux-gnueabihf-gcc /usr/bin/arm-linux-gnueabi-gcc
ln -s /usr/bin/arm-linux-gnueabihf-as /usr/bin/arm-linux-gnueabi-as
ln -s /usr/bin/arm-linux-gnueabihf-objcopy /usr/bin/arm-linux-gnueabi-objcopy
ln -s /usr/bin/arm-linux-gnueabihf-objdump /usr/bin/arm-linux-gnueabi-objdump

These instruction have been tested from a clean chroot (pacstrap -i -c -d bincat-test base, then systemd-nspawn -b -D bincat-test).

Installing c2newspeak

git clone https://github.com/airbus-seclab/c2newspeak
cd c2newspeak
make
make install
sudo ln -s `pwd`/bin/c2newspeak /usr/bin/c2newspeak

Installing BinCAT

  1. Clone this depository and enter it
git clone https://github.com/airbus-seclab/bincat
cd bincat
  1. compilation
make
  1. installation (as a super user)
make install
  1. for the documentation (generated in directory doc)
make doc

OCaml compilation

If messages indicating that the -fPIC must be used, update your OCaml installation to 4.02.3.

Install (macOS)

Warning: the authors do not use macOS anymore, and thus do not test this procedure anymore. If you run into problems on macOS, we recommend running bincat in a linux virtual machine, or in a docker container (build procedure provided in docker/Dockerfile).

By default non initialized external symobols are not exported by ranlib. Hence some symbols in _caml_table are not exported which results in a link failure. To avoid this, run the following command:

ranlib -c /path/to/the/lib/libsasmrun.a