-
-
Download the OpenVPN client and connect using the public DNS of the ec2 instance.
All set! Now the internet traffic will be routed through the VPN. Verify it using an IP Lookup
@@ -92,24 +91,21 @@How it works
ENV Variables¶
-Environment variables are loaded from
+.envfile if present.Environment variables are loaded from any
envfile if present.More on Environment variables
+
-- +
VPN_USERNAME - Username to access
OpenVPN Connectclient.- +
VPN_PASSWORD - Password to access
OpenVPN Connectclient.VPN_PORT - Port number for web interfaces.
IMAGE_ID - AMI ID to be used. Defaults to a pre-built AMI from SSM parameter for OpenVPN Access Server AMI Alias.
- -
INSTANCE_TYPE - Instance type to use for the VPN server. Defaults to
t2.nano, uset2.microif under free-tier.- -
VPN_USERNAME - Username to access
OpenVPN Connectclient. Defaults to log in profile oropenvpn- -
VPN_PASSWORD - Password to access
OpenVPN Connectclient. Defaults toawsVPN2021- -
DOMAIN - Domain name for the hosted zone.
- +
RECORD_NAME - Alias record name using which the VPN server has to be accessed.
- +
KEY_PAIR - Name of the key pair file to connect to ec2.
- +
SECURITY_GROUP - Name of the security group.
- +
VPN_INFO - Name of the JSON file to dump the server information.
- +
HOSTED_ZONE - Domain name for the hosted zone.
SUBDOMAIN - Alias record name using which the VPN server has to be accessed.
To get notification about login information:
--
-- -
GMAIL_USER - Username of the gmail account.
- -
GMAIL_PASS - Password of the gmail account.
- -
RECIPIENT - Email address to which the notification has to be sent.
- -
PHONE - Phone number to which the notification has to be sent (Works only for
USbased cellular)Optionally
+env varsfor AWS config (AWS_ACCESS_KEY,AWS_SECRET_KEY,AWS_REGION_NAME) can be setup.Optionally
env varsfor AWS config (AWS_PROFILE_NAME,AWS_ACCESS_KEY,AWS_SECRET_KEY,AWS_REGION_NAME) can be setup.
import vpn
+import os
+
+os.environ['env_file'] = 'custom' # to load a custom .env file
+
+import vpn
# Instantiates the object, takes the same args as env vars.
vpn_server = vpn.VPNServer() # Defaults to console logging, but supports custom logger.
vpn_server.create_vpn_server() # Create a VPN Server, login information will be saved to a JSON file.
-# Re-configure an existing VPN Server (not required, unless the configuration steps have been interrupted)
-# vpn_server.reconfigure_vpn()
-
# Test an existing VPN Server (not required, as a test is run right after creation anyway)
# vpn_server.test_vpn()
vpn_server.delete_vpn_server() # Deletes the VPN Server removing the AWS resources acquired during creation.
-
-Manual Configuration
Following are the prompts and response required to configure the VPN server.
-
-Are you sure you want to continue connecting (yes/no)? yes
-
-Please enter ‘yes’ to indicate your agreement [no]: yes
Will this be the primary Access Server node? Default: yes
Please specify the network interface and IP address to be used by the Admin Web UI: Default: all interfaces: 0.0.0.0
Please specify the port number for the Admin Web UI. Default: 943
Please specify the TCP port number for the OpenVPN Daemon. Default: 443
Should client traffic be routed by default through the VPN? yes
Should client DNS traffic be routed by default through the VPN? Default: No
Use local authentication via internal DB? Default: yes
Should private subnets be accessible to clients by default? Default: yes
Do you wish to login to the Admin UI as “openvpn”? Default: yes
Specify the username for an existing user or for the new user account: {USERNAME}
Type the password for the ‘vicky’ account: {PASSWORD}
Confirm the password for the ‘vicky’ account: {PASSWORD}
Please specify your Activation key (or leave blank to specify later): {ENTER/RETURN}
-
-Download the OpenVPN application and get connected to the VPN server.
+
+Limitations
Currently expose cannot handle, tunneling multiple port numbers without modifying the following env vars in the .env file.
+KEY_PAIR # SSH connection to AWS ec2
+KEY_FILE # Private key filename for self signed SSL
+CERT_FILE # Public certificate filename for self signed SSL
+SERVER_INFO # Filename to dump JSON data with server configuration information
+SECURITY_GROUP # Ingress and egress firewall rules to control traffic allowed via VPC
+
+
-
-AWS Resources Used¶
-
-EC2
-
-Instance - To redirect traffic through the instance’s IP
SecurityGroup - To allow traffic over specific TCP ports
Systems Manager - To access OpenVPN SSM parameter store to retrieve the AMI ID
Route53 [Optional] - To access VPN server using an A record in Route 53
-VPC [Default]
Subnet [Default]
-
+
+Coding Standards¶
+Docstring format: Google
+Styling conventions: PEP 8
+Clean code with pre-commit hooks: flake8 and
+isort
-Release Notes¶
+Release Notes¶
Requirement
python -m pip install gitverse
@@ -187,7 +160,7 @@
-Linting¶
+Linting¶
PreCommit will ensure linting, and the doc creation are run on every commit.
Requirement
pip install sphinx==5.1.1 pre-commit recommonmark
@@ -199,14 +172,15 @@ Linting
-Links¶
+Links¶
+
License & copyright¶
-© Vignesh Sivanandha Rao
+© Vignesh Rao
Licensed under the MIT License
@@ -229,10 +203,12 @@ Table of Contents
ENV Variables
Install
Usage
-AWS Resources Used
+Coding Standards
+
License & copyright
@@ -282,7 +258,7 @@ Navigation