Merge pull request #173 from lykinsbd/fix_proxies

Resolve #172, Enable HTTP Proxy Support for `iControlRESTTokenAuth` Object

Author: f5-rahm

.gitignore

@@ -6,6 +6,10 @@
 .idea/*
 *.py[cod]
 
+### Additional virtual environment files
+bin/
+pyvenv.cfg
+
 ### added with RM's Makefile
 localutils/**
 agent/f5/bigip/pycontrol/wsdl/**

icontrol/authtoken.py

@@ -55,6 +55,8 @@ class iControlRESTTokenAuth(AuthBase):
     BigIP should consult when creating the token.
     :param str verify: The path to a CA bundle containing the \
     CA certificate for SSL validation
+    :param proxies: A dict of proxy information for Requests to utilize \
+    on this connection to the BigIP
 
     If ``username`` is configured locally on the BigIP,
     ``login_provider_name`` should be ``"tmos"`` (default).  Otherwise
@@ -63,10 +65,11 @@ class iControlRESTTokenAuth(AuthBase):
     of ``login_provider_name``.
     """
     def __init__(self, username, password, login_provider_name='tmos',
-                 verify=False, auth_provider=None):
+                 verify=False, auth_provider=None, proxies=None):
         self.username = username
         self.password = password
         self.login_provider_name = login_provider_name
+        self.proxies = proxies
         self.token = None
         self.expiration = None
         self.attempts = 0
@@ -95,7 +98,7 @@ def get_auth_providers(self, netloc):
         """
         url = "https://%s/info/system?null" % (netloc)
 
-        response = requests.get(url, verify=self.verify)
+        response = requests.get(url, verify=self.verify, proxies=self.proxies)
         if not response.ok or not hasattr(response, "json"):
             error_message = '%s Unexpected Error: %s for uri: %s\nText: %r' %\
                             (response.status_code,
@@ -147,7 +150,8 @@ def get_new_token(self, netloc):
             login_url,
             json=login_body,
             verify=self.verify,
-            auth=HTTPBasicAuth(self.username, self.password)
+            auth=HTTPBasicAuth(self.username, self.password),
+            proxies=self.proxies,
         )
         self.attempts += 1
         if not response.ok or not hasattr(response, "json"):

icontrol/session.py

@@ -428,22 +428,22 @@ def __init__(self, username, password, **kwargs):
 
         # Handle token-based auth.
         if token_to_use:
-            self.session.auth = iControlRESTTokenAuth('admin', 'admin')
+            self.session.auth = iControlRESTTokenAuth('admin', 'admin', proxies=proxies)
             self.session.auth.token = token_to_use
         else:
             if auth_provider:
                 self.session.auth = iControlRESTTokenAuth(
-                    username, password, auth_provider=auth_provider, verify=verify
+                    username, password, auth_provider=auth_provider, verify=verify, proxies=proxies
                 )
             else:
                 if token_auth is True:
                     self.session.auth = iControlRESTTokenAuth(
-                        username, password, verify=verify
+                        username, password, verify=verify, proxies=proxies
                     )
                 elif token_auth:
                     # Truthy but not true: non-default loginAuthProvider
                     self.session.auth = iControlRESTTokenAuth(
-                        username, password, token_auth, verify=verify
+                        username, password, token_auth, verify=verify, proxies=proxies
                     )
                 else:
                     self.session.auth = (username, password)