Test d'automatisation dans AppScan® Enterprise à l'aide d'HCL AppScan Traffic Recorder

HCL AppScan Traffic Recorder vous permet d'enregistrer du trafic et de l'utiliser en tant que données d'exploration dans votre travail AppScan Enterprise (ASE). HCL AppScan Traffic Recorder est un système de gestion des instances d'enregistreur de trafic. Des instances de l'enregistreur de trafic peuvent être créées à la demande pour enregistrer le trafic qui sera ensuite utilisé pour un examen DAST. Cette rubrique décrit comment configurer et utiliser l'enregistreur de trafic.

Vue d'ensemble

Dans l'univers des DevOps, il est de plus en plus important de pouvoir intégrer des examens de sécurité à vos processus CI/CD. Si vous utilisez une infrastructure d'automatisation (comme Selenium), vous pouvez tirer parti des scripts déjà écrits pour créer des examens personnalisés.
  • A l'aide de l'enregistreur de trafic AppScan, vous pouvez démarrer automatiquement une instance d'enregistreur de trafic. Les demandes provenant de la structure d'automatisation vers l'application Web sont ensuite enregistrées lorsqu'elles sont transmises via cet enregistreur de trafic. Le trafic est enregistré au format HAR dans un fichier .dast.config, que vous pouvez ensuite charger pour qu'il soit utilisé par AppScan Enterprise (ASE) en tant que données d'exploration pour un examen.
  • Vous pouvez également enregistrer le trafic manuellement, via l'enregistreur de trafic, pour créer un fichier .dast.config.
  • Vous pouvez également charger votre propre fichier HAR directement dans ASE, sans utiliser l'enregistreur de trafic.

Ce diagramme représente le automated scan flow with AppScan® Enterprise.


Flux d'examen automatisé avec AppScan Enterprise

Flux de travaux standard

  1. Installer l'enregistreur de trafic
  2. Configurer l'enregistreur de trafic
  3. Démarrer l'enregistreur de trafic
  4. Utilisation de l'enregistreur de trafic
Remarque : Le script de démonstration pour ce flux de travaux, ProxyServerDemoScript.py, est disponible dans le dossier d'installation d'AppScan.

Installer l'enregistreur de trafic AppScan

Prérequis : une version actuelle de Node.js (v16 ou version LTS ultérieure) doit être installée sur votre machine. Si votre service est conforme aux normes FIPS, vous devez utiliser un serveur Node.js compatible FIPS.

  1. Windows : Décompressez TrafficRecorder.Windows.zip dans un dossier de votre machine.

    Linux : Décompresser TrafficRecorder.Linux.zip

  2. Pour remplacer un port par défaut sur lequel exécuter l'enregistreur de trafic : Configurez le paramètre du port dans Settings.json.
  3. Vérifiez que app.js et le fichier Java interne : /java/bin/java disposent de droits exécuter en tant qu'exécutable.

Configurer l'enregistreur de trafic AppScan

Après avoir apporté des modifications à la configuration, vous devez redémarrer le serveur.
Remarque : Lors de la mise à niveau, si vous avez déjà défini un certificat PKCS12 dans Settings.json, vous devrez le définir à nouveau.

Mode compatible FIPS

  1. Localisez le fichier Settings.json dans le dossier racine de l'enregistreur de trafic et ouvrez-le dans un éditeur de texte.
  2. Localisez le paramètre requireFips et modifiez sa valeur de false en true.
  3. Sauvegardez le fichier.

