The Serval Project's core daemon that implements Distributed Numbering Architecture (DNA), MDP, VoMP, Rhizome, MeshMS, etc.
Go to file
Andrew Bettison 067340bbba Change HTTP Authorization realm to "Serval RESTful API"
Was "Serval Rhizome", which is not accurate
2014-06-30 11:11:01 +09:30
asterisk_include Added support for batmand.peers file for reliable peer querying. 2011-03-21 13:08:35 +10:30
Debian/etc Improve Debian init.d script and default file 2013-01-24 13:24:11 +10:30
doc Fix coverage test documentation to reflect changes required to support clang 2014-06-16 16:11:11 +09:30
fec-3.0.1 Fix -Wsign-compare warnings: use size_t or unsigned for byte counts 2013-12-10 16:52:53 +10:30
java/org/servalproject Rename config 'rhizome.api.restful' to 'api.restful' 2014-06-30 11:11:01 +09:30
m4 Artefacts created by libtoolize -c -i 2012-09-12 15:21:50 +09:30
nacl Fix -Wsign-compare warnings in NaCl code 2013-12-11 13:58:51 +10:30
openwrt/packages/serval-dna Modify OpenWRT Makefile for development 2014-03-03 15:21:53 +10:30
sqlite-amalgamation-3070900 Fix unused variable warning in sqlite on some platforms 2014-06-05 17:25:24 +09:30
tests Change HTTP Authorization realm to "Serval RESTful API" 2014-06-30 11:11:01 +09:30
utilities Fix Markdown formatting 2013-02-22 00:05:34 -08:00
win32 Allow clients to request variables for all records by passing empty did. 2011-04-27 12:17:26 +09:30
.dir-locals.el Add file to set emacs variables to match the prevailing style. 2012-07-29 13:52:46 +09:30
.gitignore Improve test framework: test coverage support 2014-06-06 14:47:54 +09:30
aclocal.m4 Merge branch 'master' of github.com:servalproject/serval-dna 2012-04-23 20:41:52 +09:30
Android.mk Measure free space on Android using statfs() 2014-06-26 12:17:36 +09:30
cc-by-4.0.png Add copyright notices and CC-BY license to README.md and INSTALL.md 2014-05-20 14:52:57 +09:30
CC-BY-4.0.md Add text of CC BY 4.0 license 2014-05-21 17:37:23 +09:30
check-in-out-return.c Uniform copyright notices 2013-12-04 17:15:36 +10:30
cli.c Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
cli.h Fix -Wsign-compare warnings in CLI 2013-12-10 16:56:23 +10:30
commandline.c Reinstate rhizome database storage limit 2014-06-19 11:09:09 +09:30
conf_om.c Don't compare past the end of the parent key 2014-05-09 15:13:13 +09:30
conf_parse.c Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
conf_schema.c Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
conf_schema.h Rename config 'rhizome.api.restful' to 'api.restful' 2014-06-30 11:11:01 +09:30
conf.c Move serverMode flag from log.c to server.c 2014-06-11 14:53:26 +09:30
conf.h Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
config_test.c Merge network simulator into development 2014-05-26 15:52:40 +09:30
config.guess Artefacts created by libtoolize -c -i 2012-09-12 15:21:50 +09:30
config.sub Artefacts created by libtoolize -c -i 2012-09-12 15:21:50 +09:30
configure.in Measure free space on Android using statfs() 2014-06-26 12:17:36 +09:30
console.c Move console reading from vomp_console.c to console.c 2014-05-02 14:03:23 +09:30
console.h Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
constants.h Add monitor message for interface up/down events 2014-06-13 13:34:10 +09:30
context1.c Fix compiler warning 2013-11-21 16:49:44 +10:30
CONTRIBUTORS.md Add CONTRIBUTORS.md file, fix alternative links in README.md 2013-12-03 15:05:05 +10:30
COPYRIGHT.txt Add Petter Reinholdtsen to copyright message 2013-12-09 16:27:58 +10:30
crypto.c Migrate keyring sas commands 2014-02-19 16:37:45 +10:30
crypto.h Migrate keyring sas commands 2014-02-19 16:37:45 +10:30
dataformats.c Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
dataformats.h Initial msp library implementation with connection state tracking 2014-01-09 15:01:37 +10:30
directory_client.c Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
directory_service.c Fix config file timestamp bug 2014-04-29 15:04:20 +09:30
dna_helper.c Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
fakeradio.c Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
fdqueue.c Rework scheduler to allow for lazy but important alarms 2014-06-04 17:13:08 +09:30
fdqueue.h Rework scheduler to allow for lazy but important alarms 2014-06-04 17:13:08 +09:30
fifo.c Uniform copyright notices 2013-12-04 17:15:36 +10:30
fifo.h Uniform copyright notices 2013-12-04 17:15:36 +10:30
golay.c Uniform copyright notices 2013-12-04 17:15:36 +10:30
golay.h Uniform #ifdef __SERVAL_DNA__... for headers 2013-12-04 17:15:36 +10:30
GPL-2.0.txt Add full text of GPL version 2.0 2013-12-04 02:52:31 +10:30
headerfiles.mk Only send rhizome sync packets when we have neighbours 2014-05-30 15:03:22 +09:30
http_server.c New HTTP RESTful requests: MeshMS read message(s) 2014-06-24 12:11:58 +09:30
http_server.h Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
httpd.c Change HTTP Authorization realm to "Serval RESTful API" 2014-06-30 11:11:01 +09:30
httpd.h Change HTTP Authorization realm to "Serval RESTful API" 2014-06-30 11:11:01 +09:30
install-sh Artefacts created by libtoolize -c -i 2012-09-12 15:21:50 +09:30
INSTALL.md Improve test framework: test coverage support 2014-06-06 14:47:54 +09:30
instance.c Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
instance.h Filesystem Heirarchy Standard (FHS) paths 2014-03-26 15:35:43 +10:30
jni.c Imported ref10/ implementation of crypto_sign from supercop-20120525 2012-10-18 17:26:48 +10:30
keyring.c Refactor keyring open/seed out of server() 2014-04-07 16:22:31 +09:30
keyring.h Migrate keyring sas commands 2014-02-19 16:37:45 +10:30
LICENSE-DOCUMENTATION.md Add text of CC BY 4.0 license 2014-05-21 17:37:23 +09:30
limit.c Move rate limit code to separate file 2014-05-12 13:44:50 +09:30
limit.h Move rate limit code to separate file 2014-05-12 13:44:50 +09:30
log_stderr.c Move serverMode flag from log.c to server.c 2014-06-11 14:53:26 +09:30
log_util.c Improve "log.h", make logMessage() inline 2014-05-05 18:17:51 +09:30
log.c Move serverMode flag from log.c to server.c 2014-06-11 14:53:26 +09:30
log.h Move serverMode flag from log.c to server.c 2014-06-11 14:53:26 +09:30
logMessage.c Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
lsif.c Remove spurius include of netinet/if_ether.h, fixes #76 2014-04-07 13:22:39 +09:30
ltmain.sh Artefacts created by libtoolize -c -i 2012-09-12 15:21:50 +09:30
macconfig Fixed broadcast address discovery to work on Mac. 2011-08-08 16:11:05 +09:30
main.c Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
Makefile.dbg Move debug options to Makefile.dbg so we don't have to re-run configure. 2012-07-29 14:55:10 +09:30
Makefile.in Disable and remove pthreads to support compiling with clang 2014-06-11 20:32:16 +09:30
mdp_client.c Fix OSX specific issues 2014-06-05 14:57:53 +09:30
mdp_client.h Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
mdp_filter.c Move serverMode flag from log.c to server.c 2014-06-11 14:53:26 +09:30
mdp_net.c Uniform copyright notices 2013-12-04 17:15:36 +10:30
mem.c Minor refactor in strn_edup() 2013-12-01 05:13:33 +10:30
mem.h Uniform #ifdef __SERVAL_DNA__... for headers 2013-12-04 17:15:36 +10:30
meshms_restful.c Change HTTP Authorization realm to "Serval RESTful API" 2014-06-30 11:11:01 +09:30
meshms.c New HTTP RESTful requests: MeshMS read message(s) 2014-06-24 12:11:58 +09:30
meshms.h New HTTP RESTful requests: MeshMS read message(s) 2014-06-24 12:11:58 +09:30
meshpotato_build Assorted unknown changes. Updated Makefile.in etc to properly build serval.c for building asterisk module. 2011-06-15 13:52:30 +09:30
monitor-cli.c Fix -Wunused-parameter warnings 2013-12-09 18:22:18 +10:30
monitor-client.c Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
monitor-client.h Uniform #ifdef __SERVAL_DNA__... for headers 2013-12-04 17:15:36 +10:30
monitor.c Add monitor message for interface up/down events 2014-06-13 13:34:10 +09:30
mpbuild Added mesh potato build script. 2011-08-10 15:39:40 +02:00
msp_client.c Allow for an msp handler that closes another socket, dont consider a closed socket to be listening 2014-06-12 11:15:41 +09:30
msp_client.h Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
msp_proxy.c Test that msp listen --service_name shuts down 2014-06-23 14:23:30 +09:30
net.c Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
net.h Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
nonce.c Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
os.c Fix OSX specific issues 2014-06-05 14:57:53 +09:30
os.h Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
overlay_address.c Refactor interface addresses to use new socket_address struct 2014-01-09 15:01:38 +10:30
overlay_address.h Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
overlay_buffer.c Remove unused debug flags 2014-05-26 14:01:34 +09:30
overlay_buffer.h Refactor rhizome mdp and vomp packet sending 2014-02-19 16:38:26 +10:30
overlay_interface.c Ignore some types of sendto errors 2014-06-27 12:45:53 +09:30
overlay_interface.h Ensure directory service tests aren't creating a global routing table 2014-06-16 17:22:46 +09:30
overlay_link.c Move rate limit code to separate file 2014-05-12 13:44:50 +09:30
overlay_mdp_services.c Replace internal usage of overlay_mdp_dispatch 2014-02-19 16:39:42 +10:30
overlay_mdp.c Display where packets came from in debug messages 2014-06-26 16:47:23 +09:30
overlay_olsr.c Refactor interface addresses to use new socket_address struct 2014-01-09 15:01:38 +10:30
overlay_packet.h Display where packets came from in debug messages 2014-06-26 16:47:23 +09:30
overlay_packetformats.c Fix duplicate payload detection over unicast links 2014-06-26 17:20:06 +09:30
overlay_packetradio.c Refactor interface addresses to use new socket_address struct 2014-01-09 15:01:38 +10:30
overlay_payload.c Remove unused debug flags 2014-05-26 14:01:34 +09:30
overlay_queue.c Add new debug flag to show what payloads are being included in network packets 2014-06-28 20:17:26 +09:30
performance_timing.c Sort timing details by duration then call count 2014-06-27 15:08:25 +09:30
radio_link.c Refactor interface addresses to use new socket_address struct 2014-01-09 15:01:38 +10:30
radio_link.h Uniform #ifdef __SERVAL_DNA__... for headers 2013-12-04 17:15:36 +10:30
randombytes.c More consistent use of sleep_ms 2013-08-27 15:14:17 +09:30
README.md Add text of CC BY 4.0 license 2014-05-21 17:37:23 +09:30
rhizome_bundle.c Fix Rhizome manifest parsing bug 2014-04-29 15:08:02 +09:30
rhizome_crypto.c Fix Rhizome manifest parsing bug 2014-04-29 15:08:02 +09:30
rhizome_database.c Squelch info message that is occuring while fetching a journal bundle 2014-06-30 08:40:48 +09:30
rhizome_direct_http.c Reinstate rhizome database storage limit 2014-06-19 11:09:09 +09:30
rhizome_direct.c Introduce typedef for handling BAR values 2014-06-16 14:38:14 +09:30
rhizome_fetch.c Improve debug info for rhizome sync 2014-06-28 20:27:29 +09:30
rhizome_http.c Improve MeshMS RESTful HTTP failure reporting 2014-02-07 16:28:40 +10:30
rhizome_packetformats.c Improve debug info for rhizome sync 2014-06-28 20:27:29 +09:30
rhizome_restful.c Change HTTP Authorization realm to "Serval RESTful API" 2014-06-30 11:11:01 +09:30
rhizome_store.c Ensure temporary id is unique 2014-06-28 17:36:06 +09:30
rhizome_sync.c Improve debug info for rhizome sync 2014-06-28 20:27:29 +09:30
rhizome_types.h Introduce typedef for handling BAR values 2014-06-16 14:38:14 +09:30
rhizome.c Reinstate rhizome database storage limit 2014-06-19 11:09:09 +09:30
rhizome.h Improve debug info for rhizome sync 2014-06-28 20:27:29 +09:30
rotbuf.c Fix bug in rotbuf_next_chunk() when rotation == 0 2013-05-15 16:46:39 +09:30
rotbuf.h Remove spurious rotbuf_log() declaration, fixes #75 2014-04-03 10:43:14 +10:30
route_link.c Fix duplicate payload detection over unicast links 2014-06-26 17:20:06 +09:30
serval_packetvisualise.c Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
serval_types.h Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
serval.h Display where packets came from in debug messages 2014-06-26 16:47:23 +09:30
servalwrap.c Fix android commandline interface 2013-07-09 16:46:16 +09:30
server.c Improve debug info for rhizome sync 2014-06-28 20:27:29 +09:30
server.h Allow closing a monitor connection to force the server to quit 2014-06-11 20:39:26 +09:30
sha2.c Add supid copyright headers on request from Andrew Bettison in the serval project. 2013-12-07 18:38:14 +01:00
sha2.h Substantial preparatory work towards Rhizome/MeshMS store-and-forward 2011-12-13 19:34:12 +10:30
sighandlers.c Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
sighandlers.h Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
simulator.c Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
simulator.h Create new AF_UNIX based network simulator 2014-05-23 10:47:22 +09:30
socket.c Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
socket.h Refactor socket helper functions to take socket_address struct 2014-02-20 14:44:38 +10:30
sourcefiles.mk Ensure a race condition while starting servald only starts one process 2014-06-11 09:01:56 +09:30
srandomdev.c Add supid copyright headers on request from Andrew Bettison in the serval project. 2013-12-07 18:38:14 +01:00
str.c New HTTP RESTful requests: MeshMS read message(s) 2014-06-24 12:11:58 +09:30
str.h New HTTP RESTful requests: MeshMS read message(s) 2014-06-24 12:11:58 +09:30
strbuf_helpers.c Set up SEGV crash handler in main() not server() 2014-05-08 14:24:00 +09:30
strbuf_helpers.h Set up SEGV crash handler in main() not server() 2014-05-08 14:24:00 +09:30
strbuf.c Format UUID strings as lower case hex 2013-11-13 12:45:02 +10:30
strbuf.h STRBUF_ALLOCA_FIT() macro 2014-01-20 15:37:14 +10:30
strlcpy.c Fix issues arising from new strlcpy.c 2012-08-14 11:23:27 +09:30
strlcpy.h Fix build when strlcpy is present 2013-01-11 14:43:37 +10:30
testconfig.sh.in Trival test of dna JNI command line entry point 2012-04-23 18:25:26 +09:30
testdefs_java.sh Include Java tests in 'tests/all' if Java compiler available 2014-06-19 11:38:39 +09:30
testdefs_json.sh Split up 'rhizomehttp' test script 2014-06-26 15:08:48 +09:30
testdefs_meshms.sh Refactor tests: testdefs_java.sh, testdefs_meshms.sh 2014-06-19 09:54:29 +09:30
testdefs_rhizome.sh Fix HTTP transfers of large payloads 2014-06-27 15:07:26 +09:30
testdefs.sh Split up 'rhizomehttp' test script 2014-06-26 15:08:48 +09:30
testframework.sh Improve test framework: create_file 2014-06-19 09:52:17 +09:30
testnacl.c Add missing copyright/license comment blocks 2013-11-21 16:05:18 +10:30
tfw_createfile.c Fix -Wsign-compare warnings in tfw_createfile 2013-12-11 14:00:41 +10:30
timeit.c add context switching speed test to "test memory" command. 2013-10-22 13:12:10 -07:00
uuid.c Rename uuid_t --> serval_uuid_t 2014-02-17 13:26:03 +10:30
uuid.h Rename uuid_t --> serval_uuid_t 2014-02-17 13:26:03 +10:30
version_servald.c Add "servald version" command and "make copyright" 2013-12-05 14:32:01 +10:30
version_string.sh Cleanup git version arguments 2014-03-05 10:26:54 -08:00
vomp_console.c Allow closing a monitor connection to force the server to quit 2014-06-11 20:39:26 +09:30
vomp.c Rework scheduler to allow for lazy but important alarms 2014-06-04 17:13:08 +09:30
whence.c Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
whence.h Overhaul Makefile and header files 2014-05-26 15:36:26 +09:30
xprintf.c Add XPRINT strbuf adapter 2013-03-25 12:02:48 +10:30
xprintf.h Uniform #ifdef __SERVAL_DNA__... for headers 2013-12-04 17:15:36 +10:30

