AppScan 360° のシングル仮想マシンへのカスタム・インストール

カスタムインストールでは、完全な構成でAppScan 360° をテストすることができます。このインストールモードは、AppScan 360° の実動レベルの配置に使用できます。

注:
  1. ターゲット・システムで、すべてのインストールおよび設定作業を管理者として実行します。
  2. AppScan 360° シングル VM のセットアップ・スクリプトでは、環境を構成するため一連の質問を受けます。シングル VM 環境のセットアップ でセットアップ情報を確認し、インストールを完了するために必要な情報を収集します。

インストールファイルの準備

  1. MyHCLSoftware ポータルから、AppScan 360° シングル VM スクリプトと AppScan 360° インストール・ファイルを /home/username の下にある単一のディレクトリーにダウンロードします。例えば、/home/username/AppScan360_singleVM です。
    ディレクトリーに含まれるファイルは次のとおりです。
    • AppScan360_SingleVMsetup_v2.1.0.run
    • AppScan360_v2.1.0.run
    • AppScan360_ASRA_v2.1.0.run
    • AppScan360_DCTS_v2.1.0.run (DAST スキャン機能に必要)
    • AppScan360_SCA_v2.1.0.run (オプション)
  2. インストール用のディレクトリーを作成し、すべてのファイルをそこに移動します。すべてのインストール・キット・ファイルは同じディレクトリーにある必要があります。
    mkdir -p ~/aio-setup
    mv *.run ~/aio-setup/
  3. インストール・フォルダーで、次のコマンドを実行してインストーラーに実行可能権限を与えます。
    cd ~/aio-setup
    chmod +x *.run

場所証明書 (必要に応じて)

  1. SSO (LDAP、OIDC) や SMTP などのサービスにカスタム証明書または自己署名証明書を使用する場合は、証明書フォルダーを準備します。
    sudo ./AppScan360_SingleVMsetup_v2.1.0.run -- $PWD prepareCertsFolders
    コマンドは、次のフォルダー構造を作成します。
    フォルダー 関数
    ~/aio-setup/certs/ メイン証明書フォルダー
    ~/aio-setup/certs/docker/ Docker レジストリー証明書 (POC モードでは不要)
    ~/aio-setup/certs/ldap/ LDAP 証明書 (LDAPS サポート用)
    ~/aio-setup/certs/smtp/ SMTP 証明書 (SMTPS サポート用)
    ~/aio-setup/certs/oidc/ OIDC 証明書 (OIDCS サポート用)
    ~/aio-setup/certs/ingress/ Ingress 証明書 (オプション、提供されない場合は自己署名が生成されます)
  2. フォルダー構造を作成したら、続行する前に適切なフォルダーに証明書を配置します。

アップグレード (☑️すべての手順に慎重に従う必要があります)

以前のバージョンからアップグレードするには、次の手順を実行します。
  1. helm を helm4 にアップグレードします。v2.1.0 から AS360 helm チャートには helm4 が必要です。
  2. prepareUpgrade を実行して、v2.1.0 ットアップ用の現在の環境を準備します
    cd ~/aio-setup
    sudo ./AppScan360_SingleVMsetup_v2.1.0.run -- $PWD prepareUpgrade
  3. 前のインストールのキットの横に answers ファイルを配置します。as360-aio-answers.env ファイルを以前のインストールワークスペース aioWorkspace/audit から現在のキットの場所に検索してコピーします。
    • これにより、アップグレード用に同じ answers/config が提供されます
    • それ以外の場合は、「インストールの実行」セクションで説明したすべての調査質問に、データベース、Docker レジストリー、共有ストレージサイズなどのリソースについて、以前と同じ answers で慎重に応答する必要があります。
  4. 証明書がある場合は、以前のインストールから現在のセットアップディレクトリーに同じ証明書フォルダーをコピーします。
  5. 次に、以下のコマンドを使用してインストールを実行します
注: フォルダーの場所からインストールしている場合でも、ファイルのフォルダーの場所 (この場合は現在の作業ディレクトリー) を指定します。
cd ~/aio-setup
sudo ./AppScan360_SingleVMsetup_v2.1.0.run -- $PWD

