Red Hat Summit30.7. ScanImage
POST /v1/images/scan
scanImage は単一のイメージをスキャンして結果を返します
30.7.1. 説明
30.7.2. パラメーター
30.7.2.1. ボディパラメーター
| 名前 | 説明 | 必須 | デフォルト | Pattern |
|---|---|---|---|---|
| body | X |
30.7.3. 戻り値のタイプ
30.7.4. コンテンツタイプ
- application/json
30.7.5. レスポンス
| コード | メッセージ | データタイプ |
|---|---|---|
| 200 | 正常な応答。 | |
| 0 | 予期しないエラーの応答です。 |
30.7.6. サンプル
30.7.7. 共通のオブジェクト参照
30.7.7.1. CVSSV2AccessComplexity
| Enum 値 |
|---|
| ACCESS_HIGH |
| ACCESS_MEDIUM |
| ACCESS_LOW |
30.7.7.2. CVSSV2Authentication
| Enum 値 |
|---|
| AUTH_MULTIPLE |
| AUTH_SINGLE |
| AUTH_NONE |
30.7.7.3. CVSSV3Complexity
| Enum 値 |
|---|
| COMPLEXITY_LOW |
| COMPLEXITY_HIGH |
30.7.7.4. CVSSV3Privileges
| Enum 値 |
|---|
| PRIVILEGE_NONE |
| PRIVILEGE_LOW |
| PRIVILEGE_HIGH |
30.7.7.5. CVSSV3UserInteraction
| Enum 値 |
|---|
| UI_NONE |
| UI_REQUIRED |
30.7.7.6. EmbeddedVulnerabilityVulnerabilityType
| Enum 値 |
|---|
| UNKNOWN_VULNERABILITY |
| IMAGE_VULNERABILITY |
| K8S_VULNERABILITY |
| ISTIO_VULNERABILITY |
| NODE_VULNERABILITY |
| OPENSHIFT_VULNERABILITY |
30.7.7.7. ProtobufAny
any には、シリアライズされたメッセージの型を記述する URL とともに、任意のシリアライズされたプロトコルバッファーメッセージが含まれます。
Protobuf ライブラリーは、パック/アンパックをサポートします。任意の値は、ユーティリティー関数の形式で、または Any タイプの追加の生成されたメソッドになります。
例 1: C++ のメッセージをパックして展開します。
例 2: Java でメッセージをパックして解凍します。
Example 3: Pack and unpack a message in Python.
Example 3: Pack and unpack a message in Python.Example 4: Pack and unpack a message in Go
Example 4: Pack and unpack a message in Goprotobuf ライブラリーが提供するパックメソッドは、デフォルトで type.googleapis.com/full.type.name をタイプ URL として使用し、unzip メソッドは、タイプ URL の最後の//のみを使用します。たとえば、"foo.bar.com/x/y.z" のように、"foo.bar.com/x/y.z" の型名 "y.z" が生成されます。
30.7.7.7.1. JSON 表現
Any 値の JSON 表現は、デシリアライズされた埋め込みメッセージの通常の表現を使用し、タイプ URL が含まれる追加のフィールド @type を使用します。以下に例を示します。
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
埋め込みメッセージタイプがよく知られていて、カスタム JSON 表現がある場合、その表現は埋め込みされ、@type フィールドに加えてカスタム JSON を保持するフィールド 値 が追加されます。例（メッセージ [google.protobuf.Duration][] の場合）:
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| typeUrl | String |
シリアライズされたプロトコルバッファーメッセージのタイプを一意に識別する URL/リソース名。この文字列には最低でも 1 つの \"/\" 文字を含める必要があります。URL のパスの最後のセグメントは、タイプの完全修飾名( | |||
| value | byte[] | 上記の指定されたタイプの有効なシリアライズされたプロトコルバッファーである必要があります。 | byte |
30.7.7.8. RuntimeError
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | ProtobufAnyのリスト |
30.7.7.9. StorageCVSSV2
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| vector | String | ||||
| attackVector | ATTACK_LOCAL, ATTACK_ADJACENT, ATTACK_NETWORK, | ||||
| accessComplexity | ACCESS_HIGH、ACCESS_MEDIUM、ACCESS_LOW、 | ||||
| 認証 | AUTH_MULTIPLE, AUTH_SINGLE, AUTH_NONE, | ||||
| confidentiality | IMPACT_NONE, IMPACT_PARTIAL, IMPACT_COMPLETE, | ||||
| integrity | IMPACT_NONE, IMPACT_PARTIAL, IMPACT_COMPLETE, | ||||
| availability | IMPACT_NONE, IMPACT_PARTIAL, IMPACT_COMPLETE, | ||||
| exploitabilityScore | Float | float | |||
| impactScore | Float | float | |||
| score | Float | float | |||
| severity | UNKNOWN、LOW、MEDIUM、HIGH |
30.7.7.10. StorageCVSSV2AttackVector
| Enum 値 |
|---|
| ATTACK_LOCAL |
| ATTACK_ADJACENT |
| ATTACK_NETWORK |
30.7.7.11. StorageCVSSV2Impact
| Enum 値 |
|---|
| IMPACT_NONE |
| IMPACT_PARTIAL |
| IMPACT_COMPLETE |
30.7.7.12. StorageCVSSV2Severity
| Enum 値 |
|---|
| UNKNOWN |
| LOW |
| MEDIUM |
| HIGH |
30.7.7.13. StorageCVSSV3
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| vector | String | ||||
| exploitabilityScore | Float | float | |||
| impactScore | Float | float | |||
| attackVector | ATTACK_LOCAL, ATTACK_ADJACENT, ATTACK_NETWORK, ATTACK_PHYSICAL, | ||||
| attackComplexity | COMPLEXITY_LOW、COMPLEXITY_HIGH、 | ||||
| privilegesRequired | PRIVILEGE_NONE、PRIVILEGE_LOW、PRIVILEGE_HIGH、 | ||||
| userInteraction | UI_NONE, UI_REQUIRED, | ||||
| scope | 変更、変更、 | ||||
| confidentiality | IMPACT_NONE, IMPACT_LOW, IMPACT_HIGH, | ||||
| integrity | IMPACT_NONE, IMPACT_LOW, IMPACT_HIGH, | ||||
| availability | IMPACT_NONE, IMPACT_LOW, IMPACT_HIGH, | ||||
| score | Float | float | |||
| severity | UNKNOWN、NONE、LOW、MEDIUM、HIGH、CRITICAL、 |
30.7.7.14. StorageCVSSV3AttackVector
| Enum 値 |
|---|
| ATTACK_LOCAL |
| ATTACK_ADJACENT |
| ATTACK_NETWORK |
| ATTACK_PHYSICAL |
30.7.7.15. StorageCVSSV3Impact
| Enum 値 |
|---|
| IMPACT_NONE |
| IMPACT_LOW |
| IMPACT_HIGH |
30.7.7.16. StorageCVSSV3Scope
| Enum 値 |
|---|
| 変更なし |
| CHANGED |
30.7.7.17. StorageCVSSV3Severity
| Enum 値 |
|---|
| UNKNOWN |
| NONE |
| LOW |
| MEDIUM |
| HIGH |
| CRITICAL |
30.7.7.18. StorageCosignSignature
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| rawSignature | byte[] | byte | |||
| signaturePayload | byte[] | byte | |||
| certPem | byte[] | byte | |||
| certChainPem | byte[] | byte |
30.7.7.19. StorageDataSource
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| id | String | ||||
| name | String | ||||
| mirror | String |
30.7.7.20. StorageEmbeddedImageScanComponent
Next Tag: 13
Next Tag: 13| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| name | String | ||||
| version | String | ||||
| license | |||||
| vulns | |||||
| layerIndex | Integer | int32 | |||
| priority | String | int64 | |||
| source | OS、PYTHON、JAVA、RUBY、NODEJS、GO、ドットNETCORERUNTIME、INFRASTRUCTURE | ||||
| location | String | ||||
| topCvss | Float | float | |||
| riskScore | Float | float | |||
| fixedBy | String | このコンポーネントに関する修正可能なすべての脆弱性を修正するコンポーネントのバージョン。 | |||
| executables |
30.7.7.21. StorageEmbeddedImageScanComponentExecutable
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| path | String | ||||
| dependencies |
|
30.7.7.22. StorageEmbeddedVulnerability
Next Tag: 21
Next Tag: 21| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| cve | String | ||||
| CVSS | Float | float | |||
| summary | String | ||||
| link | String | ||||
| fixedBy | String | ||||
| scoreVersion | V2, V3, | ||||
| cvssV2 | |||||
| cvssV3 | |||||
| publishedOn | Date | date-time | |||
| lastModified | Date | date-time | |||
| vulnerabilityType | UNKNOWN_VULNERABILITY、IMAGE_VULNERABILITY、K8S_VULNERABILITY、ISTIO_VULNERABILITY、NODE_VULNERABILITY、OPENSHIFT_VULNERABILITY、 | ||||
| vulnerabilityTypes | |||||
| suppressed | Boolean | ||||
| suppressActivation | Date | date-time | |||
| suppressExpiry | Date | date-time | |||
| firstSystemOccurrence | Date | CVE が初めて確認された時刻（この特定のディストリビューションに対して、システムに）。 | date-time | ||
| firstImageOccurrence | Date | このイメージに CVE が最初に見られた時刻。 | date-time | ||
| severity | UNKNOWN_VULNERABILITY_SEVERITY, LOW_VULNERABILITY_SEVERITY, MODERATE_VULNERABILITY_SEVERITY, IMPORTANT_VULNERABILITY_SEVERITY, CRITICAL_VULNERABILITY_SEVERITY, | ||||
| state | OBSERVED、DEFERRED、FALSE_POSITIVE、 |
30.7.7.23. StorageEmbeddedVulnerabilityScoreVersion
| Enum 値 |
|---|
| V2 |
| V3 |
30.7.7.24. StorageImage
Next Tag: 19
Next Tag: 19| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| id | String | ||||
| name | |||||
| names | これにより、ImageName フィールドが長期間非推奨になり、同じダイジェストを持つイメージを異なる場所に関連付けることができます。TODO (dhaus): 現在、このメッセージは、検索タグが重複するため、検索タグがありません。 | ||||
| metadata | |||||
| scan | |||||
| signatureVerificationData | |||||
| signature | |||||
| コンポーネント | Integer | int32 | |||
| cves | Integer | int32 | |||
| fixableCves | Integer | int32 | |||
| lastUpdated | Date | date-time | |||
| notPullable | Boolean | ||||
| isClusterLocal | Boolean | ||||
| priority | String | int64 | |||
| riskScore | Float | float | |||
| topCvss | Float | float | |||
| notes | StorageImageNoteのリスト |
30.7.7.25. StorageImageLayer
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| 命令 | String | ||||
| value | String | ||||
| created | Date | date-time | |||
| author | String | ||||
| 空 | Boolean |
30.7.7.26. StorageImageMetadata
If any fields of ImageMetadata are modified including subfields, please check pkg/images/enricher/metadata.go to ensure that those changes will be automatically picked up Next Tag: 6
If any fields of ImageMetadata are modified including subfields, please check pkg/images/enricher/metadata.go to ensure that those changes will be automatically picked up Next Tag: 6| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| v1 | |||||
| v2 | |||||
| layerShas |
| ||||
| dataSource | |||||
| version | String | uint64 |
30.7.7.27. StorageImageName
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| registry | String | ||||
| remote | String | ||||
| tag | String | ||||
| fullName | String |
30.7.7.28. StorageImageNote
| Enum 値 |
|---|
| MISSING_METADATA |
| MISSING_SCAN_DATA |
| MISSING_SIGNATURE |
| MISSING_SIGNATURE_VERIFICATION_DATA |
30.7.7.29. StorageImageScan
Next tag: 8
Next tag: 8| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| scannerVersion | String | ||||
| scanTime | Date | date-time | |||
| コンポーネント | |||||
| operatingSystem | String | ||||
| dataSource | |||||
| notes | |||||
| ハッシュ | String | uint64 |
30.7.7.30. StorageImageScanNote
| Enum 値 |
|---|
| UNSET |
| OS_UNAVAILABLE |
| PARTIAL_SCAN_DATA |
| OS_CVES_UNAVAILABLE |
| OS_CVES_STALE |
| LANGUAGE_CVES_UNAVAILABLE |
| CERTIFIED_RHEL_SCAN_UNAVAILABLE |
30.7.7.31. StorageImageSignature
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| signatures | |||||
| fetched | Date | date-time |
30.7.7.32. StorageImageSignatureVerificationData
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| results |
30.7.7.33. StorageImageSignatureVerificationResult
Next Tag: 6
Next Tag: 6| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| verificationTime | Date | date-time | |||
| verifierId | String | verifier_id は、署名の検証に使用される署名統合の ID に相関します。 | |||
| status | UNSET, VERIFIED, FAILED_VERIFICATION, INVALID_SIGNATURE_ALGO, CORRUPTED_SIGNATURE, GENERIC_ERROR, | ||||
| description | String | 特定のエラーメッセージを含むエラーが発生した場合に、Description が設定されます。それ以外の場合は、設定されません。 | |||
| verifiedImageReferences |
| この特定の署名インテグレーション ID によって検証される完全なイメージ名。 |
30.7.7.34. StorageImageSignatureVerificationResultStatus
status は、結果のステータスを表します。
- VERIFIED: 署名の検証が成功したときに VERIFIED が設定されます。
- FAILED_VERIFICATION: 署名の検証が失敗した場合、FAILED_VERIFICATION が設定されます。
- INVALID_SIGNATURE_ALGO: 署名のアルゴリズムが無効でサポート対象外の場合に INVALID_SIGNATURE_ALGO が設定されます。
- CORRUPTED_SIGNATURE: 未加工の署名が破損したときに CORRUPTED_SIGNATURE が設定されます。つまり、base64 エンコーディングが正しくありません。
- GENERIC_ERROR: GENERIC_ERROR は、特定のステータスに関連付けない検証中にエラーが発生した場合に設定されます。
| Enum 値 |
|---|
| UNSET |
| VERIFIED |
| FAILED_VERIFICATION |
| INVALID_SIGNATURE_ALGO |
| CORRUPTED_SIGNATURE |
| GENERIC_ERROR |
30.7.7.35. StorageLicense
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| name | String | ||||
| type | String | ||||
| url | String |
30.7.7.36. StorageSignature
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| cosign |
30.7.7.37. StorageSourceType
| Enum 値 |
|---|
| OS |
| PYTHON |
| JAVA |
| RUBY |
| NODEJS |
| GO |
| DOTNETCORERUNTIME |
| インフラストラクチャー |
30.7.7.38. StorageV1Metadata
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| digest | String | ||||
| created | Date | date-time | |||
| author | String | ||||
| layers | |||||
| user | String | ||||
| command |
| ||||
| entrypoint |
| ||||
| volumes |
| ||||
| labels |
|
30.7.7.39. StorageV2Metadata
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| digest | String |
30.7.7.40. StorageVulnerabilitySeverity
| Enum 値 |
|---|
| UNKNOWN_VULNERABILITY_SEVERITY |
| LOW_VULNERABILITY_SEVERITY |
| MODERATE_VULNERABILITY_SEVERITY |
| IMPORTANT_VULNERABILITY_SEVERITY |
| CRITICAL_VULNERABILITY_SEVERITY |
30.7.7.41. StorageVulnerabilityState
VulnerabilityState は、脆弱性が観察されているか、または遅延している(/suppressed)かどうかを示します。デフォルトでは、脆弱性は観察されます。
| Enum 値 |
|---|
| OBSERVED |
| DEFERRED |
| FALSE_POSITIVE |
30.7.7.42. V1ScanImageRequest
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| imageName | String | ||||
| force | Boolean | ||||
| includeSnoozed | Boolean | ||||
| cluster | String | スキャンを委譲するクラスター。クラスターの名前または ID です。 |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}