createJob

概要

• createJob APIは「Web Security Checker」から提供される機能で、ユーザーが診断を登録するAPIです。

サポート範囲及び注意事項

• createJob APIは、NAVERクラウドプラットフォームコンソールで Web Security Checkerの利用申請 を行った後に使用できます。
• createJob APIの呼び出し時に課金が発生します。Web Security Checker紹介ページで料金ポリシーを必ず確認してください。
• createJob APIはNAVERクラウドプラットフォームによって作成されたサーバに対する診断のみサポートします。
  • NAVERクラウドプラットフォームによって作成されていない外部サーバは、NAVERクラウドプラットフォームコンソール(Web Security Checker) からご利用ください。
• createJob APIは予約機能を提供していないため、APIを呼び出すと同時に診断を開始します。
  • 予約機能は NAVERクラウドプラットフォームコンソール(Web Security Checker) からご利用ください。
  • 必要な場合、APIを実装する過程で予約を希望する時間にcreateJob APIを呼び出してください。

リクエスト

Path Variables

リクエストヘッダー

IAM認証のためのリクエストヘッダーです。

予約語の説明

UserAgentの予約語リスト

Web Securtiy Checkerは、ユーザーのウェブサイトに最適なブラウザを選択できるように診断オプションを提供します。

APIユーザーは、次のテーブルの予約語に関する説明を参考にして予約語を選択してからAPIを呼び出します。

診断項目の予約語リスト

診断作成APIは、診断項目を明示して、希望する診断を選択して行えるような機能を提供します。

診断項目に関する詳しい内容は、Web Security Checker紹介ページ > 診断項目 からも確認できます。

• すべての点検項目で診断を実行する場合、ALLキーワードを使用してください。
• 一部の点検項目だけで診断を実行する場合、次のテーブルから希望するキーワードを選択してください。

例

• 次の例を参考にしてAPIを使用してください。

リクエスト例1(診断作業の作成)

curl -X PUT "https://wsc.apigw.ntruss.com/api/v1/job"
   -H "accept: application/json"
   -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"
   -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}"
   -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"
   --data-raw '{
    "StartUrl": "https://www.ncloud.com",
    "ExcludeUrl": [
        "https://www.ncloud.com/event",
        "https://www.ncloud.com/robot.txt"
    ],
    "Headers": {
        "Upgrade-Insecure-Requests": "1",
        "Accept": "text/html.....",
        "Accept-Encoding": "gzip, deflate",
        "Accept-Language": "ko-KR,ko;q=0.9,en-US;q=0.8,en;q=0.7",
        "Cookie": "XSRF-TOKEN=eyJ.....; PHPSESSIONID=e.....",
        "X-Custom-Header": "Bar"
    },
    "VulnItems": [
        "ALL"
    ],
    "UserAgent": "Android",
    "Speed": "1",
    "Memo": "OPEN API TEST"
}'

リクエスト例2(再診断作業の作成)

リクエスト例2-1.再診断できる診断検索(手動)

1. getJobs(Web Security Checker) APIを利用して診断リストを呼び出します。
2. レスポンスでresources > record_dataプロパティの項目のうち、"rescan_button": "possible"と表記された項目を検索します。
3. 前段階で検索した項目のinstanceNoをコピーします。

• 備考：rescan_buttonの値がnullまたはexpiredの場合は再診断できません。

curl -X GET "https://wsc.apigw.ntruss.com/api/v1/jobs?limit=10&page=1"
   -H "accept: application/json"
   -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"
   -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}"
   -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"
{
    "returnCode": "0",
    "returnDesc": "Request Success",
    "returnMessage": "成功",
    "resources": {
        "total_cnt": 1,
        "total_page_cnt": "1",
        "current_start_page": "1",
        "current_end_page": "10",
        "record_data": [
            {
                "instanceNo": "12311231",
                "start_date": "2020-12-02 23:34:54",
                "end_date": "2020-12-02 23:36:43",
                "status": "Complete",
                "start_url": "http://ncloud.com",
                "crawl_cnt": "10",
                "scan_cnt": "1",
                "memo": "OPEN APIテスト(#1)",
                "result_button": "report",
                "result_desc": null,
                "rescan_button": "possible",
                "slave_data": null
            },
        ]
    }
}

リクエスト例2-1-1.再診断できる診断検索(ユーティリティ使用)

• getJobs(Web Security Checker) APIとjqユーティリティを利用して再診断できるinstanceNoリストを確認します。
  • この例で、instanceNoは「12311231」です。
  • もし、instanceNoがない場合、再診断できる診断作業がないことを意味します。

curl -X GET "https://wsc.apigw.ntruss.com/api/v1/jobs?limit=10&page=1"
   -H "accept: application/json"
   -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"
   -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}"
   -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}" | jq '.resources.record_data[] | select( .rescan_button == "possible" ) | .instanceNo'
