disentangling conjure and gotapdance, WIP

Author: jmwample

Cargo.lock

@@ -3,38 +3,38 @@
 CC		 = ${CROSS_COMPILE}gcc #--platform=native
 
 DEBUG_OR_RELEASE = release
-RUST_LIB=./target/release/librust_dark_decoy.a
-TD_LIB=./libtapdance/libtapdance.a
+RUST_LIB=./cmd/detector/target/release/librust_dark_decoy.a
+TD_LIB=./cmd/detector/libtapdance/libtapdance.a
 LIBS=${RUST_LIB} ${TD_LIB} -L/usr/local/lib -lpcap -lpfring -lzmq -lcrypto -lpthread -lrt -lgmp -ldl -lm
 CFLAGS = -Wall -DENABLE_BPF -DHAVE_PF_RING -DHAVE_PF_RING_ZC -DTAPDANCE_USE_PF_RING_ZERO_COPY -O2 # -g
-PROTO_RS_PATH=src/signalling.rs
+PROTO_RS_PATH=./cmd/detector/src/signalling.rs
 EXE_DIR=./bin
 
 all: rust libtd conjure app registration-server ${PROTO_RS_PATH}
 
 sim: rust libtd conjure-sim app registration-server ${PROTO_RS_PATH}
 
-rust: ./src/*.rs
-	cargo build --${DEBUG_OR_RELEASE}
+rust:
+	cd ./cmd/detector/ && cargo build --${DEBUG_OR_RELEASE}
 
 test:
-	cargo test --${DEBUG_OR_RELEASE}
+	cd ./cmd/detector/ && cargo test --${DEBUG_OR_RELEASE}
 
 app:
 	[ -d $(EXE_DIR) ] || mkdir -p $(EXE_DIR)
 	go build -o ${EXE_DIR}/application ./cmd/application
 
 libtd:
-	cd ./libtapdance/ && make libtapdance.a
+	cd ./cmd/detector/libtapdance/ && make libtapdance.a
 
-conjure: detect.c loadkey.c rust_util.c rust libtapdance
+conjure: rust ./cmd/detector/libtapdance
 	[ -d $(EXE_DIR) ] || mkdir -p $(EXE_DIR)
-	${CC} ${CFLAGS} -o ${EXE_DIR}/$@ detect.c loadkey.c rust_util.c ${LIBS}
+	${CC} ${CFLAGS} -o ${EXE_DIR}/$@ ./cmd/detector/detect.c ./cmd/detector/loadkey.c ./cmd/detector/rust_util.c ${LIBS}
 
 
-conjure-sim: detect.c loadkey.c rust_util.c rust libtapdance
+conjure-sim: rust ./cmd/detector/libtapdance
 	[ -d $(EXE_DIR) ] || mkdir -p $(EXE_DIR)
-	${CC} -Wall -O2 -o ${EXE_DIR}/conjure detect.c loadkey.c rust_util.c ${LIBS}
+	${CC} -Wall -O2 -o ${EXE_DIR}/conjure ./cmd/detector/detect.c ./cmd/detector/loadkey.c ./cmd/detector/rust_util.c ${LIBS}
 
 registration-server:
 	[ -d $(EXE_DIR) ] || mkdir -p $(EXE_DIR)
@@ -84,7 +84,7 @@ endif
 	$(RM) -rf backup
 
 clean:
-	cargo clean
+	cd ./cmd/detector/ && cargo clean
 	$(RM) -rf *.o *~ ${EXE_DIR}
 	cd ./libtapdance/ && make clean
 

Makefile

@@ -16,8 +16,8 @@ import (
 	"syscall"
 	"time"
 
+	"github.com/refraction-networking/conjure/pkg/log"
 	cj "github.com/refraction-networking/conjure/pkg/station/lib"
-	"github.com/refraction-networking/conjure/pkg/station/log"
 	"github.com/refraction-networking/conjure/pkg/transports"
 )
 

cmd/application/conns.go

@@ -12,8 +12,8 @@ import (
 	"time"
 
 	"github.com/refraction-networking/conjure/internal/conjurepath"
+	"github.com/refraction-networking/conjure/pkg/log"
 	cj "github.com/refraction-networking/conjure/pkg/station/lib"
-	"github.com/refraction-networking/conjure/pkg/station/log"
 )
 
 // MockGeoIP is a mock implementation of the geoip.GeoIP interface.

cmd/application/conns_test.go

@@ -12,8 +12,8 @@ import (
 	"time"
 
 	"github.com/refraction-networking/conjure/pkg/dtls/dnat"
+	"github.com/refraction-networking/conjure/pkg/log"
 	cj "github.com/refraction-networking/conjure/pkg/station/lib"
-	"github.com/refraction-networking/conjure/pkg/station/log"
 	"github.com/refraction-networking/conjure/pkg/transports/connecting/dtls"
 	"github.com/refraction-networking/conjure/pkg/transports/wrapping/min"
 	"github.com/refraction-networking/conjure/pkg/transports/wrapping/obfs4"

cmd/application/main.go

@@ -0,0 +1,82 @@
+# Gotapdance CLI version
+
+# Build
+After [downloading Golang, TD and dependencies:](../README.md)
+
+```sh
+   cd ${GOPATH:-~/go}/src/github.com/refraction-networking/gotapdance/cli # works even if GOPATH is not set
+   go build -a .
+```
+
+# Usage
+
+Simply run
+
+```sh
+./cli
+```
+
+to listen to local connections on default 10500 port.
+
+Then, you'll have a few options:
+
+## Configure HTTP proxy
+
+You will need to ask your particular application(e.g. browser) to use 127.0.0.1:10500 as HTTP proxy.
+In Firefox (both mobile and desktop) I prefer to type ```about:config``` into address line and set the following:
+
+```conf
+network.proxy.http_port = 10500
+network.proxy.http = 127.0.0.1
+network.proxy.ssl_port = 10500
+network.proxy.ssl = 127.0.0.1
+network.proxy.type = 1
+```
+
+To disable proxying you may simply set ```network.proxy.type``` back to ```5``` or ```0```.
+
+The same settings are available in Firefox GUI: Preferences->Advanced->Network->Settings
+
+## Configure ssh SOCKS proxy
+
+If you have access to some ssh server, say `socksserver`, you can set up ssh SOCKS tunnel.
+First, modify and add the following to `.ssh/config`:
+
+```ssh
+Host socksserver-td
+Hostname 123.456.789.012
+User cookiemonster
+ProxyCommand nc -X connect -x 127.0.0.1:10500 %h %p
+```
+
+then run `ssh -D1234 socksserver-td -4`
+
+Now in Firefox you could just go to Preferences->Advanced->Network->Settings and set SOCKSv5 host to localhost:1234.
+
+## Some utilities use following enivoronment variables:
+
+ ```bash
+export https_proxy=127.0.0.1:10500
+export http_proxy=127.0.0.1:10500
+wget https://twitter.com
+```
+
+Most of the popular utilities also have a flag to specify a proxy.
+
+## Docker
+
+A simple dockerfile is provided that instantiates a golang environment in which to
+run the cli. This is primarily meant to be used with [the GNS3 simulation
+environment](https://github.com/refraction-networking/conjure/wiki/GNS3-Simulation).
+
+To build the docker environemnt use:
+
+```sh
+# run from repo root
+docker build -t gotapdance/cli -f cli/cli.dockerfile .
+```
+
+The environemnt can then be attached to using a `docker exec` or using telnet
+in the case of gns3. See the [wiki page](https://docs.gns3.com/docs/emulators/create-a-docker-container-for-gns3)
+for local docker image builds in gns3 for more details on setting up local
+docker appliances in gns3.

cmd/cli/README.md

@@ -0,0 +1,15 @@
+FROM golang:1.20
+
+RUN apt-get update
+RUN apt-get install -y -f libzmq3-dev
+
+WORKDIR /go/src/github/refracction-networking/gotapdance
+COPY . .
+
+# RUN go get -d -v ./...
+RUN go mod download
+RUN go mod tidy
+RUN go install ./cli 
+
+# no run / entrypoint specified. this containter is meant to be run w/
+# gns3 and connected to using terminal or telnet.