Skip to content

Commit

Permalink
feat: Allow feast snowflake to read in byte string for private-key au…
Browse files Browse the repository at this point in the history
…thentication (feast-dev#4384)

* allow feast snowflake to read in byte string for private-key authentication

Signed-off-by: Artur <artur.kolakowski@medely.com>

* Update type hint for  to use Union instead of | syntax

Signed-off-by: Artur <artur.kolakowski@medely.com>

* Update type hint for private_key to use Union instead of | syntax

Signed-off-by: Artur <artur.kolakowski@medely.com>

* Update type hint in parse_private_key_path

Signed-off-by: Artur <artur.kolakowski@medely.com>

* added private_key_content in Snowflake configs to support key-pair auth by reading in byte string

Signed-off-by: Artur <artur.kolakowski@medely.com>

* fix incompatible linting types

Signed-off-by: Artur <artur.kolakowski@medely.com>

* remove unused Union import

Signed-off-by: Artur <artur.kolakowski@medely.com>

* fix formating

Signed-off-by: Artur <artur.kolakowski@medely.com>

---------

Signed-off-by: Artur <artur.kolakowski@medely.com>
Co-authored-by: Artur <artur.kolakowski@medely.com>
  • Loading branch information
2 people authored and shuchu committed Aug 14, 2024
1 parent 74528cf commit 6c8235b
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 5 deletions.
3 changes: 3 additions & 0 deletions sdk/python/feast/infra/materialization/snowflake_engine.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,9 @@ class SnowflakeMaterializationEngineConfig(FeastConfigBaseModel):
private_key: Optional[str] = None
""" Snowflake private key file path"""

private_key_content: Optional[bytes] = None
""" Snowflake private key stored as bytes"""

private_key_passphrase: Optional[str] = None
""" Snowflake private key file passphrase"""

Expand Down
3 changes: 3 additions & 0 deletions sdk/python/feast/infra/offline_stores/snowflake.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,9 @@ class SnowflakeOfflineStoreConfig(FeastConfigBaseModel):
private_key: Optional[str] = None
""" Snowflake private key file path"""

private_key_content: Optional[bytes] = None
""" Snowflake private key stored as bytes"""

private_key_passphrase: Optional[str] = None
""" Snowflake private key file passphrase"""

Expand Down
3 changes: 3 additions & 0 deletions sdk/python/feast/infra/online_stores/snowflake.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ class SnowflakeOnlineStoreConfig(FeastConfigBaseModel):
private_key: Optional[str] = None
""" Snowflake private key file path"""

private_key_content: Optional[bytes] = None
""" Snowflake private key stored as bytes"""

private_key_passphrase: Optional[str] = None
""" Snowflake private key file passphrase"""

Expand Down
3 changes: 3 additions & 0 deletions sdk/python/feast/infra/registry/snowflake.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,9 @@ class SnowflakeRegistryConfig(RegistryConfig):
private_key: Optional[str] = None
""" Snowflake private key file path"""

private_key_content: Optional[bytes] = None
""" Snowflake private key stored as bytes"""

private_key_passphrase: Optional[str] = None
""" Snowflake private key file passphrase"""

Expand Down
26 changes: 21 additions & 5 deletions sdk/python/feast/infra/utils/snowflake/snowflake_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,11 @@ def __enter__(self):

# https://docs.snowflake.com/en/user-guide/python-connector-example.html#using-key-pair-authentication-key-pair-rotation
# https://docs.snowflake.com/en/user-guide/key-pair-auth.html#configuring-key-pair-authentication
if "private_key" in kwargs:
if "private_key" in kwargs or "private_key_content" in kwargs:
kwargs["private_key"] = parse_private_key_path(
kwargs["private_key"], kwargs["private_key_passphrase"]
kwargs.get("private_key_passphrase"),
kwargs.get("private_key"),
kwargs.get("private_key_content"),
)

try:
Expand Down Expand Up @@ -510,13 +512,27 @@ def chunk_helper(lst: pd.DataFrame, n: int) -> Iterator[Tuple[int, pd.DataFrame]
yield int(i / n), lst[i : i + n]


def parse_private_key_path(key_path: str, private_key_passphrase: str) -> bytes:
with open(key_path, "rb") as key:
def parse_private_key_path(
private_key_passphrase: str,
key_path: Optional[str] = None,
private_key_content: Optional[bytes] = None,
) -> bytes:
"""Returns snowflake pkb by parsing and reading either from key path or private_key_content as byte string."""
if private_key_content:
p_key = serialization.load_pem_private_key(
key.read(),
private_key_content,
password=private_key_passphrase.encode(),
backend=default_backend(),
)
elif key_path:
with open(key_path, "rb") as key:
p_key = serialization.load_pem_private_key(
key.read(),
password=private_key_passphrase.encode(),
backend=default_backend(),
)
else:
raise ValueError("Please provide key_path or private_key_content.")

pkb = p_key.private_bytes(
encoding=serialization.Encoding.DER,
Expand Down

0 comments on commit 6c8235b

Please sign in to comment.