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,--openSourceOnly

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 : Spécifiez -d <save_path>, où <save_path> correspond au répertoire dans lequel vous souhaitez enregistrer le fichier IRX.
  • -dr, --dryrun : Spécifiez -dr or --dryrun pour découvrir et valider les cibles de l'examen, mais pas pour générer un fichier .irx.
  • -jdk : Spécifiez -jdk <jdk_path> pour préciser le chemin d'accès à l'installation du 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 : Spécifiez -l <log_path>, où <log_path> correspond au répertoire dans lequel vous souhaitez enregistrer les fichiers journaux.
  • -n : Spécifiez -n <file_name>, où <file_name> correspond au nom du fichier IRX. Vous pouvez indiquer le nom du fichier avec ou sans l'extension de fichier .irx. Si vous le spécifiez sans l'extension, celle-ci est ajoutée automatiquement lorsque le fichier est généré.
  • -nc, --noConfigFiles : Désactive le traitement des fichiers de configuration pour l'analyse de composition logicielle (SCA).
  • -oso, --openSourceOnly : Spécifiez -oso ou --openSourceOnly afin de rechercher uniquement les vulnérabilités connues dans des packages SCA. Lorsque -oso ou --openSourceOnly 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 ce fichier de configuration, c:\my_config_files\my_config.xml (et qui enregistre le fichier IRX sous c:\my_irx_files\my_scan.irx), exécutez 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 l'analyse de la composition du logiciel (SCA). Lorsqu'elle est exécutée sans paramètres, cette commande équivaut à exécuter appscan prepare -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 : Spécifiez -d <save_path>, où <save_path> correspond au répertoire dans lequel vous souhaitez enregistrer le fichier IRX.
  • -l : Spécifiez -l <log_path>, où <log_path> correspond au répertoire dans lequel vous souhaitez enregistrer les fichiers journaux.
  • -n : Spécifiez -n <file_name>, où <file_name> correspond au nom du fichier IRX. Vous pouvez indiquer le nom du fichier avec ou sans l'extension de fichier .irx. Si vous le spécifiez sans l'extension, celle-ci est ajoutée automatiquement lorsque le fichier est généré.
  • -X,--debug : Spécifiez -X ou --debug pour exécuter la commande complète en mode de débogage. Lors d'une exécution en mode de débogage, davantage de fichiers journaux sont générés pour le dépannage.
  • -container : Spécifiez -container <container>, où <container> correspond à 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>, où <image> correspond à 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 connecté à Internet, cette commande n'est pas requise, étant donné qu'une clé de chiffrement est automatiquement téléchargée lorsque vous exécutez la commande prepare. Si une clé de chiffrement existe déjà sur l'ordinateur, elle est mise à jour, si nécessaire, lorsque vous exécutez 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 cette clé de chiffrement sur cet ordinateur, vous devez conserver le nom du fichier rsa.pub et placer le fichier dans le répertoire config du fichier SAClientUtil_<version>_<os>.zip extrait (où <version> correspond à la version actuelle 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, réexécutez 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 : Spécifiez -d <save_path>, où <save_path> correspond au répertoire dans lequel vous souhaitez enregistrer la clé de chiffrement. Si cette option n'est pas spécifiée, la clé est enregistrée dans le répertoire config du fichier SAClientUtil_<version>_<os>.zip extrait.