progy

proGY

A miniature squid like intermediate local proxy server.

Installation

Usual go get is suffice to get this server up and running.

go get -u github.com/aki237/proGY

If $GOPATH/bin is in your path then you are good to go. Else add it in your $PATH variable.

Usage

proGY

This starts a proxy server at the http://[local_listen_address]:[listen_port] and authenticating requests to the remote proxy server with the given proxy credentials. If the network traffic is to be monitored : add a -v to the command. THis make live logs to appear in the stdout. [-v is not recomended : craps up the terminal]

If a LAN IP is assigned to the host PC ,say 192.168.1.100, then proGY can be run in that address, thus accessible to all the devices in the network. Actually I got sick of the commandline arguments. So write a config file ".progy" in json format that conatains the following ...

{
    "listenaddress":":9999",
    "Creds":[
		{
			"remoteproxyaddress":"<listenaddress1>:<port1>",
			"username":"<username1>",
			"password":"<password1>"
		},
		{
			"remoteproxyaddress":"<listenaddress2>:<port2>",
			"username":"<username2>",
			"password":"<password2>"
		},
		{
			"remoteproxyaddress":"<listenaddress3>:<port3>",
			"username":"<username3>",
			"password":"<password3>"
		}
	],
	"domaincachefile" : "<cacheFileLocation>",
	"verbose":true,
	"contorlsocket":"/tmp/proGY-control",
	"loggerport" :  <SomePortAsInteger>
}

Example

{
    "listenaddress":":9999",
    "Creds":[
		{
			"remoteproxyaddress":"134.8.9.13:80",
			"username":"alanthicke",
			"password":"ohcanada"
		},
		{
			"remoteproxyaddress":"134.8.9.34:9900",
			"username":"brobibs",
			"password":"milliondollaridea"
		},
		{
			"remoteproxyaddress":"134.8.9.55:8080",
			"username":"awesomium",
			"password":"elementbybarney"
		}
    ],
	"domaincachefile" : "/Users/stinson/.cache/dnscache.pgy",
	"contorlsocket":"/tmp/proGY-control",
    "verbose":true,
    "loggerport" :  3030
}

Features

Domain Name Cache File

Domain Name Cachefile points to a bolt database file. If you don't have the file already, bolt will create it automatically. This file is used to store the maps of domain names to their IP addresses. This will make the tunnelling a lot faster than domain name lookup for every connection.

Logger Service TCP Port

This should be mentioned so that, the logger service will run at that port(TCP).

It is a TCP based Cross Process Communication Service, with Json as the transport format.

I used proGY as a systemd service. Till v1.02.1, it was spamming journal logs with lots of data (Sent Bytes, Recieved Bytes). I used it only when internet seems to slouch a little bit. So I was only expecting for errors when I open the journal logs.

When you connect to the TCP server running at specified port using some program (say telnet), it will spit out the json object of the connection made or closed. This can be used by other programs. Like for example monitoring

This branch is just testing and is inteded to work in any posix system which has the proc file system mounted. The running system has to have the ss command(not netstat). I have been writing another package to remove this external binary dependancy, replicating the functionalities of ss and ps commands in golang. Any help to write those packages will be apperitiated.

Control Port

A new feature for controlling proGY has been added. A unix socket running at any location (Default Location if not specified : /tmp/proGY-control) specified in the config file will be running for controlling the daemon. Syntax for controlling it will be like a simple QBasic statement. Right now only one command has been added. To reload the configuration on the fly without stopping use the socat tool to connect to the domain socket and communicate with it.

$ socat - UNIX:/tmp/proGY-control
RELOAD /etc/progy.json

• RELOAD - to reload the running proGY configuration. The listenaddress cannot be changed. Usage : RELOAD [filename] - any file with the proGY's configuration structure as specified above will be good.

Future Plans

• Enable transparent proxying for TLS connections also.