December 2015 - tor-commits - lists.torproject.org

[webwml/master] Deprecate old TBB versions
by gk＠torproject.org 20 Dec '15

20 Dec '15

commit 55d3326cea993c3154f91535ce0196f88c009617 Author: Georg Koppen <gk(a)torproject.org> Date: Sun Dec 20 01:21:28 2015 +0000 Deprecate old TBB versions --- projects/torbrowser/RecommendedTBBVersions | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/projects/torbrowser/RecommendedTBBVersions b/projects/torbrowser/RecommendedTBBVersions index 82c8ee9..b0a53b2 100644 --- a/projects/torbrowser/RecommendedTBBVersions +++ b/projects/torbrowser/RecommendedTBBVersions @@ -1,22 +1,12 @@ [ -"5.0.5", -"5.0.5-Linux", -"5.0.5-MacOS", -"5.0.5-Windows", "5.0.6", "5.0.6-Linux", "5.0.6-MacOS", "5.0.6-Windows", -"5.5a4", -"5.5a4-Linux", -"5.5a4-MacOS", -"5.5a4-Windows", "5.5a5", "5.5a5-Linux", "5.5a5-MacOS", "5.5a5-Windows", -"5.5a4-hardened", -"5.5a4-hardened-Linux", "5.5a5-hardened", "5.5a5-hardened-Linux" ]

1 0

[webwml/master] Add redirect for broken url used on twitter...
by sebastian＠torproject.org 19 Dec '15

19 Dec '15

commit 285eabdcefa7cce0ddbde30df90648796dc4d04b Author: Sebastian Hahn <sebastian(a)torproject.org> Date: Sat Dec 19 12:28:35 2015 +0100 Add redirect for broken url used on twitter... --- .htaccess | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.htaccess b/.htaccess index 8870a5a..b3992a7 100644 --- a/.htaccess +++ b/.htaccess @@ -66,3 +66,6 @@ RewriteRule ^donate/donate-hpbanner(.*) /donate/donate$1 [R=302,L] #keep prefixes of other entries down here... RewriteRule ^donate/donate-hp(.*) /donate/donate$1 [R=302,L] +# yuck, https://twitter.com/torproject/status/677928074630049793 +RewriteRule ^Donate/Donate-Twitter(.*) /donate/donate$1 [R=302,L] +

1 0

[websocket/master] Change import to new golang.org/x/net/websocket.
by dcf＠torproject.org 19 Dec '15

19 Dec '15

commit 7fbabe47b0fdb51c1573221024da7786cbf7ebe1 Author: David Fifield <david(a)bamsoftware.com> Date: Sat Dec 19 00:38:54 2015 -0800 Change import to new golang.org/x/net/websocket. https://groups.google.com/forum/#!msg/golang-nuts/eD8dh3T9yyA/l5Ail-xfMiAJ --- websocket-client/websocket-client.go | 2 +- websocket/websocket.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/websocket-client/websocket-client.go b/websocket-client/websocket-client.go index 859d98e..8943a97 100644 --- a/websocket-client/websocket-client.go +++ b/websocket-client/websocket-client.go @@ -7,7 +7,7 @@ package main import ( - "code.google.com/p/go.net/websocket" + "golang.org/x/net/websocket" "flag" "fmt" "io" diff --git a/websocket/websocket.go b/websocket/websocket.go index 5786fdf..7c649e3 100644 --- a/websocket/websocket.go +++ b/websocket/websocket.go @@ -5,7 +5,7 @@ // maximum buffering of messages. // // The reason for using this custom implementation instead of -// code.google.com/p/go.net/websocket is that the latter has problems with long +// golang.org/x/net/websocket is that the latter has problems with long // messages and does not support server subprotocols. // "Denial of Service Protection in Go HTTP Servers" // https://code.google.com/p/go/issues/detail?id=2093

1 0

[websocket/master] Rearrange imports.
by dcf＠torproject.org 19 Dec '15

19 Dec '15

commit ea3ee6b5cf035a9465c02b4a2b38882c9c6a7050 Author: David Fifield <david(a)bamsoftware.com> Date: Sat Dec 19 00:41:38 2015 -0800 Rearrange imports. --- websocket-client/websocket-client.go | 7 ++++--- websocket-server/websocket-server.go | 6 +++--- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/websocket-client/websocket-client.go b/websocket-client/websocket-client.go index 8943a97..c035e58 100644 --- a/websocket-client/websocket-client.go +++ b/websocket-client/websocket-client.go @@ -7,7 +7,6 @@ package main import ( - "golang.org/x/net/websocket" "flag" "fmt" "io" @@ -18,9 +17,11 @@ import ( "os/signal" "sync" "syscall" -) -import "git.torproject.org/pluggable-transports/goptlib.git" + "golang.org/x/net/websocket" + + "git.torproject.org/pluggable-transports/goptlib.git" +) var ptInfo pt.ClientInfo diff --git a/websocket-server/websocket-server.go b/websocket-server/websocket-server.go index 0d065cc..6fb5a0b 100644 --- a/websocket-server/websocket-server.go +++ b/websocket-server/websocket-server.go @@ -19,11 +19,11 @@ import ( "sync" "syscall" "time" -) -import "../websocket" + "../websocket" -import "git.torproject.org/pluggable-transports/goptlib.git" + "git.torproject.org/pluggable-transports/goptlib.git" +) const ptMethodName = "websocket" const requestTimeout = 10 * time.Second

1 0

[websocket/master] Fix .gitignore for binaries.
by dcf＠torproject.org 19 Dec '15

19 Dec '15

commit 33b71474aa4a7b220b8ad4733c4230d7163d24e3 Author: David Fifield <david(a)bamsoftware.com> Date: Fri Dec 18 22:36:28 2015 -0800 Fix .gitignore for binaries. --- .gitignore | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 1fee725..bf705ca 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,2 @@ -/websocket-client -/websocket-server +/websocket-client/websocket-client +/websocket-server/websocket-server

1 0

[websocket/master] Add sample websocket-server torrc.
by dcf＠torproject.org 19 Dec '15

19 Dec '15

commit feb20f13712b43c1a8d8139b326dab66628a0aca Author: David Fifield <david(a)bamsoftware.com> Date: Fri Dec 18 22:36:48 2015 -0800 Add sample websocket-server torrc. --- websocket-server/torrc | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/websocket-server/torrc b/websocket-server/torrc new file mode 100644 index 0000000..7947f9a --- /dev/null +++ b/websocket-server/torrc @@ -0,0 +1,6 @@ +BridgeRelay 1 +ORPort 9001 +ExtORPort auto +SocksPort 0 +ServerTransportPlugin websocket exec ./websocket-server --log websocket-server.log --port 9901 +ExitPolicy reject *:*

1 0

