boto3-refresh-session 1.3.5__py3-none-any.whl → 1.3.7__py3-none-any.whl

boto3_refresh_session/__init__.py

@@ -3,5 +3,5 @@ from .session import RefreshableSession
 from .sts import STSRefreshableSession
 
 __all__ = ["RefreshableSession"]
-__version__ = "1.3.5"
+__version__ = "1.3.7"
 __author__ = "Mike Letts"

boto3_refresh_session/custom.py

@@ -4,6 +4,7 @@ __all__ = ["CustomRefreshableSession"]
 
 from typing import Any, Callable
 
+from .exceptions import BRSError
 from .session import BaseRefreshableSession
 
 
@@ -50,7 +51,7 @@ class CustomRefreshableSession(BaseRefreshableSession, method="custom"):
     >>> sess = RefreshableSession(
     >>>     method='custom',
     >>>     custom_credentials_method=your_custom_credential_getter,
-    >>>     custom_credentials_methods_args=...,
+    >>>     custom_credentials_method_args=...,
     >>> )
     """
 
@@ -77,11 +78,20 @@ class CustomRefreshableSession(BaseRefreshableSession, method="custom"):
         )
 
     def _get_credentials(self) -> dict[str, str]:
-        return self._custom_get_credentials(
+        credentials = self._custom_get_credentials(
             **self._custom_get_credentials_args
         )
+        required_keys = {"access_key", "secret_key", "token", "expiry_time"}
 
-    def get_identity(self):
+        if missing := required_keys - credentials.keys():
+            raise BRSError(
+                f"The dict returned by custom_credentials_method is missing these key-value pairs: "
+                f"{', '.join(repr(param) for param in missing)}. "
+            )
+
+        return credentials
+
+    def get_identity(self) -> dict[str, str]:
         """Returns metadata about the custom credential getter.
 
         Returns
