protegrity-ai-developer-python 1.2.1__py3-none-any.whl

pty_migrate/payloads/__init__.py

@@ -0,0 +1,51 @@
+"""Loader for bundled DE policy payload files."""
+
+import json
+from pathlib import Path
+
+_PAYLOAD_DIR = Path(__file__).parent
+
+
+def load_payload(name):
+    """Load a payload JSON file by resource name.
+
+    Args:
+        name: Resource name (e.g., 'dataelements', 'roles', 'rules').
+
+    Returns:
+        Parsed JSON (list or dict).
+    """
+    # Map resource names to filenames
+    filename_map = {
+        "datastores": "datastores.json",
+        "sources": "sources.json",
+        "roles": "roles.json",
+        "alphabets": "alphabets.json",
+        "masks": "masks.json",
+        "dataelements": "dataelements.json",
+        "applications": "trusted_apps.json",
+        "policies": "policies.json",
+        "rules": "rules.json",
+        "deploy": "deploy_policy_ta.json",
+        "members": "members.json",
+    }
+    filename = filename_map.get(name)
+    if not filename:
+        raise ValueError(f"Unknown payload resource: {name}")
+
+    path = _PAYLOAD_DIR / filename
+    with open(path, "r", encoding="utf-8") as f:
+        return json.load(f)
+
+
+def load_all_payloads():
+    """Load all payload files into a dict keyed by resource name.
+
+    Returns:
+        dict: {resource_name: payload_data}
+    """
+    resources = [
+        "datastores", "sources", "roles", "alphabets", "masks",
+        "dataelements", "applications", "policies", "rules", "deploy", "members",
+    ]
+    return {name: load_payload(name) for name in resources}

pty_migrate/payloads/alphabets.json

@@ -0,0 +1,42 @@
+[
+    {
+        "label": "latin_german_numeric",
+        "codePoints": ["00E4", "00F6", "00FC", "00C4", "00D6", "00DC", "00DF"],
+        "ranges": [
+            { "from": "0041", "to": "005A" },
+            { "from": "0061", "to": "007A" },
+            { "from": "0100", "to": "017F" },
+            { "from": "0180", "to": "024F" },
+            { "from": "0030", "to": "0039" }
+        ]
+    },
+    {
+        "label": "latin_french_numeric",
+        "ranges": [
+            { "from": "0041", "to": "005A" },
+            { "from": "0061", "to": "007A" },
+            { "from": "00C0", "to": "00FF" },
+            { "from": "0100", "to": "017F" },
+            { "from": "0030", "to": "0039" }
+        ]
+    },
+    {
+        "label": "latin_german",
+        "codePoints": ["00E4", "00F6", "00FC", "00C4", "00D6", "00DC", "00DF"],
+        "ranges": [
+            { "from": "0041", "to": "005A" },
+            { "from": "0061", "to": "007A" },
+            { "from": "0100", "to": "017F" },
+            { "from": "0180", "to": "024F" }
+        ]
+    },
+    {
+        "label": "latin_french",
+        "ranges": [
+            { "from": "0041", "to": "005A" },
+            { "from": "0061", "to": "007A" },
+            { "from": "00C0", "to": "00FF" },
+            { "from": "0100", "to": "017F" }
+        ]
+    }
+]

pty_migrate/payloads/dataelements.json

