Project

General

Profile

Click here for a shortcut to the AIT QKD R10 Documentation.

Introduction

Since SECOQC AIT has made the QKD software available to various universities and working groups in the field. After years of development we moved the development facility of the AIT-QKD-software to a public site from which anyone can download the software sources and participate in the software development: http://git-service.ait.ac.at/quantum-cryptography/qkd

The present sources are significant further development beyond the former AIT QKD Developer Snapshot and add new features and tools to the whole suite.

The QKD-software presented now includes the following sources that constitute a complete package needed to realize a QKD point-to-point connection (QKD Link) and its integration in a trusted-repeater QKD Network:

  • Full QKD protocol stack including
    • Sifting
    • Error correction: Cascade
    • Privacy amplification
    • Authentication
  • QKD-link simulator
  • Overall communication between Alice and Bob
The following features are also included:
  • Easy and well defined interfaces between the modules
  • Interface to the QKD-link simulator as well as the
  • Interface to the QKD-network with SECOQC-type key-stores
  • Internal monitoring on dbus
Typical use cases of the software are:
  • Simulation of QKD-links including losses and detector imperfections on a single PC
  • Emulation of QKD-links in the framework of a communication network
  • Performance monitoring of user-written reconciliation software in a reproducible QKD environment
  • QKD-network simulation including key management

These use cases can directly be used in the education of Bachelor and Master Students.

Preamble

The AIT QKD R10 Software as hosted here is work in progress. This said, some features are not working currently or have been deliberately turned off due to bugs.

Among these are:

  • The Q3P encryption and authentication is currently turned off.
  • The Q3P protocol is not fully implemented yet.
  • The IPSec implementation - though present - is not yet fully included.
  • The QKD Module Manager (in the tools section) is not fully implemented.
  • The documentation is slightly out of date.

Content

The whole project compiles in one single step, meaning no subprojects. This results in a single package for deployment for ease of installation and upgrade. The structure is:

qkd
+-- bin                                             all executable programs
|   +-- modules                                         all QKD post processing modules
|   |   +-- qkd-auth                                        authentication module
|   |   +-- qkd-bb84                                        BB84 module
|   |   +-- qkd-buffer                                      bufferinge module, keypool
|   |   +-- qkd-cascade                                     cascade error correction
|   |   +-- qkd-cat                                         load a keystream from a file and feed the pipeline
|   |   +-- qkd-confirmation                                confirmation module
|   |   +-- qkd-debug                                       print keystream meta data to stderr
|   |   +-- qkd-dekey                                       remove metadate from a keytream (turns keystream to BLOB)
|   |   +-- qkd-drop                                        randomly dropping keys on one side (development module)
|   |   +-- qkd-enkey                                       add metadate to a BLOB (turns BLOB to keystream)
|   |   +-- qkd-error-estimation                            error estimation module
|   |   +-- qkd-ping                                        touch remote peer module (administration module)
|   |   +-- qkd-privacy-amplification                       privacy amplification module
|   |   +-- qkd-reorder                                     randomly reorder keys in a keystream (development module)
|   |   +-- qkd-tee                                         fork keystream to stderr and the next module
|   |   +-- qkd-throttle                                    throttle key stream on bits/keys per second (development module)
|   +-- q3pd                                            The Q3P node
|   +-- tools                                           tools
|       +-- q3p-inject                                      Feed a Q3P node with keys, BASH-Script
|       +-- q3p-keystore-dump                               dump content of Q3P database human readable on stdout
|       +-- q3p-mq-reader                                   read qkd Q3P message queue
|       +-- qkd-blob-keystream                              wrapper around qkd-enkey, BASH-Script
|       +-- qkd-key-dump                                    dump a keystream file human readable to stdout
|       +-- qkd-key-gen                                     create pairs of pseudo random input keys
|       +-- qkd-module-manager                              GUI for qkd post processing
|       +-- qkd-pipeline                                    high level qkd post processing admin (start/stop pipeline)
|       +-- qkd-simulate                                    GUI with simulating quantum events continuously 
|       +-- qkd-view                                        dump current status of all qkd objects of the system to stdout
+-- cmake                                           cmake relevant build details
+-- doc                                             documentation
|   +-- handbook                                        AIT QKD Handbook (OUTDATED)
|   +-- simulator                                       QKD Simulator
+-- etc                                             system configuration for installment
+-- examples                                        examples
|   +-- module-1                                        "Hello World!" qkd module
|   +-- module-2                                        continuative example
|   +-- module-3                                        continuative example
|   +-- module-4                                        continuative example
|   +-- module-5                                        complex example incl. DBus
+-- include                                         header files
+-- lib                                             libqkd (QKD Module Framework / Q3P Links / etc.)  <--- !! THIS IS THE CORE !! --->
+-- share                                           shared files (like graphics)
|   +-- qkd-module-manager                              graphic files for qkd module manager
|   +-- qkd-simulate                                    graphic files for qkd simulator
+-- test                                            test-cases to check build integrity (these are also samples on how to work with the source)