%"12311231"

リクエスト例2-2.診断作業呼び出し

• masterInstanceNoパラメータに先ほど取得した"12311231"を入力します。
  • 必ず文字列タイプで番号を入力してください。

curl -X PUT "https://wsc.apigw.ntruss.com/api/v1/job"
   -H "accept: application/json"
   -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"
   -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}"
   -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"
   --data-raw '{
    "StartUrl": "https://www.ncloud.com",
    "ExcludeUrl": [
        "https://www.ncloud.com/event",
        "https://www.ncloud.com/robot.txt"
    ],
    "Headers": {
        "Upgrade-Insecure-Requests": "1",
        "Accept": "text/html.....",
        "Accept-Encoding": "gzip, deflate",
        "Accept-Language": "ko-KR,ko;q=0.9,en-US;q=0.8,en;q=0.7",
        "Cookie": "XSRF-TOKEN=eyJ.....; PHPSESSIONID=e.....",
        "X-Custom-Header": "Bar"
    },
    "VulnItems": [
        "ALL"
    ],
    "UserAgent": "Android",
    "Speed": "1",
    "Memo": "OPEN API TEST",
    "MasterInstanceNo": "12311231"
}'
%{
    "returnCode": "0",
    "returnDesc": "Request Success",
    "returnMessage": "成功",
    "resources": null
}

レスポンス例1(診断作業の作成完了)

{
    "returnCode": "0",
    "returnDesc": "Request Success",
    "returnMessage": "成功",
    "resources": null
}

レスポンス例2(予約語の入力エラー)

ユーザーリクエストのVulnItemsパラメータに診断項目の予約語リストにないキーワードが存在する場合、次のようなエラーが発生します。

また、ALL予約語をXSSなどの予約語と一緒に使用する場合、次のようなエラーが発生します。

{
    "error": {
        "errorCode": 160433,
        "message": "Param Value Not Define - VulnItems"
    }
}

レスポンス例2-1(予約語の入力エラー)

• ALL予約語を使用する場合、他の予約語は使用できません。

curl -X PUT "https://wsc.apigw.ntruss.com/api/v1/job"
   -H "accept: application/json"
   -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"
   -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}"
   -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"
   --data-raw '{
    "StartUrl": "https://www.ncloud.com",
    "ExcludeUrl": [
        "https://www.ncloud.com/event",
        "https://www.ncloud.com/robot.txt"
    ],
    "Headers": {
        "Upgrade-Insecure-Requests": "1",
        "Accept": "text/html.....",
        "Accept-Encoding": "gzip, deflate",
        "Accept-Language": "ko-KR,ko;q=0.9,en-US;q=0.8,en;q=0.7",
        "Cookie": "XSRF-TOKEN=eyJ.....; PHPSESSIONID=e.....",
        "X-Custom-Header": "Bar"
    },
    "VulnItems": [
        "ALL",
        "XSS"
    ],
    "UserAgent": "Android",
    "Speed": "1",
    "Memo": "OPEN API TEST"
}'
%{
    "error": {
        "errorCode": 160433,
        "message": "Param Value Not Define - VulnItems"
    }
}

レスポンス例2-2(パラメータのタイプエラー)

• VulnItemsパラメータは配列(list)タイプのみを許可します。
• VulnItems: "ALL"を入力する場合、エラーが発生します。

curl -X PUT "https://wsc.apigw.ntruss.com/api/v1/job"
   -H "accept: application/json"
   -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"
   -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}"
   -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"
   --data-raw '{
    "StartUrl": "https://www.ncloud.com",
    "ExcludeUrl": [
        "https://www.ncloud.com/event",
        "https://www.ncloud.com/robot.txt"
    ],
    "Headers": {
        "Upgrade-Insecure-Requests": "1",
        "Accept": "text/html.....",
        "Accept-Encoding": "gzip, deflate",
        "Accept-Language": "ko-KR,ko;q=0.9,en-US;q=0.8,en;q=0.7",
        "Cookie": "XSRF-TOKEN=eyJ.....; PHPSESSIONID=e.....",
        "X-Custom-Header": "Bar"
    },
    "VulnItems": "ALL",
    "UserAgent": "Android",
    "Speed": "1",
    "Memo": "OPEN API TEST"
}'
%{
    "error": {
        "errorCode": 160431,
        "message": "VulnItems should be list"
    }
}

レスポンス例3(サーバ所有有無のチェック)

顧客本人の資産でないサーバに対して診断をリクエストする場合、次のようなエラーが発生します。

APIを利用するアカウントのサーバに対する権限を確認してください。

{
    "error": {
        "errorCode": 160451,
        "message": "Assets_Check_Fail"
    }
}