tordam

A library for peer discovery inside the Tor network
git clone https://git.parazyd.org/tordam
Log | Files | Refs | README | LICENSE

README.md (1385B)

      1 tor-dam (Tor Distributed Announce Mechanism)
      2 ============================================
      3 
      4 ![tordam](contrib/tordam.png)
      5 
      6 A library for peer discovery inside the Tor network.
      7 
      8 ![Build Status](https://github.com/parazyd/tordam/actions/workflows/go.yml/badge.svg)
      9 [![Go Report Card](https://goreportcard.com/badge/github.com/parazyd/tordam)](https://goreportcard.com/report/github.com/parazyd/tordam)
     10 [![Go Reference](https://pkg.go.dev/badge/github.com/parazyd/tordam.svg)](https://pkg.go.dev/github.com/parazyd/tordam)
     11 
     12 Installation
     13 ------------
     14 
     15 ```
     16 go get github.com/parazyd/tordam
     17 ```
     18 
     19 Documentation
     20 -------------
     21 
     22 https://pkg.go.dev/github.com/parazyd/tordam
     23 
     24 tor-dam is a small library that can be used to facilitate peer to
     25 peer services in the Tor network with simple mechanisms.
     26 
     27 An integration example can be found and reviewed in the form of a
     28 single go file: [cmd/tor-dam/tor-dam.go](cmd/tor-dam/tor-dam.go). It
     29 is procedural and well-documented so it should serve well for learning
     30 how to integrate the library into a Go program.
     31 
     32 Most of the library's code is documented in the source, along with
     33 godoc.
     34 
     35 
     36 Feature list
     37 ------------
     38 
     39 * Anonymous peer mapping in the Tor network
     40 * Launching Tor and Hidden Services
     41 * Port mapping to launched hidden service for easy anonymous services
     42 * Exporting available peers through any marshaling interface (think
     43   peer list as JSON)