Compilation

Preperation

In order to compile the QKD sources we need at least the developer versions of:

  • gcc and g++ at least version 4.8
  • boost at least version 1.49 (better 1.55.0)
  • OpenSSL
  • UUID
  • CMake
  • GMP
  • 0MQ (Zero Message Queue) version 2.2 (NOT version 3)
  • Qt4 at least version 4.4
  • Qwt (Qt Widgets for Technical Applications)
  • Doxygen

Here are the steps which help you to setup a build system capable of compiling the sources on a pure Debian Wheezy/Jessie system.

$ sudo apt-get install \
        build-essential \
        g++ \
        gcc \
        libboost-all-dev \
        libssl-dev \
        uuid-dev \
        cmake \
        libssl-dev \
        uuid-dev \
        libgmp3-dev \
        libzmq-dev \
        libdbus-1-dev \
        libqt4-dev \
        libqwt-dev \
        doxygen \
        texlive-latex-base \
        texlive-latex-extra \
        texlive-font-utils \
        dbus-x11 \
        libcap2-bin

To clone the sources from the AIT servers:

$ sudo apt-get install git
...
$ git clone http://git-service.ait.ac.at/quantum-cryptography/qkd.git

Building

Step into the "build" folder, invoke cmake and then make.

$ mkdir build
$ cd build
$ cmake ..
$ make

Test

Once you've run successful the "make" command you are enabled to run tests at your disposal. To do so switch into the build folder again.

$ cd build
$ make test

This will run a series of tests to check the sanity of the qkd system built. If one or more test failed then this is a good indicator that something has gone awry. Please consult the AIT with the output of the command for support.

Packaging

After a successful build, you might as well create DEB packages for install on various Debian or Debian-based systems.

$ cd build
$ make package

This will create a package `qkd_9.9999.3_amd64.deb` (or with the current version number embedded) in the current build folder.

Package install

If you are a registered user then you have the ability to install the AIT QKD package directly from our repositories. Check Installation for more details.

Despite a normal Debian Wheezy/Jessie implementation you'll need:

$ sudo apt-get install dbus

which is normally already installed on modern Linux distributions.

If you have built the debian package on the target system then a

$ sudo dpkg --install qkd_9.9999.3_amd64.deb 

will be sufficient.

However, if you lack certain packages and get error messages like these

$ sudo dpkg --install qkd_9.9999.3_amd64.deb 
Selecting previously unselected package qkd.
(Reading database ... 40364 files and directories currently installed.)
Unpacking qkd (from qkd_9.9999.3_amd64.deb) ...
dpkg: dependency problems prevent configuration of qkd:
 qkd depends on libboost-filesystem1.49.0 (>= 1.49.0); however:
  Package libboost-filesystem1.49.0 is not installed.
 qkd depends on libboost-program-options1.49.0 (>= 1.49.0); however:
  Package libboost-program-options1.49.0 is not installed.
 qkd depends on libboost-system1.49.0 (>= 1.49.0); however:
  Package libboost-system1.49.0 is not installed.
 qkd depends on libzmq1; however:
  Package libzmq1 is not installed.
 qkd depends on libqtgui4; however:
  Package libqtgui4 is not installed.
 qkd depends on libqtdbus4; however:
  Package libqtdbus4 is not installed.
 qkd depends on libqt4-network; however:
  Package libqt4-network is not installed.
 qkd depends on libqwt6; however:
  Package libqwt6 is not installed.
 qkd depends on libcap2-bin; however:
  Package libcap2-bin is not installed.

