4. Structure d’un paquet WAPT¶

Note

WAPT packages whose names end with the suffix -template` are generic templates designed to be adapted to the specific needs of each organisation. They should not be installed directly without prior modification.

These packages act as working bases that require customisation to meet the technical specifications or internal policies of your company or IT department.

Structure du paquet WAPT affichée dans l'explorateur Windows — Structure du paquet WAPT affichée dans l’explorateur Windows¶

Un paquet WAPT est un fichier .zip contenant plusieurs éléments :

Un fichier setup.py à la racine.
Un fichier ou plusieurs fichiers binaires.
Un fichier ou plusieurs autres fichiers additionnels.
Un fichier control dans le dossier WAPT.
Un fichier icon.png dans le dossier WAPT.
Un fichier certificate.crt dans le dossier WAPT.
Un fichier manifest.sha256 dans le dossier WAPT.
Un fichier signature.sha256 dans le dossier WAPT.
Un fichier wapt.psproj dans le dossier WAPT, ce fichier est utilisé pour stocker les données de configuration PyScripter pour le paquet WAPT.
Depuis WAPT 1.8, un dossier caché .vscode qui contient un fichier launch.json et un fichier settings.json utilisés pour stocker les données de configuration VScode pour le paquet WAPT.

4.1. Le fichier control¶

Le fichier control est la fiche d’identité du paquet.

package           : tis-firefox-esr
version           : 62.0-0
architecture      : all
section           : base
priority          : optional
maintainer        : Administrateur
description       : Firefox Web Browser French
description_fr    : Navigateur Web Firefox Français
description_es    : Firefox Web Browser
depends           :
conflicts         :
maturity          : PROD
locale            : fr
target_os         : windows
min_os_version    :
max_os_version    :
min_wapt_version  : 1.6.2
sources           :
installed_size    :
impacted_process  : firefox.exe
audit_schedule    :
editor            : Mozilla
keywords          : Navigateur
licence           : MPL
homepage          : https://www.mozilla.org/en-US/firefox/organizations/
package_uuid      : dc66ccd1-d987-482e-b792-04e89a3803f7
valid_from        : 2022-02-23T00:00:00
valid_until       : 2022-03-23T00:00:00
forced_install_on : 2022-03-23T00:00:00
signer            : Tranquil IT
signer_fingerprint: 459934db53fd804bbb1dee79412a46b7d94b638737b03a0d73fc4907b994da5d
signature         : MLOzLiz0qCHN5fChdylnvXUZ8xNJj4rEu5FAAsDTdEtQ(...)hsduxGRJpN1wLEjGRaMLBlod/p8w==
signature_date    : 20170704-164552
signed_attributes : package,version,architecture,section,priority,maintainer,description,depends,conflicts,maturity,locale,min_os_version,max_os_version,min_wapt_version,sources,installed_size,signer,signer_fingerprint,signature_date,signed_attributes

Description des options du fichier control¶
Paramètres	description	Exemple de valeur
`package`	Nom du paquet WAPT, sans accent, sans espace, sans caractère spécial, sans majuscule.	tis-geogebra
`Version`	Définit la version du paquet (note : la version NE DOIT PAS contenir plus de 5 délimiteurs, le dernier chiffre étant le numéro de version du paquet). La version DOIT commencer par la version du logiciel packagé (chiffres seulement) divisée par des points (`.`) et DOIT se terminer par la version du paquet WAPT séparée par un caractère tiret (`-`).	5.0.309.0-1
`architecture`	Définit l’architecture du processeur sur lequel le paquet WAPT sera installé. Un paquet prévu pour une architecture x64 ne sera pas visible avec un Agent WAPT installé sur un poste équipé d’un processeur x86. Valeurs possibles : x86 : le paquet est destiné uniquement aux machines avec un processeur 32bits ; x64 : le paquet est destiné uniquement aux machines avec un processeur 64bits ; all : le paquet est conçu pour n’importe quelle architecture.	x64
`section`	Définit le type de paquet WAPT (`host`, `group`, `base`). Valeurs possibles : host : paquet machine ; group : paquet groupe ; base : paquet logiciel ; unit : paquet UO ;	base
`priority`	Définit la priorité d’installation du paquet WAPT (facultatif). Cette option n’est pas prise en charge pour le moment. Ce champ sera utilisé pour définir la priorité d’installation des paquets. Cette fonctionnalité sera utile pour définir les mises à jour de sécurité obligatoires.	Non pris en charge pour le moment
`maintainer`	Indique la maturité du paquet. Indiquer l’adresse email peut être utile.	Arnold Schwarzenegger <terminator@mydomain.lan>
`description`	Description du paquet qui apparaîtra dans la console et dans le self-service. Ajouter un champ description_fr ou description_es permet par exemple de préciser une description pour une langue précise. Si la langue n’existe pas, l’Agent wapt utilisera la champ description classique.	The Graphing Calculator for Functions, Geometry, Algebra, Calculus, Statistics and 3D
`description_fr`	Description du paquet dans une langue précise.	Calculatrice graphique
`depends`	Définit quelle(s) dépendance(s) doit(doivent) être satisfaite(s) avant d’installer le paquet WAPT, par exemple tis-java devra être installé avant le paquet LibreOffice. On peut définir plusieurs dépendances en les séparant par des virgules (,).	tis-java
`conflicts`	Définit les packages WAPT qui Doivent être supprimés avant l’installation du package, par exemple tis-firefox Doivent être supprimés avant l’installation du package tis-firefox-esr, ou OpenOffice Doivent être supprimés avant l’installation de LibreOffice. Fonctionne exactement à l’inverse de depends. On peut définir plusieurs conflits en les séparant par des virgules (,).	tis-graph
`maturity`	Définit le niveau de maturité du paquet WAPT (`BETA`, `DEV`, `PROD`, etc). Un agent verra par défaut les paquets PROD et les paquet sans maturité. Pour qu’un client puisse voir un paquet d’un autre niveau de maturité, il faudra définir l’attribut `maturities` dans le fichier de configuration `wapt-get.ini` de l’Agent WAPT.	PROD
`locale`	Définit la langue pour le paquet WAPT. Un Agent WAPT verra par défaut les paquets qui sont configurés pour son (ses) environnement(s) linguistique(s) et les paquets sans langue spécifiée. Pour qu’un ordinateur puisse voir un paquet dans une autre langue, vous devrez configurer les locales dans `wapt-get.ini` de l’Agent WAPT. La casse et l’ordre n’ont pas d’importance. Si vous voulez respecter un ordre pour les maturités, vous devrez définir l’ordre dans le fichier de configuration `wapt-get-ini` de l’Agent WAPT.	fr,en,es
`target_os`	Indique le système d’exploitation prévu pour le paquet. Un Agent WAPT verra par défaut les paquets prévus pour son système d’exploitation et les paquets avec un champ `target_os` sans valeur. Depuis la version 2.3 l’attribut `target_os` peut avoir plusieurs valeurs, il doit correspondre à la balise `host_capabilities`. Avec debian, vous pouvez utiliser < ou >. Les trois premières dans l’exemple sont les plus utilisées.	windows, mac, linux, debian-bullseye, redhat_based, centos8, debian(>8), ubuntu, almalinux8
`min_os_version`	Définit la version minimale de Windows pour que le paquet soit vu par l’Agent WAPT. Pour un `target_os` windows, ce champ définit la version minimale du système d’exploitation. Par exemple, cet attribut peut être utilisé pour éviter d’installer sur WindowsXP des paquets qui ne fonctionnent que sur Windows7 et supérieur. Depuis la version 1.8, il peut également définir la version minimale de Mac OS. Nous conseillons de ne pas l’utiliser avec Linux car il existe plusieurs distributions différentes.	6.0
`max_os_version`	Définit la version maximale de Windows pour que le paquet soit vu par l’Agent WAPT. Pour un windows target_os, il définit le maximum Windows Operating System Version. Par exemple, cet attribut peut être utilisé pour installer sur Windows7 des versions plus récentes d’un logiciel qui ne sont plus supportées par Windows XP. Depuis la version 1.8, il peut également définir la version minimale de Mac OS. Nous conseillons de ne pas l’utiliser avec Linux car il existe plusieurs distributions différentes.	10.0
`min_wapt_version`	Définit la version minimale de l’Agent WAPT pour que le paquet WAPT fonctionne correctement. Le code de WAPT évoluant, certaines fonctions que vous aurez utilisées dans vos anciens paquets peuvent devenir obsolètes avec les nouvelles versions des Agents WAPT.	1.3.8
`sources`	Définit le lien de stockage des versions historisées du paquet (commande wapt-get source). Définit un dépôt pour le versionnement des paquets WAPT, par exemple https://svn.mydomain.lan/sources/tis-geogebra-wapt/trunk/. Cela permet de versionner le paquet et de concevoir collaborativement le paquet. Le versionnage de paquets est particulièrement utile lorsque plusieurs personnes créent des paquets de manière collaborative. Cette fonction est également utile pour retracer l’historique d’un paquet si vous êtes soumis à une réglementation particulière dans votre secteur d’activité.	https://srv-svn.mydomain.lan/sources/tis-geogebra-wapt/trunk/
`installed_size`	Définit l’espace disque libre minimum requis pour installer le paquet WAPT. Le test d’espace disque disponible est fait sur le dossier `C:Program Files`. La valeur renseignée dans installed_size doit être en bytes. Pour convertir des valeurs de stockage en bytes, visiter https://www.convertworld.com/fr/mesures-informatiques/.	254251008
`impacted_process`	Indique une liste de processus impactés lors de l’installation du paquet WAPT. Ce champ est utilisé par les fonctions install_msi_if_needed et install_exe_if_needed si killbefore n’est pas renseigné. impacted_process est également utilisé lors de la désinstallation d’un paquet. Cela permet de fermer l’application si l’application est ouverture avant sa désinstallation.	firefox.exe
`audit_schedule`	Définit la périodicité d’exécution de la fonction d’audit dans le paquet WAPT. La valeur peut être indiquée de plusieurs manières : un entier (en minutes) ; un entier suivi d’une lettre (m = minutes , h = heure , d = jour , w = semaine).	60
`editor`	Éditeur de logiciels des binaires intégrés dans le paquet base de WAPT. La liste des valeurs pourra être utilisée dans la console et dans le selfservice pour trier les paquets.	Mozilla
`license`	Indique la page d’accueil du site officiel de logiciel intégrée dans le paquet. La liste des valeurs pourra être utilisée dans la console et dans le selfservice pour trier les paquets.	GPLV3
`keywords`	Définit un ensemble de mots-clés décrivant le paquet WAPT. La liste des valeurs pourra être utilisée dans la console et dans le selfservice pour trier les paquets.	Productivité, Traitement de texte
`homepage`	Indique la page d’accueil du site officiel de logiciel intégrée dans le paquet. La liste des valeurs pourra être utilisée dans la console et dans le selfservice pour trier les paquets.	https://www.tranquil.it/
`package_uuid`	Identifiant unique du packaging. Il est généré automatiquement lors de la construction du packaging.	dc66ccd1-d987-482e-b792-04e89a3803f7
`valid_from`	Date / time from which the package may be installed. The WAPT Agent will refuse to install it before that date. The string is formated according to the ISO8601 standard: YYYY-MM-DDTHH:MM:SS. When the date has passed, WAPT will install the package when an update is triggered.	2022-02-23T00:00:00
`valid_until`	Date / time from which the package may not be installed. The WAPT Agent will refuse to install it after that date. The string is formated according to the ISO8601 standard: YYYY-MM-DDTHH:MM:SS.	2022-02-23T00:00:00
`forced_install_on`	Date / time from which the WAPT Agent will trigger a forced install of the package. The string is formated according to the ISO8601 standard: YYYY-MM-DDTHH:MM:SS.	2022-02-23T00:00:00
`signer`	Définit le CN du signataire du paquet WAPT. Il s’agit généralement du nom complet du signataire. La valeur est automatiquement insérée lors de la signature du packaging WAPT.	Tranquil IT
`signer_fingerprint`	Fournit l’empreinte digitale de la signature du titulaire du certificat. La valeur est automatiquement insérée lors de la signature du packaging WAPT.	2BAFAF007C174A3B00F12E9CA1E74956
`signature`	Fournit le hachage SHA256 du paquet WAPT. La valeur est automatiquement insérée lors de la signature du packaging WAPT.	MLOzLiz0qC(…)hsEjGRaMLBlod/p8w==
`signature_date`	Indique la date de signature du paquet. La valeur est automatiquement insérée lors de la signature du packaging WAPT.	20180307-230413
`signed_attributes`	Listes des attributs du fichier `control` du paquet WAPT qui sont signés. La valeur est automatiquement insérée lors de la signature du packaging WAPT.	package, version, architecture, section, priority, maintainer, description, depends, conflicts, maturity, locale, min_wapt_version, sources, installed_size, signer, signer_fingerprint, signature_date, signed_attributes

Attention

Si le fichier control comporte des caractères accentués, le fichier doit être enregistré en format UTF-8 (No BOM).

4.2. Le fichier setup.py¶

Cette ligne se trouve au début de chaque paquet WAPT qui contient un setup.py :
```
from setuphelpers import *
```
Nous demandons au paquet d’importer toutes les fonctions depuis la librairie Setuphelpers.

Setuphelpers est la librairie intégrée à WAPT, elle embarque des fonctions simplifiées pour aider à créer des paquets fonctionnels rapidement.
suivi d’une liste uninstallkey pour associer une liste de clés de désinstallation au packaging WAPT.
```
uninstallkey = ['tisnaps2','Mozilla Firefox 45.6.0 ESR (x86 fr)']
```
Nous déclarerons ici une liste des clé de désinstallation associées au paquet. Quand un paquet est supprimé, l’Agent WAPT recherche dans la base de registre la clé de désinstallation correspondant au paquet. Cette clé de désinstallation indiquera à l’Agent WAPT les actions à déclencher pour supprimer le logiciel.

Même s’il n’y a pas de clé de désinstallation pour le paquet, il faudra quand même déclarer une clé de désinstallation vide :
```
uninstallkey = []
```
suivi de fonctions telles que def_install(), def_uninstall(), def_session-setup() et def_audit()

Ces fonctions décrivent les recettes du paquet WAPT, l’ensemble des instructions qui seront exécutées pour installer, supprimer, configurer et auditer un paquet WAPT.

4.3. Le fichier wapt.psproj¶

On trouve dans le dossier WAPT un fichier wapt.psproj.

Il s’agit du fichier projet PyScripter pour le paquet WAPT.

Pour éditer un paquet avec PyScripter, il suffira d’ouvrir ce fichier.

4.4. Le fichier icon.png¶

On trouve dans le dossier WAPT un fichier icon.png.

Il permet d’associer une icône au paquet.

Indication

L’icône est utilisée dans le Self-Service, elle est téléchargée avec sa somme MD5 pour la sécurité ; si la somme MD5 n’est pas bonne, l’icône est supprimée.
L’icône DOIT être au format .png en 48px par 48px.

4.5. Le fichier manifest.sha256¶

On trouve dans le dossier WAPT un fichier manifest.sha256.

Il contient l’empreinte sha256 de chaque fichier du package.

4.6. Le fichier signature¶

Le fichier signature est situé dans le dossier WAPT.

Le fichier contient la signature du fichier manifest.sha256.

A l’installation du paquet WAPT, wapt-get vérifie :

Que la signature de manifest.sha256 correspond au fichier manifest.sha256 actuel (l’agent vérifiera les certificats publics dans C:\Program Files (x86)\wapt\ssl sous Windows et /opt/wapt/ssl sous Linux et macOS).
Que l’empreinte sha256 de chaque fichier est identique à celle contenue dans le fichier manifest.sha256.

4.7. Le fichier certificate.crt¶

Le fichier certificate.crt est situé dans le dossier WAPT.

C’est le certificat du mainteneur qui a signé le paquet.

Lors de l’installation d’un paquet, wapt-get vérifie que le certificate.crt ou son parent correspond aux certificats présents dans C:\Program Files (x86)wapt\ssl sous Windows et /opt/wapt/ssl sous Linux et macOS. Si le certificat n’est pas validé, le paquet ne sera pas installé.

4.8. Autres fichiers¶

D’autres fichiers peuvent être embarqués dans le paquet WAPT. Par exemple :

Un installeur à côté du setup.py à appeler dans le setup.py.
Un fichier de réponses à passer à l’installeur du logiciel.
Un fichier de licence.
Etc.