掃描管理REST API ——服務——運行掃描

HCL AppScan Enterprise 中文文檔 10.0.1 /

檢索模板列表

該 REST 服務將檢索您可以在模板目錄或其任何子文件夾中訪問的可用作業模板的列表。

HTTPS 方法

GET

服務格式

/services/templates

查詢字符串參數

無

返回值

作業模板的列表。

示例：

<folder-items>
   <content-scan-job>
   <id>33</id>
   <name>Altoro Mutual</name>
   <description>Scan of Altoro Mutual</description>
   <parent href="https://localhost/ase/services/folders/2">
     <id>2</id>
   </parent>
   <contact>Miriam</contact>
   <state>
     <id>1</id>
     <name>Ready</name>
   </state>
   <action>
     <id>1</id>
     <name>None</name>
   </action>
   <options href="https://localhost/ase/services/folderitems/33/options">
   <options/>
  </content-scan-job>
</folder-items>

請參閱文檔記錄的模式以獲取更多詳細信息。

下一步的操作

將<id>33</id> 的 33 用作下一步中的 templateid：基于模板創建掃描作業

Retrieving Scanlogs

此 REST 服務將從日志目錄中檢索掃描日志以進行掃描。

HTTPS 方法

GET

服務格式

/services/folderitems/<folderItemID>/scanlog

查詢字符串參數

無

返回值

包含掃描的掃描日志的 XML 文件。

示例：

<?xml version="1.0" encoding="utf-8"?>

<scan-log xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" log="<div id='innerDiv' class="no_border">
<span title="Service Code: CRWAD0310I"…………………….. Scan stopped; scan duration: 00:20:18.8010000</span><br/></div>" xmlns="http://www.ibm.com/Rational/AppScanEnterprise" />

請參閱文檔記錄的模式以獲取更多詳細信息。

Retrieving Statistics

此 REST 服務將檢索掃描的統計信息。

HTTPS 方法

GET

服務格式

/services/folderitems/<folderItemID>/statistics

查詢字符串參數

無

返回值

統計信息包括作業/掃描的狀態、運行開始時間、運行結束時間、已用時間、凈掃描時間、找到的頁面、中斷鏈接、掃描的頁面、頁面掃描速率、掃描階段、找到的安全實體、測試的安全實體、安全實體分析速率、安全問題變體以及發送的請求。

示例：

<?xml version="1.0" encoding="utf-8"?>

<statistics xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" status="Suspended (Unknown error: SDK Server Down Error)" 
run-start="2018-08-08T12:27:51.203" run-end="2018-08-08T12:27:51.203" elapsed-time="0:00:00" net-scan-time="0:20:28" pages-found="72" broken-links="27" pages-scanned="72" page-scan-rate="3.52" scanning-phase="-" security-entities-found="326" security-entities-tested="326" security-entity-analysis-rate="15.93" security-issue-variants="67" requests-sent="3209" xmlns="http://www.ibm.com/Rational/AppScanEnterprise" />

請參閱文檔記錄的模式以獲取更多詳細信息。

基于模板創建掃描作業

該 REST 服務將基于特定模板創建掃描作業和關聯的報告包。使用 POST 數據向服務器提供名稱和描述字段。

HTTPS 方法

POST

服務格式

要在根文件夾中創建作業和報告包： /services/folderitems?templateid=<id>

要在特定文件夾中創建作業和報告包： /services/folders/<folderId>/folderitems?templateid=<id>

查詢字符串參數

（必需）templateid：掃描模板標識。
注： “templateid”必須是您可以在“模板”目錄或其任何子文件夾中訪問的有效標識。
（可選）appid：應用程序標識。用于將作業與應用程序關聯。

POST 數據

內容類型：application/x-www-form-urlencoded

名稱：掃描的名稱

描述：掃描的描述

有效內容：這是可選數據。僅將 AppScan Enterprise 作業結果異步發布到配置的端點 URL功能需要。

返回值

創建的新內容掃描作業和報告包 XML。

示例：

請求：

POST /services/folderitems?templateid=<templateId>&appid=<appid>

name=<name of scan>&description=<description>

響應：

