Skip to content

savoirfairelinux/dhtnet

Repository files navigation

DHTNet - Lightweight Peer-to-Peer Communication Library

DHTNet Logo

DHTNet is a C++17 library designed to serve as a network overlay that provides an IP network abstraction. Its main objective is to establish secure peer-to-peer connections using public-key authentication.

Dhtnet allows you to connect with a device simply by knowing its public key and efficiently manages peer discovery and connectivity establishment, including NAT traversal.

Features

  • Connection Management: DHTNet simplifies the establishment and management of connections to peers, streamlining the communication process.

  • Multiplexed Sockets: It provides multiplexed sockets that allow multiple channels for data transmission, optimizing network resources.

  • UPnP Integration: DHTNet seamlessly integrates with UPnP, enabling automatic port mapping and enhanced network connectivity.

  • Server TURN Support: DHTNet includes support for server TURN, used as a fallback for connections if the NAT block all possible connections.

Documentation

For detailed information on using DHTNet, consult our documentation:

Getting Started

Get started with DHTNet by building and installing the library:

Usage Example

In the example repository, there is a client-server application where the client connects to the server and sends a "hello" message. You can build the example using the project's Build and Install Instructions with -BUILS_EXAMPLE=ON. Demo

Dependencies

DHTNet depends on the following libraries:

  • OpenDHT 2.6, used to launch DHT nodes.
  • pjproject (our fork), used for ICE negotiation.
  • msgpack-c 1.3+, used for data serialization.
  • GnuTLS 3.3+, used for cryptographic operations.
  • Nettle 2.4+, a GnuTLS dependency for crypto.
  • {fmt} 9.0+, for log formatting.
  • Argon2, a dependency for key stretching.
  • Readline, an optional dependency for the DHT tools.

See also

dnc is a command-line program that provides network connectivity between peers in a Distributed Hash Table (DHT) network. It allows peers to establish connections with other peers and create a TCP socket on a remote devices, similar to the behavior of the traditional nc utility.

dsh is a Distributed Shell command-line program that enables peers to establish connections with other peers in a Distributed Hash Table (DHT) network and execute a binary on the remote target.

dvpn is a VPN tool built on the foundation of the DHTNet library. dvpn supports both server and client modes, offering flexibility in deployment sceanrios.

dhtnet-crtmgr is a command-line tool designed to manage certificates for the DHTNet network. It provides functionality for generating and signing certificates.

Using Different Certificates

If the client and server are on the same machine, they should use different certificates for authentication, so make sure to specify different identity file paths for the client and server. This ensures that they use separate certificates.

Report issues

Report issues on Gitlab: https://git.jami.net/savoirfairelinux/dhtnet/-/issues