Connexion à l'enregistreur de trafic

  1. Configurez un port par défaut dans Settings.json pour que l'enregistreur de trafic s'exécute.
  2. Configurez une connexion sécurisée (SSL) à l'enregistreur de trafic. Vous pouvez pour cela utiliser votre propre certificat (Méthode A) ou un certificat autosigné (Méthode B).

    Méthode A : Configurez votre propre certificat PEM ou PKCS12 dans Settings.json.

    PEM :

    Un certificat PEM nécessite deux chemins de fichiers (vers private.key et certificate.pem).
    • Insérez les chemins de fichier dans la section PEM de Settings.json.
      Remarque : Un échappement est requis pour le caractère '\', exemple : « C:\\Users\\admin\\private.key ».

    PKCS12

    Vous devez échapper des caractères si nécessaire à la fois dans les chemins d'accès aux fichiers et dans le mot de passe, par exemple un mot de passe tel que abc!”123 devient abc!\”123 (le symbole " est échappé)
    1. Dans la ligne de commande, exécutez :

      .\Java\bin\java.exe -jar .\DastProxy.jar -sc "C:\Path\to\certificate.pfx"

    2. A l'invite, entrez le mot de passe du certificat et appuyez sur Entrée.

      Exemple d'utilisation d'openssl pour créer un certificat PEM :

      openssl req -newkey rsa:2048 -new -nodes -keyout key.pem -out csr.pem

      openssl x509 -req -days 365 -in csr.pem -signkey key.pem -out server.crt

      Exemple d'utilisation d'openssl pour convertir le certificat PEM en certificat PKCS12 :

      openssl pkcs12 -export -out certificate.pfx -inkey key.pem -in server.crt

      Exemple d'outil keygen de Java pour convertir un certificat JKS en certificat PKCS12 :

      keytool -importkeystore -srckeystore certificate.jks -srcstoretype JKS -destkeystore certificate.p12 -deststoretype PKCS12

    Méthode B : si vous n'avez pas de certificat, vous devez créer et utiliser un certificat autosigné. Notez que cette méthode est moins sécurisée.

    Option A : utiliser OpenSSL

    OpenSSL n'est pas inclus et n'est pas requis, sauf pour créer le certificat autosigné.

    1. Créez la clé et les fichiers PEM à l'aide de la commande OpenSSL : openssl req -new -newkey rsa:2048 -nodes -keyout private.key -x509 -days 365 -out certificate.pem
    2. Insérez les chemins de fichier dans la section PEM de Settings.json.
      Remarque : Un échappement est requis pour le caractère '\', exemple : « C:\\Users\\admin\\private.key ».

    Option B : utiliser Java keytool

    Pour NodeJS version 17 et supérieure, vous devez utiliser l'indicateur de nœud « --openssl-legacy-provider » en raison de la limitation de keytool, voir https://nodejs.org/api/cli.html#--openssl-legacy-provider

    1. Dans la ligne de commande, ouvrez le dossier racine Traffic Recorder.
    2. Créez un fichier de certificat PKCS12 à l'aide de la commande : .\Java\bin\keytool -genkey -keyalg RSA -alias selfsigned -keystore keystore-new.p12 -storetype PKCS12 -validity 365 -keysize 2048
    3. Renseignez les détails du certificat et protégez-le avec un mot de passe, qui sera exigé à l'étape suivante.
    4. Utilisez le certificat généré dans HCL AppScan Traffic Recorder à l'aide de la commande : .\Java\bin\java.exe -jar .\DastProxy.jar -sc "keystore.p12"

Certificat racine

Si l'application que vous testez utilise le protocole SSL (HTTPS), HCL AppScan Traffic Recorder doit agir comme intermédiaire pour l'enregistrement du trafic. Pour cela, il doit disposer d'un certificat racine qu'il peut utiliser pour signer ses communications avec l'application.

Par défaut, HCL AppScan Traffic Recorder génère un certificat racine unique, sans que l'intervention de l'utilisateur ne soit requise. Cependant, vous obtiendrez des avertissements SSL lorsque vous parcourrez l'application. Vous pouvez soit les ignorer, soit faire l'une des choses suivantes :
  1. Installer le certificat généré par HCL AppScan Traffic Recorder sur votre ou vos machines :
    1. Utilisez l'API REST pour télécharger l'autorité de certification racine autosignée utilisée par HCL AppScan Traffic Recorder en tant que fichier PEM.
    2. Installez le certificat sur le navigateur utilisé pour l'exploration ou à tout emplacement requis (en fonction de l'origine du trafic).
  2. Importer votre propre certificat racine sur HCL AppScan Traffic Recorder. Les formats de certificats pris en charge sont PKCS12 (.P12, .PFX) et JKS :
    1. Ouvrez une fenêtre de ligne de commande et accédez au dossier d'installation sur la machine de l'enregistreur de trafic.
    2. Exécutez la commande :

      .\Java\bin\java -jar DastProxy.jar -irc [path to certificate file] -ircp [password]

      Remarque : Pour afficher l'utilisation de commande complète, exécutez la commande .\Java\bin\java -jar DastProxy.jar.

      Important : Il est recommandé d'utiliser un certificat test dédié, dans la mesure où le certificat est enregistré sur l'enregistreur de trafic.

  3. Fournissez votre propre certificat de serveur fixe (et non un certificat racine) dans la commande StartProxy.

