scientiveshield-tools 0.1.0__tar.gz

scientiveshield_tools-0.1.0/LICENSE

@@ -0,0 +1,88 @@
+Business Source License 1.1
+
+License text copyright © 2017 MariaDB Corporation Ab, All Rights Reserved.
+"Business Source License" is a trademark of MariaDB Corporation Ab.
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited
+production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+TITLE.
+
+MariaDB hereby grants you permission to use this License’s text to license
+your works, and to refer to it using the trademark “Business Source License”,
+as long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+
+In consideration of the right to use this License’s text and the “Business
+Source License” name and trademark, Licensor covenants to MariaDB, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where “compatible” means that software provided under the Change License can
+   be included in a program with software provided under GPL Version 2.0 or a
+   later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not
+   impose any additional restriction on the right granted in this License, as
+   the Additional Use Grant; or (b) insert the text “None”.
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.
+
+---
+
+License parameters
+
+Licensor: ScientiveShield
+Licensed Work: scientiveshield-tools, version 0.1.0 and later versions
+Additional Use Grant: You may use, reproduce, and distribute the Licensed Work,
+including in production, solely to export data from Devolens/Cryptolens for
+import into ScientiveShield. This includes use by the licensed customer's
+employees, contractors, agencies, and other authorized service providers
+acting on the customer's behalf, and internal evaluation, testing, and CI use.
+You may not offer the Licensed Work, or a derivative work, as a standalone
+commercial product, managed service, or as part of a competing software
+licensing platform.
+Change Date: 2030-10-21
+Change License: Apache License, Version 2.0

scientiveshield_tools-0.1.0/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: scientiveshield-tools
+Version: 0.1.0
+Summary: Export Devolens (Cryptolens) licensing data into a ScientiveShield import bundle.
+Author: ScientiveShield
+License-Expression: BUSL-1.1
+Project-URL: Homepage, https://scientiveshield.pro/migrate/developer/
+Project-URL: Documentation, https://scientiveshield.pro/migrate/developer/
+Project-URL: Repository, https://github.com/franciscomvargas/scientiveshield-tools
+Project-URL: Issues, https://github.com/franciscomvargas/scientiveshield-tools/issues
+Keywords: licensing,cryptolens,devolens,migration,scientiveshield
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.31
+Dynamic: license-file
+
+# scientiveshield-tools
+
+Export Devolens (formerly Cryptolens) products, customers, templates, licenses, activations and
+data objects into one ScientiveShield import bundle.
+
+This package is the official ScientiveShield exporter. It is **not** a Cryptolens SDK.
+
+## Install
+
+```bash
+python -m pip install --upgrade scientiveshield-tools
+```
+
+Python 3.10+ is required.
+
+## Create an import file
+
+Use a read-only Devolens/Cryptolens token with these permissions:
+
+- Get Products
+- Get Keys
+- Get Customers
+- License Template
+- List Data Objects
+
+```python
+from scientiveshield_tools import create_import_file
+
+result = create_import_file(
+    token="read-only-cryptolens-token",
+    product_ids=[33453, 33454],
+    output="bundle.json",
+)
+
+print(result.summary)
+```
+
+The exporter writes schema version 2 and preserves key strings. It includes key-scoped and
+machine-scoped data objects. Product selection is explicit; it never exports every product by
+accident.
+
+### Inspect products
+
+```python
+from scientiveshield_tools import list_products
+
+for product in list_products(token="..."):
+    print(product.id, product.name)
+```
+
+### Validate the file
+
+```python
+from scientiveshield_tools import validate_import_file
+
+result = validate_import_file("bundle.json")
+print(result.ok, result.errors, result.warnings)
+```
+
+### Free environment
+
+Cryptolens’ limited free environment allows one API request every 10 seconds. Use:
+
+```python
+create_import_file(..., free_tier=True)
+```
+
+The client then spaces requests proactively. On a 429 response it honors `Retry-After`, otherwise
+waits 10 seconds. A free-tier export can take a few minutes; that is expected.
+
+## CLI (optional)
+
+```bash
+python -m scientiveshield_tools list-products --token "$CRYPTOLENS_TOKEN"
+python -m scientiveshield_tools export --interactive --out bundle.json
+python -m scientiveshield_tools validate --bundle bundle.json
+```
+
+## Security
+
+- Use a **read-only** token. Never use the Cryptolens account password.
+- The token is never logged or included in the bundle.
+- The bundle contains customer secrets and license data. Share it only via a secure channel.
+- Revoke the source token after the export.
+- Do not commit `bundle.json` or tokens.
+
+## Import and cutover
+
+Upload the bundle in ScientiveShield → **Migration**. The dashboard validates it, shows a dry-run
+preview, imports through a background worker, and provides the app cutover kit.
+
+Developer guide: <https://scientiveshield.pro/migrate/developer/>
+
+## License
+
+Business Source License 1.1 with an Additional Use Grant. See [LICENSE](LICENSE). Commercial use is
+permitted for migrating your own or your clients’ software into ScientiveShield. The Licensed Work
+may not be offered as a standalone commercial product, managed service, or competing licensing
+platform. The Change Date is 2030-10-21; the Change License is Apache-2.0.