<folder-items>
   <content-scan-job>
     <id>56</id>
     <name>new scan A</name>
     <description>a new scan called A</description>
     <parent href="https://localhost/ase/services/folders/1">
       <id>1</id>
     </parent>
     <contact>Bill Smith</contact>
     <state>
       <id>1</id>
       <name>Ready</name>
     </state>
     <action>
       <id>1</id>
       <name>None</name>
     </action>
     <options href="https://localhost/ase/services/folderitems/56/options" />
   </content-scan-job>
   <report-pack>
     <id>57</id>
     <name>new scan A</name>
     <description>a new scan called A</description>
     <parent href="https://localhost/ase/services/folders/1" />
       <id>1</id>
     </parent>
     <contact>Bill Smith</contact>
     <state>
       <id>1</id>
       <name>Ready</name>
     </state>
     <action>
       <id>1</id>
       <name>None</name>
     </action>
     <reports href="https://localhost/ase/services/folderitems/57/reports">
       <count>4</count>
     </reports>
   </report-pack>
</folder-items>

請參閱文檔記錄的模式以獲取更多詳細信息。

配置作業選項

該 REST 服務將配置內容掃描作業選項，例如添加起始 URL。

HTTPS 方法

POST

服務格式

/services/folderitems/<fiid>/options/<option>

fiid: 文件夾項標識

選項：表示要更改的選項的字符串，例如“epcsCOTListOfStartingUrls”。以下是可以配置的作業選項的列表：

epcsCOTListOfStartingUrls
ebCOTHttpAuthentication
esCOTHttpUser
esCOTHttpPassword
elCOTScanLimit
esCOTAutoFormFillUserNameValue
esCOTAutoFormFillPasswordValue
epcsCOTUrlExclusions
ecsCOTUrlExclusionSpecificExceptions
ecsCOTUrlExclusionGlobalExceptions

查詢字符串參數

/services/folderitems/<fiid>/options/<option>?delete=1

如果選項是一個集合，那么此參數將刪除現有集合。

/services/folderitems/<fiid>/options/<option>?put=1

POST 數據將用于覆蓋現有的選項值或集合。

POST 數據

內容類型：application/x-www-form-urlencoded

在請求正文中輸入“value=”。如果必要，可以具有多個值。

示例： value=http://http://www.altoromutual.com/&value=http://www.ibm.com

返回值

與設置的選項相關的值。

示例：

<options>
   <option value="https://demo.testfire.net/"/>
</options>

請參閱文檔記錄的模式以獲取更多詳細信息。

ecsCOTUrlExclusionSpecificExceptions 選項的配置

查詢字符串參數

delete 和 put 參數不適用于此選項。

POST 數據

內容類型：application/x-www-form-urlencoded

在請求正文中輸入“value=”。如果必要，可以具有多個值。

示例： value=/home.jsp&value=/bank.jsp
在請求的正文中輸入“exclusionid=”。排除編號從零開始。如果有 3 個排除項，則分配給排除項的編號為 0、1、2。不支持指定多個排除編號。對于此選項，“exclusionid”為可選選項。如果未指定“exclusionid”，則會將異常值添加到最后一個排除項上。

示例：exclusionid=3（將異常值添加到第 4 個排除項上）

更新文件夾項操作

該 REST 服務將更新文件夾項（作業、報告包、儀表板）的操作（啟動掃描、暫掛、取消、結束、恢復）。

HTTPS 方法

發布

服務格式

/services/folderitems/<fiid>

查詢字符串參數

無

POST 數據

內容類型：application/x-www-form-urlencoded

action：

運行： action=2
暫掛： action=3
取消：action=4
結束： action=5

返回值

包含以新操作值更新的 XML 的元素

示例：

<report-pack>
   <id>12</id>
   <name>Quality</name>
   <description>Quality only reports, all jobs</description>
   <parent href="https://localhost/ase/services/folders/1">
     <id>1</id>
   </parent>
   <contact>Miriam</contact>
   <state>
      <id>1</id>
      <name>Ready</name>
   </state>
   **<action>
     <id>2</id>
     <name>Run</name>
   </action>**
   <reports href="https://localhost/ase/services/folderitems/12/reports">
     <count>11</count>
   </reports>
</report-pack>

請參閱文檔記錄的模式以獲取更多詳細信息。

上載手動探索數據

此 REST 服務會將 .htd / .har / *.dast.config 文件中存儲的手動探索數據上載到 AppScan? Enterprise。流量文件的大小不能超過 20 MB。如果您已超過了此限制，請通過記錄更小的序列以將文件拆分為更小的區塊。要使用 *.har 或 *.dast.config 文件格式的文件，需要將另一個參數格式**傳遞到請求中。示例如下。

HTTP 方法

發布

GET

服務格式

/services/folderitems/<fiid>/httptrafficdata。

查詢字符串參數

/services/folderitems/<fiid>/httptrafficdata?delete=1

