Files
sigma-rules/detection_rules/schemas/registry_package.py
T
Sergey Polzunov 1fb60d6475 fix: type hinting fixes and additional code checks (#4790)
* first pass

* Adding a dedicated code checking workflow

* Type fixes

* linting config and python version bump

* Type hints

* Drop incorrect config option

* More fixes

* Style fixes

* CI adjustments

* Pyproject fixes

* CI & pyproject fixes

* Proper version bump

* Tests formatting

* Resolve cirtular dependency

* Test fixes

* Make sure the tests are formatted correctly

* Check tweaks

* Bumping python version in CI images

* Pin marshmallow do 3.x because 4.x is not supported

* License fix

* Convert path to str

* Making myself a codeowner

* Missing kwargs param

* Adding a missing kwargs to `set_score`

* Update .github/CODEOWNERS

Co-authored-by: Mika Ayenson, PhD <Mikaayenson@users.noreply.github.com>

* Dropping unnecessary raise

* Dropping skipped test

* Drop unnecessary var

* Drop unused commented-out func

* Disable typehinting for the whole func

* Update linting command

* Invalid type hist on the input param

* Incorrect field type

* Incorrect value used fix

* Stricter values check

* Simpler function call

* Type condition fix

* TOML formatter fix

* Simpligy output conditions

* Formatting

* Use proper types instead of aliases

* MITRE attack fixes

* Using pathlib.Path for an argument

* Use proper method to update a set from a dict

* First round of `ruff` fixes

* More fixes

* More fixes

* Hack against cyclic dependency

* Ignore `PLC0415`

* Remove unused markers

* Cleanup

* Fixing the incorrect condition

* Update .github/CODEOWNERS

Co-authored-by: Mika Ayenson, PhD <Mikaayenson@users.noreply.github.com>

* Set explicit default values for optional fields

* Update the guidelines

* Adding None Defaults

---------

Co-authored-by: Mika Ayenson, PhD <Mikaayenson@users.noreply.github.com>
Co-authored-by: eric-forte-elastic <eric.forte@elastic.co>
2025-07-01 08:20:55 -05:00

67 lines
1.5 KiB
Python

# Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
# or more contributor license agreements. Licensed under the Elastic License
# 2.0; you may not use this file except in compliance with the Elastic License
# 2.0.
"""Definitions for packages destined for the registry."""
from dataclasses import dataclass, field
from detection_rules.mixins import MarshmallowDataclassMixin
from detection_rules.schemas.definitions import ConditionSemVer, SemVer
@dataclass
class ConditionElastic:
subscription: str
capabilities: list[str] | None
@dataclass
class Condition:
kibana_version: str = field(metadata={"data_key": "kibana.version"})
elastic: ConditionElastic
@dataclass
class Icon:
size: str
src: str
type: str
@dataclass
class RegistryPackageManifestBase(MarshmallowDataclassMixin):
"""Base class for registry packages."""
categories: list[str]
description: str
format_version: SemVer
icons: list[Icon]
name: str
owner: dict[str, str]
title: str
type: str
version: SemVer
internal: bool | None
policy_templates: list[str] | None
screenshots: list[str] | None
@dataclass
class RegistryPackageManifestV1(RegistryPackageManifestBase):
"""Registry packages using elastic-package v1."""
conditions: dict[str, ConditionSemVer]
license: str
release: str
@dataclass
class RegistryPackageManifestV3(RegistryPackageManifestBase):
"""Registry packages using elastic-package v3."""
conditions: Condition
source: dict[str, str]