Commandes de configuration (Windows)

Utilisez les commandes de configuration pour préparer vos fichiers à l'examen.

appscan prepare

Syntaxe :

appscan prepare -c <configuration_file> -d <save_path> -jdk <jdk_path> -l <log_path> -n <file_name> -nc, --noConfigFile -oso 

Description :

Générez un fichier IRX.

Remarque : Lorsque vous examinez du code ou générez un fichier IRX, vous pouvez recevoir un message relatif à la mise à jour vers l'Utilitaire de ligne de commande Static Analyzer le plus récent. Voir Support de l'utilitaire de ligne de commande (CLI).

Indicateurs/paramètres en option :

  • -c : cette option sert à configurer un examen.
  • -d : Indiquez -d <save_path>, où <save_path> est le répertoire dans lequel vous souhaitez sauvegarder le fichier IRX.
  • -dr, --dryrun: Indiquez -dr ou --dryrun pour découvrir et valider les cibles de l'examen, mais pas pour générer un fichier .irx.
  • -jdk : Indiquez -jdk <jdk_path> pour préciser le chemin d'accès à votre installation JDK à utiliser à la place du JDK 17 par défaut. Si vous utilisez un fichier de configuration (-c <configuration_file>)et que l'attribut jdk_path est utilisé, la valeur spécifiée dans le fichier de configuration est prioritaire.
  • -l : indiquez -l <log_path>, où <log_path> est le répertoire dans lequel vous souhaitez enregistrer les fichiers journaux.
  • -n : Indiquez -n <file_name>, où <file_name> est le nom du fichier IRX. Vous pouvez indiquer le nom du fichier avec ou sans l’extension de fichier .irx. Si vous l'indiquez sans l'extension, celle-ci est automatiquement ajoutée lors de la génération du fichier.
  • -nc, --noConfigFiles: Désactive le traitement des fichiers de configuration pour Software Composition Analysis (SCA).
  • -oso : Indiquez -oso afin de ne rechercher que des vulnérabilités connues dans des packages SCA. Lorsque -oso est spécifié, AppScan sur Cloud n'effectue pas d'analyse statique du package.
    Remarque : Lorsqu'un utilisateur dispose d'une licence Open Source, l'analyse SCA fait partie d'un examen statique par défaut. Cette option limite l'analyse aux vulnérabilités SCA. Les utilisateurs doivent disposer d'une licence Open Source pour bénéficier de l'analyse SCA uniquement.
Conseil : Pour toutes les commandes, les options peuvent être utilisées dans n'importe quel ordre.

Exemples :

Pour générer un fichier IRX qui utilise le fichier de configuration, c:\my_config_files\my_config.xml et pour sauvegarder le fichier IRX dans c:\my_irx_files\my_scan.irx, émettez la commande suivante :

appscan prepare -c c:\my_config_files\my_config.xml -d c:\my_irx_files -n my_scan.irx

appscan prepare_sca

Syntaxe :

appscan prepare_sca -d <save_path> -l <log_path> -n <file_name> -X, -debug -container <container> -image <image>

Description :

Générez un fichier IRX sur une image Docker pour exécuter Software Composition Analysis (SCA). Lorsqu'elle est exécutée sans paramètres, cette commande équivaut à exécuter appscanprepare -oso.
Important : Les outils d'interface de ligne de commande Docker doivent être installés et configurés sur le système pour examiner les conteneurs et les images Docker.

Indicateurs/paramètres en option :

  • -d : Indiquez -d <save_path>, où <save_path> est le répertoire dans lequel vous souhaitez sauvegarder le fichier IRX.
  • -l : indiquez -l <log_path>, où <log_path> est le répertoire dans lequel vous souhaitez enregistrer les fichiers journaux.
  • -n : Indiquez -n <file_name>, où <file_name> est le nom du fichier IRX. Vous pouvez indiquer le nom du fichier avec ou sans l’extension de fichier .irx. Si vous l'indiquez sans l'extension, celle-ci est automatiquement ajoutée lors de la génération du fichier.
  • -X,--debug : indiquez -X ou --debug pour exécuter la commande complète en mode de débogage. Dans ce mode, des fichiers journaux supplémentaires sont générés pour le traitement des incidents.
  • -container : Spécifiez -container <container><container> est un conteneur Docker à analyser. La valeur peut être un nom de conteneur, un historique de conteneur ou le chemin d'accès à une archive locale.
  • -image : Spécifiez -image <image><image> est une image Docker à analyser. La valeur peut être un nom d'image, un historique d'image ou le chemin d'accès à une archive locale.
Conseil : Pour toutes les commandes, les options peuvent être utilisées dans n'importe quel ordre.

appscan get_pubkey

Syntaxe :

appscan get_pubkey -d <save_path>

Description :

Téléchargez la clé de chiffrement publique pour l'utiliser sur un ordinateur qui n'est pas connecté à internet.

Si vous générez un fichier IRX depuis un ordinateur qui est connecté à Internet, cette commande est inutile, car une clé de chiffrement est téléchargée automatiquement lorsque vous entrez la commande prepare. Si une clé de chiffrement existe déjà sur l'ordinateur, elle est mise à jour, si nécessaire, lorsque vous entrez la commande prepare.

Cependant, si vous générez un fichier IRX depuis un ordinateur qui n'est pas connecté à Internet, vous pouvez télécharger la clé de chiffrement à l'aide de cette commande. Vous pouvez ensuite copier la clé de chiffrement sur l'ordinateur qui n'est pas connecté à Internet pour ensuite l'utiliser lorsque vous générez le fichier IRX. Pour utiliser la clé de chiffrement sur cet ordinateur, vous devez conserver le nom de fichier rsa.pub et placer le fichier dans le répertoire config du fichier SAClientUtil_<version>_<os>.zip extrait (où <version> est la version en cours de l'Utilitaire de ligne de commande).

Remarque : La clé de chiffrement utilisée doit être à jour. Si un fichier IRX est généré avec une clé de chiffrement obsolète, le fichier IRX est alors rejeté lors de son chargement. Si votre ordinateur est connecté à Internet, entrez à nouveau la commande prepare pour mettre à jour automatiquement la clé de chiffrement. Si votre ordinateur n'est pas connecté à Internet, vous devez utiliser la commande get_pubkey.

Indicateurs/paramètres en option :

  • -d : indiquez -d <save_path>, où <save_path> est le répertoire dans lequel vous souhaitez enregistrer la clé de chiffrement. Si cette option n'est pas spécifiée, la clé est sauvegardée dans le répertoire config du fichier SAClientUtil_<version>_<os>.zip extrait.