1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
|
// 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 "git.torproject.org/pluggable-transports/websocket/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([]string{ptMethodName})
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)
}
}
|