IP2

IP2(Internet Protocol 2) is a p2p(peer to peer), decentralized and server-less networking protocol based on UDP. It is designed for restriction free "public key to public key" overlay communication on UDP. IP2 uses self-generated 256 bits public key as address, while previous Internet Protocol RFC 791 uses hierarchically assigned address ether IPv4 or IPv6 to communicate. And importantly IP2 is not easily affacted by network devices such as router, firewall and NAT. So it can adapt to IOT network very well.

Roadmap

libTAU

libTAU is forked from libtorrent. libtorrent uses ip address as node id for DHT network. Differently, libTAU uses public key as its node id, so the nodes with the nearest public key automatically compose a "captrue swarm". By "captrue swarm" a node can be located very easily.

IP2

IP2 is forked from libTAU. Compared with libTAU, BLOB(Binary Large Object) can be transfered.

Building

See building.md for more details on how to build and install.

Usage

API

See API for more details on how to call ip2 API.

Example

1. launch ip2 session

	char hex_device_id[32 + 1]={}; // the last char is used for '\0'
	// device id is the random 16 bytes

	char hex_account_seed[64 + 1]={}; // the last char is used for '\0'
	// hex string of ed25519 seed. If not exist, create it by 'dht::ed25519_create_seed()'

	settings_pack sp_set;

	sp_set.set_str(settings_pack::device_id, device_id);
	sp_set.set_str(settings_pack::account_seed, account_seed);

	// 'true' is client mode, and 'false' is the servr mode
	sp_set.set_bool(settings_pack::dht_non_referrable, true);

	sp_set.set_str(settings_pack::dht_bootstrap_nodes, bootstrap_nodes);
	// bootstrap nodes format: tau:://<hex string of public_key>@<ip>:<port>
	// tau://9CB3E5A7B060D06A6A47E0E9AFCE4455077B0F5B313E7FF105A48A6D7AF356C7@10.0.2.15:6881
	sp_set.set_str(settings_pack::listen_interfaces, listen_interfaces.str());
	// listen interface format: <ip>:<port>, etc. 192.168.2.120:6881

	session_params sp_param(sp_set);
	session ses(sp_param);

For more detail, please see ip-shell main function.

2. dispatch alerts

	std::vector<alert*> alert_queue;
	bool quit = false;
	while (!quit)
	{
		ses.pop_alerts(&alert_queue);
		for(std::vector<alert*>::iterator i = alert_queue.begin()
			, end(alert_queue.end()); i != end; ++i)
		{
			int alert_type = (*i)->type();
			switch(alert_type){
			case put_data_alert::alert_type:// put blob done
				break;
			case relay_data_uri_alert::alert_type: // relay uri done
				break;
			case incoming_relay_data_uri_alert::alert_type:// incoming relay uri
				break;
			case get_data_alert::alert_type:// get blob done
				break;
			case relay_message_alert::alert_type: // relay message done
				break;
			case incoming_relay_message_alert::alert_type: // incoming relay message
				break;
			}
		}
	}

For more detail, please see ip-shell main function.

3. call IP2 API

	error_code ec = ses.put_data_into_swarm(blob, uri);
	error_code ec = ses.relay_data_uri(receiver, uri, timestamp);
	error_code ec = ses.get_data_from_swarm(sender, uri, timestamp);
	error_code ec = ses.relay_message(receiver, message);

For more detail, please see ip2-shell rpc commands.

Contribute

Now libip2 is just alpha version. If any problems, please help us with the open issues.