インストールの実行

  1. 以下のコマンドを使用してインストールを実行します
    注: フォルダーの場所からインストールしている場合でも、ファイルのフォルダーの場所 (この場合は現在の作業ディレクトリー) を指定します。
    cd ~/aio-setup
    sudo ./AppScan360_SingleVMsetup_v2.1.0.run -- $PWD
    注: 何らかの理由でインストールを中止するには、CTRL+C を押してから実行してください。
    cd aioWorkspace
    ./disengageAS360-AIO.sh
    インストール・ログ・ファイルは、./aioWorkspace/logs にあります。
  2. 次のようにプロンプトが表示されたら、1 を入力してカスタム/実動インストールを指定します。Enter キーを押します。
    Please select your installation path:
    1. 🚀  Express Mode (POC)
    2. 🛠️  Custom Mode (Production)
    Enter 1 or 2 [Default: 1]:
  3. インストール手順では、入力内容に基づいて一連の質問が行われます
    > Will this production deployment include Software Composition 
    Analysis (SCA)? This requires license. (y/n) [Default: n]:
    • デフォルトは n です。
      • y: お使いのインストール環境にソフトウェア・コンポジション分析 (SCA) を含めます。SCA でアプリケーションにオープン・ソース・コンポーネントの脆弱性がないか分析できます。
      • n: お使いのインストール環境でソフトウェア・コンポジション分析 (SCA) を含めないでください。
    • 本番インストールでは、外部 MSSQL データベースを構成する必要があります。プロンプトが表示されるので、適宜対応します。
      🛢️ *** 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: AppScanCloudDB]:
    • インストール環境にソフトウェア・コンポジション分析 (SCA) を含めることを選択した場合:
      • SCA データベース名を入力します。
        > Please provide a name for the new SCA database [Default:
         AppScan360_SCA_DB]:
      • SCA 集約データベース名を入力します。
        > Please provide a name for the new SCA Aggregation database 
        [Default: > AppScan360_SCA_Aggregation_DB]:
      • SCA アップデートのレジストリー情報を入力するか、該当する場合はデフォルトを受け入れます。
        > SCA Registry Address [Default: hclcr.io]:
        > SCA Registry Path [Default: appscan360/as360-k8s-docker-images]:
        > SCA Registry Username (typically your ID):
        > SCA Registry Password/Token:
        > SCA Helm Repository Path [Default:appscan360/as360-k8s-helm-packages]:
      • 注: SCA 脆弱性データベースの自動更新を有効にするには、ID とパスワード/トークンを使用します。自動更新を行うには、システムがインターネットに接続されている必要があります。
        🔗 Network Configuration
        > Please enter the primary domain name for this installation. This 
        will be used to create the access URL (e.g., yourcompany.com):
    • これはデフォルト値のない必須フィールドです。指定されたドメイン名は AppScan 360° インスタンスのアクセス URL の作成に使用されます。例えば、appscan-test.local と入力すると、AppScan 360° の URL は https://hostname.appscan-test.local になります。
      ドメイン名は、覚えやすい名前にし、ネットワーク環境内で一意であり、既存のドメインと競合しないようにする必要があります。
      > 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:
    • 次のように、AppScan 360° インスタンスが接続する必要があるドメインまたは IP アドレスを入力します。
      • E メール通知用の SMTP サーバー
      • SSO 認証プロバイダー (LDAP、OIDC)
      • 外部 CI/CD ツール
    • 複数のエントリーを指定する場合は、コンマで区切ります。外部サービスが不要な場合は、空白のままにします。
      > Is the VM connected with the local DNS server (y/n)?
    • デフォルトは n です。
      • y: VM が DNS サーバーに接続されています。ネットワーク関連の構成にホスト名が使用されます。
      • n: VM が DNS サーバーに接続されていません。ネットワーク関連の設定に IP アドレスが直接使用されます。
        > 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]:
    • このストレージは、コンポーネント間で共有されるログ、構成ファイル、永続データ、スキャン・ログに使用されます。デフォルトは 200GB です。
      • Enter キーを押してデフォルト値を受け入れるか、
      • 別の数字を入力してカスタム・ストレージ値を指定し、Enter キーを押します。
        > Do you want to connect with your SMTP Mail Relay (SMR)(y/n)?
    • デフォルトは n です。
      SMTP メール・リレーは、システムから送信された電子メールを受け入れ、受信者の電子メール・サーバーに転送する中間サーバーです。リレーは、電子メールの配信を保証し、スパム・フィルタリングなどの特定のルールを適用できます。AppScan 360° で、スキャンが完了したとき、スケジュール/スキャンが開始されたときなどに通知メールを受信するようにリレーを設定します。
      • y: 配置から電子メールを送信するために、AppScan 360° を SMTP メールリレーと統合します。y を選択した場合は、SMR に接続を完了するように求めるプロンプトが表示されたら、適切なホスト、ポート、資格情報、および暗号化の詳細を入力します。
        > Please enter the SMTP host:
        > Please enter the SMTP port:
      • 通常、ポート番号は 25、465、または 587 です。
        > Please enter the SMTP username:
      • 認証が必要な場合。
        Please enter the SMTP password:
      • 認証が必要な場合。
        > Does your SMTP server use SSL/TLS? If yes, a certificate is 
        required to be present in certs/smtp folder (y/n)?
      • n: SMTP サーバーが設定されません。ユーザーは関連する電子メール通知を受信できません。
    • 外部 DPR がない場合は、ローカル DPR を設定するかどうかを選択します
      > Do you want the kit to install and manage a local Docker Private 
      Registry (DPR) on this VM? (y/n) [Default: n]:
    • y - 、Docker クエリーをスキップしてデフォルト値を設定します。n の場合は、以降の質問として DPR の詳細を入力します
      • Docker レジストリー構成:
        🐳 Docker Registry Configuration
        > What is the external Docker Private Registry (DPR) address (FQDN:PORT)?
        > What is the external Docker Private Registry (DPR) username?
      • 認証が必要な場合
        > What is the external Docker Private Registry (DPR) password?
      • 認証が必要な場合
        🐳 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]:
        🔄 Proxy Service Configuration
        > Do you want to use a proxy service? (y/n) [Default: n]:
      • y: プロキシー・サービスを構成します。
        > 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: プロキシー構成をスキップします。
  4. インストールでは、選択内容の概要が表示され、インストールを続行するかどうかを尋ねられます。
    ✅ 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]
    
    > Continue with installation? (y/n) [Default: y]:

  5. 情報が正しいことを確認し、y と入力して続行します。正しくない場合、または変更する場合は n と入力し、Enter キーを押します

    インストールを進めるにあたり、次のものがインストールおよび構成されます。
    • Kubernetes クラスター (K0S)
    • Docker Private Registry (DPR) (選択した場合)
    • AppScan 360° 中央プラットフォーム (ASCP) とコンポーネント。
    • AppScan 修復アドバイザリー (ASRA)
    • DAST テンプレートコンバーター・サービス (DTC)
    • ソフトウェア・コンポジション分析 (SCA)、選択した場合
    • 外部データベースと Docker レジストリーへの接続
  6. システムとネットワークの速度によっては、インストールに時間がかかる場合があります。完了すると、インストールの完了メッセージが表示されます。
    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
  7. ホスト・ファイルに指定された IP アドレスとホスト名を追加します。
    オペレーティング・システム ホスト・ファイルの場所
    Linux、MacOS /etc/hosts
    Windows C:\Windows\System32\drivers\etc\hosts
  8. 例:
    192.168.1.100 appscan.appscan-test.local

