Skip to content

Latest commit

 

History

History
43 lines (37 loc) · 1.55 KB

README.md

File metadata and controls

43 lines (37 loc) · 1.55 KB

Kademlia DHT Implementation

The project aims to adhere to vanilla Kademlia information protocol as described by Maymounkov et. al. in the paper Kademlia: A Peer to Peer Information System based on XOR Metric

Dependencies

  • go
  • godoc (optional: for documentation)

Usage

The kademgo library can be imported in any project like regular libraries. In the project root run,

$> go get github.com/r0ck3r008/kademgo

or, to get the conainer image,

$> podman pull ghcr.io/r0ck3r008/kademgo:latest # using podman (recommended)
$> docker pull ghcr.io/r0ck3r008/kademgo:latest # Using docker

Then use,

import "github.com/r0ck3r008/kademgo"

in the project. The project has actively mantained godoc based comments. This makes easier for community to figure out how code is structured.

To access the documentation,

# Clone the repository
git clone https://github.com/r0ck3r008/kademgo
# Go to directory root
cd kademgo
# Use Godoc HTTP server
godoc

Then in your browser, visit http://localhost:6060/pkg/github.com/r0ck3r008/kademgo.

Contributing

The project aims to follow all the general guidelines mentioned in official go documentation in Effective Go. This project is currently under development and is open for all contributions.

Future Trajectory

The future trajectory of this project is to make a Command and Control framework for a botnet inspired by Starnberger et. al in the paper Overbot: a botnet protocol based on Kademlia.