itUpdate docs. - 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 f96079f9d2e09d9c550df70a2e9c788b858bbbed /git/tordam/commit/f96079f9d2e09d9c550df70a2e9c788b858bbbed.gph parazyd.org 70 1parent 30d0d8dc0e019c41b6f1853d13b2b8bbc9f230b4 /git/tordam/commit/30d0d8dc0e019c41b6f1853d13b2b8bbc9f230b4.gph parazyd.org 70 hAuthor: parazyd URL:mailto:parazyd@dyne.org parazyd.org 70 iDate: Mon, 8 Mar 2021 01:58:25 +0100 Err parazyd.org 70 i Err parazyd.org 70 iUpdate docs. Err parazyd.org 70 i Err parazyd.org 70 iDiffstat: Err parazyd.org 70 i M cryptohelpers.go | 2 +- Err parazyd.org 70 i M database.go | 4 ++-- Err parazyd.org 70 i M peer_announce.go | 9 +++++---- Err parazyd.org 70 i M rpc_announce.go | 2 +- Err parazyd.org 70 i Err parazyd.org 70 i4 files changed, 9 insertions(+), 8 deletions(-) Err parazyd.org 70 i--- Err parazyd.org 70 1diff --git a/cryptohelpers.go b/cryptohelpers.go /git/tordam/file/cryptohelpers.go.gph parazyd.org 70 it@@ -23,7 +23,7 @@ import ( Err parazyd.org 70 i "fmt" Err parazyd.org 70 i ) Err parazyd.org 70 i Err parazyd.org 70 i-// RandomGarbage returns a base64 encoded string of n bytes. Err parazyd.org 70 i+// RandomGarbage returns a base64 encoded string of n bytes of entropy. Err parazyd.org 70 i func RandomGarbage(n int) (string, error) { Err parazyd.org 70 i garbage := make([]byte, n) Err parazyd.org 70 i read, err := rand.Read(garbage) Err parazyd.org 70 1diff --git a/database.go b/database.go /git/tordam/file/database.go.gph parazyd.org 70 it@@ -35,8 +35,8 @@ func WritePeersDB(file string) error { Err parazyd.org 70 i } Err parazyd.org 70 i Err parazyd.org 70 i // writePeersDBWithSem is an internal function to call WritePeersDB safely Err parazyd.org 70 i-// using an internal semafore. Programs using this library should probably Err parazyd.org 70 i-// implement something similar. Err parazyd.org 70 i+// using an internal semaphore. Programs using this library should probably Err parazyd.org 70 i+// implement something similar if they want to write Peers to a file. Err parazyd.org 70 i func writePeersDBWithSem(file string) { Err parazyd.org 70 i if err := dbSem.Acquire(dbSemCtx, 1); err != nil { Err parazyd.org 70 i log.Println("warning: failed to acquire sem for writing:", err) Err parazyd.org 70 1diff --git a/peer_announce.go b/peer_announce.go /git/tordam/file/peer_announce.go.gph parazyd.org 70 it@@ -29,9 +29,9 @@ import ( Err parazyd.org 70 i "golang.org/x/net/proxy" Err parazyd.org 70 i ) Err parazyd.org 70 i Err parazyd.org 70 i-// Announce is the function that announces to a certain onion address. Upon Err parazyd.org 70 i+// Announce is a function that announces to a certain onion address. Upon Err parazyd.org 70 i // success, it appends the peers received from the endpoint to the global Err parazyd.org 70 i-// Peers map. Err parazyd.org 70 i+// Peers map, which in turn also writes it to the peers db file. Err parazyd.org 70 i func Announce(onionaddr string) error { Err parazyd.org 70 i log.Println("Announcing to", onionaddr) Err parazyd.org 70 i Err parazyd.org 70 it@@ -59,7 +59,7 @@ func Announce(onionaddr string) error { Err parazyd.org 70 i Err parazyd.org 70 i if peer, ok := Peers[onionaddr]; ok { Err parazyd.org 70 i // Here the implication is that it's not our first announce, so we Err parazyd.org 70 i- // have received a revoke key to use in subsequent announces. Err parazyd.org 70 i+ // should have received a revoke key to use for a subsequent announce. Err parazyd.org 70 i data = append(data, peer.SelfRevoke) Err parazyd.org 70 i } Err parazyd.org 70 i Err parazyd.org 70 it@@ -91,7 +91,8 @@ func Announce(onionaddr string) error { Err parazyd.org 70 i // AppendPeers appends given []string peers to the global Peers map. Usually Err parazyd.org 70 i // received by validating ourself to a peer and them replying with a list of Err parazyd.org 70 i // their valid peers. If a peer is not in format of "unlikelyname.onion:port", Err parazyd.org 70 i-// they will not be appended. Err parazyd.org 70 i+// they will not be appended. When done, the function also writes the Peers Err parazyd.org 70 i+// struct as a JSON file in the Datadir. Err parazyd.org 70 i // As a placeholder, this function can return an error, but it has no reason Err parazyd.org 70 i // to do so right now. Err parazyd.org 70 i func AppendPeers(p []string) error { 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@@ -42,7 +42,7 @@ type Ann struct{} Err parazyd.org 70 i // } Err parazyd.org 70 i // Returns: Err parazyd.org 70 i // - nonce: A random nonce which is to be signed by the client Err parazyd.org 70 i-// - revoke: A key which can be used to revoke key and portman and reannounce the peer Err parazyd.org 70 i+// - revoke: A key which can be used to revoke key and portmap and reannounce the peer Err parazyd.org 70 i // { Err parazyd.org 70 i // "jsonrpc":"2.0", Err parazyd.org 70 i // "id":1, Err parazyd.org 70 .