datamasque-python 1.1.4__tar.gz → 1.1.5__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/HISTORY.rst +10 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/PKG-INFO +6 -1
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/README.rst +5 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/base.py +3 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/exceptions.py +16 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/models/connection.py +9 -4
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/models/dm_instance.py +13 -0
- datamasque_python-1.1.5/datamasque/client/spcs.py +179 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/docs/client.rst +8 -0
- datamasque_python-1.1.5/docs/usage.rst +49 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/pyproject.toml +1 -1
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/tests/test_connections.py +30 -0
- datamasque_python-1.1.5/tests/test_spcs.py +157 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/uv.lock +1 -1
- datamasque_python-1.1.4/docs/usage.rst +0 -21
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/.editorconfig +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/.github/workflows/ci.yml +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/.github/workflows/release-testpypi.yml +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/.github/workflows/release.yml +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/.gitignore +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/.readthedocs.yaml +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/CONTRIBUTING.rst +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/LICENSE +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/MANIFEST.in +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/Makefile +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/NOTICE +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/__init__.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/connections.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/discovery.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/discovery_configs.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/dmclient.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/files.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/ifm.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/license.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/models/__init__.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/models/data_selection.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/models/discovery.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/models/discovery_config.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/models/files.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/models/git.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/models/ifm.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/models/license.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/models/pagination.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/models/ruleset.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/models/ruleset_library.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/models/runs.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/models/status.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/models/user.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/py.typed +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/ruleset_libraries.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/rulesets.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/runs.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/settings.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/users.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/docs/Makefile +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/docs/client.models.rst +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/docs/conf.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/docs/contributing.rst +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/docs/history.rst +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/docs/index.rst +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/docs/installation.rst +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/docs/make.bat +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/docs/modules.rst +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/docs/readme.rst +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/setup.cfg +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/tests/__init__.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/tests/conftest.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/tests/helpers.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/tests/test_base.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/tests/test_discovery.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/tests/test_discovery_configs.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/tests/test_files.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/tests/test_ifm.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/tests/test_license.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/tests/test_pagination.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/tests/test_ruleset_library.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/tests/test_rulesets.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/tests/test_runs.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/tests/test_settings.py +0 -0
- {datamasque_python-1.1.4 → datamasque_python-1.1.5}/tests/test_users.py +0 -0
|
@@ -2,6 +2,16 @@
|
|
|
2
2
|
History
|
|
3
3
|
=======
|
|
4
4
|
|
|
5
|
+
1.1.5 (2026-06-29)
|
|
6
|
+
------------------
|
|
7
|
+
|
|
8
|
+
* Added support for DataMasque deployments on Snowpark Container Services (SPCS):
|
|
9
|
+
|
|
10
|
+
* Added ``spcs_pat`` to ``DataMasqueInstanceConfig`` for authenticating through the SPCS app gateway.
|
|
11
|
+
* Added ``SpcsGatewayAuthError``, raised when the gateway rejects the PAT.
|
|
12
|
+
* Added the ``spcs`` option to ``SnowflakeStageLocation``.
|
|
13
|
+
* Made several ``SnowflakeConnectionConfig`` fields optional, since SPCS-staged connections leave them unset.
|
|
14
|
+
|
|
5
15
|
1.1.4 (2026-06-29)
|
|
6
16
|
------------------
|
|
7
17
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: datamasque-python
|
|
3
|
-
Version: 1.1.
|
|
3
|
+
Version: 1.1.5
|
|
4
4
|
Summary: Official Python client for the DataMasque data-masking API.
|
|
5
5
|
Project-URL: Homepage, https://datamasque.com/
|
|
6
6
|
Project-URL: Documentation, https://datamasque-python.readthedocs.io/
|
|
@@ -74,6 +74,11 @@ Authentication is performed on the first request if ``authenticate()`` is not ca
|
|
|
74
74
|
and is automatically retried once on a 401 response.
|
|
75
75
|
``client.healthcheck()`` is available as a lightweight readiness probe that does not consume credentials.
|
|
76
76
|
|
|
77
|
+
For a DataMasque instance hosted on Snowpark Container Services (SPCS)
|
|
78
|
+
(a ``*.snowflakecomputing.app`` ``base_url``),
|
|
79
|
+
pass a Snowflake Programmatic Access Token as ``spcs_pat`` on ``DataMasqueInstanceConfig``.
|
|
80
|
+
See the `usage docs <https://datamasque-python.readthedocs.io/en/latest/usage.html>`_ for details.
|
|
81
|
+
|
|
77
82
|
Error handling
|
|
78
83
|
==============
|
|
79
84
|
|
|
@@ -42,6 +42,11 @@ Authentication is performed on the first request if ``authenticate()`` is not ca
|
|
|
42
42
|
and is automatically retried once on a 401 response.
|
|
43
43
|
``client.healthcheck()`` is available as a lightweight readiness probe that does not consume credentials.
|
|
44
44
|
|
|
45
|
+
For a DataMasque instance hosted on Snowpark Container Services (SPCS)
|
|
46
|
+
(a ``*.snowflakecomputing.app`` ``base_url``),
|
|
47
|
+
pass a Snowflake Programmatic Access Token as ``spcs_pat`` on ``DataMasqueInstanceConfig``.
|
|
48
|
+
See the `usage docs <https://datamasque-python.readthedocs.io/en/latest/usage.html>`_ for details.
|
|
49
|
+
|
|
45
50
|
Error handling
|
|
46
51
|
==============
|
|
47
52
|
|
|
@@ -21,6 +21,7 @@ from datamasque.client.exceptions import (
|
|
|
21
21
|
DataMasqueTransportError,
|
|
22
22
|
)
|
|
23
23
|
from datamasque.client.models.dm_instance import DataMasqueInstanceConfig
|
|
24
|
+
from datamasque.client.spcs import install_spcs_gateway_auth
|
|
24
25
|
|
|
25
26
|
logger = logging.getLogger(__name__)
|
|
26
27
|
|
|
@@ -137,6 +138,8 @@ class BaseClient:
|
|
|
137
138
|
self.verify_ssl = connection_config.verify_ssl
|
|
138
139
|
self.token_source = connection_config.token_source
|
|
139
140
|
self._session = _build_session(self.verify_ssl)
|
|
141
|
+
if connection_config.spcs_pat:
|
|
142
|
+
install_spcs_gateway_auth(self._session, connection_config.spcs_pat)
|
|
140
143
|
|
|
141
144
|
@contextmanager
|
|
142
145
|
def _maybe_suppress_insecure_warning(self) -> Iterator[None]:
|
|
@@ -84,6 +84,22 @@ class IfmAuthError(DataMasqueIfmError):
|
|
|
84
84
|
"""Raised when the IFM client cannot obtain or refresh a JWT (e.g. invalid credentials, missing scope)."""
|
|
85
85
|
|
|
86
86
|
|
|
87
|
+
class SpcsGatewayAuthError(DataMasqueException):
|
|
88
|
+
"""
|
|
89
|
+
Raised when a Snowflake SPCS app gateway rejects the configured `spcs_pat`.
|
|
90
|
+
|
|
91
|
+
The message includes the Snowflake-provided detail, request id,
|
|
92
|
+
and a hint at the likely cause
|
|
93
|
+
(for example an expired token, or a network policy that excludes your IP).
|
|
94
|
+
|
|
95
|
+
Deliberately a direct subclass of `DataMasqueException` rather than
|
|
96
|
+
`DataMasqueApiError`:
|
|
97
|
+
the client's 401 re-authenticate-and-retry path keys off `DataMasqueApiError`,
|
|
98
|
+
so keeping this outside that subtree
|
|
99
|
+
ensures a gateway rejection aborts immediately instead of looping.
|
|
100
|
+
"""
|
|
101
|
+
|
|
102
|
+
|
|
87
103
|
class RunNotCancellableError(DataMasqueUserError):
|
|
88
104
|
"""
|
|
89
105
|
Raised when `cancel_run` is called against a run that is no longer eligible for cancellation.
|
|
@@ -57,6 +57,7 @@ class SnowflakeStageLocation(str, Enum):
|
|
|
57
57
|
local = "local" # Not supported for production use
|
|
58
58
|
aws_s3 = "aws_s3"
|
|
59
59
|
azure_blob_storage = "azure_blob_storage"
|
|
60
|
+
spcs = "spcs" # DataMasque running inside Snowflake SPCS; staged on the container's own storage
|
|
60
61
|
|
|
61
62
|
|
|
62
63
|
class SseSelection(Enum):
|
|
@@ -234,10 +235,14 @@ class SnowflakeConnectionConfig(ConnectionConfig):
|
|
|
234
235
|
"""
|
|
235
236
|
|
|
236
237
|
database: str
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
238
|
+
# Optional because DataMasque-in-SPCS connections leave these unset: the agent uses the
|
|
239
|
+
# container's OAuth token + SNOWFLAKE_HOST/SNOWFLAKE_ACCOUNT env and the app-owned QUERY_WAREHOUSE,
|
|
240
|
+
# so user/account/storage-integration/warehouse are null for stage_location=spcs. Mirrors the app's
|
|
241
|
+
# canonical model (agent .../schemas/connection/connection.py), which types these `| None = None`.
|
|
242
|
+
user: Optional[str] = None
|
|
243
|
+
snowflake_account_id: Optional[str] = None
|
|
244
|
+
snowflake_warehouse: Optional[str] = None
|
|
245
|
+
snowflake_storage_integration_name: Optional[str] = None
|
|
241
246
|
host: str = ""
|
|
242
247
|
port: Optional[int] = None
|
|
243
248
|
db_schema: Optional[str] = Field(default=None, alias="schema")
|
|
@@ -20,6 +20,11 @@ class DataMasqueInstanceConfig(BaseModel):
|
|
|
20
20
|
the client prepends it with `Token ` when sending the `Authorization` header.
|
|
21
21
|
The client calls `token_source` on each authentication attempt,
|
|
22
22
|
so the callable is free to fetch and refresh tokens out-of-band (e.g. from a secrets manager).
|
|
23
|
+
|
|
24
|
+
`spcs_pat` is an optional Snowflake Programmatic Access Token
|
|
25
|
+
for reaching a DataMasque instance hosted on Snowpark Container Services (SPCS).
|
|
26
|
+
It layers underneath whichever DataMasque auth method
|
|
27
|
+
(`password` or `token_source`) you choose.
|
|
23
28
|
"""
|
|
24
29
|
|
|
25
30
|
model_config = ConfigDict(arbitrary_types_allowed=True)
|
|
@@ -29,6 +34,14 @@ class DataMasqueInstanceConfig(BaseModel):
|
|
|
29
34
|
password: Optional[str] = None
|
|
30
35
|
verify_ssl: bool = True
|
|
31
36
|
token_source: Optional[Callable[[], str]] = None
|
|
37
|
+
spcs_pat: Optional[str] = None
|
|
38
|
+
"""Snowflake Programmatic Access Token
|
|
39
|
+
for a DataMasque instance hosted on Snowpark Container Services (SPCS),
|
|
40
|
+
where `base_url` ends in `.snowflakecomputing.app`.
|
|
41
|
+
|
|
42
|
+
Create the token in Snowsight (User profile → Programmatic access tokens)
|
|
43
|
+
for an account that can reach the SPCS app.
|
|
44
|
+
Leave unset for instances that are not hosted on SPCS."""
|
|
32
45
|
|
|
33
46
|
@model_validator(mode="after")
|
|
34
47
|
def _validate_auth_source(self) -> "DataMasqueInstanceConfig":
|
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Snowflake SPCS app gateway authentication for `DataMasqueClient`.
|
|
3
|
+
|
|
4
|
+
When a DataMasque instance is hosted on Snowpark Container Services (SPCS),
|
|
5
|
+
its app ingress (`*.snowflakecomputing.app`) fronts every request
|
|
6
|
+
with a Snowflake gateway that must be cleared first.
|
|
7
|
+
We authenticate to the gateway with a Programmatic Access Token (PAT),
|
|
8
|
+
sent on `X-SF-SPCS-Authorization: Snowflake Token="<PAT>"`.
|
|
9
|
+
The gateway accepts the PAT on this alternate header
|
|
10
|
+
and strips it before forwarding to the container,
|
|
11
|
+
so DataMasque's own `Authorization: Token <key>` flow rides through untouched.
|
|
12
|
+
|
|
13
|
+
`install_spcs_gateway_auth` attaches this behaviour to a client's `requests.Session`:
|
|
14
|
+
it sets the header on the session
|
|
15
|
+
(so it is sent on every request, including the unauthenticated login)
|
|
16
|
+
and registers a response hook
|
|
17
|
+
that turns a gateway-originated rejection into a clear `SpcsGatewayAuthError`.
|
|
18
|
+
"""
|
|
19
|
+
|
|
20
|
+
import re
|
|
21
|
+
from typing import Any, Optional
|
|
22
|
+
|
|
23
|
+
import requests
|
|
24
|
+
|
|
25
|
+
from datamasque.client.exceptions import SpcsGatewayAuthError
|
|
26
|
+
|
|
27
|
+
SPCS_GATEWAY_AUTH_HEADER = "X-SF-SPCS-Authorization"
|
|
28
|
+
|
|
29
|
+
# Body-shape discriminators for SPCS gateway error responses.
|
|
30
|
+
# The gateway emits JSON with `responseType` (ERROR_<UPPER_SNAKE>), `requestId`
|
|
31
|
+
# (canonical UUID), and `detail` (free text). All three must be present and
|
|
32
|
+
# match these patterns for the body to count as gateway-originated.
|
|
33
|
+
_GATEWAY_RESPONSE_TYPE_RE = re.compile(r"^ERROR_[A-Z][A-Z0-9_]+$")
|
|
34
|
+
_UUID_RE = re.compile(
|
|
35
|
+
r"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
|
|
36
|
+
re.IGNORECASE,
|
|
37
|
+
)
|
|
38
|
+
|
|
39
|
+
# Header-shape discriminators for "this response transited a Snowflake SPCS
|
|
40
|
+
# gateway". The Server header and the `sfc-ss-` cookie name prefix both appear
|
|
41
|
+
# on every gateway-handled response (success and error alike) and aren't
|
|
42
|
+
# plausible to spoof by accident.
|
|
43
|
+
_SPCS_GATEWAY_SERVER_VALUE = "_"
|
|
44
|
+
_SPCS_COOKIE_PREFIX = "sfc-ss-"
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
def _has_spcs_gateway_header_signature(response: requests.Response) -> bool:
|
|
48
|
+
"""
|
|
49
|
+
True if at least one header-level Snowflake gateway marker is present.
|
|
50
|
+
|
|
51
|
+
Looks for either `Server: _` (the gateway's literal Server header value)
|
|
52
|
+
or any `Set-Cookie` carrying the `sfc-ss-` cookie name prefix.
|
|
53
|
+
Either is sufficient — both indicate the response was emitted by,
|
|
54
|
+
or transited, Snowflake's SPCS ingress.
|
|
55
|
+
"""
|
|
56
|
+
if response.headers.get("server", "").strip() == _SPCS_GATEWAY_SERVER_VALUE:
|
|
57
|
+
return True
|
|
58
|
+
# `Set-Cookie` may appear multiple times; `requests` flattens duplicates
|
|
59
|
+
# via a comma-separated value in `.headers`, but our prefix substring
|
|
60
|
+
# check is order- and count-insensitive.
|
|
61
|
+
return _SPCS_COOKIE_PREFIX in response.headers.get("set-cookie", "")
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
def _is_spcs_gateway_error_body(response: requests.Response) -> Optional[dict]:
|
|
65
|
+
"""
|
|
66
|
+
Return the parsed body iff it is a structurally-valid gateway error.
|
|
67
|
+
|
|
68
|
+
All four conditions must hold:
|
|
69
|
+
1. The body parses as JSON and is a dict.
|
|
70
|
+
2. Keys `responseType`, `requestId`, `detail` are all present and string-typed.
|
|
71
|
+
3. `responseType` matches `^ERROR_<UPPER_SNAKE>$`.
|
|
72
|
+
4. `requestId` is a canonical 8-4-4-4-12 UUID.
|
|
73
|
+
|
|
74
|
+
Returns the parsed dict (truthy) on match, `None` on miss.
|
|
75
|
+
"""
|
|
76
|
+
try:
|
|
77
|
+
data = response.json()
|
|
78
|
+
except ValueError:
|
|
79
|
+
return None
|
|
80
|
+
if not isinstance(data, dict):
|
|
81
|
+
return None
|
|
82
|
+
response_type = data.get("responseType")
|
|
83
|
+
request_id = data.get("requestId")
|
|
84
|
+
detail = data.get("detail")
|
|
85
|
+
if not (isinstance(response_type, str) and isinstance(request_id, str) and isinstance(detail, str)):
|
|
86
|
+
return None
|
|
87
|
+
if _GATEWAY_RESPONSE_TYPE_RE.match(response_type) and _UUID_RE.match(request_id):
|
|
88
|
+
return data
|
|
89
|
+
return None
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
def _hint_for_gateway_detail(detail: str) -> str:
|
|
93
|
+
"""Map common Snowflake gateway `detail` strings to a one-line cause hint."""
|
|
94
|
+
d = (detail or "").lower()
|
|
95
|
+
if "network policy" in d:
|
|
96
|
+
return (
|
|
97
|
+
"PAT requires a network policy attached to the user (or account) "
|
|
98
|
+
"that permits your current public IP. Run `CREATE NETWORK POLICY "
|
|
99
|
+
"... ALLOWED_IP_LIST = ('<your.ip>/32')` and `ALTER USER <pat-user> "
|
|
100
|
+
"SET NETWORK_POLICY = <policy>`."
|
|
101
|
+
)
|
|
102
|
+
if "invalid" in d and "token" in d:
|
|
103
|
+
return (
|
|
104
|
+
"PAT is malformed, expired, or revoked. Create a new PAT in Snowsight "
|
|
105
|
+
"(User profile -> Programmatic access tokens) and update `spcs_pat`."
|
|
106
|
+
)
|
|
107
|
+
if "expired" in d:
|
|
108
|
+
return "PAT has expired. Create a fresh one in Snowsight and update `spcs_pat`."
|
|
109
|
+
if "authentication" in d or "unauthorized" in d:
|
|
110
|
+
return (
|
|
111
|
+
"Generic auth rejection. Verify the PAT was created by a user that "
|
|
112
|
+
"has access to this SPCS app, and that any account-level network "
|
|
113
|
+
"policy includes your current public IP."
|
|
114
|
+
)
|
|
115
|
+
return "Unknown gateway rejection — see the Snowflake `detail` string above and the Snowflake PAT docs."
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
def _check_spcs_gateway_response(response: requests.Response) -> None:
|
|
119
|
+
"""
|
|
120
|
+
Raise `SpcsGatewayAuthError` iff `response` is a gateway-originated rejection.
|
|
121
|
+
|
|
122
|
+
Two-layer discriminator — both must hold:
|
|
123
|
+
* **Body originated at the gateway**:
|
|
124
|
+
strict shape match on the JSON body
|
|
125
|
+
(multiple fields, typed, with format constraints)
|
|
126
|
+
via `_is_spcs_gateway_error_body`.
|
|
127
|
+
* **Response transited an SPCS gateway**:
|
|
128
|
+
header signature confirms via `_has_spcs_gateway_header_signature`.
|
|
129
|
+
|
|
130
|
+
Either layer alone could in principle false-positive on an unrelated upstream
|
|
131
|
+
that happened to emit one of those signals;
|
|
132
|
+
the conjunction is what makes the check robust.
|
|
133
|
+
Legitimate DataMasque 401s (DRF `{"detail": "..."}`)
|
|
134
|
+
have the gateway header signature but fail the body shape —
|
|
135
|
+
so they correctly flow through
|
|
136
|
+
to the client's normal re-auth-and-retry path untouched.
|
|
137
|
+
"""
|
|
138
|
+
if response.status_code not in (401, 403):
|
|
139
|
+
return
|
|
140
|
+
if not _has_spcs_gateway_header_signature(response):
|
|
141
|
+
return
|
|
142
|
+
data = _is_spcs_gateway_error_body(response)
|
|
143
|
+
if data is None:
|
|
144
|
+
return
|
|
145
|
+
|
|
146
|
+
response_type = data["responseType"]
|
|
147
|
+
request_id = data["requestId"]
|
|
148
|
+
detail = data["detail"]
|
|
149
|
+
hint = _hint_for_gateway_detail(detail)
|
|
150
|
+
raise SpcsGatewayAuthError(
|
|
151
|
+
f"SPCS gateway rejected the PAT (HTTP {response.status_code}, "
|
|
152
|
+
f"{response_type}). The request never reached DataMasque.\n"
|
|
153
|
+
f' Snowflake said: "{detail}"\n'
|
|
154
|
+
f" Snowflake reqId: {request_id}\n"
|
|
155
|
+
f" Likely cause: {hint}\n"
|
|
156
|
+
f" Fix in Snowsight on the account hosting this SPCS app, then retry."
|
|
157
|
+
)
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
def _spcs_gateway_response_hook(response: requests.Response, *args: Any, **kwargs: Any) -> None:
|
|
161
|
+
"""`requests` response hook: raise on a gateway-originated auth rejection."""
|
|
162
|
+
_check_spcs_gateway_response(response)
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
def install_spcs_gateway_auth(session: requests.Session, pat: str) -> None:
|
|
166
|
+
"""
|
|
167
|
+
Configure `session` to authenticate to a Snowflake SPCS app gateway.
|
|
168
|
+
|
|
169
|
+
Sets the `X-SF-SPCS-Authorization` header on the session
|
|
170
|
+
(so it rides on every request, including the unauthenticated login)
|
|
171
|
+
and registers a response hook
|
|
172
|
+
that raises `SpcsGatewayAuthError` on a gateway rejection.
|
|
173
|
+
|
|
174
|
+
Scoping is automatic:
|
|
175
|
+
the client's session only ever talks to its own `base_url`,
|
|
176
|
+
so there is no need to match per-request hosts.
|
|
177
|
+
"""
|
|
178
|
+
session.headers[SPCS_GATEWAY_AUTH_HEADER] = f'Snowflake Token="{pat}"'
|
|
179
|
+
session.hooks["response"].append(_spcs_gateway_response_hook)
|
|
@@ -60,6 +60,14 @@ datamasque.client.files module
|
|
|
60
60
|
:undoc-members:
|
|
61
61
|
:show-inheritance:
|
|
62
62
|
|
|
63
|
+
datamasque.client.spcs module
|
|
64
|
+
-----------------------------
|
|
65
|
+
|
|
66
|
+
.. automodule:: datamasque.client.spcs
|
|
67
|
+
:members:
|
|
68
|
+
:undoc-members:
|
|
69
|
+
:show-inheritance:
|
|
70
|
+
|
|
63
71
|
datamasque.client.ifm module
|
|
64
72
|
----------------------------
|
|
65
73
|
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
=====
|
|
2
|
+
Usage
|
|
3
|
+
=====
|
|
4
|
+
|
|
5
|
+
To use DataMasque Python in a project:
|
|
6
|
+
|
|
7
|
+
.. code-block:: python
|
|
8
|
+
|
|
9
|
+
from datamasque.client import DataMasqueClient
|
|
10
|
+
from datamasque.client.models.dm_instance import DataMasqueInstanceConfig
|
|
11
|
+
|
|
12
|
+
config = DataMasqueInstanceConfig(
|
|
13
|
+
base_url="https://datamasque.example.com",
|
|
14
|
+
username="api_user",
|
|
15
|
+
password="api_password",
|
|
16
|
+
)
|
|
17
|
+
client = DataMasqueClient(config)
|
|
18
|
+
client.authenticate()
|
|
19
|
+
|
|
20
|
+
for connection in client.list_connections():
|
|
21
|
+
print(connection.name)
|
|
22
|
+
|
|
23
|
+
Connecting to an SPCS-hosted instance
|
|
24
|
+
=====================================
|
|
25
|
+
|
|
26
|
+
When DataMasque is hosted on Snowpark Container Services (SPCS),
|
|
27
|
+
its `base_url` ends in `.snowflakecomputing.app`
|
|
28
|
+
and requests must first clear the Snowflake gateway.
|
|
29
|
+
Pass a Snowflake Programmatic Access Token (PAT) as `spcs_pat`
|
|
30
|
+
and the client clears the gateway for you,
|
|
31
|
+
independently of your DataMasque `username`/`password` (or `token_source`) auth.
|
|
32
|
+
|
|
33
|
+
.. code-block:: python
|
|
34
|
+
|
|
35
|
+
config = DataMasqueInstanceConfig(
|
|
36
|
+
base_url="https://my-app.snowflakecomputing.app",
|
|
37
|
+
username="api_user",
|
|
38
|
+
password="api_password",
|
|
39
|
+
spcs_pat="<snowflake-programmatic-access-token>",
|
|
40
|
+
)
|
|
41
|
+
client = DataMasqueClient(config)
|
|
42
|
+
client.authenticate()
|
|
43
|
+
|
|
44
|
+
Create the PAT in Snowsight (User profile → Programmatic access tokens)
|
|
45
|
+
for an account that can reach the SPCS app.
|
|
46
|
+
If the gateway rejects the PAT
|
|
47
|
+
(for example it has expired, or a network policy excludes your IP),
|
|
48
|
+
the client raises `SpcsGatewayAuthError`
|
|
49
|
+
with the Snowflake-provided detail and a hint at the likely cause.
|
|
@@ -952,6 +952,36 @@ def test_snowflake_connection_model_validate_with_stage_location():
|
|
|
952
952
|
assert conn.password is None
|
|
953
953
|
|
|
954
954
|
|
|
955
|
+
def test_snowflake_connection_model_validate_with_spcs_stage_location():
|
|
956
|
+
"""
|
|
957
|
+
A Snowflake connection staged in SPCS must deserialise (regression for ui-testing MR !185).
|
|
958
|
+
|
|
959
|
+
When DataMasque runs inside Snowflake SPCS it saves connections with
|
|
960
|
+
`snowflake_stage_location=spcs`. Listing connections deserialises every
|
|
961
|
+
one, so an unknown stage value used to raise `ValidationError` and break
|
|
962
|
+
`create_or_update_connection` for unrelated connections on a shared instance.
|
|
963
|
+
"""
|
|
964
|
+
payload = {
|
|
965
|
+
"id": "a1b2c3d4-0000-0000-0000-000000000000",
|
|
966
|
+
"name": "snowflake_spcs",
|
|
967
|
+
"mask_type": "database",
|
|
968
|
+
"db_type": "snowflake",
|
|
969
|
+
"user": "snowman",
|
|
970
|
+
"database": "icicle",
|
|
971
|
+
"snowflake_account_id": "ABCDEF-123456",
|
|
972
|
+
"snowflake_warehouse": "warehouse1",
|
|
973
|
+
"snowflake_storage_integration_name": "mysi",
|
|
974
|
+
"snowflake_stage_location": "spcs",
|
|
975
|
+
}
|
|
976
|
+
|
|
977
|
+
conn = SnowflakeConnectionConfig.model_validate(payload)
|
|
978
|
+
|
|
979
|
+
assert conn.snowflake_stage_location is SnowflakeStageLocation.spcs
|
|
980
|
+
# SPCS staging carries no external-storage fields.
|
|
981
|
+
assert conn.s3_bucket_name is None
|
|
982
|
+
assert conn.snowflake_azure_container_name is None
|
|
983
|
+
|
|
984
|
+
|
|
955
985
|
def test_snowflake_connection_model_validate_without_stage_location():
|
|
956
986
|
payload = {
|
|
957
987
|
"id": "id-3",
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
"""Tests for Snowflake SPCS app gateway auth (`spcs_pat` on the client)."""
|
|
2
|
+
|
|
3
|
+
from unittest.mock import patch
|
|
4
|
+
|
|
5
|
+
import pytest
|
|
6
|
+
import requests_mock
|
|
7
|
+
|
|
8
|
+
from datamasque.client import DataMasqueClient
|
|
9
|
+
from datamasque.client.exceptions import SpcsGatewayAuthError
|
|
10
|
+
from datamasque.client.models.dm_instance import DataMasqueInstanceConfig
|
|
11
|
+
from datamasque.client.spcs import (
|
|
12
|
+
SPCS_GATEWAY_AUTH_HEADER,
|
|
13
|
+
_hint_for_gateway_detail,
|
|
14
|
+
)
|
|
15
|
+
|
|
16
|
+
BASE_URL = "https://my-app.snowflakecomputing.app"
|
|
17
|
+
PAT = "PAT123"
|
|
18
|
+
EXPECTED_HEADER = 'Snowflake Token="PAT123"'
|
|
19
|
+
VALID_UUID = "12345678-1234-1234-1234-123456789abc"
|
|
20
|
+
|
|
21
|
+
# Headers/body that together mark a response as a gateway-originated rejection.
|
|
22
|
+
GATEWAY_HEADERS = {"Server": "_"}
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
def _gateway_error_body(detail="Invalid token", response_type="ERROR_INVALID_TOKEN"):
|
|
26
|
+
return {"responseType": response_type, "requestId": VALID_UUID, "detail": detail}
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
@pytest.fixture
|
|
30
|
+
def spcs_config():
|
|
31
|
+
return DataMasqueInstanceConfig(
|
|
32
|
+
base_url=BASE_URL,
|
|
33
|
+
username="api_user",
|
|
34
|
+
password="api_password",
|
|
35
|
+
spcs_pat=PAT,
|
|
36
|
+
)
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
@pytest.fixture
|
|
40
|
+
def spcs_client(spcs_config):
|
|
41
|
+
client = DataMasqueClient(spcs_config)
|
|
42
|
+
client.token = "Token dm-token" # pretend we're already authenticated with DM
|
|
43
|
+
return client
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
def test_spcs_header_present_on_authenticated_request(spcs_client):
|
|
47
|
+
with requests_mock.Mocker() as m:
|
|
48
|
+
m.get(f"{BASE_URL}/api/anything/", json={}, status_code=200)
|
|
49
|
+
spcs_client.make_request("GET", "/api/anything/")
|
|
50
|
+
|
|
51
|
+
assert m.last_request.headers[SPCS_GATEWAY_AUTH_HEADER] == EXPECTED_HEADER
|
|
52
|
+
# DM's own auth header rides alongside, untouched.
|
|
53
|
+
assert m.last_request.headers["Authorization"] == "Token dm-token"
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
def test_spcs_header_present_on_login_request(spcs_config):
|
|
57
|
+
"""The header must ride on the unauthenticated login POST too (it must clear the gateway)."""
|
|
58
|
+
client = DataMasqueClient(spcs_config)
|
|
59
|
+
with requests_mock.Mocker() as m:
|
|
60
|
+
m.post(f"{BASE_URL}/api/auth/token/login/", json={"key": "k"}, status_code=200)
|
|
61
|
+
client.authenticate()
|
|
62
|
+
|
|
63
|
+
assert m.last_request.headers[SPCS_GATEWAY_AUTH_HEADER] == EXPECTED_HEADER
|
|
64
|
+
# Login is unauthenticated — no DM Authorization header on this request.
|
|
65
|
+
assert "Authorization" not in m.last_request.headers
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
def test_no_spcs_pat_means_no_header_and_no_hook(client):
|
|
69
|
+
"""The default client (no spcs_pat) is entirely unaffected."""
|
|
70
|
+
assert SPCS_GATEWAY_AUTH_HEADER not in client._session.headers
|
|
71
|
+
assert client._session.hooks["response"] == []
|
|
72
|
+
|
|
73
|
+
client.token = "Token dm-token"
|
|
74
|
+
with requests_mock.Mocker() as m:
|
|
75
|
+
m.get("http://test-server/api/anything/", json={}, status_code=200)
|
|
76
|
+
client.make_request("GET", "/api/anything/")
|
|
77
|
+
assert SPCS_GATEWAY_AUTH_HEADER not in m.last_request.headers
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
def test_gateway_401_raises_and_does_not_retry(spcs_config):
|
|
81
|
+
"""A gateway rejection aborts immediately — no re-auth, no retry loop."""
|
|
82
|
+
with patch.object(DataMasqueClient, "authenticate") as mock_auth:
|
|
83
|
+
client = DataMasqueClient(spcs_config)
|
|
84
|
+
client.token = "Token dm-token"
|
|
85
|
+
with requests_mock.Mocker() as m:
|
|
86
|
+
# A single response: a second call would 404 and fail the test loudly.
|
|
87
|
+
m.get(
|
|
88
|
+
f"{BASE_URL}/api/anything/",
|
|
89
|
+
json=_gateway_error_body(),
|
|
90
|
+
status_code=401,
|
|
91
|
+
headers=GATEWAY_HEADERS,
|
|
92
|
+
)
|
|
93
|
+
with pytest.raises(SpcsGatewayAuthError) as exc:
|
|
94
|
+
client.make_request("GET", "/api/anything/")
|
|
95
|
+
|
|
96
|
+
assert m.call_count == 1
|
|
97
|
+
mock_auth.assert_not_called()
|
|
98
|
+
# The helpful hint is surfaced.
|
|
99
|
+
assert "PAT is malformed, expired, or revoked" in str(exc.value)
|
|
100
|
+
assert VALID_UUID in str(exc.value)
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
def test_normal_dm_401_still_retries(spcs_config):
|
|
104
|
+
"""A genuine DataMasque 401 (no gateway signature) flows to the normal re-auth retry."""
|
|
105
|
+
client = DataMasqueClient(spcs_config)
|
|
106
|
+
with requests_mock.Mocker() as m:
|
|
107
|
+
m.post(f"{BASE_URL}/api/auth/token/login/", json={"key": "k"}, status_code=200)
|
|
108
|
+
m.get(
|
|
109
|
+
f"{BASE_URL}/api/anything/",
|
|
110
|
+
[
|
|
111
|
+
# DRF-shaped 401, no gateway Server header → not a gateway rejection.
|
|
112
|
+
{"json": {"detail": "Authentication credentials were not provided."}, "status_code": 401},
|
|
113
|
+
{"json": {"ok": True}, "status_code": 200},
|
|
114
|
+
],
|
|
115
|
+
)
|
|
116
|
+
# Should NOT raise SpcsGatewayAuthError; should re-auth and succeed.
|
|
117
|
+
response = client.make_request("GET", "/api/anything/")
|
|
118
|
+
|
|
119
|
+
assert response.status_code == 200
|
|
120
|
+
assert client.token == "Token k" # re-auth happened
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
def test_gateway_signature_without_body_shape_passes_through(spcs_config):
|
|
124
|
+
"""Gateway header present but DM-shaped body → treated as a normal DM 401, not a gateway rejection."""
|
|
125
|
+
client = DataMasqueClient(spcs_config)
|
|
126
|
+
with requests_mock.Mocker() as m:
|
|
127
|
+
m.post(f"{BASE_URL}/api/auth/token/login/", json={"key": "k"}, status_code=200)
|
|
128
|
+
m.get(
|
|
129
|
+
f"{BASE_URL}/api/anything/",
|
|
130
|
+
[
|
|
131
|
+
{"json": {"detail": "nope"}, "status_code": 401, "headers": GATEWAY_HEADERS},
|
|
132
|
+
{"json": {"ok": True}, "status_code": 200},
|
|
133
|
+
],
|
|
134
|
+
)
|
|
135
|
+
response = client.make_request("GET", "/api/anything/") # must not raise
|
|
136
|
+
|
|
137
|
+
assert response.status_code == 200
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
@pytest.mark.parametrize(
|
|
141
|
+
"detail, expected_substring",
|
|
142
|
+
[
|
|
143
|
+
("Request failed network policy check", "network policy"),
|
|
144
|
+
("Invalid token supplied", "malformed, expired, or revoked"),
|
|
145
|
+
("The token has expired", "PAT has expired"),
|
|
146
|
+
("Unauthorized request", "Generic auth rejection"),
|
|
147
|
+
("Something totally unexpected", "Unknown gateway rejection"),
|
|
148
|
+
],
|
|
149
|
+
)
|
|
150
|
+
def test_hint_for_gateway_detail(detail, expected_substring):
|
|
151
|
+
assert expected_substring in _hint_for_gateway_detail(detail)
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
def test_spcs_pat_coexists_with_password_and_token_source():
|
|
155
|
+
"""`spcs_pat` is orthogonal to the password/token_source XOR — both combos validate."""
|
|
156
|
+
DataMasqueInstanceConfig(base_url=BASE_URL, username="u", password="p", spcs_pat=PAT)
|
|
157
|
+
DataMasqueInstanceConfig(base_url=BASE_URL, username="u", token_source=lambda: "t", spcs_pat=PAT)
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
=====
|
|
2
|
-
Usage
|
|
3
|
-
=====
|
|
4
|
-
|
|
5
|
-
To use DataMasque Python in a project:
|
|
6
|
-
|
|
7
|
-
.. code-block:: python
|
|
8
|
-
|
|
9
|
-
from datamasque.client import DataMasqueClient
|
|
10
|
-
from datamasque.client.models.dm_instance import DataMasqueInstanceConfig
|
|
11
|
-
|
|
12
|
-
config = DataMasqueInstanceConfig(
|
|
13
|
-
base_url="https://datamasque.example.com",
|
|
14
|
-
username="api_user",
|
|
15
|
-
password="api_password",
|
|
16
|
-
)
|
|
17
|
-
client = DataMasqueClient(config)
|
|
18
|
-
client.authenticate()
|
|
19
|
-
|
|
20
|
-
for connection in client.list_connections():
|
|
21
|
-
print(connection.name)
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/models/data_selection.py
RENAMED
|
File without changes
|
|
File without changes
|
{datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/models/discovery_config.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{datamasque_python-1.1.4 → datamasque_python-1.1.5}/datamasque/client/models/ruleset_library.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|