@@ -0,0 +1,342 @@
+[
+  {
+    "name": "name",
+    "description": "Protect or unprotect name of a person",
+    "alphabeticToken": {
+      "tokenizer": "SLT_2_3",
+      "fromLeft": 0,
+      "fromRight": 0,
+      "lengthPreserving": true
+    }
+  },
+  {
+    "name": "name_de",
+    "description": "Protect or unprotect name of a person in German language",
+    "unicodeGen2Token": {
+      "tokenizer": "SLT_X_1",
+      "alphabetUid": "3",
+      "fromLeft": 0,
+      "fromRight": 0,
+      "lengthPreserving": true
+    }
+  },
+  {
+    "name": "name_fr",
+    "description": "Protect or unprotect name of a person in French language",
+    "unicodeGen2Token": {
+      "tokenizer": "SLT_X_1",
+      "alphabetUid": "4",
+      "fromLeft": 0,
+      "fromRight": 0,
+      "lengthPreserving": true
+    }
+  },
+  {
+    "name": "address",
+    "description": "Protect or unprotect an address",
+    "alphaNumericToken": {
+      "tokenizer": "SLT_2_3",
+      "fromLeft": 0,
+      "fromRight": 0,
+      "lengthPreserving": true
+    }
+  },
+  {
+    "name": "address_de",
+    "description": "Protect or unprotect an address in German language",
+    "unicodeGen2Token": {
+      "tokenizer": "SLT_X_1",
+      "alphabetUid": "1",
+      "fromLeft": 0,
+      "fromRight": 0,
+      "lengthPreserving": true
+    }
+  },
+  {
+    "name": "address_fr",
+    "description": "Protect or unprotect an address in French language",
+    "unicodeGen2Token": {
+      "tokenizer": "SLT_X_1",
+      "alphabetUid": "2",
+      "fromLeft": 0,
+      "fromRight": 0,
+      "lengthPreserving": true
+    }
+  },
+  {
+    "name": "city",
+    "description": "Protect or unprotect a town or city",
+    "alphabeticToken": {
+      "tokenizer": "SLT_2_3",
+      "fromLeft": 0,
+      "fromRight": 0,
+      "lengthPreserving": true
+    }
+  },
+  {
+    "name": "city_de",
+    "description": "Protect or unprotect a town or city name in German language",
+    "unicodeGen2Token": {
+      "tokenizer": "SLT_X_1",
+      "alphabetUid": "3",
+      "fromLeft": 0,
+      "fromRight": 0,
+      "lengthPreserving": true
+    }
+  },
+  {
+    "name": "city_fr",
+    "description": "Protect or unprotect a town or city name in French language",
+    "unicodeGen2Token": {
+      "tokenizer": "SLT_X_1",
+      "alphabetUid": "4",
+      "fromLeft": 0,
+      "fromRight": 0,
+      "lengthPreserving": true
+    }
+  },
+  {
+    "name": "postcode",
+    "description": "Protect or unprotect a postal code with digits and chatacters",
+    "alphaNumericToken": {
+      "tokenizer": "SLT_2_3",
+      "fromLeft": 0,
+      "fromRight": 0,
+      "lengthPreserving": true,
+      "preservePosition": true,
+      "preserveCase": true
+    }
+  },
+  {
+    "name": "zipcode",
+    "description": "Protect or unprotect a postal code with digits only",
+    "numericToken": {
+      "tokenizer": "SLT_2_6",
+      "fromLeft": 0,
+      "fromRight": 0,
+      "lengthPreserving": true
+    }
+  },
+  {
+    "name": "phone",
+    "description": "Protect or unprotect a phone number",
+    "numericToken": {
+      "tokenizer": "SLT_2_6",
+      "fromLeft": 0,
+      "fromRight": 0,
+      "lengthPreserving": true
+    }
+  },
+  {
+    "name": "email",
+    "description": "Protect or unprotect an email",
+    "emailToken": {
+      "tokenizer": "SLT_2_3",
+      "lengthPreserving": true
+    }
+  },
+  {
+    "name": "datetime",
+    "description": "Protect or unprotect all components of a datetime string date, month, year and time",
+    "dateTimeToken": {
+      "tokenizer": "SLT_8_DATETIME"
+    }
+  },
+  {
+    "name": "datetime_yc",
+    "description": "Protect or unprotect a datetime string. Year will be in clear.",
+    "dateTimeToken": {
+      "tokenizer": "SLT_8_DATETIME",
+      "dateInClear": "YEAR"
+    }
+  },
+  {
+    "name": "int",
+    "description": "Protect or unprotect a 4-byte integer string",
+    "integerToken": {
+      "tokenizer": "SLT_1_3"
+    }
+  },
+  {
+    "name": "nin",
+    "description": "Protect or unprotect a National Insurance Number UK",
+    "alphaNumericToken": {
+      "tokenizer": "SLT_2_3",
+      "fromLeft": 0,
+      "fromRight": 0,
+      "lengthPreserving": true,
+      "preservePosition": true,
+      "preserveCase": true
+    }
+  },
+  {
+    "name": "ssn",
+    "description": "Protect or unprotect a Social Security Number US",
+    "numericToken": {
+      "tokenizer": "SLT_2_6",
+      "fromLeft": 0,
+      "fromRight": 0,
+      "lengthPreserving": true
+    }
+  },
+  {
+    "name": "ccn",
+    "description": "Protect or unprotect a Credit Card Number",
+    "creditCardToken": {
+      "tokenizer": "SLT_2_6",
+      "fromLeft": 0,
+      "fromRight": 0
+    }
+  },
+  {
+    "name": "ccn_bin",
+    "description": "Protect or unprotect a Credit Card Number. Leaves 8-digit BIN in the clear.",
+    "creditCardToken": {
+      "tokenizer": "SLT_2_6",
+      "fromLeft": 8,
+      "fromRight": 0
+    }
+  },
+  {
+    "name": "passport",
+    "description": "Protect or unprotect a passport number",
+    "alphaNumericToken": {
+      "tokenizer": "SLT_2_3",
+      "fromLeft": 0,
+      "fromRight": 0,
+      "lengthPreserving": true,
+      "preservePosition": true,
+      "preserveCase": true
+    }
+  },
+  {
+    "name": "iban",
+    "description": "Protect or unprotect an Internation Banking Account Number",
+    "alphaNumericToken": {
+      "tokenizer": "SLT_2_3",
+      "fromLeft": 0,
+      "fromRight": 0,
+      "lengthPreserving": true,
+      "preservePosition": true,
+      "preserveCase": true
+    }
+  },
+  {
+    "name": "iban_cc",
+    "description": "Protect or unprotect an Internation Banking Account Number. Leaves letters in the clear.",
+    "numericToken": {
+      "tokenizer": "SLT_2_6",
+      "fromLeft": 0,
+      "fromRight": 0,
+      "lengthPreserving": true
+    }
+  },
+  {
+    "name": "string",
+    "description": "Protect or unprotect a string",
+    "alphaNumericToken": {
+      "tokenizer": "SLT_2_3",
+      "fromLeft": 0,
+      "fromRight": 0,
+      "lengthPreserving": true
+    }
+  },
+  {
+    "name": "number",
+    "description": "Protect or unprotect a number",
+    "numericToken": {
+      "tokenizer": "SLT_2_6",
+      "fromLeft": 0,
+      "fromRight": 0,
+      "lengthPreserving": true
+    }
+  },
+  {
+    "name": "text",
+    "description": "Protect or unprotect text using encryption",
+    "aes256CbcEnc": {}
+  },
+  {
+    "name": "fpe_numeric",
+    "description": "FPE for numeric data",
+    "numericFpe": {
+      "fromLeft": 0,
+      "fromRight": 0,
+      "allowShort": "NOWITHERROR",
+      "minLength": 2,
+      "tweakMode": "EXT_INPUT"
+    }
+  },
+  {
+    "name": "fpe_alpha",
+    "description": "FPE using Alpha as plaintext alphabet",
+    "alphabeticFpe": {
+      "fromLeft": 0,
+      "fromRight": 0,
+      "allowShort": "NOWITHERROR",
+      "minLength": 2,
+      "tweakMode": "EXT_INPUT"
+    }
+  },
+  {
+    "name": "fpe_alphanumeric",
+    "description": "FPE using Alphanumeric as plaintext alphabet",
+    "alphaNumericFpe": {
+      "fromLeft": 0,
+      "fromRight": 0,
+      "allowShort": "NOWITHERROR",
+      "minLength": 2,
+      "tweakMode": "EXT_INPUT"
+    }
+  },
+  {
+    "name": "fpe_latin1_alpha",
+    "description": "FPE using Basic Latin and Latin-1 Supplement Alpha",
+    "unicodeBasicLatinAlphabeticFpe": {
+      "fromLeft": 0,
+      "fromRight": 0,
+      "allowShort": "NOWITHERROR",
+      "minLength": 2,
+      "tweakMode": "EXT_INPUT"
+    }
+  },
+  {
+    "name": "fpe_latin1_alphanumeric",
+    "description": "FPE using Basic Latin and Latin-1 Supplement Alphanumeric",
+    "unicodeBasicLatinAlphaNumericFpe": {
+      "fromLeft": 0,
+      "fromRight": 0,
+      "allowShort": "NOWITHERROR",
+      "minLength": 2,
+      "tweakMode": "EXT_INPUT"
+    }
+  },
+  {
+    "name": "mask",
+    "description": "Mask all the characters",
+    "noEnc": {
+      "maskUid": "1"
+    }
+  },
+  {
+    "name": "no_encryption",
+    "description": "No encryption data element",
+    "noEnc": {}
+  },
+  {
+    "name": "short",
+    "description": "Protect or unprotect a 2-byte integer string",
+    "integerToken": {
+      "tokenizer": "SLT_1_3",
+      "integerSize": "SHORT"
+    }
+  },
+  {
+    "name": "long",
+    "description": "Protect or unprotect an 8-byte integer string",
+    "integerToken": {
+      "tokenizer": "SLT_1_3",
+      "integerSize": "LONG"
+    }
+  }
+]

