Aller au contenu principal

garak (garak)

Sonde un point d'accès de modèle à la recherche de contournements, d'injections d'invite, de fuites de données et de contenus toxiques, et produit un rapport.

Généré depuis catalog/services/garak.yaml : ne pas modifier à la main.

Résumé​

Version0.12.0
Usageexécuter à la demande
Couchefonctionnelle (catalogue IA)
CatégorieÉvaluation et exploitation des LLM
Méthodes d'installationpython
Connexion externenon
Réservé au bac à sablenon

Licence​

Identifiant SPDXApache-2.0
Politique de licencelicence socle (MIT ou Apache-2.0)
Exception de licence-
Composant de la plateformegarak

Paquets et artefacts​

Un paquet que publie le projet du service (son image, son archive binaire, son paquet Python ou système) porte la licence du service ; un paquet tiers porte la licence écrite sur sa ligne, lue dans les métadonnées officielles du projet amont.

TypePaquetVersionLicenceDétails
paquet Pythongarak0.12.0Apache-2.0interpréteurs, par ordre de préférence python3.11, python3.12, python3.10

Systèmes et architectures pris en charge​

MéthodeSystèmes d'exploitationArchitectures
pythonfamille RHEL (dnf), famille Debian (apt), Arch Linux (pacman)x86_64, aarch64 (non restreintes par le descripteur)

Systèmes hôtes certifiés : RHEL 8/9/10, Rocky Linux 8/9/10, AlmaLinux 8/9/10, Oracle Linux 8/9, CentOS Stream 9/10, Ubuntu 22.04/24.04, Debian 12, Arch Linux (rolling). Le contrôle préalable des hôtes accepte ces systèmes (une autre version d'une famille connue donne un avertissement, une version en fin de vie est refusée) et les architectures x86_64 et aarch64.

Prérequis​

Hôte​

Le descripteur ne déclare aucun contrôle préalable de l'hôte.

Réseau et ports​

Aucun.

Services et connexions nécessaires​

Détail et résolution : voir Dépendances.

Méthodes et modes d'installation​

MéthodeDéfautCe que la méthode utilise
pythonouiun environnement virtuel Python qui contient les paquets Python du descripteur

Composants​

ComposantTypeMéthodes d'installationPorts
Client garak (garak)clientpython-

Client (client) (par défaut)​

Installé sur les hôtes d'évaluation, lancé à la demande.

Ce que le mode déploie :

ComposantPlacement
garakmin 1, recommandé 1

Installer ce service​

L'assistant d'installation du Navin Manager planifie, valide et exécute l'installation ; il faut la permission services:install sur le cluster.

  1. Ouvrez l'assistant. Dans Clusters, choisissez l'action de ligne Installer des services du cluster cible. L'assistant s'ouvre sur sa première étape, Service.

  2. Choisissez le service. À l'étape Service, sélectionnez garak. La carte affiche la licence Apache-2.0 et les dépendances dont l'installation a besoin.

  3. Choisissez les hôtes et le mode. À l'étape Hôtes, cochez les hôtes, puis choisissez le Mode : client (par défaut). Chaque mode déploie les composants listés dans Méthodes et modes d'installation.

  4. Liez les dépendances. À l'étape Liaisons, choisissez pour chaque dépendance (litellm) Installer avec la plateforme ou Utiliser une connexion existante ; une dépendance facultative peut rester sur Aucune liaison.

  5. Configurez. À l'étape Configuration, relisez les paramètres (voir Paramètres de configuration) ; les paramètres obligatoires sont api_key. Les mots de passe laissés vides avec une valeur générée par défaut sont générés et scellés par le Manager.

  6. Relisez et installez. À l'étape Installation, le Manager valide le plan et affiche l'ordre d'installation ; quand il indique « Le plan est valide. Prêt pour l'installation. », choisissez Installer. Un mode hautement disponible n'est installé que si ses contrôles HA réussissent.

  7. Vérifiez. L'opération se termine quand les contrôles de santé de chaque instance réussissent (voir Contrôles de santé) ; le service apparaît alors en marche dans Services.

Exécutions à la demande​

Sonde un modèle à la recherche de vulnérabilités (injection d'invite, contournement, fuite) quand une campagne de red team est demandée.

Écran du portail : /quality/redteam

Haute disponibilité​

Clusteraucun (none)
Haute disponibilitéaucun (none)
Basculeaucun (none)
Réplicationaucun (none)
Quorumaucun (none)
Découverteaucun (none)
Point d'entréeaucun (none)
Documentation officiellehttps://docs.garak.ai/garak

Topologie par mode​

ModesNiveau le plus haut du catalogueRépartitionComposant du quorumDomaines de panneDescription
clientautonome (standalone)jobs parallèles (parallel-jobs)--Installé sur les hôtes d'évaluation ; les analyses tournent en parallèle, orchestrées hors de l'outil.

Remarques​

  • Outil en ligne de commande lancé à la demande : jamais un cluster hautement disponible ; plusieurs analyses tournent comme des jobs parallèles indépendants.

Paramètres de configuration​

Général​

ParamètreTypeDéfautValeurs permisesObligatoireSecretRedémarrageDescription
Point d'accès (endpoint_url)urlhttp://127.0.0.1:4000/v1-nonnonnonURL de base compatible OpenAI du modèle à analyser quand aucune liaison LiteLLM n'est définie.
Clé d'API (api_key)password--ouiouinonClé du point d'accès analysé.
Modèle (model)stringnavin-chat-nonnonnonNom du modèle envoyé au point d'accès.
Sondes (probes)stringpromptinject,dan,leakreplay-nonnonnonFamilles de sondes garak séparées par des virgules.

Dépendances​

Pour chaque dépendance active, le Manager prend la première solution parmi : la liaison choisie dans l'assistant ; un service de la même installation qui la fournit ; un service déjà installé dans le cluster ; la seule connexion du type attendu. Sinon, une dépendance facultative reste non liée, et une dépendance obligatoire est ajoutée à l'installation dans son mode par défaut (la colonne ci-dessous nomme le service du catalogue ajouté).

LiaisonFournie parType de connexionPoint d'accèsFacultativeQuand rien n'est liéDescription
litellmlitellm-apiouireste non liée (facultative)Passerelle LiteLLM de la plateforme servant le modèle analysé (point d'accès du générateur) ; sans elle le paramètre point d'accès est utilisé.

Commandes​

CommandeComposantCibleDescription
Analyser le point d'accès (scan)garakhôte choisiLance les sondes configurées sur le point d'accès ; le rapport est écrit dans le répertoire de données. (demande une confirmation)

Contrôles de santé​

Vivacité (par instance)​

ComposantContrôleDétails
garak{{ paths.opt }}/venv/bin/python -m garak --version1 tentatives ; intervalle 1 s ; délai 120 s

Désinstallation​

Chemins supprimés quand les données sont purgées : {{ paths.data }}, {{ paths.opt }}.

Documentation amont​