ExternalVendorCode/serval-dna
1
0
Fork 0
mirror of https://github.com/servalproject/serval-dna.git synced 2024-12-18 20:57:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve README.md

Browse Source 
Add VoMP to list of new technologies

Add links to new Wiki Technology Roadmap pages for key technologies

Simplify contributor agreement PDF download links

Add link to SPI page on Wiki
This commit is contained in:
Andrew Bettison 2013-05-16 18:04:47 +09:30
parent 3c8643289e
commit 628fba6208
2 changed files with 36 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
INSTALL.md
View File

@ -4,7 +4,7 @@ Serval DNA Build and Test
To build To build
-------- --------
Run the following commands: In the `serval-dna` directory, run the following commands:
autoreconf -f -i autoreconf -f -i
./configure ./configure

53
README.md
View File

@ -4,15 +4,15 @@ Serval DNA
This repository contains the source code for the “core” Serval components This repository contains the source code for the “core” Serval components
implemented in [GNU C][]: implemented in [GNU C][]:
* The **Distributed Numbering Architecture** (DNA) is the key innovation that * The **[Distributed Numbering Architecture (DNA)][]** is the key
makes mesh telephony viable in the absence of any infrastructure, eg, in the innovation that makes mesh telephony viable in the absence of any
aftermath of a natural disaster or in remote locations. It is a protocol infrastructure, eg, in the aftermath of a natural disaster or in remote
carried over MDP (see below) that allows any device to ask its neighboring locations. It is a protocol carried over MDP (see below) that allows any
devices for a phone number (DID). Such a request will propagate through the device to ask its neighboring devices for a phone number (DID). Such a
mesh, and any device may respond with the identity (SID) of a subscriber who request will propagate through the mesh, and any device may respond with the
has “claimed” that DID. identity (SID) of a subscriber who has “claimed” that DID.
* The **Serval Keyring** is a flat file containing all the user identities on * 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 a single device. Each identity is a set of elliptic curve secret
cryptographic keys that belong to a single “mesh subscriber”, indexed by the 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 subscriber's 256-bit public key, called a SID. Each identity in the keyring is
@ -21,7 +21,7 @@ implemented in [GNU C][]:
from theft or tampering, and steganography to allow the user to plausibly from theft or tampering, and steganography to allow the user to plausibly
deny the existence of any locked identity. deny the existence of any locked identity.
* The **Mesh Datagram Protocol** (MDP) is Serval's own layer 3 protocol * The **[Mesh Datagram Protocol (MDP)][]** is Serval's own layer 3 protocol
designed for secure mesh networking. It is completely independent of designed for secure mesh networking. It is completely independent of
Internet protocols such as IP and UDP, but for the time being is implemented 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 as an “overlay” network based on UDP/IP because that is the interface that
@ -31,7 +31,16 @@ implemented in [GNU C][]:
source and destination addresses, and has a 32-bit port number analogous to source and destination addresses, and has a 32-bit port number analogous to
the 16-bit port number used in TCP/IP. the 16-bit port number used in TCP/IP.
* The **Rhizome** content distribution service is a storage engine implemented * 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 using SQLite and a content-exchange protocol based on MDP and HTTP for the
pervasive dissemination of content like images, videos, documents, software pervasive dissemination of content like images, videos, documents, software
upgrades, etc. Each piece of content in Rhizome is called a “bundle”, which upgrades, etc. Each piece of content in Rhizome is called a “bundle”, which
@ -40,13 +49,13 @@ implemented in [GNU C][]:
identifier that allows any recipient to verify that it has not been tampered identifier that allows any recipient to verify that it has not been tampered
with. with.
* The **MeshMS** messaging service is implemented using Rhizome as its * The **[MeshMS][]** messaging service is implemented using Rhizome as its
transport, with each thread represented as a pair of bundles, one for each transport, with each thread represented as a pair of bundles, one for each
direction. At present, the MeshMS logic is implemented in Java within the direction. At present, the MeshMS logic is implemented in Java within the
[Serval Mesh][batphone] Android app, but is planned to be re-implemented in [Serval Mesh][batphone] Android app, but is planned to be re-implemented in
C as part of Serval DNA (see [issue #28][]). C as part of Serval DNA (see [issue #28][]).
* **Serval Infrastructure** services may optionally be deployed on any devices * **[Serval Infrastructure][]** services may optionally be deployed on any devices
in the mesh to expose external services to mesh subscribers and vice versa in the mesh to expose external services to mesh subscribers and vice versa
(eg, VoIP gateways, SMS satellite links, packetised web), and to overcome (eg, VoIP gateways, SMS satellite links, packetised web), and to overcome
scalability limitations of a perfectly decentralised mesh (eg, central scalability limitations of a perfectly decentralised mesh (eg, central
@ -64,10 +73,10 @@ Serval DNA is [free software][] produced by the [Serval Project][] and many
License version 2][GPL2]. All source code is freely available from the Serval License version 2][GPL2]. All source code is freely available from the Serval
Project's [serval-dna][] Git repository on [GitHub][]. Project's [serval-dna][] Git repository on [GitHub][].
The copyright in most of the source code in Serval DNA is held by Serval The copyright in most of the source code in Serval DNA is held by [Serval
Project Inc., an organisation incorporated in the state of South Australia in Project Inc.][SPI], an organisation incorporated in the state of South
the Commonwealth of Australia for the purpose of developing the Serval mesh Australia in the Commonwealth of Australia for the purpose of developing the
software. Serval mesh software.
The [Serval Project][] will accept contributions from individual developers who The [Serval Project][] will accept contributions from individual developers who
have agreed to the [Serval Project Developer Agreement - Individual][individ], have agreed to the [Serval Project Developer Agreement - Individual][individ],
@ -100,6 +109,7 @@ Instructions for building and testing Serval DNA are in
[Serval Project]: http://www.servalproject.org/ [Serval Project]: http://www.servalproject.org/
[SPI]: http://developer.servalproject.org/dokuwiki/doku.php?id=content:spi
[serval-dna]: https://github.com/servalproject/serval-dna [serval-dna]: https://github.com/servalproject/serval-dna
[batphone]: https://github.com/servalproject/batphone [batphone]: https://github.com/servalproject/batphone
[issue #28]: https://github.com/servalproject/serval-dna/issues/28 [issue #28]: https://github.com/servalproject/serval-dna/issues/28
@ -109,7 +119,14 @@ Instructions for building and testing Serval DNA are in
[contributors]: /servalproject/serval-dna/blob/master/CONTRIBUTORS.md [contributors]: /servalproject/serval-dna/blob/master/CONTRIBUTORS.md
[GitHub]: https://github.com/servalproject [GitHub]: https://github.com/servalproject
[GPL2]: http://www.gnu.org/licenses/gpl-2.0.html [GPL2]: http://www.gnu.org/licenses/gpl-2.0.html
[individ]: http://developer.servalproject.org/dokuwiki/lib/exe/fetch.php?media=content:software:developeragreements:serval_project_inc-individual.pdf [individ]: http://developer.servalproject.org/files/serval_project_inc-individual.pdf
[entity]: http://developer.servalproject.org/dokuwiki/lib/exe/fetch.php?media=content:software:developeragreements:serval_project_inc-entity.pdf [entity]: http://developer.servalproject.org/files/serval_project_inc-entity.pdf
[Distributed Numbering Architecture (DNA)]: http://developer.servalproject.org/dokuwiki/doku.php?id=content:tech:dna
[Serval Keyring]: http://developer.servalproject.org/dokuwiki/doku.php?id=content:tech:keyring
[Mesh Datagram Protocol (MDP)]: http://developer.servalproject.org/dokuwiki/doku.php?id=content:tech:mdp
[VoMP]: http://developer.servalproject.org/dokuwiki/doku.php?id=content:tech:vomp
[Rhizome]: http://developer.servalproject.org/dokuwiki/doku.php?id=content:tech:rhizome
[MeshMS]: http://developer.servalproject.org/dokuwiki/doku.php?id=content:tech:meshms
[Serval Infrastructure]: http://developer.servalproject.org/dokuwiki/doku.php?id=content:tech:serval_infrastructure
[JNI]: http://en.wikipedia.org/wiki/Java_Native_Interface [JNI]: http://en.wikipedia.org/wiki/Java_Native_Interface
[pipe]: http://www.kernel.org/doc/man-pages/online/pages/man2/pipe.2.html [pipe]: http://www.kernel.org/doc/man-pages/online/pages/man2/pipe.2.html