# Routing
[](http://maidsafe.net/applications) [](https://github.com/maidsafe/crust/blob/master/COPYING)
**Primary Maintainer:** Benjamin Bollen (benjamin.bollen@maidsafe.net)
**Secondary Maintainer:** Peter Jankuliak (peter.jankuliak@maidsafe.net)
Routing - a specialised storage DHT
|Crate|Linux|Windows|OSX|Coverage|Issues|
|:------:|:-------:|:-------:|:-------:|:-------:|:-------:|
|[](https://crates.io/crates/routing)|[](https://travis-ci.org/maidsafe/routing)|[](http://ci.maidsafe.net:8080/job/routing_win64_status_badge/)|[](http://ci.maidsafe.net:8080/job/routing_osx_status_badge/)|[](https://coveralls.io/r/maidsafe/routing)|[](https://waffle.io/maidsafe/routing)
| [API Documentation - Master branch](http://maidsafe.github.io/routing/routing/) | [SAFENetwork System Documention](http://systemdocs.maidsafe.net/) | [MaidSafe website](http://www.maidsafe.net) | [Safe Community site](https://forum.safenetwork.io) |
#Overview
A secured [DHT](http://en.wikipedia.org/wiki/Distributed_hash_table), based on a [kademlia-like](http://en.wikipedia.org/wiki/Kademlia) implementation, but with some very stark differences. This is a recursive as opposed to iterative network, enabling easier NAT traversal and providing more efficient use of routers and larger networks. This also allows very fast reconfiguration of network changes, aleviating the requirement for a refresh algorithm. A recursive solution based on a network protocol layer that is 'connection oriented' also allows a close group to be aligned with security protocols.
This library makes use of [Public-key cryptography](http://en.wikipedia.org/wiki/Public-key_cryptography) to allow a mechanism to ensure nodes are well recognised and cryptographically secured. This pattern
allows the creation of a DHT based PKI and this in turn allows a decentralised network to make use of groups as fixed in relation to any address. This is particularly useful in a continually fluid network as described [here,](http://maidsafe.net/Whitepapers/pdf/MaidSafeDistributedHashTable.pdf) creating a server-less and [autonomous network](http://maidsafe.net/docs/SAFEnetwork.pdf).
This is a very under researched area. For a general introduction to some of the ideas behind the design related to XOR Space, watching [The SAFE Network from First Principles series](https://www.youtube.com/watch?v=Lr9FJRDcNzk&list=PLiYqQVdgdw_sSDkdIZzDRQR9xZlsukIxD) is recommended. The slides for XOR Distance Metric and Basic Routing lecture are also [available here](http://ericklavoie.com/talks/safenetwork/1-xor-routing.pdf). The last video from the series on how the same ideas were applied to decentralised BitTorrent trackers is available [here](https://www.youtube.com/watch?v=YFV908uoLPY). A proper formalisation of the Routing algorithm is in progress.
###Pre-requisite:
libsodium is a native dependency for [sodiumxoide](https://github.com/dnaq/sodiumoxide). Thus, install sodium by following the instructions [here](http://doc.libsodium.org/installation/index.html).
For windows, download and use the [prebuilt mingw library](https://download.libsodium.org/libsodium/releases/libsodium-1.0.2-mingw.tar.gz).
Extract and place the libsodium.a file in "bin\x86_64-pc-windows-gnu" for 64bit System, or "bin\i686-pc-windows-gnu" for a 32bit system.
##Todo Items
General note: please document code you touch, and introduce property-based unit tests where applicable.
## [0.1.60] - essential logical corrections
- [x] [MAID-1007](https://maidsafe.atlassian.net/browse/MAID-1007) limit swarm to targeted group
- [x] [MAID-1105](https://maidsafe.atlassian.net/browse/MAID-1105) delay RoutingTable new ConnectRequests
- [x] [MAID-1106](https://maidsafe.atlassian.net/browse/MAID-1106) examine Not For Us
- [x] [MAID-1032](https://maidsafe.atlassian.net/browse/MAID-1032)
correct name calculation of pure Id
- [x] [MAID-1034](https://maidsafe.atlassian.net/browse/MAID-1034) ConnectResponse needs to include original signed ConnectRequest
- [x] [MAID-1043](https://maidsafe.atlassian.net/browse/MAID-1043) remove old sentinel
- [x] [MAID-1059](https://maidsafe.atlassian.net/browse/MAID-1059) rename types::Action -> types::MessageAction; rename RoutingNodeAction -> MethodCall
## [0.1.61] - Relay module, relocatable Id, update NodeInterface
- [x] [MAID-1114](https://maidsafe.atlassian.net/browse/MAID-1114) Relay module
- [x] [MAID-1060](https://maidsafe.atlassian.net/browse/MAID-1060) update Interface for Vaults
- [x] [MAID-1040](https://maidsafe.atlassian.net/browse/MAID-1040) enable Id, PublicId and NodeInfo with 'relocated' name
## [0.1.62] - restructure core of routing
- [x] [MAID-1037](https://maidsafe.atlassian.net/browse/MAID-1037) Address relocation
- [x] [MAID-1038](https://maidsafe.atlassian.net/browse/MAID-1038) Integrate handlers with RelayMap
- [x] [MAID-1039](https://maidsafe.atlassian.net/browse/MAID-1039) put_public_id handler
- [x] [MAID-1052](https://maidsafe.atlassian.net/browse/MAID-1052) Message Handling
- [x] [MAID-1055](https://maidsafe.atlassian.net/browse/MAID-1055) full review of implementation of handlers
- [x] [MAID-1057](https://maidsafe.atlassian.net/browse/MAID-1057) make event loop in routing_node internal
- [x] [MAID-1062](https://maidsafe.atlassian.net/browse/MAID-1062) extract all_connections into a module
- [x] [MAID-1070](https://maidsafe.atlassian.net/browse/MAID-1070) drop_bootstrap in coordination with CRUST
- [x] [MAID-1071](https://maidsafe.atlassian.net/browse/MAID-1071) Implement relay id exchange for client node
- [x] [MAID-1066](https://maidsafe.atlassian.net/browse/MAID-1066) Routing Example : update to internal event loop
## [0.1.63] - bug fixes
- [x] [#314](https://github.com/maidsafe/routing/issues/314) simple_key_value_store input validation lacking
- [x] [#324](https://github.com/maidsafe/routing/issues/324) simple_key_value_store peer option
- [x] [#336](https://github.com/maidsafe/routing/issues/336) Routing `0.1.62` causes API inconsistency in usage of RoutingClient
## [0.1.64] - bug fixes
- [x] [#330](https://github.com/maidsafe/routing/issues/330) Who-Are-You / I-Am message for identifying new connections
- [x] [#312](https://github.com/maidsafe/routing/issues/312) Fix never-connecting client
- [x] [#343](https://github.com/maidsafe/routing/issues/343) Filter escalating number of connect requests
- [x] [#342](https://github.com/maidsafe/routing/issues/342) Clean up overloaded debug command line printout
- [x] [#347](https://github.com/maidsafe/routing/issues/347) Relay GetDataResponses and cached GetDataResponses back to relayed node
## [0.1.70] - Activate AccountTransfer
- [x] [#354](https://github.com/maidsafe/routing/issues/354) Fix release builds
- [x] [MAID-1069](https://maidsafe.atlassian.net/browse/MAID-1069) OurCloseGroup Authority
- [x] [#363](https://github.com/maidsafe/routing/issues/363) Refresh message and ad-hoc accumulator
- [x] [#290](https://github.com/maidsafe/routing/issues/290) Remove NodeInterface::handle_get_key
- [x] [#373](https://github.com/maidsafe/routing/issues/373) Reduce group size for QA to 23
## [0.1.71] Finish Rust-2
- [x] [#360](https://github.com/maidsafe/routing/issues/360) Fix intermittent failure in Relay
- [x] [#372](https://github.com/maidsafe/routing/issues/372) Introduce unit tests for Routing Membrane
- [x] [#388](https://github.com/maidsafe/routing/issues/388) Handle PutDataResponse for routing_client
- [x] [#395](https://github.com/maidsafe/routing/issues/395) Preserve message_id
## Future sprints
- [ ] [MAID-1063](https://maidsafe.atlassian.net/browse/MAID-1063) replace MessageTypeTag with full enum.
- [ ] [MAID-1064](https://maidsafe.atlassian.net/browse/MAID-1064) POC first and move UnauthorisedPut into explicit message structure.
- [ ] [MAID-1065](https://maidsafe.atlassian.net/browse/MAID-1065) Return Result for Put Get Post-
- [ ] [MAID-1042](https://maidsafe.atlassian.net/browse/MAID-1042) Sentinel [Reference document](https://docs.google.com/document/d/1-x7pCq_YXm-P5xDi7y8UIYDbheVwJ10Q80FzgtnMD8A/edit?usp=sharing)
- [ ] [MAID-1045](https://maidsafe.atlassian.net/browse/MAID-1045) Instantiate pure Sentinel for PUT GET (POST) / from node & from group
- [ ] [MAID-1048](https://maidsafe.atlassian.net/browse/MAID-1048) Instantiate Key Sentinel for FindGroupResponse
- [ ] [MAID-1049](https://maidsafe.atlassian.net/browse/MAID-1049) Instantiate Account Sentinel for orderable Refresh / AccountTransfer messages
- [ ] [MAID-1046](https://maidsafe.atlassian.net/browse/MAID-1046) break down (header, body) into correct (request, claim) and dispatch
- [ ] update signature of handler functions to request and claim
- [ ] [MAID-1051](https://maidsafe.atlassian.net/browse/MAID-1051) update construction of message_header
- [ ] [MAID-1050](https://maidsafe.atlassian.net/browse/MAID-1050) block messages at filter once Sentinel has resolved