Commandes d'analyse (Linux™ et macOS)

Les commandes d'analyse servent à envoyer des requêtes d'examen à des fins d'analyse, ou à utiliser des requêtes d'examen qui ont déjà été envoyées. Ces commandes permettent également de recevoir des informations sur les examens. Ces informations peuvent s'avérer utiles pour les scripts d'automatisation.

Avant d'utiliser ces commandes, veillez à vous connecter au service d'analyse (voir Commandes d'authentification).

appscan.sh status

Syntaxe :

appscan.sh status -i <job_id>

Description :

cette commande renvoie l'un des codes de statut suivants pour un travail d'analyse :

0 = Pending
1 = Starting
2 = Running
3 = FinishedRunning
4 = FinishedRunningWithErrors
5 = PendingSupport
6 = Ready
7 = ReadyIncomplete
8 = FailedToScan
9 = ManuallyStopped
10 = None
11 = Initiating
12 = MissingConfiguration
13 = PossibleMissingConfiguration

Options requises :

  • -i : Spécifiez -i <job_id>, où <job_id> correspond à l'ID du travail d'analyse.
Conseil : Pour toutes les commandes, les options peuvent être utilisées dans n'importe quel ordre.

Exemples :

pour afficher le statut de l'ID du travail 12345, indiquez ceci :

appscan.sh status -i 12345

Si le code retour est 0, cela signifie que le travail est en attente. Si le code retour est 1, cela signifie que le travail est en cours de démarrage, et ainsi de suite.

appscan.sh list

Syntaxe :

appscan.sh list

Description :

Répertoriez tous les travaux d'analyse, y compris ceux qui sont en file d'attente, en cours d'exécution et terminés. L'ID de chaque travail est renvoyé afin que vous puissiez utiliser l'ID pour d'autres commandes. Par exemple, vous pouvez utiliser l'ID avec la commande info dans l'invite de commande ou dans des scripts.

appscan.sh list_apps

Syntaxe :

appscan.sh list_apps

Description :

HCL Cloud Marketplace uniquement : Si vous êtes connecté au service AppScan on Cloud sur HCL Cloud Marketplace, les fichiers IRX que vous envoyez vers le cloud doivent être associés à une application AppScan on Cloud existante.

Cette commande vous permet de voir les applications AppScan on Cloud auxquelles vous avez accès. Pour utiliser la commande, vous devez être authentifié au service. Après avoir lancé la commande, une liste d'applications AppScan on Cloud s'affiche et indique les noms des applications suivis de leurs ID entre parenthèses. Utilisez les valeurs d'ID de cette liste lorsque vous utilisez l'option -a de la commande queue_analysis.

appscan.sh cancel

Syntaxe :

appscan.sh cancel -i <job_id>

Description :

Annulez un travail d'analyse qui est en cours d'exécution ou en file d'attente.

Options requises :

  • -i : Spécifiez -i <job_id>, où <job_id> correspond à l'ID du travail d'analyse.
Conseil : Pour toutes les commandes, les options peuvent être utilisées dans n'importe quel ordre.

Exemples :

Pour annuler l'ID du travail 12345, indiquez ceci :

appscan.sh cancel -i 12345

appscan.sh queue_analysis

Syntaxe :

appscan.sh queue_analysis -a <app_id> -f <file> -di -n <scan_name> -nen -oso -ps -sao

Description :

Soumettre un fichier pour analyse (archive IRX ou non-IRX). Une fois l'examen terminé, vous recevez une notification par e-mail (à l'adresse e-mail associée au compte qui a été utilisé pour la connexion au service d'analyse). L'e-mail contient un lien qui vous permet de vous connecter pour télécharger votre examen.
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).
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).

Options requises :

  • -a : Les fichiers que vous envoyez pour analyse (fichierIRX ou archive non-IRX) doivent être associés à une application AppScan on Cloud existante. Avec cette option, spécifiez -a <app_id>, où <app_id> correspond à l'ID de l'application à laquelle les fichiers doivent être associés. Pour déterminer l'ID, utilisez la commande list_apps.
  • -f : Spécifiez -f <file>, où <file> correspond au fichier IRX ou à l'archive non-IRX que vous souhaitez envoyer pour examen. Si le fichier ne se trouve pas dans le répertoire de travail, utilisez cette option pour spécifier le chemin et le nom du fichier.
    Remarque : Cette option est uniquement requise si l'une des deux affirmations suivantes est vraie :
    • Vous lancez la commande depuis un répertoire qui contient plusieurs fichiers cibles. Si le répertoire ne contient qu'un seul fichier cible, ce fichier est envoyé, à condition que l'option -f ne soit pas utilisée.
    • Vous lancez la commande depuis un répertoire qui ne contient pas de fichiers cibles. Dans ce cas, vous devez utiliser l'option -f pour spécifier le chemin d'accès et le nom du fichier à envoyer.
