Packaging

.gitignore

@@ -6,3 +6,5 @@ web/app/node_modules
 .idea
 
 memcoin
+deb-package/deb
+deb-package/dist

.gitmodules

@@ -0,0 +1,12 @@
+[submodule "contracts/evoting/unikernel/unikraft"]
+	path = contracts/evoting/unikernel/unikraft
+	url = https://github.com/unikraft/unikraft
+[submodule "contracts/evoting/unikernel/libs/lwip"]
+	path = contracts/evoting/unikernel/libs/lwip
+	url = https://github.com/unikraft/lib-lwip
+[submodule "contracts/evoting/unikernel/libs/newlib"]
+	path = contracts/evoting/unikernel/libs/newlib
+	url = https://github.com/unikraft/lib-newlib
+[submodule "contracts/evoting/unikernel/libs/libsodium"]
+	path = contracts/evoting/unikernel/libs/libsodium
+	url = https://github.com/cs-pub-ro/lib-libsodium

Makefile

@@ -22,4 +22,7 @@ test_integration:
 	go test ./integration
 
 build:
-	go build -ldflags="-X $(versionFlag) -X $(timeFlag)" ./cli/memcoin
+	go build -ldflags="-X $(versionFlag) -X $(timeFlag)" ./cli/memcoin
+
+deb: build
+	cd deb-package; ./build-deb.sh; cd ..

contracts/evoting/unikernel/apps/combine_shares/README.md