Serval DNA

Serval Project, March 2014

Serval DNA is the core component of the Serval Mesh app for Android and the Serval Mesh Extender long-range mesh networking device. It is a daemon process that performs all the central services of the Serval mesh network such as dynamic routing, encryption and authentication, file distribution, messaging, and voice telephony.

Any device with Wi-Fi connectivity that runs the Serval DNA daemon can participate in the Serval mesh network.

Download, build and test

INSTALL.md contains instructions for downloading, building and testing Serval DNA on most Linux and some Linux-like platforms.

Configuration

doc/Servald-Configuration.md describes how to set up and run a Serval DNA daemon.

Documentation

What is in this repository?

This repository contains the GNU C source code for the servald executable, a test framework and test scripts written in Bash, some technical documentation, and various support files for installation and configuration on various platforms.

The servald executable is a multi-purpose program that can be invoked directly from the command line, run as a daemon process, or invoked via JNI from within a Java program. The servald executable is really many commands built into one; the command-line arguments select which command to run. Some commands are stand-alone utilities, some start and stop the servald daemon process, some communicate with the servald daemon as an MDP client, and others via a two-way pipe called the monitor interface.

The following protocols and services are implemented in servald:

  • The Distributed Numbering Architecture (DNA) is the key innovation that makes mesh telephony viable in the absence of any infrastructure, eg, in the aftermath of a natural disaster or in remote locations. It is a protocol carried over MDP (see below) that allows any device to ask its neighboring devices for a phone number (DID). Such a request will propagate through the mesh, and any device may respond with the identity (SID) of a subscriber who has “claimed” that DID.

  • The Serval Keyring is a flat file containing all the user identities on a single device. Each identity is a set of elliptic curve secret cryptographic keys that belong to a single “mesh subscriber”, indexed by the subscriber's 256-bit public key, called a SID. Each identity in the keyring is locked by its own user-chosen password (called a PIN in the code and documentation), using elliptic curve cryptography to protect locked entries from theft or tampering, and steganography to allow the user to plausibly deny the existence of any locked identity.

  • The Mesh Datagram Protocol (MDP) is Serval's own layer 3 protocol designed for secure mesh networking. It is completely independent of Internet protocols such as IP and UDP, but for the time being is implemented as an “overlay” network based on UDP/IP because that is the interface that Linux and other operating systems provide for sending data over WiFi. However, MDP could easily be implemented directly over a layer 2 data link such as WiFi or Ethernet MAC. MDP uses subscribers' public keys (SID) as source and destination addresses, and has a 32-bit port number analogous to the 16-bit port number used in TCP/IP.

  • The Voice over Mesh Protocol (VoMP) is Serval's own call negotiation and two-way audio streaming protocol used to implement mesh voice calls. It is analogous to SIP/RTS, which is the dominant protocol used to implement Voice over Internet Protocol, but VoMP is designed for the variable and unstable conditions of wireless mesh networks. VoMP's session state model and signalling can handle packet loss, mid-call re-routing and re-connection where SIP would fail. VoMP's audio streaming can encapsulate many codecs and even DTMF (dialpad button) signalling.

  • The Rhizome content distribution service is a storage engine implemented using SQLite and a content-exchange protocol based on MDP and HTTP for the pervasive dissemination of content like images, videos, documents, software upgrades, etc. Each piece of content in Rhizome is called a “bundle”, which has two parts: a manifest that describes the content, and the payload, which is the content itself. Each bundle has its own unique cryptographic identifier that allows any recipient to verify that it has not been tampered with. A bundle's payload may be encrypted by the author so that only the designated recipient can read it.

  • The MeshMS messaging service sends short text messages using Rhizome as its transport. Each message thread is stored and carried in a pair of journal bundles, one for each direction (ply).

  • Serval Infrastructure services may optionally be deployed on any devices in the mesh to expose external services to mesh subscribers and vice versa (eg, VoIP gateways, SMS satellite links, packetised web), and to overcome scalability limitations of a perfectly decentralised mesh (eg, central telephone directory). Serval Infrastructure is implemented as a daemon with its own executable called directory_service.

Serval DNA is free software produced by the Serval Project and many contributors. Its source code is licensed to the public under the GNU General Public License version 2. Its technical documentation is licensed to the public under the Creative Commons Attribution 4.0 International licence. All source code and technical documentation is freely available from the Serval Project's serval-dna Git repository on GitHub.

The copyright in most of the source code in Serval DNA is held by Serval Project Inc., a not-for-profit association incorporated in the state of South Australia in the Commonwealth of Australia for the purpose of developing the Serval mesh software. The COPYRIGHT file contains a full list of all those who hold copyright in portions of the Serval DNA source code.

The Serval Project will accept contributions for which copyright has been assigned to Serval Project Inc., or which are licensed to either Serval Project Inc. or to the public on terms that allow the Serval Project to freely redistribute and re-license the code under non-restrictive terms, for example, to release Serval DNA as part of a product distributed through the Apple app store.

Individual developers may assign copyright in their contributions by signing the Serval Project Developer Agreement - Individual, and organisations by signing the Serval Project Developer Agreement - Entity.


Copyright 2014 Serval Project Inc.
CC-BY-4.0 This document is available under the Creative Commons Attribution 4.0 International licence.