stwunsch / gr-nacl

GNU Radio module for data encryption using NaCl library
Other
25 stars 8 forks source link

gr-nacl: GNU Radio data encryption module

GNU Radio module for data encryption using NaCl library

Features
The gr-nacl module for GNU Radio provides functionality from the NaCl crypto library implemented with the fork libsodium (see section 'Dependency' for more information). This contains public-key and secret-key encryption. The difference is explained, e.g., on Wikipedia [0]. The implementation is based on encryption of messages, which are passed in GNU Radio via the message system. Check out the GNU Radio documentation for further information [1]. Furthermore, a byte stream encryption method via tagged streams is implemented.

The functionality can be tested with the example flowgraphs for GNU Radio Companion at the subfolder examples/ or directly with the provided test-cases for ctest.

Install guide (Linux)
Change to any folder in your home directory and enter following commands in your terminal. Check out the section 'Dependency' first. As well, you can install GNU Radio with PyBOMBS and use the provided install recipe for gr-nacl. The recipe builds and installs the dependency automatically.

git clone https://github.com/stwunsch/gr-nacl.git // clone this repository
cd gr-nacl/
mkdir build // make build folder
cd build/
cmake ../ // build makefiles
make // build toolbox
ctest // run tests, check if all have passed, the option -V provides an extended output
sudo make install // install toolbox

Install guide (Mac OS X)
The following commands will work if you have installed Gnuradio and libsodium via Macports. Change to any folder in your home directory and enter following commands in your terminal.

git clone https://github.com/stwunsch/gr-nacl.git // clone this repository
cd gr-nacl/
mkdir build // make build folder
cd build/
cmake -DCMAKE_INSTALL_PREFIX:PATH=/opt/local ../ // build makefiles
make // build toolbox
ctest // run tests, check if all have passed, the option -V provides an extended output. This actually did not work for me
sudo make install // install toolbox

Development platform
Ubuntu 15.04
GNU Radio 3.7.6.1

Dependency
The NaCl (pronounced 'salt') crypto library [2] by Daniel J. Bernstein, Tanja Lange and Peter Schwabe has a well maintained fork called 'libsodium' [3]. Follow the instructions to build and install it.

git clone https://github.com/jedisct1/libsodium.git // clone libsodium
cd libsodium/
./autogen.sh // build libsodium
./configure
make
sudo make install // install libsodium

Contact
Stefan Wunsch
stefan.wunsch[at]student.kit.edu

Links
[0] https://en.wikipedia.org/wiki/Public-key_cryptography, https://en.wikipedia.org/wiki/Symmetric-key_algorithm
[1] http://gnuradio.org/doc/doxygen/, http://gnuradio.org/doc/doxygen/page_msg_passing.html, http://gnuradio.org/doc/doxygen/page_tagged_stream_blocks.html
[2] http://nacl.cr.yp.to/
[3] http://doc.libsodium.org/, https://github.com/jedisct1/libsodium