feat: add API token authentication support for qBittorrent v5.2.0+

Author: hongcankun

autoremovetorrents/client/deluge.py

@@ -24,7 +24,7 @@ def __init__(self, host):
         self._last_refresh = 0
 
     # Login to Deluge
-    def login(self, username, password):
+    def login(self, username, password, api_token=None):
         # Split IP(or domain name) and port
         splits = self._host.split(':')
         host = splits[0] if len(splits) > 0 else ''

autoremovetorrents/client/qbittorrent.py

@@ -36,7 +36,9 @@ def client_version(self):
             return self._session.get(self._host+'/version/qbittorrent')
 
         # Login
-        def login(self, username, password):
+        def login(self, username, password, api_token=None):
+            if api_token:
+                raise IncompatibleAPIVersion('API token authentication is only supported on qBittorrent v5.2.0+ with WebAPI v2.14.1+ (API v2)')
             return self._session.post(self._host+'/login', data={'username':username, 'password':password})
 
         # Get server state
@@ -89,8 +91,15 @@ def client_version(self):
             return self._session.get(self._host+'/api/v2/app/version')
 
         # Login
-        def login(self, username, password):
-            return self._session.post(self._host+'/api/v2/auth/login', data={'username':username, 'password':password})
+        def login(self, username, password, api_token=None):
+            if api_token:
+                self._session.headers.update({
+                    'Authorization': f'Bearer {api_token}'
+                })
+                # Verify the token works by calling a simple API endpoint
+                return self.server_state()
+            else:
+                return self._session.post(self._host+'/api/v2/auth/login', data={'username':username, 'password':password})
 
         # Get server state
         def server_state(self):
@@ -136,15 +145,17 @@ def __init__(self, host):
             raise IncompatibleAPIVersion('Incompatible qbittorrent client. The current API version may be unsupported.')
 
     # Login to qBittorrent
-    def login(self, username, password):
+    def login(self, username, password, api_token=None):
         try:
-            request = self._request_handler.login(username, password)
+            request = self._request_handler.login(username, password, api_token)
         except Exception as exc:
             raise ConnectionFailure(str(exc))
 
         if request.status_code == 200:
-            if request.text == 'Fails.': # Fail
-                raise LoginFailure(request.text)
+            # Check if this is a response from the login endpoint (plain text) or from server_state() (JSON)
+            if not api_token:  # Only check "Fails." for username/password login
+                if request.text == 'Fails.':
+                    raise LoginFailure(request.text)
         else:
             raise LoginFailure('The server returned HTTP %d.' % request.status_code)
 

autoremovetorrents/client/transmission.py

@@ -22,7 +22,7 @@ def __init__(self, host):
         self._session = requests.Session()
 
     # Login to Transmission
-    def login(self, username, password):
+    def login(self, username, password, api_token=None):
         # Save authentication of session
         self._session.auth = (username, password)
 

autoremovetorrents/client/utorrent.py

@@ -26,7 +26,7 @@ def __init__(self, host):
         self._refresh_time = 0
 
     # Login to uTorrent
-    def login(self, username, password):
+    def login(self, username, password, api_token=None):
         # HTTP Authorization
         self._session.auth = (username, password)
         # Requests Token

autoremovetorrents/task.py

@@ -21,7 +21,7 @@ def __init__(self, name, conf, remove_torrents = True):
 
         # Replace environment variables first
         pattern = re.compile(r'\$\(([^\)]+)\)')
-        replace_keys = ['host', 'username', 'password']
+        replace_keys = ['host', 'username', 'password', 'api_token']
         for key in replace_keys:
             if key in conf:
                 env = pattern.match(str(conf[key]))
@@ -34,6 +34,7 @@ def __init__(self, name, conf, remove_torrents = True):
         self._host = conf['host'].rstrip('/')
         self._username = conf['username'] if 'username' in conf else ''
         self._password = conf['password'] if 'password' in conf else ''
+        self._api_token = conf['api_token'] if 'api_token' in conf else ''
         self._enabled_remove = remove_torrents
         self._delete_data = conf['delete_data'] if 'delete_data' in conf else False
         self._strategies = conf['strategies'] if 'strategies' in conf else []
@@ -55,8 +56,8 @@ def __init__(self, name, conf, remove_torrents = True):
 
         # Print debug logs
         self._logger.debug("Configuration of task '%s':" % self._name)
-        self._logger.debug('Client: %s, Host: %s, Username: %s, Password: %s' % (
-            self._client_name, self._host, self._username, self._password
+        self._logger.debug('Client: %s, Host: %s, Username: %s, Password: %s, API Token: %s' % (
+            self._client_name, self._host, self._username, self._password, self._api_token
         ))
         self._logger.debug('Remove Torrents: %s, Remove Torrents and Data: %s' % (
             self._enabled_remove, self._delete_data
@@ -83,7 +84,7 @@ def _login(self):
 
         # Login
         self._logger.info('Logging in...')
-        self._client.login(self._username, self._password)
+        self._client.login(self._username, self._password, self._api_token)
         self._logger.info('Login successfully. The client is %s.' % self._client.version())
         self._logger.info('WebUI API version: %s' % self._client.api_version())
 

docs/config.rst

@@ -67,8 +67,9 @@ For qBittorrent/Transmission/μTorrent, this program works with your client's We
 
 * ``client``: Your client name. It's case-insensitive.
 * ``host``: The URL of your client's WebUI, and the URL must have a scheme (http:// or https://).
-* ``username``: The username of the WebUI.
-* ``password``: The password of the WebUI.
+* ``username``: The username of the WebUI (optional for qBittorrent if using API token).
+* ``password``: The password of the WebUI (optional for qBittorrent if using API token).
+* ``api_token``: The API key for qBittorrent v5.2.0+ with WebAPI v2.14.1+ (optional, if provided, username/password can be omitted).
 
 For Deluge
 +++++++++++