feat(grz-common): Add proxy options to config (#335)

Co-authored-by: maga-imi <matthias.ganzinger@med.uni-heidelberg.de>

Author: Travis Wrightsman

packages/grz-common/src/grz_common/models/s3.py

@@ -5,6 +5,23 @@
 from .base import IgnoringBaseModel, IgnoringBaseSettings
 
 
+class ProxyOptions(IgnoringBaseModel):
+    proxy_ca_bundle: str | None = None
+    """
+    The path to a custom certificate bundle to use when establishing SSL/TLS connections with proxy (optional).
+    """
+
+    proxy_client_cert: str | None = None
+    """
+    The path to a certificate for proxy TLS client authentication  (optional).
+    """
+
+    proxy_use_forwarding_for_https: bool = False
+    """
+    For HTTPS proxies, forward your requests to HTTPS destinations with an absolute URI. We strongly recommend you only use this option with trusted or corporate proxies.
+    """
+
+
 class S3Options(IgnoringBaseModel):
     endpoint_url: AnyHttpUrl
     """
@@ -53,6 +70,9 @@ class S3Options(IgnoringBaseModel):
     The proxy URL for S3 operations (optional).
     """
 
+    proxy_config: ProxyOptions | None = None
+    """Proxy configuration for S3 operations."""
+
     request_checksum_calculation: Literal["when_supported", "when_required"] | None = None
     """
     Whether to calculate checksums for S3 request payloads (optional).

packages/grz-common/src/grz_common/transfer.py

@@ -6,7 +6,7 @@
 
 import boto3
 from boto3 import client as boto3_client  # type: ignore[import-untyped]
-from botocore.config import Config as Boto3Config  # type: ignore[import-untyped]
+from botocore.config import Config as Boto3Config
 
 if TYPE_CHECKING:
     from types_boto3_s3 import S3Client
@@ -31,8 +31,10 @@ def init_s3_client(s3_options: S3Options) -> S3Client:
     """Create a boto3 Client from a grz-cli configuration."""
     # configure proxies if proxy_url is defined
     proxy_url = s3_options.proxy_url
+    proxies_config = s3_options.proxy_config.model_dump(exclude_none=True) if s3_options.proxy_config else None
     s3_config = Boto3Config(
         proxies={"http": str(proxy_url), "https": str(proxy_url)} if proxy_url is not None else None,
+        proxies_config=proxies_config,  # type: ignore
         request_checksum_calculation=s3_options.request_checksum_calculation,
     )
 
@@ -55,8 +57,10 @@ def init_s3_client(s3_options: S3Options) -> S3Client:
 def init_s3_resource(s3_options: S3Options) -> S3ServiceResource:
     """Create a boto3 Resource from a grz-cli configuration."""
     proxy_url = s3_options.proxy_url
+    proxies_config = s3_options.proxy_config.model_dump(exclude_none=True) if s3_options.proxy_config else None
     s3_config = Boto3Config(
         proxies={"http": str(proxy_url), "https": str(proxy_url)} if proxy_url is not None else None,
+        proxies_config=proxies_config,  # type: ignore
         request_checksum_calculation=s3_options.request_checksum_calculation,
     )
     s3_resource = boto3.resource(