[websocket/master] rm Makefile.
by dcf＠torproject.org 19 Dec '15

19 Dec '15

commit be285b1ea115fccda644ce35dfdef884309f81ad Author: David Fifield <david(a)bamsoftware.com> Date: Fri Dec 18 22:19:31 2015 -0800 rm Makefile. I'm more used to the "go build" approach now. --- Makefile | 30 ------------------------------ 1 file changed, 30 deletions(-) diff --git a/Makefile b/Makefile deleted file mode 100644 index b6ea18c..0000000 --- a/Makefile +++ /dev/null @@ -1,30 +0,0 @@ -DESTDIR = -PREFIX = /usr/local -BINDIR = $(PREFIX)/bin - -GOBUILDFLAGS = -# Alternate flags to use gccgo, allowing cross-compiling for x86 from -# x86_64, and presumably better optimization. Install this package: -# apt-get install gccgo-multilib -# GOBUILDFLAGS = -compiler gccgo -gccgoflags "-O3 -m32 -static-libgo" - -all: websocket-server/websocket-server - -websocket-server/websocket-server: websocket-server/*.go websocket/*.go - cd websocket-server && go build $(GOBUILDFLAGS) - -websocket-client/websocket-client: websocket-client/*.go - cd websocket-client && go build $(GOBUILDFLAGS) - -install: websocket-server/websocket-server - mkdir -p "$(DESTDIR)$(BINDIR)" - cp -f websocket-server/websocket-server "$(DESTDIR)$(BINDIR)" - -clean: - rm -f websocket-server/websocket-server websocket-client/websocket-client - rm -f doc/websocket-server.1 - -fmt: - go fmt ./websocket-server ./websocket-client ./websocket - -.PHONY: all install clean fmt

1 0

[websocket/master] Use the standard log package.
by dcf＠torproject.org 19 Dec '15

19 Dec '15

commit 086d3bcf6ffe5faa1889b89a4ceea9ac58b948e1 Author: David Fifield <david(a)bamsoftware.com> Date: Fri Dec 18 22:59:56 2015 -0800 Use the standard log package. This changes "2015-12-19" to "2015/12/19" and uses UTC instead of local time. --- websocket-client/websocket-client.go | 35 ++++++++++++--------------------- websocket-server/websocket-server.go | 36 +++++++++++++--------------------- 2 files changed, 26 insertions(+), 45 deletions(-) diff --git a/websocket-client/websocket-client.go b/websocket-client/websocket-client.go index f65a9c9..859d98e 100644 --- a/websocket-client/websocket-client.go +++ b/websocket-client/websocket-client.go @@ -11,13 +11,13 @@ import ( "flag" "fmt" "io" + "log" "net" "net/url" "os" "os/signal" "sync" "syscall" - "time" ) import "git.torproject.org/pluggable-transports/goptlib.git" @@ -27,14 +27,10 @@ var ptInfo pt.ClientInfo const ptMethodName = "websocket" const bufSiz = 1500 -var logFile = os.Stderr - // When a connection handler starts, +1 is written to this channel; when it // ends, -1 is written. var handlerChan = make(chan int) -var logMutex sync.Mutex - func usage() { fmt.Printf("Usage: %s [OPTIONS]\n", os.Args[0]) fmt.Printf("WebSocket client pluggable transport for Tor.\n") @@ -45,14 +41,6 @@ func usage() { fmt.Printf(" --socks ADDR listen for SOCKS on ADDR.\n") } -func log(format string, v ...interface{}) { - dateStr := time.Now().Format("2006-01-02 15:04:05") - logMutex.Lock() - defer logMutex.Unlock() - msg := fmt.Sprintf(format, v...) - fmt.Fprintf(logFile, "%s %s\n", dateStr, msg) -} - func proxy(local *net.TCPConn, ws *websocket.Conn) { var wg sync.WaitGroup @@ -77,7 +65,7 @@ func proxy(local *net.TCPConn, ws *websocket.Conn) { } } if err != nil && err != io.EOF { - log("%s", err) + log.Printf("%s", err) } local.CloseRead() ws.Close() @@ -106,7 +94,7 @@ func proxy(local *net.TCPConn, ws *websocket.Conn) { } } if err != nil && err != io.EOF { - log("%s", err) + log.Printf("%s", err) } local.CloseWrite() ws.Close() @@ -127,7 +115,7 @@ func handleConnection(conn *pt.SocksConn) error { var ws *websocket.Conn - log("SOCKS request for %s", conn.Req.Target) + log.Printf("SOCKS request for %s", conn.Req.Target) destAddr, err := net.ResolveTCPAddr("tcp", conn.Req.Target) if err != nil { conn.Reject() @@ -139,7 +127,7 @@ func handleConnection(conn *pt.SocksConn) error { err = conn.Reject() return err } - log("WebSocket connection to %s", ws.Config().Location.String()) + log.Printf("WebSocket connection to %s", ws.Config().Location.String()) defer ws.Close() err = conn.Grant(destAddr) if err != nil { @@ -164,7 +152,7 @@ func socksAcceptLoop(ln *pt.SocksListener) error { go func() { err := handleConnection(socks) if err != nil { - log("SOCKS from %s: %s", socks.RemoteAddr(), err) + log.Printf("SOCKS from %s: %s", socks.RemoteAddr(), err) } }() } @@ -179,7 +167,7 @@ func startListener(addrStr string) (*pt.SocksListener, error) { go func() { err := socksAcceptLoop(ln) if err != nil { - log("accept: %s", err) + log.Printf("accept: %s", err) } }() return ln, nil @@ -201,13 +189,14 @@ func main() { fmt.Fprintf(os.Stderr, "Can't open log file %q: %s.\n", logFilename, err.Error()) os.Exit(1) } - logFile = f + log.SetOutput(f) } - log("starting") + log.SetFlags(log.LstdFlags | log.LUTC) + log.Printf("starting") ptInfo, err = pt.ClientSetup(nil) if err != nil { - log("error in setup: %s", err) + log.Printf("error in setup: %s", err) os.Exit(1) } @@ -221,7 +210,7 @@ func main() { break } pt.Cmethod(ptMethodName, ln.Version(), ln.Addr()) - log("listening on %s", ln.Addr().String()) + log.Printf("listening on %s", ln.Addr().String()) listeners = append(listeners, ln) default: pt.CmethodError(methodName, "no such method") diff --git a/websocket-server/websocket-server.go b/websocket-server/websocket-server.go index fbfffd8..0d065cc 100644 --- a/websocket-server/websocket-server.go +++ b/websocket-server/websocket-server.go @@ -11,6 +11,7 @@ import ( "flag" "fmt" "io" + "log" "net" "net/http" "os" @@ -48,16 +49,6 @@ func usage() { fmt.Printf(" --port PORT listen on PORT (overrides Tor's requested port).\n") } -var logMutex sync.Mutex - -func log(format string, v ...interface{}) { - dateStr := time.Now().Format("2006-01-02 15:04:05") - logMutex.Lock() - defer logMutex.Unlock() - msg := fmt.Sprintf(format, v...) - fmt.Fprintf(logFile, "%s %s\n", dateStr, msg) -} - // An abstraction that makes an underlying WebSocket connection look like an // io.ReadWriteCloser. It internally takes care of things like base64 encoding // and decoding. @@ -146,7 +137,7 @@ func proxy(local *net.TCPConn, conn *webSocketConn) { go func() { _, err := io.Copy(conn, local) if err != nil { - log("error copying ORPort to WebSocket") + log.Printf("error copying ORPort to WebSocket") } local.CloseRead() conn.Close() @@ -155,7 +146,7 @@ func proxy(local *net.TCPConn, conn *webSocketConn) { go func() { _, err := io.Copy(local, conn) if err != nil { - log("error copying WebSocket to ORPort") + log.Printf("error copying WebSocket to ORPort") } local.CloseWrite() conn.Close() @@ -178,7 +169,7 @@ func webSocketHandler(ws *websocket.WebSocket) { or, err := pt.DialOr(&ptInfo, ws.Conn.RemoteAddr().String(), ptMethodName) if err != nil { - log("Failed to connect to ORPort: " + err.Error()) + log.Printf("Failed to connect to ORPort: " + err.Error()) return } defer or.Close() @@ -202,7 +193,7 @@ func startListener(addr *net.TCPAddr) (*net.TCPListener, error) { } err = s.Serve(ln) if err != nil { - log("http.Serve: " + err.Error()) + log.Printf("http.Serve: " + err.Error()) } }() return ln, nil @@ -223,14 +214,15 @@ func main() { fmt.Fprintf(os.Stderr, "Can't open log file %q: %s.\n", logFilename, err.Error()) os.Exit(1) } - logFile = f + log.SetOutput(f) } - log("starting") + log.SetFlags(log.LstdFlags | log.LUTC) + log.Printf("starting") var err error ptInfo, err = pt.ServerSetup(nil) if err != nil { - log("error in setup: %s", err) + log.Printf("error in setup: %s", err) os.Exit(1) } @@ -251,7 +243,7 @@ func main() { break } pt.Smethod(bindaddr.MethodName, ln.Addr()) - log("listening on %s", ln.Addr().String()) + log.Printf("listening on %s", ln.Addr().String()) listeners = append(listeners, ln) default: pt.SmethodError(bindaddr.MethodName, "no such method") @@ -273,13 +265,13 @@ func main() { case sig = <-sigChan: } } - log("Got first signal %q with %d running handlers.", sig, numHandlers) + log.Printf("Got first signal %q with %d running handlers.", sig, numHandlers) for _, ln := range listeners { ln.Close() } if sig == syscall.SIGTERM { - log("Caught signal %q, exiting.", sig) + log.Printf("Caught signal %q, exiting.", sig) return } @@ -289,11 +281,11 @@ func main() { select { case n := <-handlerChan: numHandlers += n - log("%d remaining handlers.", numHandlers) + log.Printf("%d remaining handlers.", numHandlers) case sig = <-sigChan: } } if sig != nil { - log("Got second signal %q with %d running handlers.", sig, numHandlers) + log.Printf("Got second signal %q with %d running handlers.", sig, numHandlers) } }

