Merge pull request #8 from Dhi13man/feature/global-protect

Release v0.0.2 | Global Protect Integration, data model decoupling and Zope Interfaces removal

Author: Dhi13man

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Releases
+
+## [0.0.2] - 16th June 2024
+
+1. Integrated one-step [Palo Alto Global Protect](https://docs.paloaltonetworks.com/globalprotect) VPN connection/disconnection.
+2. Decoupled VPN Config and VPN Data Models for future flexibility.
+3. Removed unnecessary Zope Interfaces dependency as it does not seem worth the maintenance effort.
+4. Upgraded `pyinstaller` dependency to leave vulnerable version.
+
+## [0.0.1] - 25th March 2023
+
+Initial implementation of the base features of the auto_vpn_connect script:
+
+1. Connect/Disconnect and set up Auto-Connect to Pritunl VPNs.
+2. Save PINs, Tokens and auto fetch TOTPs using pyotp by providing the TOTP URL to minimise the effort to connect to VPNs, after a one-time setup.
+3. Set up customisable JSON VPN profiles and configs to customise where various CLIs and dependencies might be located
+4. Extensibility to add other VPN clients with ease.

README.md

@@ -10,7 +10,10 @@
 [![Language](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)
 [!["Buy Me A Coffee"](https://img.buymeacoffee.com/button-api/?text=Buy%20me%20an%20Ego%20boost&emoji=%F0%9F%98%B3&slug=dhi13man&button_colour=FF5F5F&font_colour=ffffff&font_family=Lato&outline_colour=000000&coffee_colour=FFDD00****)](https://www.buymeacoffee.com/dhi13man)
 
-A Python script that allows users to automatically connect to VPNs with minimal effort. As of now, only [Pritunl VPN Client](https://docs.pritunl.com/docs/command-line-interface) is supported.
+This is a Python script that allows users to automatically connect to VPNs with minimal effort. VPNs supported as of now:
+
+1. [Pritunl VPN Client](https://docs.pritunl.com/docs/command-line-interface)
+2. [Palo Alto Global Protect](https://docs.paloaltonetworks.com/globalprotect)
 
 ## Usage
 
@@ -24,7 +27,14 @@ A Python script that allows users to automatically connect to VPNs with minimal
     {
         "config": {
             "PRITUNL": {
+                "vpn_type": "PRITUNL",
                 "cli_path": "/Applications/Pritunl.app/Contents/Resources/pritunl-client"
+            },
+            "GLOBAL_PROTECT": {
+                "vpn_type": "GLOBAL_PROTECT",
+                "service_load_command": "launchctl load /Library/LaunchAgents/com.paloaltonetworks.gp.pangpa.plist",
+                "service_unload_command": "launchctl unload /Library/LaunchAgents/com.paloaltonetworks.gp.pangpa.plist",
+                "process_kill_command": "pkill -9 -f GlobalProtect"
             }
         },
         "vpn_list": [
@@ -44,6 +54,10 @@ A Python script that allows users to automatically connect to VPNs with minimal
                 "vpn_type": "PRITUNL", 
                 "pin": "<vpn_pin_3>",
                 "token": "<vpn_token>"
+            },
+            {
+                "vpn_id": "GlobalProtect",
+                "vpn_type": "GLOBAL_PROTECT"
             }
         ]
     }
@@ -161,7 +175,6 @@ cd <path_to_script>
 
 - [Python 3.10+](https://www.python.org/downloads/): Used for developing the script
 - [pyotp](https://pypi.org/project/pyotp/): Used for generating OTPs
-- [zope.interface](https://pypi.org/project/zope.interface/): Used for type hinting
 
 #### External Dependencies
 

__main__.py

@@ -8,7 +8,7 @@
 from time import sleep
 
 from src.models.user_switches import UserSwitches
-from src.models.vpn_data import abstract_vpn_data
+from src.models.vpn_model import abstract_vpn_model
 from src.services.vpn_parser_service import VpnDataParserService
 
 PROMPT: str = 'Run in Connect (c), Disconnect (d), or be in Always-Connected mode (w)'
@@ -57,7 +57,7 @@ def get_user_switches() -> UserSwitches:
         raise ValueError(f'Invalid action switch. {PROMPT}!')
 
     # List all VPNs
-    vpn_data_list: list[abstract_vpn_data.AbstractVpnData] = []
+    vpn_data_list: list[abstract_vpn_model.AbstractVpnModel] = []
     with open(user_switches.vpn_data_json_path, 'r', encoding='utf-8') as f:
         vpn_parser_service: VpnDataParserService = VpnDataParserService()
         vpn_data_list = vpn_parser_service.parse_vpn_data(f.read())