Merge pull request #12 from cmars/chore/rebrand-onionpipe

chore!: rebrand as onionpipe

.dockerignore

@@ -1,3 +1,3 @@
 /Dockerfile
-/oniongrok
+/onionpipe
 /.git

.gitignore

@@ -1,2 +1,2 @@
-/oniongrok*
+/onionpipe*
 data-dir-*

.goreleaser.yaml

@@ -1,5 +1,5 @@
 builds:
-- binary: oniongrok
+- binary: onionpipe
   goos:
   - darwin
   - linux
@@ -9,7 +9,7 @@ builds:
 brews:
 - tap:
     owner: cmars
-    name: homebrew-oniongrok
+    name: homebrew-onionpipe
     branch: main
     token: "{{ .Env.TAP_GITHUB_TOKEN }}"
   dependencies:

Dockerfile

@@ -18,8 +18,8 @@ RUN touch /data/.build
 
 # Deploy image
 FROM tor
-COPY --from=build /src/oniongrok /oniongrok
+COPY --from=build /src/onionpipe /onionpipe
 COPY --from=build --chown=1000 /data/ /data/
 WORKDIR /data
 USER 1000
-ENTRYPOINT [ "/oniongrok" ]
+ENTRYPOINT [ "/onionpipe" ]

Makefile

@@ -1,19 +1,19 @@
 
-all: oniongrok
+all: onionpipe
 
-oniongrok_libtor:
+onionpipe_libtor:
 	go build -o $@ -v -x -tags "staticOpenssl,staticZlib,staticLibevent,libtor" .
 	strip $@
 
-oniongrok_embed:
+onionpipe_embed:
 	go build -o $@ -v -x -tags "embed" .
 
-oniongrok:
+onionpipe:
 	go build -o $@ .
 
 .PHONY: docker
 docker:
-	docker build -t oniongrok .
+	docker build -t onionpipe .
 
 .PHONY: test
 test:
@@ -27,4 +27,4 @@ coverage:
 
 .PHONY: clean
 clean:
-	$(RM) oniongrok
+	$(RM) onionpipe

README.md

@@ -1,94 +1,94 @@
-# oniongrok
+# onionpipe
 
 Onion addresses for anything.
 
-`oniongrok` forwards ports on the local host to remote Onion addresses as Tor
+`onionpipe` forwards ports on the local host to remote Onion addresses as Tor
 hidden services and vice-versa.
 
 ### Why would I want to use this?
 
-oniongrok is a decentralized way to create virtually unstoppable global network
+onionpipe is a decentralized way to create virtually unstoppable global network
 tunnels.
 
 For example, you might want to securely publish and access a personal service
 from anywhere in the world, across all sorts of network obstructions -- your
 ISP doesn't allow ingress traffic to your home lab, your clients might be in
 heavily firewalled environments (public WiFi, mobile tether), etc.
 
-With oniongrok, that service doesn't need a public IPv4 or IPv6 ingress. You'll
+With onionpipe, that service doesn't need a public IPv4 or IPv6 ingress. You'll
 eventually be able to restrict access with auth tokens. And you don't need to
 rely on, and share your personal data with for-profit services (like Tailscale,
 ZeroTier, etc.) to get to it.
 
 ### What can I do with it right now?
 
-oniongrok sets up socket forwarding tunnels. It's like `socat(1)`, for onions.
+onionpipe sets up socket forwarding tunnels. It's like `socat(1)`, for onions.
 
 #### Export services on local networks to onion addresses
 
 Export localhost port 8000 to a temporary, one-time remote onion address.
 ```
-oniongrok 8000
+onionpipe 8000
 ```
 
 Export localhost port 8000 to temporary remote onion port 80. `~` is shorthand
 for the forward between source~destination.
 ```
-oniongrok 8000~80
+onionpipe 8000~80
 ```
 
 Export localhost port 8000 to a persistent remote onion address nicknamed
 'my-app'.
 ```
-oniongrok 8000~80@my-app
+onionpipe 8000~80@my-app
 ```
 
 Nicknames can be re-used in multiple forwarding expressions to reference the
 same onion address. Let's set up a little web forum for our Minecraft server.
 ```
-oniongrok 8000~80@minecraft 25565@minecraft
+onionpipe 8000~80@minecraft 25565@minecraft
 ```
 
 All the forwards without nicknames use the same temporary address.
 ```
-oniongrok 192.168.1.100:8000~80,8080,9000 9090
+onionpipe 192.168.1.100:8000~80,8080,9000 9090
 ```
 
 Export a UNIX socket to an onion address.
 ```
-oniongrok /run/server.sock~80
+onionpipe /run/server.sock~80
 ```
 
 Export to a non-anonymous remote onion service, trading network privacy for
 possibly reduced latency.
 ```
-oniongrok --anonymous=false 8000
+onionpipe --anonymous=false 8000
 ```
 
 #### Import onion services to local network interfaces.
 
 Import a remote onion's port 80 to localhost port 80.
 ```
-oniongrok xxx.onion:80
+onionpipe xxx.onion:80
 ```
 
 Import remote onion port 80 to local port 80 on all interfaces. This can be
 used for creating an ingress to the onion on public networks.
 ```
-oniongrok xxx.onion:80~0.0.0.0:80
+onionpipe xxx.onion:80~0.0.0.0:80
 ```
 
 Running with Docker is simple and easy, the only caveat is that its the
 container forwarding, so adjust local addresses accordingly.
 
 Forward port 80 on Docker host.
 ```
-docker run --rm ghcr.io/cmars/oniongrok:main host.docker.internal:80
+docker run --rm ghcr.io/cmars/onionpipe:main host.docker.internal:80
 ```
 
 If you're using Podman, exposing the local host network is another option.
 ```
-podman run --network=host --rm ghcr.io/cmars/oniongrok:main 8000 
+podman run --network=host --rm ghcr.io/cmars/onionpipe:main 8000 
 ```
 
 Because local forwarding addresses are DNS resolved, it's very easy to publish