@@ -9,49 +9,53 @@ functionality provided by [libsodium](https://github.com/jedisct1/libsodium).
 
 ## Requirements
 
+- To build the kernel:
+
 ```sh
-sudo apt-get install git
-sudo apt-get install make
-sudo apt-get install gcc
-sudo apt-get install libncurses-dev
-sudo apt-get install flex
-sudo apt-get install bison
-sudo apt-get install unzip
-sudo apt-get install socat
-sudo apt-get install uuid-runtime
-sudo apt install qemu-kvm libvirt-daemon-system libvirt-clients bridge-utils \
-    virtinst virt-manager
-sudo apt install net-tools
+sudo apt install bison build-essentials flex git libncurses-dev unzip
 ```
 
-## Setup
-
-Apart from the current repository, you also need to clone:
+- To run the kernel in a debian VM, the following packages must be installed
+in the VM:
 
-* [Unikraft](https://github.com/unikraft/unikraft)
-* [lwip](https://github.com/unikraft/lib-lwip)
-* [newlib](https://github.com/unikraft/lib-newlib)
-* [libsodium](https://github.com/unikraft/lib-libsodium)
-
-Make sure each repository is on the `staging` branch.
+```sh
+sudo apt install \
+  bridge-utils \
+  fuse \
+  libvirt-clients \
+  libvirt-daemon-system \
+  qemu-kvm \
+  net-tools \
+  sgabios \
+  socat \
+  uuid-runtime \
+  virtinst \
+  virt-manager
+```
 
-For the libsodium library make sure the following change is included:
-https://github.com/unikraft/lib-libsodium/pull/4.
+## Setup
 
 It is easiest to use a file hierarchy such as:
 
+```tree
+unikernel
+ ┣ apps
+ ┃ ┗ combine_shares
+ ┣ libs
+ ┃ ┣ libsodium
+ ┃ ┣ lwip
+ ┃ ┗ newlib
+ ┗ unikraft
 ```
-.
-|-- apps/
-|   `-- app-smart-contract-config/
-|-- libs/
-|   |-- lwip/
-|   |-- libsodium/
-|   `-- newlib/
-`-- unikraft/
+
+Please run the following command, which will clone the submodules in the above 
+illustrated paths:
+
+```sh
+git submodule update --init --recursive
 ```
 
-If you use a file hierarhy different than the one above, then edit the
+If you use a file hierarchy different than the one above, then edit the
 `Makefile` file and update the variables to point to the correct location:
 
 * Update the `UK_ROOT` variable to point to the location of the Unikraft clone.
@@ -62,11 +66,23 @@ If you get a `Cannot find library` error at one of the following steps, you may
 need to add the `lib-` prefix to the libraries listed in the `LIBS` variable.
 For instance, `$(UK_LIBS)/lwip` becomes `$(UK_LIBS)/lib-lwip`.
 
+Here is the list of the required repositories that you also need as submodules:
+
+* [libsodium](https://github.com/unikraft/lib-libsodium)
+* [lwip](https://github.com/unikraft/lib-lwip)
+* [newlib](https://github.com/unikraft/lib-newlib)
+* [Unikraft](https://github.com/unikraft/unikraft)
+
+For the libsodium library, the submodule still points to the source of the following PR:
+https://github.com/unikraft/lib-libsodium/pull/4.
+
+For the other libraries, please make sure that each repository is on the `staging` branch. 
+
 ## Configure
 
-Configure the build by running:
+Configure the build by running in `contracts/evoting/unikernel/apps/combine_shares`:
 
-```
+```sh
 make menuconfig
 ```
 
@@ -75,7 +91,7 @@ configuration is loaded from the `Config.uk` file. Then add support for 9pfs, by
 selecting `Library Configuration` -> `vfscore: VFS Core Interface` -> `vfscore:
 VFS Configuration`. The select `Automatically mount a root filesystem (/)` and
 select `9pfs`. For the `Default root device` option fill `fs0`. You should end
-up with an image such as the one in `9pfs_config.png`. Save the conifugration
+up with an image such as the one in `9pfs_config.png`. Save the configuration
 and exit.
 
 As a result of this, a `.config` file is created.
@@ -85,21 +101,24 @@ A KVM unikernel image will be built from the configuration.
 
 Build the unikernel KVM image by running:
 
-```
+```sh
 make
 ```
 
 The resulting image is in the `build/` subfolder, usually named
-`build/app-smart-contract-config_kvm-x86_64`.
+`build/combine_shares_kvm-x86_64`.
 
 ## Run
 
 The resulting image is to be loaded as part of a KVM virtual machine with a
 software bridge allowing outside network access to the server application. Start
 the image by using the `run` script (you require `sudo` privileges):
 
+```sh
+./start-unikernel unikernel_paths
 ```
-$ ./run
+
+```output
 [...]
 Booting from ROM...
 1: Set IPv4 address 172.44.0.2 mask 255.255.255.0 gw 172.44.0.1
@@ -126,15 +145,15 @@ the `mnt/` folder.
 On another terminal, use `nc` to connect via TCP to the program and send the
 commands:
 
-```
-$ nc 172.44.0.2 1024
+```sh
+nc 172.44.0.2 1024
 ec_multiply
 2c7be86ab07488ba43e8e03d85a67625cfbf98c8544de4c877241b7aaafc7fe3
 ```
 
 The running program will print out a summary of received commands:
 
-```
+```sh
 Received connection from 172.44.0.1:38596
 Received: ec_multiply
 Operation: ec_multiply

contracts/evoting/unikernel/apps/combine_shares/config.env

@@ -0,0 +1,10 @@
+# dela config
+export dela_bin=".../cli/memcoin"
+export dela_data=".../tmp/dela"
+export dela_port="9000"
+
+# unikernel config
+export fs_mount="mnt/"
+export kvm_image="./combine_shares_kvm-x86_64"
+export qemu_script="./qemu-guest"
+export network_config="./unikernel_network"

contracts/evoting/unikernel/apps/combine_shares/create-bridge

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+paths=$1
+
+source ${paths}
+source ${network_config}
+
+echo "Creating bridge ${bridge_iface} with IP address ${uk_gw} ..."
+sudo brctl addbr "${bridge_iface}" || true
+sudo ifconfig "${bridge_iface}" "${uk_gw}"

contracts/evoting/unikernel/apps/combine_shares/network.env

@@ -0,0 +1,4 @@
+export uk_gw="172.44.0.1"
+export uk_ip="172.44.0.2"
+export uk_port="1024"
+export bridge_iface="uk0"

contracts/evoting/unikernel/apps/combine_shares/qemu-guest

@@ -432,7 +432,7 @@ usage()
 	echo "  -x                         Run guest in background, a socket is created for the serial output"
 	echo "  -P                         Create the guest in paused state"
 	echo "  -t [TYPE]                  Set guest type: x86pc, x86q35, arm64v"
-	echo "  -G [NAME]                  Set name of guest to NAME"
+	echo "  -U [NAME]                  Set name of guest to NAME"
 	echo "  -g [PORT]                  Run a GDB server for the guest at port PORT (e.g., 1234)"
 	echo "                             Note: QEMU process stays alive on guest shutdown/reset"
 	echo "  -T [LOGFILE]               Enable tracing of CPU events (fine-grained results with -W)"
@@ -480,7 +480,7 @@ usage()
 	echo "  $0 -c 2 -m 2048 -b virbr0 -b virbr1 -q root.qcow2 -d /dev/sdb -d /dev/sdc"
 }
 
-while getopts :hnN:b:V:f:G:d:q:S:I:e:k:i:a:c:m:v:lrs:p:HxCDG:g:PT:WQ:M:t: OPT; do
+while getopts :hnN:b:V:f:G:d:q:S:I:e:k:i:a:c:m:v:lrs:p:HxCDUG:g:PT:WQ:M:t: OPT; do
         case ${OPT} in
 	v)
 		OPT_VIDEOVNC=0
@@ -666,7 +666,7 @@ EOF
 	C)
 		OPT_CTRLC=1
 		;;
-	G)
+	U)
 		ARG_GUESTNAME="${OPTARG}"
 		;;
 	Q)

contracts/evoting/unikernel/apps/combine_shares/start-unikernel

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+paths=$1
+
+source ${paths}
+source ${network_config}
+
+echo "Starting KVM image connected to bridge interface ${bridge_iface} ..."
+"${qemu_script}" -k "${kvm_image}" -e "${fs_mount}" -b "${bridge_iface}" -m 1024 -a "netdev.ipv4_addr=${uk_ip} netdev.ipv4_gw_addr=${uk_gw} netdev.ipv4_subnet_mask=255.255.255.0 -- ${uk_port}"

deb-package/README.md

@@ -0,0 +1,25 @@
+# Packaging D-Voting in an installable .deb file
+
+## Requirements
+
+- Install `gem` and [fpm](https://fpm.readthedocs.io/en/latest/installation.html):
+
+```sh
+sudo apt install rubygems build-essentials
+sudo gem install fpm
+```
+
+- Build unikernel. See [how to build unikernel](../contracts/evoting/unikernel/apps/combine_shares/README.md):
+
+```sh
+cd contracts/evoting/unikernel/apps/combine_shares
+git submodule update --init --recursive 
+make menuconfig
+make
+```
+
+- Create .deb package:
+
+```sh
+make deb
+```

deb-package/build-deb.sh

@@ -0,0 +1,69 @@
+#! /usr/bin/env bash
+set -xe
+
+# cleanup previous installations
+rm -rf deb
+
+# create binaries dir
+INSTALL_DIR="deb/opt/dedis/dvoting/bin"
+mkdir -p $INSTALL_DIR
+
+# copy binaries to deb/opt/dedis/dvoting/bin
+UKAPP_DIR="../contracts/evoting/unikernel/apps/combine_shares"
+cp $UKAPP_DIR/create-bridge $INSTALL_DIR
+cp $UKAPP_DIR/start-unikernel $INSTALL_DIR
+cp $UKAPP_DIR/qemu-guest $INSTALL_DIR
+cp $UKAPP_DIR/build/combine_shares_kvm-x86_64 $INSTALL_DIR
+
+DVOTING_CLI_DIR=".."
+cp $DVOTING_CLI_DIR/memcoin $INSTALL_DIR
+
+# add config files
+cp -a pkg/etc deb
+cp -a pkg/lib deb
+cp -a pkg/opt deb
+cp -a pkg/var deb
+
+# add folders
+mkdir -p deb/var/log/dedis/dvoting
+
+# adjust permissions
+find deb ! -perm -a+r -exec chmod a+r {} \;
+
+# get version from git without v prefix
+GITVERSION=$(git describe --abbrev=0)
+VERSION=${GITVERSION:1}
+if [[ -z "${ITERATION}" ]]
+then
+  ITERATION="0"
+fi
+
+# fpm needs an existing output directory
+OUTPUT_DIR="dist"
+mkdir -p $OUTPUT_DIR
+
+fpm \
+    --force -t deb -a all -s dir -C deb -n dedis-dvoting -v ${VERSION} \
+    --iteration ${ITERATION} \
+    --deb-user dvoting \
+    --deb-group dvoting \
+    --depends bridge-utils \
+    --depends fuse \
+    --depends qemu-kvm \
+    --depends libvirt-daemon-system \
+    --depends net-tools \
+    --depends sgabios \
+    --depends socat \
+    --depends uuid-runtime \
+    --depends virtinst \
+    --depends virt-manager \
+    --before-install pkg/before-install.sh \
+    --after-install pkg/after-install.sh \
+    --before-remove pkg/before-remove.sh \
+    --after-remove pkg/after-remove.sh \
+    --url https://dedis.github.com/dedis/dvoting \
+    --description 'D-Voting package for Unicore' \
+    --package dist .
+
+# cleanup
+rm -rf ./deb