Added in employee auth to consolidate repos

Author: allmightyspiff

SoftLayer/API.py

@@ -180,16 +180,7 @@ def employee_client(username=None,
     :param bool verify: decide to verify the server's SSL/TLS cert. DO NOT SET
                         TO FALSE WITHOUT UNDERSTANDING THE IMPLICATIONS.
 
-    Usage:
-
-        >>> import SoftLayer
-        >>> client = SoftLayer.create_client_from_env()
-        >>> resp = client.call('Account', 'getObject')
-        >>> resp['companyName']
-        'Your Company'
-
     """
-    # SSL verification is OFF because internal api uses a self signed cert
     settings = config.get_client_settings(username=username,
                                           api_key=None,
                                           endpoint_url=endpoint_url,
@@ -198,14 +189,12 @@ def employee_client(username=None,
                                           verify=verify,
                                           config_file=config_file)
 
-    url = settings.get('endpoint_url') or consts.API_EMPLOYEE_ENDPOINT
+    url = settings.get('endpoint_url')
 
     if 'internal' not in url:
-        raise exceptions.SoftLayerError("{} does not look like an Internal Employee url. Try {}".format(
-                                         url, consts.API_EMPLOYEE_ENDPOINT))
+        raise exceptions.SoftLayerError(f"{url} does not look like an Internal Employee url.")
 
     if transport is None:
-        
         if url is not None and '/rest' in url:
             # If this looks like a rest endpoint, use the rest transport
             transport = transports.RestTransport(
@@ -241,7 +230,6 @@ def employee_client(username=None,
         return EmployeeClient(auth=None, transport=transport)
 
 
-
 def Client(**kwargs):
     """Get a SoftLayer API Client using environmental settings."""
     return create_client_from_env(**kwargs)
@@ -251,8 +239,7 @@ class BaseClient(object):
     """Base SoftLayer API client.
 
     :param auth: auth driver that looks like SoftLayer.auth.AuthenticationBase
-    :param transport: An object that's callable with this signature:
-                      transport(SoftLayer.transports.Request)
+    :param transport: An object that's callable with this signature: transport(SoftLayer.transports.Request)
     """
 
     _prefix = "SoftLayer_"
@@ -288,9 +275,7 @@ def __init__(self, auth=None, transport=None, config_file=None):
 
         self.transport = transport
 
-    def authenticate_with_password(self, username, password,
-                                   security_question_id=None,
-                                   security_question_answer=None):
+    def authenticate_with_password(self, username, password, security_question_id=None, security_question_answer=None):
         """Performs Username/Password Authentication
 
         :param string username: your SoftLayer username
@@ -353,8 +338,7 @@ def call(self, service, method, *args, **kwargs):
 
         invalid_kwargs = set(kwargs.keys()) - VALID_CALL_ARGS
         if invalid_kwargs:
-            raise TypeError(
-                'Invalid keyword arguments: %s' % ','.join(invalid_kwargs))
+            raise TypeError('Invalid keyword arguments: %s' % ','.join(invalid_kwargs))
 
         prefixes = (self._prefix, 'BluePages_Search', 'IntegratedOfferingTeam_Region')
         if self._prefix and not service.startswith(prefixes):

SoftLayer/CLI/core.py

@@ -73,35 +73,28 @@ def get_version_message(ctx, param, value):
              epilog="""Run 'islcli login' to authenticate""",
              cls=CommandLoader,
              context_settings=CONTEXT_SETTINGS)
