Proxy tools for OSX

Usage

Used to manage location switching, proxies, etc... from the command line, using a json config file.

Using the details from the proxy-config.json, the Scripts will:

• Create a new OSX Network Location, in the Network preferences page
• Populate the proxy configuration for your new Location
• Populate the DNS configuration for your new Location
• Provide helper scripts, to populate the proxy configuration in your shell session.
• Provide helper scripts to switch between OSX Network Locations on the command line.
• Optional: Create a Local squid proxy (In Docker), that handles comms to the remote proxy.

Prerequisites

jq is required. Follow the instructions here to install it. openconnect is used to run the vpn script. Can be installed with brew

Commands

See example configuration file at dummy-proxy-config.json

1. Add your proxy details to the OSX keychain

For security, it's better for your scripts to retrieve proxy details from the osx keychain. nb: A regex, loaded from the config, is used to ensure the username is in the correct format e.g. d123478

upsert-proxy-creds-to-keychain.sh /path/to/proxy-config.json myproxyusername

2. Create / Load Locations

Uses the OSX Network Location feature, to switch between Locations. If the network Location (my-vpn in the example below), is not an existing osx network Location, the script uses the details in the config file to create the location.

./run-location.sh /path/to/proxy-config.json my-vpn 

If the network Location IS an existing osx Network Location, the script simply switches to that Location.

3. Run the vpn command

Use the vpn details from the config file, hostname, etc... To help with route issues, on script exit, the vpn route is removed. Will require sudo.

./run-vpn.sh /path/to/proxy-config.json

4. Create Proxy config

Creates the configuraton, in the OSX Networks preferences pane, for a web proxy and secure proxy. The proxy-config file is used to populate the user, password, host, port, bypass domains, etc... mentioned in the config file nb: Uses proxy username and password from the keychain.

./run-proxy.sh /path/to/proxy-config.json

Running a local proxy

See the Docker squid README for details on running a local instance of squid, that will run a local proxy (that handles the communication with the remote proxy.)

To use the local proxy, enable the localproxy.enabled property to "true" in the proxy config.

5. Add Proxy config as env variables

To use the proxy configuration on the command line, source the add-proxy-details-to-env.sh file

source ./toggle-proxy-details-in-env.sh /path/to/proxy-config.json

This will add the details of the proxy into the current shell environment, e.g.

export  HTTP_PROXY=http://localhost:3128
export  http_proxy=http://localhost:3128
export HTTPS_PROXY=http://localhost:3128
export https_proxy=http://localhost:3128

nb: If you source the common.sh script, you can use the following helper functions:

start_proxy Wi-Fi
start_proxy Ethernet
status_proxy Wi-Fi
status_proxy Ethernet
stop_proxy Wi-Fi
dump_location_details
clean_env_vars

6. Run, using aliases

Add the following to your .bashrc or .bash_profile, changing the alias names/paths as required

## Switch to the Location to be used for the vpn, then run the vpn script
alias myvpn='/path/to/scripts/run-location.sh /path/to/scripts/my-proxy-config.json myco-vpn && /path/to/scripts/run-vpn.sh /path/to/scripts/my-proxy-config.json'

## Switch back to the non vpn Location, e.g. Home
alias home='/path/to/scripts/run-location.sh /path/to/scripts/my-proxy-config.json home'


## Enable the proxy and expose proxy vars to bash env
alias myproxy='/path/to/scripts/run-proxy.sh /path/to/scripts/my-proxy-config.json && source /path/to/scripts/toggle-proxy-details-in-env.sh /path/to/scripts/my-proxy-config.json'