edgesec defines a new architecture and toolset for edge based routers addressing fundamental security weaknesses that impact current IP and IoT router implementations.

For more information, please see the edgesec website: https://edgesec.info

On Debian/Ubuntu, build dependencies are listed in the debian/control file.

You can use mk-build-deps to automatically install these build-dependencies.

sudo apt install devscripts # install mk-build-depends
sudo mk-build-deps --install debian/control

Compiling edgesec is done with CMake.

If you have CMake v3.22+, you can use the following cmake-presets to compile edgesec:

cmake --preset linux # configure edgesec for Linux
cmake --build --preset linux -j4 # build edgesec for Linux using 4 threads
ctest --preset linux # test edgesec for Linux

A useful one-liner is the following, which given a preset, automatically configures, compiles (using all cores, but nice -n19 for lower CPU priority), tests (if a test config exists), then installs into the ./tmp folder.

export PRESET=linux; cmake --preset "$PRESET" && nice -n19 cmake --build --preset "$PRESET" -j=$(nproc) && ( ctest --list-presets | grep "\"$PRESET\"" ) && ctest --preset "$PRESET"; cmake --install "./build/$PRESET" --prefix "./tmp/$PRESET"

For older versions of CMake, or for manual configuration, please see the next headings for more details.

Configure cmake in the build/ directory by running the following:

# or for old versions of cmake, do: mkdir build/ && cd build/ && cmake ..
cmake -S . -B build

The configure stage will download some of the edgesec dependencies, so this may take a while.

To build, you can then run:

# or for old versions of cmake, do: cd build/ && make
cmake --build build/

or to built on multiple core run:

cmake --build build/ -j4

-j4 means 4 jobs/threads, replace 4 with the amount of cores you want to use, equivalent to make -j4.

After succesful compilation the binary will be located in ./build/src folder.

To run edgesec tool with the configuration file dev-config.ini located in ./build folder use:

./build/src/edgesec -c ./build/dev-config.ini

To enable verbose debug mode use:

./build/src/edgesec -c ./build/dev-config.ini -ddddd

The following commands also work using the podman container runtime (recommended on Linux):

alias docker=podman

In config.mak change the TARGET key to the desired architecture (see details https://github.com/richfelker/musl-cross-make):

• aarch64[_be]-linux-musl
• arm[eb]-linux-musleabi[hf]
• i*86-linux-musl
• microblaze[el]-linux-musl
• mips-linux-musl
• mips[el]-linux-musl[sf]
• mips64[el]-linux-musl[n32][sf]
• powerpc-linux-musl[sf]
• powerpc64[le]-linux-musl
• riscv64-linux-musl
• s390x-linux-musl
• sh*[eb]-linux-musl[fdpic][sf]
• x86_64-linux-musl[x32]

Set MUSL_VER key to the platform MUSL library version. Use

ldd --version

to find the MUSL library version x.y.z.

Using the container name openwrt build the docker container using the command:

docker build -t openwrt .

To build EDGESec in the docker container, go back to the root of the Git Repo, and run.

# in root of git repo (where the `CMakePresets.json` file is)
docker run --rm --volume "$PWD":/opt/EDGESec --workdir /opt/EDGESec openwrt cmake --preset openwrt/default

To compile using cmake (on 4 cores)

docker run --rm --volume "$PWD":/opt/EDGESec --workdir /opt/EDGESec openwrt cmake --build --preset openwrt/default -j4

Afterwards, you'll find the compiled binaries in the build/openwrt/default folder.

To compile the tests use:

cmake -B build/ -S . # configure CMAKE
cmake --build build/ -j4 # or make -j4
cmake --build build/ --target test -j4 # or 'make test'

To run each test individually, the test binaries can be located in ./build/tests folder.

To compile the docs from ./build folder:

make doxydocs

See ./docs for how to build the developer doxygen documentation website.