Skip to content

Installation

Jump to bottom
Michael Messner edited this page Jul 10, 2024 · 119 revisions

We strongly recommend that you run EMBA inside a virtual machine with a current version of Kali Linux (a current Kali Linux is recommend but a Ubuntu Jammy should also work). Additionally, the default (docker) mode should be used.
WARNING: Do not use EMBA in developer mode (-D) as it can execute malicious code (e.g. s115 module) and harm your host system! Only use it if you know what you are doing.

EMBA can be run in two modes, Classic and Developer. In the classic variant, EMBA and all modules are executed inside the Docker container. Developer mode is intended to be used exclusively for development and not on a regular basis. The standard Docker variant only requires Docker and cve-search to be installed on the host (sudo ./installer.sh -d) and EMBA will install everything else in the Docker container itself during of the first run.

Prerequisites

EMBA is using a lot of other tools in the background (mostly open-source). The needed system resources depend a lot on the firmware you are going to analyse. Usually EMBA runs quite smooth in the following environment:

  • VMware running a current Kali Linux (currently we are using 2024/02) or Ubuntu:jammy (22.04 LTS)
  • Note: EMBA is only designed to run on x86-64 architecture and it is not running on ARM architecture.
  • Warning: EMBA is currently not running on other Linux Distributions without modifications. (For Ubuntu 22.10 a workaround is documented here)
  • RAM: 16GB or more
  • Processors: 8 cores minimum recommended (with 12 cores EMBA will run quite smooth)
  • The more cores your system has for EMBA, the more RAM is needed. Rule of thumb: Double the cores and you have the minimum RAM in GB -> 12 cores results in at least 24GB of RAM. If EMBA is crashing your system or your desktop environment, please check the output of dmesg for OOM messages which are indicators that your system was running out of memory.
  • For a typical installation (installer option -d), docker-compose version 1.29.x is the only tested version
  • Hard disk: 30GB-100GB of free disk space (the more the better)

If you are using a recent Kali Linux, then the installer and EMBA itself should work fine. We are currently not testing alternative Linux distributions, but feel free to test it and modify EMBA, if needed. Don't forget to open a PR with your changes!

Classic installation

To install the necessary environment, you only have to run the install script with root permissions:

sudo ./installer.sh -d

WARNING: The prepared docker image is around 14G and you need to download it in a compressed state with around 6G.

You can choose to install your own docker image, instead of the default emba docker, by using the c flag followed by the name of the container:

sudo ./installer.sh -d -c {name-of-the-container}

If this switch is not used, EMBA will download the default docker image.

You should use the -d switch with the installer to run a typical installation. This will install needed dependencies (e.g. cve-search) on the host. Additionally it will download the EMBA docker image. We recommend using this for the initial installation. The default usage of EMBA is with the protection of a Docker environment, and therefore is very easy to maintain.

Good to know:
If you are using an older distribution, it can happen that some of the installed programs (especially docker-compose) in the package sources correspond to an older version than is required for EMBA. To work around this potential problem: use a modern Debian derivative or manually update these tools.

  • To build the EMBA container manually: 
    docker-compose build emba
    (you can skip this step, then EMBA download a fresh docker image on its first run from hub.docker.com)

Random installation topics

Dependencies

EMBA uses numerous external tools, which are installed with the installer script. The applications that the installer needs to compile, parse or install are not listed here. If there are used tools missing, then please open an issue and we will add them here.

We try to keep track of all the used projects here.

System tools

The EMBA installer installs all the necessary external tools for smooth operation, but EMBA requires many system-internal tools. During our development on Kali these tools have always been on the system, and therefore are not reinstalled.

  • awk
  • basename
  • bc
  • cat
  • chmod
  • chown
  • cp
  • cut
  • date
  • dirname
  • dpkg-deb
  • echo
  • eval
  • find
  • grep
  • head
  • kill
  • ln
  • ls
  • md5sum
  • mkdir
  • mknod
  • modinfo
  • mv
  • netstat
  • printf
  • pwd
  • readelf
  • realpath
  • rm
  • rmdir
  • rpm
  • sed
  • seq
  • sleep
  • sort
  • strings
  • tee
  • touch
  • tr
  • tree
  • uniq
  • unzip
  • wc
It is possible that some tools used in EMBA have been forgotten and are not listed. If so, we are really sorry! Please send us a note and we will fix it.

EMBA - firmware security scanning at its best

Sponsor EMBA and EMBArk:

The EMBA environment is free and open source!

We put a lot of time and energy into these tools and related research to make this happen. It's now possible for you to contribute as a sponsor!

If you like EMBA you have the chance to support future development by becoming a Sponsor

Thank You ❤️ Get a Sponsor
You can also buy us some beer here ❤️ Buy me a coffee

To show your love for EMBA with nice shirts or other merch you can check our Spreadshop

EMBA - firmware security scanning at its best

Clone this wiki locally