go-proxy-tee

go-proxy-tee

Warning

This is exemplar code only. It does not build because of unmet dependencies.

Summary

Build go-proxy-tee-M.m.P-I.x86_64.rpm and go-proxy-tee_M.m.P-I_amd64.deb where "M.m.P-I" is Major.minor.Patch-Iteration.

Usage

A proxy the acts like Linux's tee command, but for network traffic.

Configuration

Copy go-proxy-tee.json.sample to go-proxy-tee.json in one of the following places:

• ./go-proxy-tee.json for "directory-specific" invocation
• $HOME/.go-proxy-tee/go-proxy-tee.json for "user-specific" invocation
• /etc/go-proxy-tee/go-proxy-tee.json for "system-specific" invocation

Note: Can be placed in another directory and then use the --configPath command-line option.

Modify go-proxy-tee.json key/values:

• debug: Turn on/off debugging statements.
  • Values: true / false
  • Also available via the --debug command-line option
• format: Specify output format for "tee" files.
  • Values: "binaryfile", "binaryxml", "hex", "hexparsed", "string".
  • Also available via the --format command-line option
• inbound: Communication from client to go-proxy-tee
  • network: Type of network. Values: "tcp", "unix"
  • address: Address for network-type.
  • output: File to send traffic from client when using --format binaryfile
• outbound: Communication from go-proxy-tee to primary server
  • network: Type of network. Values: "tcp", "unix"
  • address: Address for network-type.
  • output: File to send captured network traffic
  • Responses from the primary server will be transmitted to the client.
• tee: List of communications from `go-proxy-tee to additional servers
  • {tee-name}: - a name of your choosing
    • network: Type of network. Values: "tcp", "unix"
    • address: Address for network-type.
    • output: File to send captured network traffic
  • Responses from these servers will not be transmitted to the client.

Format

The format JSON stanza which can be over-ridden by the --format commandline option has one of the following values.

This is the default value. The output file captures both request and response. A header prefaces each message. The binary message is converted to a string. ...

This output is the binary stream sent by either the client or by a server. This format differs from the other formats because each output file represents bytes sent by the client or by servers, but not both. Other formats show both the client and server interaction. The output file can be formatted into hex by running hexdump -C /path/to/outputfile.txt.

This format is an attempt to parse the network traffic into the Binary XML format.

A format similar to what is seen in hexdump -C /path/to/file.out

...

Invocation

go-proxy-tee net

To transform --format binaryxml output to XML, run:

go-proxy-tee binaryxml

Development

Dependencies

Set environment variables

export GOPATH="${HOME}/go"
export PATH="${PATH}:${GOPATH}/bin:/usr/local/go/bin"
export PROJECT_DIR=${GOPATH}/src/github.com/docktermj
export REPOSITORY_DIR="${PROJECT_DIR}/go-proxy-tee"

Download project

mkdir -p ${PROJECT_DIR}
cd ${PROJECT_DIR}
git clone git@github.com:docktermj/go-proxy-tee.git

Download dependencies

cd ${REPOSITORY_DIR}
make dependencies

Build

Local build

cd ${REPOSITORY_DIR}
make build-local

The results will be in the ${GOPATH}/bin directory.

Docker build

cd ${REPOSITORY_DIR}
make build

The results will be in the .../target directory.

Test

cd ${REPOSITORY_DIR}
make test-local

Install

RPM-based

Example distributions: openSUSE, Fedora, CentOS, Mandrake

Example:

sudo rpm -ivh go-proxy-tee-M.m.P-I.x86_64.rpm

Example:

sudo rpm -Uvh go-proxy-tee-M.m.P-I.x86_64.rpm

Debian

Example distributions: Ubuntu

Example:

sudo dpkg -i go-proxy-tee_M.m.P-I_amd64.deb

Cleanup

make clean