Protocol Types¶
configuration for KEI-protocol-Integration.
Definiert welche protocole enabled are and theen specific Endpunkte. Ermöglicht automatische protocol-Auswahl and Fallback-Mechatismen.
Attributes:
Name | Type | Description |
---|---|---|
rpc_enabled | bool | Enabled KEI-RPC protocol |
stream_enabled | bool | Enabled KEI-Stream protocol |
bus_enabled | bool | Enabled KEI-Bus protocol |
mcp_enabled | bool | Enabled KEI-MCP protocol |
rpc_endpoint | str | API-Endpunkt for RPC operationen |
stream_endpoint | str | WebSocket-Endpunkt for Streaming |
bus_endpoint | str | API-Endpunkt for Message-Bus |
mcp_endpoint | str | API-Endpunkt for MCP-Integration |
auto_protocol_selection | bool | Automatische protocol-Auswahl aktivieren |
protocol_fallback_enabled | bool | Fallback on atthee protocole on errorn |
Functions¶
get_enabled_protocols()
¶
Gibt lis the enablethe protocole torück.
Returns:
Type | Description |
---|---|
list[Protocoltypee] | lis the enablethe Protocoltypee Enums |
Source code in kei_agent/protocol_types.py
is_protocol_enabled(protocol)
¶
Checks ob a specifics protocol enabled is.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
protocol | Protocoltypee | protocol to check | required |
Returns:
Type | Description |
---|---|
bool | True if protocol enabled is |
Source code in kei_agent/protocol_types.py
get_endpoint(protocol)
¶
Gibt Endpunkt for specifics protocol torück.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
protocol | Protocoltypee | protocol for the the Endpunkt benötigt is | required |
Returns:
Type | Description |
---|---|
str | API-Endpunkt for the protocol |
Raises:
Type | Description |
---|---|
ValueError | If protocol not supported is |
Source code in kei_agent/protocol_types.py
security configuration for KEI-Agent.
Definiert authentication, Authorization and securitys-Features for the KEI-Agent SDK.
Attributes:
Name | Type | Description |
---|---|---|
auth_type | Authtypee | type the authentication |
api_token | Optional[str] | Bearer Token for API-authentication |
oidc_issuer | Optional[str] | OIDC Ithetity Provithe URL |
oidc_client_id | Optional[str] | OIDC client-ID |
oidc_client_secret | Optional[str] | OIDC client-Secret |
oidc_scope | str | OIDC Scopes for Token-Request |
mtls_cert_path | Optional[str] | Path tom client-Zertifikat for mTLS |
mtls_key_path | Optional[str] | Path tom Private Key for mTLS |
mtls_ca_path | Optional[str] | Path tor Certificate Authority for mTLS |
tls_verify | bool | TLS-Zertifikatsprüfung aktivieren/deaktivieren |
tls_ca_bundle | Optional[str] | Pfad to benutzerdefiniertem CA-Bundle |
tls_pinned_sha256 | Optional[str] | SHA-256 Fingerprint for Zertifikat-Pinning |
rbac_enabled | bool | Role-Based Access Control aktivieren |
audit_enabled | bool | Audit-Logging aktivieren |
token_refresh_enabled | bool | Automatische Token-Erneuerung aktivieren |
token_cache_ttl | int | Token-Cache Time-To-Live in Sekatthe |
Functions¶
validate()
¶
Validates the security configuration using Pydantic models.
Raises:
Type | Description |
---|---|
ValidationError | On ungültiger configuration |
Source code in kei_agent/protocol_types.py
is_token_based()
¶
Checks ob Token-basierte authentication verwendet is.
Returns:
Type | Description |
---|---|
bool | True if Bearer or OIDC verwendet is |
AgentClientConfig¶
Basis-Konfiguration für den KEI-Agent Client.
ProtocolConfig¶
Konfiguration für Protokoll-spezifische Einstellungen.
@dataclass
class ProtocolConfig:
rpc_enabled: bool = True
stream_enabled: bool = True
bus_enabled: bool = True
mcp_enabled: bool = True
SecurityConfig¶
Sicherheitskonfiguration für Authentifizierung und Autorisierung.
@dataclass
class SecurityConfig:
auth_type: AuthType
rbac_enabled: bool = False
audit_enabled: bool = False