-@click.option('--format',
-              default=DEFAULT_FORMAT,
-              show_default=True,
+@click.option('--format', default=DEFAULT_FORMAT, show_default=True,
               help="Output format",
               type=click.Choice(VALID_FORMATS))
-@click.option('-C', '--config',
-              required=False,
+@click.option('-C', '--config', required=False, show_default=True,
               default=click.get_app_dir('softlayer', force_posix=True),
-              show_default=True,
               help="Config file location",
               type=click.Path(resolve_path=True))
 @click.option('--verbose', '-v',
               help="Sets the debug noise level, specify multiple times for more verbosity.",
               type=click.IntRange(0, 3, clamp=True),
               count=True)
-@click.option('--proxy',
-              required=False,
+@click.option('--proxy', required=False,
               help="HTTPS or HTTP proxy to be use to make API calls")
-@click.option('--really / --not-really', '-y',
-              is_flag=True,
-              required=False,
+@click.option('--really / --not-really', '-y', is_flag=True, required=False,
               help="Confirm all prompt actions")
-@click.option('--demo / --no-demo',
-              is_flag=True,
-              required=False,
+@click.option('--demo / --no-demo', is_flag=True, required=False,
               help="Use demo data instead of actually making API calls")
 @click.option('--version', is_flag=True, expose_value=False, is_eager=True, callback=get_version_message,
               help="Show version information.",  allow_from_autoenv=False,)
-@click.option('--account', '-a', help="Account Id")
+@click.option('--account', '-a', help="Account Id, only needed for some API calls.")
+@click.option('--internal', '-i', is_flag=True, required=False,
+              help="Use the Employee Client instead of the Customer Client.")
 @environment.pass_env
 def cli(env,
         format='table',
@@ -111,6 +104,7 @@ def cli(env,
         really=False,
         demo=False,
         account=None,
+        internal=False,
         **kwargs):
     """Main click CLI entry-point."""
 
@@ -119,7 +113,10 @@ def cli(env,
     env.config_file = config
     env.format = format
     env.set_env_theme(config_file=config)
-    env.ensure_client(config_file=config, is_demo=demo, proxy=proxy)
+    if internal:
+        env.ensure_emp_client(config_file=config, is_demo=demo, proxy=proxy)
+    else:
+        env.ensure_client(config_file=config, is_demo=demo, proxy=proxy)
     env.vars['_start'] = time.time()
     logger = logging.getLogger()
 
@@ -134,7 +131,6 @@ def cli(env,
     env.vars['_timings'] = SoftLayer.DebugTransport(env.client.transport)
     env.vars['verbose'] = verbose
     env.client.transport = env.vars['_timings']
-    print("Account ID is now: {}".format(account))
     env.client.account_id = account
 
 

SoftLayer/CLI/environment.py

@@ -183,16 +183,26 @@ def ensure_client(self, config_file=None, is_demo=False, proxy=None):
 
         # Environment can be passed in explicitly. This is used for testing
         if is_demo:
-            client = SoftLayer.BaseClient(
-                transport=SoftLayer.FixtureTransport(),
-                auth=None,
-            )
+            client = SoftLayer.BaseClient(transport=SoftLayer.FixtureTransport(), auth=None)
         else:
             # Create SL Client
-            client = SoftLayer.employee_client(
-                proxy=proxy,
-                config_file=config_file,
-            )
+            client = SoftLayer.create_client_from_env(proxy=proxy, config_file=config_file)
+        self.client = client
+
+    def ensure_emp_client(self, config_file=None, is_demo=False, proxy=None):
+        """Create a new SLAPI client to the environment.
+
+        This will be a no-op if there is already a client in this environment.
+        """
+        if self.client is not None:
+            return
+
+        # Environment can be passed in explicitly. This is used for testing
+        if is_demo:
+            client = SoftLayer.BaseClient(transport=SoftLayer.FixtureTransport(), auth=None)
+        else:
+            # Create SL Client
+            client = SoftLayer.employee_client(proxy=proxy, config_file=config_file)
         self.client = client
 
     def set_env_theme(self, config_file=None):

SoftLayer/CLI/login.py

@@ -12,10 +12,6 @@
 from SoftLayer.CLI import environment
 
 
-# def get_username(env):
-#     """Gets the username from config or env"""
-#     settings = 
-
 def censor_password(value):
     if value:
         value = '*' * len(value)

SoftLayer/consts.py

@@ -10,6 +10,5 @@
 API_PRIVATE_ENDPOINT = 'https://api.service.softlayer.com/xmlrpc/v3.1/'
 API_PUBLIC_ENDPOINT_REST = 'https://api.softlayer.com/rest/v3.1/'
 API_PRIVATE_ENDPOINT_REST = 'https://api.service.softlayer.com/rest/v3.1/'
-API_EMPLOYEE_ENDPOINT = 'https://internal.applb.dal10.softlayer.local/v3/internal/xmlrpc/'
 USER_AGENT = "softlayer-python/%s" % VERSION
 CONFIG_FILE = "~/.softlayer"

SoftLayer/transports/transport.py

@@ -99,9 +99,12 @@ def __repr__(self):
         """Prints out what this call is all about"""
         pretty_mask = utils.clean_string(self.mask)
         pretty_filter = self.filter
-        param_string = "id={id}, mask='{mask}', filter='{filter}', args={args}, limit={limit}, offset={offset}".format(
-            id=self.identifier, mask=pretty_mask, filter=pretty_filter,
-            args=self.args, limit=self.limit, offset=self.offset)
+        clean_args = self.args
+        # Passwords can show up here, so censor them before logging.
+        if self.method in ["performExternalAuthentication", "refreshEncryptedToken", "getPortalLoginToken"]:
+            clean_args = "*************"
+        param_string = (f"id={self.identifier}, mask='{pretty_mask}', filter='{pretty_filter}', args={clean_args}, "
+                        f"limit={self.limit}, offset={self.offset}")
         return "{service}::{method}({params})".format(
             service=self.service, method=self.method, params=param_string)