routing 0.1.1

This is Pre alpha, and not useful, no code worth looking at.
docs.rs failed to build routing-0.1.1
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.
Visit the last successful build: routing-0.37.0

routing

Routing - specialised storage DHT

Crate Travis Appveyor Coverage
Build Status Build status Coverage Status

| 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, this allows easier NAT traversal and makes more efficient use of routers and larger networks. This also allows very fast reconfiguration of network changes and aleviates the requirement of 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 us to make use of groups as fixed in relation to any address, in a continually fluid network as described here and create serverless networks that can provide fully autonomous networks.

This is a very under-researched area. For a general introduction to some of the ideas behind the design related to XOR Space, please see the videos in The SAFE Network from First Principles series. 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 decentralized the Bittorrent trackers is available here. A proper formalization 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.

SQLite3 is also native dependency for rustsqlite. Steps to compile SQLite by,

  1. Download SQLite Source code which includes a "configure" script from SQLite download page
  2. On Linux, Run ./configure --prefix=/usr && make && sudo make install to build the SQLite source. While on Windows Users can build using (mingw + msys) and run './configure && make'
  3. On Windows, Copy the libsqlite3.a file from the .libs folder to the "bin{TARGET-TRIPLE}" (i.e. i686-pc-win32 or x86_64-pc-win32 etc.) in the project root folder (or at least in your path).

##Todo Items

  • Set up facade design pattern
  • Test facade pattern
  • Set up accumulator
  • Accumulator tests
  • Message header
  • Message header tests
  • API version 0.0.6
  • Bootstrap handler implementation
  • Bootstrap handler test
  • Create sort and bucket index methods
  • Implement routing table
  • Test routing table
  • Implement sentinel (initial)
  • Finalise sentinel in line with tests
  • Implement client node
  • Test sentinel
  • Implement routing message types (Connect FindNode)
  • Test message types
  • Implement Get Put Post messages
  • Version 0.0.8
  • Test client node
  • Test basic facade (normal DHT Get Put with republish)
  • Move bootstrap out of routing
  • Complete Client Interface (Facade)
  • Complete Routing Node Interface to accomodate churn
  • Add caching to node interface
  • Implement routing node (100%)
  • Implement PUT in routing
  • Handle PMID Caching
  • Split Message handling
  • Check Authority (see Jira 954)
  • Implement routing connections management
  • Sentinel:
    • Handover existing implementation
    • Account transfer merge
    • Group response merge
    • Signature checks
    • QA Sentinel including code review from system design perspective
  • Examples:
    • Routing Node with type erased cache
    • Routing Client accepting key, value as string for GET/PUT
    • Local Network Test. 12 Linux, 2 OSX, 2 WIN
    • 101 Droplet test
  • zero state network
  • Test node network (process on single machine)
  • Test node network (local area network (12 linux 2 OSX 2 Win)
  • Test node network (across digital ocean images (256 nodes)
  • Version 0.1 (crates.io)
  • Address re-location (security essential)
  • Implement NAT traversal (requires crust v0.1.0)