dtn7-rs

Crates.io Docs.rs Build status License: MIT License: Apache 2.0

Rust implementation of a daemon for DTN7 Bundle Protocol draft https://tools.ietf.org/html/draft-ietf-dtn-bpbis-23

Plus: * Minimal TCP Convergence Layer Protocol https://tools.ietf.org/html/draft-ietf-dtn-mtcpcl-01 * A simple HTTP Convergence Layer * Convenient command line tools to interact with the daemon * A simple web interface for status information about dtnd * A web-socket interface for application agents

A similar golang implementation can be found here: https://github.com/dtn7/dtn7-go

The actual BP7 implementation can be found here: https://github.com/dtn7/bp7-rs

Currently a very basic service discovery, MTCP & HTTP CLs, flooding/epidemic/sink-routing and a rest command interface are implemented. Both addressing schemes, dtn as well as ipn are supported.

Beware, the API is not always idiomatic rust and lacks documentation and tests at the moment.

I consider this code to be work-in-progress and not finished yet. Also the rest and web-socket interface is totally undocumented and unfinished at the moment:)

Installation

Installation from source using cargo: cargo install dtn7

Usage

Daemon

``` $ dtnd -h dtn7-rs 0.6.0 Lars Baumgaertner baumgaertner@cs.tu-darmstadt.de A simple Bundle Protocol 7 Daemon for Delay Tolerant Networking

USAGE: dtnd [FLAGS] [OPTIONS]

FLAGS: -d, --debug Set log level to debug -h, --help Prints help information -V, --version Prints version information

OPTIONS: -C, --cla Sets a custom config file -e, --endpoint ... Registers an application agent for a node local endpoint (e.g. 'incoming' listens on 'dtn://node1/incoming') -i, --interval Sets service discovery interval (0 = deactive) -j, --janitor Sets janitor interval (0 = deactive) -n, --nodeid Sets local node name (e.g. 'dtn://node1') -p, --peer-timeout Sets timeout to remove peer -r, --routing Set routing algorithm: epidemic, flooding, sink -s, --static-peer ... Adds a static peer (e.g. mtcp://192.168.2.1:2342/node2) -w, --web-port Sets web interface port (default = 3000) ```

Example usage for node1 with epidemic routing, mtcp convergence layer and the default endpoint 'incoming': $ dtnd -n node1 -r epidemic -C mtcp -e incoming

The same but with ipn addressing scheme and a default endpoint at 23.42: $ dtnd -n 23 -r epidemic -C mtcp -e 42

Configuration can also happen via a config file. For an example take a look at examples/dtn7.toml.example.

Helpers

Querying information from dtnd: ``` $ dtnquery -h dtnquery 0.6.0 Lars Baumgaertner baumgaertner@cs.tu-darmstadt.de A simple Bundle Protocol 7 Query Utility for Delay Tolerant Networking

USAGE: dtnquery [OPTIONS] [SUBCOMMAND]

FLAGS: -h, --help Prints help information -V, --version Prints version information

OPTIONS: -p, --port Local web port (default = 3000)

SUBCOMMANDS: bundles list bundles in node eids list registered endpoint IDs help Prints this message or the help of the given subcommand(s) info General dtnd info nodeid Local node id peers list known peers store list bundles status in store ```

Receiving bundles: ``` $ dtnrecv -h dtnrecv 0.4.0 Lars Baumgaertner baumgaertner@cs.tu-darmstadt.de A simple Bundle Protocol 7 Receive Utility for Delay Tolerant Networking

USAGE: dtnrecv [FLAGS] [OPTIONS] --endpoint

FLAGS: -h, --help Prints help information -V, --version Prints version information -v, --verbose verbose output

OPTIONS: -e, --endpoint Specify local endpoint, e.g. '/incoming') -o, --output Write bundle payload to file instead of stdout -p, --port Local web port (default = 3000) ```

Sending bundles: ``` $ dtnsend -h dtnsend 0.6.0 Lars Baumgaertner baumgaertner@cs.tu-darmstadt.de A simple Bundle Protocol 7 Send Utility for Delay Tolerant Networking

USAGE: dtnsend [FLAGS] [OPTIONS] --receiver [infile]

FLAGS: -D, --dry-run Don't actually send packet, just dump the encoded one. -h, --help Prints help information -V, --version Prints version information -v, --verbose verbose output

OPTIONS: -p, --port Local web port (default = 3000) -r, --receiver Receiver EID (e.g. 'dtn://node2/incoming') -s, --sender Sets sender name (e.g. 'dtn://node1')

ARGS: File to send, if omitted data is read from stdin till EOF ```

Automatic triggering of external binaries for incoming bundles: ``` $ dtntrigger -h dtntrigger 0.9.0 Lars Baumgaertner baumgaertner@cs.tu-darmstadt.de A simple Bundle Protocol 7 Incoming Trigger Utility for Delay Tolerant Networking

USAGE: dtntrigger [FLAGS] [OPTIONS] --command

FLAGS: -h, --help Prints help information -6, --ipv6 Use IPv6 -V, --version Prints version information -v, --verbose verbose output

OPTIONS: -c, --command Command to execute for incoming bundles, param1 = source, param2 = payload file -e, --endpoint Specify local endpoint, e.g. '/incoming') -p, --port Local web port (default = 3000) ```

Examples

A simple DTN echo service can be found under examples/dtnecho.rs.

This service automatically registers its endpoint and listens for any incoming bundles on the local /echo endpoint or for ipn addresses on service number 7. Each bundle is sent back to its source with the same payload and lifetime, no delivery report is requested.

Acknowledging this work

If you use this software in a scientific publication, please cite the following paper:

BibTeX @INPROCEEDINGS{baumgaertner2019bdtn7, author={L. {Baumgärtner} and J. {Höchst} and T. {Meuser}}, booktitle={2019 International Conference on Information and Communication Technologies for Disaster Management (ICT-DM)}, title={B-DTN7: Browser-based Disruption-tolerant Networking via Bundle Protocol 7}, year={2019}, volume={}, number={}, pages={1-8}, keywords={Protocols;Browsers;Software;Convergence;Servers;Synchronization;Wireless fidelity}, doi={10.1109/ICT-DM47966.2019.9032944}, ISSN={2469-8822}, month={Dec}, }

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in dtn7-rs by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.