Définir le délai d'inactivité

Si une instance de l'enregistreur de trafic n'est pas fermée après utilisation à l'aide de la commande correspondante, elle reste ouverte et en mode écoute sur le port. Les instances de l'enregistreur de trafic sont automatiquement fermées si elles restent inactives pendant une durée prédéfinie.

Le délai d'inactivité par défaut pour les instances de l'enregistreur de trafic est de 60 minutes. Vous pouvez modifier cette valeur en modifiant la valeur de inactivityTimeoutInMinutes dans le fichier Settings.json, enregistré dans le dossier d'installation.

Chiffrer le trafic

Par défaut, le fichier de trafic (.dast.config) n'est pas chiffré. Pour configurer le serveur afin de chiffrer tout le trafic, modifiez la valeur "encryptDastConfig" en "true" dans le fichier Settings.json, qui se trouve dans le dossier d'installation.

Proxy chaîné

Si vous devez définir plusieurs proxys chaînés ou des exceptions sur le proxy, utilisez le fichier de règles de proxy chaîné (proxy.chain) qui se trouve dans le dossier d'installation. Des instructions d'utilisation sont incluses dans ce fichier.

Démarrer/Arrêter l'enregistreur de trafic

Vous pouvez simplement démarrer l'enregistreur de trafic ou l'exécuter en tant que service (ci-dessous). Notez que vous ne pouvez pas faire les deux en parallèle.

Pour démarrer l'enregistreur de trafic :
  • Exécutez la commande suivante : node app.js [port]

    où *port = le port sur lequel l'enregistreur de trafic écoute les requêtes de l'API REST.

Remarque :
  • Si vous ne définissez pas le port au démarrage de l'enregistreur de trafic, le port défini dans le fichier Settings.json est utilisé.
  • Il n'est pas nécessaire d'arrêter l'enregistreur de trafic, vous pouvez le laisser s'exécuter de façon permanente.

Démarrer en tant que service Windows

Vous pouvez exécuter l'enregistreur de trafic en tant que service, à l'aide de l'exécutable service.js qui se trouve dans le dossier Service. Le service utilise les privilèges du système local.
Remarque : Toutes les commandes de service doivent être exécutées avec des privilèges d'administrateur (Exécuter en tant qu'administrateur).

Pour démarrer le service, exécutez les commandes :

node service.js --install

node service.js --start

Commandes de service supplémentaires

Vous pouvez imprimer cette liste en exécutant la commande node service.js --help

Commandes de service Description
--start Démarrer le service
--stop Arrêter le service
--install Installer le service
--uninstall Arrêter et désinstaller le service
--h | --help Informations d'utilisation de sortie

Arrêter le service Windows

Pour arrêter le service Windows de l'enregistreur de trafic à l'aide de l'exécutable service.js qui se trouve dans le dossier "Service", exécutez la commande :

node service.js --uninstall

Démarrer en tant que service Linux à l'aide de systemd

  1. Créez un fichier sous le répertoire systemd (généralement : /etc/systemd/system). Par exemple, sudo vim /etc/systemd/system/TrafficRecorder.service.

    Contenu du fichier :

    [Unité]

    Description=Appscan TrafficRecorder

    After=multi-user.target

    [Service]

    ExecStart=[chemin d'accès au nœud ici] [chemin d'accès à app.js ici]

    Restart=always

    RestartSec=10StandardOutput=syslog

    StandardError=syslog

    SyslogIdentifier=TrafficRecorder

    [Installer]

    WantedBy=multi-user.target

    Exemple pour ExecStart : ExecStart= node /home/admin/Documents/TrafficRecorder.Linux.1.2.0/app.js

  2. Rechargez les fichiers systemd à l'aide de la commande : sudo systemctl daemon-reload
  3. Démarrez le service à l'aide de la commande suivante : sudo systemctl start TrafficRecorder.service
  4. Vous pouvez vérifier le statut à l'aide de la commande : sudo systemctl status TrafficRecorder.service
    Remarque : Le statut doit être « Active: active (running) »
  5. Activez le service à l'aide de la commande : sudo systemctl enable TrafficRecorder.service