dpkg: error processing qkd (--install):
 dependency problems - leaving unconfigured
Errors were encountered while processing:
 qkd

then you can still go on with installment by issuing

$ sudo apt-get -f install

Configuration

The installation will deploy sample configuration scripts in /etc/qkd and /etc/q3p. Also a new system group qkd will be present.

NOTE: In order to access the configuration files you either have to be root (discouraged) or your user has to be part of the qkd group.

Finally an environment variable QKD_DBUS_SESSION_ADDRESS holds the address of the QKD dedicated system wide DBus server.

For more details on configuration please consult Configuration.

Next Steps

Now that you have installed the QKD R10 and maybe checked the configuration, you might want

Known Issues

locale

If you come along such messages:

$ make
[  0%] Doxygen running ...
perl: warning: Setting locale failed.
perl: warning: Please check that your locale settings:
        LANGUAGE = "en_US:en",
        LC_ALL = "",
        LC_TIME = "de_AT.UTF-8",
        LC_MONETARY = "de_AT.UTF-8",
        LC_ADDRESS = "de_AT.UTF-8",
        LC_TELEPHONE = "de_AT.UTF-8",
        LC_NAME = "de_AT.UTF-8",
        LC_MEASUREMENT = "de_AT.UTF-8",
        LC_IDENTIFICATION = "de_AT.UTF-8",
        LC_NUMERIC = "de_AT.UTF-8",
        LC_PAPER = "de_AT.UTF-8",
        LANG = "" 
    are supported and installed on your system.
perl: warning: Falling back to the standard locale ("C").

or

$ locale
locale: Cannot set LC_ALL to default locale: No such file or directory
LANG=en_US.UTF-8
LANGUAGE=en_US:en
LC_CTYPE="en_US.UTF-8" 
LC_NUMERIC=de_AT.UTF-8
LC_TIME=de_AT.UTF-8
LC_COLLATE="en_US.UTF-8" 
LC_MONETARY=de_AT.UTF-8
LC_MESSAGES="en_US.UTF-8" 
LC_PAPER=de_AT.UTF-8
LC_NAME=de_AT.UTF-8
LC_ADDRESS=de_AT.UTF-8
LC_TELEPHONE=de_AT.UTF-8
LC_MEASUREMENT=de_AT.UTF-8
LC_IDENTIFICATION=de_AT.UTF-8
LC_ALL=

Then you are lacking a locale installation. Some parts, especially boost-filesystem, are known to suffer badly from missing locale installation files. Reinstall them by

$ sudo dpkg-reconfigure locales

and verify that all locales in use listed by

$ locale

are installed. All installed locales can be seen by

$ locale -a

Remote SSH login and DBus server

The AIT QKD depends on a running DBus server. When you ssh into a remote machine as usually via

$ ssh user@machine

then you will lack DBus capabilities. This results in warnings and messages like this:

Could not connect to D-Bus server: org.freedesktop.DBus.Error.NotSupported: Unable to autolaunch a dbus-daemon without a $DISPLAY for X11

Please either enable X11 forwarding support via

$ ssh -X user@machine

or ensure that the qkd-dbus service is running and the environment variable QKD_DBUS_SESSION_ADDRESS holds a valid DBus address. See Configuration for details.

Note: if you launch GUI applications like qkd-module-manager or qkd-simulate remotely, you still need to login via SSH and X11-forwarding enabled.

License

The AIT QKD Software Suite is licensed under the GPL 3.

Some GUI parts use images and graphics created by http://www.creativefreedom.co.uk under the "CC Attribution-No Derivative 3.0" License. See http://creativecommons.org/licenses/by-nd/3.0 for details.

(C)opyright 2012-2015 AIT Austrian Institute of Technology