getReport

Available in Classic and VPC

Output a report of the diagnostic whose diagnostic task is complete.

Request

This section describes the request format. The method and URI are as follows:

Request headers

For headers common to Web Security Checker, see Web Security Checker common request headers.

Request path parameters

The following describes the parameters.

Request example

The request example is as follows:

curl --location --request GET 'https://wsc.apigw.ntruss.com/api/v1/jobs/{instanceId}/report'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
--header 'Content-Type: application/json'

Response

This section describes the response format.

Response body

The response body includes the following data:

Response status codes

For error codes common to Web Security Checker APIs, see Common Web Security Checker error codes.

Response example

The response example is as follows:

• Diagnostic report output complete

  {
      "returnCode": "0",
      "returnDesc": "Request Success",
      "returnMessage": "Success",
      "resource": {
          "report_date": "2024-07-08 13:15:10",
          "Target_Info": "http://your-domain",
          "Crawl_Time": "2024/07/08 13:12:03~2024/07/08 13:12:08",
          "Scan_Time": "2024/07/08 13:12:27~2024/07/08 13:15:10",
          "Excluded_Url": [],
          "Login_Info": "",
          "Vulnerability_Category": "SQL Injection, XSS, .... (omitted)",
          "User_Agent": "Mozilla/5.0 .... (omitted)",
          "Memo": "Sample",
          "Scanned_Domain_List": [
              "http://your-domain"
          ],
          "Not_Scanned_Domain_List": [
              "http://www.w3.org",
              "http://httpd.apache.org",
              "https://bugs.launchpad.net"
          ],
          "Classify_byRisk_Level": {
              "Total": 1,
              "High": 0,
              "Medium": 0,
              "Low": 1
          },
          "Classify_byRisk_Domain": {
              "http://your-domain": {
                  "XSS": {
                      "Low": 1
                  }
              }
          },
          "Classify_byRisk_Vulnerability": {
              "XSS": 1
          },
          "Details": {
              "XSS": {
                  "RiskLevel": "Low",
                  "Vuln_Desc": "Cross-site scripting (XSS) vulnerabilities can be... (omitted)",
                  "Vuln_Desc2": "- The value entered from the user is in the correct range... (omitted)",
                  "0": {
                      "Title": "XSS #1",
                      "vuln_key": "http://your-domain_XSS_0",
                      "URL": "[GET]  http://your-domain/....(omitted)",
                      "Request_Header": "",
                      "Referer": "",
                      "Request_Body": "",
                      "newline": "true",
                      "VulnParam": "",
                      "VulnSTR": "",
                      "Response_Data": [
                          "Allow: POST,OPTIONS,HEAD,GET"
                      ],
                      "Description": "",
                      "Reference": ""
                  }
              }
          },
          "Recommendation": {
              "XSS": "The value entered from the user is in the predictable... (omitted)"
          }
      }
  }
  

• Diagnostic report output error: Invalid InstanceId entered

  {
      "error": {
          "errorCode": 901,
          "message": "API Call Fail"
      }
  }
  

Sample code

To output a diagnostic report, you need the Search diagnostics API and the Output diagnostic report API. You need to extract the value of instanceNo of the diagnostic for which you want to output a diagnostic report through the Search diagnostics API and call the Output diagnostic report API using this value.
See getJobs or searchJobs for more information on how to search for diagnostics and check instanceNo, as well as sample code for those APIs.

Sample code from a search with the Search diagnostics API (searchJobs) is as follows:

• Search type: url
• Keyword: target-domain.com

# Request example
$ python jobSearch.py "url target-domain.com"

# Response example
{
    "returnCode": "0",
    "returnDesc": "Request Success",
    "returnMessage": "Success",
    "resources": {
        "total_cnt": 1,
        "total_page_cnt": 1,
        "current_start_page": 1,
        "current_end_page": 1,
        "record_data": [
            {
                "instanceNo": "1234567890",
                "start_date": "2024-07-09 15:37:04",
                "end_date": "2024-07-09 15:39:54",
                "status": "Diagnostics completed",
                "progress": null,
                "start_url": "http://target-domain.com",
                "crawl_cnt": "1",
                "scan_cnt": "1",
                "memo": "Wsc Sample",
                "result_button": "report",
                "result_desc": "",
                "rescan_button": "possible",
                "slave_data": null
            }
        ]
    }
}

The following is sample code that generates a signature with the make_signature function to create a request head and then cancel it before diagnosing based on the request parameters entered, outputting the result if the response code is 200.

import sys
import os
import hashlib
import hmac
import base64
import requests
import time
import json
from pprint import pprint

def make_signature(method, uri, timestamp):

    access_key = "{accessKey}"  # access key id (from portal or sub account)
    secret_key = "{secretKey}"  # secret key (from portal or sub account)
    secret_key = bytes(secret_key, 'UTF-8')

    method = method
    uri = uri

    message = method + " " + uri + "\n" + timestamp + "\n" + access_key
    message = bytes(message, 'UTF-8')
    signingKey = base64.b64encode(hmac.new(secret_key, message, digestmod=hashlib.sha256).digest())
    return signingKey

method = 'GET'
instanceId = "{instanceId}" # instance id (from api)
uri = f'/api/v1/jobs/{instanceId}/report'
timestamp = str(int(time.time() * 1000))

signature = make_signature(method, uri, timestamp)

headers = {
    'x-ncp-apigw-signature-v2': signature.decode('utf-8'),
    'x-ncp-apigw-timestamp': timestamp,
    'x-ncp-iam-access-key': '{accessKey}', # access key id (from portal or sub account)
    'Content-Type': 'application/json'
}

response = requests.request(
    method,
    f"https://wsc.apigw.ntruss.com{uri}",
    headers=headers
)

if response.status_code == 200:
    pprint(json.loads(response.text))
else:
    pprint(json.loads(response.text))