@openai/codex-security 0.7.0 → 0.8.1
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 +18 -12
- package/_bundled_plugin/.codex-plugin/plugin.json +1 -0
- package/_bundled_plugin/examples/completed-scan/findings.json +34 -34
- package/_bundled_plugin/examples/completed-scan/report.md +22 -31
- package/_bundled_plugin/examples/completed-scan/scan-manifest.json +27 -29
- package/_bundled_plugin/examples/{completed-scan → legacy-completed-scan}/coverage.json +1 -0
- package/_bundled_plugin/examples/legacy-completed-scan/findings.json +57 -0
- package/_bundled_plugin/examples/legacy-completed-scan/report.md +98 -0
- package/_bundled_plugin/examples/legacy-completed-scan/scan-manifest.json +43 -0
- package/_bundled_plugin/mcp/helpers.mjs.br.part-000 +0 -0
- package/_bundled_plugin/mcp/helpers.mjs.br.part-001 +0 -0
- package/_bundled_plugin/mcp/native/win32-arm64/windows.node +0 -0
- package/_bundled_plugin/mcp/native/win32-x64/windows.node +0 -0
- package/_bundled_plugin/mcp/server.mjs.br.part-000 +0 -0
- package/_bundled_plugin/mcp/server.mjs.br.part-001 +0 -0
- package/_bundled_plugin/mcp/server.mjs.br.part-002 +0 -0
- package/_bundled_plugin/references/core-scan.md +2 -2
- package/_bundled_plugin/references/final-report.md +16 -6
- package/_bundled_plugin/references/scan-artifacts.md +6 -6
- package/_bundled_plugin/references/scan-contract.md +10 -12
- package/_bundled_plugin/references/threat-model.md +1 -1
- package/_bundled_plugin/schemas/scan-manifest.schema.json +36 -11
- package/_bundled_plugin/schemas/tools/scan-draft.schema.json +5 -5
- package/_bundled_plugin/scripts/deep_scan_workbench.py +1 -1
- package/_bundled_plugin/scripts/finalize_scan_contract.py +97 -20
- package/_bundled_plugin/scripts/report_projection.py +5 -2
- package/_bundled_plugin/scripts/review_state.py +68 -0
- package/_bundled_plugin/scripts/servicenow_avit.py +107 -0
- package/_bundled_plugin/scripts/validate_scan_contract.py +1 -2
- package/_bundled_plugin/scripts/workbench/retained_coverage.py +49 -37
- package/_bundled_plugin/scripts/workbench/retained_records.py +7 -7
- package/_bundled_plugin/scripts/workbench/saved_coverage.py +15 -15
- package/_bundled_plugin/scripts/workbench/saved_sources.py +24 -6
- package/_bundled_plugin/scripts/workbench_constants.py +0 -1
- package/_bundled_plugin/scripts/workbench_coverage_receipts.py +4 -4
- package/_bundled_plugin/scripts/workbench_db.py +5 -150
- package/_bundled_plugin/scripts/workbench_saved_results.py +169 -4
- package/_bundled_plugin/scripts/workbench_scan_history.py +12 -7
- package/_bundled_plugin/scripts/workbench_scan_start.py +4 -1
- package/_bundled_plugin/skills/publish-findings/SKILL.md +9 -3
- package/_bundled_plugin/skills/security-diff-scan/SKILL.md +1 -1
- package/_bundled_plugin/skills/security-scan/SKILL.md +7 -7
- package/_bundled_plugin/skills/track-findings/SKILL.md +1 -1
- package/dist/api.d.ts.map +1 -1
- package/dist/api.js +50 -27
- package/dist/api.js.map +1 -1
- package/dist/artifact-export.d.ts +12 -3
- package/dist/artifact-export.d.ts.map +1 -1
- package/dist/artifact-export.js +30 -10
- package/dist/artifact-export.js.map +1 -1
- package/dist/cli-help.d.ts.map +1 -1
- package/dist/cli-help.js +1 -0
- package/dist/cli-help.js.map +1 -1
- package/dist/cli.d.ts +1 -1
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +69 -55
- package/dist/cli.js.map +1 -1
- package/dist/cloud-publish.d.ts.map +1 -1
- package/dist/cloud-publish.js +2 -23
- package/dist/cloud-publish.js.map +1 -1
- package/dist/contract.d.ts +4 -2
- package/dist/contract.d.ts.map +1 -1
- package/dist/contract.js +39 -21
- package/dist/contract.js.map +1 -1
- package/dist/custom-publish.js +2 -2
- package/dist/custom-publish.js.map +1 -1
- package/dist/custom-validation-prompt.d.ts.map +1 -1
- package/dist/custom-validation-prompt.js +14 -6
- package/dist/custom-validation-prompt.js.map +1 -1
- package/dist/custom-validation.d.ts.map +1 -1
- package/dist/custom-validation.js +17 -15
- package/dist/custom-validation.js.map +1 -1
- package/dist/deduplication/codex-review.d.ts.map +1 -1
- package/dist/deduplication/codex-review.js +2 -2
- package/dist/deduplication/codex-review.js.map +1 -1
- package/dist/deduplication/deduplication-prompts.d.ts +1 -0
- package/dist/deduplication/deduplication-prompts.d.ts.map +1 -1
- package/dist/deduplication/deduplication-prompts.js +3 -0
- package/dist/deduplication/deduplication-prompts.js.map +1 -1
- package/dist/deduplication/records-protocol.d.ts.map +1 -1
- package/dist/deduplication/records-protocol.js +21 -1
- package/dist/deduplication/records-protocol.js.map +1 -1
- package/dist/deduplication/scan.d.ts.map +1 -1
- package/dist/deduplication/scan.js +2 -2
- package/dist/deduplication/scan.js.map +1 -1
- package/dist/external-findings-local.d.ts +1 -0
- package/dist/external-findings-local.d.ts.map +1 -1
- package/dist/external-findings-local.js +25 -2
- package/dist/external-findings-local.js.map +1 -1
- package/dist/external-findings-publish.d.ts +1 -0
- package/dist/external-findings-publish.d.ts.map +1 -1
- package/dist/external-findings-publish.js +55 -26
- package/dist/external-findings-publish.js.map +1 -1
- package/dist/external-findings-read.d.ts +1 -0
- package/dist/external-findings-read.d.ts.map +1 -1
- package/dist/external-findings-read.js +10 -0
- package/dist/external-findings-read.js.map +1 -1
- package/dist/external-findings.d.ts +2 -0
- package/dist/external-findings.d.ts.map +1 -1
- package/dist/external-findings.js.map +1 -1
- package/dist/external-import-contract.d.ts +4 -0
- package/dist/external-import-contract.d.ts.map +1 -1
- package/dist/external-import-contract.js +34 -10
- package/dist/external-import-contract.js.map +1 -1
- package/dist/finding-workflow.d.ts +2 -0
- package/dist/finding-workflow.d.ts.map +1 -1
- package/dist/finding-workflow.js +3 -0
- package/dist/finding-workflow.js.map +1 -1
- package/dist/github-advisories.d.ts.map +1 -1
- package/dist/github-advisories.js +5 -5
- package/dist/github-advisories.js.map +1 -1
- package/dist/github-dependabot-findings.d.ts +6 -0
- package/dist/github-dependabot-findings.d.ts.map +1 -0
- package/dist/github-dependabot-findings.js +247 -0
- package/dist/github-dependabot-findings.js.map +1 -0
- package/dist/github-findings.d.ts.map +1 -1
- package/dist/github-findings.js +11 -4
- package/dist/github-findings.js.map +1 -1
- package/dist/github-identifiers.d.ts +4 -0
- package/dist/github-identifiers.d.ts.map +1 -0
- package/dist/github-identifiers.js +9 -0
- package/dist/github-identifiers.js.map +1 -0
- package/dist/github.d.ts.map +1 -1
- package/dist/github.js +4 -6
- package/dist/github.js.map +1 -1
- package/dist/host-protocol.d.ts +1 -1
- package/dist/host-protocol.d.ts.map +1 -1
- package/dist/host-protocol.js +2 -2
- package/dist/host-protocol.js.map +1 -1
- package/dist/hosted-scan.d.ts.map +1 -1
- package/dist/hosted-scan.js +13 -6
- package/dist/hosted-scan.js.map +1 -1
- package/dist/import-scan.js +16 -16
- package/dist/import-scan.js.map +1 -1
- package/dist/index.d.ts +2 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -1
- package/dist/knowledge-base.js +3 -0
- package/dist/knowledge-base.js.map +1 -1
- package/dist/mock-scan.d.ts +1 -2
- package/dist/mock-scan.d.ts.map +1 -1
- package/dist/mock-scan.js +12 -17
- package/dist/mock-scan.js.map +1 -1
- package/dist/models.d.ts +9 -1
- package/dist/models.d.ts.map +1 -1
- package/dist/models.js.map +1 -1
- package/dist/multiscan.d.ts.map +1 -1
- package/dist/multiscan.js +1 -6
- package/dist/multiscan.js.map +1 -1
- package/dist/native-json-findings.d.ts +30 -0
- package/dist/native-json-findings.d.ts.map +1 -0
- package/dist/native-json-findings.js +114 -0
- package/dist/native-json-findings.js.map +1 -0
- package/dist/opengrep-findings.d.ts +10 -0
- package/dist/opengrep-findings.d.ts.map +1 -0
- package/dist/opengrep-findings.js +198 -0
- package/dist/opengrep-findings.js.map +1 -0
- package/dist/patch-tui.d.ts.map +1 -1
- package/dist/patch-tui.js +2 -0
- package/dist/patch-tui.js.map +1 -1
- package/dist/publication.js +1 -2
- package/dist/publication.js.map +1 -1
- package/dist/record.d.ts +1 -0
- package/dist/record.d.ts.map +1 -1
- package/dist/record.js +10 -0
- package/dist/record.js.map +1 -1
- package/dist/result.d.ts +5 -3
- package/dist/result.d.ts.map +1 -1
- package/dist/result.js +9 -6
- package/dist/result.js.map +1 -1
- package/dist/scan-history-renderer.js +1 -1
- package/dist/scan-history-renderer.js.map +1 -1
- package/dist/scanner-import.d.ts +0 -1
- package/dist/scanner-import.d.ts.map +1 -1
- package/dist/scanner-import.js +9 -9
- package/dist/scanner-import.js.map +1 -1
- package/dist/security-policy.d.ts.map +1 -1
- package/dist/security-policy.js +16 -2
- package/dist/security-policy.js.map +1 -1
- package/dist/semgrep-findings.d.ts.map +1 -1
- package/dist/semgrep-findings.js +15 -82
- package/dist/semgrep-findings.js.map +1 -1
- package/docs/cli.md +55 -10
- package/docs/dedupe-records.md +15 -1
- package/docs/hosted-scans.md +14 -0
- package/package.json +5 -5
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cloud-publish.d.ts","sourceRoot":"","sources":["../src/cloud-publish.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,OAAO,EAAgB,MAAM,aAAa,CAAC;AAkCzD,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;CACtB;AAED,UAAU,4BAA4B;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IAChC,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;IACjE,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,wBAAsB,kBAAkB,CACtC,aAAa,EAAE,MAAM,EACrB,YAAY,GAAE,4BAA4B,GAAG;IAC3C,cAAc,CAAC,EAAE,MAAM,CAAC;CACpB,GACL,OAAO,CAAC,sBAAsB,CAAC,CAYjC;AAED,wBAAsB,yBAAyB,CAC7C,OAAO,EAAE,MAAM,EACf,YAAY,GAAE,4BAAiC,GAC9C,OAAO,CAAC,sBAAsB,CAAC,
|
|
1
|
+
{"version":3,"file":"cloud-publish.d.ts","sourceRoot":"","sources":["../src/cloud-publish.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,OAAO,EAAgB,MAAM,aAAa,CAAC;AAkCzD,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;CACtB;AAED,UAAU,4BAA4B;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IAChC,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;IACjE,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,wBAAsB,kBAAkB,CACtC,aAAa,EAAE,MAAM,EACrB,YAAY,GAAE,4BAA4B,GAAG;IAC3C,cAAc,CAAC,EAAE,MAAM,CAAC;CACpB,GACL,OAAO,CAAC,sBAAsB,CAAC,CAYjC;AAED,wBAAsB,yBAAyB,CAC7C,OAAO,EAAE,MAAM,EACf,YAAY,GAAE,4BAAiC,GAC9C,OAAO,CAAC,sBAAsB,CAAC,CAwEjC"}
|
package/dist/cloud-publish.js
CHANGED
|
@@ -58,23 +58,6 @@ export async function publishFindingsCsvToCloud(csvPath, dependencies = {}) {
|
|
|
58
58
|
scanId,
|
|
59
59
|
findings,
|
|
60
60
|
});
|
|
61
|
-
const coverageDocument = JSON.stringify({
|
|
62
|
-
documentType: "codex-security.coverage",
|
|
63
|
-
schemaVersion: "1.0",
|
|
64
|
-
scanId,
|
|
65
|
-
mode: "repository",
|
|
66
|
-
inventoryStrategy: "custom",
|
|
67
|
-
includePaths: ["."],
|
|
68
|
-
excludePaths: [],
|
|
69
|
-
surfaces: findings.map((finding) => ({
|
|
70
|
-
id: finding.occurrenceId,
|
|
71
|
-
label: finding.title,
|
|
72
|
-
disposition: "reported",
|
|
73
|
-
receiptRefs: [],
|
|
74
|
-
})),
|
|
75
|
-
explicitExclusions: [],
|
|
76
|
-
deferred: [],
|
|
77
|
-
});
|
|
78
61
|
const scan = {
|
|
79
62
|
id: scanId,
|
|
80
63
|
producer: { name: "codex-security-cli", version: VERSION },
|
|
@@ -93,7 +76,8 @@ export async function publishFindingsCsvToCloud(csvPath, dependencies = {}) {
|
|
|
93
76
|
excludePaths: [],
|
|
94
77
|
summary: "Findings imported from a Codex Security CSV export.",
|
|
95
78
|
},
|
|
96
|
-
|
|
79
|
+
mode: "repository",
|
|
80
|
+
review: { excludedPaths: [] },
|
|
97
81
|
findingsRef: "findings.json",
|
|
98
82
|
artifacts: [
|
|
99
83
|
{
|
|
@@ -101,11 +85,6 @@ export async function publishFindingsCsvToCloud(csvPath, dependencies = {}) {
|
|
|
101
85
|
sha256: sha256(findingsDocument),
|
|
102
86
|
mediaType: "application/json",
|
|
103
87
|
},
|
|
104
|
-
{
|
|
105
|
-
path: "coverage.json",
|
|
106
|
-
sha256: sha256(coverageDocument),
|
|
107
|
-
mediaType: "application/json",
|
|
108
|
-
},
|
|
109
88
|
{
|
|
110
89
|
path: "findings.csv",
|
|
111
90
|
sha256: digest,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cloud-publish.js","sourceRoot":"","sources":["../src/cloud-publish.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,KAAK,IAAI,SAAS,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,UAAU,IAAI,MAAM,EAAE,MAAM,eAAe,CAAC;AACnE,OAAO,EACL,2BAA2B,EAC3B,kBAAkB,EAClB,YAAY,GACb,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,aAAa,EACb,gBAAgB,GACjB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,iBAAiB,EACjB,0CAA0C,EAC1C,2BAA2B,EAC3B,qCAAqC,EACrC,UAAU,GACX,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,MAAM,sBAAsB,GAC1B,qKAAqK,CAAC;AAExK,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE;IAC1C,cAAc,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IACnC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;QACf,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QACtC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;KACrC,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7B,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;IAC7B,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACvC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;CAC3C,CAAC,CAAC;AAiBH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,aAAqB,EACrB,YAAY,GAER,EAAE;IAEN,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,MAAM,YAAY,CAAC,aAAa,EAAE;QAC/D,UAAU,EAAE,MAAM,iBAAiB,EAAE;QACrC,MAAM,EAAE,YAAY,CAAC,MAAM;QAC3B,cAAc,EAAE,YAAY,CAAC,cAAc;KAC5C,CAAC,CAAC;IACH,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,kBAAkB,CAC1B,gDAAgD,CACjD,CAAC;IACJ,CAAC;IACD,OAAO,mBAAmB,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;AAC7E,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,OAAe,EACf,YAAY,GAAiC,EAAE;IAE/C,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;IACtC,IAAI,MAAc,CAAC;IACnB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CACxE,MAAM,QAAQ,CAAC,OAAO,CAAC,CACxB,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,kBAAkB,CAC1B,gCAAgC,YAAY,CAAC,KAAK,CAAC,EAAE,EACrD,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;IACJ,CAAC;IACD,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;IACtC,MAAM,IAAI,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACtC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,kBAAkB,CAC1B,iDAAiD,CAClD,CAAC;IACJ,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAC9B,MAAM,MAAM,GAAG,YAAY,MAAM,CAC/B,CAAC,8BAA8B,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAC7D,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC;IACjB,MAAM,QAAQ,GAAG,oBAAoB,CACnC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,EACvB,KAAK,EACL,MAAM,EACN,aAAa,CACd,CAAC;IACF,MAAM,SAAS,GAAG,0BAA0B,CAAC;IAC7C,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC;QACtC,YAAY,EAAE,yBAAyB;QACvC,aAAa,EAAE,KAAK;QACpB,MAAM;QACN,QAAQ;KACT,CAAC,CAAC;IACH,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC;QACtC,YAAY,EAAE,yBAAyB;QACvC,aAAa,EAAE,KAAK;QACpB,MAAM;QACN,IAAI,EAAE,YAAY;QAClB,iBAAiB,EAAE,QAAQ;QAC3B,YAAY,EAAE,CAAC,GAAG,CAAC;QACnB,YAAY,EAAE,EAAE;QAChB,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YACnC,EAAE,EAAE,OAAO,CAAC,YAAY;YACxB,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,WAAW,EAAE,UAAU;YACvB,WAAW,EAAE,EAAE;SAChB,CAAC,CAAC;QACH,kBAAkB,EAAE,EAAE;QACtB,QAAQ,EAAE,EAAE;KACb,CAAC,CAAC;IACH,MAAM,IAAI,GAAyB;QACjC,EAAE,EAAE,MAAM;QACV,QAAQ,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,EAAE,OAAO,EAAE;QAC1D,MAAM,EAAE,WAAW;QACnB,SAAS,EAAE,SAAS;QACpB,WAAW,EAAE,SAAS;QACtB,QAAQ,EAAE,SAAS;QACnB,MAAM,EAAE;YACN,IAAI,EAAE,oBAAoB;YAC1B,QAAQ,EAAE,aAAa;YACvB,WAAW,EAAE,cAAc;YAC3B,cAAc,EAAE,qCAAqC,MAAM,EAAE;SAC9D;QACD,KAAK,EAAE;YACL,YAAY,EAAE,CAAC,GAAG,CAAC;YACnB,YAAY,EAAE,EAAE;YAChB,OAAO,EAAE,qDAAqD;SAC/D;QACD,WAAW,EAAE,eAAe;QAC5B,WAAW,EAAE,eAAe;QAC5B,SAAS,EAAE;YACT;gBACE,IAAI,EAAE,eAAe;gBACrB,MAAM,EAAE,MAAM,CAAC,gBAAgB,CAAC;gBAChC,SAAS,EAAE,kBAAkB;aAC9B;YACD;gBACE,IAAI,EAAE,eAAe;gBACrB,MAAM,EAAE,MAAM,CAAC,gBAAgB,CAAC;gBAChC,SAAS,EAAE,kBAAkB;aAC9B;YACD;gBACE,IAAI,EAAE,cAAc;gBACpB,MAAM,EAAE,MAAM;gBACd,SAAS,EAAE,UAAU;aACtB;SACF;KACF,CAAC;IACF,OAAO,mBAAmB,CAAC,IAAI,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;AAC3D,CAAC;AAED,KAAK,UAAU,mBAAmB,CAChC,IAA0B,EAC1B,QAAmB,EACnB,YAA0C;IAE1C,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;IACtC,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;QACxB,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,EAAE;YACf,UAAU,EAAE,EAAE;YACd,YAAY,EAAE,QAAQ,CAAC,MAAM;YAC7B,MAAM,EAAE,IAAI;YACZ,QAAQ;SACT,CAAC;IACJ,CAAC;IACD,MAAM,WAAW,GAAG,YAAY,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;IAC5D,MAAM,UAAU,GACd,WAAW,CAAC,kCAAkC,CAAC,EAAE,IAAI,EAAE;QACvD,GAAG,YAAY,CAAC,WAAW,CAAC,eAAe,CAAC;IAC9C,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAAC,WAAW,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM;QAChC,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACjD,CAAC,CAAC,OAAO,CAAC;IACZ,IAAI,QAAkB,CAAC;IACvB,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,CAAC,YAAY,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE;YACpE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,WAAW,CAAC,YAAY,EAAE;gBACnD,oBAAoB,EAAE,WAAW,CAAC,UAAU;gBAC5C,cAAc,EAAE,kBAAkB;gBAClC,MAAM,EAAE,kBAAkB;aAC3B;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,aAAa,EAAE,KAAK;gBACpB,IAAI;gBACJ,QAAQ;aACT,CAAC;YACF,QAAQ,EAAE,OAAO;YACjB,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAAC,MAAM,CAAC;QACP,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;QACtC,2EAA2E;QAC3E,MAAM,IAAI,kBAAkB,CAC1B,0HAA0H,CAC3H,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QACrD,MAAM,MAAM,GACV,QAAQ,CAAC,MAAM,KAAK,GAAG;YACrB,CAAC,CAAC,6CAA6C;YAC/C,CAAC,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG;gBACvB,CAAC,CAAC,8DAA8D;gBAChE,CAAC,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG;oBACvB,CAAC,CAAC,oEAAoE;oBACtE,CAAC,CAAC,8BAA8B,CAAC;QACzC,MAAM,IAAI,kBAAkB,CAC1B,kCAAkC,QAAQ,CAAC,MAAM,MAAM,MAAM,EAAE,CAChE,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GAAG,aAAa,CAAC,SAAS,CACrC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE;QAC/B,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;QACtC,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC,CACH,CAAC;IACF,2EAA2E;IAC3E,wEAAwE;IACxE,wEAAwE;IACxE,IACE,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC;QACpD,CAAC,OAAO,CAAC,OAAO;QAChB,OAAO,CAAC,IAAI,CAAC,aAAa,KAAK,QAAQ,CAAC,MAAM;QAC9C,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM;QACnD,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAC1E,CAAC;QACD,MAAM,IAAI,kBAAkB,CAC1B,2HAA2H,CAC5H,CAAC;IACJ,CAAC;IACD,OAAO;QACL,MAAM,EAAE,IAAI,CAAC,EAAE;QACf,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,WAAW;QACpC,YAAY,EAAE,OAAO,CAAC,IAAI,CAAC,aAAa;KACzC,CAAC;AACJ,CAAC;AAED,2DAA2D;AAC3D,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,WAA8B;IACvE,MAAM,cAAc,GAAG,WAAW,CAAC,YAAY,CAAC,CAAC;IACjD,IAAI,IAAI,GAAG,UAAU,CACnB,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,UAAU,EACpD,WAAW,CACZ,CAAC;IACF,IAAI,kBAAkB,GAAG,IAAI,CAAC;IAC9B,MAAM,aAAa,GAAG,2BAA2B,CAAC,WAAW,CAAC,CAAC;IAC/D,IAAI,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;QAC9B,IAAI,CAAC,CAAC,MAAM,0CAA0C,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC;YACvE,MAAM,IAAI,2BAA2B,CAAC,sBAAsB,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,MAAM,qCAAqC,CAAC,aAAa,CAAC,EAAE,CAAC;YAC/D,IAAI,GAAG,aAAa,CAAC;YACrB,kBAAkB,GAAG,KAAK,CAAC;QAC7B,CAAC;aAAM,IAAI,UAAU,CAAC,IAAI,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC;YAC1D,gFAAgF;YAChF,MAAM,IAAI,2BAA2B,CAAC,sBAAsB,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IACD,IAAI,kBAAkB,EAAE,CAAC;QACvB,IAAI,iBAA0B,CAAC;QAC/B,IAAI,CAAC;YACH,iBAAiB,GAAG,SAAS,CAC3B,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,MAAM,CAAC,CAClD,CAAC,4BAA4B,CAAC,CAAC;QAClC,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,2BAA2B,CAAC,sBAAsB,CAAC,CAAC;QAChE,CAAC;QACD,kEAAkE;QAClE,wEAAwE;QACxE,IAAI,iBAAiB,KAAK,MAAM,EAAE,CAAC;YACjC,MAAM,IAAI,2BAA2B,CAAC,sBAAsB,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IACD,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,iBAAiB,CAAC,SAAS,CAC7C,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC,CAC5D,CAAC;QACF,IAAI,WAAW,CAAC,OAAO;YAAE,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC;IAC1D,CAAC;IAAC,MAAM,CAAC;QACP,2EAA2E;IAC7E,CAAC;IACD,MAAM,IAAI,2BAA2B,CAAC,sBAAsB,CAAC,CAAC;AAChE,CAAC","sourcesContent":["import { existsSync } from \"node:fs\";\nimport { readFile } from \"node:fs/promises\";\nimport { join } from \"node:path\";\nimport { z } from \"zod\";\nimport { parse as parseToml } from \"smol-toml\";\nimport { loadContract, sha256Text as sha256 } from \"./contract.js\";\nimport {\n AuthenticationRequiredError,\n CodexSecurityError,\n errorMessage,\n} from \"./errors.js\";\nimport type { Finding, ScanManifest } from \"./models.js\";\nimport {\n CSV_TARGET_ID,\n bindImportedFindings,\n csvRowFinding,\n parseFindingsCsv,\n} from \"./findings-import.js\";\nimport {\n bundledPluginRoot,\n codexSecurityCredentialAllowsAmbientImport,\n codexSecurityCredentialHome,\n codexSecurityHasStoredFileCredentials,\n expandHome,\n} from \"./runtime.js\";\nimport { VERSION } from \"./version.js\";\nimport { cloudBaseUrl } from \"./cloud-endpoint.js\";\nconst CHATGPT_LOGIN_REQUIRED =\n \"Cloud publication requires a ChatGPT login already available to Codex Security. Run a scan or sign in with ChatGPT using Codex file credential storage, then retry.\";\n\nconst credentialsSchema = z.object({\n auth_mode: z.literal(\"chatgpt\").optional(),\n OPENAI_API_KEY: z.null().optional(),\n tokens: z.object({\n access_token: z.string().trim().min(1),\n account_id: z.string().trim().min(1),\n }),\n});\n\nconst receiptSchema = z.object({\n status: z.literal(\"accepted\"),\n finding_ids: z.array(z.string().min(1)),\n finding_count: z.number().int().positive(),\n});\n\nexport interface CloudPublicationResult {\n scanId: string;\n findingIds: string[];\n findingCount: number;\n dryRun?: true;\n findings?: Finding[];\n}\n\ninterface CloudPublicationDependencies {\n environment?: NodeJS.ProcessEnv;\n fetch?: (url: string, options: RequestInit) => Promise<Response>;\n signal?: AbortSignal;\n dryRun?: boolean;\n}\n\nexport async function publishScanToCloud(\n scanDirectory: string,\n dependencies: CloudPublicationDependencies & {\n expectedScanId?: string;\n } = {},\n): Promise<CloudPublicationResult> {\n const { manifest, findings } = await loadContract(scanDirectory, {\n pluginRoot: await bundledPluginRoot(),\n signal: dependencies.signal,\n expectedScanId: dependencies.expectedScanId,\n });\n if (findings.findings.length === 0) {\n throw new CodexSecurityError(\n \"The completed scan has no findings to publish.\",\n );\n }\n return publishCloudPayload(manifest.scan, findings.findings, dependencies);\n}\n\nexport async function publishFindingsCsvToCloud(\n csvPath: string,\n dependencies: CloudPublicationDependencies = {},\n): Promise<CloudPublicationResult> {\n dependencies.signal?.throwIfAborted();\n let source: string;\n try {\n source = new TextDecoder(\"utf-8\", { fatal: true, ignoreBOM: true }).decode(\n await readFile(csvPath),\n );\n } catch (error) {\n throw new CodexSecurityError(\n `Could not read findings CSV. ${errorMessage(error)}`,\n { cause: error },\n );\n }\n dependencies.signal?.throwIfAborted();\n const rows = parseFindingsCsv(source);\n if (rows.length === 0) {\n throw new CodexSecurityError(\n \"Findings CSV must contain at least one finding.\",\n );\n }\n const digest = sha256(source);\n const scanId = `scan_csv_${sha256(\n [\"codex-security-csv-import/v1\", VERSION, source].join(\"\\0\"),\n ).slice(0, 24)}`;\n const findings = bindImportedFindings(\n rows.map(csvRowFinding),\n \"csv\",\n scanId,\n CSV_TARGET_ID,\n );\n const timestamp = \"1970-01-01T00:00:00.000Z\";\n const findingsDocument = JSON.stringify({\n documentType: \"codex-security.findings\",\n schemaVersion: \"1.0\",\n scanId,\n findings,\n });\n const coverageDocument = JSON.stringify({\n documentType: \"codex-security.coverage\",\n schemaVersion: \"1.0\",\n scanId,\n mode: \"repository\",\n inventoryStrategy: \"custom\",\n includePaths: [\".\"],\n excludePaths: [],\n surfaces: findings.map((finding) => ({\n id: finding.occurrenceId,\n label: finding.title,\n disposition: \"reported\",\n receiptRefs: [],\n })),\n explicitExclusions: [],\n deferred: [],\n });\n const scan: ScanManifest[\"scan\"] = {\n id: scanId,\n producer: { name: \"codex-security-cli\", version: VERSION },\n status: \"completed\",\n startedAt: timestamp,\n completedAt: timestamp,\n sealedAt: timestamp,\n target: {\n kind: \"directory_snapshot\",\n targetId: CSV_TARGET_ID,\n displayName: \"findings.csv\",\n snapshotDigest: `codex-security-snapshot/v1:sha256:${digest}`,\n },\n scope: {\n includePaths: [\".\"],\n excludePaths: [],\n summary: \"Findings imported from a Codex Security CSV export.\",\n },\n coverageRef: \"coverage.json\",\n findingsRef: \"findings.json\",\n artifacts: [\n {\n path: \"findings.json\",\n sha256: sha256(findingsDocument),\n mediaType: \"application/json\",\n },\n {\n path: \"coverage.json\",\n sha256: sha256(coverageDocument),\n mediaType: \"application/json\",\n },\n {\n path: \"findings.csv\",\n sha256: digest,\n mediaType: \"text/csv\",\n },\n ],\n };\n return publishCloudPayload(scan, findings, dependencies);\n}\n\nasync function publishCloudPayload(\n scan: ScanManifest[\"scan\"],\n findings: Finding[],\n dependencies: CloudPublicationDependencies,\n): Promise<CloudPublicationResult> {\n dependencies.signal?.throwIfAborted();\n if (dependencies.dryRun) {\n return {\n scanId: scan.id,\n findingIds: [],\n findingCount: findings.length,\n dryRun: true,\n findings,\n };\n }\n const environment = dependencies.environment ?? process.env;\n const publishUrl =\n environment[\"CODEX_SECURITY_CLOUD_PUBLISH_URL\"]?.trim() ||\n `${cloudBaseUrl(environment)}/cli/findings`;\n const credentials = await readCloudCredentials(environment);\n const timeout = AbortSignal.timeout(30_000);\n const signal = dependencies.signal\n ? AbortSignal.any([dependencies.signal, timeout])\n : timeout;\n let response: Response;\n try {\n response = await (dependencies.fetch ?? globalThis.fetch)(publishUrl, {\n method: \"POST\",\n headers: {\n Authorization: `Bearer ${credentials.access_token}`,\n \"ChatGPT-Account-ID\": credentials.account_id,\n \"Content-Type\": \"application/json\",\n Accept: \"application/json\",\n },\n body: JSON.stringify({\n schemaVersion: \"1.0\",\n scan,\n findings,\n }),\n redirect: \"error\",\n signal,\n });\n } catch {\n dependencies.signal?.throwIfAborted();\n // A lost response does not establish whether the server accepted the POST.\n throw new CodexSecurityError(\n \"Cloud publication was not confirmed. The request was not retried; check whether it was accepted before submitting again.\",\n );\n }\n if (!response.ok) {\n await response.body?.cancel().catch(() => undefined);\n const detail =\n response.status === 401\n ? \"Sign in with ChatGPT again before retrying.\"\n : response.status === 403\n ? \"The signed-in account is not authorized to publish to Cloud.\"\n : response.status === 404\n ? \"Cloud publication is not available for this account or deployment.\"\n : \"The request was not retried.\";\n throw new CodexSecurityError(\n `Cloud publication failed (HTTP ${response.status}). ${detail}`,\n );\n }\n const receipt = receiptSchema.safeParse(\n await response.json().catch(() => {\n dependencies.signal?.throwIfAborted();\n return undefined;\n }),\n );\n // Cloud assigns opaque IDs in request order, so they cannot be compared to\n // local finding IDs. The authenticated response must still preserve the\n // submitted count and return one distinct observation for each finding.\n if (\n (response.status !== 200 && response.status !== 201) ||\n !receipt.success ||\n receipt.data.finding_count !== findings.length ||\n receipt.data.finding_ids.length !== findings.length ||\n new Set(receipt.data.finding_ids).size !== receipt.data.finding_ids.length\n ) {\n throw new CodexSecurityError(\n \"Cloud publication returned an invalid acceptance receipt. Check whether the request was accepted before submitting again.\",\n );\n }\n return {\n scanId: scan.id,\n findingIds: receipt.data.finding_ids,\n findingCount: receipt.data.finding_count,\n };\n}\n\n/** @internal Shared sign-in for local Cloud publishers. */\nexport async function readCloudCredentials(environment: NodeJS.ProcessEnv) {\n const configuredHome = environment[\"CODEX_HOME\"];\n let home = expandHome(\n configuredHome?.trim() ? configuredHome : \"~/.codex\",\n environment,\n );\n let requireFileStorage = true;\n const dedicatedHome = codexSecurityCredentialHome(environment);\n if (existsSync(dedicatedHome)) {\n if (!(await codexSecurityCredentialAllowsAmbientImport(dedicatedHome))) {\n throw new AuthenticationRequiredError(CHATGPT_LOGIN_REQUIRED);\n }\n if (await codexSecurityHasStoredFileCredentials(dedicatedHome)) {\n home = dedicatedHome;\n requireFileStorage = false;\n } else if (existsSync(join(dedicatedHome, \"config.toml\"))) {\n // Do not silently switch accounts when the dedicated login may be in a keyring.\n throw new AuthenticationRequiredError(CHATGPT_LOGIN_REQUIRED);\n }\n }\n if (requireFileStorage) {\n let credentialStorage: unknown;\n try {\n credentialStorage = parseToml(\n await readFile(join(home, \"config.toml\"), \"utf8\"),\n )[\"cli_auth_credentials_store\"];\n } catch {\n throw new AuthenticationRequiredError(CHATGPT_LOGIN_REQUIRED);\n }\n // File presence is not proof that it is the active ambient login:\n // automatic or keyring storage can leave auth.json for another account.\n if (credentialStorage !== \"file\") {\n throw new AuthenticationRequiredError(CHATGPT_LOGIN_REQUIRED);\n }\n }\n try {\n const credentials = credentialsSchema.safeParse(\n JSON.parse(await readFile(join(home, \"auth.json\"), \"utf8\")),\n );\n if (credentials.success) return credentials.data.tokens;\n } catch {\n // Parsing and filesystem diagnostics must not reflect credential contents.\n }\n throw new AuthenticationRequiredError(CHATGPT_LOGIN_REQUIRED);\n}\n"]}
|
|
1
|
+
{"version":3,"file":"cloud-publish.js","sourceRoot":"","sources":["../src/cloud-publish.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,KAAK,IAAI,SAAS,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,UAAU,IAAI,MAAM,EAAE,MAAM,eAAe,CAAC;AACnE,OAAO,EACL,2BAA2B,EAC3B,kBAAkB,EAClB,YAAY,GACb,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,aAAa,EACb,gBAAgB,GACjB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,iBAAiB,EACjB,0CAA0C,EAC1C,2BAA2B,EAC3B,qCAAqC,EACrC,UAAU,GACX,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,MAAM,sBAAsB,GAC1B,qKAAqK,CAAC;AAExK,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE;IAC1C,cAAc,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IACnC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;QACf,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QACtC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;KACrC,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7B,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;IAC7B,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACvC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;CAC3C,CAAC,CAAC;AAiBH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,aAAqB,EACrB,YAAY,GAER,EAAE;IAEN,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,MAAM,YAAY,CAAC,aAAa,EAAE;QAC/D,UAAU,EAAE,MAAM,iBAAiB,EAAE;QACrC,MAAM,EAAE,YAAY,CAAC,MAAM;QAC3B,cAAc,EAAE,YAAY,CAAC,cAAc;KAC5C,CAAC,CAAC;IACH,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,kBAAkB,CAC1B,gDAAgD,CACjD,CAAC;IACJ,CAAC;IACD,OAAO,mBAAmB,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;AAC7E,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,OAAe,EACf,YAAY,GAAiC,EAAE;IAE/C,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;IACtC,IAAI,MAAc,CAAC;IACnB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CACxE,MAAM,QAAQ,CAAC,OAAO,CAAC,CACxB,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,kBAAkB,CAC1B,gCAAgC,YAAY,CAAC,KAAK,CAAC,EAAE,EACrD,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;IACJ,CAAC;IACD,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;IACtC,MAAM,IAAI,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACtC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,kBAAkB,CAC1B,iDAAiD,CAClD,CAAC;IACJ,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAC9B,MAAM,MAAM,GAAG,YAAY,MAAM,CAC/B,CAAC,8BAA8B,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAC7D,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC;IACjB,MAAM,QAAQ,GAAG,oBAAoB,CACnC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,EACvB,KAAK,EACL,MAAM,EACN,aAAa,CACd,CAAC;IACF,MAAM,SAAS,GAAG,0BAA0B,CAAC;IAC7C,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC;QACtC,YAAY,EAAE,yBAAyB;QACvC,aAAa,EAAE,KAAK;QACpB,MAAM;QACN,QAAQ;KACT,CAAC,CAAC;IACH,MAAM,IAAI,GAAyB;QACjC,EAAE,EAAE,MAAM;QACV,QAAQ,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,EAAE,OAAO,EAAE;QAC1D,MAAM,EAAE,WAAW;QACnB,SAAS,EAAE,SAAS;QACpB,WAAW,EAAE,SAAS;QACtB,QAAQ,EAAE,SAAS;QACnB,MAAM,EAAE;YACN,IAAI,EAAE,oBAAoB;YAC1B,QAAQ,EAAE,aAAa;YACvB,WAAW,EAAE,cAAc;YAC3B,cAAc,EAAE,qCAAqC,MAAM,EAAE;SAC9D;QACD,KAAK,EAAE;YACL,YAAY,EAAE,CAAC,GAAG,CAAC;YACnB,YAAY,EAAE,EAAE;YAChB,OAAO,EAAE,qDAAqD;SAC/D;QACD,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE;QAC7B,WAAW,EAAE,eAAe;QAC5B,SAAS,EAAE;YACT;gBACE,IAAI,EAAE,eAAe;gBACrB,MAAM,EAAE,MAAM,CAAC,gBAAgB,CAAC;gBAChC,SAAS,EAAE,kBAAkB;aAC9B;YACD;gBACE,IAAI,EAAE,cAAc;gBACpB,MAAM,EAAE,MAAM;gBACd,SAAS,EAAE,UAAU;aACtB;SACF;KACF,CAAC;IACF,OAAO,mBAAmB,CAAC,IAAI,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;AAC3D,CAAC;AAED,KAAK,UAAU,mBAAmB,CAChC,IAA0B,EAC1B,QAAmB,EACnB,YAA0C;IAE1C,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;IACtC,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;QACxB,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,EAAE;YACf,UAAU,EAAE,EAAE;YACd,YAAY,EAAE,QAAQ,CAAC,MAAM;YAC7B,MAAM,EAAE,IAAI;YACZ,QAAQ;SACT,CAAC;IACJ,CAAC;IACD,MAAM,WAAW,GAAG,YAAY,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;IAC5D,MAAM,UAAU,GACd,WAAW,CAAC,kCAAkC,CAAC,EAAE,IAAI,EAAE;QACvD,GAAG,YAAY,CAAC,WAAW,CAAC,eAAe,CAAC;IAC9C,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAAC,WAAW,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM;QAChC,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACjD,CAAC,CAAC,OAAO,CAAC;IACZ,IAAI,QAAkB,CAAC;IACvB,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,CAAC,YAAY,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE;YACpE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,WAAW,CAAC,YAAY,EAAE;gBACnD,oBAAoB,EAAE,WAAW,CAAC,UAAU;gBAC5C,cAAc,EAAE,kBAAkB;gBAClC,MAAM,EAAE,kBAAkB;aAC3B;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,aAAa,EAAE,KAAK;gBACpB,IAAI;gBACJ,QAAQ;aACT,CAAC;YACF,QAAQ,EAAE,OAAO;YACjB,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAAC,MAAM,CAAC;QACP,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;QACtC,2EAA2E;QAC3E,MAAM,IAAI,kBAAkB,CAC1B,0HAA0H,CAC3H,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QACrD,MAAM,MAAM,GACV,QAAQ,CAAC,MAAM,KAAK,GAAG;YACrB,CAAC,CAAC,6CAA6C;YAC/C,CAAC,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG;gBACvB,CAAC,CAAC,8DAA8D;gBAChE,CAAC,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG;oBACvB,CAAC,CAAC,oEAAoE;oBACtE,CAAC,CAAC,8BAA8B,CAAC;QACzC,MAAM,IAAI,kBAAkB,CAC1B,kCAAkC,QAAQ,CAAC,MAAM,MAAM,MAAM,EAAE,CAChE,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GAAG,aAAa,CAAC,SAAS,CACrC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE;QAC/B,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;QACtC,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC,CACH,CAAC;IACF,2EAA2E;IAC3E,wEAAwE;IACxE,wEAAwE;IACxE,IACE,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC;QACpD,CAAC,OAAO,CAAC,OAAO;QAChB,OAAO,CAAC,IAAI,CAAC,aAAa,KAAK,QAAQ,CAAC,MAAM;QAC9C,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM;QACnD,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAC1E,CAAC;QACD,MAAM,IAAI,kBAAkB,CAC1B,2HAA2H,CAC5H,CAAC;IACJ,CAAC;IACD,OAAO;QACL,MAAM,EAAE,IAAI,CAAC,EAAE;QACf,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,WAAW;QACpC,YAAY,EAAE,OAAO,CAAC,IAAI,CAAC,aAAa;KACzC,CAAC;AACJ,CAAC;AAED,2DAA2D;AAC3D,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,WAA8B;IACvE,MAAM,cAAc,GAAG,WAAW,CAAC,YAAY,CAAC,CAAC;IACjD,IAAI,IAAI,GAAG,UAAU,CACnB,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,UAAU,EACpD,WAAW,CACZ,CAAC;IACF,IAAI,kBAAkB,GAAG,IAAI,CAAC;IAC9B,MAAM,aAAa,GAAG,2BAA2B,CAAC,WAAW,CAAC,CAAC;IAC/D,IAAI,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;QAC9B,IAAI,CAAC,CAAC,MAAM,0CAA0C,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC;YACvE,MAAM,IAAI,2BAA2B,CAAC,sBAAsB,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,MAAM,qCAAqC,CAAC,aAAa,CAAC,EAAE,CAAC;YAC/D,IAAI,GAAG,aAAa,CAAC;YACrB,kBAAkB,GAAG,KAAK,CAAC;QAC7B,CAAC;aAAM,IAAI,UAAU,CAAC,IAAI,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC;YAC1D,gFAAgF;YAChF,MAAM,IAAI,2BAA2B,CAAC,sBAAsB,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IACD,IAAI,kBAAkB,EAAE,CAAC;QACvB,IAAI,iBAA0B,CAAC;QAC/B,IAAI,CAAC;YACH,iBAAiB,GAAG,SAAS,CAC3B,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,MAAM,CAAC,CAClD,CAAC,4BAA4B,CAAC,CAAC;QAClC,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,2BAA2B,CAAC,sBAAsB,CAAC,CAAC;QAChE,CAAC;QACD,kEAAkE;QAClE,wEAAwE;QACxE,IAAI,iBAAiB,KAAK,MAAM,EAAE,CAAC;YACjC,MAAM,IAAI,2BAA2B,CAAC,sBAAsB,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IACD,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,iBAAiB,CAAC,SAAS,CAC7C,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC,CAC5D,CAAC;QACF,IAAI,WAAW,CAAC,OAAO;YAAE,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC;IAC1D,CAAC;IAAC,MAAM,CAAC;QACP,2EAA2E;IAC7E,CAAC;IACD,MAAM,IAAI,2BAA2B,CAAC,sBAAsB,CAAC,CAAC;AAChE,CAAC","sourcesContent":["import { existsSync } from \"node:fs\";\nimport { readFile } from \"node:fs/promises\";\nimport { join } from \"node:path\";\nimport { z } from \"zod\";\nimport { parse as parseToml } from \"smol-toml\";\nimport { loadContract, sha256Text as sha256 } from \"./contract.js\";\nimport {\n AuthenticationRequiredError,\n CodexSecurityError,\n errorMessage,\n} from \"./errors.js\";\nimport type { Finding, ScanManifest } from \"./models.js\";\nimport {\n CSV_TARGET_ID,\n bindImportedFindings,\n csvRowFinding,\n parseFindingsCsv,\n} from \"./findings-import.js\";\nimport {\n bundledPluginRoot,\n codexSecurityCredentialAllowsAmbientImport,\n codexSecurityCredentialHome,\n codexSecurityHasStoredFileCredentials,\n expandHome,\n} from \"./runtime.js\";\nimport { VERSION } from \"./version.js\";\nimport { cloudBaseUrl } from \"./cloud-endpoint.js\";\nconst CHATGPT_LOGIN_REQUIRED =\n \"Cloud publication requires a ChatGPT login already available to Codex Security. Run a scan or sign in with ChatGPT using Codex file credential storage, then retry.\";\n\nconst credentialsSchema = z.object({\n auth_mode: z.literal(\"chatgpt\").optional(),\n OPENAI_API_KEY: z.null().optional(),\n tokens: z.object({\n access_token: z.string().trim().min(1),\n account_id: z.string().trim().min(1),\n }),\n});\n\nconst receiptSchema = z.object({\n status: z.literal(\"accepted\"),\n finding_ids: z.array(z.string().min(1)),\n finding_count: z.number().int().positive(),\n});\n\nexport interface CloudPublicationResult {\n scanId: string;\n findingIds: string[];\n findingCount: number;\n dryRun?: true;\n findings?: Finding[];\n}\n\ninterface CloudPublicationDependencies {\n environment?: NodeJS.ProcessEnv;\n fetch?: (url: string, options: RequestInit) => Promise<Response>;\n signal?: AbortSignal;\n dryRun?: boolean;\n}\n\nexport async function publishScanToCloud(\n scanDirectory: string,\n dependencies: CloudPublicationDependencies & {\n expectedScanId?: string;\n } = {},\n): Promise<CloudPublicationResult> {\n const { manifest, findings } = await loadContract(scanDirectory, {\n pluginRoot: await bundledPluginRoot(),\n signal: dependencies.signal,\n expectedScanId: dependencies.expectedScanId,\n });\n if (findings.findings.length === 0) {\n throw new CodexSecurityError(\n \"The completed scan has no findings to publish.\",\n );\n }\n return publishCloudPayload(manifest.scan, findings.findings, dependencies);\n}\n\nexport async function publishFindingsCsvToCloud(\n csvPath: string,\n dependencies: CloudPublicationDependencies = {},\n): Promise<CloudPublicationResult> {\n dependencies.signal?.throwIfAborted();\n let source: string;\n try {\n source = new TextDecoder(\"utf-8\", { fatal: true, ignoreBOM: true }).decode(\n await readFile(csvPath),\n );\n } catch (error) {\n throw new CodexSecurityError(\n `Could not read findings CSV. ${errorMessage(error)}`,\n { cause: error },\n );\n }\n dependencies.signal?.throwIfAborted();\n const rows = parseFindingsCsv(source);\n if (rows.length === 0) {\n throw new CodexSecurityError(\n \"Findings CSV must contain at least one finding.\",\n );\n }\n const digest = sha256(source);\n const scanId = `scan_csv_${sha256(\n [\"codex-security-csv-import/v1\", VERSION, source].join(\"\\0\"),\n ).slice(0, 24)}`;\n const findings = bindImportedFindings(\n rows.map(csvRowFinding),\n \"csv\",\n scanId,\n CSV_TARGET_ID,\n );\n const timestamp = \"1970-01-01T00:00:00.000Z\";\n const findingsDocument = JSON.stringify({\n documentType: \"codex-security.findings\",\n schemaVersion: \"1.0\",\n scanId,\n findings,\n });\n const scan: ScanManifest[\"scan\"] = {\n id: scanId,\n producer: { name: \"codex-security-cli\", version: VERSION },\n status: \"completed\",\n startedAt: timestamp,\n completedAt: timestamp,\n sealedAt: timestamp,\n target: {\n kind: \"directory_snapshot\",\n targetId: CSV_TARGET_ID,\n displayName: \"findings.csv\",\n snapshotDigest: `codex-security-snapshot/v1:sha256:${digest}`,\n },\n scope: {\n includePaths: [\".\"],\n excludePaths: [],\n summary: \"Findings imported from a Codex Security CSV export.\",\n },\n mode: \"repository\",\n review: { excludedPaths: [] },\n findingsRef: \"findings.json\",\n artifacts: [\n {\n path: \"findings.json\",\n sha256: sha256(findingsDocument),\n mediaType: \"application/json\",\n },\n {\n path: \"findings.csv\",\n sha256: digest,\n mediaType: \"text/csv\",\n },\n ],\n };\n return publishCloudPayload(scan, findings, dependencies);\n}\n\nasync function publishCloudPayload(\n scan: ScanManifest[\"scan\"],\n findings: Finding[],\n dependencies: CloudPublicationDependencies,\n): Promise<CloudPublicationResult> {\n dependencies.signal?.throwIfAborted();\n if (dependencies.dryRun) {\n return {\n scanId: scan.id,\n findingIds: [],\n findingCount: findings.length,\n dryRun: true,\n findings,\n };\n }\n const environment = dependencies.environment ?? process.env;\n const publishUrl =\n environment[\"CODEX_SECURITY_CLOUD_PUBLISH_URL\"]?.trim() ||\n `${cloudBaseUrl(environment)}/cli/findings`;\n const credentials = await readCloudCredentials(environment);\n const timeout = AbortSignal.timeout(30_000);\n const signal = dependencies.signal\n ? AbortSignal.any([dependencies.signal, timeout])\n : timeout;\n let response: Response;\n try {\n response = await (dependencies.fetch ?? globalThis.fetch)(publishUrl, {\n method: \"POST\",\n headers: {\n Authorization: `Bearer ${credentials.access_token}`,\n \"ChatGPT-Account-ID\": credentials.account_id,\n \"Content-Type\": \"application/json\",\n Accept: \"application/json\",\n },\n body: JSON.stringify({\n schemaVersion: \"1.0\",\n scan,\n findings,\n }),\n redirect: \"error\",\n signal,\n });\n } catch {\n dependencies.signal?.throwIfAborted();\n // A lost response does not establish whether the server accepted the POST.\n throw new CodexSecurityError(\n \"Cloud publication was not confirmed. The request was not retried; check whether it was accepted before submitting again.\",\n );\n }\n if (!response.ok) {\n await response.body?.cancel().catch(() => undefined);\n const detail =\n response.status === 401\n ? \"Sign in with ChatGPT again before retrying.\"\n : response.status === 403\n ? \"The signed-in account is not authorized to publish to Cloud.\"\n : response.status === 404\n ? \"Cloud publication is not available for this account or deployment.\"\n : \"The request was not retried.\";\n throw new CodexSecurityError(\n `Cloud publication failed (HTTP ${response.status}). ${detail}`,\n );\n }\n const receipt = receiptSchema.safeParse(\n await response.json().catch(() => {\n dependencies.signal?.throwIfAborted();\n return undefined;\n }),\n );\n // Cloud assigns opaque IDs in request order, so they cannot be compared to\n // local finding IDs. The authenticated response must still preserve the\n // submitted count and return one distinct observation for each finding.\n if (\n (response.status !== 200 && response.status !== 201) ||\n !receipt.success ||\n receipt.data.finding_count !== findings.length ||\n receipt.data.finding_ids.length !== findings.length ||\n new Set(receipt.data.finding_ids).size !== receipt.data.finding_ids.length\n ) {\n throw new CodexSecurityError(\n \"Cloud publication returned an invalid acceptance receipt. Check whether the request was accepted before submitting again.\",\n );\n }\n return {\n scanId: scan.id,\n findingIds: receipt.data.finding_ids,\n findingCount: receipt.data.finding_count,\n };\n}\n\n/** @internal Shared sign-in for local Cloud publishers. */\nexport async function readCloudCredentials(environment: NodeJS.ProcessEnv) {\n const configuredHome = environment[\"CODEX_HOME\"];\n let home = expandHome(\n configuredHome?.trim() ? configuredHome : \"~/.codex\",\n environment,\n );\n let requireFileStorage = true;\n const dedicatedHome = codexSecurityCredentialHome(environment);\n if (existsSync(dedicatedHome)) {\n if (!(await codexSecurityCredentialAllowsAmbientImport(dedicatedHome))) {\n throw new AuthenticationRequiredError(CHATGPT_LOGIN_REQUIRED);\n }\n if (await codexSecurityHasStoredFileCredentials(dedicatedHome)) {\n home = dedicatedHome;\n requireFileStorage = false;\n } else if (existsSync(join(dedicatedHome, \"config.toml\"))) {\n // Do not silently switch accounts when the dedicated login may be in a keyring.\n throw new AuthenticationRequiredError(CHATGPT_LOGIN_REQUIRED);\n }\n }\n if (requireFileStorage) {\n let credentialStorage: unknown;\n try {\n credentialStorage = parseToml(\n await readFile(join(home, \"config.toml\"), \"utf8\"),\n )[\"cli_auth_credentials_store\"];\n } catch {\n throw new AuthenticationRequiredError(CHATGPT_LOGIN_REQUIRED);\n }\n // File presence is not proof that it is the active ambient login:\n // automatic or keyring storage can leave auth.json for another account.\n if (credentialStorage !== \"file\") {\n throw new AuthenticationRequiredError(CHATGPT_LOGIN_REQUIRED);\n }\n }\n try {\n const credentials = credentialsSchema.safeParse(\n JSON.parse(await readFile(join(home, \"auth.json\"), \"utf8\")),\n );\n if (credentials.success) return credentials.data.tokens;\n } catch {\n // Parsing and filesystem diagnostics must not reflect credential contents.\n }\n throw new AuthenticationRequiredError(CHATGPT_LOGIN_REQUIRED);\n}\n"]}
|
package/dist/contract.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { type BigIntStats, type Stats } from "node:fs";
|
|
2
2
|
import { type FileHandle } from "node:fs/promises";
|
|
3
3
|
import { ContractValidationError } from "./errors.js";
|
|
4
|
-
import type {
|
|
4
|
+
import type { Finding, FindingsDocument, ScanManifest } from "./models.js";
|
|
5
5
|
import type { NormalizedTarget, ScanMode } from "./targets.js";
|
|
6
6
|
export interface ScanExpectation {
|
|
7
7
|
repository: string;
|
|
@@ -11,10 +11,12 @@ export interface ScanExpectation {
|
|
|
11
11
|
pluginVersion: string;
|
|
12
12
|
}
|
|
13
13
|
export interface LoadedContract {
|
|
14
|
+
mode: NonNullable<ScanManifest["scan"]["mode"]>;
|
|
14
15
|
manifest: ScanManifest;
|
|
15
16
|
findings: FindingsDocument;
|
|
16
|
-
|
|
17
|
+
review: NonNullable<ScanManifest["scan"]["review"]>;
|
|
17
18
|
}
|
|
19
|
+
export declare const validatedFileDigests: WeakMap<ScanManifest, ReadonlyMap<string, string>>;
|
|
18
20
|
export declare class ContractSchemaError extends ContractValidationError {
|
|
19
21
|
}
|
|
20
22
|
export declare const SEALED_DEFERRED_PATH_RULE = "invalidSealedDeferredPath";
|
package/dist/contract.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAGA,OAAO,EAAa,KAAK,WAAW,EAAE,KAAK,KAAK,EAAE,MAAM,SAAS,CAAC;AAClE,OAAO,EAKL,KAAK,UAAU,EAChB,MAAM,kBAAkB,CAAC;AAI1B,OAAO,EACL,uBAAuB,EAGxB,MAAM,aAAa,CAAC;AAErB,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAGA,OAAO,EAAa,KAAK,WAAW,EAAE,KAAK,KAAK,EAAE,MAAM,SAAS,CAAC;AAClE,OAAO,EAKL,KAAK,UAAU,EAChB,MAAM,kBAAkB,CAAC;AAI1B,OAAO,EACL,uBAAuB,EAGxB,MAAM,aAAa,CAAC;AAErB,OAAO,KAAK,EAEV,OAAO,EACP,gBAAgB,EAChB,YAAY,EACb,MAAM,aAAa,CAAC;AAKrB,OAAO,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAqB/D,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,MAAM,EAAE,gBAAgB,CAAC;IACzB,IAAI,EAAE,QAAQ,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IAChD,QAAQ,EAAE,YAAY,CAAC;IACvB,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,MAAM,EAAE,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;CACrD;AAGD,eAAO,MAAM,oBAAoB,oDAG9B,CAAC;AAEJ,qBAAa,mBAAoB,SAAQ,uBAAuB;CAAG;AAEnE,eAAO,MAAM,yBAAyB,8BAA8B,CAAC;AACrE,eAAO,MAAM,sBAAsB,QAAuC,CAAC;AAE3E,KAAK,mBAAmB,GAAG;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF,wBAAsB,YAAY,CAChC,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,cAAc,CAAC,CAEzB;AAED,wBAAsB,6BAA6B,CACjD,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC;IAAE,QAAQ,EAAE,cAAc,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,CAAC,CA+H9D;AAeD,yEAAyE;AACzE,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAE7D;AAsLD,wBAAsB,eAAe,CACnC,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,MAAM,CAAC,CAIjB;AAED,wBAAsB,YAAY,CAChC,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,MAAM,CAAC,CAYjB;AAsXD,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAInD;AA0PD,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,UAAU,EAChB,OAAO,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,GAAG,WAAW,EAAE,KAAK,GAAG,KAAK,CAAC,CAAA;CAAE,EAC7E,MAAM,EAAE,IAAI,CAAC,KAAK,GAAG,WAAW,EAAE,KAAK,GAAG,KAAK,CAAC,EAChD,QAAQ,GAAE,MAAM,CAAC,QAA2B,EAC5C,aAAa,GAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,UAAU,CAAQ,GACzE,OAAO,CAAC,OAAO,CAAC,CA+BlB;AA2DD,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC;;;;;;;;;;QAiBzB,SAAS,EAAE,mBAAmB;QAC9B,OAAO;;EAGZ"}
|
package/dist/contract.js
CHANGED
|
@@ -17,6 +17,8 @@ const DOCUMENTS = {
|
|
|
17
17
|
"coverage.json": "coverage.schema.json",
|
|
18
18
|
};
|
|
19
19
|
const PRODUCER_NAME = "codex-security-plugin";
|
|
20
|
+
// Hosted receipts compare reread files with the bytes that passed validation.
|
|
21
|
+
export const validatedFileDigests = new WeakMap();
|
|
20
22
|
export class ContractSchemaError extends ContractValidationError {
|
|
21
23
|
}
|
|
22
24
|
export const SEALED_DEFERRED_PATH_RULE = "invalidSealedDeferredPath";
|
|
@@ -28,13 +30,19 @@ export async function loadContractWithScanDirectory(scanDirectory, options) {
|
|
|
28
30
|
const validators = await loadContractValidators(options.pluginRoot, options.signal);
|
|
29
31
|
const scanRoot = await requireScanRoot(scanDirectory, options.signal);
|
|
30
32
|
const scanDir = scanRoot.path;
|
|
31
|
-
const
|
|
33
|
+
const fileDigests = new Map();
|
|
32
34
|
const payloads = {};
|
|
33
|
-
|
|
34
|
-
|
|
35
|
+
payloads["scan-manifest.json"] = await readScanJson(scanDir, "scan-manifest.json", fileDigests, options.signal, scanRoot);
|
|
36
|
+
const rawManifest = payloads["scan-manifest.json"];
|
|
37
|
+
const documents = validators.filter(({ filename }) => filename !== "coverage.json" ||
|
|
38
|
+
rawManifest.scan?.coverageRef !== undefined);
|
|
39
|
+
for (const { filename } of documents) {
|
|
40
|
+
if (filename === "scan-manifest.json")
|
|
41
|
+
continue;
|
|
42
|
+
payloads[filename] = await readScanJson(scanDir, filename, fileDigests, options.signal, scanRoot);
|
|
35
43
|
}
|
|
36
44
|
throwIfAborted(options.signal);
|
|
37
|
-
for (const { filename, schemaName, validate } of
|
|
45
|
+
for (const { filename, schemaName, validate } of documents) {
|
|
38
46
|
let payload;
|
|
39
47
|
let valid;
|
|
40
48
|
try {
|
|
@@ -64,28 +72,37 @@ export async function loadContractWithScanDirectory(scanDirectory, options) {
|
|
|
64
72
|
const manifest = payloads["scan-manifest.json"];
|
|
65
73
|
const findings = payloads["findings.json"];
|
|
66
74
|
const coverage = payloads["coverage.json"];
|
|
75
|
+
const mode = coverage?.mode ?? manifest.scan.mode;
|
|
76
|
+
const review = coverage
|
|
77
|
+
? {
|
|
78
|
+
excludedPaths: coverage.explicitExclusions.map((item) => item.pattern),
|
|
79
|
+
}
|
|
80
|
+
: manifest.scan.review;
|
|
67
81
|
if (options.expectedScanId !== undefined &&
|
|
68
82
|
manifest.scan.id !== options.expectedScanId) {
|
|
69
83
|
throw new ContractValidationError(`Scan artifacts do not match selected scan ${options.expectedScanId}.`);
|
|
70
84
|
}
|
|
71
85
|
if (findings.scanId !== manifest.scan.id ||
|
|
72
|
-
coverage.scanId !== manifest.scan.id) {
|
|
86
|
+
(coverage !== undefined && coverage.scanId !== manifest.scan.id)) {
|
|
73
87
|
throw new ContractValidationError("Canonical contract scan IDs do not match.");
|
|
74
88
|
}
|
|
75
|
-
if (
|
|
89
|
+
if (coverage !== undefined &&
|
|
90
|
+
!sameArray(coverage.includePaths, manifest.scan.scope.includePaths)) {
|
|
76
91
|
throw new ContractValidationError("Coverage include paths do not match the manifest scope.");
|
|
77
92
|
}
|
|
78
|
-
if (
|
|
93
|
+
if (coverage !== undefined &&
|
|
94
|
+
!sameArray(coverage.excludePaths, manifest.scan.scope.excludePaths)) {
|
|
79
95
|
throw new ContractValidationError("Coverage exclude paths do not match the manifest scope.");
|
|
80
96
|
}
|
|
81
97
|
validateCanonicalContract(manifest, findings, coverage);
|
|
82
|
-
await validateSeal(scanDir, manifest, findings, coverage,
|
|
98
|
+
await validateSeal(scanDir, manifest, findings, coverage, fileDigests, options.signal, scanRoot);
|
|
83
99
|
if (options.expectation !== undefined) {
|
|
84
|
-
validateExpectation(manifest,
|
|
100
|
+
validateExpectation(manifest, mode, options.expectation, options.workbenchValidated === true);
|
|
85
101
|
}
|
|
86
102
|
await verifyScanRoot(scanRoot, options.signal);
|
|
103
|
+
validatedFileDigests.set(manifest, fileDigests);
|
|
87
104
|
return {
|
|
88
|
-
contract: { manifest, findings,
|
|
105
|
+
contract: { manifest, findings, review, mode },
|
|
89
106
|
scanDirectory: scanRoot.path,
|
|
90
107
|
};
|
|
91
108
|
}
|
|
@@ -125,9 +142,9 @@ function validateCanonicalContract(manifest, findings, coverage) {
|
|
|
125
142
|
: undefined,
|
|
126
143
|
"manifest.scan.producer.name": manifest.scan.producer.name,
|
|
127
144
|
"manifest.scan.producer.version": manifest.scan.producer.version,
|
|
128
|
-
"coverage.inventoryStrategy": coverage
|
|
145
|
+
"coverage.inventoryStrategy": coverage?.inventoryStrategy,
|
|
129
146
|
});
|
|
130
|
-
for (const [index, surface] of coverage
|
|
147
|
+
for (const [index, surface] of (coverage?.surfaces ?? []).entries())
|
|
131
148
|
requireText({
|
|
132
149
|
[`coverage.surfaces[${index}].id`]: surface.id,
|
|
133
150
|
[`coverage.surfaces[${index}].label`]: surface.label,
|
|
@@ -170,7 +187,7 @@ function validateCanonicalContract(manifest, findings, coverage) {
|
|
|
170
187
|
}
|
|
171
188
|
}
|
|
172
189
|
}
|
|
173
|
-
for (const [index, deferred] of coverage
|
|
190
|
+
for (const [index, deferred] of (coverage?.deferred ?? []).entries()) {
|
|
174
191
|
for (const [pathIndex, path] of (deferred.paths ?? []).entries()) {
|
|
175
192
|
const context = `coverage.deferred[${index}].paths[${pathIndex}]`;
|
|
176
193
|
try {
|
|
@@ -292,7 +309,7 @@ async function requireCheckedScanFile(scanDirectory, relativePath, context, sign
|
|
|
292
309
|
});
|
|
293
310
|
}
|
|
294
311
|
}
|
|
295
|
-
async function validateSeal(scanDir, manifest, findings, coverage,
|
|
312
|
+
async function validateSeal(scanDir, manifest, findings, coverage, fileDigests, signal, expectedRoot) {
|
|
296
313
|
const scan = manifest.scan;
|
|
297
314
|
if (scan.sealedAt !== scan.completedAt) {
|
|
298
315
|
throw new ContractValidationError("Manifest sealedAt must match completedAt.");
|
|
@@ -309,11 +326,12 @@ async function validateSeal(scanDir, manifest, findings, coverage, documentDiges
|
|
|
309
326
|
}
|
|
310
327
|
artifactPaths.add(normalized);
|
|
311
328
|
artifactCollisionKeys.add(collisionKey);
|
|
312
|
-
const digest =
|
|
329
|
+
const digest = fileDigests.get(normalized) ??
|
|
313
330
|
(await sha256ScanFile(scanDir, normalized, context, signal, expectedRoot));
|
|
314
331
|
if (digest !== artifact.sha256) {
|
|
315
332
|
throw new ContractValidationError(`${context}: sealed artifact changed or is missing.`);
|
|
316
333
|
}
|
|
334
|
+
fileDigests.set(artifact.path, digest);
|
|
317
335
|
}
|
|
318
336
|
const requireSealedReference = (reference, context) => {
|
|
319
337
|
throwIfAborted(signal);
|
|
@@ -328,7 +346,7 @@ async function validateSeal(scanDir, manifest, findings, coverage, documentDiges
|
|
|
328
346
|
throw new ContractValidationError(`${context} is missing from sealed artifacts: ${reference}`);
|
|
329
347
|
}
|
|
330
348
|
};
|
|
331
|
-
for (const surface of coverage
|
|
349
|
+
for (const surface of coverage?.surfaces ?? []) {
|
|
332
350
|
for (const receipt of surface.receiptRefs) {
|
|
333
351
|
requireSealedReference(receipt, "Coverage receipt");
|
|
334
352
|
}
|
|
@@ -351,7 +369,7 @@ async function validateSeal(scanDir, manifest, findings, coverage, documentDiges
|
|
|
351
369
|
await file.close();
|
|
352
370
|
}
|
|
353
371
|
}
|
|
354
|
-
function validateExpectation(manifest,
|
|
372
|
+
function validateExpectation(manifest, mode, expectation, workbenchValidated = false) {
|
|
355
373
|
const scan = manifest.scan;
|
|
356
374
|
if (scan.producer.name !== PRODUCER_NAME) {
|
|
357
375
|
throw new ContractValidationError(`Manifest producer must be ${PRODUCER_NAME}, got ${scan.producer.name}.`);
|
|
@@ -360,8 +378,8 @@ function validateExpectation(manifest, coverage, expectation, workbenchValidated
|
|
|
360
378
|
throw new ContractValidationError("Manifest producer version does not match the installed Codex Security plugin.");
|
|
361
379
|
}
|
|
362
380
|
const expectedMode = expectedCoverageMode(expectation.target, expectation.mode);
|
|
363
|
-
if (
|
|
364
|
-
throw new ContractValidationError(`Coverage mode must be ${expectedMode}, got ${
|
|
381
|
+
if (mode !== expectedMode) {
|
|
382
|
+
throw new ContractValidationError(`Coverage mode must be ${expectedMode}, got ${mode}.`);
|
|
365
383
|
}
|
|
366
384
|
const requested = expectation.target;
|
|
367
385
|
if (!workbenchValidated) {
|
|
@@ -495,11 +513,11 @@ export function safeScopePath(value) {
|
|
|
495
513
|
? value
|
|
496
514
|
: safeRelativePath(value, "manifest scope include path");
|
|
497
515
|
}
|
|
498
|
-
async function readScanJson(scanDir, relativePath,
|
|
516
|
+
async function readScanJson(scanDir, relativePath, fileDigests, signal, expectedRoot) {
|
|
499
517
|
const file = await openCheckedScanFile(scanDir, relativePath, relativePath, signal, expectedRoot);
|
|
500
518
|
try {
|
|
501
519
|
const bytes = await file.readFile({ signal });
|
|
502
|
-
|
|
520
|
+
fileDigests.set(relativePath, hash("sha256", bytes));
|
|
503
521
|
return parseJson(join(scanDir, relativePath), bytes);
|
|
504
522
|
}
|
|
505
523
|
catch (error) {
|