security.go (package eai)
Source : sdks/go/security.go. Retour à l'index de la référence du SDK Go.
Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.
Classe SecurityService
Sécurité. Posture de sécurité du déploiement et réglages de sécurité du tenant.
SecurityService.GetSettings
GetSettings(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
Lire les réglages de sécurité. Renvoie tenant_id et settings : les réglages de sécurité du tenant, valeurs par défaut comprises. Exige tenant_admin ou security_officer et un tenant (403 tenant_required).
Route : /v1/security/settings (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Lire les réglages de sécurité ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
SecurityService.Posture
Posture(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
Lire la posture de sécurité. Renvoie environment, generated_at, protections (méthodes d'authentification et autres protections en vigueur), checks (chacun avec son statut pass, warn ou fail, sa gravité et son message) et summary (nombre de contrôles par statut). Pour un appelant rattaché à un tenant, renvoie aussi tenant avec les réglages de sécurité du tenant, dont certains contrôles tiennent compte. Exige security_officer ou tenant_admin. En lecture seule.
Route : /v1/security/posture (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Lire la posture de sécurité ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
SecurityService.UpdateSettings
UpdateSettings(ctx context.Context, body any, opts ...CallOption) (json.RawMessage, error)
Modifier les réglages de sécurité. Mise à jour partielle : seuls les réglages envoyés changent, les autres gardent leur valeur. Exige tenant_admin ou security_officer et un tenant.
Route : /v1/security/settings (PUT).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
body | any | oui | Objet JSON avec les réglages à modifier, par exemple {"prompt_injection_mode": "block"}. | |
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Modifier les réglages de sécurité ». L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error, les erreurs typées du transport (Erreurs).
Fonctions
IsLocalHost
IsLocalHost(host string) bool
IsLocalHost indique si host vaut localhost, 127.0.0.1 ou ::1.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
host | string | oui | Nom d'hôte sans port, comparé sans tenir compte de la casse. |
Retour : bool. true pour localhost, 127.0.0.1 et ::1.
ValidateBaseURL
ValidateBaseURL(raw string) error
ValidateBaseURL accepte les URL https, et http seulement pour localhost et 127.0.0.1.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
raw | string | oui | Renvoie une ApiResponse (données, statut, en-têtes) au lieu du corps décodé. |
Retour : error. Erreur de l'appel (une erreur typée du SDK), nil en cas de succès.
Erreurs levées : error.
ValidateWebSocketURL
ValidateWebSocketURL(raw string) (string, error)
ValidateWebSocketURL accepte les URL wss, et ws seulement pour localhost et 127.0.0.1 ; renvoie l'URL.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
raw | string | oui | Renvoie une ApiResponse (données, statut, en-têtes) au lieu du corps décodé. |
Retour : (string, error). L'URL inchangée si elle est acceptée ; l'error est renseignée pour une URL relative, un autre schéma, ou ws vers un hôte distant.
Erreurs levées : error.
WithCABundle
WithCABundle(pem []byte) Option
WithCABundle ajoute des certificats d'autorité encodés en PEM au magasin du système ; la vérification reste active.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
pem | []byte | oui | Certificats d'autorité encodés en PEM ; vide, ou sans aucun certificat, NewClient échoue. |
Retour : Option. Une Option à passer à NewClient.
WithDangerouslyDisableTLSVerificationForLocalhost
WithDangerouslyDisableTLSVerificationForLocalhost() Option
WithDangerouslyDisableTLSVerificationForLocalhost désactive la vérification des certificats. NewClient la refuse sauf si l'hôte de l'URL de base est localhost, 127.0.0.1 ou ::1.
Cet élément ne prend aucun paramètre.
Retour : Option. Une Option à passer à NewClient.
MaskSecret
MaskSecret(s string) string
MaskSecret garde au plus 4 caractères d'un secret.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
s | string | oui | Secret à masquer, par exemple une clé d'API ou un jeton. |
Retour : string. Les 4 premiers caractères suivis de *** pour un secret de plus de 12 caractères, *** sinon, vide pour un secret vide.
IsEgressDenied
IsEgressDenied(err error) bool
IsEgressDenied signale une erreur egress_denied.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
err | error | oui | Erreur à tester. |
Retour : bool. true quand err correspond à ErrEgressDenied.
EgressDeniedReason
EgressDeniedReason(err error) string
EgressDeniedReason renvoie details.reason d'une erreur egress_denied.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
err | error | oui | Erreur renvoyée par le SDK. |
Retour : string. La chaîne reason de Details, vide quand err n'est pas egress_denied ou n'a pas de raison.
IsPromptInjectionBlocked
IsPromptInjectionBlocked(err error) bool
IsPromptInjectionBlocked signale une erreur prompt_injection_blocked.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
err | error | oui | Erreur à tester. |
Retour : bool. true quand err correspond à ErrPromptInjectionBlocked.
IsPayloadTooLarge
IsPayloadTooLarge(err error) bool
IsPayloadTooLarge signale une erreur payload_too_large (ou HTTP 413).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
err | error | oui | Erreur à tester. |
Retour : bool. true pour le code payload_too_large ou un statut HTTP 413.