scientiveshield_tools-0.1.0/README.md

@@ -0,0 +1,99 @@
+# scientiveshield-tools
+
+Export Devolens (formerly Cryptolens) products, customers, templates, licenses, activations and
+data objects into one ScientiveShield import bundle.
+
+This package is the official ScientiveShield exporter. It is **not** a Cryptolens SDK.
+
+## Install
+
+```bash
+python -m pip install --upgrade scientiveshield-tools
+```
+
+Python 3.10+ is required.
+
+## Create an import file
+
+Use a read-only Devolens/Cryptolens token with these permissions:
+
+- Get Products
+- Get Keys
+- Get Customers
+- License Template
+- List Data Objects
+
+```python
+from scientiveshield_tools import create_import_file
+
+result = create_import_file(
+    token="read-only-cryptolens-token",
+    product_ids=[33453, 33454],
+    output="bundle.json",
+)
+
+print(result.summary)
+```
+
+The exporter writes schema version 2 and preserves key strings. It includes key-scoped and
+machine-scoped data objects. Product selection is explicit; it never exports every product by
+accident.
+
+### Inspect products
+
+```python
+from scientiveshield_tools import list_products
+
+for product in list_products(token="..."):
+    print(product.id, product.name)
+```
+
+### Validate the file
+
+```python
+from scientiveshield_tools import validate_import_file
+
+result = validate_import_file("bundle.json")
+print(result.ok, result.errors, result.warnings)
+```
+
+### Free environment
+
+Cryptolens’ limited free environment allows one API request every 10 seconds. Use:
+
+```python
+create_import_file(..., free_tier=True)
+```
+
+The client then spaces requests proactively. On a 429 response it honors `Retry-After`, otherwise
+waits 10 seconds. A free-tier export can take a few minutes; that is expected.
+
+## CLI (optional)
+
+```bash
+python -m scientiveshield_tools list-products --token "$CRYPTOLENS_TOKEN"
+python -m scientiveshield_tools export --interactive --out bundle.json
+python -m scientiveshield_tools validate --bundle bundle.json
+```
+
+## Security
+
+- Use a **read-only** token. Never use the Cryptolens account password.
+- The token is never logged or included in the bundle.
+- The bundle contains customer secrets and license data. Share it only via a secure channel.
+- Revoke the source token after the export.
+- Do not commit `bundle.json` or tokens.
+
+## Import and cutover
+
+Upload the bundle in ScientiveShield → **Migration**. The dashboard validates it, shows a dry-run
+preview, imports through a background worker, and provides the app cutover kit.
+
+Developer guide: <https://scientiveshield.pro/migrate/developer/>
+
+## License
+
+Business Source License 1.1 with an Additional Use Grant. See [LICENSE](LICENSE). Commercial use is
+permitted for migrating your own or your clients’ software into ScientiveShield. The Licensed Work
+may not be offered as a standalone commercial product, managed service, or competing licensing
+platform. The Change Date is 2030-10-21; the Change License is Apache-2.0.

