Installation personnalisée d'AppScan 360° sur une seule machine virtuelle

L'installation personnalisée vous permet de tester AppScan 360° avec une configuration complète. Vous pouvez installer la machine virtuelle unique en mode hors ligne ou en ligne.

Remarque : Effectuez toutes les activités d'installation et de configuration en tant qu'administrateur sur le système cible.
Pour installer AppScan 360° sur une seule machine virtuelle :
  1. Le script de configuration d'AppScan 360° sur une seule machine virtuelle pose une série de questions pour configurer votre environnement. Vérifiez les informations de configuration dans la section Configuration d'un environnement à une seule machine virtuelle et rassemblez les données nécessaires pour finaliser l'installation.

  2. Téléchargez le script d'AppScan 360° pour une seule machine virtuelle et les fichiers d'installation d'AppScan 360° à partir du portail MyHCLSoftware vers un emplacement de répertoire unique sous /home/username. Par exemple, /home/username/AppScan360_singleVM.
    Les fichiers inclus dans le répertoire doivent être les suivants :
    • Exécutez l'une des opérations suivantes :
      • AppScan360_SingleVMsetup_v2.0.0_Online.run
      • AppScan360_SingleVMsetup_v2.0.0_Offline.run
    • AppScan360_v2.0.0.run
    • AppScan360_ASRA_v2.0.0.run
    • AppScan360_SCA_v2.0.0.run (en option)
  3. Renommez les fichiers téléchargés comme suit :
    mv AppScan360_v2.0.0.run ascp-AppScan360_v2.0.0.run
    mv AppScan360_v2.0.0.run asra-AppScan360_ASRA_v2.0.0.run
    mv AppScan360_SCA_v2.0.0.run sca-AppScan360_SCA_v2.0.0.run # (Optional)
  4. Créez un répertoire d'installation et déplacez tous les fichiers à cet endroit. Tous les fichiers du kit d'installation doivent se trouver dans le même répertoire.
    mkdir -p ~/aio-setup
    mv *.run ~/aio-setup/
  5. Dans le dossier d'installation, fournissez l'autorisation exécutable au programme d'installation en exécutant :
    cd ~/aio-setup
    chmod +x *.run
  6. Si vous utilisez des certificats personnalisés ou auto-signés pour des services tels que SSO (LDAP, OIDC) ou SMTP, préparez le dossier des certificats.
    Remarque : Cette étape est facultative pour l'installation rapide ; elle est requise pour l'installation personnalisée.
    ./AppScan360_SingleVMsetup_v2.0.0_Online.gz.run -- $PWD prepareCertsFolders
    La commande crée la structure de dossiers suivante :
    Dossier Fonction
    ~/aio-setup/certs/ Dossier de certificats principal
    ~/aio-setup/certs/docker/ Certificats de registre Docker (non requis pour le mode POC)
    ~/aio-setup/certs/ldap/ Certificats LDAP (pour la prise en charge LDAPS)
    ~/aio-setup/certs/smtp/ Certificats SMTP (pour la prise en charge SMTPS)
    ~/aio-setup/certs/oidc/ Certificats OIDC (pour la prise en charge OIDCS)
    ~/aio-setup/certs/ingress/ Certificats d'entrée (en option, les certificats auto-signés sont générés s'ils ne sont pas fournis)
    Important : Après avoir créé la structure de dossiers, placez les certificats dans les dossiers appropriés avant de continuer.
  7. Exécutez le script d'installation :
    Remarque : Spécifiez l'emplacement du dossier des fichiers, même si vous effectuez l'installation à partir de l'emplacement du dossier.
    cd ~/aio-setup
    ./AppScan360_SingleVMsetup_v2.0.0_Online.gz.run -- $PWD
    Remarque :
    • Pour arrêter l'installation pour quelque raison que ce soit, appuyez sur CTRL+C, puis exécutez
      cd aioWorkspace
      ./disengageAS360-AIO.sh
    • Les fichiers journaux d'installation se trouvent dans ./aioWorkspace/logs
  8. Lorsque vous y êtes invité, saisissez 2 pour spécifier Installation personnalisée. Appuyez sur Entrée.
  9. La procédure d'installation pose une série de questions et vous demande de confirmer chaque réponse. Répondez aux questions et aux invites comme indiqué :
    1. > Will this production deployment include Software Composition Analysis (SCA)? This requires license. (y/n) [Default: n]:
      La valeur par défaut est n.
      • o : Incluez le composant d'analyse de la composition logicielle (SCA) dans votre installation. L'analyse SCA vous permet d'analyser les applications pour détecter les vulnérabilités des composants Open Source.
      • n : N'incluez pas le composant d'analyse de la composition logicielle (SCA) dans votre installation.
    2. > To ensure system stability, we strongly recommend validating your server's hardware against your expected workload. This helps prevent scan failures and performance issues after installation. Do you want to perform this resource check now? (y/n) [Default: y]:
      La valeur par défaut est o.
      • o : Validez les ressources matérielles par rapport à votre charge de travail d'examen prévue. Cette opération est recommandée pour les environnements de production.
        Indiquez le nombre attendu d'examens simultanés :
        🖥️ *** Production Workload & Resource Planning ***
        📊 To calculate hardware requirements, please specify the maximum number of scans you expect to run at the same time (concurrently).
        💡 You can enter 0 if a scan type will not be used.
        
        > Enter desired number of concurrent STATIC (SAST) scans [Default: 1]:
        > Enter desired number of concurrent DYNAMIC (DAST) scans [Default: 1]:
        > Enter desired number of concurrent INTERACTIVE (IAST) scans [Default: 1]:
        Si vous avez choisi d'activer l'analyse SCA, indiquez le nombre attendu d'examens SCA simultanés :
        Enter desired number of concurrent SCA scans [Default: 1]:
      • n : Ignorez la validation des ressources.
    3. Les installations de production doivent configurer une base de données MSSQL externe. Répondez aux invites au fur et à mesure qu'elles s'affichent.
      • 🛢️ *** Database Configuration ***
        > Enter Database Hostname or IP:
      • > Enter Database Port [Default: 1433]:
      • > Enter Database User for AppScan:
      • > Enter Database User Password:
      • > Enter the name for the main AppScan database [Default: AppScan360DB]:
    4. Si vous avez choisi d'inclure l'analyse de la composition logicielle (SCA) dans l'installation :
      • Saisissez le nom de la base de données SCA :
        > Please provide a name for the new SCA database [Default: AppScan360_SCA_DB]:
      • Saisissez le nom de la base de données d'agrégation SCA :
        > Please provide a name for the new SCA Aggregation database [Default: > AppScan360_SCA_Aggregation_DB]:
      • Saisissez les informations de registre pour les mises à jour SCA ou acceptez les valeurs par défaut, le cas échéant :

        > SCA Registry Address [Default: hclcr.io]:
        > SCA Registry Path [Default: appscan360/as360-k8s-docker-images]:
        > SCA Registry Username (typically your HCL ID):
        > SCA Registry Password/Token:
    5. > Please enter the primary domain name for this installation. This will be used to create the access URL (e.g., yourcompany.com):

      Il s'agit d'un champ obligatoire sans valeur par défaut. Le nom de domaine spécifié est utilisé pour créer l'URL d'accès de votre instance AppScan 360°. Par exemple, si vous saisissez appscan-test.local, votre URL AppScan 360° sera https://hostname.appscan-test.local.

      Le nom de domaine doit être facile à mémoriser et unique dans votre environnement réseau, et ne doit pas entrer en conflit avec les domaines existants.

    6. > Please enter the external domain(s) or IP(s) that this instance will need to access for external services(such as SSO, SMTP, etc.). Separate multiple entries with commas:

      Saisissez tous les domaines ou adresses IP auxquels votre instance AppScan 360° doit se connecter, tels que :

      • Serveurs SMTP pour les notifications par e-mail

      • Fournisseurs d'authentification SSO (LDAP, OIDC)

      • Outils CI/CD externes

      Séparez les différentes entrées par des virgules. Laissez vide si aucun service externe n'est nécessaire.

    7. > Is the VM connected with the local DNS server (y/n)? 

      La valeur par défaut est n.

      • o : Votre machine virtuelle est connectée à un serveur DNS. Le système utilise le nom d'hôte pour les configurations liées au réseau.
      • n : Votre machine virtuelle n'est connectée à aucun serveur DNS. Le système utilise les adresses IP directement pour les configurations liées au réseau.
    8. > To plan for long-term storage costs, estimate the number of scan results you plan to retain. > Specify the shared storage capacity in GB [Default: 200]:
      Ce stockage est utilisé pour les journaux, les fichiers de configuration, les données persistantes et les journaux d'examen partagés entre les composants. La valeur par défaut est 200GB.
      • Appuyez sur Entrée pour accepter la valeur par défaut, ou
      • Saisissez un numéro différent pour spécifier une valeur de stockage personnalisée, puis appuyez sur Entrée.
    9. > Do you want to connect with your SMTP Mail Relay (SMR)(y/n)? 

      La valeur par défaut est n.

      Un relais de messagerie SMTP est un serveur intermédiaire qui accepte les e-mails sortants de votre système et les transfère aux serveurs de messagerie des destinataires. Le relais permet de garantir la transmission des e-mails et peut appliquer certaines règles telles que le filtrage des spams. Dans AppScan 360°, configurez un relais pour recevoir des notifications par e-mail lorsqu'un un examen est terminé, si un examen planifié a été lancé, etc.

      • o : intégrez AppScan 360° avec un relais de messagerie SMTP pour envoyer des e-mails depuis le déploiement. Lorsque vous sélectionnez y, saisissez l'hôte, le port, les informations d'identification et les détails de chiffrement appropriés lorsque le SMR vous invite à finaliser la connexion :
        • > Please enter the SMTP host:
        • > Please enter the SMTP port:

          Le numéro de port est généralement 25, 465 ou 587.

        • > Please enter the SMTP username:

          Si l'authentification est requise.

        • Please enter the SMTP password:

          Si l'authentification est requise.

        • > Does your SMTP server use SSL/TLS? If yes, a certificate is required to be present in certs/smtp folder (y/n)?
      • n : aucun serveur SMTP n'est configuré ; les utilisateurs ne peuvent pas recevoir de notifications par e-mail associées.
  10. Indiquez la configuration du registre Docker :
    • > What is the external Docker Private Registry (DPR) address (FQDN:PORT)?
    • > What is the external Docker Private Registry (DPR) username?

      Si l'authentification est requise

    • > What is the external Docker Private Registry (DPR) password?

      Si l'authentification est requise

    • 🐳 Docker registry and Helm repository context names are used to set the context for docker images and helm charts.
      💡 To set these to an empty string(root repository), type EMPTY
      ------------------------------------------------------------------------------------------------
      > What is the docker registry context/repository name [Default: as360-k8s-docker-images]:
    • > What is the helm repository context/repository name [Default: as360-k8s-helm-packages]:
  11. Souhaitez-vous utiliser un service proxy ? (o/n) [Par défaut : n] :
    La valeur par défaut est n.
    • o : Configurez un service proxy.
      • > What is the proxy host?
      • > What is the proxy port?
      • > Does the proxy require user/password credentials? (y/n):
      • > What is the proxy username?:
      • > What is the proxy password?:
    • n : Ignorez la configuration du proxy.
  12. L'installation affiche un résumé de vos choix et vous demande si vous souhaitez poursuivre l'installation.
    ✅ Summary of your choices:
      Installation Mode: Custom (Production)
      Install SCA Kit: [y/n]
      Domain: [your domain]
      Connected to Local DNS: [y/n]
      Storage Size: [size]GB
      Use SMTP Mail Relay: [y/n]
      Docker Private Registry Address: [address]
      Scan Concurrency: SAST=[n], DAST=[n], IAST=[n], SCA=[n]
      MSSQL Host: [host], Port: [port], DB: [database]
      [Additional configuration details...]
    > Continue with installation? (y/n) [Default: y]:

    Vérifiez que les informations sont correctes et saisissez o.

    L'installation se poursuit avec l'installation et la configuration :
    • Cluster Kubernetes (K0S)
    • AppScan 360° plateforme centrale et composants.
    • Conseils de résolution AppScan (ASRA)
    • Analyse de la composition logicielle (SCA), si sélectionnée
    • Connexions à votre base de données externe et au registre Docker
    L'installation peut prendre un certain temps en fonction de votre système et de la vitesse du réseau. A l'issue de l'installation, un message d'achèvement s'affiche :
    The AS360 Single VM was installed, to access it do the following:
      1. Add to your 'hosts' file the following line: [IP_ADDRESS] [HOSTNAME].[DOMAIN]
      2. Access https://[HOSTNAME].[DOMAIN] in your browser
  13. Ajoutez l'adresse IP et le nom d'hôte fournis pour votre fichier hôte.
    Système d'exploitation Emplacement du fichier hôte
    Linux, macOS /etc/hosts
    Windows C:\Windows\System32\drivers\etc\hosts
    Exemple :
    192.168.1.100 appscan.appscan-test.local

