acex-devkit 2.1.1__tar.gz → 2.2.1__tar.gz

{acex_devkit-2.1.1 → acex_devkit-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: acex-devkit
-Version: 2.1.1
+Version: 2.2.1
 Summary: ACE-X DevKit - Development kit for building ACE-X drivers and plugins
 License: AGPL-3.0
 Keywords: automation,devkit,sdk,drivers,plugins

{acex_devkit-2.1.1 → acex_devkit-2.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "acex-devkit"
-version = "2.1.1"
+version = "2.2.1"
 description = "ACE-X DevKit - Development kit for building ACE-X drivers and plugins"
 authors = ["Johan Lahti <johan.lahti@acebit.se>"]
 readme = "README.md"

acex_devkit-2.2.1/src/acex_devkit/models/credential.py

@@ -0,0 +1,104 @@
+from enum import StrEnum
+
+from pydantic import BaseModel, model_validator
+
+from acex_devkit.models.base import PersistedResponse
+
+
+class SnmpAuthProtocol(StrEnum):
+    """SNMPv3 authentication protocols, in Telegraf's vocabulary."""
+
+    MD5 = "MD5"
+    SHA = "SHA"
+    SHA224 = "SHA224"
+    SHA256 = "SHA256"
+    SHA384 = "SHA384"
+    SHA512 = "SHA512"
+
+
+class SnmpPrivProtocol(StrEnum):
+    """SNMPv3 privacy protocols, in Telegraf's vocabulary."""
+
+    DES = "DES"
+    AES = "AES"
+    AES192 = "AES192"
+    AES192C = "AES192C"
+    AES256 = "AES256"
+    AES256C = "AES256C"
+
+
+# Per-credential-type enum constraints on field values, keyed by field name.
+CREDENTIAL_FIELD_ENUMS: dict[str, dict[str, type[StrEnum]]] = {
+    "snmpv3": {
+        "auth_protocol": SnmpAuthProtocol,
+        "priv_protocol": SnmpPrivProtocol,
+    },
+}
+
+
+def _validate_field_enums(credential_type: str, fields: dict[str, str]) -> None:
+    constraints = CREDENTIAL_FIELD_ENUMS.get(credential_type, {})
+    for field_name, enum_cls in constraints.items():
+        value = fields.get(field_name)
+        if value is None or value == "":
+            continue
+        try:
+            enum_cls(value)
+        except ValueError:
+            valid = ", ".join(e.value for e in enum_cls)
+            raise ValueError(
+                f"Invalid {field_name} '{value}' for credential type '{credential_type}'. Valid: {valid}"
+            ) from None
+
+
+class CredentialFieldBase(BaseModel):
+    field_name: str
+    sensitive: bool = True
+
+
+class CredentialBase(BaseModel):
+    name: str
+    credential_type: str
+    source: str = "local"
+    vault_path: str | None = None
+
+
+class CredentialFieldResponse(CredentialFieldBase):
+    field_value: str | None = None
+
+
+class CredentialResponse(PersistedResponse, CredentialBase):
+    fields: list[CredentialFieldResponse] = []
+
+
+class CredentialCreate(CredentialBase):
+    fields: dict[str, str]
+
+    @model_validator(mode="after")
+    def _check_field_values(self):
+        _validate_field_enums(self.credential_type, self.fields)
+        return self
+
+
+class CredentialUpdate(BaseModel):
+    name: str | None = None
+    source: str | None = None
+    vault_path: str | None = None
+    fields: dict[str, str] | None = None
+
+
+class CredentialSecret(BaseModel):
+    id: int
+    credential_type: str
+    fields: dict[str, str] = {}
+
+
+class NodeCredentialCreate(BaseModel):
+    credential_id: int
+
+
+class NodeCredentialResponse(PersistedResponse):
+    node_id: int
+    credential_id: int
+    credential_name: str | None = None
+    credential_type: str | None = None

{acex_devkit-2.1.1 → acex_devkit-2.2.1}/src/acex_devkit/models/telemetry_agent.py

@@ -12,6 +12,18 @@ class InfluxDBVersion(StrEnum):
     v3 = "v3"
 
 
+class SnmpVersion(StrEnum):
+    v2c = "2c"
+    v3 = "3"
+    both = "both"
+
+
+class SnmpSecLevel(StrEnum):
+    no_auth_no_priv = "noAuthNoPriv"
+    auth_no_priv = "authNoPriv"
+    auth_priv = "authPriv"
+
+
 class OutputDestinationBase(BaseModel):
     influxdb_version: InfluxDBVersion = InfluxDBVersion.v2
     url: str = "http://localhost:8086"
@@ -62,6 +74,18 @@ class TelemetryAgentMatchRuleCreate(TelemetryAgentMatchRuleBase):
 class TelemetryAgentBase(BaseModel):
     name: str
     description: str | None = None
+    snmp_version: SnmpVersion = SnmpVersion.v2c
+    snmp_trap_port: int = 162
+    syslog_port: int = 514
+    snmpv3_sec_level: SnmpSecLevel | None = None
+    # Inline security name — only used with noAuthNoPriv (no credential needed).
+    # With authNoPriv/authPriv the username comes from the mapped credential.
+    snmpv3_sec_name: str | None = None
+    # References to Credentials holding trap receiver secrets.
+    # snmpv2c_credential_id → credential of type "snmp_community" (field: community)
+    # snmpv3_credential_id → credential of type "snmpv3" (fields: username/auth_*/priv_*)
+    snmpv2c_credential_id: int | None = None
+    snmpv3_credential_id: int | None = None
 
 
 class TelemetryAgentCreate(TelemetryAgentBase):
@@ -72,6 +96,13 @@ class TelemetryAgentUpdate(BaseModel):
     name: str | None = None
     description: str | None = None
     capabilities: list[TelemetryCapability] | None = None
+    snmp_version: SnmpVersion | None = None
+    snmp_trap_port: int | None = None
+    syslog_port: int | None = None
+    snmpv3_sec_level: SnmpSecLevel | None = None
+    snmpv3_sec_name: str | None = None
+    snmpv2c_credential_id: int | None = None
+    snmpv3_credential_id: int | None = None
 
 
 class TelemetryAgentAck(BaseModel):
@@ -88,3 +119,22 @@ class TelemetryAgentResponse(PersistedResponse, TelemetryAgentBase):
     rules: list[TelemetryAgentMatchRuleResponse] = []
     resolved_nodes: list[int] = []
     outputs: list[OutputDestinationResponse] = []
+
+
+__all__ = [
+    "InfluxDBVersion",
+    "OutputDestinationBase",
+    "OutputDestinationCreate",
+    "OutputDestinationResponse",
+    "OutputDestinationUpdate",
+    "SnmpSecLevel",
+    "SnmpVersion",
+    "TelemetryAgentAck",
+    "TelemetryAgentBase",
+    "TelemetryAgentCreate",
+    "TelemetryAgentMatchRuleBase",
+    "TelemetryAgentMatchRuleCreate",
+    "TelemetryAgentMatchRuleResponse",
+    "TelemetryAgentResponse",
+    "TelemetryAgentUpdate",
+]

acex_devkit-2.1.1/src/acex_devkit/models/credential.py

@@ -1,51 +0,0 @@
-from pydantic import BaseModel
-
-from acex_devkit.models.base import PersistedResponse
-
-
-class CredentialFieldBase(BaseModel):
-    field_name: str
-    sensitive: bool = True
-
-
-class CredentialBase(BaseModel):
-    name: str
-    credential_type: str
-    source: str = "local"
-    vault_path: str | None = None
-
-
-class CredentialFieldResponse(CredentialFieldBase):
-    field_value: str | None = None
-
-
-class CredentialResponse(PersistedResponse, CredentialBase):
-    fields: list[CredentialFieldResponse] = []
-
-
-class CredentialCreate(CredentialBase):
-    fields: dict[str, str]
-
-
-class CredentialUpdate(BaseModel):
-    name: str | None = None
-    source: str | None = None
-    vault_path: str | None = None
-    fields: dict[str, str] | None = None
-
-
-class CredentialSecret(BaseModel):
-    id: int
-    credential_type: str
-    fields: dict[str, str] = {}
-
-
-class NodeCredentialCreate(BaseModel):
-    credential_id: int
-
-
-class NodeCredentialResponse(PersistedResponse):
-    node_id: int
-    credential_id: int
-    credential_name: str | None = None
-    credential_type: str | None = None