Skip to content

Latest commit

 

History

History
88 lines (62 loc) · 3.8 KB

README.MD

File metadata and controls

88 lines (62 loc) · 3.8 KB
Raw

Logo

openconnect-ocproxy

This project aims to facilitate the setup of a secure VPN connection within a Docker container using the OpenConnect client, providing access to the VPN connection through a SOCKS5 proxy powered by ocproxy. It supports multiple VPN protocols, including Cisco's AnyConnect SSL VPN, and allows for establishing multiple simultaneous connections to supported VPNs, even those using the same protocol, with isolation at the Docker container level. Network traffic is routed through the VPN via the SOCKS5 proxy, enabling easy and secure tunneling of connections from your local environment or other applications through the VPN.

Components Used

Getting Started

To set up openconnect-ocproxy, configure environment variables according to whether you're running the Docker container directly or building and running locally.

Running with Docker

When running the Docker container directly, you can set environment variables in the docker run command. Here’s how:

  1. Prepare Environment Variables: Include the required environment variables in the Docker run command.
docker run \
-d \
-e OPENCONNECT_URL="ip:port" \
-e OPENCONNECT_USER="user" \
-e OPENCONNECT_PASSWORD="password" \
-e OPENCONNECT_MFA_CODE='mfa_code (optional)' \
-e OPENCONNECT_OPTIONS="--protocol=<vpn_protocol>" \
--name "openconnect-ocproxy" \
-p <local_port>:9876 \
--restart always \
barpaw/openconnect-ocproxy:latest
  • Replace ip:port, user, password, mfa_code, <vpn_protocol>, and <local_port> with the appropriate values for your setup.
  • Note: Your connection may require additional options in OPENCONNECT_OPTIONS. Check the OpenConnect manual for more flags.

Building and Running Locally

When building and running the container locally using the build_and_run_locally.sh script, configure the environment variables in a .env file. Follow these steps:

  1. Create an Environment File: Create a .env file in the repository directory with the required environment variables. The .env file should look like this:
OPENCONNECT_URL='ip:port, e.g., 127.0.0.1:2000'
OPENCONNECT_USER='user'
OPENCONNECT_PASSWORD='password'
OPENCONNECT_MFA_CODE='mfa_code (optional)'
OPENCONNECT_OPTIONS='--protocol=<protocol, e.g., f5> --example_option=example'
DOCKER_CONTAINER_NAME='f5_vpn'
DOCKER_OPENCONNECT_PROXY_VERSION='1.0.1'
DOCKER_SOCKS5_PROXY_PORT=1337
  1. Run the Script: Execute the script to build the Docker image and start the container with the configuration from the .env file:
sh build_and_run_locally.sh .env
  • Ensure that the .env file is present in the repository directory and contains the necessary environment variables.

Supported Protocols

OpenConnect supports the following VPN protocols:

  • Cisco AnyConnect --protocol=anyconnect
  • Array Networks AG SSL VPN --protocol=array
  • Juniper SSL VPN --protocol=nc
  • Pulse Connect Secure --protocol=pulse
  • Palo Alto Networks GlobalProtect SSL VPN --protocol=gp
  • F5 Big-IP SSL VPN --protocol=f5
  • Fortinet Fortigate SSL VPN --protocol=fortinet

For more details on these protocols and additional options, please refer to the OpenConnect manual.

Docker Hub

You can find the Docker image for openconnect-ocproxy on Docker Hub. Pull the image using the following command:

docker pull barpaw/openconnect-ocproxy:latest

For more details, visit the Docker Hub repository.

License

This project is licensed under the MIT License.