README ¶
Insolar – Host Network
Physical networking layer
Overview
We took Kademlia DHT original specifications and made significant improvements to make it ready for real world application by enterprises.
Key features of our blockchain network layer:
- Support of heterogeneous network topology with different types of hosts being able to communicate with each other. In classic peer-to-peer networks, any host can communicate directly with any other host on the network. In a real enterprise environment, this condition is often unacceptable for a variety of reasons including security.
- Network routing with a host or host group becoming relays for others hosts. The network can continue to function despite various network restrictions such as firewalls, NATs, etc.
- Ability to limit number of gateways to corporate host group via relays to keep the host group secure while being able to interact with the rest of the network through relays. This feature mitigates the risk of DDoS attacks.
Key components
Transport
Network transport interface. It allows to abstract our network from physical transport. It can either be IP based network or any other kind of packet courier (e.g. an industrial packet bus).
Host
Host is a fundamental part of networking system. Each host has:
- one real network address (IP or any other transport protocol address)
- multiple abstract network IDs (either host's own or ones belonging to relayed hosts)
Routing
It is actually a Kademlia hash table used to store network hosts and calculate distances between them. See Kademlia whitepaper and XLattice design specification for details.
Packet
A set of data transferred by this module between hosts.
- Request packet
- Response packet
Now packets are serialized simply with encoding/gob. In future there will be a powerful robust serialization system based on Google's Protocol Buffers.
RPC
RPC module allows higher level components to register methods that can be called by other network hosts.
Usage
package main
import (
"github.com/insolar/insolar/network/hostnetwork"
"github.com/insolar/insolar/configuration"
)
func main() {
cfg := configuration.NewConfiguration().Host
cfg.Address = "0.0.0.0:31337"
network, err := hostnetwork.NewHostNetwork(cfg)
if err != nil {
panic(err)
}
defer network.Disconnect()
network.Listen()
}
For more detailed usage example see cmd/example/network/hostnetwork/main.go
Documentation ¶
Overview ¶
Package hostnetwork is an implementation of Kademlia DHT. It is mostly based on original specification but has multiple backward-incompatible changes.
Usage:
package main import ( "github.com/insolar/insolar/network/hostnetwork" "github.com/insolar/insolar/configuration" ) func main() { cfg := configuration.NewConfiguration().Host cfg.Address = "0.0.0.0:31337" network, err := hostnetwork.NewHostNetwork(cfg) if err != nil { panic(err) } defer network.Disconnect() network.Listen() }
Index ¶
- type AuthInfo
- type Context
- type ContextBuilder
- type DHT
- func (dht *DHT) AnalyzeNetwork(ctx Context) error
- func (dht *DHT) AuthenticationRequest(ctx Context, command, targetID string) error
- func (dht *DHT) Bootstrap() error
- func (dht *DHT) CheckNodeRole(ctx Context, domainID string) error
- func (dht *DHT) CheckOriginRequest(ctx Context, targetID string) error
- func (dht *DHT) Disconnect()
- func (dht *DHT) FindHost(ctx Context, key string) (*host.Host, bool, error)
- func (dht *DHT) Get(ctx Context, key string) ([]byte, bool, error)
- func (dht *DHT) GetDistance(id1, id2 []byte) *big.Int
- func (dht *DHT) GetOriginHost(ctx Context) *host.Host
- func (dht *DHT) Listen() error
- func (dht *DHT) NumHosts(ctx Context) int
- func (dht *DHT) ObtainIP(ctx Context) error
- func (dht *DHT) ObtainIPRequest(ctx Context, targetID string) error
- func (dht *DHT) RelayRequest(ctx Context, command, targetID string) error
- func (dht *DHT) RemoteProcedureCall(ctx Context, target string, method string, args [][]byte) (result []byte, err error)
- func (dht *DHT) RemoteProcedureRegister(name string, method core.RemoteProcedure)
- func (dht *DHT) Store(ctx Context, data []byte) (id string, err error)
- type HighKnownOuterHostsHost
- type Options
- type RPC
- type Subnet
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthInfo ¶
type AuthInfo struct { // Sent/received unique auth keys. SentKeys map[string][]byte ReceivedKeys map[string][]byte // contains filtered or unexported fields }
AuthInfo collects some information about authentication.
type Context ¶
Context type is localized for future purposes. Network Host can have multiple IDs, but each action must be executed with only one ID. Context is used in all actions to select specific ID to work with.
type ContextBuilder ¶
type ContextBuilder struct {
// contains filtered or unexported fields
}
ContextBuilder allows to lazy configure and build new Context.
func NewContextBuilder ¶
func NewContextBuilder(dht *DHT) ContextBuilder
NewContextBuilder creates new ContextBuilder.
func (ContextBuilder) Build ¶
func (cb ContextBuilder) Build() (ctx Context, err error)
Build builds and returns new Context.
func (ContextBuilder) SetDefaultHost ¶
func (cb ContextBuilder) SetDefaultHost() ContextBuilder
SetDefaultHost sets first host id in Context.
func (ContextBuilder) SetHostByID ¶
func (cb ContextBuilder) SetHostByID(hostID id.ID) ContextBuilder
SetHostByID sets host id in Context.
type DHT ¶
type DHT struct {
// contains filtered or unexported fields
}
DHT represents the state of the local host in the distributed hash table.
func NewDHT ¶
func NewDHT(store store.Store, origin *host.Origin, transport transport.Transport, rpc rpc.RPC, options *Options, proxy relay.Proxy) (dht *DHT, err error)
NewDHT initializes a new DHT host.
func NewHostNetwork ¶ added in v0.0.5
func NewHostNetwork(cfg configuration.HostNetwork) (*DHT, error)
NewHostNetwork creates and returns DHT network.
func (*DHT) AnalyzeNetwork ¶
AnalyzeNetwork is func to analyze the network after IP obtaining.
func (*DHT) AuthenticationRequest ¶
AuthenticationRequest sends an authentication request.
func (*DHT) Bootstrap ¶
Bootstrap attempts to bootstrap the network using the BootstrapHosts provided to the Options struct. This will trigger an iterateBootstrap to the provided BootstrapHosts.
func (*DHT) CheckNodeRole ¶ added in v0.0.5
CheckNodeRole starting a check all known nodes.
func (*DHT) CheckOriginRequest ¶
CheckOriginRequest send a request to check target host originality
func (*DHT) Disconnect ¶
func (dht *DHT) Disconnect()
Disconnect will trigger a Stop from the network.
func (*DHT) Get ¶
Get retrieves data from the transport using key. Key is the base58 encoded identifier of the data.
func (*DHT) GetDistance ¶
GetDistance returns a distance between id1 and id2.
func (*DHT) GetOriginHost ¶ added in v0.0.5
GetOriginHost returns the local host.
func (*DHT) NumHosts ¶
NumHosts returns the total number of hosts stored in the local routing table.
func (*DHT) ObtainIPRequest ¶
ObtainIPRequest is request to self IP obtaining.
func (*DHT) RelayRequest ¶
RelayRequest sends relay request to target.
func (*DHT) RemoteProcedureCall ¶
func (dht *DHT) RemoteProcedureCall(ctx Context, target string, method string, args [][]byte) (result []byte, err error)
RemoteProcedureCall calls remote procedure on target host.
func (*DHT) RemoteProcedureRegister ¶
func (dht *DHT) RemoteProcedureRegister(name string, method core.RemoteProcedure)
RemoteProcedureRegister registers procedure for remote call on this host
type HighKnownOuterHostsHost ¶
type HighKnownOuterHostsHost struct { ID string OuterHosts int // high known outer hosts by ID host SelfKnownOuterHosts int }
HighKnownOuterHostsHost collects an information about host in home subnet which have a more known outer hosts.
type Options ¶
type Options struct { // The hosts being used to bootstrap the network. Without a bootstrap // host there is no way to connect to the network. NetworkHosts can be // initialized via host.NewHost(). BootstrapHosts []*host.Host // The time after which a key/value pair expires; // this is a time-to-live (TTL) from the original publication date. ExpirationTime time.Duration // Seconds after which an otherwise unaccessed bucket must be refreshed. RefreshTime time.Duration // The interval between Kademlia replication events, when a host is // required to publish its entire database. ReplicateTime time.Duration // The time after which the original publisher must // republish a key/value pair. Currently not implemented. RepublishTime time.Duration // The maximum time to wait for a response from a host before discarding // it from the bucket. PingTimeout time.Duration // The maximum time to wait for a response to any packet. PacketTimeout time.Duration }
Options contains configuration options for the local host.
Directories ¶
Path | Synopsis |
---|---|
Package connection encapsulates connection creation process and provides connection factories.
|
Package connection encapsulates connection creation process and provides connection factories. |
Package host is a fundamental part of networking system.
|
Package host is a fundamental part of networking system. |
Package packet provides network messaging protocol and serialization layer.
|
Package packet provides network messaging protocol and serialization layer. |
Package relay is an implementation of relay mechanism.
|
Package relay is an implementation of relay mechanism. |
Package resolver provides interface (and default implementation) to retrieve public network address.
|
Package resolver provides interface (and default implementation) to retrieve public network address. |
Package routing implements Kademlia hash tables with XOR distance metrics.
|
Package routing implements Kademlia hash tables with XOR distance metrics. |
Package rpc allows higher level components to register methods that can be called by other network hosts.
|
Package rpc allows higher level components to register methods that can be called by other network hosts. |
Package store provides interfaces and default in-memory implementation of storage for DHT metadata.
|
Package store provides interfaces and default in-memory implementation of storage for DHT metadata. |
Package transport provides network transport interface.
|
Package transport provides network transport interface. |