SK-3014-gitleaks-detection-fix

.gitleaks.toml

@@ -0,0 +1,10 @@
+title = "skyflow-python gitleaks config"
+
+[extend]
+useDefault = true
+
+[allowlist]
+description = "Dummy, non-secret fixture values used only by tests"
+paths = [
+  '''(^|/)dummy-non-secret/.*''',
+]

flowvault/README.md

@@ -493,7 +493,7 @@ from skyflow.vault.data import DetokenizeRequest, TokenGroupRedactions
 vault = skyflow_client.vault('<VAULT_ID>')  # skyflow_client from Quickstart
 
 request = DetokenizeRequest(
-    tokens=['5479-4229-4622-1393', 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'],
+    tokens=['5479-4229-4622-1393', '<TOKEN_1>'],
     token_group_redactions=[TokenGroupRedactions(token_group_name='card_number_cg', redaction='MASKED')],
 )
 response = vault.detokenize(request)
@@ -516,7 +516,7 @@ Sample response:
       "request_id": null
     },
     {
-      "token": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+      "token": "<TOKEN_1>",
       "value": null,
       "token_group_name": null,
       "metadata": null,
@@ -650,7 +650,7 @@ Sample response:
       "table_name": "table1",
       "skyflow_id": "9fac9201-7b8a-4446-93f8-5244e1213bd1",
       "tokens": {
-        "cardholder_name": [ { "token": "f1a2b3c4-d5e6-7890-abcd-ef1234567890", "token_group_name": "deterministic_string", "path": null } ]
+        "cardholder_name": [ { "token": "<TOKEN_2>", "token_group_name": "deterministic_string", "path": null } ]
       },
       "data": { "cardholder_name": "Jane Doe" },
       "hashed_data": null,

skyvault/skyflow/generated/rest/authentication/client.py

@@ -73,11 +73,11 @@ def authentication_service_get_auth_token(
         from skyflow import Skyflow
 
         client = Skyflow(
-            token="YOUR_TOKEN",
+            token="<TOKEN_1>",
         )
         client.authentication.authentication_service_get_auth_token(
             grant_type="urn:ietf:params:oauth:grant-type:jwt-bearer",
-            assertion="eyLhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaXNzIjoiY29tcGFueSIsImV4cCI6MTYxNTE5MzgwNywiaWF0IjoxNjE1MTY1MDQwLCJhdWQiOiKzb21lYXVkaWVuY2UifQ.4pcPyMDQ9o1PSyXnrXCjTwXyr4BSezdI1AVTmud2fU3",
+            assertion="<JWT_TOKEN>",
         )
         """
         _response = self._raw_client.authentication_service_get_auth_token(
@@ -156,14 +156,14 @@ async def authentication_service_get_auth_token(
         from skyflow import AsyncSkyflow
 
         client = AsyncSkyflow(
-            token="YOUR_TOKEN",
+            token="<TOKEN>",
         )
 
 
         async def main() -> None:
             await client.authentication.authentication_service_get_auth_token(
                 grant_type="urn:ietf:params:oauth:grant-type:jwt-bearer",
-                assertion="eyLhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaXNzIjoiY29tcGFueSIsImV4cCI6MTYxNTE5MzgwNywiaWF0IjoxNjE1MTY1MDQwLCJhdWQiOiKzb21lYXVkaWVuY2UifQ.4pcPyMDQ9o1PSyXnrXCjTwXyr4BSezdI1AVTmud2fU3",
+                assertion="<JWT_TOKEN>",
             )
 
 

skyvault/skyflow/generated/rest/tokens/client.py

@@ -74,11 +74,11 @@ def record_service_detokenize(
             vault_id="vaultID",
             detokenization_parameters=[
                 V1DetokenizeRecordRequest(
-                    token="afbd1074-51c1-4a16-9eee-e2c0ecb52125",
+                    token="<TOKEN_1>",
                     redaction="PLAIN_TEXT",
                 ),
                 V1DetokenizeRecordRequest(
-                    token="05383487-fcae-42e5-a48e-5bd62a51af12",
+                    token="<TOKEN_2>",
                     redaction="DEFAULT",
                 ),
             ],
@@ -202,11 +202,11 @@ async def main() -> None:
                 vault_id="vaultID",
                 detokenization_parameters=[
                     V1DetokenizeRecordRequest(
-                        token="afbd1074-51c1-4a16-9eee-e2c0ecb52125",
+                        token="<TOKEN_1>",
                         redaction="PLAIN_TEXT",
                     ),
                     V1DetokenizeRecordRequest(
-                        token="05383487-fcae-42e5-a48e-5bd62a51af12",
+                        token="<TOKEN_2>",
                         redaction="DEFAULT",
                     ),
                 ],

skyvault/tests/dummy-non-secret/api_keys.json

@@ -0,0 +1,8 @@
+{
+  "validations_valid_api_key": "sky-test-000000000000000000000000000000000",
+  "validations_invalid_prefix_api_key": "invalid-test-000000000000000000000000000000000",
+  "validations_invalid_length_api_key": "sky-test-000000",
+  "utils_valid_api_key": "sky-00000-00000000000000000000000000000000",
+  "utils_invalid_length_api_key": "sky-00000-000",
+  "utils_invalid_pattern_api_key": "sky-00000-0000000000GHIJKL0000000000000000"
+}

skyvault/tests/utils/test__utils.py

@@ -43,6 +43,14 @@
 with open(creds_path, "r") as file:
     credentials = json.load(file)
 
+dummy_api_keys_path = os.path.join(os.path.dirname(__file__), "..", "dummy-non-secret", "api_keys.json")
+with open(dummy_api_keys_path, "r") as dummy_api_keys_file:
+    dummy_api_keys = json.load(dummy_api_keys_file)
+
+DUMMY_VALID_API_KEY = dummy_api_keys["utils_valid_api_key"]
+DUMMY_INVALID_LENGTH_API_KEY = dummy_api_keys["utils_invalid_length_api_key"]
+DUMMY_INVALID_PATTERN_API_KEY = dummy_api_keys["utils_invalid_pattern_api_key"]
+
 TEST_ERROR_MESSAGE = "Test error message."
 VALID_ENV_CREDENTIALS = credentials
 
@@ -556,15 +564,15 @@ def test_handle_exception_json_error(self, mock_log_and_reject_error):
         )
 
     def test_validate_api_key_valid_key(self):
-        valid_key = "sky-ABCDE-1234567890abcdef1234567890abcdef"
+        valid_key = DUMMY_VALID_API_KEY
         self.assertTrue(validate_api_key(valid_key))
 
     def test_validate_api_key_invalid_length(self):
-        invalid_key = "sky-ABCDE-123"
+        invalid_key = DUMMY_INVALID_LENGTH_API_KEY
         self.assertFalse(validate_api_key(invalid_key))
 
     def test_validate_api_key_invalid_pattern(self):
-        invalid_key = "sky-ABCDE-1234567890GHIJKL7890abcdef"
+        invalid_key = DUMMY_INVALID_PATTERN_API_KEY
         self.assertFalse(validate_api_key(invalid_key))
 
     def test_encode_column_values(self):