セキュリティデータ API を使用してデータを送信する

シンプルな POST リクエストを介して、セキュリティデータ API を介してカスタムの脆弱性またはセキュリティデータを New Relic に送信します。統合によるセキュリティサービスが現在サポートされていない場合、または API を介してセキュリティデータを送信する方がカスタムワークフローに適している場合は、API を使用してください。

前提条件

新しいレリック
データを報告するアカウントの。

New Relicへのデータ送信

脆弱性またはその他のセキュリティデータを送信するには、結果配列を含む POST メソッドを介して JSON オブジェクトを送信します。配列内の各オブジェクトは、検出された脆弱性またはその他のセキュリティイベントを表します。New Relic のセキュリティエンドポイントを必ず含めてください。お住まいの地域に応じて、次のいずれかを使用してください。

米国の場合、 https://security-api.newrelic.com/security/v1
EUの場合、 https://security-api.service.eu.newrelic.com/security/v1

POST リクエストの例を次に示します。次のセクションでは、個々のコンポーネントを見ていきます。

curl -X POST https://security-api.newrelic.com/security/v1 \
   -H “Content-Type: application/json” \
   -H “Api-Key: <New Relic License Key>” \
   -d '{"findings": [
     {
       "source": "Security Tool Name",
       "title": "Short description of issue",
       "message": "Long form description of the security issue including remediaton advice",
       "issueType": "Library Vulnerability",
       "issueId": "Well-known vulnerability identifier like CVE, CWE, CIS, etc.",
       "issueVendorId": "Vendor-specific identifier if different from issueId",
       "issueInstanceKey": "unique_path_to_this_instance_of_the_issue",
       "disclosureUrl": "https://url/link/for/more/information",
       "severity": "CRITICAL",
       "remediationExists": true,
       "remediationRecommendation": "upgrade TheComponent to 1.2.3",
       "detectedAt": "1665610506000",
       "entityType": "Host|Service|Repository|...",
       "entityLookupValue": "a.hostname.com",
       "entityGuid": "ABCDEFGH",
       "customFields": {
         "sourceDetailInfo": "DecadeCoffee",
         ...
       }
     },
     ...
   ]}'

URL パラメータ

パラメータ	説明
`repository`	オプション: 統合されたアプリケーションのリポジトリ URL。

必須項目

リクエストには次のフィールドが必要です。

フィールド	説明
`source`	`Snyk`や`Dependabot`など、このイベントを生成したセキュリティツールのわかりやすい名前。
`title`	問題の短い (50 ～ 100 文字) 要約。ページタイトルまたは表のセルコンテンツとしての使用に適している必要があります。
`message`	調査結果の説明とその修正方法を含む、問題の詳細な説明。マークダウンを含めることができます。
`issueType`	New Relic がサポートする課題タイプ。現在、これらは次のとおりです。 `Library Vulnerability` `Container Vulnerability` `Host Vulnerability`
`issueID`	検出された問題の標準識別子。たとえば、CVE または CWE 識別子、あるいは CIS ベンチマークルールなどです。複数のツールが同じ問題を検出した場合、 `issueId`はすべてのツールで同じである必要があります。
`severity`	問題またはスキャンツールの重大度に関する定義済みのコミュニティコンセンサス。これは、次のいずれかである必要があります。 `CRITICAL` `HIGH` `MEDIUM` `LOW` `INFO`
`entityType`	報告された問題を New Relic プラットフォームに知られているエンティティに関連付けるために使用されます。エンティティ検索 API によって認識されるタイプ、または Security API によってサポートされる特殊なケース ( `Image`および`AWS` ) のいずれかである必要があります。 `entityLookupValue`の例は次のとおりです。 `"entityType": "AWS", "entityLookupValue": "arn:aws:rds:us-east-2:403720000000:db:my-database"`
`entityLookupValue`	そのタイプの適切なエンティティを見つけるために使用されます。 `entityType`の例は次のとおりです。 `"entityType": "Repository", "entityLookupValue": "https://github.com/newrelic/ruby_agent"`

オプションのフィールド

リクエストには、次のオプションフィールドのいずれかを含めることができます。

フィールド	説明
`cvssScore`	JSON/ の浮動小数点数として、CVE に割り当てられた CVSSv3 スコア
`cvssVector`	この CVE を記述する CVSSv3 ベクトル。
`issueInstanceKey`	この脆弱性のインスタンスの発生を、同じリポジトリ、サービス、エンティティ、またはアカウント内の他のインスタンスから一意に識別するパスまたは識別子。例: ファイルへのフルパスとソースコードの検出結果の行番号、またはホストまたはコンテナーイメージ内の脆弱なバイナリへのパス。インスタンスキーは、それぞれ修復が必要な複数のインスタンスを区別しながら、同じ問題の繰り返し検出に対して同一である必要があります。指定しない場合、解決された`entityGuid`またはユーザー指定の`entityLookupValue`が使用されます。
`issueVendorID`	`issueId`と異なる場合、問題のベンダー固有の識別子。
`disclosureUrl`	問題に関する追加情報への URL (ソースツールベンダーの Web サイトまたは公開情報参照)。信頼できる情報源である必要があります。
`remediationExists`	問題の修正が存在することがわかっているかどうかを示すブール値。
`remediationRecommendation`	修復のために実行するアクションを説明する短い形式のテキスト。サードパーティの依存関係については、フォームを使用してください `upgrade PACKAGE_NAME to X.Y.Z`
`detectedAt`	問題が検出されたときのタイムスタンプ (エポックからのミリ秒単位)。提供されない場合、データが New Relic に送信された時点で使用されます。