/dctk

Direct Connect client library (ADC and NMDC) for the Go programming language

Primary LanguageGoBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

dctk

Test Lint CodeCov PkgGoDev

dctk implements the client part of the Direct Connect peer-to-peer system (ADC and NMDC protocols) in the Go programming language. It includes:

  • a library, that allows the creation of clients capable of interacting with hubs and other clients;
  • a series of command line utilities that make use of the library.

Direct Connect is semi-centralized peer-to-peer system in which peers connect to servers (hubs) and exchange textual messages and files. Files are indexed by computing their Tiger Tree Hash (TTH), provided by users through their file list, and searchable on a hub-basis. There exist two variants, one based on the traditional NMDC protocol (NeoModus Direct Connect) and the other based on the newer ADC protocol (Advanced Direct Connect).

This project is based on the go-dc project, that provides a base layer for building DC-related software.

Features:

  • ADC and NMDC transparent protocol support
  • Active and passive mode
  • Hub: connection with configurable try count, password authentication, keepalive, compression, encryption
  • Chat: bidirectional public and private chat
  • File search: by name or TTH, reply to requests
  • File download: by name or TTH, full or partial, on ram or disk, multiple in parallel, compression, encryption, configurable download slots, validation via TTH, client fingerprint validation
  • File upload: upload from personal share, asynchronous file indexing system, file list generation and serving, compression, encryption, configurable upload slots, tthl extension support, client fingerprint validation
  • Examples provided for every feature, comprehensive test suite, continuous integration

Note: this project uses the rolling release development model, as it is used in a production environment which requires the latest updates. The public API may suffer minor changes. The master branch is to be considered stable.

Table of contents

Library

Installation

Go ≥ 1.17 is required, and modules must be enabled (there must be a go.mod file in your project folder, that can be created with the command go mod init main). To install the library, it is enough to write its name in the import section of the source files that will use it. Go will take care of downloading the needed files:

import (
    "github.com/aler9/dctk"
)

Examples

API Documentation

https://pkg.go.dev/github.com/aler9/dctk#pkg-index

Testing

If you want to edit this library and test the results, you can you automated tests with:

make test

Command-line utilities

Installation

Go ≥ 1.17 is required. Download, compile and install the binaries with:

go get github.com/aler9/dctk/cmd/...

Usage

dc-tth [<flags>] <filepath>

Compute the Tiger Tree Hash (TTH) of a given file.

dc-search --hub=HUB --nick=NICK [<flags>] <query>

Search files and directories by name in a given hub.

dc-download --hub=HUB --nick=NICK --outdir=OUTDIR [<flags>] <user> <fpath>

Download a file or a directory from a user in a given hub.

dc-share --hub=HUB --nick=NICK [<flags>] <share>

Share a directory in a given hub.

Links

Related projects

Hubs

Other clients

Other libraries

Standards