Indicateurs/paramètres en option :
  • -di : Désactive l'intervention. Si votre examen échoue pour une raison quelconque, l'équipe d'activation des examens n'intervient pas pour tenter d'améliorer la configuration. Par défaut, lorsqu'un examen échoue, il passe sur le statut En cours de révision pour attendre l'intervention de l'équipe d'activation des examens. Spécifiez -di pour désactiver cette intervention ; l'examen échoue simplement.
  • -n : Spécifiez -n <scan_name>, où <scan_name> correspond au nom de l'examen envoyé.
  • -nen : Désactivez la notification par e-mail à la fin de l'analyse. Si cet indicateur n'est pas spécifié, la notification par e-mail est effectuée par défaut.
    Remarque : L'indicateur -e, désormais obsolète, a été remplacé par -nen.
  • -oso : Spécifiez -oso afin de rechercher uniquement les vulnérabilités connues dans des packages SCA. Lorsque -oso est spécifié, AppScan on 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.
  • -ps : Exécutez l'examen en tant qu'examen personnel. Si cet indicateur n'est pas spécifié, un examen régulier se produit par défaut.
  • -sao : Spécifiez -sao pour effectuer une analyse statique uniquement. Lorsque -sao est spécifié, AppScan on Cloud n'effectue pas d'analyse Open Source du package.
Conseil : Pour toutes les commandes, les options peuvent être utilisées dans n'importe quel ordre.

Exemples :

Pour envoyer my_irx.irx, situé dans le répertoire actuel, à des fins d'examen, utilisez
appscan queue_analysis -f my_irx.irx -a 12345 -n my_scan
Où 12345 correspond à l'ID de l'application à laquelle associer l'examen (il est possible de déterminer l'ID de l'application à l'aide de la commande list_apps). Si vous utilisez l'interface utilisateur ou la commande list pour afficher tous les examens en cours, my_scan figure dans la liste.
Lorsque le fichier IRX est créé sans spécifier soit l'analyse Open Source uniquement (SCA), soit l'analyse statique uniquement, ces options peuvent être appliquées au moment de l'analyse à l'aide des options -oso ou -sao avec appscan queue_analysis. Dans cet exemple, la commande suivante envoie le fichier pour l'analyse Open Source et statique :
appscan queue_analysis -a <application> -f my_irx.irx
Le fichier suivant est envoyé pour analyse statique uniquement :
appscan queue_analysis -a <application> -f <file> -sao
Les éléments suivants envoient le fichier pour l'analyse Open Source (SCA) uniquement :
appscan queue_analysis -a <application> -f <file> -os
Inversement, si un fichier est créé et que seule l'analyse statique ou l'analyse Open Source (SCA) est spécifiée avec appscan prepare, la commande de base
appscan queue_analysis -a <application> -f my_irx.irx
envoie le fichier uniquement pour le type d'analyse spécifié avec la commande appscan prepare.

appscan.sh info

Syntaxe :

appscan.sh info -i <job_id>

Description :

Affichez les informations pour un travail d'analyse spécifié.

Les informations fournies peuvent être utilisées pour les scripts d'automatisation.

Options requises :

  • -i : Spécifiez -i <job_id>, où <job_id> correspond à l'ID du travail d'analyse.
Conseil : Pour toutes les commandes, les options peuvent être utilisées dans n'importe quel ordre.

Exemples :

Pour recevoir des informations à propos de l'ID du travail 12345, indiquez ceci :

appscan.sh info -i 12345

Exemple d'informations renvoyées :

NLowIssues=0
ReadStatus=2
NHighIssues=0
Name=appscan.zip
ScanEndTime=2014-11-20T13:56:04.497Z
Progress=0
RemainingFreeRescanMinutes=0
ParentJobId=00000000-0000-0000-0000-000000000000
EnableMailNotifications=false
JobStatus=6
NInfoIssues=0
JobId=9b344fc7-bc70-e411-b922-005056924f9b
NIssuesFound=0
CreatedAt=2014-11-20T13:54:49.597Z
UserMessage=Scan completed successfully. The report is ready.
NMediumIssues=0
Result=1