5 \h'-\w'\fB\\$1\ \fP'u'\fB\\$1\ \fP\c
32 .TH pkstream 1 "23 April 2003" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
34 pkstream \- forward UDP packets over streams
52 program forwards UDP packets over some kind of reliable stream. It
53 understands TCP sockets natively; anything else has to be fudged up
54 using some kind of port forwarder like
58 etc. It's intended, among other things, to provide a transport for
60 packets where there are annoying firewalls in the way.
61 .SS "Command-line arguments"
66 pairs on the command-line are respectively the UDP port that
68 should listen on, and the port which it should receive packets from and
73 will parse packets from the stream attached to its standard input and
74 send them to its UDP peer; and it will write packets it reads from its
75 UDP port to the stream attached to its standard output. The program
76 will quit when its input stream closes.
78 This behaviour can be modified by passing suitable options:
81 Writes a brief description of the command-line options available to
82 standard output and exits with status 0.
87 version number to standard output and exits with status 0.
90 Writes a brief usage summary to standard output and exits with status 0.
92 .BI "\-l, \-\-listen=" port
93 Listen for connections on the given TCP
95 Only one connection is allowed at a time. When a connection is
96 accepted, forward UDP packets over the TCP stream until it closes; then
97 wait for another connection.
98 .BI "\-p, \-\-peer=" addr
99 Only accept TCP connections from
101 This option only makes sense in conjunction with
104 .BI "\-c, \-\-connect=" addr : port
109 and forward packets over the TCP connection rather than using stdin and
112 The stream protocol is very simple. Each packet is preceded by a
113 two-octet length field in network byte order. The length is number of
114 octets in the following packet (i.e., it does
116 include the length field itself). There is no padding between packets.
117 The only way a stream can be invalid is if it stops in the middle of a
120 The code hasn't been audited. It may contain security bugs. If you
121 find one, please inform the author
129 Mark Wooding, <mdw@nsict.org>