Onglet Configuration Générale
Par défaut, l'API REST n'est pas activée et seul le super administrateur (compte admin) du firewall SNS peut l'activer.
L'authentification sur l'API REST est sécurisée par des clés API, générées par les administrateurs. Ces clés possèdent des droits en lecture / écriture ou bien lecture seule, ainsi qu'une période de validité paramétrable.
Toutes les actions effectuées via l'API REST sont consignées dans les logs d'audit.
Pour faciliter l'utilisation de cette API, une documentation OpenAPI est accessible sur le firewall via l'adresse https://<@IP du firewall SNS>/docs/papi/v1 ou via le lien affiché dans l'interface web du firewall.
La documentation est également disponible sur le site de la Documentation technique Stormshield.
Activer l'API REST SNS
|
Activer l'API REST   |
Positionnez le curseur sur ON pour activer l'API REST. |
Communication
|
Certificat serveur |
Sélectionnez le certificat présenté par le firewall lors de l'accès à l'API REST. Le certificat sélectionné par défaut est le certificat auto-généré par le firewall (SNS-WebServer-default-authority) pour l'accès à l'interface Web d'administration du firewall. |
| Port |
Sélectionnez le port d'accès à l'API REST du firewall. Le port sélectionné par défaut est l'objet https. |
Durée de vie des clés
|
Durée de vie minimale (jours) |
Définissez la durée de vie minimale proposée par défaut aux administrateurs lorsqu'ils créent une clé API (30 jours par défaut). La durée de vie d'une clé API générée par un administrateur ne pourra pas être inférieure à cette valeur. |
| Durée de vie maximale(jours) |
Définissez la durée de vie maximale proposée par défaut aux administrateurs lorsqu'ils créent une clé API (365 jours par défaut). La durée de vie d'une clé API générée par un administrateur ne pourra pas être supérieure à cette valeur. |
Traces
|
Tracer les échecs d'authentification |
Cochez cette case pour activer la génération de tous les enregistrements liés à des erreurs d'authentification pour l'utilisation de l'API. Ces enregistrements sont écrits dans le fichier de logs dédié "l_restapi". |
| Tracer toutes les routes |
Cochez cette case pour activer la génération des logs relatifs à toutes les routes utilisées sur l'API REST. Ces enregistrements sont écrits dans le fichier de logs dédié "l_restapi". |