Description du fichier GASP

Un fichier GASP est un fichier de description des règles Gaspacho. C’est un fichier contenant un objet au format JSON.

Légende :

  • “” : texte
  • {} : objet
  • [] : liste
  • attribut obligatoire
  • attribut non obligatoire

Information

Informations sur le fichier GASP :

"name": "",
"version": "",
"database": "",
"os": {},
"software": {},
"categories": [],
  • name : nom du fichier de règle, chaque règle importée sera associée à un fichier d’import avec ce nom
  • version : version du fichier de règle, utile pour les mises à jour
  • database : version de la base de données compatible, important lors de changements du format d’importation
  • os : objet OS de la règle
  • software : objet Software de la règle
  • categories : liste d’objet Catégorie de la règle

OS

Un fichier GASP concerne un et seul OS. Par OS il faut comprendre nom du système ou de la distribution :

"name": "",
"version": "",
  • name : nom de l’OS (windows, fedora, ...)
  • version: version de l’OS (vista, 15, ...)

Software

Un fichier GASP concerne un et un seul logiciel :

"name": "",
"version": "",
  • name : nom du logiciel (firefox)
  • version: version du logiciel (4.0)

Category

Les tags sont classés dans des catégories :

"names": [],
"tags": [],
  • names : liste d’objet Name
  • tags : liste d’objet Tag

Tag

Les règles sont classées dans des tags :

"names": [],
"rules": [],
  • names : liste d’objet Name
  • rules : liste d’objet Rules correspondant aux règles

Règle

Règle applicable :

"names": [],
"type": "",
"variables": [],
"defaultvalue": "",
"defaultstate": "",
"display": "",
"comments": [],
"options": {}
  • names : liste d’objet Name
  • type : type de la règle (‘boolean’, ‘unicode’, ‘integer’, ‘ip’, ‘enum’, ‘list’ ou ‘multi’)
  • variables : liste d’objets Variable
  • defaultvalue : valeur de la règle par défaut (si non spécifié vide)
  • defaultstate : état de la règle ‘on’, ‘off’ ou ‘free’ par défaut (si non spécifié ‘free’)
  • display : permet de cacher une règle dans l’interface pour forcer son activation ou désactivation
  • comments : liste d’objets Name avec un commentaire sur la règle (par défaut vide)
  • options : objet d’Option

Option

Les options peuvent être différentes suivant le type :

  • boolean : aucune option possible
  • unicode : aucune option possible
  • integer : il est possible de spécifier la valeur minimum (ex : {“min”: 1}) et maximum (ex : {“max”: 23})
  • enum : ensemble de possibilités offertes par l’énumération (ex : [[“2”, “Option 2”], [“1”, “Option 1”], [“0”, “Option 0”])
  • list : le séparateur de la liste, par défaut “-” (ex : {“separator”: ”;”})

Variable

La variable est spécifique aux fichiers de configuration du logiciel sur l’OS. Le contenu pourra varier suivant le plugin associé:

"name": "",
"type": "",
"level": "",
"extension": "",
"path": ""
"value_off": "",
"value_on": "",
"info": "",
"comment": "",
  • name : nom de la variable présent dans le fichier de configuration
  • type : type de la variable du fichier de configuration
  • level : niveau de la variable, soit utilisateur (user), soit machine (computer)
  • extension : type du fichier de configuration (correspond à un plugin)
  • path : chemin du fichier
  • value_off : valeur de la variable lorsque la règle est activée (SUPPR supprime la variable)
  • value_on : valeur de la variable lorsque la règle est activée (SUPPR supprime la variable), généralement utilisée uniquement pour les règles de type booléen
  • info : information utile pour la variable, différent suivant le plugin (section, type, ... par défaut None)
  • comment : commentaire (non visible) sur la variable (par défaut vide)

Name

Label traduit en différentes langues :

"lang": "",
"label": ""
  • lang : langue (fr, en, ...)
  • label : label

Exemple

Activation du proxy dans LibreOffice sur Fedora 15 :

{"name"     : "fedora-15/libreoffice-3.3",
"version"   : "0.1",
"database"  : "0.9",
"os"        : {
    "name"      : "fedora",
    "version"   : "15"},
"software"  : {
    "name"     : "libreoffice",
    "version"  : "3.3"},
"categories": [{
    "names"      : [{
        "lang"      : "fr",
        "label"     : "Réseau"}],
    "tags"      : [{
        "names"      : [{
            "lang"      : "fr",
            "label"     : "Configuration du proxy"}],
        "rules"     : [{
             "names"      : [{
                 "lang"      : "fr",
                 "label"     : "Activer le proxy"}],
             "type":     : 'boolean',
             "variables" : [{
                 "value_on"  : "2",
                 "value_off" : "SUPPR",
                 "type"      : "integer",
                 "name"      : "ooInetProxyType",
                 "extension" : "xcu3",
                 "info"      : "Inet/Settings",
                 "path"      : "$HOME/.libreoffice/3/user/registrymodifications.xcu"
             }]
         }]
     }]
}]}

Table des Matières

Sujet précédent

Description de l’API

Sujet suivant

Description du fichier à appliquer

Cette page