qBitTorrent automatic update port

PIAWireguard.json

@@ -10,5 +10,9 @@
     "piaDipToken": "",
     "piaPortForward": false,
     "piaUseDip": false,
-    "tunnelGateway": null
-}
+    "tunnelGateway": null,
+    "qbtUpdate": false,
+    "qbtURL": "",
+    "qbtUsername": "",
+    "qbtPassword": ""
+}

PIAWireguard.py

@@ -61,7 +61,10 @@
     "piaDipToken",
     "piaPortForward",
     "piaUseDip",
-    "tunnelGateway"
+    "tunnelGateway",
+    "qbtUpdate",
+    "qbtUsername",
+    "qbtPassword"
 ]
 
 # Check config contains the right settings
@@ -212,6 +215,26 @@ def printDebug(text):
     print("piaUseDip can only be true or false")
     sys.exit(0)
 
+if config['qbtUpdate'] == True and config['piaPortForward'] != True:
+    print("If you wish to use qbtUpdate, please also enable piaPortForward in the json file")
+    sys.exit(0)
+
+if config['qbtUpdate'] != True and config['qbtUpdate'] != False:
+    print("qbtUpdate can only be true or false")
+    sys.exit(0)
+
+if config['qbtUpdate'] == True and config['qbtURL'] == '':
+    print("If you wish to use qbtUpdate, please define qbtURL variable in the json file")
+    sys.exit(0)
+
+if config['qbtUpdate'] == True and config['qbtUsername'] == '':
+    print("If you wish to use qbtUpdate, please define qbtUsername variable in the json file")
+    sys.exit(0)
+
+if config['qbtUpdate'] == True and config['qbtPassword'] == '':
+    print("If you wish to use qbtUpdate, please define qbtPassword variable in the json file")
+    sys.exit(0)
+
 opnsenseURL = config['opnsenseURL']
 
 # List current wireguard instances looking for PIA one
@@ -853,6 +876,62 @@ def printDebug(text):
     print("reconfigure request failed non 200 status code - apply alias changes")
     sys.exit(2)
 
+#
+# qBitTorrent update section
+# Port forwarding must also be enabled and working
+#
+
+# Exit if qbtUpdate isn't enabled otherwise continue
+if config['qbtUpdate'] is False:
+    sys.exit(0)
+
+# Login to qBitTorrent server
+login = {
+    'username': config['qbtUsername'],
+    'password': config['qbtPassword']
+}
+
+referer = {
+    'Referer': config['qbtURL']
+}
+
+r = requests.post(f"{config['qbtURL']}/api/v2/auth/login", data= login, headers= referer)
+
+# Check for errors.
+if r.status_code != 200 and r.status_code != 403:
+    print("qbtUpdate login request failed on invalid status code, verify qbtURL")
+    sys.exit(2)
+
+if r.status_code == 403:
+    print("qbtUpdate login request failed, too many unsuccessful login attempts")
+    sys.exit(2)
+
+if r.content[slice(-1)] != b'Ok':
+    print("qbtUpdate login request failed, verify qbtUsername and qbtPassword")
+    sys.exit(2)
+
+# Store authentication cookie data
+cookie = {
+    'SID': r.cookies['SID']
+}
+
+# Check current qBitTorrent listen port
+r = requests.get(f"{config['qbtURL']}/api/v2/app/preferences", cookies= cookie)
+qbtPort = json.loads(r.content)['listen_port']
+print(f"qbtUpdate current listen_port is {qbtPort}")
+if qbtPort == wireguardSignature['port']:
+    print("qbtUpdate listen_port change not required")
+    sys.exit(0)
+
+# Set new qBitTorrent listen port
+newPort = {
+    'listen_port': wireguardSignature['port']
+}
+
+r = requests.post(f"{config['qbtURL']}/api/v2/app/setPreferences", cookies= cookie, data= {"json": json.dumps(newPort)}, headers= referer)
+if r.status_code == 200:
+    print(f"qbtUpdate listen_port changed successfully to {wireguardSignature['port']}")
+
 #
 # Script finished
 #

README.md

@@ -114,6 +114,11 @@ To accommodate this functionality, this is built in to the script. You will need
 
 You'll find your gateway names in "System: Gateways: Single", making sure its the IPv4 one.
 
+***qBitTorrent automatic port update***
+
+This feature can log into any qBitTorrent client that has the webUI enabled and is accessible from OPNsense and change the listen port to the one set by the `piaPortForward` feature. To use qBitTorrent port updating change `qbtUpdate` variable in the json file from `false` to `true`. You must also set the values for `qbtURL` (example: `"http://192.168.1.7:8080"`), `qbtUsername`, and `qbtPassword`. 
+**Note:** `piaPortForward` must also be set to `true`. 
+
 ***WireGuard kernel module***
 
 Since OPNsense 21.1.4, they now support the install the new kernel module implementation of WireGuard, its early days for the module and should be considered experimental.