ログインおよびアクティブ化 AppScan 360°

AppScan 360° にログインしてアクティブ化するには、次の手順を実行します。
  1. 指定された URL を使用して AppScan 360° インターフェースにアクセスします (https://[HOSTNAME].[DOMAIN])
  2. デフォルトの資格情報を使用してログインを実行します。
    • ユーザー名: Admin
    • パスワード: Admin12!
  3. AppScan 360° ライセンス・ファイルをアップロードして、製品をアクティブ化します。
注: 次を含め、定期的にバックアップすることをお勧めします。
  • データベース (定期的)。
  • インストール・ディレクトリーにある構成ファイル。(in ~/aio-setup/aioWorkspace/conf ディレクトリー)
  • ライセンス情報。

インストール方法の変更

AppScan 360° を分散環境にインストールするには、分散インストール: AppScan 360° に記載されている指示に従ってください。これはまったく新しいプロセスになります。

一般的なインストールの問題

問題 解決方法
データベース接続の失敗 データベースの認証情報とネットワーク接続を確認します
ディスクの空き容量が不足しています 要件に応じて VM に適切なストレージがあることを確認します
証明書エラー 証明書フォルダー内の証明書形式とファイル名を確認します
Docker レジストリー接続 レジストリーの認証情報とネットワーク接続を確認します