Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
routing
Primary Maintainer: Benjamin Bollen (benjamin.bollen@maidsafe.net)
Secondary Maintainer: Peter Jankuliak (peter.jankuliak@maidsafe.net)
Routing - a specialised storage DHT
Crate | Travis | Windows | OSX | Coverage |
---|---|---|---|---|
| API Documentation| MaidSafe System Documention | MaidSafe web site | Safe Community site |
#Overview
A secured DHT, based on a kademlia-like 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 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, creating a server-less and autonomous network.
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 is recommended. The slides for XOR Distance Metric and Basic Routing lecture are also available here. The last video from the series on how the same ideas were applied to decentralised BitTorrent trackers is available here. A proper formalisation of the Routing algorithm is in progress.
###Pre-requisite: libsodium is a native dependency for sodiumxoide. Thus, install sodium by following the instructions here.
For windows, download and use the prebuilt mingw library. 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.5] - essential logical corrections
- MAID-1007 limit swarm to targeted group
- MAID-1032 correct name calculation of pure Id
- MAID-1034 ConnectResponse needs to include original signed ConnectRequest
[0.1.6] - activate security features
- MAID-1037 Address relocation
- MAID-1042 Sentinel
- MAID-1043 remove old sentinel
- MAID-1045 plug in Sentinel Reference document
- MAID-1046 break down (header, body) into correct (request, claim) and dispatch
- MAID-1048 Ensure correct dispatch of GetGroupKeyResponse
- MAID-1049 update signature of handler functions to request and claim
- MAID-1050 block messages at filter once Sentinel has resolved
- MAID-1051 update construction of message_header
[0.1.7] - restructure core of routing
- MAID-1052 Message Handling
- MAID-1054 move all handler functions to separate module
- MAID-1055 full review of implementation of handlers
- MAID-1057 make event loop in routing_node internal
- MAID-1059 rename types::Action -> types::MessageAction; rename RoutingNodeAction -> MethodCall
- MAID-1060 Interface handle Result < Option < Action >, >
- MAID-1062 extract all_connections into a module
- MAID-1063 replace MessageTypeTag with full enum.
- MAID-1064 POC first and move UnauthorisedPut into explicit message structure.
- MAID-1065 Return Result for Put Get Post
- MAID-1066 Routing Example : update to internal event loop
[0.1.8] - activate account transfer
- MAID-1067 Remove merge from Sendable
- MAID-1068 Account Transfer message
- MAID-1069 OurCloseGroup Authority