1 0

[websocket/master] Change back to "websocket" names from "pt-websocket" names.
by dcf＠torproject.org 19 Dec '15

19 Dec '15

commit 138301de19e0ec4726d98ae1eeed3b939da950a6 Author: David Fifield <david(a)bamsoftware.com> Date: Fri Dec 18 21:25:44 2015 -0800 Change back to "websocket" names from "pt-websocket" names. Distributors can rename the binaries if they want to. This reverts commit c4ef06f097354214460d45207a0297eec79d3bbe. This reverts commit f75ce00346237321622a3959997c707a1eaaf5ad. --- .gitignore | 4 +- Makefile | 22 +- README | 2 +- pt-websocket-client/pt-websocket-client.go | 263 ------------------------ pt-websocket-server/pt-websocket-server.go | 299 ---------------------------- websocket-client/websocket-client.go | 263 ++++++++++++++++++++++++ websocket-server/websocket-server.go | 299 ++++++++++++++++++++++++++++ 7 files changed, 576 insertions(+), 576 deletions(-) diff --git a/.gitignore b/.gitignore index 1e915e0..1fee725 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,2 @@ -/pt-websocket-client/pt-websocket-client -/pt-websocket-server/pt-websocket-server +/websocket-client +/websocket-server diff --git a/Makefile b/Makefile index 4882798..b723c86 100644 --- a/Makefile +++ b/Makefile @@ -9,26 +9,26 @@ GOBUILDFLAGS = # apt-get install gccgo-multilib # GOBUILDFLAGS = -compiler gccgo -gccgoflags "-O3 -m32 -static-libgo" -all: pt-websocket-server/pt-websocket-server +all: websocket-server/websocket-server -pt-websocket-server/pt-websocket-server: pt-websocket-server/*.go websocket/*.go - cd pt-websocket-server && go build $(GOBUILDFLAGS) +websocket-server/websocket-server: websocket-server/*.go websocket/*.go + cd websocket-server && go build $(GOBUILDFLAGS) -pt-websocket-client/pt-websocket-client: pt-websocket-client/*.go - cd pt-websocket-client && go build $(GOBUILDFLAGS) +websocket-client/websocket-client: websocket-client/*.go + cd websocket-client && go build $(GOBUILDFLAGS) -doc/pt-websocket-server.1: pt-websocket-server/pt-websocket-server +doc/websocket-server.1: websocket-server/websocket-server help2man --no-info --name "WebSocket server pluggable transport" --version-string "$(VERSION)" -o "$@" "$<" -install: pt-websocket-server/pt-websocket-server +install: websocket-server/websocket-server mkdir -p "$(DESTDIR)$(BINDIR)" - cp -f "$<" "$(DESTDIR)$(BINDIR)" + cp -f websocket-server/websocket-server "$(DESTDIR)$(BINDIR)" clean: - rm -f pt-websocket-server/pt-websocket-server pt-websocket-client/pt-websocket-client - rm -f doc/pt-websocket-server.1 + rm -f websocket-server/websocket-server websocket-client/websocket-client + rm -f doc/websocket-server.1 fmt: - go fmt ./pt-websocket-server ./pt-websocket-client ./websocket + go fmt ./websocket-server ./websocket-client ./websocket .PHONY: all install clean fmt diff --git a/README b/README index f2844eb..718dd67 100644 --- a/README +++ b/README @@ -27,4 +27,4 @@ Add configuration like the following to the relay's torrc. You can change the --port option; make sure that port is open in the firewall. ExtORPort 6669 - ServerTransportPlugin websocket exec /usr/local/bin/pt-websocket-server --port 9901 + ServerTransportPlugin websocket exec /usr/local/bin/websocket-server --port 9901 diff --git a/pt-websocket-client/pt-websocket-client.go b/pt-websocket-client/pt-websocket-client.go deleted file mode 100644 index f65a9c9..0000000 --- a/pt-websocket-client/pt-websocket-client.go +++ /dev/null @@ -1,263 +0,0 @@ -// Tor websocket client transport plugin. -// -// Usage in torrc: -// UseBridges 1 -// Bridge websocket X.X.X.X:YYYY -// ClientTransportPlugin websocket exec ./websocket-client -package main - -import ( - "code.google.com/p/go.net/websocket" - "flag" - "fmt" - "io" - "net" - "net/url" - "os" - "os/signal" - "sync" - "syscall" - "time" -) - -import "git.torproject.org/pluggable-transports/goptlib.git" - -var ptInfo pt.ClientInfo - -const ptMethodName = "websocket" -const bufSiz = 1500 - -var logFile = os.Stderr - -// When a connection handler starts, +1 is written to this channel; when it -// ends, -1 is written. -var handlerChan = make(chan int) - -var logMutex sync.Mutex - -func usage() { - fmt.Printf("Usage: %s [OPTIONS]\n", os.Args[0]) - fmt.Printf("WebSocket client pluggable transport for Tor.\n") - fmt.Printf("Works only as a managed proxy.\n") - fmt.Printf("\n") - fmt.Printf(" -h, --help show this help.\n") - fmt.Printf(" --log FILE log messages to FILE (default stderr).\n") - fmt.Printf(" --socks ADDR listen for SOCKS on ADDR.\n") -} - -func log(format string, v ...interface{}) { - dateStr := time.Now().Format("2006-01-02 15:04:05") - logMutex.Lock() - defer logMutex.Unlock() - msg := fmt.Sprintf(format, v...) - fmt.Fprintf(logFile, "%s %s\n", dateStr, msg) -} - -func proxy(local *net.TCPConn, ws *websocket.Conn) { - var wg sync.WaitGroup - - wg.Add(2) - - // Local-to-WebSocket read loop. - go func() { - buf := make([]byte, bufSiz) - var err error - for { - n, er := local.Read(buf[:]) - if n > 0 { - ew := websocket.Message.Send(ws, buf[:n]) - if ew != nil { - err = ew - break - } - } - if er != nil { - err = er - break - } - } - if err != nil && err != io.EOF { - log("%s", err) - } - local.CloseRead() - ws.Close() - - wg.Done() - }() - - // WebSocket-to-local read loop. - go func() { - var buf []byte - var err error - for { - er := websocket.Message.Receive(ws, &buf) - if er != nil { - err = er - break - } - n, ew := local.Write(buf) - if ew != nil { - err = ew - break - } - if n != len(buf) { - err = io.ErrShortWrite - break - } - } - if err != nil && err != io.EOF { - log("%s", err) - } - local.CloseWrite() - ws.Close() - - wg.Done() - }() - - wg.Wait() -} - -func handleConnection(conn *pt.SocksConn) error { - defer conn.Close() - - handlerChan <- 1 - defer func() { - handlerChan <- -1 - }() - - var ws *websocket.Conn - - log("SOCKS request for %s", conn.Req.Target) - destAddr, err := net.ResolveTCPAddr("tcp", conn.Req.Target) - if err != nil { - conn.Reject() - return err - } - wsUrl := url.URL{Scheme: "ws", Host: conn.Req.Target} - ws, err = websocket.Dial(wsUrl.String(), "", wsUrl.String()) - if err != nil { - err = conn.Reject() - return err - } - log("WebSocket connection to %s", ws.Config().Location.String()) - defer ws.Close() - err = conn.Grant(destAddr) - if err != nil { - return err - } - - proxy(conn.Conn.(*net.TCPConn), ws) - - return nil -} - -func socksAcceptLoop(ln *pt.SocksListener) error { - defer ln.Close() - for { - socks, err := ln.AcceptSocks() - if err != nil { - if e, ok := err.(*net.OpError); ok && e.Temporary() { - continue - } - return err - } - go func() { - err := handleConnection(socks) - if err != nil { - log("SOCKS from %s: %s", socks.RemoteAddr(), err) - } - }() - } - return nil -} - -func startListener(addrStr string) (*pt.SocksListener, error) { - ln, err := pt.ListenSocks("tcp", addrStr) - if err != nil { - return nil, err - } - go func() { - err := socksAcceptLoop(ln) - if err != nil { - log("accept: %s", err) - } - }() - return ln, nil -} - -func main() { - var logFilename string - var socksAddrStr string - var err error - - flag.Usage = usage - flag.StringVar(&logFilename, "log", "", "log file to write to") - flag.StringVar(&socksAddrStr, "socks", "127.0.0.1:0", "address on which to listen for SOCKS connections") - flag.Parse() - - if logFilename != "" { - f, err := os.OpenFile(logFilename, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0600) - if err != nil { - fmt.Fprintf(os.Stderr, "Can't open log file %q: %s.\n", logFilename, err.Error()) - os.Exit(1) - } - logFile = f - } - - log("starting") - ptInfo, err = pt.ClientSetup(nil) - if err != nil { - log("error in setup: %s", err) - os.Exit(1) - } - - listeners := make([]net.Listener, 0) - for _, methodName := range ptInfo.MethodNames { - switch methodName { - case ptMethodName: - ln, err := startListener(socksAddrStr) - if err != nil { - pt.CmethodError(ptMethodName, err.Error()) - break - } - pt.Cmethod(ptMethodName, ln.Version(), ln.Addr()) - log("listening on %s", ln.Addr().String()) - listeners = append(listeners, ln) - default: - pt.CmethodError(methodName, "no such method") - } - } - pt.CmethodsDone() - - var numHandlers int = 0 - var sig os.Signal - sigChan := make(chan os.Signal, 1) - signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM) - - // wait for first signal - sig = nil - for sig == nil { - select { - case n := <-handlerChan: - numHandlers += n - case sig = <-sigChan: - } - } - for _, ln := range listeners { - ln.Close() - } - - if sig == syscall.SIGTERM { - return - } - - // wait for second signal or no more handlers - sig = nil - for sig == nil && numHandlers != 0 { - select { - case n := <-handlerChan: - numHandlers += n - case sig = <-sigChan: - } - } -} diff --git a/pt-websocket-server/pt-websocket-server.go b/pt-websocket-server/pt-websocket-server.go deleted file mode 100644 index b14c754..0000000 --- a/pt-websocket-server/pt-websocket-server.go +++ /dev/null @@ -1,299 +0,0 @@ -// Tor websocket server transport plugin. -// -// Usage in torrc: -// ExtORPort 6669 -// ServerTransportPlugin websocket exec ./pt-websocket-server --port 9901 -package main - -import ( - "encoding/base64" - "errors" - "flag" - "fmt" - "io" - "net" - "net/http" - "os" - "os/signal" - "sync" - "syscall" - "time" -) - -import "../websocket" - -import "git.torproject.org/pluggable-transports/goptlib.git" - -const ptMethodName = "websocket" -const requestTimeout = 10 * time.Second - -// "4/3+1" accounts for possible base64 encoding. -const maxMessageSize = 64*1024*4/3 + 1 - -var logFile = os.Stderr - -var ptInfo pt.ServerInfo - -// When a connection handler starts, +1 is written to this channel; when it -// ends, -1 is written. -var handlerChan = make(chan int) - -func usage() { - fmt.Printf("Usage: %s [OPTIONS]\n", os.Args[0]) - fmt.Printf("WebSocket server pluggable transport for Tor.\n") - fmt.Printf("Works only as a managed proxy.\n") - fmt.Printf("\n") - fmt.Printf(" -h, --help show this help.\n") - fmt.Printf(" --log FILE log messages to FILE (default stderr).\n") - fmt.Printf(" --port PORT listen on PORT (overrides Tor's requested port).\n") -} - -var logMutex sync.Mutex - -func log(format string, v ...interface{}) { - dateStr := time.Now().Format("2006-01-02 15:04:05") - logMutex.Lock() - defer logMutex.Unlock() - msg := fmt.Sprintf(format, v...) - fmt.Fprintf(logFile, "%s %s\n", dateStr, msg) -} - -// An abstraction that makes an underlying WebSocket connection look like an -// io.ReadWriteCloser. It internally takes care of things like base64 encoding -// and decoding. -type webSocketConn struct { - Ws *websocket.WebSocket - Base64 bool - messageBuf []byte -} - -// Implements io.Reader. -func (conn *webSocketConn) Read(b []byte) (n int, err error) { - for len(conn.messageBuf) == 0 { - var m websocket.Message - m, err = conn.Ws.ReadMessage() - if err != nil { - return - } - if m.Opcode == 8 { - err = io.EOF - return - } - if conn.Base64 { - if m.Opcode != 1 { - err = errors.New(fmt.Sprintf("got non-text opcode %d with the base64 subprotocol", m.Opcode)) - return - } - conn.messageBuf = make([]byte, base64.StdEncoding.DecodedLen(len(m.Payload))) - var num int - num, err = base64.StdEncoding.Decode(conn.messageBuf, m.Payload) - if err != nil { - return - } - conn.messageBuf = conn.messageBuf[:num] - } else { - if m.Opcode != 2 { - err = errors.New(fmt.Sprintf("got non-binary opcode %d with no subprotocol", m.Opcode)) - return - } - conn.messageBuf = m.Payload - } - } - - n = copy(b, conn.messageBuf) - conn.messageBuf = conn.messageBuf[n:] - - return -} - -// Implements io.Writer. -func (conn *webSocketConn) Write(b []byte) (n int, err error) { - if conn.Base64 { - buf := make([]byte, base64.StdEncoding.EncodedLen(len(b))) - base64.StdEncoding.Encode(buf, b) - err = conn.Ws.WriteMessage(1, buf) - if err != nil { - return - } - n = len(b) - } else { - err = conn.Ws.WriteMessage(2, b) - n = len(b) - } - return -} - -// Implements io.Closer. -func (conn *webSocketConn) Close() error { - // Ignore any error in trying to write a Close frame. - _ = conn.Ws.WriteFrame(8, nil) - return conn.Ws.Conn.Close() -} - -// Create a new webSocketConn. -func newWebSocketConn(ws *websocket.WebSocket) webSocketConn { - var conn webSocketConn - conn.Ws = ws - conn.Base64 = (ws.Subprotocol == "base64") - return conn -} - -// Copy from WebSocket to socket and vice versa. -func proxy(local *net.TCPConn, conn *webSocketConn) { - var wg sync.WaitGroup - wg.Add(2) - - go func() { - _, err := io.Copy(conn, local) - if err != nil { - log("error copying ORPort to WebSocket") - } - local.CloseRead() - conn.Close() - wg.Done() - }() - go func() { - _, err := io.Copy(local, conn) - if err != nil { - log("error copying WebSocket to ORPort") - } - local.CloseWrite() - conn.Close() - wg.Done() - }() - - wg.Wait() -} - -func webSocketHandler(ws *websocket.WebSocket) { - // Undo timeouts on HTTP request handling. - ws.Conn.SetDeadline(time.Time{}) - conn := newWebSocketConn(ws) - defer conn.Close() - - handlerChan <- 1 - defer func() { - handlerChan <- -1 - }() - - or, err := pt.DialOr(&ptInfo, ws.Conn.RemoteAddr().String(), ptMethodName) - if err != nil { - log("Failed to connect to ORPort: " + err.Error()) - return - } - defer or.Close() - - proxy(or, &conn) -} - -func startListener(addr *net.TCPAddr) (*net.TCPListener, error) { - ln, err := net.ListenTCP("tcp", addr) - if err != nil { - return nil, err - } - go func() { - defer ln.Close() - var config websocket.Config - config.Subprotocols = []string{"base64"} - config.MaxMessageSize = maxMessageSize - s := &http.Server{ - Handler: config.Handler(webSocketHandler), - ReadTimeout: requestTimeout, - } - err = s.Serve(ln) - if err != nil { - log("http.Serve: " + err.Error()) - } - }() - return ln, nil -} - -func main() { - var logFilename string - var port int - - flag.Usage = usage - flag.StringVar(&logFilename, "log", "", "log file to write to") - flag.IntVar(&port, "port", 0, "port to listen on if unspecified by Tor") - flag.Parse() - - if logFilename != "" { - f, err := os.OpenFile(logFilename, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0600) - if err != nil { - fmt.Fprintf(os.Stderr, "Can't open log file %q: %s.\n", logFilename, err.Error()) - os.Exit(1) - } - logFile = f - } - - log("starting") - var err error - ptInfo, err = pt.ServerSetup(nil) - if err != nil { - log("error in setup: %s", err) - os.Exit(1) - } - - listeners := make([]*net.TCPListener, 0) - for _, bindaddr := range ptInfo.Bindaddrs { - // Override tor's requested port (which is 0 if this transport - // has not been run before) with the one requested by the --port - // option. - if port != 0 { - bindaddr.Addr.Port = port - } - - switch bindaddr.MethodName { - case ptMethodName: - ln, err := startListener(bindaddr.Addr) - if err != nil { - pt.SmethodError(bindaddr.MethodName, err.Error()) - break - } - pt.Smethod(bindaddr.MethodName, ln.Addr()) - log("listening on %s", ln.Addr().String()) - listeners = append(listeners, ln) - default: - pt.SmethodError(bindaddr.MethodName, "no such method") - } - } - pt.SmethodsDone() - - var numHandlers int = 0 - var sig os.Signal - sigChan := make(chan os.Signal, 1) - signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM) - - // wait for first signal - sig = nil - for sig == nil { - select { - case n := <-handlerChan: - numHandlers += n - case sig = <-sigChan: - } - } - log("Got first signal %q with %d running handlers.", sig, numHandlers) - for _, ln := range listeners { - ln.Close() - } - - if sig == syscall.SIGTERM { - log("Caught signal %q, exiting.", sig) - return - } - - // wait for second signal or no more handlers - sig = nil - for sig == nil && numHandlers != 0 { - select { - case n := <-handlerChan: - numHandlers += n - log("%d remaining handlers.", numHandlers) - case sig = <-sigChan: - } - } - if sig != nil { - log("Got second signal %q with %d running handlers.", sig, numHandlers) - } -} diff --git a/websocket-client/websocket-client.go b/websocket-client/websocket-client.go new file mode 100644 index 0000000..f65a9c9 --- /dev/null +++ b/websocket-client/websocket-client.go @@ -0,0 +1,263 @@ +// Tor websocket client transport plugin. +// +// Usage in torrc: +// UseBridges 1 +// Bridge websocket X.X.X.X:YYYY +// ClientTransportPlugin websocket exec ./websocket-client +package main + +import ( + "code.google.com/p/go.net/websocket" + "flag" + "fmt" + "io" + "net" + "net/url" + "os" + "os/signal" + "sync" + "syscall" + "time" +) + +import "git.torproject.org/pluggable-transports/goptlib.git" + +var ptInfo pt.ClientInfo + +const ptMethodName = "websocket" +const bufSiz = 1500 + +var logFile = os.Stderr + +// When a connection handler starts, +1 is written to this channel; when it +// ends, -1 is written. +var handlerChan = make(chan int) + +var logMutex sync.Mutex + +func usage() { + fmt.Printf("Usage: %s [OPTIONS]\n", os.Args[0]) + fmt.Printf("WebSocket client pluggable transport for Tor.\n") + fmt.Printf("Works only as a managed proxy.\n") + fmt.Printf("\n") + fmt.Printf(" -h, --help show this help.\n") + fmt.Printf(" --log FILE log messages to FILE (default stderr).\n") + fmt.Printf(" --socks ADDR listen for SOCKS on ADDR.\n") +} + +func log(format string, v ...interface{}) { + dateStr := time.Now().Format("2006-01-02 15:04:05") + logMutex.Lock() + defer logMutex.Unlock() + msg := fmt.Sprintf(format, v...) + fmt.Fprintf(logFile, "%s %s\n", dateStr, msg) +} + +func proxy(local *net.TCPConn, ws *websocket.Conn) { + var wg sync.WaitGroup + + wg.Add(2) + + // Local-to-WebSocket read loop. + go func() { + buf := make([]byte, bufSiz) + var err error + for { + n, er := local.Read(buf[:]) + if n > 0 { + ew := websocket.Message.Send(ws, buf[:n]) + if ew != nil { + err = ew + break + } + } + if er != nil { + err = er + break + } + } + if err != nil && err != io.EOF { + log("%s", err) + } + local.CloseRead() + ws.Close() + + wg.Done() + }() + + // WebSocket-to-local read loop. + go func() { + var buf []byte + var err error + for { + er := websocket.Message.Receive(ws, &buf) + if er != nil { + err = er + break + } + n, ew := local.Write(buf) + if ew != nil { + err = ew + break + } + if n != len(buf) { + err = io.ErrShortWrite + break + } + } + if err != nil && err != io.EOF { + log("%s", err) + } + local.CloseWrite() + ws.Close() + + wg.Done() + }() + + wg.Wait() +} + +func handleConnection(conn *pt.SocksConn) error { + defer conn.Close() + + handlerChan <- 1 + defer func() { + handlerChan <- -1 + }() + + var ws *websocket.Conn + + log("SOCKS request for %s", conn.Req.Target) + destAddr, err := net.ResolveTCPAddr("tcp", conn.Req.Target) + if err != nil { + conn.Reject() + return err + } + wsUrl := url.URL{Scheme: "ws", Host: conn.Req.Target} + ws, err = websocket.Dial(wsUrl.String(), "", wsUrl.String()) + if err != nil { + err = conn.Reject() + return err + } + log("WebSocket connection to %s", ws.Config().Location.String()) + defer ws.Close() + err = conn.Grant(destAddr) + if err != nil { + return err + } + + proxy(conn.Conn.(*net.TCPConn), ws) + + return nil +} + +func socksAcceptLoop(ln *pt.SocksListener) error { + defer ln.Close() + for { + socks, err := ln.AcceptSocks() + if err != nil { + if e, ok := err.(*net.OpError); ok && e.Temporary() { + continue + } + return err + } + go func() { + err := handleConnection(socks) + if err != nil { + log("SOCKS from %s: %s", socks.RemoteAddr(), err) + } + }() + } + return nil +} + +func startListener(addrStr string) (*pt.SocksListener, error) { + ln, err := pt.ListenSocks("tcp", addrStr) + if err != nil { + return nil, err + } + go func() { + err := socksAcceptLoop(ln) + if err != nil { + log("accept: %s", err) + } + }() + return ln, nil +} + +func main() { + var logFilename string + var socksAddrStr string + var err error + + flag.Usage = usage + flag.StringVar(&logFilename, "log", "", "log file to write to") + flag.StringVar(&socksAddrStr, "socks", "127.0.0.1:0", "address on which to listen for SOCKS connections") + flag.Parse() + + if logFilename != "" { + f, err := os.OpenFile(logFilename, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0600) + if err != nil { + fmt.Fprintf(os.Stderr, "Can't open log file %q: %s.\n", logFilename, err.Error()) + os.Exit(1) + } + logFile = f + } + + log("starting") + ptInfo, err = pt.ClientSetup(nil) + if err != nil { + log("error in setup: %s", err) + os.Exit(1) + } + + listeners := make([]net.Listener, 0) + for _, methodName := range ptInfo.MethodNames { + switch methodName { + case ptMethodName: + ln, err := startListener(socksAddrStr) + if err != nil { + pt.CmethodError(ptMethodName, err.Error()) + break + } + pt.Cmethod(ptMethodName, ln.Version(), ln.Addr()) + log("listening on %s", ln.Addr().String()) + listeners = append(listeners, ln) + default: + pt.CmethodError(methodName, "no such method") + } + } + pt.CmethodsDone() + + var numHandlers int = 0 + var sig os.Signal + sigChan := make(chan os.Signal, 1) + signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM) + + // wait for first signal + sig = nil + for sig == nil { + select { + case n := <-handlerChan: + numHandlers += n + case sig = <-sigChan: + } + } + for _, ln := range listeners { + ln.Close() + } + + if sig == syscall.SIGTERM { + return + } + + // wait for second signal or no more handlers + sig = nil + for sig == nil && numHandlers != 0 { + select { + case n := <-handlerChan: + numHandlers += n + case sig = <-sigChan: + } + } +} diff --git a/websocket-server/websocket-server.go b/websocket-server/websocket-server.go new file mode 100644 index 0000000..fbfffd8 --- /dev/null +++ b/websocket-server/websocket-server.go @@ -0,0 +1,299 @@ +// Tor websocket server transport plugin. +// +// Usage in torrc: +// ExtORPort 6669 +// ServerTransportPlugin websocket exec ./websocket-server --port 9901 +package main + +import ( + "encoding/base64" + "errors" + "flag" + "fmt" + "io" + "net" + "net/http" + "os" + "os/signal" + "sync" + "syscall" + "time" +) + +import "../websocket" + +import "git.torproject.org/pluggable-transports/goptlib.git" + +const ptMethodName = "websocket" +const requestTimeout = 10 * time.Second + +// "4/3+1" accounts for possible base64 encoding. +const maxMessageSize = 64*1024*4/3 + 1 + +var logFile = os.Stderr + +var ptInfo pt.ServerInfo + +// When a connection handler starts, +1 is written to this channel; when it +// ends, -1 is written. +var handlerChan = make(chan int) + +func usage() { + fmt.Printf("Usage: %s [OPTIONS]\n", os.Args[0]) + fmt.Printf("WebSocket server pluggable transport for Tor.\n") + fmt.Printf("Works only as a managed proxy.\n") + fmt.Printf("\n") + fmt.Printf(" -h, --help show this help.\n") + fmt.Printf(" --log FILE log messages to FILE (default stderr).\n") + fmt.Printf(" --port PORT listen on PORT (overrides Tor's requested port).\n") +} + +var logMutex sync.Mutex + +func log(format string, v ...interface{}) { + dateStr := time.Now().Format("2006-01-02 15:04:05") + logMutex.Lock() + defer logMutex.Unlock() + msg := fmt.Sprintf(format, v...) + fmt.Fprintf(logFile, "%s %s\n", dateStr, msg) +} + +// An abstraction that makes an underlying WebSocket connection look like an +// io.ReadWriteCloser. It internally takes care of things like base64 encoding +// and decoding. +type webSocketConn struct { + Ws *websocket.WebSocket + Base64 bool + messageBuf []byte +} + +// Implements io.Reader. +func (conn *webSocketConn) Read(b []byte) (n int, err error) { + for len(conn.messageBuf) == 0 { + var m websocket.Message + m, err = conn.Ws.ReadMessage() + if err != nil { + return + } + if m.Opcode == 8 { + err = io.EOF + return + } + if conn.Base64 { + if m.Opcode != 1 { + err = errors.New(fmt.Sprintf("got non-text opcode %d with the base64 subprotocol", m.Opcode)) + return + } + conn.messageBuf = make([]byte, base64.StdEncoding.DecodedLen(len(m.Payload))) + var num int + num, err = base64.StdEncoding.Decode(conn.messageBuf, m.Payload) + if err != nil { + return + } + conn.messageBuf = conn.messageBuf[:num] + } else { + if m.Opcode != 2 { + err = errors.New(fmt.Sprintf("got non-binary opcode %d with no subprotocol", m.Opcode)) + return + } + conn.messageBuf = m.Payload + } + } + + n = copy(b, conn.messageBuf) + conn.messageBuf = conn.messageBuf[n:] + + return +} + +// Implements io.Writer. +func (conn *webSocketConn) Write(b []byte) (n int, err error) { + if conn.Base64 { + buf := make([]byte, base64.StdEncoding.EncodedLen(len(b))) + base64.StdEncoding.Encode(buf, b) + err = conn.Ws.WriteMessage(1, buf) + if err != nil { + return + } + n = len(b) + } else { + err = conn.Ws.WriteMessage(2, b) + n = len(b) + } + return +} + +// Implements io.Closer. +func (conn *webSocketConn) Close() error { + // Ignore any error in trying to write a Close frame. + _ = conn.Ws.WriteFrame(8, nil) + return conn.Ws.Conn.Close() +} + +// Create a new webSocketConn. +func newWebSocketConn(ws *websocket.WebSocket) webSocketConn { + var conn webSocketConn + conn.Ws = ws + conn.Base64 = (ws.Subprotocol == "base64") + return conn +} + +// Copy from WebSocket to socket and vice versa. +func proxy(local *net.TCPConn, conn *webSocketConn) { + var wg sync.WaitGroup + wg.Add(2) + + go func() { + _, err := io.Copy(conn, local) + if err != nil { + log("error copying ORPort to WebSocket") + } + local.CloseRead() + conn.Close() + wg.Done() + }() + go func() { + _, err := io.Copy(local, conn) + if err != nil { + log("error copying WebSocket to ORPort") + } + local.CloseWrite() + conn.Close() + wg.Done() + }() + + wg.Wait() +} + +func webSocketHandler(ws *websocket.WebSocket) { + // Undo timeouts on HTTP request handling. + ws.Conn.SetDeadline(time.Time{}) + conn := newWebSocketConn(ws) + defer conn.Close() + + handlerChan <- 1 + defer func() { + handlerChan <- -1 + }() + + or, err := pt.DialOr(&ptInfo, ws.Conn.RemoteAddr().String(), ptMethodName) + if err != nil { + log("Failed to connect to ORPort: " + err.Error()) + return + } + defer or.Close() + + proxy(or, &conn) +} + +func startListener(addr *net.TCPAddr) (*net.TCPListener, error) { + ln, err := net.ListenTCP("tcp", addr) + if err != nil { + return nil, err + } + go func() { + defer ln.Close() + var config websocket.Config + config.Subprotocols = []string{"base64"} + config.MaxMessageSize = maxMessageSize + s := &http.Server{ + Handler: config.Handler(webSocketHandler), + ReadTimeout: requestTimeout, + } + err = s.Serve(ln) + if err != nil { + log("http.Serve: " + err.Error()) + } + }() + return ln, nil +} + +func main() { + var logFilename string + var port int + + flag.Usage = usage + flag.StringVar(&logFilename, "log", "", "log file to write to") + flag.IntVar(&port, "port", 0, "port to listen on if unspecified by Tor") + flag.Parse() + + if logFilename != "" { + f, err := os.OpenFile(logFilename, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0600) + if err != nil { + fmt.Fprintf(os.Stderr, "Can't open log file %q: %s.\n", logFilename, err.Error()) + os.Exit(1) + } + logFile = f + } + + log("starting") + var err error + ptInfo, err = pt.ServerSetup(nil) + if err != nil { + log("error in setup: %s", err) + os.Exit(1) + } + + listeners := make([]*net.TCPListener, 0) + for _, bindaddr := range ptInfo.Bindaddrs { + // Override tor's requested port (which is 0 if this transport + // has not been run before) with the one requested by the --port + // option. + if port != 0 { + bindaddr.Addr.Port = port + } + + switch bindaddr.MethodName { + case ptMethodName: + ln, err := startListener(bindaddr.Addr) + if err != nil { + pt.SmethodError(bindaddr.MethodName, err.Error()) + break + } + pt.Smethod(bindaddr.MethodName, ln.Addr()) + log("listening on %s", ln.Addr().String()) + listeners = append(listeners, ln) + default: + pt.SmethodError(bindaddr.MethodName, "no such method") + } + } + pt.SmethodsDone() + + var numHandlers int = 0 + var sig os.Signal + sigChan := make(chan os.Signal, 1) + signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM) + + // wait for first signal + sig = nil + for sig == nil { + select { + case n := <-handlerChan: + numHandlers += n + case sig = <-sigChan: + } + } + log("Got first signal %q with %d running handlers.", sig, numHandlers) + for _, ln := range listeners { + ln.Close() + } + + if sig == syscall.SIGTERM { + log("Caught signal %q, exiting.", sig) + return + } + + // wait for second signal or no more handlers + sig = nil + for sig == nil && numHandlers != 0 { + select { + case n := <-handlerChan: + numHandlers += n + log("%d remaining handlers.", numHandlers) + case sig = <-sigChan: + } + } + if sig != nil { + log("Got second signal %q with %d running handlers.", sig, numHandlers) + } +}

