Fix changelog version.
[ocproxy-debian.git] / README
bloba5e4beea3d2bbdeb95b6d8d03291db61392ca7ed
1 ocproxy is a user-level SOCKS and port forwarding proxy for OpenConnect
2 based on lwIP.  When using ocproxy, OpenConnect only handles network
3 activity that the user specifically asks to proxy, so the VPN interface
4 no longer "hijacks" all network traffic on the host.
6 Commonly used options include:
8   -D port                   Set up a SOCKS5 server on PORT
9   -L lport:rhost:rport      Connections to localhost:LPORT will be redirected
10                             over the VPN to RHOST:RPORT
11   -g                        Allow non-local clients.  Must be the first option.
12   -k interval               Send TCP keepalive every INTERVAL seconds, to
13                             prevent connection timeouts
16 Dependencies:
18 libevent >= 2.0 - *.so library and headers
21 Building:
23 cd contrib/ports/unix/proj/ocproxy
24 make
27 Sample usage:
29 openconnect --script-tun --script \
30     "./ocproxy -L 2222:unix-host:22 -L 3389:win-host:3389 -D 11080" \
31     vpn.example.com
33 ssh -p2222 localhost
34 rdesktop localhost
35 socksify ssh unix-host
36 tsocks ssh 172.16.1.2
37 ...
39 OpenConnect can (and should) be run as a non-root user when using ocproxy.
42 Sample tsocks.conf (no DNS):
44 server = 127.0.0.1
45 server_type = 5
46 server_port = 11080
49 Sample socks.conf for Dante (DNS lookups via SOCKS5 "DOMAIN" addresses):
51 resolveprotocol: fake
52 route {
53         from: 0.0.0.0/0 to: 0.0.0.0/0 via: 127.0.0.1 port = 11080
54         command: connect
55         proxyprotocol: socks_v5
59 dme@dme.org, 2012-11-14