在單一虛擬機器上自訂安裝 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 憑證(支援 SMPM)
    ~/aio-setup/certs/oidc/ OIDC 憑證(支援 OIDCS)
    ~/aio-setup/certs/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. 將答案檔案與先前安裝的套件放在同一位置。從先前安裝的工作區 aioWorkspace/audit 中找到 as360-aio-answers.env 檔案並複製到目前的套件位置。
    • 這可確保升級時提供相同的答案/配置
    • 否則,必須仔細回答下述「執行安裝」區段中提到的所有調查問題,而且對於資料庫、Docker 登錄、共用儲存空間大小等資源,也得回答與先前相同的答案。
  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]:
      • 附註:使用您的 ID 與密碼/記號來啟用 SCA 漏洞資料庫的自動更新。您的系統必須連線至網際網路才能進行自動更新。
        🔗 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 位址,例如:
      • 用於電子郵件通知的 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: 配置 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:略過 Proxy 配置。
  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 範本轉換器服務 (DTCS)
    • 軟體組合分析 (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 (https://[HOSTNAME].[DOMAIN]) 存取 AppScan 360° 介面
  2. 以預設認證登入:
    • 使用者名稱:Admin
    • 密碼:Admin12!
  3. 上傳您的 AppScan 360° 授權檔案以啟動產品。
註: 建議您定期備份,包括:
  • 資料庫(定期)。
  • 安裝目錄中的配置檔。(位於 ~/aio-setup/aioWorkspace/conf 目錄中)
  • 授權資訊。

變更安裝方法

若要在分散式環境中安裝 AppScan 360°,請遵循分散式安裝 AppScan 360°中的指示。這是一個全新的程序。

常見的安裝問題

問題 解決方案
資料庫連線失敗 確認資料庫認證和網路連線
磁碟空間不足 確保 VM 具有符合要求的足夠儲存空間
憑證錯誤 檢查憑證資料夾中的憑證格式和檔案名稱
Docker 登錄連線 確認登錄認證和網路連線