summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorAlex Xu (Hello71) <alex_y_xu@yahoo.ca>2016-06-26 16:29:32 -0400
committerAlex Xu (Hello71) <alex_y_xu@yahoo.ca>2016-06-29 18:22:24 -0400
commitabe4a8942044a29acd68dc7faf4ac09563e9b921 (patch)
tree666cb878ff588cfbc0e847418985ac919fb0f09e /README
downloadudpastcp-abe4a8942044a29acd68dc7faf4ac09563e9b921.tar.xz
udpastcp-abe4a8942044a29acd68dc7faf4ac09563e9b921.zip
Initial commit
Diffstat (limited to 'README')
-rw-r--r--README17
1 files changed, 17 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..e90a036
--- /dev/null
+++ b/README
@@ -0,0 +1,17 @@
+This program hides UDP traffic as TCP traffic in order to bypass certain
+firewalls.
+
+It is not designed to bypass rigorous deep packet inspection; for example,
+there is no window scaling; all data received as UDP will be immediately
+transmitted as TCP with a fixed window size. There is also no retransmission,
+although that could be implemented (at a detriment to the overall network health).
+
+This program is intended to be C99 and POSIX compatible, and requires only
+libev. If desired, it should be easily portable to use libevent instead, as it
+uses only basic event-based programming concepts.
+
+example usage:
+ server# openvpn --proto udp --port 1194
+ server# udpintcp server localhost 11940 localhost 1194
+ client# udpintcp client localhost 1194 server 11940
+ client# openvpn --remote localhost 11940 udp