Arrêter le service Linux

  1. Arrêtez le service à l'aide de la commande : sudo systemctl stop TrafficRecorder.service
  2. Désactivez le service à l'aide de la commande : sudo systemctl disable TrafficRecorder.service

Utilisation de l'enregistreur de trafic

Une fois que l'enregistreur de trafic a démarré, vous pouvez lancer de nouvelles instances de l'enregistreur de trafic, pour enregistrer le trafic de votre application.

  1. Pour lancer une instance de l'enregistreur de trafic, utilisez la requête de l'API REST : StartProxy
  2. Envoyez votre trafic vers l'application que vous testez, via le port de l'enregistreur de trafic défini.
  3. Lorsque vous avez terminé, envoyez la demande API REST : StartProxy.
  4. Téléchargez le fichier .dast.config, lequel contient le trafic enregistré, en envoyant la requête d'API REST suivante : Traffic. Le fichier est une archive ZIP contenant un ou plusieurs fichiers .har (HTTP Archive). Lorsque vous téléchargez ce fichier, les données sont supprimées de l'enregistreur de trafic AppScan.
  5. Vous pouvez utiliser le fichier .dast.config pour mettre à jour les données d'exploration d'un travail existant, à l'aide de l'API REST ASE. Voir le lien vers la documentation : https://<domain>:9443/ase/api/pages/apidocs.html. Pour plus d'informations, voir la section Commandes de l'API de l'enregistreur de trafic.

Commandes de l'API de l'enregistreur de trafic

Une fois que l'enregistreur de trafic a démarré, vous pouvez lancer une instance de l'enregistreur de trafic et envoyer votre trafic vers votre application.

Documentation

Pour consulter la documentation d'API REST complète dans Swagger, saisissez ce qui suit dans un navigateur : https://<server>:<port>

Toutes les commandes pointent vers un nœud final qui ressemble à ceci :

https://[server]:[port]/automation/

server = adresse IP de la machine sur laquelle l'enregistreur de trafic est installé (la valeur par défaut est localhost).

port = port sur lequel l'enregistreur de trafic écoute

"StartProxy"

Démarrez une instance de l'enregistreur de trafic qui écoute sur le port spécifié.
  • URL : https://[server]:[port]/automation/StartProxy/<recordingPort>
  • Type de demande : POST ou GET (en cas d'utilisation de chainedProxy, proxyCertificate et clientCertificate, la requête est POST.

"StopProxy"

Arrêtez l'instance de l'enregistreur de trafic qui écoute sur le port spécifié.
  • URL : https://[server]:[port]/automation/StopProxy/<recordingPort>
  • Type de demande : GET
Remarque : La définition du port sur 0 n'arrête pas toutes les instances de l'enregistreur de trafic ouvertes. Pour ce faire, utilisez StopAllProxies.

"StopAllProxies"

Arrêtez toutes les instances de l'enregistreur de trafic en cours d'exécution. Cette commande permet d'arrêter toutes les instances de l'enregistreur de trafic sur tous les ports, y compris ceux démarrés par d'autres utilisateurs.

  • URL : https://[server]:[port]/automation/StopAllProxies
  • Type de demande : POST

"EncryptDastConfig"

Chargez le fichier DAST.CONFIG pour le chiffrer.
  • URL : https://[server]:[port]/automation/EncryptDastConfig
  • Type de demande : POST

"DownloadEncryptedDast"

Téléchargez un fichier .dast.config chiffré (chargé à l'aide de l'API EncryptDastConfig).
Remarque : Lorsque le fichier a été téléchargé, les fichiers .dast.config chiffrés et déchiffrés sont supprimés de l'enregistreur de trafic.
  • URL : https://[server]:[port]/automation/DownloadEncryptedDastConfig/<uuid>
  • Type de demande : GET

"Traffic"

Téléchargez les données enregistrées à partir de l'enregistreur de trafic identifié par son port, comme un fichier .dast.config.
  • URL : https://[server]:[port]/automation/Traffic/<recordingPort>
  • Type de demande : GET

"Certificate"

Téléchargez l'autorité de certification racine autosignée utilisée par l'enregistreur de trafic en tant que fichier PEM.
  • URL : https://[server]:[port]/automation/Certificate
  • Type de demande : GET