clear-skies-aws 2.0.3__py3-none-any.whl → 2.0.4__py3-none-any.whl

{clear_skies_aws-2.0.3.dist-info → clear_skies_aws-2.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clear-skies-aws
-Version: 2.0.3
+Version: 2.0.4
 Summary: clearskies bindings for working in AWS
 Project-URL: Repository, https://github.com/clearskies-py/clearskies-aws
 Project-URL: Issues, https://github.com/clearskies-py/clearskies-aws/issues
@@ -17,10 +17,12 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: <4.0,>=3.11
 Requires-Dist: boto3<2.0.0,>=1.26.148
 Requires-Dist: clear-skies<3.0.0,>=2.0.20
-Requires-Dist: types-boto3[dynamodb,sns,sqs]<2.0.0,>=1.38.13
+Requires-Dist: types-boto3[dynamodb,secretsmanager,ses,sns,sqs,ssm,stepfunctions]<2.0.0,>=1.38.13
 Provides-Extra: akeyless
 Requires-Dist: akeyless-cloud-id<0.5.0,>=0.2.3; extra == 'akeyless'
 Requires-Dist: akeyless<6.0.0,>=5.0.0; extra == 'akeyless'
+Provides-Extra: mysql
+Requires-Dist: pymysql<2.0.0,>=1.1.0; extra == 'mysql'
 Provides-Extra: ses
 Requires-Dist: jinja2<4.0.0,>=3.1.2; extra == 'ses'
 Description-Content-Type: text/markdown

{clear_skies_aws-2.0.3.dist-info → clear_skies_aws-2.0.4.dist-info}/RECORD

@@ -1,4 +1,4 @@
-clearskies_aws/__init__.py,sha256=-vmIX17AJIxy3-2CO4iXofUcgIUAckfHfdrkHtkya8g,368
+clearskies_aws/__init__.py,sha256=o83_Jk53zPtFz-zYfJVtbwfw2NdATRziR0tvRijnxVs,396
 clearskies_aws/actions/__init__.py,sha256=YsIi3ZTdByu4R7I77uOAXDE5hzB31J_tRrIoTxe_bjo,371
 clearskies_aws/actions/action_aws.py,sha256=JMogBFIrN72h5oBQLbyMy0LmfVLrqvWCYLQDml1qO4M,4674
 clearskies_aws/actions/assume_role.py,sha256=XNxbVju460aBMS8NQhY80eoNVQgZRJ6-OydsNOx3neA,4319
@@ -6,29 +6,33 @@ clearskies_aws/actions/ses.py,sha256=Cu8USID8vy2IZC6sFOIQRzv8a0LCMvYG15yn0l-fl5g
 clearskies_aws/actions/sns.py,sha256=YS1TbEwtU-0lDbjG2HyTBs2J-ML5OL3ModAiGTMeK-c,2205
 clearskies_aws/actions/sqs.py,sha256=r0z8njU87n09UgAq3l34JuNIbaBE85D_z8IE6ciIs9Q,3359
 clearskies_aws/actions/step_function.py,sha256=Y6tGbQJIAD_IwV9ohwYfuv3vqtryTwpFTNGUFgdj_DQ,2689
-clearskies_aws/backends/__init__.py,sha256=LgMNrf2yD9_PZBGbfs3yQGWM0NelSwk9GO73NfGwc44,587
+clearskies_aws/backends/__init__.py,sha256=lmjWPoLN7Ebmdj3Pv5X1tJDcRWN3PsR8aGG9nDcqOrs,635
 clearskies_aws/backends/backend.py,sha256=WpsoT0pZOdilvtOkbiNtk6DoOEzmjyWcCDfUCWOlToc,4316
-clearskies_aws/backends/dynamo_db_backend.py,sha256=cTlbSpMiJ-0YILeHRrMZ6u4blRl_76hmemZZO9BwNN4,29396
-clearskies_aws/backends/dynamo_db_condition_parser.py,sha256=OipIlFpcfS2GQiGpge6ZFX4NZNfNtHF87qi9g3yZgIU,12622
-clearskies_aws/backends/dynamo_db_parti_ql_backend.py,sha256=x1pLNTUsTjCxi1SDryr9_uhL-AQJS7ksP5bvQpnhaC8,46081
+clearskies_aws/backends/dynamo_db_backend.py,sha256=0KfAow5pUXpiBg0rRWtG3j48mpHUtJP9q-C2FfpBeqA,29411
+clearskies_aws/backends/dynamo_db_condition_parser.py,sha256=796BhrqqZy_lW4wVYbDKK85oVVKa0YnWbtl4Bb0RNF0,12637
+clearskies_aws/backends/dynamo_db_parti_ql_backend.py,sha256=p0SdrRq467w0w5OxYscxPfqUOjrkZ41JLmJa3KQCXq8,46097
 clearskies_aws/backends/sqs_backend.py,sha256=kHTzgBwpYzV31UcGaoSUcC_7eZEwm-GsCHvXFM1OLT0,2152
 clearskies_aws/configs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clearskies_aws/contexts/__init__.py,sha256=kBLUlkpIp88n5RgbE9gVi4rDnJou81vCE5g_aiv2v8Y,717
 clearskies_aws/contexts/cli_web_socket_mock.py,sha256=XjsFcx0YlQqjb9Hh8q2NUW7T2Exu7_FHx9v_Am0Uq0g,784
 clearskies_aws/contexts/lambda_alb.py,sha256=hNMWYePN_moC4waXdydAp7dJkGpSowxDZZzU39Sxc7I,3426
 clearskies_aws/contexts/lambda_api_gateway.py,sha256=HWH-CAX_aYiDhQr8rBhR5TW99-wx2ODsyI_dqGJkcdw,3354
-clearskies_aws/contexts/lambda_api_gateway_web_socket.py,sha256=gO0arcveIbvkCxrqjk8piVwcymuw_pgHwsSfdfElyWU,4583
-clearskies_aws/contexts/lambda_invoke.py,sha256=Ouns3zIw0G1aCuB0yVS91PgNqFVyqT3Oe6NcDgaEcvY,4872
+clearskies_aws/contexts/lambda_api_gateway_web_socket.py,sha256=0zrBF3ShxKcBoG9UFGENUrjYa9-F-f4iywYwa9Z6lc0,4583
+clearskies_aws/contexts/lambda_invoke.py,sha256=hvW05FtyiraAvhQiP5DX77LhYoRMgFTY4Tv6HhHH9C8,4872
 clearskies_aws/contexts/lambda_sns.py,sha256=_TyPqRWosfaJzreYGNabvR-XTLYYO4eVWMVINSIY-OE,4129
-clearskies_aws/contexts/lambda_sqs_standard.py,sha256=uzENeXJaWsZoUxves8IXo8wFrcub_viQSKF9fmmPPvE,5293
+clearskies_aws/contexts/lambda_sqs_standard.py,sha256=sekaPlCRvuHk-E8ohfFQkC2gAfO-DnTC7uLiIKfGY0E,5293
+clearskies_aws/cursors/__init__.py,sha256=vy-WYxNEy5nd9fqY0En3T6WhE3omoV1tE-A5Uz26cCk,94
+clearskies_aws/cursors/iam/__init__.py,sha256=-0uOKKzWZrlnCzUNITleKyT0rl3cqoLEbPtVrAF46hI,143
+clearskies_aws/cursors/iam/rds_mysql.py,sha256=PlJv8PebCFq08iv8OYPkSNd4dRTZFQbBrDFdb3brK_M,5656
+clearskies_aws/cursors/port_forwarding/__init__.py,sha256=LBcFYeIIfmGhxf3Ezn1KChOUdkpF5AjJL1xE_ak-x3s,78
 clearskies_aws/di/__init__.py,sha256=pLHSIKxS1oELOgttRuwM0yXdJRxjZKXQ6tPxme2db0U,222
-clearskies_aws/di/aws_additional_config_auto_import.py,sha256=qc9AUlFdF9jhAzS99esyvgY1MiW7mLz45fATK7Yp0rg,1271
+clearskies_aws/di/aws_additional_config_auto_import.py,sha256=94h_YsPBcdwMhqn0VAAfId1jLL5vCsk76kUrr-6ET_U,1275
 clearskies_aws/di/inject/__init__.py,sha256=5_x5_BBQwC6J4k5YLdTm1DfIDM-95zXz1L5a1nMrlrY,186
-clearskies_aws/di/inject/boto3.py,sha256=7qcn5N-RnUKiCd1U31JAjQHF6NDudS4KyBLT0krUD-Y,404
+clearskies_aws/di/inject/boto3.py,sha256=yUDiEpR2Si6pKcLrqMOlQEUU0pi6MS1tXNdoyC2mjwk,408
 clearskies_aws/di/inject/boto3_session.py,sha256=11UYHz5kgrrx5lawoYaOFBm-QIoa45YUCMAOn4gT8Jo,383
 clearskies_aws/di/inject/parameter_store.py,sha256=g0uAVwQEywLO9bCcYLbDKuyYnYgVyrfcYsOBJWYGads,475
 clearskies_aws/endpoints/__init__.py,sha256=OUL_nhtuNs62BvQeVtC9xP_e9Hs_-qjANvb81vdLdrc,61
-clearskies_aws/endpoints/secrets_manager_rotation.py,sha256=wLJjid_K09rXGEd_MIgoHP84im4_Eo2m_lwAxn36Jf8,7763
+clearskies_aws/endpoints/secrets_manager_rotation.py,sha256=c__4N-Z4qZ9XkzMMyIcxyPjOIxdO801FAJp6oX6n0a4,7761
 clearskies_aws/endpoints/simple_body_routing.py,sha256=B3fnfxUEMuNpzc26Pzly6618DFU9fpaCk8KhTGSaptE,1181
 clearskies_aws/input_outputs/__init__.py,sha256=RTDFwhPWZ2S0tZQiIPH0Tkj2xF-9qBjZte_CA2cmGt8,743
 clearskies_aws/input_outputs/cli_web_socket_mock.py,sha256=cp0MaJjVnsXE1rx5K44lpN9uHKo3MOAsNxVQ3AsJOi4,547
@@ -57,7 +61,7 @@ clearskies_aws/secrets/additional_configs/iam_db_auth.py,sha256=PwyiLaacpRfhBKzQ
 clearskies_aws/secrets/additional_configs/iam_db_auth_with_ssm.py,sha256=ABY29X-YvrE6vvNo6kVdf4DqyRNq5cFR5SfK7MNkltE,3463
 clearskies_aws/secrets/additional_configs/mysql_connection_dynamic_producer_via_ssh_cert_bastion.py,sha256=mLaplwvJLSbGh6oXgdOKL9Mv-6hLv5OUYCfEwHbHvLE,3700
 clearskies_aws/secrets/additional_configs/mysql_connection_dynamic_producer_via_ssm_bastion.py,sha256=2VHOwto4I9gBwrpd2HGpL-Wr0T2S-jFjUhe2Ib8hNJ8,6596
-clear_skies_aws-2.0.3.dist-info/METADATA,sha256=ZQj_x9m1wlgaf4SH_gu1AJiGiykQzDjdnBRLOgh9Q1Y,8973
-clear_skies_aws-2.0.3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-clear_skies_aws-2.0.3.dist-info/licenses/LICENSE,sha256=MkEX8JF8kZxdyBpTTcB0YTd-xZpWnHvbRlw-pQh8u58,1069
-clear_skies_aws-2.0.3.dist-info/RECORD,,
+clear_skies_aws-2.0.4.dist-info/METADATA,sha256=CMTqizz2HDuJdsyuFSsUpS1gcbfhEuFHDfA-ejsrWAE,9087
+clear_skies_aws-2.0.4.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+clear_skies_aws-2.0.4.dist-info/licenses/LICENSE,sha256=MkEX8JF8kZxdyBpTTcB0YTd-xZpWnHvbRlw-pQh8u58,1069
+clear_skies_aws-2.0.4.dist-info/RECORD,,

clearskies_aws/__init__.py

@@ -4,6 +4,7 @@ from clearskies_aws import (
     actions,
     backends,
     contexts,
+    cursors,
     di,
     endpoints,
     handlers,
@@ -17,6 +18,7 @@ __all__ = [
     "actions",
     "backends",
     "contexts",
+    "cursors",
     "di",
     "endpoints",
     "handlers",

clearskies_aws/backends/__init__.py

@@ -1,9 +1,9 @@
 from __future__ import annotations
 
 from clearskies_aws.backends.backend import Backend
-from clearskies_aws.backends.dynamo_db_backend import DynamoDBBackend
-from clearskies_aws.backends.dynamo_db_condition_parser import DynamoDBConditionParser
-from clearskies_aws.backends.dynamo_db_parti_ql_backend import (
+from clearskies_aws.backends.dynamo_db_backend import DynamoDBBackend  # type: ignore
+from clearskies_aws.backends.dynamo_db_condition_parser import DynamoDBConditionParser  # type: ignore
+from clearskies_aws.backends.dynamo_db_parti_ql_backend import (  # type: ignore
     DynamoDBPartiQLBackend,
     DynamoDBPartiQLCursor,
 )

clearskies_aws/backends/dynamo_db_backend.py

@@ -1,3 +1,4 @@
+# type: ignore
 from __future__ import annotations
 
 import base64

clearskies_aws/backends/dynamo_db_condition_parser.py

@@ -1,3 +1,4 @@
+# type: ignore
 from __future__ import annotations
 
 import base64

clearskies_aws/backends/dynamo_db_parti_ql_backend.py

@@ -1,3 +1,5 @@
+# type: ignore
+
 from __future__ import annotations
 
 import base64

clearskies_aws/contexts/lambda_api_gateway_web_socket.py

@@ -73,7 +73,7 @@ class LambdaApiGatewayWebSocket(Context):
 
     """
 
-    def __call__(
+    def __call__(  # type: ignore[override]
         self, event: dict[str, Any], context: dict[str, Any], url: str = "", request_method: str = ""
-    ) -> dict[str, Any]:  # type: ignore[override]
+    ) -> dict[str, Any]:
         return self.execute_application(LambdaApiGatewayWebSocketInputOutput(event, context, url))

clearskies_aws/contexts/lambda_invoke.py

@@ -125,9 +125,9 @@ class LambdaInvoke(Context):
 
     """
 
-    def __call__(
+    def __call__(  # type: ignore[override]
         self, event: dict[str, Any], context: dict[str, Any], request_method: str = "", url: str = ""
-    ) -> dict[str, Any]:  # type: ignore[override]
+    ) -> dict[str, Any]:
         return self.execute_application(
             LambdaInvokeInputOutput(
                 event,

clearskies_aws/contexts/lambda_sqs_standard.py

@@ -120,9 +120,9 @@ class LambdaSqsStandard(Context):
 
     """
 
-    def __call__(
+    def __call__(  # type: ignore[override]
         self, event: dict[str, Any], context: dict[str, Any], url: str = "", request_method: str = ""
-    ) -> dict[str, Any]:  # type: ignore[override]
+    ) -> dict[str, Any]:
         item_failures = []
         for record in event["Records"]:
             try:

clearskies_aws/cursors/__init__.py

@@ -0,0 +1,3 @@
+from clearskies_aws.cursors import iam, port_forwarding
+
+__all__ = ["iam", "port_forwarding"]

clearskies_aws/cursors/iam/__init__.py

@@ -0,0 +1,7 @@
+import logging
+
+from clearskies_aws.cursors.iam.rds_mysql import RdsMySql
+
+logging.getLogger(__name__)
+
+__all__ = ["RdsMySql", "MysqlWithSSM"]

clearskies_aws/cursors/iam/rds_mysql.py

@@ -0,0 +1,125 @@
+"""
+RdsMySql: MySQL cursor with AWS RDS IAM authentication.
+
+This class provides a MySQL cursor that uses AWS RDS IAM DB authentication.
+It loads connection parameters from environment variables and generates a temporary
+IAM authentication token for secure database access.
+
+Configuration fields:
+    - boto3: Injected boto3 provider for AWS API access.
+    - environment: Injected environment variable provider.
+    - hostname_environment_key: Environment variable for DB host (default: "DATABASE_HOST").
+    - username_environment_key: Environment variable for DB user (default: "DATABASE_USERNAME").
+    - database_environment_key: Environment variable for DB name (default: "DATABASE_NAME").
+    - port_environment_key: Environment variable for DB port (default: "DATABASE_PORT").
+    - cert_path_environment_key: Environment variable for SSL CA cert (default: "DATABASE_CERT_PATH").
+    - autocommit_environment_key: Environment variable for autocommit (default: "DATABASE_AUTOCOMMIT").
+    - connect_timeout_environment_key: Environment variable for connect timeout (default: "DATABASE_CONNECT_TIMEOUT").
+    - database_region_key: Environment variable for AWS region (default: "DATABASE_REGION").
+
+Example:
+    import clearskies_aws.cursors.iam.rds_mysql
+
+    cursor = clearskies_aws.cursors.iam.rds_mysql.RdsMySql()
+    cursor.execute("SELECT 1")
+"""
+
+import os
+from typing import Any
+
+import clearskies
+from clearskies import decorators
+from clearskies.cursors import Mysql as MysqlBase
+
+from clearskies_aws.di import inject
+
+
+class RdsMySql(MysqlBase):
+    """MySQL cursor with AWS RDS IAM DB authentication."""
+
+    """Injected boto3 provider for AWS API access."""
+    boto3 = inject.Boto3()
+
+    """Injected environment variable provider."""
+    environment = clearskies.di.inject.Environment()
+
+    """Environment variable for DB host (default: "DATABASE_HOST")."""
+    hostname_environment_key = clearskies.configs.String(default="DATABASE_HOST")
+
+    """Environment variable for DB user (default: "DATABASE_USERNAME")."""
+    username_environment_key = clearskies.configs.String(default="DATABASE_USERNAME")
+
+    """Environment variable for DB name (default: "DATABASE_NAME")."""
+    database_environment_key = clearskies.configs.String(default="DATABASE_NAME")
+
+    """Environment variable for DB port (default: "DATABASE_PORT")."""
+    port_environment_key = clearskies.configs.String(default="DATABASE_PORT")
+
+    """Environment variable for SSL CA cert (default: "DATABASE_CERT_PATH")."""
+    cert_path_environment_key = clearskies.configs.String(default="DATABASE_CERT_PATH")
+
+    """Environment variable for autocommit (default: "DATABASE_AUTOCOMMIT")."""
+    autocommit_environment_key = clearskies.configs.String(default="DATABASE_AUTOCOMMIT")
+
+    """Environment variable for connect timeout (default: "DATABASE_CONNECT_TIMEOUT")."""
+    connect_timeout_environment_key = clearskies.configs.String(default="DATABASE_CONNECT_TIMEOUT")
+
+    """Environment variable for AWS region (default: "DATABASE_REGION")."""
+    database_region_key = clearskies.configs.String(default="DATABASE_REGION")
+
+    @decorators.parameters_to_properties
+    def __init__(
+        self,
+        hostname_environment_key: str | None = None,
+        username_environment_key: str | None = None,
+        database_environment_key: str | None = None,
+        port_environment_key: str | None = None,
+        cert_path_environment_key: str | None = None,
+        autocommit_environment_key: str | None = None,
+        database_region_key: str | None = None,
+        connect_timeout_environment_key: str | None = None,
+        port_forwarding: Any | None = None,
+    ):
+        self.finalize_and_validate_configuration()
+
+    def build_connection_kwargs(self) -> dict:
+        """
+        Build the connection kwargs for the MySQL client, using IAM DB authentication.
+
+        Returns
+        -------
+        dict
+            Connection parameters for the MySQL client.
+        """
+        connection_kwargs = {
+            "user": self.environment.get(self.username_environment_key),
+            "host": self.environment.get(self.hostname_environment_key),
+            "database": self.environment.get(self.database_environment_key),
+            "port": int(self.environment.get(self.port_environment_key, silent=True) or self.port),
+            "ssl_ca": self.environment.get(self.cert_path_environment_key, silent=True),
+            "autocommit": self.environment.get(self.autocommit_environment_key, silent=True),
+            "connect_timeout": int(
+                self.environment.get(self.connect_timeout_environment_key, silent=True) or self.connect_timeout
+            ),
+        }
+        region: str = self.environment.get(self.database_region_key, True) or self.environment.get("AWS_REGION", True)
+        if not region:
+            raise ValueError(
+                "To use RDS IAM DB auth you must set DATABASE_REGION or AWS_REGION in the .env file or an environment variable"
+            )
+        os.environ["LIBMYSQL_ENABLE_CLEARTEXT_PLUGIN"] = "1"
+
+        rds_api = self.boto3.Session().client("rds")
+        rds_token = rds_api.generate_db_auth_token(
+            DBHostname=connection_kwargs.get("host"),
+            Port=connection_kwargs.get("port", 3306),
+            DBUsername=connection_kwargs.get("user"),
+            Region=region,
+        )
+        connection_kwargs["password"] = rds_token
+
+        for kwarg in ["autocommit", "connect_timeout", "port", "ssl_ca"]:
+            if not connection_kwargs[kwarg]:
+                del connection_kwargs[kwarg]
+
+        return {**super().build_connection_kwargs(), **connection_kwargs}

clearskies_aws/cursors/port_forwarding/__init__.py

@@ -0,0 +1,3 @@
+from clearskies_aws.cursors.port_forwarding.ssm import Ssm
+
+__all__ = ["Ssm"]

clearskies_aws/di/aws_additional_config_auto_import.py

@@ -17,7 +17,7 @@ class AwsAdditionalConfigAutoImport(AdditionalConfigAutoImport):
     This DI auto injects boto3, boto3 Session and the parameter store.
     """
 
-    def provide_boto3(self) -> ModuleType:
+    def provide_boto3_sdk(self) -> ModuleType:
         import boto3
 
         return boto3

clearskies_aws/di/inject/boto3.py

@@ -12,4 +12,4 @@ class Boto3(Injectable):
     def __get__(self, instance, parent) -> ModuleType:
         if instance is None:
             return self  # type: ignore
-        return self._di.build_from_name("boto3", cache=self.cache)
+        return self._di.build_from_name("boto3_sdk", cache=self.cache)

clearskies_aws/endpoints/secrets_manager_rotation.py

@@ -91,7 +91,7 @@ class SecretsManagerRotation(Endpoint):
             pending_secret_data = json.loads(pending_secret["SecretString"])
         except botocore.exceptions.ClientError as error:
             if error.response["Error"]["Code"] == "ResourceNotFoundException":
-                pending_secret_data = None
+                pending_secret_data = {}
             else:
                 raise error