scientiveshield_tools-0.1.0/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "scientiveshield-tools"
+version = "0.1.0"
+description = "Export Devolens (Cryptolens) licensing data into a ScientiveShield import bundle."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "BUSL-1.1"
+license-files = ["LICENSE"]
+authors = [{ name = "ScientiveShield" }]
+keywords = ["licensing", "cryptolens", "devolens", "migration", "scientiveshield"]
+dependencies = ["requests>=2.31"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[project.urls]
+Homepage = "https://scientiveshield.pro/migrate/developer/"
+Documentation = "https://scientiveshield.pro/migrate/developer/"
+Repository = "https://github.com/franciscomvargas/scientiveshield-tools"
+Issues = "https://github.com/franciscomvargas/scientiveshield-tools/issues"
+
+[project.scripts]
+scientiveshield-tools = "scientiveshield_tools.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+scientiveshield_tools = ["py.typed"]

scientiveshield_tools-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

scientiveshield_tools-0.1.0/src/scientiveshield_tools/__init__.py

@@ -0,0 +1,35 @@
+"""Official ScientiveShield exporter for Devolens (Cryptolens) licensing data."""
+
+from .bundle import SCHEMA_VERSION, validate_bundle_data, validate_import_file
+from .cryptolens import (
+    DEFAULT_BASE_URL,
+    CryptolensClient,
+    create_import_file,
+    list_products,
+)
+from .errors import (
+    ConfigurationError,
+    CryptolensError,
+    ScientiveShieldToolsError,
+    ValidationError,
+)
+from .models import ExportResult, Product, ValidationResult
+
+__all__ = [
+    "ConfigurationError",
+    "CryptolensClient",
+    "CryptolensError",
+    "DEFAULT_BASE_URL",
+    "ExportResult",
+    "Product",
+    "SCHEMA_VERSION",
+    "ScientiveShieldToolsError",
+    "ValidationError",
+    "ValidationResult",
+    "create_import_file",
+    "list_products",
+    "validate_bundle_data",
+    "validate_import_file",
+]
+
+__version__ = "0.1.0"

scientiveshield_tools-0.1.0/src/scientiveshield_tools/__main__.py

@@ -0,0 +1,3 @@
+from .cli import main
+
+raise SystemExit(main())

scientiveshield_tools-0.1.0/src/scientiveshield_tools/bundle.py

@@ -0,0 +1,159 @@
+"""Bundle schema helpers and offline validation."""
+
+from __future__ import annotations
+
+import json
+import os
+from pathlib import Path
+from typing import Any
+
+from .errors import ValidationError
+from .models import ValidationResult
+
+SCHEMA_VERSION = 2
+
+
+def normalize_customer_id(value: Any) -> int | None:
+    """Cryptolens uses -1 for "no customer"; normalize it to None."""
+    if value is None:
+        return None
+    try:
+        number = int(value)
+    except (TypeError, ValueError):
+        return None
+    return number if number > 0 else None
+
+
+def normalize_machine_limit(value: Any) -> int:
+    try:
+        number = int(value or 0)
+    except (TypeError, ValueError):
+        number = 0
+    return max(0, number)
+
+
+def load_bundle(path: str | Path) -> dict[str, Any]:
+    try:
+        with open(path, encoding="utf-8") as handle:
+            data = json.load(handle)
+    except (OSError, json.JSONDecodeError) as exc:
+        raise ValidationError(f"Could not read bundle: {exc}") from exc
+    if not isinstance(data, dict):
+        raise ValidationError("The bundle root must be a JSON object.")
+    return data
+
+
+def validate_bundle_data(bundle: dict[str, Any]) -> ValidationResult:
+    errors: list[str] = []
+    warnings: list[str] = []
+
+    schema = int(bundle.get("schemaVersion") or 1)
+    if schema > SCHEMA_VERSION:
+        errors.append(f"Unsupported schema version {schema}; this tool supports up to {SCHEMA_VERSION}.")
+
+    products = bundle.get("products") or []
+    customers = bundle.get("customers") or []
+    templates = bundle.get("templates") or []
+    keys = bundle.get("keys") or []
+    if not isinstance(products, list):
+        errors.append("products must be a list.")
+        products = []
+    if not isinstance(customers, list):
+        errors.append("customers must be a list.")
+        customers = []
+    if not isinstance(templates, list):
+        errors.append("templates must be a list.")
+        templates = []
+    if not isinstance(keys, list):
+        errors.append("keys must be a list.")
+        keys = []
+
+    product_ids = {int(p.get("sourceId", 0)) for p in products if isinstance(p, dict)}
+    if len(product_ids) != len(products):
+        errors.append("Duplicate or missing product source ids.")
+    customer_ids = {int(c.get("sourceId", 0)) for c in customers if isinstance(c, dict)}
+    if len(customer_ids) != len(customers):
+        errors.append("Duplicate or missing customer source ids.")
+    template_ids = {int(t.get("sourceId", 0)) for t in templates if isinstance(t, dict)}
+    if len(template_ids) != len(templates):
+        errors.append("Duplicate or missing template source ids.")
+
+    for product in products:
+        if not isinstance(product, dict) or not str(product.get("name") or "").strip():
+            errors.append("A product has no name.")
+            break
+
+    for template in templates:
+        if not isinstance(template, dict):
+            errors.append("A template is not an object.")
+            continue
+        source_product = template.get("sourceProductId")
+        if source_product not in product_ids:
+            errors.append(f"Template {template.get('sourceId')} references unknown product {source_product}.")
+        if not str(template.get("name") or "").strip():
+            errors.append(f"Template {template.get('sourceId')} has no name.")
+
+    seen_keys: set[tuple[int, str]] = set()
+    activation_count = 0
+    data_object_count = 0
+    for key in keys:
+        if not isinstance(key, dict):
+            errors.append("A license is not an object.")
+            continue
+        source_product = key.get("sourceProductId")
+        normalized = str(key.get("key") or "").strip().upper()
+        if not normalized:
+            errors.append(f"License in product {source_product} has no key string.")
+        elif len(normalized) > 32:
+            errors.append(f"License {normalized} is longer than 32 characters.")
+        elif (source_product, normalized) in seen_keys:
+            errors.append(f"Duplicate license {normalized} in product {source_product}.")
+        seen_keys.add((source_product, normalized))
+        if source_product not in product_ids:
+            errors.append(f"License {normalized} references unknown product {source_product}.")
+        customer_id = normalize_customer_id(key.get("sourceCustomerId"))
+        if customer_id is not None and customer_id not in customer_ids:
+            errors.append(f"License {normalized} references unknown customer {customer_id}.")
+        if int(key.get("maxNoOfMachines") or 0) < 0:
+            warnings.append(f"License {normalized} has a negative machine limit; treating it as unlimited.")
+        activations = key.get("activations") or []
+        if isinstance(activations, list):
+            activation_count += len(activations)
+        data_objects = key.get("dataObjects") or []
+        if isinstance(data_objects, list):
+            data_object_count += len(data_objects)
+
+    counts = {
+        "products": len(products),
+        "customers": len(customers),
+        "templates": len(templates),
+        "keys": len(keys),
+        "activations": activation_count,
+        "dataObjects": data_object_count,
+    }
+    return ValidationResult(ok=not errors, errors=errors, warnings=warnings, counts=counts)
+
+
+def validate_import_file(path: str | Path) -> ValidationResult:
+    return validate_bundle_data(load_bundle(path))
+
+
+def write_bundle(path: str | Path, bundle: dict[str, Any]) -> Path:
+    target = Path(path).expanduser()
+    target.parent.mkdir(parents=True, exist_ok=True)
+    text = json.dumps(bundle, indent=2) + "\n"
+    # The bundle contains customer secrets and license keys. Create it owner-only on POSIX.
+    if os.name == "posix":
+        fd = os.open(target, os.O_WRONLY | os.O_CREAT | os.O_TRUNC, 0o600)
+        try:
+            with os.fdopen(fd, "w", encoding="utf-8") as handle:
+                handle.write(text)
+        except Exception:
+            try:
+                os.close(fd)
+            except OSError:
+                pass
+            raise
+    else:
+        target.write_text(text, encoding="utf-8")
+    return target