1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
// Copyright 2015 MaidSafe.net limited. // // This SAFE Network Software is licensed to you under (1) the MaidSafe.net Commercial License, // version 1.0 or later, or (2) The General Public License (GPL), version 3, depending on which // licence you accepted on initial access to the Software (the "Licences"). // // By contributing code to the SAFE Network Software, or to this project generally, you agree to be // bound by the terms of the MaidSafe Contributor Agreement. This, along with the Licenses can be // found in the root directory of this project at LICENSE, COPYING and CONTRIBUTOR. // // Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed // under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY // KIND, either express or implied. // // Please review the Licences for the specific language governing permissions and limitations // relating to use of the SAFE Network Software. //! Client and node implementations for a resilient decentralised network. //! //! The network is based on the [`kademlia_routing_table`][1] and uses the XOR metric to define the //! "distance" between two [`XorName`][2]s. `XorName`s are used as addresses of nodes, clients as //! well as data. //! //! [1]: ../kademlia_routing_table/index.html //! [2]: ../xor_name/struct.XorName.html //! //! Messages are exchanged between _authorities_, where an `Authority` can be an individual client //! or node, or a collection of nodes called a "section", or a subset of a section called a "group". //! In all cases, messages are cryptographically signed by the sender, and in the case of sections //! and groups, it is verified that a sufficient number of members agree on the message: only if //! that quorum is reached, the message is delivered. In addition, each message has a unique ID, and //! is delivered only once. //! //! Section and group authorities are also addressed using a single `XorName`. The members are the //! nodes that are closest to that name. Sections contain a minimum number of nodes with the minimum //! value specified as a network-wide constant. Groups are of fixed size, defined as the above //! minimum section size. Since nodes are assigned their name by the network, this provides //! redundancy and resilience: a node has no control over which section or group authority it will //! be a member of, and without a majority in the section or group it cannot forge a message from //! there. //! //! The library also provides different types for the messages' data. //! //! //! # Usage //! //! A decentralised service based on the `routing` library uses `Client` to send requests to the //! network of nodes and receive responses. //! //! `Node` is used to handle and send requests within that network, and to implement its //! functionality, e.g. storing and retrieving data, validating permissions, managing metadata, etc. //! //! //! ## Client creation //! //! A client's name is a hash of its public keys. Upon creation, the client will attempt to connect //! to the network through any node, and exchange public keys with it. That node becomes a //! bootstrap node for the client, and messages to and from the client will be routed over it. //! //! ```no_run //! # #![allow(unused)] //! use std::sync::mpsc; //! use routing::{Client, Event, FullId}; //! //! let (sender, receiver) = mpsc::channel::<Event>(); //! let full_id = FullId::new(); // Generate new keys. //! # #[cfg(not(feature = "use-mock-crust"))] //! let client = Client::new(sender, Some(full_id)).unwrap(); //! ``` //! //! Messages can be sent using the methods of `client`, and received as `Event`s from the //! `receiver`. //! //! //! ## Node creation //! //! Creating a node looks even simpler: //! //! ```no_run //! # #![allow(unused)] //! use routing::Node; //! //! let min_section_size = 8; //! let node = Node::builder().create(min_section_size).unwrap(); //! ``` //! //! Upon creation, the node will first connect to the network as a client. Once it has client //! status, it requests a new name from the network, and then integrates itself in the network with //! that new name, adding close nodes to its routing table. //! //! Messages can be sent using the methods of `node`, and received as `Event`s from the `receiver`. //! The node can act as an individual node or as part of a section or group authority. Sending a //! message as a section or group authority only has an effect if sufficiently many other nodes in //! that authority send the same message. //! //! //! # Sequence diagrams //! //! - [Bootstrapping](bootstrap.png) //! - [Churn (`NewNode`)](new-node.png) //! - [Tunnel](tunnel.png) #![doc(html_logo_url = "https://raw.githubusercontent.com/maidsafe/QA/master/Images/maidsafe_logo.png", html_favicon_url = "https://maidsafe.net/img/favicon.ico", html_root_url = "https://docs.rs/routing")] // For explanation of lint checks, run `rustc -W help` or see // https://github.com/maidsafe/QA/blob/master/Documentation/Rust%20Lint%20Checks.md #![forbid(exceeding_bitshifts, mutable_transmutes, no_mangle_const_items, unknown_crate_types, warnings)] #![deny(bad_style, deprecated, improper_ctypes, missing_docs, non_shorthand_field_patterns, overflowing_literals, plugin_as_library, private_no_mangle_fns, private_no_mangle_statics, stable_features, unconditional_recursion, unknown_lints, unsafe_code, unused, unused_allocation, unused_attributes, unused_comparisons, unused_features, unused_parens, while_true)] #![warn(trivial_casts, trivial_numeric_casts, unused_extern_crates, unused_import_braces, unused_qualifications, unused_results)] #![allow(box_pointers, fat_ptr_transmutes, missing_copy_implementations, missing_debug_implementations, variant_size_differences, non_camel_case_types)] #![cfg_attr(feature="cargo-clippy", deny(unicode_not_nfc, wrong_pub_self_convention, option_unwrap_used))] // Allow `panic_params` until https://github.com/Manishearth/rust-clippy/issues/768 is resolved. #![cfg_attr(feature="cargo-clippy", allow(panic_params))] extern crate hex; #[macro_use] extern crate log; #[cfg(feature = "use-mock-crust")] extern crate fake_clock; extern crate maidsafe_utilities; #[macro_use] extern crate quick_error; #[macro_use] extern crate unwrap; #[cfg(not(feature = "use-mock-crust"))] extern crate crust; extern crate itertools; extern crate lru_time_cache; extern crate num_bigint; extern crate rand; extern crate resource_proof; extern crate rust_sodium; extern crate serde; #[macro_use] extern crate serde_derive; extern crate tiny_keccak; // Needs to be before all other modules to make the macros available to them. #[macro_use] mod macros; mod ack_manager; mod action; mod client; mod cache; mod data; mod error; mod event; mod event_stream; mod section_list_cache; mod id; mod message_filter; mod messages; mod node; mod outbox; mod peer_manager; mod resource_prover; mod routing_message_filter; mod routing_table; mod signature_accumulator; mod state_machine; mod states; mod stats; mod timer; mod tunnels; mod types; mod utils; mod xor_name; /// Mock crust #[cfg(feature = "use-mock-crust")] pub mod mock_crust; /// SHA-3 type alias. pub mod sha3; /// Messaging infrastructure pub mod messaging; /// Error communication between vaults and core pub mod client_errors; /// Structured Data Tag for Session Packet Type pub const TYPE_TAG_SESSION_PACKET: u64 = 0; /// Structured Data Tag for DNS Packet Type pub const TYPE_TAG_DNS_PACKET: u64 = 5; /// Quorum is defined as having strictly greater than `QUORUM_NUMERATOR / QUORUM_DENOMINATOR` /// agreement; using only integer arithmetic a quorum can be checked with /// `votes * QUORUM_DENOMINATOR > voters * QUORUM_NUMERATOR`. pub const QUORUM_NUMERATOR: usize = 1; /// See `QUORUM_NUMERATOR`. pub const QUORUM_DENOMINATOR: usize = 2; pub use cache::{Cache, NullCache}; pub use client::Client; pub use data::{AppendWrapper, AppendedData, Data, DataIdentifier, Filter, ImmutableData, MAX_IMMUTABLE_DATA_SIZE_IN_BYTES, MAX_PRIV_APPENDABLE_DATA_SIZE_IN_BYTES, MAX_PUB_APPENDABLE_DATA_SIZE_IN_BYTES, MAX_STRUCTURED_DATA_SIZE_IN_BYTES, NO_OWNER_PUB_KEY, PrivAppendableData, PrivAppendedData, PubAppendableData, StructuredData}; pub use error::{InterfaceError, RoutingError}; pub use event::Event; pub use event_stream::EventStream; pub use id::{FullId, PublicId}; pub use messages::{Request, Response}; #[cfg(feature = "use-mock-crust")] pub use mock_crust::crust; pub use node::{Node, NodeBuilder}; #[cfg(feature = "use-mock-crust")] pub use peer_manager::test_consts; pub use routing_table::{Authority, Prefix, RoutingTable, Xorable}; pub use routing_table::Error as RoutingTableError; #[cfg(any(test, feature = "use-mock-crust"))] pub use routing_table::verify_network_invariant; pub use types::MessageId; pub use xor_name::{XOR_NAME_BITS, XOR_NAME_LEN, XorName, XorNameFromHexError}; type Service = crust::Service<PublicId>; use crust::Event as CrustEvent; type CrustEventSender = crust::CrustEventSender<PublicId>; type PrivConnectionInfo = crust::PrivConnectionInfo<PublicId>; type PubConnectionInfo = crust::PubConnectionInfo<PublicId>; #[cfg(test)] mod tests { use super::{QUORUM_DENOMINATOR, QUORUM_NUMERATOR}; #[test] #[cfg_attr(feature="cargo-clippy", allow(eq_op))] fn quorum_check() { assert!(QUORUM_NUMERATOR < QUORUM_DENOMINATOR, "Quorum impossible to achieve"); assert!(QUORUM_NUMERATOR * 2 >= QUORUM_DENOMINATOR, "Quorum does not guarantee agreement"); } }