Connexion et activation AppScan 360°

Pour vous connecter et activer AppScan 360° :
  1. Accéder à l'interface AppScan 360° à l'aide de l'URL spécifiée (https://[HOSTNAME].[DOMAIN])
  2. Connectez-vous avec les informations d'identification par défaut :
    • Nom d'utilisateur : Admin
    • Mot de passe : Admin123!
  3. Chargez votre fichier de licence AppScan 360° pour activer le produit.
Remarque : Nous vous recommandons d'effectuer des sauvegardes régulières, notamment des éléments suivants :
  • une base de données.
  • Fichiers de configuration dans le répertoire d'installation.
  • Informations de licence.

Modification de la méthode d'installation

Si après l'installation et l'utilisation de l'installation rapide d'AppScan 360° sur une seule machine virtuelle, vous décidez d'installer la version de production d'AppScan 360° sur une seule machine virtuelle ou d'AppScan 360° dans un environnement distribué :

Problèmes d'installation courants

Problème Solution
Echecs de connexion à la base de données Vérifier les informations d'identification de la base de données et la connectivité réseau
Espace disque insuffisant S'assurer que la machine virtuelle dispose d'un espace de stockage adéquat, conformément aux exigences
Erreurs de certificat Vérifier les formats de certificat et les noms de fichier dans les dossiers certificats
Connectivité du registre Docker Vérifier les informations d'identification du registre et la connectivité réseau