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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clear-skies-aws
-Version: 2.0.4
+Version: 2.0.5
 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
@@ -22,7 +22,7 @@ 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'
+Requires-Dist: clear-skies[mysql]; 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.4.dist-info → clear_skies_aws-2.0.5.dist-info}/RECORD

@@ -22,9 +22,10 @@ clearskies_aws/contexts/lambda_invoke.py,sha256=hvW05FtyiraAvhQiP5DX77LhYoRMgFTY
 clearskies_aws/contexts/lambda_sns.py,sha256=_TyPqRWosfaJzreYGNabvR-XTLYYO4eVWMVINSIY-OE,4129
 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/iam/__init__.py,sha256=dY410gfPoMXB42jhmamqD5IiCeopDnxr5wIibpqaYcY,127
+clearskies_aws/cursors/iam/rds_mysql.py,sha256=bdAYTLg9t8DsoSi0otY9bmIgLCbrezczxd_3hWuEkeE,5639
 clearskies_aws/cursors/port_forwarding/__init__.py,sha256=LBcFYeIIfmGhxf3Ezn1KChOUdkpF5AjJL1xE_ak-x3s,78
+clearskies_aws/cursors/port_forwarding/ssm.py,sha256=RJXU6meeX9GNSbcxTGf6c9LcI4I0_wvYHnS_DzRSEXM,4498
 clearskies_aws/di/__init__.py,sha256=pLHSIKxS1oELOgttRuwM0yXdJRxjZKXQ6tPxme2db0U,222
 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
@@ -61,7 +62,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.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,,
+clear_skies_aws-2.0.5.dist-info/METADATA,sha256=CXZjCcG1-cVFBHHXsXu0Sn3u3Bf5gMpmfGzaPh_OLPc,9084
+clear_skies_aws-2.0.5.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+clear_skies_aws-2.0.5.dist-info/licenses/LICENSE,sha256=MkEX8JF8kZxdyBpTTcB0YTd-xZpWnHvbRlw-pQh8u58,1069
+clear_skies_aws-2.0.5.dist-info/RECORD,,

clearskies_aws/cursors/iam/__init__.py

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

clearskies_aws/cursors/iam/rds_mysql.py

@@ -29,12 +29,12 @@ from typing import Any
 
 import clearskies
 from clearskies import decorators
-from clearskies.cursors import Mysql as MysqlBase
+from clearskies.cursors import Mysql
 
 from clearskies_aws.di import inject
 
 
-class RdsMySql(MysqlBase):
+class RdsMysql(Mysql):
     """MySQL cursor with AWS RDS IAM DB authentication."""
 
     """Injected boto3 provider for AWS API access."""

clearskies_aws/cursors/port_forwarding/ssm.py

@@ -0,0 +1,137 @@
+import time
+
+import clearskies.configs
+from clearskies import decorators
+from clearskies.cursors.port_forwarding.port_forwarder import PortForwarder
+
+from clearskies_aws.di import inject
+
+
+class Ssm(PortForwarder):
+    """
+    Port forwarder using AWS SSM Session Manager.
+
+    This class sets up a local port forwarding tunnel to a remote host using AWS SSM.
+    If instance_id is not provided, it will search for a running instance by Name tag.
+    """
+
+    """
+    The EC2 instance ID to connect to. If not provided, instance_name will be used to look up the instance.
+    """
+    instance_id = clearskies.configs.String(default=None)
+
+    """
+    The Name tag of the EC2 instance to search for if instance_id is not provided.
+    """
+    instance_name = clearskies.configs.String(default=None)
+
+    """
+    The remote port to forward to.
+    """
+    remote_port = clearskies.configs.Integer()
+
+    """
+    The local port to bind for the forwarding tunnel (default: 0, auto-selects a free port).
+    """
+    local_port = clearskies.configs.Integer(default=0)
+
+    """
+    AWS region.
+    """
+    region = clearskies.configs.String(default=None)
+
+    """
+    AWS CLI profile.
+    """
+    profile = clearskies.configs.String(default=None)
+
+    """
+    Boto3 session or client provider
+    """
+    boto3 = inject.Boto3()
+
+    @decorators.parameters_to_properties
+    def __init__(
+        self,
+        instance_id=None,
+        instance_name=None,
+        remote_port=None,
+        local_port=0,
+        region=None,
+        profile=None,
+    ):
+        self._proc = None
+        self.finalize_and_validate_configuration()
+
+    def setup(self, original_host: str, original_port: int) -> tuple[str, int]:
+        """
+        Establish the port forwarding tunnel and return the local endpoint.
+
+        If instance_id is not set, searches for a running instance by Name tag.
+
+        Returns:
+            A tuple containing the local host and local port to connect to (e.g., ("localhost", 12345)).
+        """
+        # Resolve instance_id if needed
+        if not self.instance_id and self.instance_name:
+            ec2_api = self.boto3.client("ec2", region_name=self.region)
+            running_instances = ec2_api.describe_instances(
+                Filters=[
+                    {"Name": "tag:Name", "Values": [self.instance_name]},
+                    {"Name": "instance-state-name", "Values": ["running"]},
+                ]
+            )
+            instance_ids = []
+            for reservation in running_instances["Reservations"]:
+                for instance in reservation["Instances"]:
+                    instance_ids.append(instance["InstanceId"])
+            if len(instance_ids) == 0:
+                raise ValueError("Failed to launch SSM tunnel! Cannot find bastion!")
+            self.instance_id = instance_ids.pop()
+
+        if self.local_port == 0:
+            self.local_port = self.pick_free_port("127.0.0.1")
+
+        if self.is_port_open("127.0.0.1", self.local_port):
+            return "127.0.0.1", self.local_port
+
+        ssm_cmd = [
+            "aws",
+            "ssm",
+            "start-session",
+            "--target",
+            self.instance_id,
+            "--document-name",
+            "AWS-StartPortForwardingSession",
+            "--parameters",
+            f"portNumber={self.remote_port},localPort={self.local_port}",
+        ]
+        if self.region:
+            ssm_cmd += ["--region", self.region]
+        if self.profile:
+            ssm_cmd += ["--profile", self.profile]
+
+        self._proc = self.subprocess.Popen(ssm_cmd, stdout=self.subprocess.PIPE, stderr=self.subprocess.PIPE)
+
+        start = time.time()
+        while True:
+            try:
+                test_sock = self.socket.socket(self.socket.AF_INET, self.socket.SOCK_STREAM)
+                test_sock.settimeout(0.2)
+                test_sock.connect(("127.0.0.1", self.local_port))
+                test_sock.close()
+                break
+            except Exception:
+                if self._proc is not None and self._proc.poll() is not None:
+                    raise RuntimeError("SSM process exited unexpectedly")
+                if time.time() - start > 10:
+                    raise TimeoutError(f"Timeout waiting for port {self.local_port} to open")
+                time.sleep(0.1)
+
+        return "127.0.0.1", self.local_port
+
+    def teardown(self):
+        if self._proc:
+            self._proc.terminate()
+            self._proc.wait()
+            self._proc = None