Read Me

UDP Tunnel

Copyright (c) 2010 Andrew S. Gaskill


1. License

This software is released under the MIT license.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.


2. Functionality

The software functions in a peer-to-peer fashion, with each peer connecting to
and accepting connections from any number of remote peers via TCP.  Each peer
has a definition of mappings from a local UDP port to a remote IP address and
UDP port through a specified peer.  Peers are identified by a user-assigned
name. Since UDP traffic can be tunneled from a "server" to a "client" it is
well suited to monitoring remote SNMP devices through an agent that can make
an outbound connection through its firewall, where otherwise inbound port
forwards through the firewall would be required.


3. Installation

Extract to a program folder.  C:\Program Files\UDPProxy is assumed.


4. Usage

Both a command line application and a windows service are provided.  The
service, UDPProxySvc.exe, can be installed via InstallUtil.exe in the .Net
Framework 2.0 folder.  A convenience batch file, install.cmd, is provided.
Configuration is via the config.xml file, for which a sample is provided.  In
most cases only a listen section or a connect section will be provided, but
there's no reason there can't be both.  The logfile is optional, debug
information will be logged there.  The UDPProxySvc.exe.config file may need to
be modified to point to the configuration file if the path is changed.

The command line application is passed the same configuration instructions as
command line parameters, which are described if no parameters are supplied.


5. Mono

This application should run fine under Mono on Linux.  The mono-service2
runtime can be used to run the service as a daemon.  The configuration file
path will certainly need to be modified.