@@ -103,7 +103,7 @@ is great for securing personal services over Tor. How to use it:
 Alice creates a new client auth public key pair.
 
 ```
-oniongrok client new alice
+onionpipe client new alice
 ```
 
 ```
@@ -118,7 +118,7 @@ Alice shares this public key with Bob, who forwards an onion service that only
 Alice can use.
 
 ```
-oniongrok --require-auth p2pof7vumwsrqqavtovfwqqaw6cqzvtqqe7cjvxt754k6j7blufa 8000~80@test
+onionpipe --require-auth p2pof7vumwsrqqavtovfwqqaw6cqzvtqqe7cjvxt754k6j7blufa 8000~80@test
 ```
 
 ```
@@ -130,7 +130,7 @@ Alice can use her client private key to connect to this onion and forward to a
 local port.
 
 ```
-oniongrok --auth alice sd6aq2r6jvuoeisrudq7jbqufjh6nck5buuzjmgalicgwrobgfj4lkqd.onion:80~7000
+onionpipe --auth alice sd6aq2r6jvuoeisrudq7jbqufjh6nck5buuzjmgalicgwrobgfj4lkqd.onion:80~7000
 ```
 
 ```
@@ -145,22 +145,22 @@ tap and Docker image.
 
 #### Homebrew
 
-    brew tap cmars/oniongrok
-    brew install oniongrok
+    brew tap cmars/onionpipe
+    brew install onionpipe
 
 #### Docker
 
-The provided `Dockerfile` builds a minimal image that can run oniongrok in a
+The provided `Dockerfile` builds a minimal image that can run onionpipe in a
 container with the latest Tor release from the Tor Project. Build and runtime
 is Debian-based.
 
 #### Local build
 
 In a local clone of this project,
 
-    make oniongrok
+    make onionpipe
 
-The built binary `oniongrok` will require a `tor` daemon executable to be in
+The built binary `onionpipe` will require a `tor` daemon executable to be in
 your `$PATH`.
 
 #### Static standalone binary with libtor
@@ -171,7 +171,7 @@ are some quirks; see comments in `tor/init_libtor.go` for details.
 
 In a local clone of this project,
 
-    make oniongrok_libtor
+    make onionpipe_libtor
 
 This will take a long time the first time you build, because it compiles CGO
 wrappers for Tor and its dependencies.
@@ -191,7 +191,7 @@ dependencies installed into your shell context.
 Operate from a yaml file.
 
 ```
