https://github.com/lnsp/coyote

Simple peer-to-peer file-sharing protocol inspired by BitTorrent.
https://github.com/lnsp/coyote

bittorrent connect file-sharing p2p peer-to-peer protobuf

Last synced: about 2 months ago
JSON representation

Simple peer-to-peer file-sharing protocol inspired by BitTorrent.

• Host: GitHub
• URL: https://github.com/lnsp/coyote
• Owner: lnsp
• License: apache-2.0
• Created: 2020-01-12T00:09:27.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-10-10T05:46:57.000Z (about 2 years ago)
• Last Synced: 2024-06-20T00:26:59.807Z (6 months ago)
• Topics: bittorrent, connect, file-sharing, p2p, peer-to-peer, protobuf
• Language: Go
• Homepage:
• Size: 127 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: security/security.go

Awesome Lists containing this project

README

        
# 

Simple peer-to-peer file transfer protocol inspired by the BitTorrent protocol, but instead of custom TCP protocols everything is built on top of QUIC (and therefore can be protected by TLS easily).

## How does it work?

There are three types of actors in a functioning `coyote` environment. First of all, there are the **taverns**. These are rendevouz servers, which introduce network peers to each other. The first type of peer is the **seeder**. They provide their bandwidth and storage for others to use and download file chunks from. Then there is the **fetcher**. Its sole purpose is to contact **taverns**, ask around for peers for a given file hash and contact these **seeders**, fetching file chunks and assembling the final file at the end.

## What does (not) work yet?

* [x] Simple file sharing using tavern, fetcher and seeder

* [x] Announcement timeouts

* [x] Better chunk download scheduling

* [x] Add support to resume fetches by checking for already downloaded chunks (and verifying them)

* [x] Use UDP-based QUIC as transport layer with Buf Connect on top of it (with this comes UDP hole punching)

* [ ] Encryption of tavern traffic using Let's Encrypt certificates

* [ ] Use distributed hash tables for decentralized peer discovery

* [ ] Split `.tracker` into public- and private trackers, allowing for file encryption

* [ ] Add tests for fetcher, seeder, tavern and tracker

## Installation

```bash

go install github.com/lnsp/coyote@latest

```

The binary is then available in your `$GOPATH/bin` directory.

## Usage

```bash

# First, we need to setup a tracker for our file.

# We assume, that the file you want to distribute is called myvideo.mp4

coyote track -s https://tavern.espe.tech:6443 myvideo.mp4

# Now you get a myvideo.mp4.coyote file which you can share with others

# To seed the file yourself, use the seed command

coyote seed -x