itAdd more documentation. - tordam - A library for peer discovery inside the Tor network Err parazyd.org 70 hgit clone https://git.parazyd.org/tordam URL:https://git.parazyd.org/tordam parazyd.org 70 1Log /git/tordam/log.gph parazyd.org 70 1Files /git/tordam/files.gph parazyd.org 70 1Refs /git/tordam/refs.gph parazyd.org 70 1README /git/tordam/file/README.md.gph parazyd.org 70 1LICENSE /git/tordam/file/LICENSE.gph parazyd.org 70 i--- Err parazyd.org 70 1commit 42701591ffa8aea9cda274b3c77c7a8f79b128fd /git/tordam/commit/42701591ffa8aea9cda274b3c77c7a8f79b128fd.gph parazyd.org 70 1parent 6c9368a6643840efd5af6a10eb3fec885b4c9ff6 /git/tordam/commit/6c9368a6643840efd5af6a10eb3fec885b4c9ff6.gph parazyd.org 70 hAuthor: parazyd URL:mailto:parazyd@dyne.org parazyd.org 70 iDate: Sun, 7 Mar 2021 22:35:34 +0100 Err parazyd.org 70 i Err parazyd.org 70 iAdd more documentation. Err parazyd.org 70 i Err parazyd.org 70 iDiffstat: Err parazyd.org 70 i M peer.go | 14 +++++++------- Err parazyd.org 70 i M rpc_announce.go | 1 + Err parazyd.org 70 i M sanity.go | 2 ++ Err parazyd.org 70 i M tor.go | 6 ++++++ Err parazyd.org 70 i Err parazyd.org 70 i4 files changed, 16 insertions(+), 7 deletions(-) Err parazyd.org 70 i--- Err parazyd.org 70 1diff --git a/peer.go b/peer.go /git/tordam/file/peer.go.gph parazyd.org 70 it@@ -23,11 +23,11 @@ import ( Err parazyd.org 70 i Err parazyd.org 70 i // Peer is the base struct for any peer in the network. Err parazyd.org 70 i type Peer struct { Err parazyd.org 70 i- Pubkey ed25519.PublicKey Err parazyd.org 70 i- Portmap []string Err parazyd.org 70 i- Nonce string Err parazyd.org 70 i- SelfRevoke string // Our revoke key we use to update our data Err parazyd.org 70 i- PeerRevoke string // Peer's revoke key if they wish to update their data Err parazyd.org 70 i- LastSeen int64 Err parazyd.org 70 i- Trusted int // Trusted is int because of possible levels of trust Err parazyd.org 70 i+ Pubkey ed25519.PublicKey // Peer's ed25519 public key Err parazyd.org 70 i+ Portmap []string // Peer's port map in Tor Err parazyd.org 70 i+ Nonce string // The nonce to be signed after announce init Err parazyd.org 70 i+ SelfRevoke string // Our revoke key we use to update our data Err parazyd.org 70 i+ PeerRevoke string // Peer's revoke key if they wish to update their data Err parazyd.org 70 i+ LastSeen int64 // Timestamp of last announce Err parazyd.org 70 i+ Trusted int // Trusted is int because of possible levels of trust Err parazyd.org 70 i } Err parazyd.org 70 1diff --git a/rpc_announce.go b/rpc_announce.go /git/tordam/file/rpc_announce.go.gph parazyd.org 70 it@@ -26,6 +26,7 @@ import ( Err parazyd.org 70 i "time" Err parazyd.org 70 i ) Err parazyd.org 70 i Err parazyd.org 70 i+// Ann is the struct for the announce JSON-RPC endpoint. Err parazyd.org 70 i type Ann struct{} Err parazyd.org 70 i Err parazyd.org 70 i // Init takes three parameters: Err parazyd.org 70 1diff --git a/sanity.go b/sanity.go /git/tordam/file/sanity.go.gph parazyd.org 70 it@@ -40,6 +40,8 @@ func ValidateOnionAddress(addr string) error { Err parazyd.org 70 i return nil Err parazyd.org 70 i } Err parazyd.org 70 i Err parazyd.org 70 i+// ValidateOnionInternal takes someunlikelyname.onion:port as a parameter Err parazyd.org 70 i+// and validates its format. Err parazyd.org 70 i func ValidateOnionInternal(onionaddr string) error { Err parazyd.org 70 i splitOnion := strings.Split(onionaddr, ":") Err parazyd.org 70 i if len(splitOnion) != 2 { Err parazyd.org 70 1diff --git a/tor.go b/tor.go /git/tordam/file/tor.go.gph parazyd.org 70 it@@ -25,6 +25,8 @@ import ( Err parazyd.org 70 i "strings" Err parazyd.org 70 i ) Err parazyd.org 70 i Err parazyd.org 70 i+// newtorrc returns a torrc string that is fed as standard input to the Tor Err parazyd.org 70 i+// binary for its configuration. Err parazyd.org 70 i func newtorrc(listener, torlistener *net.TCPAddr, portmap []string) string { Err parazyd.org 70 i var pm []string Err parazyd.org 70 i Err parazyd.org 70 it@@ -46,6 +48,10 @@ HiddenServicePort %d %s Err parazyd.org 70 i listener.Port, listener.String(), strings.Join(pm, "\n")) Err parazyd.org 70 i } Err parazyd.org 70 i Err parazyd.org 70 i+// SpawnTor runs the system's Tor binary with the torrc created by newtorrc. Err parazyd.org 70 i+// It takes listener (which is the local JSON-RPC server net.TCPAddr), Err parazyd.org 70 i+// portmap (to map HiddenServicePort entries) and datadir (to store Tor files) Err parazyd.org 70 i+// as parameters. Returns exec.Cmd pointer and/or error. Err parazyd.org 70 i func SpawnTor(listener *net.TCPAddr, portmap []string, datadir string) (*exec.Cmd, error) { Err parazyd.org 70 i var err error Err parazyd.org 70 i Err parazyd.org 70 .