fluidattacks_core_models 12.0.0__tar.gz

fluidattacks_core_models-12.0.0/.envrc

@@ -0,0 +1 @@
+use_flake ".#python311.devShell"

fluidattacks_core_models-12.0.0/.gitignore

@@ -0,0 +1,5 @@
+target/
+.direnv/
+.venv/
+.vscode/settings.json
+.zed/settings.json

fluidattacks_core_models-12.0.0/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.5
+Name: fluidattacks_core_models
+Version: 12.0.0
+Summary: Fluid Attacks Core Models Library
+Author-email: Development <development@fluidattacks.com>
+License: MPL-2.0
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.11
+Requires-Dist: pydantic>=2.12.3
+Requires-Dist: pyyaml>=6.0.2

fluidattacks_core_models-12.0.0/build/default.nix

@@ -0,0 +1,19 @@
+{ src, workspace_root }:
+{
+  inherit src workspace_root;
+  root_path = "develops/fluidattacks-core/python/models";
+  module_name = "fluidattacks_core";
+  pypi_token = {
+    method = "oidc";
+  };
+  override = {
+    checks = {
+      basedpyright = false;
+    };
+    configs = {
+      import_linter = ../import-linter.cfg;
+      mypy = ../mypy.ini;
+      ruff = ../ruff.toml;
+    };
+  };
+}

fluidattacks_core_models-12.0.0/build/filter.nix

@@ -0,0 +1,13 @@
+path_filter: src:
+path_filter {
+  root = src;
+  include = [
+    "fluidattacks_core"
+    "tests"
+    "import-linter.cfg"
+    "mypy.ini"
+    "pyproject.toml"
+    "ruff.toml"
+    "uv.lock"
+  ];
+}

fluidattacks_core_models-12.0.0/flake.lock