pty_migrate/payloads/datastores.json

@@ -0,0 +1,7 @@
+[
+    {
+        "name": "DevEdition",
+        "description": "Datastore for Protegrity Developer Edition.",
+        "default": true
+    }
+]

pty_migrate/payloads/deploy_policy_ta.json

@@ -0,0 +1 @@
+[{ "policies": ["1"], "applications": ["1"] }]

pty_migrate/payloads/masks.json

@@ -0,0 +1,18 @@
+[
+    {
+        "name": "mask",
+        "description": "mask character",
+        "fromLeft": 0,
+        "fromRight": 0,
+        "masked": false,
+        "character": "*"
+    },
+    {
+        "name": "mask_ccn",
+        "description": "Mask CCN data",
+        "fromLeft": 4,
+        "fromRight": 4,
+        "masked": false,
+        "character": "*"
+    }
+]

pty_migrate/payloads/members.json

@@ -0,0 +1,62 @@
+{
+    "roles/1/members": [
+        {
+            "name": "superuser",
+            "source": "1",
+            "type": "USER"
+        }
+    ],
+    "roles/2/members": [
+        {
+            "name": "admin",
+            "source": "1",
+            "type": "USER"
+        },
+        {
+            "name": "devops",
+            "source": "1",
+            "type": "USER"
+        },
+        {
+            "name": "jay.banerjee",
+            "source": "1",
+            "type": "USER"
+        }
+    ],
+    "roles/3/members": [
+        {
+            "name": "finance",
+            "source": "1",
+            "type": "USER"
+        },
+        {
+            "name": "robin.goodwill",
+            "source": "1",
+            "type": "USER"
+        }
+    ],
+    "roles/4/members": [
+        {
+            "name": "marketing",
+            "source": "1",
+            "type": "USER"
+        },
+        {
+            "name": "merlin.ishida",
+            "source": "1",
+            "type": "USER"
+        }
+    ],
+    "roles/5/members": [
+        {
+            "name": "hr",
+            "source": "1",
+            "type": "USER"
+        },
+        {
+            "name": "paloma.torres",
+            "source": "1",
+            "type": "USER"
+        }
+    ]
+}

