osv-scanner-mcp 0.4.1 → 0.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -4
- package/dist/index.js +1 -1
- package/dist/osv/scanReport.js +7 -3
- package/dist/osv/versionScheme.js +39 -0
- package/dist/tools/scanJavaArtifact.js +1 -1
- package/dist/tools/scanJavaProject.js +29 -10
- package/dist/tools/scanProject.js +5 -3
- package/dist/tools/suggestFix.js +2 -2
- package/dist/utils/safeRead.js +7 -1
- package/dist/utils/scanSnapshot.js +59 -14
- package/dist/utils/semverVersion.js +69 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -16,7 +16,7 @@ Google製 [OSV-Scanner](https://github.com/google/osv-scanner) をラップす
|
|
|
16
16
|
- **JAR/WAR実体スキャン**: `scan_java_artifact` ツールで、lockfileが無い・shaded/fat JARしか手元にないプロジェクトでもアーカイブ内メタデータから既知の脆弱性を検出します(ベストエフォート同定であることを明示するcoverage情報付き)
|
|
17
17
|
- **SBOM入力スキャン**: `scan_sbom` ツールでCycloneDX/SPDXのJSON SBOMに記録された依存を検査します。SBOMの網羅性や実成果物との一致は未検証であることを明示します
|
|
18
18
|
- **深刻度順のレポート**: パッケージごとに脆弱性をCVSSスコア順に整理し、5段階の深刻度ラベル(critical / high / medium / low / unknown)とサマリ集計付きで返します
|
|
19
|
-
- **修正版の提示**: 各脆弱性の `fixed_versions`
|
|
19
|
+
- **修正版の提示**: 各脆弱性の `fixed_versions` を含めます。MavenはMavenバージョン優先順位規則(`2.17.1-RELEASE` のようなsemver非対応の表記にも対応)、npm・GoはSemantic Versioningの優先順位で正しくソートします
|
|
20
20
|
- **セキュリティ第一の設計**: シェル非経由の実行・引数ホワイトリスト・パス正規化と境界チェック・タイムアウト/出力サイズ上限を実装段階から組み込んでいます
|
|
21
21
|
|
|
22
22
|
## 動作要件
|
|
@@ -208,7 +208,7 @@ api.osv.dev と deps.dev はどちらも Google が運営するサービスで
|
|
|
208
208
|
- `lockfile_missing`: lockfileの無いマニフェスト(`package.json`、`pyproject.toml`、`Pipfile`、`setup.py`、`build.gradle` 等)。同じディレクトリに同じエコシステムのlockfileがあれば記録しません。上位のディレクトリのlockfileだけがある場合は、`package-lock.json`(v2以降)にそのディレクトリが収録されていることを確認できたときだけ記録しません(npm workspaces)。収録されていなければ `status: "missing"`、確認できない形式(yarn.lock、Python系等)なら `status: "unconfirmed"` として記録します。`hint` の手順でlockfileを生成してから再スキャンしてください(生成は信頼できる環境で)
|
|
209
209
|
- `unpinned_requirements`: requirements.txtのうち、版を固定していない行。`kind` は `unpinned`(版の指定なし)・`range`(`>`、`<`、`!=`、`==1.*`、範囲の組み合わせ等)・`lower_bound`(`>=`、`~=`)。`unpinned` と `range` の行はOSV-Scannerがスキャンせず、`lower_bound` の行は下限の版を使用中の版とみなしてスキャンします(該当パッケージには `version_is_lower_bound: true` が付き、実際の版とは異なる可能性があります)
|
|
210
210
|
- `unscannable_requirements`: スキャンされない行と理由。`-e`、`name @ URL`、パス指定、展開しなかった取り込み(プロジェクトディレクトリの外・存在しない・URL・上限超過)、制約ファイル(`-c`、適用しません)、解釈できないオプションや版の指定。解釈できない行は無視せず、ここに記録します
|
|
211
|
-
- `skipped_files`: スキャン対象から外したファイルと理由(requirements.txt自体が読めない・1MiBを超える場合、`pom.xml` の親POM
|
|
211
|
+
- `skipped_files`: スキャン対象から外したファイルと理由(requirements.txt自体が読めない・1MiBを超える場合、`pom.xml` の親POMが許可ルートの外を参照する場合)。親POMを読めず、親POMを含めずにスキャンした `pom.xml` もここに理由付きで示します([親POMの扱い](#親pomの扱い)を参照)
|
|
212
212
|
- 各一覧は200件までで、超えた分の件数を `omitted_items` に返します
|
|
213
213
|
- `ecosystem_breakdown` は、脆弱性0件のエコシステムも含めて「スキャンした」ことを示します
|
|
214
214
|
- `dependency_groups` はOSV-Scannerが付けた依存グループ(例: `dev`)の生の値です。lockfileの形式によって欠落・不正確なため(pnpmでは付かず、pdmでは `optional` になる等)、参考情報として扱ってください
|
|
@@ -234,6 +234,8 @@ OSV-Scannerは `pom.xml` の `<parent>` が参照する親POM(`<relativePath>`
|
|
|
234
234
|
|
|
235
235
|
`OSV_MCP_ALLOWED_ROOT` を設定している場合、親POMの連鎖のどこかが**許可ルートの外**のファイルを参照する `pom.xml` は、スキャン対象から外します(許可ルート外のファイルの内容を結果や照会先に出さないため)。外したファイルは応答の `skipped_manifests`(`scan_project` では `coverage.skipped_files`)に理由付きで示し、`scope_warning` で「検出0件でも安全とは判断しない」旨を伝えます。全件が外れた場合や、該当する `pom.xml` を直接指定した場合は `path_outside_allowed_root` を返します。
|
|
236
236
|
|
|
237
|
+
存在する親POMを読めない場合(10MiBを超える、名前付きパイプ等の通常のファイルでない、末尾がシンボリックリンク等)は、その `pom.xml` を親POMを含めずにスキャンし、親から継承する依存が欠ける可能性を応答の `incomplete_manifests`(`scan_project` では `coverage.skipped_files`、`coverage.complete` は `false`)に理由付きで示します。子の `pom.xml` に依存が無く `no_packages_found` になる場合も、エラーのメッセージに同じ理由を含めます。親POMが存在しない場合(ルートの `pom.xml` で既定の `../pom.xml` が無い等)は、元の配置でもOSV-Scannerは親を読まないため欠落として扱いません。
|
|
238
|
+
|
|
237
239
|
- 許可ルート内の親POMは従来どおり読みます(サブモジュールのスキャンは許可ルート内なら引き続き使えます)
|
|
238
240
|
- `<relativePath/>`(空)はローカルの親POMを参照しないため対象外です
|
|
239
241
|
- 親POMの指定は、OSV-Scanner(Go)のXMLの解釈に合わせて読みます。要素は名前空間の接頭辞に関係なく要素名で照合し(`<m:parent>` も親として扱う)、ルート要素の直下の `parent` だけを対象にし、文字参照を展開します
|
|
@@ -275,7 +277,7 @@ OSV-Scannerは `pom.xml` の `<parent>` が参照する親POM(`<relativePath>`
|
|
|
275
277
|
```
|
|
276
278
|
|
|
277
279
|
- `packages` は最も深刻な脆弱性を持つ順、各 `vulnerabilities` は深刻度順(unknownは末尾)
|
|
278
|
-
- `fixed_versions` はMaven
|
|
280
|
+
- `fixed_versions` はOSVに記載された修正版です。MavenはMaven優先順位、npm・GoはSemantic Versioningの優先順位で昇順(SemVerとして解釈できない表記は末尾)、PyPI等はOSVの記載順のまま(並び順は保証しません)。複数のリリース系統(例: 2.12系バックポートと2.15系)が混在することがあります。プレリリース版(`5.0.0-beta.3`)やGoの疑似バージョン(`0.0.0-20180925071336-cf3bd585ca2a`)が含まれることもあります。空配列は「OSVに修正版の記載がない」ことを意味します。v0.4.1以前はMaven以外のパッケージで常に空配列を返していました
|
|
279
281
|
- `severity_score` が取得できない脆弱性は `null` / `"unknown"` として扱います
|
|
280
282
|
|
|
281
283
|
### `scan_java_artifact`
|
|
@@ -371,7 +373,7 @@ OSV-Scanner 2.4.0の `java/archive` プラグインを使用し、ネストJAR
|
|
|
371
373
|
- MavenのOSV `ECOSYSTEM` 範囲(`introduced` / `fixed` / `last_affected` / 上限なし)を照合します。`versions` に明示された影響も確認します。範囲欠落・不正・未対応形式・`limit` による不完全な情報では安全と推定せず、候補を検証できなければ `recommended_upgrade: null`、`verification: "no_verified_candidate"` を返します。
|
|
372
374
|
- 推奨時は `verification: "verified"`、CVEごとの `recommended_status` は `affected` / `not_affected` / `unknown` です。推奨保留時は `not_evaluated` になります。`per_cve_detail.fixed_in` は各CVE単独の候補であり、最終推奨先の判定は `recommended_status` を参照してください。
|
|
373
375
|
- 現在より新しい修正版候補がないCVEは `tier: "unfixed"` として推奨の修正対象から除外します(情報欠落を含む場合があります)。除外したCVEも推奨先で判定し、その状態を表示します。全CVEがunfixedの場合も `recommended_upgrade` は `null` です。
|
|
374
|
-
- 修正版の推奨はMavenのみ対応です。Maven以外のパッケージは `verification: "unsupported_ecosystem"`、CVEごとの `tier: "unsupported"` を返し、`unfixed` には数えません(修正版の有無は判定していないため。修正版は `explain_vulnerability` で確認できます)。
|
|
376
|
+
- 修正版の推奨はMavenのみ対応です。Maven以外のパッケージは `verification: "unsupported_ecosystem"`、CVEごとの `tier: "unsupported"` を返し、`unfixed` には数えません(修正版の有無は判定していないため。修正版は `scan_project` の `fixed_versions` や `explain_vulnerability` で確認できます)。
|
|
375
377
|
|
|
376
378
|
### `explain_vulnerability`
|
|
377
379
|
|
package/dist/index.js
CHANGED
|
@@ -36,7 +36,7 @@ if (startupWarning !== null) {
|
|
|
36
36
|
// NOTE: リリース時はpackage.jsonのversionと同じ値に更新すること
|
|
37
37
|
const server = new McpServer({
|
|
38
38
|
name: "osv-scanner-mcp",
|
|
39
|
-
version: "0.4.
|
|
39
|
+
version: "0.4.2",
|
|
40
40
|
});
|
|
41
41
|
server.registerTool("scan_project", {
|
|
42
42
|
title: "プロジェクトの依存の脆弱性スキャン(Java / JavaScript / Python / Go)",
|
package/dist/osv/scanReport.js
CHANGED
|
@@ -12,9 +12,9 @@
|
|
|
12
12
|
* OSV-Scannerの出力は外部由来データなので、形式が想定と異なっても例外を投げず
|
|
13
13
|
* 読み取れた範囲でレポートを構築する(欠損フィールドはスキップ)。
|
|
14
14
|
*/
|
|
15
|
-
import { compareMavenVersions } from "../utils/mavenVersion.js";
|
|
16
15
|
import { asArray, asRecord, asString, asStrings } from "../utils/unknownJson.js";
|
|
17
16
|
import { extractAffectedVersions } from "./affectedVersions.js";
|
|
17
|
+
import { sortVersions, versionRangeTypes } from "./versionScheme.js";
|
|
18
18
|
/** 外部由来のsummaryをLLMに渡す際の長さ上限(プロンプト肥大・DoS対策) */
|
|
19
19
|
const MAX_SUMMARY_LENGTH = 500;
|
|
20
20
|
const CVSS_CRITICAL = 9.0;
|
|
@@ -65,9 +65,12 @@ function extractSummary(vulnDetails) {
|
|
|
65
65
|
/**
|
|
66
66
|
* OSVエントリの`affected[].ranges[].events[].fixed`から修正版を収集する。
|
|
67
67
|
* 1つのOSVエントリが複数パッケージをカバーしうるため、対象パッケージ名で絞り込む。
|
|
68
|
+
* 範囲の型はエコシステム別(versionScheme.ts)。GIT型のコミットハッシュは集めない。
|
|
69
|
+
* v0.4.1以前はMavenだけを集めていたため、npm・Go・PyPI等で常に空になっていた。
|
|
68
70
|
*/
|
|
69
71
|
function extractFixedVersions(vulnDetails, packageName, ecosystem) {
|
|
70
72
|
const versions = new Set();
|
|
73
|
+
const rangeTypes = versionRangeTypes(ecosystem);
|
|
71
74
|
for (const detail of vulnDetails) {
|
|
72
75
|
for (const affectedRaw of asArray(detail.affected)) {
|
|
73
76
|
const affected = asRecord(affectedRaw);
|
|
@@ -77,7 +80,8 @@ function extractFixedVersions(vulnDetails, packageName, ecosystem) {
|
|
|
77
80
|
if (affectedName !== packageName || asString(asRecord(affected.package)?.ecosystem) !== ecosystem)
|
|
78
81
|
continue;
|
|
79
82
|
for (const rangeRaw of asArray(affected.ranges)) {
|
|
80
|
-
|
|
83
|
+
const type = asString(asRecord(rangeRaw)?.type);
|
|
84
|
+
if (type === null || !rangeTypes.has(type))
|
|
81
85
|
continue;
|
|
82
86
|
for (const eventRaw of asArray(asRecord(rangeRaw)?.events)) {
|
|
83
87
|
const fixed = asString(asRecord(eventRaw)?.fixed);
|
|
@@ -87,7 +91,7 @@ function extractFixedVersions(vulnDetails, packageName, ecosystem) {
|
|
|
87
91
|
}
|
|
88
92
|
}
|
|
89
93
|
}
|
|
90
|
-
return
|
|
94
|
+
return sortVersions(versions, ecosystem);
|
|
91
95
|
}
|
|
92
96
|
/**
|
|
93
97
|
* OSV-Scannerの`--format json`出力を`scan_java_project`のレポートに変換する。
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* エコシステムごとのバージョンの扱い(docs/DESIGN_TODO.md「suggest_fix npm/Go対応」)。
|
|
3
|
+
*
|
|
4
|
+
* - Maven: Mavenの優先順位(mavenVersion.ts)。範囲はECOSYSTEM型
|
|
5
|
+
* - npm・Go: SemVer 2.0.0の優先順位(semverVersion.ts)。範囲はSEMVER型とECOSYSTEM型
|
|
6
|
+
* - その他(PyPI等): 比較器なし。範囲はECOSYSTEM型
|
|
7
|
+
*
|
|
8
|
+
* GIT型の範囲(コミットハッシュ)はリリース版と無関係のため、どのエコシステムでも版として扱わない。
|
|
9
|
+
*/
|
|
10
|
+
import { compareMavenVersions } from "../utils/mavenVersion.js";
|
|
11
|
+
import { compareParsedSemver, parseSemver } from "../utils/semverVersion.js";
|
|
12
|
+
const SEMVER_ECOSYSTEMS = new Set(["npm", "Go"]);
|
|
13
|
+
/** 修正版・影響範囲として読み取るOSVの範囲の型 */
|
|
14
|
+
export function versionRangeTypes(ecosystem) {
|
|
15
|
+
if (ecosystem === "Maven")
|
|
16
|
+
return new Set(["ECOSYSTEM"]);
|
|
17
|
+
if (SEMVER_ECOSYSTEMS.has(ecosystem))
|
|
18
|
+
return new Set(["SEMVER", "ECOSYSTEM"]);
|
|
19
|
+
return new Set(["ECOSYSTEM"]);
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* 重複を除いた版の一覧を、エコシステムの優先順位で昇順に並べる。
|
|
23
|
+
* - npm・Go: SemVerとして解釈できない版は末尾に記載順のまま置く
|
|
24
|
+
* - 比較器のないエコシステム: 記載順のまま返す
|
|
25
|
+
*/
|
|
26
|
+
export function sortVersions(versions, ecosystem) {
|
|
27
|
+
const unique = [...new Set(versions)];
|
|
28
|
+
if (ecosystem === "Maven")
|
|
29
|
+
return unique.sort(compareMavenVersions);
|
|
30
|
+
if (!SEMVER_ECOSYSTEMS.has(ecosystem))
|
|
31
|
+
return unique;
|
|
32
|
+
const parsed = unique.flatMap((raw) => {
|
|
33
|
+
const version = parseSemver(raw);
|
|
34
|
+
return version === null ? [] : [{ raw, version }];
|
|
35
|
+
});
|
|
36
|
+
const unparsed = unique.filter((raw) => parseSemver(raw) === null);
|
|
37
|
+
parsed.sort((a, b) => compareParsedSemver(a.version, b.version) || (a.raw < b.raw ? -1 : a.raw > b.raw ? 1 : 0));
|
|
38
|
+
return [...parsed.map((p) => p.raw), ...unparsed];
|
|
39
|
+
}
|
|
@@ -32,7 +32,7 @@ export async function handleScanJavaArtifact(args, options = {}) {
|
|
|
32
32
|
if (copy.ok)
|
|
33
33
|
originals.set(copy.path, artifact);
|
|
34
34
|
}
|
|
35
|
-
const raw = originals.size > 0 ? await runOsvArtifactScan([...originals.keys()], options) : { results: [] };
|
|
35
|
+
const raw = originals.size > 0 ? await snapshot.guard(() => runOsvArtifactScan([...originals.keys()], options)) : { results: [] };
|
|
36
36
|
return jsonResult(buildArtifactReport(restoreSourcePaths(raw, originals), artifactPaths));
|
|
37
37
|
}
|
|
38
38
|
finally {
|
|
@@ -21,20 +21,37 @@ export function dependencyResolution(noRemoteResolution, warning = TRANSITIVE_OM
|
|
|
21
21
|
? { transitive_resolution: "disabled", warning }
|
|
22
22
|
: { transitive_resolution: "enabled" };
|
|
23
23
|
}
|
|
24
|
-
const SKIPPED_MANIFESTS_WARNING = "
|
|
24
|
+
const SKIPPED_MANIFESTS_WARNING = "一部のマニフェストをスキャン対象から外したか、親POMを含めずにスキャンしました(skipped_manifests / incomplete_manifestsを参照)。" +
|
|
25
25
|
"それらの依存の脆弱性は結果に含まれないため、検出0件でも安全とは判断しないでください";
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
28
|
-
* (既存の出力を変えない)。件数より前に置き、検出0件を安全と誤読させない
|
|
27
|
+
* 外したマニフェスト(skipped)と、親POMを再現できずにスキャンしたマニフェスト(incomplete)。
|
|
28
|
+
* どちらも無ければ何も出力しない(既存の出力を変えない)。件数より前に置き、検出0件を安全と誤読させない
|
|
29
29
|
*/
|
|
30
|
-
export function skippedManifestsFields(skipped) {
|
|
31
|
-
if (skipped.length === 0)
|
|
30
|
+
export function skippedManifestsFields(skipped, incomplete = []) {
|
|
31
|
+
if (skipped.length === 0 && incomplete.length === 0)
|
|
32
32
|
return {};
|
|
33
|
+
const list = (items) => items.map((s) => ({ path: sanitizeExternalText(s.path), reason: sanitizeExternalText(s.reason) }));
|
|
33
34
|
return {
|
|
34
|
-
|
|
35
|
+
...(skipped.length > 0 ? { skipped_manifests: list(skipped) } : {}),
|
|
36
|
+
...(incomplete.length > 0 ? { incomplete_manifests: list(incomplete) } : {}),
|
|
35
37
|
scope_warning: SKIPPED_MANIFESTS_WARNING,
|
|
36
38
|
};
|
|
37
39
|
}
|
|
40
|
+
/**
|
|
41
|
+
* スキャン対象を外した・親POMを含めずにスキャンしたマニフェストがある状態で「パッケージなし」になった場合、
|
|
42
|
+
* エラーにもその旨を含める(応答の一覧が出ないため、欠落を黙って「依存なし」と読ませない)。
|
|
43
|
+
*/
|
|
44
|
+
export async function withScopeNotes(notes, scan) {
|
|
45
|
+
try {
|
|
46
|
+
return await scan();
|
|
47
|
+
}
|
|
48
|
+
catch (error) {
|
|
49
|
+
if (!(error instanceof ScanToolError) || error.kind !== "no_packages_found" || notes.length === 0)
|
|
50
|
+
throw error;
|
|
51
|
+
throw new ScanToolError(error.kind, `${error.message}。ただし次のマニフェストはスキャン対象から外したか、親POMを含めずにスキャンしたため、` +
|
|
52
|
+
`検出0件でも安全とは判断しないでください: ${notes.map((n) => `${n.path}: ${n.reason}`).join(" / ")}`, error.detail);
|
|
53
|
+
}
|
|
54
|
+
}
|
|
38
55
|
/**
|
|
39
56
|
* 検出したマニフェストをスナップショットへコピーし、コピーをスキャンする(元のファイルは渡さない)。
|
|
40
57
|
* 応答に一時ディレクトリのパスを出さないよう、スキャナーのパスは元のファイルに戻す。
|
|
@@ -43,7 +60,7 @@ export function skippedManifestsFields(skipped) {
|
|
|
43
60
|
export async function scanJavaManifests(project, options) {
|
|
44
61
|
const snapshot = await ScanSnapshot.create();
|
|
45
62
|
try {
|
|
46
|
-
const { targets, skipped } = await snapshotManifests(snapshot, project.targets, {
|
|
63
|
+
const { targets, skipped, incomplete } = await snapshotManifests(snapshot, project.targets, {
|
|
47
64
|
projectDir: project.projectDir,
|
|
48
65
|
allowedRootReal: project.allowedRootReal,
|
|
49
66
|
});
|
|
@@ -56,10 +73,12 @@ export async function scanJavaManifests(project, options) {
|
|
|
56
73
|
throw new ScanToolError(skipped.every((s) => s.kind === "outside_allowed_root") ? "path_outside_allowed_root" : "no_manifest_found", `スキャンできるマニフェストがありません(${details})`);
|
|
57
74
|
}
|
|
58
75
|
const originals = new Map(targets.map((copy, i) => [copy.path, scanned[i].path]));
|
|
59
|
-
const
|
|
76
|
+
const incompleteRelative = incomplete.map((s) => ({ path: relative(s.path), reason: s.reason }));
|
|
77
|
+
const report = await withScopeNotes([...skippedRelative, ...incompleteRelative], () => snapshot.guard(() => runOsvScan(targets, options)));
|
|
60
78
|
return {
|
|
61
79
|
manifests: scanned.map((t) => relative(t.path)),
|
|
62
80
|
skipped: skippedRelative,
|
|
81
|
+
incomplete: incompleteRelative,
|
|
63
82
|
report: { ...report, source_files: report.source_files.map((file) => originals.get(file) ?? file) },
|
|
64
83
|
};
|
|
65
84
|
}
|
|
@@ -73,11 +92,11 @@ export async function handleScanJavaProject(args, options = {}) {
|
|
|
73
92
|
allowedRoot: options.allowedRoot,
|
|
74
93
|
});
|
|
75
94
|
const noRemoteResolution = isRemoteResolutionDisabled(options);
|
|
76
|
-
const { manifests, skipped, report } = await scanJavaManifests(project, { ...options, noRemoteResolution });
|
|
95
|
+
const { manifests, skipped, incomplete, report } = await scanJavaManifests(project, { ...options, noRemoteResolution });
|
|
77
96
|
return jsonResult({
|
|
78
97
|
project_dir: project.projectDir,
|
|
79
98
|
manifests,
|
|
80
|
-
...skippedManifestsFields(skipped),
|
|
99
|
+
...skippedManifestsFields(skipped, incomplete),
|
|
81
100
|
dependency_resolution: dependencyResolution(noRemoteResolution),
|
|
82
101
|
...report,
|
|
83
102
|
});
|
|
@@ -12,7 +12,7 @@ import { sanitizeExternalText } from "../utils/externalText.js";
|
|
|
12
12
|
import { detectProject } from "../utils/manifestDetector.js";
|
|
13
13
|
import { normalizePypiName } from "../utils/requirementsFile.js";
|
|
14
14
|
import { ScanSnapshot, snapshotManifests } from "../utils/scanSnapshot.js";
|
|
15
|
-
import { dependencyResolution } from "./scanJavaProject.js";
|
|
15
|
+
import { dependencyResolution, withScopeNotes } from "./scanJavaProject.js";
|
|
16
16
|
import { errorResult, jsonResult } from "./toolResult.js";
|
|
17
17
|
const TRANSITIVE_OMITTED_WARNING = "OSV_MCP_NO_REMOTE_RESOLUTIONの設定により、マニフェスト(pom.xml / requirements.txt)からの推移的依存の解決を省略しています。" +
|
|
18
18
|
"lockfile(package-lock.json / poetry.lock / go.mod / gradle.lockfile等)に記録された依存は対象ですが、" +
|
|
@@ -96,10 +96,12 @@ function markLowerBounds(project, packages) {
|
|
|
96
96
|
async function scanFromSnapshot(project, options) {
|
|
97
97
|
const snapshot = await ScanSnapshot.create();
|
|
98
98
|
try {
|
|
99
|
-
const { targets, skipped } = await snapshotManifests(snapshot, project.targets, {
|
|
99
|
+
const { targets, skipped, incomplete } = await snapshotManifests(snapshot, project.targets, {
|
|
100
100
|
projectDir: project.projectDir,
|
|
101
101
|
allowedRootReal: project.allowedRootReal,
|
|
102
102
|
});
|
|
103
|
+
// 親POMを再現できずにスキャンしたpom.xmlも、欠落の可能性としてcoverageに出す(complete=falseになる)
|
|
104
|
+
project.skippedFiles.push(...incomplete.map((s) => ({ path: path.relative(project.projectDir, s.path), reason: s.reason })));
|
|
103
105
|
if (skipped.length > 0) {
|
|
104
106
|
const skippedPaths = new Set(skipped.map((s) => s.path));
|
|
105
107
|
project.manifests = project.manifests.filter((m) => !skippedPaths.has(path.join(project.projectDir, m.path)));
|
|
@@ -115,7 +117,7 @@ async function scanFromSnapshot(project, options) {
|
|
|
115
117
|
}
|
|
116
118
|
if (targets.length === 0)
|
|
117
119
|
return parseOsvScanOutput({ results: [] });
|
|
118
|
-
return await runOsvScan(targets, options);
|
|
120
|
+
return await withScopeNotes(project.skippedFiles, () => snapshot.guard(() => runOsvScan(targets, options)));
|
|
119
121
|
}
|
|
120
122
|
finally {
|
|
121
123
|
await snapshot.cleanup();
|
package/dist/tools/suggestFix.js
CHANGED
|
@@ -14,13 +14,13 @@ export async function handleSuggestFix(args, options = {}) {
|
|
|
14
14
|
allowedRoot: options.allowedRoot,
|
|
15
15
|
});
|
|
16
16
|
const noRemoteResolution = isRemoteResolutionDisabled(options);
|
|
17
|
-
const { manifests, skipped, report } = await scanJavaManifests(project, { ...options, noRemoteResolution });
|
|
17
|
+
const { manifests, skipped, incomplete, report } = await scanJavaManifests(project, { ...options, noRemoteResolution });
|
|
18
18
|
const suggestions = suggestUpgrades(report.packages);
|
|
19
19
|
const unfixedVulnerabilities = suggestions.reduce((sum, s) => sum + s.per_cve_detail.filter((d) => d.tier === "unfixed").length, 0);
|
|
20
20
|
return jsonResult({
|
|
21
21
|
project_dir: project.projectDir,
|
|
22
22
|
manifests,
|
|
23
|
-
...skippedManifestsFields(skipped),
|
|
23
|
+
...skippedManifestsFields(skipped, incomplete),
|
|
24
24
|
dependency_resolution: dependencyResolution(noRemoteResolution),
|
|
25
25
|
vulnerable_package_count: suggestions.length,
|
|
26
26
|
unfixed_vulnerability_count: unfixedVulnerabilities,
|
package/dist/utils/safeRead.js
CHANGED
|
@@ -80,7 +80,13 @@ export async function copyRegularFile(filePath, dest, options) {
|
|
|
80
80
|
result = "too_large";
|
|
81
81
|
break;
|
|
82
82
|
}
|
|
83
|
-
|
|
83
|
+
// writeは要求より少ないバイト数で戻りうるため、チャンクを書き切るまで繰り返す
|
|
84
|
+
for (let written = 0; written < bytesRead;) {
|
|
85
|
+
const { bytesWritten } = await target.write(chunk, written, bytesRead - written);
|
|
86
|
+
if (bytesWritten <= 0)
|
|
87
|
+
throw new Error("short write");
|
|
88
|
+
written += bytesWritten;
|
|
89
|
+
}
|
|
84
90
|
}
|
|
85
91
|
}
|
|
86
92
|
finally {
|
|
@@ -25,6 +25,8 @@ export class ScanSnapshot {
|
|
|
25
25
|
maxTotalBytes;
|
|
26
26
|
copied = new Map();
|
|
27
27
|
parentCache = new Map();
|
|
28
|
+
/** 再現した配置のルートごとのディレクトリ → 元のルート("/"等) */
|
|
29
|
+
mirroredRoots = new Map();
|
|
28
30
|
used = 0;
|
|
29
31
|
generated = 0;
|
|
30
32
|
constructor(dir, maxTotalBytes) {
|
|
@@ -42,7 +44,30 @@ export class ScanSnapshot {
|
|
|
42
44
|
/** 元の絶対パスに対応する、スナップショット内のパス */
|
|
43
45
|
mirror(absolute) {
|
|
44
46
|
const { root } = path.parse(absolute);
|
|
45
|
-
|
|
47
|
+
const mirroredRoot = path.join(this.treeRoot, root.replace(/[^A-Za-z0-9]/g, "_"));
|
|
48
|
+
this.mirroredRoots.set(mirroredRoot, root);
|
|
49
|
+
return path.join(mirroredRoot, path.relative(root, absolute));
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* スキャナーのメッセージ(stderr等)に含まれるコピーのパスを元のパスに戻す。
|
|
53
|
+
* 生成したコピー(requirements.txt)など元のファイルが無いものは一時ディレクトリと分かる表記にする
|
|
54
|
+
*/
|
|
55
|
+
restorePaths(text) {
|
|
56
|
+
let restored = text;
|
|
57
|
+
for (const [mirroredRoot, root] of this.mirroredRoots)
|
|
58
|
+
restored = restored.split(mirroredRoot + path.sep).join(root);
|
|
59
|
+
return restored.split(this.dir).join("<一時コピー>");
|
|
60
|
+
}
|
|
61
|
+
/** スキャナーのエラーに一時ディレクトリのパスを出さない(応答のパスは常に元のファイルを指す) */
|
|
62
|
+
async guard(scan) {
|
|
63
|
+
try {
|
|
64
|
+
return await scan();
|
|
65
|
+
}
|
|
66
|
+
catch (error) {
|
|
67
|
+
if (!(error instanceof ScanToolError))
|
|
68
|
+
throw error;
|
|
69
|
+
throw new ScanToolError(error.kind, this.restorePaths(error.message), error.detail === undefined ? undefined : this.restorePaths(error.detail));
|
|
70
|
+
}
|
|
46
71
|
}
|
|
47
72
|
/** 元のファイルを安全にコピーする。同じファイルは1回だけコピーする */
|
|
48
73
|
async copy(absolute, boundary, maxBytes = Infinity) {
|
|
@@ -89,11 +114,15 @@ const UNPARSEABLE = "親POMの指定を確実に解釈できないため(親要
|
|
|
89
114
|
/**
|
|
90
115
|
* pom.xmlと親POMの連鎖をスナップショットへコピーする。
|
|
91
116
|
* 許可ルート設定時、連鎖が許可ルートの外・スナップショットの外を参照するか、解釈できない場合は除外理由を返す。
|
|
117
|
+
* 存在する親POMを再現できなかった場合(サイズ超過・通常のファイルでない等)はスキャンを続けるが、
|
|
118
|
+
* 親から継承する依存が欠ける可能性があるためincompleteに理由を返す(黙って成功扱いにしない)。
|
|
92
119
|
*/
|
|
93
120
|
async function snapshotPom(snapshot, pomPath, context) {
|
|
94
|
-
const
|
|
95
|
-
if (!
|
|
96
|
-
return { ok: false, reason:
|
|
121
|
+
const copied = await snapshot.copy(pomPath, context.projectDir, MAX_POM_BYTES);
|
|
122
|
+
if (!copied.ok)
|
|
123
|
+
return { ok: false, reason: copied.message, kind: "unreadable" };
|
|
124
|
+
const first = { ok: true, path: copied.path };
|
|
125
|
+
const partial = (reason) => ({ ...first, incomplete: reason });
|
|
97
126
|
const restricted = context.allowedRootReal !== undefined;
|
|
98
127
|
let current = pomPath;
|
|
99
128
|
let currentCopy = first.path;
|
|
@@ -101,8 +130,11 @@ async function snapshotPom(snapshot, pomPath, context) {
|
|
|
101
130
|
const relativePath = await snapshot.parentOf(currentCopy);
|
|
102
131
|
if (relativePath === null || relativePath === "")
|
|
103
132
|
return first;
|
|
104
|
-
if (relativePath === undefined)
|
|
105
|
-
return restricted
|
|
133
|
+
if (relativePath === undefined) {
|
|
134
|
+
return restricted
|
|
135
|
+
? { ok: false, reason: UNPARSEABLE, kind: "unreadable" }
|
|
136
|
+
: partial("親POMの指定を確実に解釈できないため、親POMを含めずにスキャンしました。親から継承する依存が結果に含まれない可能性があります");
|
|
137
|
+
}
|
|
106
138
|
// Goのfilepath.Joinと同じ規則で結合する(絶対パスも連結し、..はルートで止まる)
|
|
107
139
|
const inCopy = path.join(path.dirname(currentCopy), relativePath);
|
|
108
140
|
if (!isInsideDir(snapshot.treeRoot, inCopy)) {
|
|
@@ -116,8 +148,12 @@ async function snapshotPom(snapshot, pomPath, context) {
|
|
|
116
148
|
if ((await stat(candidate)).isDirectory())
|
|
117
149
|
candidate = path.join(candidate, "pom.xml");
|
|
118
150
|
}
|
|
119
|
-
catch {
|
|
120
|
-
|
|
151
|
+
catch (error) {
|
|
152
|
+
// 参照先が無い: 元の配置でもosv-scannerは親を読まないため、欠落ではない
|
|
153
|
+
const code = error.code;
|
|
154
|
+
if (code === "ENOENT" || code === "ENOTDIR")
|
|
155
|
+
return first;
|
|
156
|
+
return partial(`親POM(relativePath: ${relativePath})を確認できないため、親POMを含めずにスキャンしました。親から継承する依存が結果に含まれない可能性があります`);
|
|
121
157
|
}
|
|
122
158
|
const parent = await snapshot.copy(candidate, context.allowedRootReal, MAX_POM_BYTES);
|
|
123
159
|
if (!parent.ok) {
|
|
@@ -131,27 +167,36 @@ async function snapshotPom(snapshot, pomPath, context) {
|
|
|
131
167
|
}
|
|
132
168
|
if (parent.failure === "changed")
|
|
133
169
|
return { ok: false, reason: `親POMの${parent.message}`, kind: "unreadable" };
|
|
134
|
-
|
|
170
|
+
// 読めない・通常のファイルでない・サイズ超過等: コピーしないため、osv-scannerも読まない
|
|
171
|
+
return partial(`親POM(relativePath: ${relativePath})を読めないため(${parent.message})、親POMを含めずにスキャンしました。` +
|
|
172
|
+
"親から継承する依存が結果に含まれない可能性があります(親のGAVが一致しない場合はもともと読まれません)");
|
|
135
173
|
}
|
|
136
174
|
current = candidate;
|
|
137
175
|
currentCopy = parent.path;
|
|
138
176
|
}
|
|
139
|
-
return restricted
|
|
177
|
+
return restricted
|
|
178
|
+
? { ok: false, reason: `親POMの連鎖が上限(${MAX_PARENT_DEPTH}段)を超えています`, kind: "unreadable" }
|
|
179
|
+
: partial(`親POMの連鎖が上限(${MAX_PARENT_DEPTH}段)を超えるため、それより上の親POMを含めずにスキャンしました`);
|
|
140
180
|
}
|
|
141
181
|
/**
|
|
142
182
|
* 検出済みのマニフェストをスナップショットへコピーし、osv-scannerに渡す対象(コピー)を返す。
|
|
143
|
-
* コピーできない・除外すべきものはskippedに理由付きで返す。
|
|
183
|
+
* コピーできない・除外すべきものはskippedに、親POMを再現できずスキャンしたものはincompleteに理由付きで返す。
|
|
144
184
|
*/
|
|
145
185
|
export async function snapshotManifests(snapshot, targets, context) {
|
|
146
186
|
const copies = [];
|
|
147
187
|
const skipped = [];
|
|
188
|
+
const incomplete = [];
|
|
148
189
|
for (const target of targets) {
|
|
149
190
|
if (target.format === "pom.xml") {
|
|
150
191
|
const result = await snapshotPom(snapshot, target.path, context);
|
|
151
|
-
if (result.ok)
|
|
192
|
+
if (result.ok) {
|
|
152
193
|
copies.push({ path: result.path, format: target.format });
|
|
153
|
-
|
|
194
|
+
if (result.incomplete !== undefined)
|
|
195
|
+
incomplete.push({ path: target.path, reason: result.incomplete });
|
|
196
|
+
}
|
|
197
|
+
else {
|
|
154
198
|
skipped.push({ path: target.path, reason: result.reason, kind: result.kind });
|
|
199
|
+
}
|
|
155
200
|
continue;
|
|
156
201
|
}
|
|
157
202
|
const result = await snapshot.copy(target.path, context.projectDir);
|
|
@@ -160,5 +205,5 @@ export async function snapshotManifests(snapshot, targets, context) {
|
|
|
160
205
|
else
|
|
161
206
|
skipped.push({ path: target.path, reason: result.message, kind: "unreadable" });
|
|
162
207
|
}
|
|
163
|
-
return { targets: copies, skipped };
|
|
208
|
+
return { targets: copies, skipped, incomplete };
|
|
164
209
|
}
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Semantic Versioning 2.0.0のバージョン解釈と優先順位比較(semver.org 11節)。
|
|
3
|
+
*
|
|
4
|
+
* OSVのnpm・Goの範囲(SEMVER型、およびECOSYSTEM型)の順序はSemVerの優先順位に従う。
|
|
5
|
+
* 実データ(docs/DESIGN_TODO.md「suggest_fix npm/Go対応」)の要点:
|
|
6
|
+
* - Goの疑似バージョン(`0.0.0-20190101120000-abcdef123456`)はプレリリースとして正しく並ぶ
|
|
7
|
+
* - Goの`+incompatible`はビルドメタデータとして比較で無視する(`20.10.14+incompatible` = `20.10.14`)
|
|
8
|
+
* - `19.03.9`(数値部の先頭ゼロ)や`13.0`のような値はSemVerではないためnullを返す
|
|
9
|
+
*/
|
|
10
|
+
const NUMERIC = "0|[1-9]\\d*";
|
|
11
|
+
const PRE_ID = "(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*)";
|
|
12
|
+
const BUILD_ID = "[0-9A-Za-z-]+";
|
|
13
|
+
const SEMVER_RE = new RegExp(`^v?(${NUMERIC})\\.(${NUMERIC})\\.(${NUMERIC})` +
|
|
14
|
+
`(?:-(${PRE_ID}(?:\\.${PRE_ID})*))?` +
|
|
15
|
+
`(?:\\+${BUILD_ID}(?:\\.${BUILD_ID})*)?$`);
|
|
16
|
+
/**
|
|
17
|
+
* SemVer 2.0.0として厳密に解釈する。解釈できなければnull。
|
|
18
|
+
* 先頭の`v`は防御的に1文字だけ受け付ける(OSVとosv-scannerはGoの版を`v`なしで返す)。
|
|
19
|
+
*/
|
|
20
|
+
export function parseSemver(version) {
|
|
21
|
+
const m = SEMVER_RE.exec(version);
|
|
22
|
+
if (!m)
|
|
23
|
+
return null;
|
|
24
|
+
const numbers = [m[1], m[2], m[3]].map(Number);
|
|
25
|
+
if (!numbers.every(Number.isSafeInteger))
|
|
26
|
+
return null;
|
|
27
|
+
return {
|
|
28
|
+
major: numbers[0],
|
|
29
|
+
minor: numbers[1],
|
|
30
|
+
patch: numbers[2],
|
|
31
|
+
prerelease: m[4] === undefined ? [] : m[4].split(".").map((id) => (/^\d+$/.test(id) ? BigInt(id) : id)),
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
function cmp(a, b) {
|
|
35
|
+
return a < b ? -1 : a > b ? 1 : 0;
|
|
36
|
+
}
|
|
37
|
+
/** 解釈済みの2つの版をSemVerの優先順位で比較する(ビルドメタデータは無視)。 */
|
|
38
|
+
export function compareParsedSemver(a, b) {
|
|
39
|
+
const core = cmp(a.major, b.major) || cmp(a.minor, b.minor) || cmp(a.patch, b.patch);
|
|
40
|
+
if (core !== 0)
|
|
41
|
+
return core;
|
|
42
|
+
// プレリリースを持つ版は、同じ版の正式リリースより小さい
|
|
43
|
+
if (a.prerelease.length === 0 || b.prerelease.length === 0) {
|
|
44
|
+
return a.prerelease.length === b.prerelease.length ? 0 : a.prerelease.length === 0 ? 1 : -1;
|
|
45
|
+
}
|
|
46
|
+
const length = Math.min(a.prerelease.length, b.prerelease.length);
|
|
47
|
+
for (let i = 0; i < length; i++) {
|
|
48
|
+
const x = a.prerelease[i];
|
|
49
|
+
const y = b.prerelease[i];
|
|
50
|
+
if (typeof x === typeof y) {
|
|
51
|
+
const result = cmp(x, y);
|
|
52
|
+
if (result !== 0)
|
|
53
|
+
return result;
|
|
54
|
+
}
|
|
55
|
+
else {
|
|
56
|
+
// 数値の識別子は英数字の識別子より小さい
|
|
57
|
+
return typeof x === "bigint" ? -1 : 1;
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
return cmp(a.prerelease.length, b.prerelease.length);
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* 2つの版をSemVerの優先順位で比較する。どちらかを解釈できなければnull。
|
|
64
|
+
*/
|
|
65
|
+
export function compareSemver(a, b) {
|
|
66
|
+
const x = parseSemver(a);
|
|
67
|
+
const y = parseSemver(b);
|
|
68
|
+
return x === null || y === null ? null : compareParsedSemver(x, y);
|
|
69
|
+
}
|