@@ -0,0 +1,303 @@
+{
+  "nodes": {
+    "flake-parts": {
+      "inputs": {
+        "nixpkgs-lib": "nixpkgs-lib"
+      },
+      "locked": {
+        "lastModified": 1762810396,
+        "narHash": "sha256-dxFVgQPG+R72dkhXTtqUm7KpxElw3u6E+YlQ2WaDgt8=",
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "rev": "0bdadb1b265fb4143a75bd1ec7d8c915898a9923",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "type": "github"
+      }
+    },
+    "nix_filter": {
+      "locked": {
+        "lastModified": 1757882181,
+        "narHash": "sha256-+cCxYIh2UNalTz364p+QYmWHs0P+6wDhiWR4jDIKQIU=",
+        "owner": "numtide",
+        "repo": "nix-filter",
+        "rev": "59c44d1909c72441144b93cf0f054be7fe764de5",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "nix-filter",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1758690382,
+        "narHash": "sha256-NY3kSorgqE5LMm1LqNwGne3ZLMF2/ILgLpFr1fS4X3o=",
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "rev": "e643668fd71b949c53f8626614b21ff71a07379d",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nixos",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs-lib": {
+      "locked": {
+        "lastModified": 1761765539,
+        "narHash": "sha256-b0yj6kfvO8ApcSE+QmA6mUfu8IYG6/uU28OFn4PaC8M=",
+        "owner": "nix-community",
+        "repo": "nixpkgs.lib",
+        "rev": "719359f4562934ae99f5443f20aa06c2ffff91fc",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-community",
+        "repo": "nixpkgs.lib",
+        "type": "github"
+      }
+    },
+    "nixpkgs_2": {
+      "locked": {
+        "lastModified": 1758690382,
+        "narHash": "sha256-NY3kSorgqE5LMm1LqNwGne3ZLMF2/ILgLpFr1fS4X3o=",
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "rev": "e643668fd71b949c53f8626614b21ff71a07379d",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nixos",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs_3": {
+      "locked": {
+        "lastModified": 1761373498,
+        "narHash": "sha256-Q/uhWNvd7V7k1H1ZPMy/vkx3F8C13ZcdrKjO7Jv7v0c=",
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "rev": "6a08e6bb4e46ff7fcbb53d409b253f6bad8a28ce",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nixos",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs_flake": {
+      "locked": {
+        "lastModified": 1778253243,
+        "narHash": "sha256-KkH2QvU6iRLDTGGEwH5jnMqHWj4zMTuHxi1S1zdr01w=",
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "rev": "4fcda7103530b23c5ca44286344912082aad4220",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "pyproject-build-systems": {
+      "inputs": {
+        "nixpkgs": "nixpkgs",
+        "pyproject-nix": "pyproject-nix",
+        "uv2nix": "uv2nix"
+      },
+      "locked": {
+        "lastModified": 1761781027,
+        "narHash": "sha256-YDvxPAm2WnxrznRqWwHLjryBGG5Ey1ATEJXrON+TWt8=",
+        "owner": "pyproject-nix",
+        "repo": "build-system-pkgs",
+        "rev": "795a980d25301e5133eca37adae37283ec3c8e66",
+        "type": "github"
+      },
+      "original": {
+        "owner": "pyproject-nix",
+        "repo": "build-system-pkgs",
+        "type": "github"
+      }
+    },
+    "pyproject-nix": {
+      "inputs": {
+        "nixpkgs": [
+          "python_builder",
+          "pyproject-build-systems",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1758265079,
+        "narHash": "sha256-amLaLNwKSZPShQHzfgmc/9o76dU8xzN0743dWgvYlr8=",
+        "owner": "nix-community",
+        "repo": "pyproject.nix",
+        "rev": "02e9418fd4af638447dca4b17b1280da95527fc9",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-community",
+        "repo": "pyproject.nix",
+        "type": "github"
+      }
+    },
+    "pyproject-nix_2": {
+      "inputs": {
+        "nixpkgs": "nixpkgs_2"
+      },
+      "locked": {
+        "lastModified": 1762427963,
+        "narHash": "sha256-CkPlAbIQ87wmjy5qHibfzk4DmMGBNqFer+lLfXjpP5M=",
+        "owner": "pyproject-nix",
+        "repo": "pyproject.nix",
+        "rev": "4540ea004e04fcd12dd2738d51383d10f956f7b9",
+        "type": "github"
+      },
+      "original": {
+        "owner": "pyproject-nix",
+        "repo": "pyproject.nix",
+        "type": "github"
+      }
+    },
+    "pyproject-nix_3": {
+      "inputs": {
+        "nixpkgs": [
+          "python_builder",
+          "uv2nix",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1760402624,
+        "narHash": "sha256-jF6UKLs2uGc2rtved8Vrt58oTWjTQoAssuYs/0578Z4=",
+        "owner": "pyproject-nix",
+        "repo": "pyproject.nix",
+        "rev": "84c4ea102127c77058ea1ed7be7300261fafc7d2",
+        "type": "github"
+      },
+      "original": {
+        "owner": "pyproject-nix",
+        "repo": "pyproject.nix",
+        "type": "github"
+      }
+    },
+    "python_builder": {
+      "inputs": {
+        "nix_filter": "nix_filter",
+        "nixpkgs_flake": "nixpkgs_flake",
+        "pyproject-build-systems": "pyproject-build-systems",
+        "pyproject-nix": "pyproject-nix_2",
+        "shell-helpers": "shell-helpers",
+        "uv2nix": "uv2nix_2"
+      },
+      "locked": {
+        "dir": "common/utils/python-builder",
+        "lastModified": 1787078362,
+        "narHash": "sha256-HYL7Rn6SuNjYxkt/PwFLksZjsauCiY+ENbOWryLsIlw=",
+        "ref": "refs/heads/trunk",
+        "rev": "09fd25a13309eb5e3b5b2a061bb340df3ae5d281",
+        "shallow": true,
+        "type": "git",
+        "url": "ssh://git@gitlab.com/fluidattacks/universe"
+      },
+      "original": {
+        "dir": "common/utils/python-builder",
+        "rev": "09fd25a13309eb5e3b5b2a061bb340df3ae5d281",
+        "shallow": true,
+        "type": "git",
+        "url": "ssh://git@gitlab.com/fluidattacks/universe"
+      }
+    },
+    "root": {
+      "inputs": {
+        "python_builder": "python_builder"
+      }
+    },
+    "shell-helpers": {
+      "inputs": {
+        "flake-parts": "flake-parts",
+        "nixpkgs": [
+          "python_builder",
+          "nixpkgs_flake"
+        ]
+      },
+      "locked": {
+        "dir": "common/utils/shell-helpers",
+        "lastModified": 1762806066,
+        "narHash": "sha256-Wz99Fl7SpPU1NkTHJ36XOo6DjOEAMXCw3ThRABOS2Hs=",
+        "ref": "refs/heads/trunk",
+        "rev": "d73cfdc7ae9e7f547e22a4481d4c2ccce38b26a8",
+        "shallow": true,
+        "type": "git",
+        "url": "ssh://git@gitlab.com/fluidattacks/universe"
+      },
+      "original": {
+        "dir": "common/utils/shell-helpers",
+        "rev": "d73cfdc7ae9e7f547e22a4481d4c2ccce38b26a8",
+        "shallow": true,
+        "type": "git",
+        "url": "ssh://git@gitlab.com/fluidattacks/universe"
+      }
+    },
+    "uv2nix": {
+      "inputs": {
+        "nixpkgs": [
+          "python_builder",
+          "pyproject-build-systems",
+          "nixpkgs"
+        ],
+        "pyproject-nix": [
+          "python_builder",
+          "pyproject-build-systems",
+          "pyproject-nix"
+        ]
+      },
+      "locked": {
+        "lastModified": 1758933732,
+        "narHash": "sha256-HAmm1GBS1myZCFuog0DC2ZLaynvZtiUI2Crmo+cdQI0=",
+        "owner": "pyproject-nix",
+        "repo": "uv2nix",
+        "rev": "273ce18f913d8559e0d04f820d724308966d7c4d",
+        "type": "github"
+      },
+      "original": {
+        "owner": "pyproject-nix",
+        "repo": "uv2nix",
+        "type": "github"
+      }
+    },
+    "uv2nix_2": {
+      "inputs": {
+        "nixpkgs": "nixpkgs_3",
+        "pyproject-nix": "pyproject-nix_3"
+      },
+      "locked": {
+        "lastModified": 1761872265,
+        "narHash": "sha256-i25GRgp2vUOebY70L3NTAgkd+Pr1hnn5xM3qHxH0ONU=",
+        "owner": "pyproject-nix",
+        "repo": "uv2nix",
+        "rev": "74dfb62871be152ad3673b143b0cc56105a4f3c5",
+        "type": "github"
+      },
+      "original": {
+        "owner": "pyproject-nix",
+        "repo": "uv2nix",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

fluidattacks_core_models-12.0.0/flake.nix

@@ -0,0 +1,29 @@
+{
+  description = "Fluid Attacks Core models package.";
+
+  inputs = {
+    python_builder = {
+      url = "git+ssh://git@gitlab.com/fluidattacks/universe?shallow=1&rev=09fd25a13309eb5e3b5b2a061bb340df3ae5d281&dir=common/utils/python-builder";
+    };
+  };
+
+  outputs =
+    { self, ... }@inputs:
+    let
+      build_args =
+        {
+          system,
+          python_version,
+          nixpkgs,
+          builders,
+          scripts,
+        }:
+        import ./build {
+          src = import ./build/filter.nix nixpkgs.nix-filter self;
+          workspace_root = ./.;
+        };
+    in
+    {
+      packages = inputs.python_builder.outputs.build build_args;
+    };
+}

fluidattacks_core_models-12.0.0/fluidattacks_core/models/scanners/__init__.py

@@ -0,0 +1,67 @@
+from fluidattacks_core.models.scanners.apk_config import ApkConfig, ApkEnvironment
+from fluidattacks_core.models.scanners.common_config import (
+    FalsePositivesConfig,
+    LocalesEnum,
+    OutputConfig,
+    OutputFormat,
+)
+from fluidattacks_core.models.scanners.containers_sca_config import (
+    ContainerImageConfig,
+    ContainerScaItem,
+    ContainersScaConfig,
+    DockerCredentialsConfig,
+    EcrCredentialsConfig,
+)
+from fluidattacks_core.models.scanners.cspm_config import AwsCredentials, AwsRole, CspmConfig
+from fluidattacks_core.models.scanners.dast_config import (
+    DastApiAuth,
+    DastApiConfig,
+    DastConfig,
+    DastUrl,
+)
+from fluidattacks_core.models.scanners.loader import build_config, load_yaml_mapping
+from fluidattacks_core.models.scanners.sast_config import SastConfig
+from fluidattacks_core.models.scanners.sbom_config import (
+    SbomAwsCredentials,
+    SbomConfig,
+    SbomDockerCredentials,
+    SbomOutputConfig,
+    SbomPlatformOverrides,
+    SourceType,
+)
+from fluidattacks_core.models.scanners.sca_config import ScaConfig
+from fluidattacks_core.models.scanners.scan_config import ScanConfig
+from fluidattacks_core.models.scanners.sniffs_config import SniffsConfig
+
+__all__ = [
+    "ApkConfig",
+    "ApkEnvironment",
+    "AwsCredentials",
+    "AwsRole",
+    "ContainerImageConfig",
+    "ContainerScaItem",
+    "ContainersScaConfig",
+    "CspmConfig",
+    "DastApiAuth",
+    "DastApiConfig",
+    "DastConfig",
+    "DastUrl",
+    "DockerCredentialsConfig",
+    "EcrCredentialsConfig",
+    "FalsePositivesConfig",
+    "LocalesEnum",
+    "OutputConfig",
+    "OutputFormat",
+    "SastConfig",
+    "SbomAwsCredentials",
+    "SbomConfig",
+    "SbomDockerCredentials",
+    "SbomOutputConfig",
+    "SbomPlatformOverrides",
+    "ScaConfig",
+    "ScanConfig",
+    "SniffsConfig",
+    "SourceType",
+    "build_config",
+    "load_yaml_mapping",
+]

fluidattacks_core_models-12.0.0/fluidattacks_core/models/scanners/apk_config.py

@@ -0,0 +1,26 @@
+from pydantic import BaseModel, StrictBool
+
+
+class ApkEnvironment(BaseModel):
+    model_config = {"extra": "forbid"}
+    apk_file_path: str
+    environment_id: str | None = None
+
+    def __eq__(self, other: object) -> bool:
+        """Compare only on apk_file_path, ignoring environment_id."""
+        if not isinstance(other, ApkEnvironment):
+            return NotImplemented
+        return self.apk_file_path == other.apk_file_path
+
+    def __hash__(self) -> int:
+        """Hash only on apk_file_path, ignoring environment_id."""
+        return hash(self.apk_file_path)
+
+
+class ApkConfig(BaseModel):
+    model_config = {"extra": "forbid"}
+    include: list[str] = []
+    exclude: list[str] = []
+    use_sast_analysis: StrictBool = True
+    environments: list[ApkEnvironment] | None = None
+    feature_preview: StrictBool | None = None

fluidattacks_core_models-12.0.0/fluidattacks_core/models/scanners/common_config.py

@@ -0,0 +1,27 @@
+from enum import Enum
+
+from pydantic import BaseModel
+
+
+class LocalesEnum(Enum):
+    EN = "EN"
+    ES = "ES"
+
+
+class OutputFormat(Enum):
+    CSV = "CSV"
+    SARIF = "SARIF"
+    ALL = "ALL"
+
+
+class OutputConfig(BaseModel):
+    model_config = {"extra": "forbid"}
+    file_path: str
+    format: OutputFormat
+
+
+class FalsePositivesConfig(BaseModel):
+    model_config = {"extra": "forbid"}
+    findings: list[str] = []
+    method_names: list[str] = []
+    cve: list[str] = []

fluidattacks_core_models-12.0.0/fluidattacks_core/models/scanners/containers_sca_config.py

@@ -0,0 +1,37 @@
+from pydantic import BaseModel, StrictBool
+
+
+class EcrCredentialsConfig(BaseModel):
+    model_config = {"extra": "allow"}
+    access_key_id: str | None = None
+    secret_access_key: str | None = None
+    session_token: str | None = None
+    role_arn: str | None = None
+    external_id: str | None = None
+    aws_region: str | None = None
+
+
+class DockerCredentialsConfig(BaseModel):
+    model_config = {"extra": "allow"}
+    docker_username: str
+    docker_password: str
+
+
+class ContainerImageConfig(BaseModel):
+    model_config = {"extra": "allow"}
+    use_docker_daemon: StrictBool | None = None
+    os_override: str | None = None
+    arch_override: str | None = None
+    ecr_credentials: EcrCredentialsConfig | None = None
+    docker_credentials: DockerCredentialsConfig | None = None
+
+
+class ContainerScaItem(BaseModel):
+    model_config = {"extra": "allow"}
+    image_uri: str
+    image_config: ContainerImageConfig | None = None
+
+
+class ContainersScaConfig(BaseModel):
+    model_config = {"extra": "allow"}
+    images: list[ContainerScaItem]

fluidattacks_core_models-12.0.0/fluidattacks_core/models/scanners/cspm_config.py

@@ -0,0 +1,45 @@
+from pydantic import BaseModel, Field, StrictBool, field_validator, model_validator
+
+from fluidattacks_core.models.scanners.loader import LoaderValidationInfo, resolve_env_var
+
+
+class AwsCredentials(BaseModel):
+    model_config = {"extra": "forbid"}
+    access_key_id: str
+    secret_access_key: str
+    session_token: str | None = None
+    environment_id: str | None = None
+
+    @field_validator("access_key_id", "secret_access_key", "session_token", mode="before")
+    @classmethod
+    def _resolve_credentials(cls, v: object, info: LoaderValidationInfo) -> object:
+        return resolve_env_var(v, info)
+
+    @model_validator(mode="after")
+    def _validate_key_session_token_pairing(self) -> "AwsCredentials":
+        is_temporary = self.access_key_id.startswith("ASIA")
+        if is_temporary and not self.session_token:
+            msg = "Temporary credentials (ASIA key) require a session_token"
+            raise ValueError(msg)
+        if not is_temporary and self.session_token:
+            msg = "Static credentials (AKIA key) must not include a session_token"
+            raise ValueError(msg)
+        return self
+
+
+class AwsRole(BaseModel):
+    model_config = {"extra": "forbid"}
+    role: str = Field(repr=False)
+    external_id: str | None = Field(default=None, repr=False)
+    environment_id: str | None = None
+
+    @field_validator("role", "external_id", mode="before")
+    @classmethod
+    def _resolve_credentials(cls, v: object, info: LoaderValidationInfo) -> object:
+        return resolve_env_var(v, info)
+
+
+class CspmConfig(BaseModel):
+    model_config = {"extra": "forbid"}
+    aws_credentials: list[AwsCredentials | AwsRole] = []
+    feature_preview: StrictBool | None = None

fluidattacks_core_models-12.0.0/fluidattacks_core/models/scanners/dast_config.py

@@ -0,0 +1,47 @@
+from pydantic import BaseModel, StrictBool, field_validator
+
+from fluidattacks_core.models.scanners.loader import LoaderValidationInfo, resolve_env_var
+
+
+class DastUrl(BaseModel):
+    model_config = {"extra": "forbid"}
+    url: str
+    environment_id: str | None = None
+
+    def __eq__(self, other: object) -> bool:
+        """Compare only on url, ignoring environment_id."""
+        if not isinstance(other, DastUrl):
+            return NotImplemented
+        return self.url == other.url
+
+    def __hash__(self) -> int:
+        """Hash only on url, ignoring environment_id."""
+        return hash(self.url)
+
+
+class DastApiAuth(BaseModel):
+    model_config = {"extra": "forbid"}
+    type: str
+    key: str
+    value: str
+
+    @field_validator("key", "value", mode="before")
+    @classmethod
+    def _resolve_credentials(cls, v: object, info: LoaderValidationInfo) -> object:
+        return resolve_env_var(v, info)
+
+
+class DastApiConfig(BaseModel):
+    model_config = {"extra": "forbid"}
+    base_url: str
+    api_specs: list[str]
+    authentication: list[DastApiAuth] = []
+    environment_id: str | None = None
+
+
+class DastConfig(BaseModel):
+    model_config = {"extra": "forbid"}
+    urls: list[DastUrl] = []
+    api: list[DastApiConfig] = []
+    feature_preview: StrictBool | None = None
+    strict_connectivity: StrictBool = False