feat: Support for Base64 String Private key (#341)

This pull request includes significant updates to the Meltano
configuration and enhancements to the Snowflake connector. The changes
improve configuration management and add new functionality for handling
private keys.

### Meltano Configuration Updates:

* Added `default_environment` and `environments` to specify deployment
environments. (`meltano.yml`:
[meltano.ymlL3-R114](diffhunk://#diff-6d0acc7374df2a40ec960634f967ae63128eac507abd089a68b8787e9433ddf2L3-R114))
* Updated `target-snowflake` loader settings to include new validation
groups and reorganized settings for better readability. (`meltano.yml`:
[meltano.ymlL3-R114](diffhunk://#diff-6d0acc7374df2a40ec960634f967ae63128eac507abd089a68b8787e9433ddf2L3-R114))

### Snowflake Connector Enhancements:

* Added imports for `base64`, `binascii`, and `warn` to handle private
key formats and deprecations. (`target_snowflake/connector.py`:
[target_snowflake/connector.pyR3-R10](diffhunk://#diff-9d2a86f3e673ca747a3f08bc77045ce73dbe3ead0713d3292a622091e7060cc8R3-R10))
* Introduced `SingerSDKDeprecationWarning` to warn users about using
private key pem formats. (`target_snowflake/connector.py`:
[target_snowflake/connector.pyR19](diffhunk://#diff-9d2a86f3e673ca747a3f08bc77045ce73dbe3ead0713d3292a622091e7060cc8R19))
* Enhanced `get_private_key` method to support both PEM and base64
encoded private keys, with appropriate logging and error handling.
(`target_snowflake/connector.py`:
[target_snowflake/connector.pyL131-R151](diffhunk://#diff-9d2a86f3e673ca747a3f08bc77045ce73dbe3ead0713d3292a622091e7060cc8L131-R151))

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Edgar Ramírez Mondragón <[email protected]>

Author: 3 people

meltano.yml

@@ -1,102 +1,114 @@
 version: 1
 send_anonymous_usage_stats: true
-project_id: "target-snowflake"
+project_id: target-snowflake
+default_environment: dev
+environments:
+- name: dev
 plugins:
-  extractors: []
   loaders:
-  - name: "target-snowflake"
-    namespace: "target_snowflake"
+  - name: target-snowflake
+    namespace: target_snowflake
     pip_url: -e .
     capabilities:
     - about
     - schema-flattening
     - stream-maps
-    config:
-      start_date: '2010-01-01T00:00:00Z'
+    settings_group_validation:
+    - - account
+      - database
+      - password
+      - user
+    - - account
+      - database
+      - private_key_path
+      - user
+    - - account
+      - database
+      - private_key
+      - user
+    - - account
+      - database
+      - use_browser_authentication
+      - user
     settings:
-    - description: Your account identifier. See [Account Identifiers](https://docs.snowflake.com/en/user-guide/admin-account-identifier.html).
+    - name: account
       kind: string
       label: Account
-      name: account
-    - description: Whether to add metadata columns.
+      description: Your account identifier. See [Account
+        Identifiers](https://docs.snowflake.com/en/user-guide/admin-account-identifier.html).
+    - name: add_record_metadata
       kind: boolean
-      label: Add Record Metadata
-      name: add_record_metadata
       value: true
-    - description: Whether to remove batch files after processing.
+      label: Add Record Metadata
+      description: Whether to add metadata columns.
+    - name: clean_up_batch_files
       kind: boolean
-      label: Clean Up Batch Files
-      name: clean_up_batch_files
       value: true
-    - description: The initial database for the Snowflake session.
+      label: Clean Up Batch Files
+      description: Whether to remove batch files after processing.
+    - name: database
       kind: string
       label: Database
-      name: database
-    - description: The default target database schema name to use for all streams.
+      description: The initial database for the Snowflake session.
+    - name: default_target_schema
       kind: string
       label: Default Target Schema
-      name: default_target_schema
-    - description: "'True' to enable schema flattening and automatically expand nested\
-        \ properties."
+      description: The default target database schema name to use for all streams.
+    - name: flattening_enabled
       kind: boolean
       label: Flattening Enabled
-      name: flattening_enabled
-    - description: The max depth to flatten schemas.
+      description: "'True' to enable schema flattening and automatically expand nested
+        properties."
+    - name: flattening_max_depth
       kind: integer
       label: Flattening Max Depth
-      name: flattening_max_depth
-    - description: The password for your Snowflake user.
-      kind: password
+      description: The max depth to flatten schemas.
+    - name: password
+      kind: string
       label: Password
-      name: password
-    - description: Path to file containing private key
+      description: The password for your Snowflake user.
+      sensitive: true
+    - name: private_key_path
       kind: string
       label: Private Key Path
-      name: private_key_path
-    - description: Passphrase to decrypt private key if encrypted
+      description: Path to file containing private key
+    - name: private_key
+      kind: string
+      label: Private Key
+      description: The private key for your Snowflake user.
+    - name: private_key_passphrase
+      kind: string
       label: Private Key Passphrase
-      kind: password
-      name: private_key_passphrase
-    - description: The initial role for the session.
+      description: Passphrase to decrypt private key if encrypted
+      sensitive: true
+    - name: role
       kind: string
       label: Role
-      name: role
-    - description: The initial schema for the Snowflake session.
+      description: The initial role for the session.
+    - name: schema
       kind: string
       label: Schema
-      name: schema
-    - description: User-defined config values to be used within map expressions.
+      description: The initial schema for the Snowflake session.
+    - name: stream_map_config
       kind: object
       label: Stream Map Config
-      name: stream_map_config
-    - description: Config object for stream maps capability. For more information check
-        out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html).
+      description: User-defined config values to be used within map expressions.
+    - name: stream_maps
       kind: object
       label: Stream Maps
-      name: stream_maps
-    - description: If browser based SSO authentication should be used. See [SSO browser authentication](https://docs.snowflake.com/en/developer-guide/node-js/nodejs-driver-authenticate#using-single-sign-on-sso-through-a-web-browser).
+      description: Config object for stream maps capability. For more information
+        check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html).
+    - name: use_browser_authentication
       kind: boolean
-      label: Use browser authentication
-      name: use_browser_authentication
       value: false
-    - description: The login name for your Snowflake user.
+      label: Use browser authentication
+      description: If browser based SSO authentication should be used. See [SSO browser
+        authentication](https://docs.snowflake.com/en/developer-guide/node-js/nodejs-driver-authenticate#using-single-sign-on-sso-through-a-web-browser).
+    - name: user
       kind: string
       label: User
-      name: user
-    - description: The initial warehouse for the session.
+      description: The login name for your Snowflake user.
+    - name: warehouse
       kind: string
       label: Warehouse
-      name: warehouse
-    settings_group_validation:
-    - - account
-      - database
-      - password
-      - user
-    - - account
-      - database
-      - private_key_path
-      - user
-    - - account
-      - database
-      - use_browser_authentication
-      - user
+      description: The initial warehouse for the session.

target_snowflake/connector.py

@@ -1,10 +1,13 @@
 from __future__ import annotations
 
+import base64
+import binascii
 import urllib.parse
 from enum import Enum
 from functools import cached_property
 from pathlib import Path
 from typing import TYPE_CHECKING, Any
+from warnings import warn
 
 import snowflake.sqlalchemy.custom_types as sct
 import sqlalchemy
@@ -128,8 +131,23 @@ def get_private_key(self):
             with key_path.open("rb") as key_file:
                 key_content = key_file.read()
         else:
-            key_content = self.config["private_key"].encode()
-
+            private_key = self.config["private_key"]
+            self.logger.debug("Reading private key from config")
+            if "-----BEGIN " in private_key:
+                warn(
+                    "Use base64 encoded private key instead of PEM format",
+                    DeprecationWarning,
+                    stacklevel=2,
+                )
+                self.logger.info("Private key is in PEM format")
+                key_content = private_key.encode()
+            else:
+                try:
+                    self.logger.debug("Private key is in base64 format")
+                    key_content = base64.b64decode(private_key)
+                except binascii.Error as e:
+                    error_message = f"Invalid private key format: {e}"
+                    raise ValueError(error_message) from e
         p_key = serialization.load_pem_private_key(
             key_content,
             password=encoded_passphrase,