1 0

[websocket/master] Use a static man page.
by dcf＠torproject.org 19 Dec '15

19 Dec '15

commit 3646f308859fcea398e138042a38cdeb65ae8c83 Author: David Fifield <david(a)bamsoftware.com> Date: Fri Dec 18 22:18:25 2015 -0800 Use a static man page. --- Makefile | 4 --- doc/Makefile | 11 +++++++ doc/websocket-server.1 | 69 ++++++++++++++++++++++++++++++++++++++++++++ doc/websocket-server.1.txt | 42 +++++++++++++++++++++++++++ 4 files changed, 122 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index b723c86..b6ea18c 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,6 @@ DESTDIR = PREFIX = /usr/local BINDIR = $(PREFIX)/bin -VERSION = 0.1 GOBUILDFLAGS = # Alternate flags to use gccgo, allowing cross-compiling for x86 from @@ -17,9 +16,6 @@ websocket-server/websocket-server: websocket-server/*.go websocket/*.go websocket-client/websocket-client: websocket-client/*.go cd websocket-client && go build $(GOBUILDFLAGS) -doc/websocket-server.1: websocket-server/websocket-server - help2man --no-info --name "WebSocket server pluggable transport" --version-string "$(VERSION)" -o "$@" "$<" - install: websocket-server/websocket-server mkdir -p "$(DESTDIR)$(BINDIR)" cp -f websocket-server/websocket-server "$(DESTDIR)$(BINDIR)" diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..464e1b5 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,11 @@ +MAN = websocket-server.1 + +all: $(MAN) + +%.1: %.1.txt + a2x --no-xmllint --xsltproc-opts "--stringparam man.th.title.max.length 17" -d manpage -f manpage $< + +clean: + rm -f $(MAN) + +.PHONY: all clean diff --git a/doc/websocket-server.1 b/doc/websocket-server.1 new file mode 100644 index 0000000..75161b2 --- /dev/null +++ b/doc/websocket-server.1 @@ -0,0 +1,69 @@ +'\" t +.\" Title: websocket-server +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 12/18/2015 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "WEBSOCKET\-SERVER" "1" "12/18/2015" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +websocket-server \- WebSocket pluggable transport server +.SH "SYNOPSIS" +.sp +\fBwebsocket\-server\fR [\fIOPTIONS\fR] +.SH "DESCRIPTION" +.sp +websocket\-server is a transport plugin for Tor that uses the WebSocket protocol\&. It is the server component of the flash proxy system\&. +.sp +Configuration for websocket\-server usually appears in a torrc file\&. Here is a sample configuration: +.sp +.if n \{\ +.RS 4 +.\} +.nf +ExtORPort auto +ServerTransportPlugin websocket exec /usr/local/bin/websocket\-server \-\-port 9901 +.fi +.if n \{\ +.RE +.\} +.SH "OPTIONS" +.PP +\fB\-\-log\fR=\fIFILENAME\fR +.RS 4 +Name of a file to write log messages to (default stderr)\&. +.RE +.PP +\fB\-\-port\fR=\fIPORT\fR +.RS 4 +Port to listen on\&. Overrides the TOR_PT_SERVER_BINDADDR environment variable set by tor\&. +.RE +.PP +\fB\-h\fR, \fB\-\-help\fR +.RS 4 +Display a help message and exit\&. +.RE +.SH "BUGS" +.sp +Please report at \fBhttps://trac\&.torproject\&.org/projects/tor\fR\&. diff --git a/doc/websocket-server.1.txt b/doc/websocket-server.1.txt new file mode 100644 index 0000000..c227a92 --- /dev/null +++ b/doc/websocket-server.1.txt @@ -0,0 +1,42 @@ +// This file is asciidoc source code. +// To generate manpages, use the a2x command i.e. +// a2x --no-xmllint -d manpage -f manpage websocket-server.1.txt +// see http://www.methods.co.nz/asciidoc/userguide.html#X1 +WEBSOCKET-SERVER(1) +=================== + +NAME +---- +websocket-server - WebSocket pluggable transport server + +SYNOPSIS +-------- +**websocket-server** [__OPTIONS__] + +DESCRIPTION +----------- +websocket-server is a transport plugin for Tor that uses the WebSocket +protocol. It is the server component of the flash proxy system. + +Configuration for websocket-server usually appears in a torrc file. Here +is a sample configuration: +---- +ExtORPort auto +ServerTransportPlugin websocket exec /usr/local/bin/websocket-server --port 9901 +---- + +OPTIONS +------- +**--log**=__FILENAME__:: + Name of a file to write log messages to (default stderr). + +**--port**=__PORT__:: + Port to listen on. Overrides the TOR_PT_SERVER_BINDADDR environment + variable set by tor. + +**-h**, **--help**:: + Display a help message and exit. + +BUGS +---- +Please report at **https://trac.torproject.org/projects/tor**.

1 0