-oniongrok --config config.yaml
+onionpipe --config config.yaml
 ```
 
 Considering a TUI.

app/app.go

@@ -9,7 +9,7 @@ import (
 	"github.com/mitchellh/go-homedir"
 	"github.com/urfave/cli/v2"
 
-	"github.com/cmars/oniongrok/secrets"
+	"github.com/cmars/onionpipe/secrets"
 )
 
 var forwardFlags = []cli.Flag{
@@ -42,13 +42,13 @@ func defaultSecretsPath() string {
 		log.Printf("failed to locate home directory: %v", err)
 		return ""
 	}
-	return filepath.Join(home, ".local", "share", "oniongrok", "secrets.json")
+	return filepath.Join(home, ".local", "share", "onionpipe", "secrets.json")
 }
 
-// App returns a new oniongrok command line app.
+// App returns a new onionpipe command line app.
 func App() *cli.App {
 	return &cli.App{
-		Name:   "oniongrok",
+		Name:   "onionpipe",
 		Usage:  "forward services through Tor; .onion addresses for anything",
 		Flags:  forwardFlags,
 		Action: Forward,

app/app_test.go

@@ -8,9 +8,9 @@ import (
 	qt "github.com/frankban/quicktest"
 	"github.com/mitchellh/go-homedir"
 
-	"github.com/cmars/oniongrok/config"
-	"github.com/cmars/oniongrok/forwarding"
-	"github.com/cmars/oniongrok/tor"
+	"github.com/cmars/onionpipe/config"
+	"github.com/cmars/onionpipe/forwarding"
+	"github.com/cmars/onionpipe/tor"
 )
 
 func init() {
@@ -49,7 +49,7 @@ func TestApp(t *testing.T) {
 		home := c.Mkdir()
 		c.Setenv("HOME", home)
 		fwdSvc.fwds = nil
-		err := App().Run([]string{"oniongrok", "8080"})
+		err := App().Run([]string{"onionpipe", "8080"})
 		c.Assert(err, qt.IsNil)
 
 		c.Assert(fwdSvc.fwds, qt.HasLen, 1)
@@ -61,7 +61,7 @@ func TestApp(t *testing.T) {
 		home := c.Mkdir()
 		c.Setenv("HOME", home)
 		fwdSvc.fwds = nil
-		err := App().Run([]string{"oniongrok", "8080@test"})
+		err := App().Run([]string{"onionpipe", "8080@test"})
 		c.Assert(err, qt.IsNil)
 
 		c.Assert(fwdSvc.fwds, qt.HasLen, 1)
@@ -75,14 +75,14 @@ func TestApp(t *testing.T) {
 		home := c.Mkdir()
 		c.Setenv("HOME", home)
 		fwdSvc.fwds = nil
-		err := App().Run([]string{"oniongrok", "--anonymous=false", "8080@test"})
+		err := App().Run([]string{"onionpipe", "--anonymous=false", "8080@test"})
 		c.Assert(err, qt.IsNil)
 
 		c.Assert(fwdSvc.fwds, qt.HasLen, 1)
 		c.Assert(fwdSvc.fwds[0].Description(fwdSvc.onions), qt.Equals, "127.0.0.1:8080 => abc.onion:8080")
 		_, err = os.Stat(defaultSecretsPath())
 		c.Assert(os.IsNotExist(err), qt.IsTrue)
-		_, err = os.Stat(home + "/.local/share/oniongrok/secrets.not-anonymous.json")
+		_, err = os.Stat(home + "/.local/share/onionpipe/secrets.not-anonymous.json")
 		c.Assert(err, qt.IsNil)
 	})
 }

app/client.go

@@ -7,8 +7,9 @@ import (
 	"os"
 	"strings"
 
-	"github.com/cmars/oniongrok/secrets"
 	"github.com/urfave/cli/v2"
+
+	"github.com/cmars/onionpipe/secrets"
 )
 
 // ListClientKeys implements the `client ls` command.

app/client_test.go

@@ -7,7 +7,7 @@ import (
 
 	qt "github.com/frankban/quicktest"
 
-	"github.com/cmars/oniongrok/secrets"
+	"github.com/cmars/onionpipe/secrets"
 )
 
 func TestClientCommands(t *testing.T) {
@@ -21,7 +21,7 @@ func TestClientCommands(t *testing.T) {
 		c.Patch(&os.Stdout, out)
 		go func() {
 			defer out.Close()
-			err := App().Run([]string{"oniongrok", "client"})
+			err := App().Run([]string{"onionpipe", "client"})
 			c.Assert(err, qt.IsNil)
 		}()
 		var clients secrets.ClientsPublic
@@ -30,22 +30,22 @@ func TestClientCommands(t *testing.T) {
 		c.Assert(clients, qt.HasLen, 0)
 	})
 	c.Run("add/rm clients", func(c *qt.C) {
-		err := App().Run([]string{"oniongrok", "client", "new", "test"})
+		err := App().Run([]string{"onionpipe", "client", "new", "test"})
 		c.Assert(err, qt.IsNil)
-		err = App().Run([]string{"oniongrok", "client", "new", "test"})
+		err = App().Run([]string{"onionpipe", "client", "new", "test"})
 		c.Assert(err, qt.ErrorMatches, `client "test" already exists`)
-		err = App().Run([]string{"oniongrok", "client", "new", "test2"})
+		err = App().Run([]string{"onionpipe", "client", "new", "test2"})
 		c.Assert(err, qt.IsNil)
-		err = App().Run([]string{"oniongrok", "client", "new", "test3"})
+		err = App().Run([]string{"onionpipe", "client", "new", "test3"})
 		c.Assert(err, qt.IsNil)
-		err = App().Run([]string{"oniongrok", "client", "rm", "test"})
+		err = App().Run([]string{"onionpipe", "client", "rm", "test"})
 		c.Assert(err, qt.IsNil)
 		in, out, err := os.Pipe()
 		c.Assert(err, qt.IsNil)
 		c.Patch(&os.Stdout, out)
 		go func() {
 			defer out.Close()
-			err := App().Run([]string{"oniongrok", "client"})
+			err := App().Run([]string{"onionpipe", "client"})
 			c.Assert(err, qt.IsNil)
 		}()
 		var clients secrets.ClientsPublic