@@ -90,7 +100,9 @@ class CustomRefreshableSession(BaseRefreshableSession, method="custom"):
             Dict containing information about the custom credential getter.
         """
 
-        return {
-            "method": "custom",
-            "source": repr(self._custom_get_credentials.__name__),
-        }
+        source = getattr(
+            self._custom_get_credentials,
+            "__name__",
+            repr(self._custom_get_credentials),
+        )
+        return {"method": "custom", "source": repr(source)}

{boto3_refresh_session-1.3.5.dist-info → boto3_refresh_session-1.3.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: boto3-refresh-session
-Version: 1.3.5
+Version: 1.3.7
 Summary: A simple Python package for refreshing the temporary security credentials in a boto3.session.Session object automatically.
 License: MIT
 Keywords: boto3,botocore,aws
@@ -106,27 +106,27 @@ A testimonial from a Cyber Security Engineer at a FAANG company:
 pip install boto3-refresh-session
 ```
 
-## Usage
+## Usage (STS)
 
 ```python
 import boto3_refresh_session as brs
 
-# you can pass all of the params associated with boto3.session.Session
-profile_name = '<your-profile-name>'
-region_name = 'us-east-1'
+# you can pass all of the params normally associated with boto3.session.Session
+profile_name = "<your-profile-name>"
+region_name = "us-east-1"
 ...
 
 # as well as all of the params associated with STS.Client.assume_role
 assume_role_kwargs = {
-  'RoleArn': '<your-role-arn>',
-  'RoleSessionName': '<your-role-session-name>',
-  'DurationSeconds': '<your-selection>',
+  "RoleArn": "<your-role-arn>",
+  "RoleSessionName": "<your-role-session-name>",
+  "DurationSeconds": "<your-selection>",
   ...
 }
 
 # as well as all of the params associated with STS.Client, except for 'service_name'
 sts_client_kwargs = {
-  'region_name': region_name,
+  "region_name": region_name,
   ...
 }
 
@@ -138,9 +138,41 @@ session = brs.RefreshableSession(
   profile_name=profile_name,
   ...
 )
+```
+
+## Usage (ECS)
+
+```python
+session = RefreshableSession(
+  method="ecs", 
+  region_name=region_name, 
+  profile_name=profile_name,
+  ...
+)
+```
+
+## Usage (Custom)
 
-# now you can create clients, resources, etc. without worrying about expired temporary 
-# security credentials
-s3 = session.client(service_name='s3')
-buckets = s3.list_buckets()
+If you have a highly sophisticated, novel, or idiosyncratic authentication flow not included in boto3-refresh-session then you will need to provide your own custom temporary credentials method. `RefreshableSession` accepts custom credentials methods, as shown below.
+
+```python
+# create (or import) your custom credential method
+def your_custom_credential_getter(...):
+    ...
+    return {
+        "access_key": ...,
+        "secret_key": ...,
+        "token": ...,
+        "expiry_time": ...,
+    }
+
+# and pass it to RefreshableSession
+session = RefreshableSession(
+    method="custom",
+    custom_credentials_method=your_custom_credential_getter,
+    custom_credentials_method_args=...,
+    region_name=region_name,
+    profile_name=profile_name,
+    ...
+)
 ```

boto3_refresh_session-1.3.7.dist-info/RECORD

@@ -0,0 +1,11 @@
+boto3_refresh_session/__init__.py,sha256=Uv136RK6A7H9vQ1nzXPCuIrJBbKZmH8DQaznDFduILU,200
+boto3_refresh_session/custom.py,sha256=0EemEoai-CnixXpFyvjmE5M9QffgBRZpMoTIwQPaxmY,3744
+boto3_refresh_session/ecs.py,sha256=WIC5mlbcEnM1oo-QXmmtiw2mjFDn01hBfcFh67ku42A,3713
+boto3_refresh_session/exceptions.py,sha256=qcFzdIuK5PZirs77H_Kb64S9QFb6cn2OJtirjvaRLiY,972
+boto3_refresh_session/session.py,sha256=ak8lvgoHMObaJgL4c80ih4bptRHS3ASojnaWdbxn5kA,5246
+boto3_refresh_session/sts.py,sha256=paIgbmn9a3cATNX-6AEGxnSGNZnX1pj4rRQmh8gQSKs,3132
+boto3_refresh_session-1.3.7.dist-info/LICENSE,sha256=I3ZYTXAjbIly6bm6J-TvFTuuHwTKws4h89QaY5c5HiY,1067
+boto3_refresh_session-1.3.7.dist-info/METADATA,sha256=ORil-xBwlFnv7oaFgiVN8XKglY9HM0A9jF_2j7LDmxY,7033
+boto3_refresh_session-1.3.7.dist-info/NOTICE,sha256=1s8r33qbl1z0YvPB942iWgvbkP94P_e8AnROr1qXXuw,939
+boto3_refresh_session-1.3.7.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+boto3_refresh_session-1.3.7.dist-info/RECORD,,

boto3_refresh_session-1.3.5.dist-info/RECORD

@@ -1,11 +0,0 @@
-boto3_refresh_session/__init__.py,sha256=D0r3Nr19lp_qzLeinuCSE-7G9iq2hBj-_hMgLlktRvw,200
-boto3_refresh_session/custom.py,sha256=ZnN94A69Eku9L-kHZ7JJxn_aWbrt6mJDWOIEWrJrIcY,3229
-boto3_refresh_session/ecs.py,sha256=WIC5mlbcEnM1oo-QXmmtiw2mjFDn01hBfcFh67ku42A,3713
-boto3_refresh_session/exceptions.py,sha256=qcFzdIuK5PZirs77H_Kb64S9QFb6cn2OJtirjvaRLiY,972
-boto3_refresh_session/session.py,sha256=ak8lvgoHMObaJgL4c80ih4bptRHS3ASojnaWdbxn5kA,5246
-boto3_refresh_session/sts.py,sha256=paIgbmn9a3cATNX-6AEGxnSGNZnX1pj4rRQmh8gQSKs,3132
-boto3_refresh_session-1.3.5.dist-info/LICENSE,sha256=I3ZYTXAjbIly6bm6J-TvFTuuHwTKws4h89QaY5c5HiY,1067
-boto3_refresh_session-1.3.5.dist-info/METADATA,sha256=mJKnoAJ7RJklmP_zOF7g801DkEw1H-7vNWaRpqVnt64,6271
-boto3_refresh_session-1.3.5.dist-info/NOTICE,sha256=1s8r33qbl1z0YvPB942iWgvbkP94P_e8AnROr1qXXuw,939
-boto3_refresh_session-1.3.5.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-boto3_refresh_session-1.3.5.dist-info/RECORD,,