pty_migrate/payloads/policies.json

@@ -0,0 +1,13 @@
+[
+    {
+        "name": "DevEditionPolicy",
+        "description": "Policy for Protegrity Developer Edition.",
+        "template": {
+            "access": {
+                "protect": false,
+                "reProtect": false,
+                "unProtect": false
+            }
+        }
+    }
+]

pty_migrate/payloads/roles.json

@@ -0,0 +1,32 @@
+[
+    {
+        "name": "Superuser",
+        "description": "The role can perform any protect and unprotect operation. The role has been made available for testing only. We strongly advise against creating superuser roles in your environments.",
+        "mode": "MANUAL",
+        "allowAll": false
+    },
+    {
+        "name": "Admin",
+        "description": "The role can protect all data but cannot unprotect. Upon an unprotection attempt, protected values will be displayed.",
+        "mode": "MANUAL",
+        "allowAll": false
+    },
+    {
+        "name": "Finance",
+        "description": "The role can unprotect all PII and PCI data. The role cannot protect any data. When attempting to unprotect data without authorization, null value will be displayed.",
+        "mode": "MANUAL",
+        "allowAll": false
+    },
+    {
+        "name": "Marketing",
+        "description": "The role can unprotect some PII data that is required for analytical research and campaign outreach. When attempting to unprotect data without authorization, null value will be displayed. The role cannot protect any data.",
+        "mode": "MANUAL",
+        "allowAll": false
+    },
+    {
+        "name": "HR",
+        "description": "The role can unprotect all PII data but cannot view any PCI data. When attempting to unprotect data without authorization, null value will be displayed. The role cannot protect any data.",
+        "mode": "MANUAL",
+        "allowAll": false
+    }
+]