刪除所有手動探索 URL 和域（不是由用戶添加并且未在起始 URL 中使用的域）。

/services/folderitems/<fiid>/httptrafficdata?put=1

刪除所有手動探索 URL 和域，然后使用 POST 數據來添加新的 URL 和域。

/services/folderitems/<fiid./httptrafficdata?includeformfills=true 或 /services/folderitems/<fiid./httptrafficdata?includeformfills=1

處理并存儲上載的 *.htd 文件中的自動填寫表單字段。

/services/folderitems/<fiid>/httptrafficdata?put=1&format=har

將存儲在 *.har 文件中的數據提供給 REST API。

/services/folderitems/<fiid>/httptrafficdata?put=1&format=dast

將存儲在 *.dast 文件中的數據提供給 REST API。

POST 數據

內容類型：application/octet-stream

文件的內容

注：如果未提供查詢參數“delete=1”，請指定 POST 數據。

返回值

成功上載狀態或錯誤消息。錯誤消息的可能原因包括：

*.htd 文件無效
文件大小超過 20 MB
用戶未獲授權
作業標識無效

請參閱文檔記錄的模式以獲取更多詳細信息。

設置用于掃描應用程序的基本和 NTLM 認證選項

該 REST 服務將設置使用基本或 NTLM 認證登錄 web 站點的用戶憑證。密碼在保存到數據庫中之前會進行編碼，但會以明文接收。通過 HTTPS 調用這一 REST 服務，然后在手動探索過程中使用測試用戶帳戶可避免用戶名和密碼以明文顯示在 Enterprise Console 界面中。

HTTP 方法

發布

GET

服務格式

要設置用于驗證的用戶名，請執行以下操作：/services/folderitems/<fiid>/options/esCOTHttpUser。

要設置用于驗證的密碼，請執行以下操作：/services/folderitems/<fiid>/options/esCOTHttpPassword。

要啟用/禁用驗證，請執行以下操作：/services/folderitems/<fiid>/options/ebCOTHttpAuthentication。

查詢字符串參數

無

POST 數據

內容類型：application/x-www-form-urlencoded

在請求正文中輸入“value=option value”：

對于 esCOTHttpUser：value=
對于 esCOTHttpPassword：value=
對于 ebCOTHttpAuthentication：value=<1 (enable) or 0 (disable)>

返回值

通過 GET 方法：

“esCOTHttpUser”返回選項值
“ebCOTHttpAuthentication”返回選項值
沒有為“esCOTHttpPassword”提供 GET 方法。如果調用 GET 方法，那么會返回 404 錯誤。

請參閱文檔記錄的模式以獲取更多詳細信息。

上載記錄的登錄數據

將存儲在 *.htd / *.har / *.dast.config 文件中作為記錄的登錄序列的手動探索數據上載到內容掃描作業，并將內容掃描作業的“登錄方法”設置為“記錄的登錄”。

該服務會將任何現有登錄序列替換為上載的登錄序列。流量文件的大小不能超過 20 MB。如果應用程序使用平臺認證 (NTLM)，那么必須通過使用設置用于掃描應用程序的基本和 NTLM 認證選項中記錄的 REST 服務來單獨地設置認證選項。要使用 *.har 或 *.dast.config 文件格式的文件，需要將另一個參數格式傳遞到請求中。示例如下。

HTTP 方法

POST

服務格式

/services/folderitems/<fiid>/recordedlogindata

查詢字符串參數

/services/folderitems/<fiid>/recordedlogindata?delete=1

刪除所有“記錄的登錄”URL 和域。如果當前“登錄方法”為“記錄的登錄”，那么將“登錄方法”更改為“無”。

/services/folderitems/<fiid>/recordedlogindata?put=1&format=har

將存儲在 *.har 文件中的數據提供給 REST API。

/services/folderitems/<fiid>/recordedlogindata?put=1&format=dast

將存儲在 *.dast 文件中的數據提供給 REST API。

POST 數據

內容類型：application/octet-stream

文件的內容。

注：如果未提供查詢參數“delete=1”，請指定 POST 數據。

返回值

成功上載狀態或錯誤消息，例如：

*.htd 文件無效
文件大小超過 20 MB
用戶未獲授權
作業標識無效
作業是使用 AppScan Standard 掃描模板文件（.scant 文件）中的屬性創建的
QuickScan 掃描作業的模板沒有選擇“手動探索”作為“QuickScan 探索方法”選項的選項。

本文章首發在網安wangan.com 網站上。