Merge pull request #67 from 2ndWatch/update-cli-auth

Add cli auth and adjust user api token handling

Author: twarnock

README.md

@@ -52,7 +52,7 @@ cloudendure api login
 or
 
 ```sh
-export CLOUDENDURE_TOKEN=<your_ce_api_token>
+export CLOUDENDURE_USER_API_TOKEN=<your_ce_user_api_token>
 export CLOUDENDURE_DESTINATION_ACCOUNT=<destination_aws_account_id>
 
 ce api login
@@ -69,7 +69,7 @@ cloudendure api login --user=<your_ce_user> --password=<your_ce_password>
 or
 
 ```sh
-ce api login --token=<your_ce_token>
+ce api login --token=<your_ce_user_api_token>
 ```
 
 Logging in for the first time will generate the `~/.cloudendure.yml` file.

cloudendure/api.py

@@ -47,7 +47,7 @@ class CloudEndureAPI:
 
     TOP_LEVEL: List[str] = ["projects", "blueprints"]
 
-    def __init__(self, *args, **kwargs) -> None:
+    def __init__(self, config: CloudEndureConfig, *args, **kwargs) -> None:
         """Initialize the CloudEndure API client.
 
         Attributes:
@@ -57,7 +57,7 @@ def __init__(self, *args, **kwargs) -> None:
         time_now: datetime.datetime = datetime.datetime.utcnow()
 
         self.api_endpoint: str = f"{HOST}/api/{API_VERSION}"
-        self.config: CloudEndureConfig = CloudEndureConfig()
+        self.config: CloudEndureConfig = config
 
         self.projects: List[str] = []
         self.session: Session = requests.Session()
@@ -75,27 +75,44 @@ def __init__(self, *args, **kwargs) -> None:
         if _xsrf_token:
             self.session.headers.update({"X-XSRF-TOKEN": _xsrf_token})
 
-    def login(self, username: str = "", password: str = "") -> bool:
+    def login(self, username: str = "", password: str = "", token: str = "") -> bool:
         """Login to the CloudEndure API console.
 
         Args:
             username (str): The CloudEndure username to be used.
                 Defaults to the environment specific default.
             password (str): The CloudEndure password to be used.
                 Defaults to the environment specific default.
+            token (str): The CloudEndure token to be used. This argument takes precedence.
+                If provided, username and password will not be used.
+                Defaults to the environment specific default.
 
         Attributes:
             endpoint (str): The CloudEndure API endpoint to be used.
             _username (str): The CloudEndure API username.
             _password (str): The CloudEndure API password.
+            _token (str): The CloudEndure API token.
             _auth (dict): The CloudEndure API username/password dictionary map.
             response (requests.Response): The CloudEndure API login request response object.
             _xsrf_token (str): The XSRF token to be used for subsequent API requests.
 
+        TODO:
+            * Verify default XSRF-Token TTL and check validity before performing
+                subsequent authentication requests.
+
         """
         _username: str = self.config.active_config["username"] or username
         _password: str = self.config.active_config["password"] or password
-        _auth: Dict[str, str] = {"username": _username, "password": _password}
+        _token: str = self.config.active_config["user_api_token"] or token
+        _auth: Dict[str, str] = {}
+
+        if _token:
+            _auth["userApiToken"] = _token
+        elif _username and _password:
+            _auth = {"username": _username, "password": _password}
+        else:
+            print("You must configure your authentication credentials!")
+            return False
 
         # Attempt to login to the CloudEndure API via a POST request.
         response: requests.Response = self.api_call(

cloudendure/cloudendure.py

@@ -29,14 +29,23 @@
 class CloudEndure:
     """Define the CloudEndure general object."""
 
-    def __init__(self, project_name: str = "", dry_run: bool = False) -> None:
+    def __init__(
+        self,
+        project_name: str = "",
+        dry_run: bool = False,
+        username: str = "",
+        password: str = "",
+        token: str = "",
+    ) -> None:
         """Initialize the CloudEndure object.
 
         This entrypoint is primarily for use with the CLI.
 
         """
-        self.config: CloudEndureConfig = CloudEndureConfig()
-        self.api: CloudEndureAPI = CloudEndureAPI()
+        self.config: CloudEndureConfig = CloudEndureConfig(
+            username=username, password=password, token=token
+        )
+        self.api: CloudEndureAPI = CloudEndureAPI(self.config)
         self.is_authenticated = self.api.login()
 
         # Determine the active project ID.

cloudendure/config.py

@@ -17,7 +17,9 @@
 class CloudEndureConfig:
     """Define the CloudEndure Config object."""
 
-    def __init__(self, *args, **kwargs) -> None:
+    def __init__(
+        self, username: str = "", password: str = "", token: str = "", *args, **kwargs
+    ) -> None:
         """Initialize the Environment."""
         logger.info("Initializing the CloudEndure Configuration")
         _config_path: str = os.environ.get(
@@ -26,6 +28,9 @@ def __init__(self, *args, **kwargs) -> None:
         if _config_path.startswith("~"):
             self.config_path = os.path.expanduser(_config_path)
 
+        # Handle CloudEndure CLI input credentials.
+        self.cli = {"username": username, "password": password, "user_api_token": token}
+
         _config: PosixPath = Path(self.config_path)
         if not _config.exists():
             print(
@@ -40,6 +45,7 @@ def __init__(self, *args, **kwargs) -> None:
                     "username": "",
                     "password": "",
                     "token": "",
+                    "user_api_token": "",
                     "session_cookie": "",
                     "project_name": "",
                     "project_id": "",
@@ -112,7 +118,11 @@ def update_config(self) -> None:
         """Update the configuration."""
         self.yaml_config_contents: Dict[str, Any] = self.read_yaml_config()
         self.env_config = self.get_env_vars()
-        self.active_config = {**self.yaml_config_contents, **self.env_config}
+        self.active_config = {
+            **self.yaml_config_contents,
+            **self.env_config,
+            **self.cli,
+        }
 
     def update_token(self, token: str) -> bool:
         """Update the CloudEndure token.