Merge pull request #14 from DenisaCG/credentialsCLI

Credentials extraction from specified path or from AWS CLI

Author: DenisaCG

README.md

@@ -19,6 +19,38 @@ To install the extension, execute:
 pip install jupyter_drives
 ```
 
+## Configure Credentials
+
+To begin using the extension and gain access to your drives, you need to configure your user credentials generated by the provider (e.g.: `access_key`, `secret-access-key` and if applicable `session_token`).
+
+For those working with `S3` drives using the `AWS` CLI, the credentials will be automatically extracted from `~/.aws/credentials`. There is nothing that needs to be done on your side.
+
+> Note: This is only applicable for Linux or macOS `AWS` [CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html) users. In case you are using the `AWS` CLI from Windows, you can use the custom file path configuration with `C:\Users\USERNAME\.aws\credentials`. You can read more about this [here](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html).
+
+### Configuration file
+
+Otherwise, you can add your credentials to the server configuration file. Create a `jupyter_notebook_config.py` file in one of the
+[Jupyter config directories](https://jupyter.readthedocs.io/en/latest/use/jupyter-directories.html#id1),
+for example: `~/.jupyter/jupyter_notebook_config.py`, and specify your long-term or short-term credentials.
+
+```python
+c = get_config()
+
+c.DrivesConfig.access_key_id = "<AWS Access Key ID / IAM Access Key ID>"
+c.DrivesConfig.secret_access_key = "<AWS Secret Access Key / IAM Secret>"
+c.DrivesConfig.session_token = "<AWS Session Token / IAM Session Token>"
+```
+
+### Custom credentials file path
+
+You can also just specify the location of a local file which contains your credentials. The `acccess_key`, `secret_access_key` and if applicable the `session_token` will be automatically extracted from there.
+
+```python
+c = get_config()
+
+c.DrivesConfig.custom_credentials_path = "path/to/file/containing/credentials"
+```
+
 ## Uninstall
 
 To remove the extension, execute:

jupyter_drives/base.py

@@ -1,3 +1,5 @@
+import os
+from sys import platform
 import entrypoints
 from traitlets import Enum, Unicode, default
 from traitlets.config import Configurable
@@ -45,6 +47,13 @@ class DrivesConfig(Configurable):
         help="Base URL of the provider service REST API.",
     )
 
+    custom_credentials_path = Unicode(
+        None,
+        config = True,
+        allow_none = True,
+        help="Custom path of file where credentials are located. Extension automatically checks jupyter_notebook_config.py or directly in ~/.aws/credentials for AWS CLI users."
+    )
+
     @default("api_base_url")
     def set_default_api_base_url(self):
         # for AWS S3 drives
@@ -60,4 +69,41 @@ def set_default_api_base_url(self):
         default_value="s3",
         config=True,
         help="The source control provider.",
-    )
+    )
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self._load_credentials()
+    
+    def _load_credentials(self):
+        # check if credentials were already set in jupyter_notebook_config.py
+        if self.access_key_id is not None and self.secret_access_key is not None:
+            return
+
+        # check if user provided custom path for credentials extraction
+        if self.custom_credentials_path is not None:
+            self.access_key_id, self.secret_access_key, self.session_token = self._extract_credentials_from_file(self.custom_credentials_path)
+            return
+        
+        # if not, try to load credentials from AWS CLI
+        aws_credentials_path = "~/.aws/credentials" #add read me about credentials path in windows: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html
+        if os.path_exists(aws_credentials_path):
+            self.access_key_id, self.secret_access_key, self.session_token = self._extract_credentials_from_file(aws_credentials_path)
+            return
+        
+    def _extract_credentials_from_file(self, file_path):
+        try:
+            with open(file_path, 'r') as file:
+                access_key_id, secret_access_key, session_token = None, None, None
+                lines = file.readlines()
+                for line in lines:
+                    if line.startswith("aws_access_key_id ="):
+                        access_key_id = line.split("=")[1].strip()
+                    elif line.startswith("aws_secret_access_key ="):
+                        secret_access_key = line.split("=")[1].strip()
+                    elif line.startswith("session_token ="):
+                        session_token = line.split("=")[1].strip()
+                return access_key_id, secret_access_key, session_token
+        except Exception as e:
+            print(f"Failed loading credentials from {file_path}: {e}")
+        return

jupyter_drives/managers/s3.py

@@ -85,15 +85,28 @@ async def mount_drive(self, drive_name):
             S3ContentsManager
         '''
         try :
-            s3_contents_manager = S3ContentsManager(
-                access_key = self._config.access_key_id,
-                secret_access_key = self._config.secret_access_key,
-                endpoint_url = self._config.api_base_url,
-                bucket = drive_name
-            )
-
             # checking if the drive wasn't mounted already
             if self.s3_content_managers[drive_name] is None:
+
+                # dealing with long-term credentials (access key, secret key)
+                if self._config.session_token is None:
+                    s3_contents_manager = S3ContentsManager(
+                    access_key = self._config.access_key_id,
+                    secret_access_key = self._config.secret_access_key,
+                    endpoint_url = self._config.api_base_url,
+                    bucket = drive_name
+                    )
+                
+                # dealing with short-term credentials (access key, secret key, session token)
+                else:
+                    s3_contents_manager = S3ContentsManager(
+                    access_key = self._config.access_key_id,
+                    secret_access_key = self._config.secret_access_key,
+                    session_token = self._config.session_token,
+                    endpoint_url = self._config.api_base_url,
+                    bucket = drive_name
+                    )
+                
                 self.s3_content_managers[drive_name] = s3_contents_manager
 
                 response = {