@openai/codex-security 0.1.20 → 0.1.23

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.
Files changed (187) hide show
  1. package/README.md +1101 -865
  2. package/_bundled_plugin/.codex-plugin/plugin.json +1 -1
  3. package/_bundled_plugin/mcp/server.mjs.br.part-000 +0 -0
  4. package/_bundled_plugin/mcp/server.mjs.br.part-001 +0 -0
  5. package/_bundled_plugin/references/config-preflight.md +2 -30
  6. package/_bundled_plugin/references/core-scan.md +1 -1
  7. package/_bundled_plugin/references/final-report.md +1 -1
  8. package/_bundled_plugin/references/finding-detail-fields.md +5 -10
  9. package/_bundled_plugin/references/sarif-adapter.md +1 -1
  10. package/_bundled_plugin/schemas/patch-risk-assessment.schema.json +243 -0
  11. package/_bundled_plugin/scripts/config_preflight.py +2 -8
  12. package/_bundled_plugin/scripts/finalize_scan_contract.py +206 -35
  13. package/_bundled_plugin/scripts/finding_preview.py +22 -4
  14. package/_bundled_plugin/scripts/generate_in_scope_files.py +27 -1
  15. package/_bundled_plugin/scripts/launch_codex_security_mcp +0 -0
  16. package/_bundled_plugin/scripts/windows_scan_local_files.py +101 -7
  17. package/_bundled_plugin/scripts/workbench_cli.py +21 -1
  18. package/_bundled_plugin/scripts/workbench_dashboard.py +115 -0
  19. package/_bundled_plugin/scripts/workbench_db.py +29 -2
  20. package/_bundled_plugin/scripts/workbench_finding_index.py +42 -24
  21. package/_bundled_plugin/scripts/workbench_finding_workflows.py +190 -0
  22. package/_bundled_plugin/scripts/workbench_findings.py +216 -0
  23. package/_bundled_plugin/scripts/workbench_saved_results.py +30 -5
  24. package/_bundled_plugin/scripts/workbench_schema.py +263 -58
  25. package/_bundled_plugin/scripts/workbench_target.py +22 -3
  26. package/_bundled_plugin/skills/assess-patch-risk/SKILL.md +88 -0
  27. package/_bundled_plugin/skills/assess-patch-risk/agents/openai.yaml +4 -0
  28. package/_bundled_plugin/skills/assess-patch-risk/references/risk-rubric.md +76 -0
  29. package/_bundled_plugin/skills/assess-patch-risk/scripts/validate_patch_risk_assessment.py +163 -0
  30. package/_bundled_plugin/skills/fix-finding/SKILL.md +16 -48
  31. package/_bundled_plugin/skills/track-findings/SKILL.md +2 -0
  32. package/dist/api.d.ts +3 -1
  33. package/dist/api.d.ts.map +1 -1
  34. package/dist/api.js +129 -45
  35. package/dist/api.js.map +1 -1
  36. package/dist/bulk-scan-discovery.d.ts.map +1 -1
  37. package/dist/bulk-scan-discovery.js +6 -24
  38. package/dist/bulk-scan-discovery.js.map +1 -1
  39. package/dist/cli.d.ts +28 -2
  40. package/dist/cli.d.ts.map +1 -1
  41. package/dist/cli.js +525 -96
  42. package/dist/cli.js.map +1 -1
  43. package/dist/cloud-publish.d.ts +5 -1
  44. package/dist/cloud-publish.d.ts.map +1 -1
  45. package/dist/cloud-publish.js +312 -10
  46. package/dist/cloud-publish.js.map +1 -1
  47. package/dist/component-plan.d.ts.map +1 -1
  48. package/dist/component-plan.js +5 -1
  49. package/dist/component-plan.js.map +1 -1
  50. package/dist/contract.d.ts +1 -0
  51. package/dist/contract.d.ts.map +1 -1
  52. package/dist/contract.js +9 -0
  53. package/dist/contract.js.map +1 -1
  54. package/dist/custom-publish.d.ts +22 -0
  55. package/dist/custom-publish.d.ts.map +1 -0
  56. package/dist/custom-publish.js +47 -0
  57. package/dist/custom-publish.js.map +1 -0
  58. package/dist/custom-validation-prompt.js +1 -1
  59. package/dist/custom-validation-prompt.js.map +1 -1
  60. package/dist/deduplication/checkpointed-review.d.ts +16 -0
  61. package/dist/deduplication/checkpointed-review.d.ts.map +1 -0
  62. package/dist/deduplication/checkpointed-review.js +76 -0
  63. package/dist/deduplication/checkpointed-review.js.map +1 -0
  64. package/dist/deduplication/codex-review.d.ts +21 -0
  65. package/dist/deduplication/codex-review.d.ts.map +1 -0
  66. package/dist/deduplication/codex-review.js +252 -0
  67. package/dist/deduplication/codex-review.js.map +1 -0
  68. package/dist/deduplication/deduplication-prompts.d.ts +8 -0
  69. package/dist/deduplication/deduplication-prompts.d.ts.map +1 -0
  70. package/dist/deduplication/deduplication-prompts.js +35 -0
  71. package/dist/deduplication/deduplication-prompts.js.map +1 -0
  72. package/dist/deduplication/deduplication-reviewer.d.ts +46 -0
  73. package/dist/deduplication/deduplication-reviewer.d.ts.map +1 -0
  74. package/dist/deduplication/deduplication-reviewer.js +105 -0
  75. package/dist/deduplication/deduplication-reviewer.js.map +1 -0
  76. package/dist/deduplication/deduplication.d.ts +6 -0
  77. package/dist/deduplication/deduplication.d.ts.map +1 -0
  78. package/dist/deduplication/deduplication.js +85 -0
  79. package/dist/deduplication/deduplication.js.map +1 -0
  80. package/dist/deduplication/scan.d.ts +16 -0
  81. package/dist/deduplication/scan.d.ts.map +1 -0
  82. package/dist/deduplication/scan.js +101 -0
  83. package/dist/deduplication/scan.js.map +1 -0
  84. package/dist/finding-dedupe-groups.d.ts +7 -0
  85. package/dist/finding-dedupe-groups.d.ts.map +1 -0
  86. package/dist/finding-dedupe-groups.js +2 -0
  87. package/dist/finding-dedupe-groups.js.map +1 -0
  88. package/dist/finding-retrieval.d.ts +13 -0
  89. package/dist/finding-retrieval.d.ts.map +1 -0
  90. package/dist/finding-retrieval.js +2 -0
  91. package/dist/finding-retrieval.js.map +1 -0
  92. package/dist/finding-workflow.d.ts +53 -0
  93. package/dist/finding-workflow.d.ts.map +1 -0
  94. package/dist/finding-workflow.js +117 -0
  95. package/dist/finding-workflow.js.map +1 -0
  96. package/dist/findings-client.d.ts +15 -0
  97. package/dist/findings-client.d.ts.map +1 -0
  98. package/dist/findings-client.js +60 -0
  99. package/dist/findings-client.js.map +1 -0
  100. package/dist/github.d.ts +161 -0
  101. package/dist/github.d.ts.map +1 -0
  102. package/dist/github.js +158 -0
  103. package/dist/github.js.map +1 -0
  104. package/dist/index.d.ts +6 -0
  105. package/dist/index.d.ts.map +1 -1
  106. package/dist/index.js +3 -0
  107. package/dist/index.js.map +1 -1
  108. package/dist/publication.js +28 -40
  109. package/dist/publication.js.map +1 -1
  110. package/dist/publish.d.ts +10 -0
  111. package/dist/publish.d.ts.map +1 -1
  112. package/dist/publish.js +29 -5
  113. package/dist/publish.js.map +1 -1
  114. package/dist/runtime.d.ts +5 -4
  115. package/dist/runtime.d.ts.map +1 -1
  116. package/dist/runtime.js +371 -197
  117. package/dist/runtime.js.map +1 -1
  118. package/dist/saved-scan.d.ts +15 -0
  119. package/dist/saved-scan.d.ts.map +1 -0
  120. package/dist/saved-scan.js +68 -0
  121. package/dist/saved-scan.js.map +1 -0
  122. package/dist/scan-comparison.d.ts +6 -2
  123. package/dist/scan-comparison.d.ts.map +1 -1
  124. package/dist/scan-comparison.js +7 -2
  125. package/dist/scan-comparison.js.map +1 -1
  126. package/dist/server/dashboard/THIRD_PARTY_NOTICES.txt +276 -0
  127. package/dist/server/dashboard/app.css +2 -0
  128. package/dist/server/dashboard/app.js +66 -0
  129. package/dist/server/dashboard/index.html +18 -0
  130. package/dist/server/dashboard-types.d.ts +45 -0
  131. package/dist/server/dashboard-types.d.ts.map +1 -0
  132. package/dist/server/dashboard-types.js +2 -0
  133. package/dist/server/dashboard-types.js.map +1 -0
  134. package/dist/server/dashboard.d.ts +6 -0
  135. package/dist/server/dashboard.d.ts.map +1 -0
  136. package/dist/server/dashboard.js +45 -0
  137. package/dist/server/dashboard.js.map +1 -0
  138. package/dist/server/embeddings.d.ts +16 -0
  139. package/dist/server/embeddings.d.ts.map +1 -0
  140. package/dist/server/embeddings.js +114 -0
  141. package/dist/server/embeddings.js.map +1 -0
  142. package/dist/server/errors.d.ts +5 -0
  143. package/dist/server/errors.d.ts.map +1 -0
  144. package/dist/server/errors.js +8 -0
  145. package/dist/server/errors.js.map +1 -0
  146. package/dist/server/findings-service.d.ts +20 -0
  147. package/dist/server/findings-service.d.ts.map +1 -0
  148. package/dist/server/findings-service.js +31 -0
  149. package/dist/server/findings-service.js.map +1 -0
  150. package/dist/server/index.d.ts +2 -0
  151. package/dist/server/index.d.ts.map +1 -0
  152. package/dist/server/index.js +32 -0
  153. package/dist/server/index.js.map +1 -0
  154. package/dist/server/routes.d.ts +6 -0
  155. package/dist/server/routes.d.ts.map +1 -0
  156. package/dist/server/routes.js +86 -0
  157. package/dist/server/routes.js.map +1 -0
  158. package/dist/server/server.d.ts +10 -0
  159. package/dist/server/server.d.ts.map +1 -0
  160. package/dist/server/server.js +17 -0
  161. package/dist/server/server.js.map +1 -0
  162. package/dist/server/sqlite-store.d.ts +22 -0
  163. package/dist/server/sqlite-store.d.ts.map +1 -0
  164. package/dist/server/sqlite-store.js +82 -0
  165. package/dist/server/sqlite-store.js.map +1 -0
  166. package/dist/server/storage.d.ts +32 -0
  167. package/dist/server/storage.d.ts.map +1 -0
  168. package/dist/server/storage.js +2 -0
  169. package/dist/server/storage.js.map +1 -0
  170. package/dist/server/validation.d.ts +17 -0
  171. package/dist/server/validation.d.ts.map +1 -0
  172. package/dist/server/validation.js +53 -0
  173. package/dist/server/validation.js.map +1 -0
  174. package/dist/targets.d.ts.map +1 -1
  175. package/dist/targets.js +1 -0
  176. package/dist/targets.js.map +1 -1
  177. package/dist/thread-source.d.ts +8 -0
  178. package/dist/thread-source.d.ts.map +1 -0
  179. package/dist/thread-source.js +7 -0
  180. package/dist/thread-source.js.map +1 -0
  181. package/dist/trusted-executable.d.ts.map +1 -1
  182. package/dist/trusted-executable.js +2 -1
  183. package/dist/trusted-executable.js.map +1 -1
  184. package/dist/version.d.ts +1 -1
  185. package/dist/version.js +1 -1
  186. package/dist/version.js.map +1 -1
  187. package/package.json +23 -8
@@ -0,0 +1,161 @@
1
+ import { Octokit } from "@octokit/core";
2
+ type GitHubAlert = Awaited<ReturnType<typeof fetchGitHubAlert>>;
3
+ export declare const GITHUB_ALERT_STATES: readonly ["open", "closed", "dismissed", "fixed", "all"];
4
+ export interface GitHubCodeScanningImportOptions {
5
+ /** GitHub repository in OWNER/REPO form. */
6
+ repository: string;
7
+ /** Exact alert numbers, regardless of state. Omit to list matching alerts. */
8
+ alertNumbers?: readonly number[];
9
+ /** State used when listing alerts (default: open). */
10
+ state?: (typeof GITHUB_ALERT_STATES)[number];
11
+ /** Git reference to inspect; omitted lists the default branch. */
12
+ ref?: string;
13
+ /** Defaults to GH_HOST or github.com. */
14
+ githubHost?: string;
15
+ /** Omit to use the authenticated GitHub CLI, including its token environment. */
16
+ githubToken?: string;
17
+ signal?: AbortSignal;
18
+ }
19
+ export interface ImportedGitHubCodeScanningAlert {
20
+ source: "github-code-scanning";
21
+ repository: string;
22
+ number: number;
23
+ url: string;
24
+ /** Upstream evidence, not a validated or sealed Codex Security finding. */
25
+ alert: GitHubAlert;
26
+ }
27
+ interface GitHubImportDependencies {
28
+ environment?: NodeJS.ProcessEnv;
29
+ currentDirectory?: string;
30
+ createGitHub?: (host: string, signal?: AbortSignal) => Promise<Octokit>;
31
+ }
32
+ export declare function createAuthenticatedGitHub(host: string, options?: {
33
+ environment?: NodeJS.ProcessEnv;
34
+ currentDirectory?: string;
35
+ token?: string;
36
+ signal?: AbortSignal;
37
+ }): Promise<Octokit>;
38
+ export declare function importGitHubCodeScanningAlerts(options: GitHubCodeScanningImportOptions, dependencies?: GitHubImportDependencies): Promise<ImportedGitHubCodeScanningAlert[]>;
39
+ declare function fetchGitHubAlert(github: Octokit, owner: string, repo: string, alertNumber: number, signal?: AbortSignal): Promise<{
40
+ number: number;
41
+ created_at: string;
42
+ updated_at?: string;
43
+ url: string;
44
+ html_url: string;
45
+ instances_url: string;
46
+ state: "fixed" | "open" | "dismissed" | null;
47
+ fixed_at?: string | null;
48
+ dismissed_by: {
49
+ name?: string | null;
50
+ email?: string | null;
51
+ login: string;
52
+ id: number;
53
+ node_id: string;
54
+ avatar_url: string;
55
+ gravatar_id: string | null;
56
+ url: string;
57
+ html_url: string;
58
+ followers_url: string;
59
+ following_url: string;
60
+ gists_url: string;
61
+ starred_url: string;
62
+ subscriptions_url: string;
63
+ organizations_url: string;
64
+ repos_url: string;
65
+ events_url: string;
66
+ received_events_url: string;
67
+ type: string;
68
+ site_admin: boolean;
69
+ starred_at?: string;
70
+ user_view_type?: string;
71
+ } | null;
72
+ dismissed_at: string | null;
73
+ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
74
+ dismissed_comment?: string | null;
75
+ rule: {
76
+ id?: string | null;
77
+ name?: string;
78
+ severity?: "none" | "note" | "warning" | "error" | null;
79
+ security_severity_level?: "low" | "medium" | "high" | "critical" | null;
80
+ description?: string;
81
+ full_description?: string;
82
+ tags?: string[] | null;
83
+ help?: string | null;
84
+ help_uri?: string | null;
85
+ };
86
+ tool: {
87
+ name?: string;
88
+ version?: string | null;
89
+ guid?: string | null;
90
+ };
91
+ most_recent_instance: {
92
+ ref?: string;
93
+ analysis_key?: string;
94
+ environment?: string;
95
+ category?: string;
96
+ state?: "fixed" | "open" | "dismissed" | null;
97
+ commit_sha?: string;
98
+ message?: {
99
+ text?: string;
100
+ };
101
+ location?: {
102
+ path?: string;
103
+ start_line?: number;
104
+ end_line?: number;
105
+ start_column?: number;
106
+ end_column?: number;
107
+ };
108
+ html_url?: string;
109
+ classifications?: ("source" | "generated" | "test" | "library" | null)[];
110
+ };
111
+ dismissal_approved_by?: {
112
+ name?: string | null;
113
+ email?: string | null;
114
+ login: string;
115
+ id: number;
116
+ node_id: string;
117
+ avatar_url: string;
118
+ gravatar_id: string | null;
119
+ url: string;
120
+ html_url: string;
121
+ followers_url: string;
122
+ following_url: string;
123
+ gists_url: string;
124
+ starred_url: string;
125
+ subscriptions_url: string;
126
+ organizations_url: string;
127
+ repos_url: string;
128
+ events_url: string;
129
+ received_events_url: string;
130
+ type: string;
131
+ site_admin: boolean;
132
+ starred_at?: string;
133
+ user_view_type?: string;
134
+ } | null;
135
+ assignees?: {
136
+ name?: string | null;
137
+ email?: string | null;
138
+ login: string;
139
+ id: number;
140
+ node_id: string;
141
+ avatar_url: string;
142
+ gravatar_id: string | null;
143
+ url: string;
144
+ html_url: string;
145
+ followers_url: string;
146
+ following_url: string;
147
+ gists_url: string;
148
+ starred_url: string;
149
+ subscriptions_url: string;
150
+ organizations_url: string;
151
+ repos_url: string;
152
+ events_url: string;
153
+ received_events_url: string;
154
+ type: string;
155
+ site_admin: boolean;
156
+ starred_at?: string;
157
+ user_view_type?: string;
158
+ }[];
159
+ }>;
160
+ export {};
161
+ //# sourceMappingURL=github.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"github.d.ts","sourceRoot":"","sources":["../src/github.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAKxC,KAAK,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC,CAAC;AAEhE,eAAO,MAAM,mBAAmB,0DAMtB,CAAC;AAEX,MAAM,WAAW,+BAA+B;IAC9C,4CAA4C;IAC5C,UAAU,EAAE,MAAM,CAAC;IACnB,8EAA8E;IAC9E,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACjC,sDAAsD;IACtD,KAAK,CAAC,EAAE,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;IAC7C,kEAAkE;IAClE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iFAAiF;IACjF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,+BAA+B;IAC9C,MAAM,EAAE,sBAAsB,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,2EAA2E;IAC3E,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,UAAU,wBAAwB;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IAChC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CACzE;AAED,wBAAsB,yBAAyB,CAC7C,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE;IACP,WAAW,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IAChC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,WAAW,CAAC;CACjB,GACL,OAAO,CAAC,OAAO,CAAC,CAmClB;AAED,wBAAsB,8BAA8B,CAClD,OAAO,EAAE,+BAA+B,EACxC,YAAY,GAAE,wBAA6B,GAC1C,OAAO,CAAC,+BAA+B,EAAE,CAAC,CAyI5C;AAED,iBAAe,gBAAgB,CAC7B,MAAM,EAAE,OAAO,EACf,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EACnB,MAAM,CAAC,EAAE,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBAasvi1B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAD5wi1B"}
package/dist/github.js ADDED
@@ -0,0 +1,158 @@
1
+ import { execFile as execFileCallback } from "node:child_process";
2
+ import { promisify } from "node:util";
3
+ import { Octokit } from "@octokit/core";
4
+ import { CodexSecurityError } from "./errors.js";
5
+ import { resolveTrustedExecutable } from "./trusted-executable.js";
6
+ const execFile = promisify(execFileCallback);
7
+ export const GITHUB_ALERT_STATES = [
8
+ "open",
9
+ "closed",
10
+ "dismissed",
11
+ "fixed",
12
+ "all",
13
+ ];
14
+ export async function createAuthenticatedGitHub(host, options = {}) {
15
+ options.signal?.throwIfAborted();
16
+ let token = options.token;
17
+ if (token === undefined) {
18
+ const trusted = await resolveTrustedExecutable("gh", options.environment ?? process.env, options.currentDirectory ?? process.cwd());
19
+ if (trusted === null) {
20
+ throw new CodexSecurityError("GitHub CLI is required. Install gh and sign in first.");
21
+ }
22
+ try {
23
+ const { stdout } = await execFile(trusted.executable, ["auth", "token", "--hostname", host], { env: trusted.environment, signal: options.signal });
24
+ token = stdout.trim();
25
+ }
26
+ catch {
27
+ options.signal?.throwIfAborted();
28
+ throw new CodexSecurityError("GitHub sign-in is required. Run 'gh auth login' first.");
29
+ }
30
+ }
31
+ if (token.trim().length === 0) {
32
+ throw new CodexSecurityError("GitHub access token must not be empty.");
33
+ }
34
+ return new Octokit({
35
+ auth: token,
36
+ ...(host === "github.com" ? {} : { baseUrl: `https://${host}/api/v3` }),
37
+ });
38
+ }
39
+ export async function importGitHubCodeScanningAlerts(options, dependencies = {}) {
40
+ options.signal?.throwIfAborted();
41
+ const repository = options.repository.trim();
42
+ const parts = /^([a-z0-9_.-]+)\/([a-z0-9_.-]+)$/iu.exec(repository);
43
+ if (parts === null ||
44
+ parts.slice(1).some((part) => /^\.{1,2}$/u.test(part))) {
45
+ throw new CodexSecurityError("GitHub repository must be OWNER/REPO.");
46
+ }
47
+ const owner = parts[1];
48
+ const repo = parts[2];
49
+ const numbers = [...new Set(options.alertNumbers ?? [])];
50
+ if (numbers.some((number) => !Number.isSafeInteger(number) || number < 1)) {
51
+ throw new CodexSecurityError("GitHub alert numbers must be positive integers.");
52
+ }
53
+ const state = options.state ?? "open";
54
+ if (!GITHUB_ALERT_STATES.includes(state)) {
55
+ throw new CodexSecurityError("GitHub alert state is invalid.");
56
+ }
57
+ if (numbers.length > 0 && state !== "open") {
58
+ throw new CodexSecurityError("--github-state only filters lists; use it without --github-alert.");
59
+ }
60
+ const ref = options.ref?.trim();
61
+ if (ref === "") {
62
+ throw new CodexSecurityError("GitHub reference must not be empty.");
63
+ }
64
+ const environment = dependencies.environment ?? process.env;
65
+ const host = options.githubHost?.trim() ??
66
+ (environment["GH_HOST"]?.trim() || "github.com");
67
+ if (host.length === 0) {
68
+ throw new CodexSecurityError("GitHub host must not be empty.");
69
+ }
70
+ try {
71
+ const github = dependencies.createGitHub
72
+ ? await dependencies.createGitHub(host, options.signal)
73
+ : await createAuthenticatedGitHub(host, {
74
+ token: options.githubToken,
75
+ environment,
76
+ currentDirectory: dependencies.currentDirectory,
77
+ signal: options.signal,
78
+ });
79
+ const selected = new Map();
80
+ if (numbers.length === 0 || ref !== undefined) {
81
+ let page = 1;
82
+ while (true) {
83
+ options.signal?.throwIfAborted();
84
+ // Octokit's list route omits GitHub's "closed" state.
85
+ const response = await github.request({
86
+ method: "GET",
87
+ url: "/repos/{owner}/{repo}/code-scanning/alerts",
88
+ owner,
89
+ repo,
90
+ per_page: 100,
91
+ page,
92
+ ref,
93
+ state: numbers.length > 0 || state === "all" ? undefined : state,
94
+ request: { signal: options.signal, redirect: "error" },
95
+ });
96
+ for (const alert of response.data) {
97
+ if (numbers.length === 0 || numbers.includes(alert.number)) {
98
+ selected.set(alert.number, alert.most_recent_instance);
99
+ }
100
+ }
101
+ if (!response.headers.link?.includes('rel="next"') ||
102
+ (numbers.length > 0 && selected.size === numbers.length))
103
+ break;
104
+ page += 1;
105
+ }
106
+ if (numbers.some((number) => !selected.has(number))) {
107
+ throw new CodexSecurityError("One or more selected GitHub alerts were not found on the requested reference.");
108
+ }
109
+ }
110
+ const alerts = [];
111
+ for (const number of numbers.length > 0 ? numbers : selected.keys()) {
112
+ options.signal?.throwIfAborted();
113
+ const alert = await fetchGitHubAlert(github, owner, repo, number, options.signal);
114
+ // Detail requests use the default branch; retain the listed ref's evidence.
115
+ const instance = selected.get(number);
116
+ alerts.push({
117
+ source: "github-code-scanning",
118
+ repository,
119
+ number,
120
+ url: alert.html_url,
121
+ alert: instance === undefined
122
+ ? alert
123
+ : { ...alert, most_recent_instance: instance },
124
+ });
125
+ }
126
+ return alerts;
127
+ }
128
+ catch (error) {
129
+ options.signal?.throwIfAborted();
130
+ if (error instanceof CodexSecurityError)
131
+ throw error;
132
+ const status = typeof error === "object" && error !== null && "status" in error
133
+ ? error.status
134
+ : undefined;
135
+ if (status === 401)
136
+ throw new CodexSecurityError("GitHub authentication failed.");
137
+ if (status === 403) {
138
+ throw new CodexSecurityError("GitHub denied code scanning access. Check repository permissions, code scanning availability, and API rate limits.");
139
+ }
140
+ if (status === 404) {
141
+ throw new CodexSecurityError("GitHub repository or code scanning alert was not found or is not accessible.");
142
+ }
143
+ if (status === 429)
144
+ throw new CodexSecurityError("GitHub request was rate limited. Wait and retry.");
145
+ // Octokit errors can contain credential-bearing request headers.
146
+ throw new CodexSecurityError(`GitHub code scanning request failed${typeof status === "number" ? ` (HTTP ${status})` : ""}.`);
147
+ }
148
+ }
149
+ async function fetchGitHubAlert(github, owner, repo, alertNumber, signal) {
150
+ const response = await github.request("GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", {
151
+ owner,
152
+ repo,
153
+ alert_number: alertNumber,
154
+ request: { signal, redirect: "error" },
155
+ });
156
+ return response.data;
157
+ }
158
+ //# sourceMappingURL=github.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"github.js","sourceRoot":"","sources":["../src/github.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AAEnE,MAAM,QAAQ,GAAG,SAAS,CAAC,gBAAgB,CAAC,CAAC;AAG7C,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,MAAM;IACN,QAAQ;IACR,WAAW;IACX,OAAO;IACP,KAAK;CACG,CAAC;AAiCX,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,IAAY,EACZ,UAKI,EAAE;IAEN,OAAO,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;IACjC,IAAI,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;IAC1B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,OAAO,GAAG,MAAM,wBAAwB,CAC5C,IAAI,EACJ,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,EAClC,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,GAAG,EAAE,CAC1C,CAAC;QACF,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACrB,MAAM,IAAI,kBAAkB,CAC1B,uDAAuD,CACxD,CAAC;QACJ,CAAC;QACD,IAAI,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,QAAQ,CAC/B,OAAO,CAAC,UAAU,EAClB,CAAC,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,EACrC,EAAE,GAAG,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CACrD,CAAC;YACF,KAAK,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;QACxB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;YACjC,MAAM,IAAI,kBAAkB,CAC1B,wDAAwD,CACzD,CAAC;QACJ,CAAC;IACH,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,kBAAkB,CAAC,wCAAwC,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,IAAI,OAAO,CAAC;QACjB,IAAI,EAAE,KAAK;QACX,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,WAAW,IAAI,SAAS,EAAE,CAAC;KACxE,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,8BAA8B,CAClD,OAAwC,EACxC,eAAyC,EAAE;IAE3C,OAAO,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;IACjC,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;IAC7C,MAAM,KAAK,GAAG,oCAAoC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACpE,IACE,KAAK,KAAK,IAAI;QACd,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EACtD,CAAC;QACD,MAAM,IAAI,kBAAkB,CAAC,uCAAuC,CAAC,CAAC;IACxE,CAAC;IACD,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;IACxB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;IACvB,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC,CAAC;IACzD,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;QAC1E,MAAM,IAAI,kBAAkB,CAC1B,iDAAiD,CAClD,CAAC;IACJ,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,MAAM,CAAC;IACtC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,kBAAkB,CAAC,gCAAgC,CAAC,CAAC;IACjE,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;QAC3C,MAAM,IAAI,kBAAkB,CAC1B,mEAAmE,CACpE,CAAC;IACJ,CAAC;IACD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;IAChC,IAAI,GAAG,KAAK,EAAE,EAAE,CAAC;QACf,MAAM,IAAI,kBAAkB,CAAC,qCAAqC,CAAC,CAAC;IACtE,CAAC;IACD,MAAM,WAAW,GAAG,YAAY,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;IAC5D,MAAM,IAAI,GACR,OAAO,CAAC,UAAU,EAAE,IAAI,EAAE;QAC1B,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,IAAI,YAAY,CAAC,CAAC;IACnD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,kBAAkB,CAAC,gCAAgC,CAAC,CAAC;IACjE,CAAC;IAED,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,YAAY,CAAC,YAAY;YACtC,CAAC,CAAC,MAAM,YAAY,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC;YACvD,CAAC,CAAC,MAAM,yBAAyB,CAAC,IAAI,EAAE;gBACpC,KAAK,EAAE,OAAO,CAAC,WAAW;gBAC1B,WAAW;gBACX,gBAAgB,EAAE,YAAY,CAAC,gBAAgB;gBAC/C,MAAM,EAAE,OAAO,CAAC,MAAM;aACvB,CAAC,CAAC;QACP,MAAM,QAAQ,GAAG,IAAI,GAAG,EAA+C,CAAC;QACxE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YAC9C,IAAI,IAAI,GAAG,CAAC,CAAC;YACb,OAAO,IAAI,EAAE,CAAC;gBACZ,OAAO,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;gBACjC,sDAAsD;gBACtD,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAEnC;oBACA,MAAM,EAAE,KAAK;oBACb,GAAG,EAAE,4CAA4C;oBACjD,KAAK;oBACL,IAAI;oBACJ,QAAQ,EAAE,GAAG;oBACb,IAAI;oBACJ,GAAG;oBACH,KAAK,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK;oBAChE,OAAO,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE;iBACvD,CAAC,CAAC;gBACH,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;oBAClC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;wBAC3D,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;oBACzD,CAAC;gBACH,CAAC;gBACD,IACE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,YAAY,CAAC;oBAC9C,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC;oBAExD,MAAM;gBACR,IAAI,IAAI,CAAC,CAAC;YACZ,CAAC;YACD,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;gBACpD,MAAM,IAAI,kBAAkB,CAC1B,+EAA+E,CAChF,CAAC;YACJ,CAAC;QACH,CAAC;QACD,MAAM,MAAM,GAAsC,EAAE,CAAC;QACrD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;YACpE,OAAO,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;YACjC,MAAM,KAAK,GAAG,MAAM,gBAAgB,CAClC,MAAM,EACN,KAAK,EACL,IAAI,EACJ,MAAM,EACN,OAAO,CAAC,MAAM,CACf,CAAC;YACF,4EAA4E;YAC5E,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC;gBACV,MAAM,EAAE,sBAAsB;gBAC9B,UAAU;gBACV,MAAM;gBACN,GAAG,EAAE,KAAK,CAAC,QAAQ;gBACnB,KAAK,EACH,QAAQ,KAAK,SAAS;oBACpB,CAAC,CAAC,KAAK;oBACP,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,oBAAoB,EAAE,QAAQ,EAAE;aACnD,CAAC,CAAC;QACL,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;QACjC,IAAI,KAAK,YAAY,kBAAkB;YAAE,MAAM,KAAK,CAAC;QACrD,MAAM,MAAM,GACV,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,QAAQ,IAAI,KAAK;YAC9D,CAAC,CAAC,KAAK,CAAC,MAAM;YACd,CAAC,CAAC,SAAS,CAAC;QAChB,IAAI,MAAM,KAAK,GAAG;YAChB,MAAM,IAAI,kBAAkB,CAAC,+BAA+B,CAAC,CAAC;QAChE,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,MAAM,IAAI,kBAAkB,CAC1B,oHAAoH,CACrH,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,MAAM,IAAI,kBAAkB,CAC1B,8EAA8E,CAC/E,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,KAAK,GAAG;YAChB,MAAM,IAAI,kBAAkB,CAC1B,kDAAkD,CACnD,CAAC;QACJ,iEAAiE;QACjE,MAAM,IAAI,kBAAkB,CAC1B,sCAAsC,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAC/F,CAAC;IACJ,CAAC;AACH,CAAC;AAED,KAAK,UAAU,gBAAgB,CAC7B,MAAe,EACf,KAAa,EACb,IAAY,EACZ,WAAmB,EACnB,MAAoB;IAEpB,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CACnC,+DAA+D,EAC/D;QACE,KAAK;QACL,IAAI;QACJ,YAAY,EAAE,WAAW;QACzB,OAAO,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE;KACvC,CACF,CAAC;IACF,OAAO,QAAQ,CAAC,IAAI,CAAC;AACvB,CAAC","sourcesContent":["import { execFile as execFileCallback } from \"node:child_process\";\nimport { promisify } from \"node:util\";\nimport { Octokit } from \"@octokit/core\";\nimport { CodexSecurityError } from \"./errors.js\";\nimport { resolveTrustedExecutable } from \"./trusted-executable.js\";\n\nconst execFile = promisify(execFileCallback);\ntype GitHubAlert = Awaited<ReturnType<typeof fetchGitHubAlert>>;\n\nexport const GITHUB_ALERT_STATES = [\n \"open\",\n \"closed\",\n \"dismissed\",\n \"fixed\",\n \"all\",\n] as const;\n\nexport interface GitHubCodeScanningImportOptions {\n /** GitHub repository in OWNER/REPO form. */\n repository: string;\n /** Exact alert numbers, regardless of state. Omit to list matching alerts. */\n alertNumbers?: readonly number[];\n /** State used when listing alerts (default: open). */\n state?: (typeof GITHUB_ALERT_STATES)[number];\n /** Git reference to inspect; omitted lists the default branch. */\n ref?: string;\n /** Defaults to GH_HOST or github.com. */\n githubHost?: string;\n /** Omit to use the authenticated GitHub CLI, including its token environment. */\n githubToken?: string;\n signal?: AbortSignal;\n}\n\nexport interface ImportedGitHubCodeScanningAlert {\n source: \"github-code-scanning\";\n repository: string;\n number: number;\n url: string;\n /** Upstream evidence, not a validated or sealed Codex Security finding. */\n alert: GitHubAlert;\n}\n\ninterface GitHubImportDependencies {\n environment?: NodeJS.ProcessEnv;\n currentDirectory?: string;\n createGitHub?: (host: string, signal?: AbortSignal) => Promise<Octokit>;\n}\n\nexport async function createAuthenticatedGitHub(\n host: string,\n options: {\n environment?: NodeJS.ProcessEnv;\n currentDirectory?: string;\n token?: string;\n signal?: AbortSignal;\n } = {},\n): Promise<Octokit> {\n options.signal?.throwIfAborted();\n let token = options.token;\n if (token === undefined) {\n const trusted = await resolveTrustedExecutable(\n \"gh\",\n options.environment ?? process.env,\n options.currentDirectory ?? process.cwd(),\n );\n if (trusted === null) {\n throw new CodexSecurityError(\n \"GitHub CLI is required. Install gh and sign in first.\",\n );\n }\n try {\n const { stdout } = await execFile(\n trusted.executable,\n [\"auth\", \"token\", \"--hostname\", host],\n { env: trusted.environment, signal: options.signal },\n );\n token = stdout.trim();\n } catch {\n options.signal?.throwIfAborted();\n throw new CodexSecurityError(\n \"GitHub sign-in is required. Run 'gh auth login' first.\",\n );\n }\n }\n if (token.trim().length === 0) {\n throw new CodexSecurityError(\"GitHub access token must not be empty.\");\n }\n return new Octokit({\n auth: token,\n ...(host === \"github.com\" ? {} : { baseUrl: `https://${host}/api/v3` }),\n });\n}\n\nexport async function importGitHubCodeScanningAlerts(\n options: GitHubCodeScanningImportOptions,\n dependencies: GitHubImportDependencies = {},\n): Promise<ImportedGitHubCodeScanningAlert[]> {\n options.signal?.throwIfAborted();\n const repository = options.repository.trim();\n const parts = /^([a-z0-9_.-]+)\\/([a-z0-9_.-]+)$/iu.exec(repository);\n if (\n parts === null ||\n parts.slice(1).some((part) => /^\\.{1,2}$/u.test(part))\n ) {\n throw new CodexSecurityError(\"GitHub repository must be OWNER/REPO.\");\n }\n const owner = parts[1]!;\n const repo = parts[2]!;\n const numbers = [...new Set(options.alertNumbers ?? [])];\n if (numbers.some((number) => !Number.isSafeInteger(number) || number < 1)) {\n throw new CodexSecurityError(\n \"GitHub alert numbers must be positive integers.\",\n );\n }\n const state = options.state ?? \"open\";\n if (!GITHUB_ALERT_STATES.includes(state)) {\n throw new CodexSecurityError(\"GitHub alert state is invalid.\");\n }\n if (numbers.length > 0 && state !== \"open\") {\n throw new CodexSecurityError(\n \"--github-state only filters lists; use it without --github-alert.\",\n );\n }\n const ref = options.ref?.trim();\n if (ref === \"\") {\n throw new CodexSecurityError(\"GitHub reference must not be empty.\");\n }\n const environment = dependencies.environment ?? process.env;\n const host =\n options.githubHost?.trim() ??\n (environment[\"GH_HOST\"]?.trim() || \"github.com\");\n if (host.length === 0) {\n throw new CodexSecurityError(\"GitHub host must not be empty.\");\n }\n\n try {\n const github = dependencies.createGitHub\n ? await dependencies.createGitHub(host, options.signal)\n : await createAuthenticatedGitHub(host, {\n token: options.githubToken,\n environment,\n currentDirectory: dependencies.currentDirectory,\n signal: options.signal,\n });\n const selected = new Map<number, GitHubAlert[\"most_recent_instance\"]>();\n if (numbers.length === 0 || ref !== undefined) {\n let page = 1;\n while (true) {\n options.signal?.throwIfAborted();\n // Octokit's list route omits GitHub's \"closed\" state.\n const response = await github.request<\n Pick<GitHubAlert, \"number\" | \"most_recent_instance\">[]\n >({\n method: \"GET\",\n url: \"/repos/{owner}/{repo}/code-scanning/alerts\",\n owner,\n repo,\n per_page: 100,\n page,\n ref,\n state: numbers.length > 0 || state === \"all\" ? undefined : state,\n request: { signal: options.signal, redirect: \"error\" },\n });\n for (const alert of response.data) {\n if (numbers.length === 0 || numbers.includes(alert.number)) {\n selected.set(alert.number, alert.most_recent_instance);\n }\n }\n if (\n !response.headers.link?.includes('rel=\"next\"') ||\n (numbers.length > 0 && selected.size === numbers.length)\n )\n break;\n page += 1;\n }\n if (numbers.some((number) => !selected.has(number))) {\n throw new CodexSecurityError(\n \"One or more selected GitHub alerts were not found on the requested reference.\",\n );\n }\n }\n const alerts: ImportedGitHubCodeScanningAlert[] = [];\n for (const number of numbers.length > 0 ? numbers : selected.keys()) {\n options.signal?.throwIfAborted();\n const alert = await fetchGitHubAlert(\n github,\n owner,\n repo,\n number,\n options.signal,\n );\n // Detail requests use the default branch; retain the listed ref's evidence.\n const instance = selected.get(number);\n alerts.push({\n source: \"github-code-scanning\",\n repository,\n number,\n url: alert.html_url,\n alert:\n instance === undefined\n ? alert\n : { ...alert, most_recent_instance: instance },\n });\n }\n return alerts;\n } catch (error) {\n options.signal?.throwIfAborted();\n if (error instanceof CodexSecurityError) throw error;\n const status =\n typeof error === \"object\" && error !== null && \"status\" in error\n ? error.status\n : undefined;\n if (status === 401)\n throw new CodexSecurityError(\"GitHub authentication failed.\");\n if (status === 403) {\n throw new CodexSecurityError(\n \"GitHub denied code scanning access. Check repository permissions, code scanning availability, and API rate limits.\",\n );\n }\n if (status === 404) {\n throw new CodexSecurityError(\n \"GitHub repository or code scanning alert was not found or is not accessible.\",\n );\n }\n if (status === 429)\n throw new CodexSecurityError(\n \"GitHub request was rate limited. Wait and retry.\",\n );\n // Octokit errors can contain credential-bearing request headers.\n throw new CodexSecurityError(\n `GitHub code scanning request failed${typeof status === \"number\" ? ` (HTTP ${status})` : \"\"}.`,\n );\n }\n}\n\nasync function fetchGitHubAlert(\n github: Octokit,\n owner: string,\n repo: string,\n alertNumber: number,\n signal?: AbortSignal,\n) {\n const response = await github.request(\n \"GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}\",\n {\n owner,\n repo,\n alert_number: alertNumber,\n request: { signal, redirect: \"error\" },\n },\n );\n return response.data;\n}\n"]}
package/dist/index.d.ts CHANGED
@@ -19,6 +19,12 @@ export { loadContract, requireScanFile } from "./contract.js";
19
19
  export type { LoadedContract, ScanExpectation } from "./contract.js";
20
20
  export type * from "./models.js";
21
21
  export { checkScanPublication, publishScan } from "./publish.js";
22
+ export { publishScanToCustom } from "./custom-publish.js";
23
+ export type { PublishScanToCustomOptions, CustomPublicationResult, } from "./custom-publish.js";
24
+ export { deduplicateScan } from "./deduplication/scan.js";
25
+ export type { DeduplicateScanOptions, DeduplicateScanResult, } from "./deduplication/scan.js";
26
+ export { importGitHubCodeScanningAlerts } from "./github.js";
27
+ export type { GitHubCodeScanningImportOptions, ImportedGitHubCodeScanningAlert, } from "./github.js";
22
28
  export type { CheckScanPublicationOptions, CheckScanPublicationResult, PublishScanOptions, PublishScanProgress, PublishScanResult, } from "./publish.js";
23
29
  export { ScanResult } from "./result.js";
24
30
  export type { RepositoryFinding, ScanResultOptions, TurnResultMetadata, } from "./result.js";
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,YAAY,EACV,6BAA6B,EAC7B,gBAAgB,EAChB,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC7E,YAAY,EACV,aAAa,EACb,wBAAwB,GACzB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,YAAY,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC5D,YAAY,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AACrE,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAC3E,YAAY,EACV,qBAAqB,EACrB,eAAe,EACf,YAAY,EACZ,kBAAkB,EAClB,WAAW,EACX,aAAa,EACb,oBAAoB,EACpB,uBAAuB,EACvB,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,UAAU,CAAC;AAClB,YAAY,EACV,SAAS,EACT,YAAY,EACZ,eAAe,EACf,gBAAgB,GACjB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAE5D,OAAO,EACL,2BAA2B,EAC3B,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,EACvB,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,EACpB,4BAA4B,EAC5B,8BAA8B,EAC9B,oBAAoB,EACpB,4BAA4B,EAC5B,0BAA0B,EAC1B,oBAAoB,GACrB,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,mBAAmB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAC9D,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACrE,mBAAmB,aAAa,CAAC;AACjC,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AACjE,YAAY,EACV,2BAA2B,EAC3B,0BAA0B,EAC1B,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,YAAY,EACV,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,0BAA0B,EAC1B,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,cAAc,CAAC;AACtB,YAAY,EACV,YAAY,EACZ,aAAa,EACb,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,UAAU,EACV,mBAAmB,EACnB,eAAe,EACf,kBAAkB,EAClB,YAAY,GACb,MAAM,cAAc,CAAC;AACtB,YAAY,EAAE,gBAAgB,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,YAAY,EACV,6BAA6B,EAC7B,gBAAgB,EAChB,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC7E,YAAY,EACV,aAAa,EACb,wBAAwB,GACzB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,YAAY,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC5D,YAAY,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AACrE,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAC3E,YAAY,EACV,qBAAqB,EACrB,eAAe,EACf,YAAY,EACZ,kBAAkB,EAClB,WAAW,EACX,aAAa,EACb,oBAAoB,EACpB,uBAAuB,EACvB,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,UAAU,CAAC;AAClB,YAAY,EACV,SAAS,EACT,YAAY,EACZ,eAAe,EACf,gBAAgB,GACjB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAE5D,OAAO,EACL,2BAA2B,EAC3B,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,EACvB,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,EACpB,4BAA4B,EAC5B,8BAA8B,EAC9B,oBAAoB,EACpB,4BAA4B,EAC5B,0BAA0B,EAC1B,oBAAoB,GACrB,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,mBAAmB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAC9D,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACrE,mBAAmB,aAAa,CAAC;AACjC,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,YAAY,EACV,0BAA0B,EAC1B,uBAAuB,GACxB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,YAAY,EACV,sBAAsB,EACtB,qBAAqB,GACtB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,8BAA8B,EAAE,MAAM,aAAa,CAAC;AAC7D,YAAY,EACV,+BAA+B,EAC/B,+BAA+B,GAChC,MAAM,aAAa,CAAC;AACrB,YAAY,EACV,2BAA2B,EAC3B,0BAA0B,EAC1B,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,YAAY,EACV,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,0BAA0B,EAC1B,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,cAAc,CAAC;AACtB,YAAY,EACV,YAAY,EACZ,aAAa,EACb,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,UAAU,EACV,mBAAmB,EACnB,eAAe,EACf,kBAAkB,EAClB,YAAY,GACb,MAAM,cAAc,CAAC;AACtB,YAAY,EAAE,gBAAgB,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC"}
package/dist/index.js CHANGED
@@ -7,6 +7,9 @@ export { AuthenticationRequiredError, CodexSecurityError, ConfigurationError, Co
7
7
  export { DEFAULT_CODEX_CONFIG, mergedCodexConfig, writeCodexConfig, } from "./config.js";
8
8
  export { loadContract, requireScanFile } from "./contract.js";
9
9
  export { checkScanPublication, publishScan } from "./publish.js";
10
+ export { publishScanToCustom } from "./custom-publish.js";
11
+ export { deduplicateScan } from "./deduplication/scan.js";
12
+ export { importGitHubCodeScanningAlerts } from "./github.js";
10
13
  export { ScanResult } from "./result.js";
11
14
  export { bootstrapPlugin, bundledPluginRoot, cleanupSdkDirectory, createIsolatedHome, createMarketplace, extractPluginZip, importAmbientAuth, MARKETPLACE_NAME, pluginExecutionEnvironment, pluginMetadata, PLUGIN_NAME, prepareOutputDir, resolveCodexCommand, resolvePluginPath, resolvePluginPython, validateOutputDir, } from "./runtime.js";
12
15
  export { DiffTarget, normalizeRepository, normalizeTarget, repositoryRevision, validateMode, } from "./targets.js";
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAQxD,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAK7E,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAuB7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAG7C,OAAO,EACL,2BAA2B,EAC3B,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,EACvB,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,EACpB,4BAA4B,EAC5B,8BAA8B,EAC9B,oBAAoB,EACpB,4BAA4B,EAC5B,0BAA0B,EAC1B,oBAAoB,GACrB,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAG9D,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAQjE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAMzC,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,0BAA0B,EAC1B,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,cAAc,CAAC;AAOtB,OAAO,EACL,UAAU,EACV,mBAAmB,EACnB,eAAe,EACf,kBAAkB,EAClB,YAAY,GACb,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,sBAAsB,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC","sourcesContent":["export { CodexSecurity, createSecurity } from \"./api.js\";\nexport { runComponentScans } from \"./component-scan.js\";\nexport type {\n ComponentDeduplicationSummary,\n ComponentReceipt,\n ComponentScanOptions,\n ComponentScanEvent,\n ComponentScanResult,\n} from \"./component-scan.js\";\nexport { normalizeComponentPlan, planComponents } from \"./component-plan.js\";\nexport type {\n ComponentPlan,\n ComponentPlanningOptions,\n} from \"./component-plan.js\";\nexport { estimateScanCost } from \"./cost.js\";\nexport type { ScanCost, ScanSessionEvent } from \"./cost.js\";\nexport type { CustomValidationResult } from \"./custom-validation.js\";\nexport type { ScanActivity, ScanActivityStatus } from \"./scan-activity.js\";\nexport type {\n CodexSecurityMetadata,\n DeepScanOptions,\n ScanAuthMode,\n ScanAuthentication,\n ScanOptions,\n ScanPreflight,\n ScanReconnectDetails,\n ScanTrustedAccessStatus,\n ScanWarningDetails,\n ValidationOptions,\n ValidationResult,\n} from \"./api.js\";\nexport type {\n ScanPhase,\n ScanProgress,\n ScanWorkerPhase,\n ScanWorkerStatus,\n} from \"./worker-progress.js\";\nexport { CodexLoginHandle } from \"./auth.js\";\nexport type { AccountStatus, LoginResult } from \"./auth.js\";\n\nexport {\n AuthenticationRequiredError,\n CodexSecurityError,\n ConfigurationError,\n ContractValidationError,\n IncompleteScanError,\n InvalidTargetError,\n OutputDirectoryError,\n OutputDirectoryNotEmptyError,\n OutputInsideProtectedRootError,\n PluginBootstrapError,\n PluginPythonUnavailableError,\n ScanCostLimitExceededError,\n ScanInterruptedError,\n} from \"./errors.js\";\nexport type { ProtectedScanPathKind } from \"./errors.js\";\nexport {\n DEFAULT_CODEX_CONFIG,\n mergedCodexConfig,\n writeCodexConfig,\n} from \"./config.js\";\nexport type { CodexSecurityConfig, JsonObject, JsonValue } from \"./config.js\";\nexport { loadContract, requireScanFile } from \"./contract.js\";\nexport type { LoadedContract, ScanExpectation } from \"./contract.js\";\nexport type * from \"./models.js\";\nexport { checkScanPublication, publishScan } from \"./publish.js\";\nexport type {\n CheckScanPublicationOptions,\n CheckScanPublicationResult,\n PublishScanOptions,\n PublishScanProgress,\n PublishScanResult,\n} from \"./publish.js\";\nexport { ScanResult } from \"./result.js\";\nexport type {\n RepositoryFinding,\n ScanResultOptions,\n TurnResultMetadata,\n} from \"./result.js\";\nexport {\n bootstrapPlugin,\n bundledPluginRoot,\n cleanupSdkDirectory,\n createIsolatedHome,\n createMarketplace,\n extractPluginZip,\n importAmbientAuth,\n MARKETPLACE_NAME,\n pluginExecutionEnvironment,\n pluginMetadata,\n PLUGIN_NAME,\n prepareOutputDir,\n resolveCodexCommand,\n resolvePluginPath,\n resolvePluginPython,\n validateOutputDir,\n} from \"./runtime.js\";\nexport type {\n CodexCommand,\n PluginInstall,\n PluginPythonOptions,\n ProcessEnvironment,\n} from \"./runtime.js\";\nexport {\n DiffTarget,\n normalizeRepository,\n normalizeTarget,\n repositoryRevision,\n validateMode,\n} from \"./targets.js\";\nexport type { NormalizedTarget, ScanMode, ScanTarget } from \"./targets.js\";\nexport { BUNDLED_PLUGIN_VERSION, VERSION } from \"./version.js\";\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAQxD,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAK7E,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAuB7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAG7C,OAAO,EACL,2BAA2B,EAC3B,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,EACvB,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,EACpB,4BAA4B,EAC5B,8BAA8B,EAC9B,oBAAoB,EACpB,4BAA4B,EAC5B,0BAA0B,EAC1B,oBAAoB,GACrB,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAG9D,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAK1D,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAK1D,OAAO,EAAE,8BAA8B,EAAE,MAAM,aAAa,CAAC;AAY7D,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAMzC,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,0BAA0B,EAC1B,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,cAAc,CAAC;AAOtB,OAAO,EACL,UAAU,EACV,mBAAmB,EACnB,eAAe,EACf,kBAAkB,EAClB,YAAY,GACb,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,sBAAsB,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC","sourcesContent":["export { CodexSecurity, createSecurity } from \"./api.js\";\nexport { runComponentScans } from \"./component-scan.js\";\nexport type {\n ComponentDeduplicationSummary,\n ComponentReceipt,\n ComponentScanOptions,\n ComponentScanEvent,\n ComponentScanResult,\n} from \"./component-scan.js\";\nexport { normalizeComponentPlan, planComponents } from \"./component-plan.js\";\nexport type {\n ComponentPlan,\n ComponentPlanningOptions,\n} from \"./component-plan.js\";\nexport { estimateScanCost } from \"./cost.js\";\nexport type { ScanCost, ScanSessionEvent } from \"./cost.js\";\nexport type { CustomValidationResult } from \"./custom-validation.js\";\nexport type { ScanActivity, ScanActivityStatus } from \"./scan-activity.js\";\nexport type {\n CodexSecurityMetadata,\n DeepScanOptions,\n ScanAuthMode,\n ScanAuthentication,\n ScanOptions,\n ScanPreflight,\n ScanReconnectDetails,\n ScanTrustedAccessStatus,\n ScanWarningDetails,\n ValidationOptions,\n ValidationResult,\n} from \"./api.js\";\nexport type {\n ScanPhase,\n ScanProgress,\n ScanWorkerPhase,\n ScanWorkerStatus,\n} from \"./worker-progress.js\";\nexport { CodexLoginHandle } from \"./auth.js\";\nexport type { AccountStatus, LoginResult } from \"./auth.js\";\n\nexport {\n AuthenticationRequiredError,\n CodexSecurityError,\n ConfigurationError,\n ContractValidationError,\n IncompleteScanError,\n InvalidTargetError,\n OutputDirectoryError,\n OutputDirectoryNotEmptyError,\n OutputInsideProtectedRootError,\n PluginBootstrapError,\n PluginPythonUnavailableError,\n ScanCostLimitExceededError,\n ScanInterruptedError,\n} from \"./errors.js\";\nexport type { ProtectedScanPathKind } from \"./errors.js\";\nexport {\n DEFAULT_CODEX_CONFIG,\n mergedCodexConfig,\n writeCodexConfig,\n} from \"./config.js\";\nexport type { CodexSecurityConfig, JsonObject, JsonValue } from \"./config.js\";\nexport { loadContract, requireScanFile } from \"./contract.js\";\nexport type { LoadedContract, ScanExpectation } from \"./contract.js\";\nexport type * from \"./models.js\";\nexport { checkScanPublication, publishScan } from \"./publish.js\";\nexport { publishScanToCustom } from \"./custom-publish.js\";\nexport type {\n PublishScanToCustomOptions,\n CustomPublicationResult,\n} from \"./custom-publish.js\";\nexport { deduplicateScan } from \"./deduplication/scan.js\";\nexport type {\n DeduplicateScanOptions,\n DeduplicateScanResult,\n} from \"./deduplication/scan.js\";\nexport { importGitHubCodeScanningAlerts } from \"./github.js\";\nexport type {\n GitHubCodeScanningImportOptions,\n ImportedGitHubCodeScanningAlert,\n} from \"./github.js\";\nexport type {\n CheckScanPublicationOptions,\n CheckScanPublicationResult,\n PublishScanOptions,\n PublishScanProgress,\n PublishScanResult,\n} from \"./publish.js\";\nexport { ScanResult } from \"./result.js\";\nexport type {\n RepositoryFinding,\n ScanResultOptions,\n TurnResultMetadata,\n} from \"./result.js\";\nexport {\n bootstrapPlugin,\n bundledPluginRoot,\n cleanupSdkDirectory,\n createIsolatedHome,\n createMarketplace,\n extractPluginZip,\n importAmbientAuth,\n MARKETPLACE_NAME,\n pluginExecutionEnvironment,\n pluginMetadata,\n PLUGIN_NAME,\n prepareOutputDir,\n resolveCodexCommand,\n resolvePluginPath,\n resolvePluginPython,\n validateOutputDir,\n} from \"./runtime.js\";\nexport type {\n CodexCommand,\n PluginInstall,\n PluginPythonOptions,\n ProcessEnvironment,\n} from \"./runtime.js\";\nexport {\n DiffTarget,\n normalizeRepository,\n normalizeTarget,\n repositoryRevision,\n validateMode,\n} from \"./targets.js\";\nexport type { NormalizedTarget, ScanMode, ScanTarget } from \"./targets.js\";\nexport { BUNDLED_PLUGIN_VERSION, VERSION } from \"./version.js\";\n"]}
@@ -52,45 +52,10 @@ export async function prepareScanPublication(scanDirectory, options) {
52
52
  function renderFindingDescription(contract, finding, uploadedAt) {
53
53
  const { coverage } = contract;
54
54
  const { scan } = contract.manifest;
55
- const lines = [
56
- "## Codex Security finding",
57
- "",
58
- `**Scan ID:** ${scan.id}`,
59
- `**Finding ID:** ${finding.findingId}`,
60
- `**Occurrence ID:** ${finding.occurrenceId}`,
61
- `**Fingerprint:** ${finding.fingerprints.primary}`,
62
- `**Severity:** ${finding.severity.level.toUpperCase()}`,
63
- `**Confidence:** ${finding.confidence.level.toUpperCase()}`,
64
- ...(finding.taxonomy.cwe.length === 0
65
- ? []
66
- : [`**CWE:** ${finding.taxonomy.cwe.join(", ")}`]),
67
- "",
68
- "## Scanned code",
69
- "",
70
- `**Repository:** ${scan.target.displayName}`,
71
- ...(scan.target.remote === undefined
72
- ? []
73
- : [`**Remote:** ${scan.target.remote}`]),
74
- ...renderTargetIdentity(scan.target),
75
- `**Scanned scope:** ${scan.scope.includePaths.join(", ") || "entire repository"}`,
76
- ...(scan.scope.excludePaths.length === 0
77
- ? []
78
- : [`**Excluded scope:** ${scan.scope.excludePaths.join(", ")}`]),
79
- `**Coverage:** ${coverage.completeness}`,
80
- `**Coverage mode:** ${coverage.mode}`,
81
- `**Scan mode:** ${scanMode(coverage.mode)}`,
82
- `**Started:** ${scan.startedAt}`,
83
- `**Completed:** ${scan.completedAt}`,
84
- `**Uploaded:** ${uploadedAt}`,
85
- "",
86
- "### Affected locations",
87
- "",
88
- ...finding.locations.map((location) => renderLocation(scan.target, location)),
89
- "",
90
- "## Summary",
91
- "",
92
- finding.summary,
93
- ];
55
+ const lines = ["## Summary", "", finding.summary];
56
+ if (finding.attackPath?.summary !== undefined) {
57
+ lines.push("", "## Reproduction summary", "", finding.attackPath.summary);
58
+ }
94
59
  const rootCause = finding.rootCause;
95
60
  if (typeof rootCause === "string") {
96
61
  lines.push("", "## Root cause", "", rootCause);
@@ -101,13 +66,36 @@ function renderFindingDescription(contract, finding, uploadedAt) {
101
66
  lines.push("", fencedCode(rootCause.code, rootCause.language));
102
67
  }
103
68
  }
69
+ lines.push("", "## Remediation", "", finding.remediation);
70
+ const validation = finding.validation;
71
+ const limits = [
72
+ ...new Set([
73
+ ...(validation?.limitations ?? []),
74
+ ...(validation?.counterEvidence ?? []),
75
+ ...(finding.attackPath?.limitations ?? []),
76
+ ]),
77
+ ];
78
+ if (validation?.summary || validation?.method || limits.length > 0) {
79
+ lines.push("", "## Validation", "");
80
+ if (validation?.summary)
81
+ lines.push(validation.summary, "");
82
+ if (validation?.method)
83
+ lines.push(`**Method:** ${validation.method}`, "");
84
+ lines.push(...limits.map((limit) => `- ${limit}`));
85
+ }
104
86
  if (finding.codeEvidence !== undefined && finding.codeEvidence.length > 0) {
105
87
  lines.push("", "## Source-code evidence");
106
88
  for (const evidence of finding.codeEvidence) {
107
89
  lines.push("", ...renderCodeEvidence(scan.target, evidence));
108
90
  }
109
91
  }
110
- lines.push("", "## Remediation", "", finding.remediation);
92
+ lines.push("", "---", "", "## Codex Security finding", "", `**Scan ID:** ${scan.id}`, `**Finding ID:** ${finding.findingId}`, `**Occurrence ID:** ${finding.occurrenceId}`, `**Fingerprint:** ${finding.fingerprints.primary}`, `**Severity:** ${finding.severity.level.toUpperCase()}`, `**Confidence:** ${finding.confidence.level.toUpperCase()}`, ...(finding.taxonomy.cwe.length === 0
93
+ ? []
94
+ : [`**CWE:** ${finding.taxonomy.cwe.join(", ")}`]), "", "## Scanned code", "", `**Repository:** ${scan.target.displayName}`, ...(scan.target.remote === undefined
95
+ ? []
96
+ : [`**Remote:** ${scan.target.remote}`]), ...renderTargetIdentity(scan.target), `**Scanned scope:** ${scan.scope.includePaths.join(", ") || "entire repository"}`, ...(scan.scope.excludePaths.length === 0
97
+ ? []
98
+ : [`**Excluded scope:** ${scan.scope.excludePaths.join(", ")}`]), `**Coverage:** ${coverage.completeness}`, `**Coverage mode:** ${coverage.mode}`, `**Scan mode:** ${scanMode(coverage.mode)}`, `**Started:** ${scan.startedAt}`, `**Completed:** ${scan.completedAt}`, `**Uploaded:** ${uploadedAt}`, "", "### Affected locations", "", ...finding.locations.map((location) => renderLocation(scan.target, location)));
111
99
  return `${lines.join("\n")}\n`;
112
100
  }
113
101
  function renderTargetIdentity(target) {
@@ -1 +1 @@
1
- {"version":3,"file":"publication.js","sourceRoot":"","sources":["../src/publication.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,GAE9B,MAAM,eAAe,CAAC;AAQvB,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAiCjD,MAAM,UAAU,0BAA0B,CACxC,WAAyC,EACzC,KAA+B;IAK/B,OAAO;QACL,IAAI,EAAE,WAAW,CAAC,MAAM;QACxB,GAAG,CAAC,WAAW,CAAC,SAAS,KAAK,SAAS;YACrC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,SAAS,EAAE,CAAC;QACvC,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,WAAW,EAAE,KAAK,CAAC,WAAW;QAC9B,GAAG,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC;KACtE,CAAC;AACJ,CAAC;AAED,MAAM,iBAAiB,GAAG;IACxB,QAAQ,EAAE,CAAC;IACX,IAAI,EAAE,CAAC;IACP,MAAM,EAAE,CAAC;IACT,GAAG,EAAE,CAAC;IACN,aAAa,EAAE,SAAS;CAC2C,CAAC;AAEtE,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,aAAqB,EACrB,OAAsC;IAEtC,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,sBAAsB,EAAE,GACvD,MAAM,6BAA6B,CAAC,aAAa,EAAE;QACjD,UAAU,EAAE,MAAM,iBAAiB,EAAE;QACrC,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;QACnE,cAAc,EAAE,OAAO,CAAC,cAAc;KACvC,CAAC,CAAC;IACL,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAClE,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;IAEzC,OAAO;QACL,MAAM;QACN,QAAQ,EAAE,MAAM;QAChB,aAAa,EAAE,sBAAsB;QACrC,WAAW,EAAE;YACX,IAAI,EAAE,OAAO,CAAC,WAAW;YACzB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,GAAG,CAAC,OAAO,CAAC,SAAS,KAAK,SAAS;gBACjC,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;SACtC;QACD,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YACjD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC3D,OAAO;gBACL,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,YAAY,EAAE,OAAO,CAAC,YAAY;gBAClC,KAAK,EAAE,oBAAoB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,KAAK,EAAE;gBACnF,WAAW,EAAE,wBAAwB,CAAC,QAAQ,EAAE,OAAO,EAAE,UAAU,CAAC;gBACpE,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC;aAChD,CAAC;QACJ,CAAC,CAAC;KACH,CAAC;AACJ,CAAC;AAED,SAAS,wBAAwB,CAC/B,QAAwB,EACxB,OAAgB,EAChB,UAAkB;IAElB,MAAM,EAAE,QAAQ,EAAE,GAAG,QAAQ,CAAC;IAC9B,MAAM,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC;IACnC,MAAM,KAAK,GAAG;QACZ,2BAA2B;QAC3B,EAAE;QACF,gBAAgB,IAAI,CAAC,EAAE,EAAE;QACzB,mBAAmB,OAAO,CAAC,SAAS,EAAE;QACtC,sBAAsB,OAAO,CAAC,YAAY,EAAE;QAC5C,oBAAoB,OAAO,CAAC,YAAY,CAAC,OAAO,EAAE;QAClD,iBAAiB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE;QACvD,mBAAmB,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE;QAC3D,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC;YACnC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,CAAC,YAAY,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpD,EAAE;QACF,iBAAiB;QACjB,EAAE;QACF,mBAAmB,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;QAC5C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS;YAClC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,CAAC,eAAe,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1C,GAAG,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC;QACpC,sBAAsB,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,mBAAmB,EAAE;QACjF,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC;YACtC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,CAAC,uBAAuB,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClE,iBAAiB,QAAQ,CAAC,YAAY,EAAE;QACxC,sBAAsB,QAAQ,CAAC,IAAI,EAAE;QACrC,kBAAkB,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;QAC3C,gBAAgB,IAAI,CAAC,SAAS,EAAE;QAChC,kBAAkB,IAAI,CAAC,WAAW,EAAE;QACpC,iBAAiB,UAAU,EAAE;QAC7B,EAAE;QACF,wBAAwB;QACxB,EAAE;QACF,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CACpC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CACtC;QACD,EAAE;QACF,YAAY;QACZ,EAAE;QACF,OAAO,CAAC,OAAO;KAChB,CAAC;IAEF,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IACpC,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAClC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC;IACjD,CAAC;SAAM,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QACnC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACjC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAED,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,IAAI,OAAO,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1E,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,yBAAyB,CAAC,CAAC;QAC1C,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YAC5C,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAC1D,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAwB;IACpD,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAClC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,eAAe,CAAC;QAC5E,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;IACjD,CAAC;IACD,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QACtC,KAAK,CAAC,IAAI,CAAC,2BAA2B,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QACtC,KAAK,CAAC,IAAI,CAAC,2BAA2B,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,IAAI,MAAM,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;QACxC,KAAK,CAAC,IAAI,CAAC,wBAAwB,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC;IAC9D,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,QAAQ,CAAC,IAAwC;IACxD,IAAI,IAAI,KAAK,iBAAiB;QAAE,OAAO,MAAM,CAAC;IAC9C,IAAI,IAAI,KAAK,YAAY;QAAE,OAAO,UAAU,CAAC;IAC7C,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,cAAc,CACrB,MAAwB,EACxB,QAAyB;IAEzB,MAAM,IAAI,GACR,QAAQ,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACzE,MAAM,KAAK,GAAG,GAAG,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,SAAS,GAClD,QAAQ,CAAC,OAAO,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,KAAK,QAAQ,CAAC,SAAS;QACvE,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,IAAI,QAAQ,CAAC,OAAO,EAC1B,EAAE,CAAC;IACH,MAAM,SAAS,GAAG,kBAAkB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACvD,OAAO,OAAO,IAAI,OAAO,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,KAAK,OAAO,SAAS,GAAG,EAAE,CAAC;AACvG,CAAC;AAED,SAAS,kBAAkB,CACzB,MAAwB,EACxB,QAA6B;IAE7B,MAAM,QAAQ,GAAoB;QAChC,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,SAAS,EAAE,QAAQ,CAAC,SAAS;QAC7B,GAAG,CAAC,QAAQ,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;QACxE,GAAG,CAAC,QAAQ,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC;KAChE,CAAC;IACF,OAAO;QACL,OAAO,QAAQ,CAAC,KAAK,EAAE;QACvB,EAAE;QACF,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC;QAChC,EAAE;QACF,UAAU,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAC5C,EAAE;QACF,QAAQ,CAAC,WAAW;KACrB,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,IAAY;IAChC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACxC,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AAC/D,CAAC;AAED,SAAS,UAAU,CAAC,IAAY,EAAE,QAAiB;IACjD,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACzC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC3D,CAAC;IACD,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACtC,MAAM,GAAG,GACP,QAAQ,KAAK,SAAS,IAAI,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC;QAC3D,CAAC,CAAC,QAAQ;QACV,CAAC,CAAC,EAAE,CAAC;IACT,OAAO,GAAG,KAAK,GAAG,GAAG,KAAK,IAAI,KAAK,KAAK,EAAE,CAAC;AAC7C,CAAC;AAED,SAAS,kBAAkB,CACzB,MAAwB,EACxB,QAAyB;IAEzB,IACE,MAAM,CAAC,IAAI,KAAK,cAAc;QAC9B,MAAM,CAAC,MAAM,KAAK,SAAS;QAC3B,MAAM,CAAC,QAAQ,KAAK,SAAS;QAC7B,CAAC,kCAAkC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QACzD,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,EACpC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,MAAW,CAAC;IAChB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IACE,MAAM,CAAC,QAAQ,KAAK,QAAQ;QAC5B,CAAC,MAAM,CAAC,QAAQ,KAAK,YAAY,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,EAC3E,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,CAAC,QAAQ;SAC/B,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;SACxB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACtB,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxE,MAAM,CAAC,QAAQ,GAAG,GAAG,UAAU,SAAS,MAAM,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;IAClE,MAAM,CAAC,IAAI,GAAG,IAAI,QAAQ,CAAC,SAAS,GAClC,QAAQ,CAAC,OAAO,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,KAAK,QAAQ,CAAC,SAAS;QACvE,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,KAAK,QAAQ,CAAC,OAAO,EAC3B,EAAE,CAAC;IACH,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;AAC3B,CAAC;AAED,SAAS,oBAAoB,CAAC,IAAY;IACxC,IACE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QACnB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;QACvB,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,EAClC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,IAAI;SACR,KAAK,CAAC,GAAG,CAAC;SACV,KAAK,CACJ,CAAC,OAAO,EAAE,EAAE,CACV,OAAO,CAAC,MAAM,GAAG,CAAC;QAClB,OAAO,KAAK,GAAG;QACf,OAAO,KAAK,IAAI;QAChB,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAClC,CAAC;AACN,CAAC","sourcesContent":["import {\n loadContractWithScanDirectory,\n type LoadedContract,\n} from \"./contract.js\";\nimport type {\n Finding,\n FindingCodeEvidence,\n FindingLocation,\n ScanTargetRecord,\n SeverityLevel,\n} from \"./models.js\";\nimport { bundledPluginRoot } from \"./runtime.js\";\n\nexport interface LinearPublicationDestination {\n type: \"linear\";\n teamId: string;\n projectId?: string;\n}\n\nexport interface PrepareScanPublicationOptions {\n destination: \"linear\";\n teamId: string;\n projectId?: string;\n uploadedAt?: string;\n signal?: AbortSignal;\n expectedScanId?: string;\n}\n\nexport interface PreparedPublicationIssue {\n findingId: string;\n occurrenceId: string;\n title: string;\n description: string;\n priority?: 1 | 2 | 3 | 4;\n}\n\nexport interface PreparedScanPublication {\n scanId: string;\n uploadId: string;\n scanDirectory: string;\n destination: LinearPublicationDestination;\n issues: PreparedPublicationIssue[];\n}\n\nexport function linearPublicationArguments(\n destination: LinearPublicationDestination,\n issue: PreparedPublicationIssue,\n): Pick<PreparedPublicationIssue, \"title\" | \"description\" | \"priority\"> & {\n team: string;\n project?: string;\n} {\n return {\n team: destination.teamId,\n ...(destination.projectId === undefined\n ? {}\n : { project: destination.projectId }),\n title: issue.title,\n description: issue.description,\n ...(issue.priority === undefined ? {} : { priority: issue.priority }),\n };\n}\n\nconst LINEAR_PRIORITIES = {\n critical: 1,\n high: 2,\n medium: 3,\n low: 4,\n informational: undefined,\n} as const satisfies Record<SeverityLevel, 1 | 2 | 3 | 4 | undefined>;\n\nexport async function prepareScanPublication(\n scanDirectory: string,\n options: PrepareScanPublicationOptions,\n): Promise<PreparedScanPublication> {\n const { contract, scanDirectory: canonicalScanDirectory } =\n await loadContractWithScanDirectory(scanDirectory, {\n pluginRoot: await bundledPluginRoot(),\n ...(options.signal === undefined ? {} : { signal: options.signal }),\n expectedScanId: options.expectedScanId,\n });\n const uploadedAt = options.uploadedAt ?? new Date().toISOString();\n const scanId = contract.manifest.scan.id;\n\n return {\n scanId,\n uploadId: scanId,\n scanDirectory: canonicalScanDirectory,\n destination: {\n type: options.destination,\n teamId: options.teamId,\n ...(options.projectId === undefined\n ? {}\n : { projectId: options.projectId }),\n },\n issues: contract.findings.findings.map((finding) => {\n const priority = LINEAR_PRIORITIES[finding.severity.level];\n return {\n findingId: finding.findingId,\n occurrenceId: finding.occurrenceId,\n title: `[Codex Security][${finding.severity.level.toUpperCase()}] ${finding.title}`,\n description: renderFindingDescription(contract, finding, uploadedAt),\n ...(priority === undefined ? {} : { priority }),\n };\n }),\n };\n}\n\nfunction renderFindingDescription(\n contract: LoadedContract,\n finding: Finding,\n uploadedAt: string,\n): string {\n const { coverage } = contract;\n const { scan } = contract.manifest;\n const lines = [\n \"## Codex Security finding\",\n \"\",\n `**Scan ID:** ${scan.id}`,\n `**Finding ID:** ${finding.findingId}`,\n `**Occurrence ID:** ${finding.occurrenceId}`,\n `**Fingerprint:** ${finding.fingerprints.primary}`,\n `**Severity:** ${finding.severity.level.toUpperCase()}`,\n `**Confidence:** ${finding.confidence.level.toUpperCase()}`,\n ...(finding.taxonomy.cwe.length === 0\n ? []\n : [`**CWE:** ${finding.taxonomy.cwe.join(\", \")}`]),\n \"\",\n \"## Scanned code\",\n \"\",\n `**Repository:** ${scan.target.displayName}`,\n ...(scan.target.remote === undefined\n ? []\n : [`**Remote:** ${scan.target.remote}`]),\n ...renderTargetIdentity(scan.target),\n `**Scanned scope:** ${scan.scope.includePaths.join(\", \") || \"entire repository\"}`,\n ...(scan.scope.excludePaths.length === 0\n ? []\n : [`**Excluded scope:** ${scan.scope.excludePaths.join(\", \")}`]),\n `**Coverage:** ${coverage.completeness}`,\n `**Coverage mode:** ${coverage.mode}`,\n `**Scan mode:** ${scanMode(coverage.mode)}`,\n `**Started:** ${scan.startedAt}`,\n `**Completed:** ${scan.completedAt}`,\n `**Uploaded:** ${uploadedAt}`,\n \"\",\n \"### Affected locations\",\n \"\",\n ...finding.locations.map((location) =>\n renderLocation(scan.target, location),\n ),\n \"\",\n \"## Summary\",\n \"\",\n finding.summary,\n ];\n\n const rootCause = finding.rootCause;\n if (typeof rootCause === \"string\") {\n lines.push(\"\", \"## Root cause\", \"\", rootCause);\n } else if (rootCause !== undefined) {\n lines.push(\"\", \"## Root cause\", \"\", rootCause.summary);\n if (rootCause.code !== undefined) {\n lines.push(\"\", fencedCode(rootCause.code, rootCause.language));\n }\n }\n\n if (finding.codeEvidence !== undefined && finding.codeEvidence.length > 0) {\n lines.push(\"\", \"## Source-code evidence\");\n for (const evidence of finding.codeEvidence) {\n lines.push(\"\", ...renderCodeEvidence(scan.target, evidence));\n }\n }\n\n lines.push(\"\", \"## Remediation\", \"\", finding.remediation);\n return `${lines.join(\"\\n\")}\\n`;\n}\n\nfunction renderTargetIdentity(target: ScanTargetRecord): string[] {\n const lines: string[] = [];\n if (target.revision !== undefined) {\n const label = target.kind === \"git_revision\" ? \"Revision\" : \"Base revision\";\n lines.push(`**${label}:** ${target.revision}`);\n }\n if (target.baseRevision !== undefined) {\n lines.push(`**Diff base revision:** ${target.baseRevision}`);\n }\n if (target.headRevision !== undefined) {\n lines.push(`**Diff head revision:** ${target.headRevision}`);\n }\n if (target.snapshotDigest !== undefined) {\n lines.push(`**Snapshot digest:** ${target.snapshotDigest}`);\n }\n return lines;\n}\n\nfunction scanMode(mode: LoadedContract[\"coverage\"][\"mode\"]): string {\n if (mode === \"deep_repository\") return \"deep\";\n if (mode === \"repository\") return \"standard\";\n return mode;\n}\n\nfunction renderLocation(\n target: ScanTargetRecord,\n location: FindingLocation,\n): string {\n const role =\n location.role === undefined ? \"Location\" : humanizeRole(location.role);\n const label = `${location.path}:${location.startLine}${\n location.endLine === undefined || location.endLine === location.startLine\n ? \"\"\n : `-${location.endLine}`\n }`;\n const sourceUrl = immutableSourceUrl(target, location);\n return `- **${role}:** ${sourceUrl === undefined ? `\\`${label}\\`` : `[\\`${label}\\`](${sourceUrl})`}`;\n}\n\nfunction renderCodeEvidence(\n target: ScanTargetRecord,\n evidence: FindingCodeEvidence,\n): string[] {\n const location: FindingLocation = {\n path: evidence.path,\n startLine: evidence.startLine,\n ...(evidence.endLine === undefined ? {} : { endLine: evidence.endLine }),\n ...(evidence.role === undefined ? {} : { role: evidence.role }),\n };\n return [\n `### ${evidence.label}`,\n \"\",\n renderLocation(target, location),\n \"\",\n fencedCode(evidence.code, evidence.language),\n \"\",\n evidence.explanation,\n ];\n}\n\nfunction humanizeRole(role: string): string {\n const words = role.replaceAll(\"_\", \" \");\n return `${words.slice(0, 1).toUpperCase()}${words.slice(1)}`;\n}\n\nfunction fencedCode(code: string, language?: string): string {\n let fenceLength = 3;\n for (const match of code.matchAll(/`+/g)) {\n fenceLength = Math.max(fenceLength, match[0].length + 1);\n }\n const fence = \"`\".repeat(fenceLength);\n const tag =\n language !== undefined && /^[A-Za-z0-9_+.-]+$/.test(language)\n ? language\n : \"\";\n return `${fence}${tag}\\n${code}\\n${fence}`;\n}\n\nfunction immutableSourceUrl(\n target: ScanTargetRecord,\n location: FindingLocation,\n): string | undefined {\n if (\n target.kind !== \"git_revision\" ||\n target.remote === undefined ||\n target.revision === undefined ||\n !/^(?:[a-f0-9]{40}|[a-f0-9]{64})$/i.test(target.revision) ||\n !isSafeRepositoryPath(location.path)\n ) {\n return undefined;\n }\n\n let remote: URL;\n try {\n remote = new URL(target.remote);\n } catch {\n return undefined;\n }\n if (\n remote.protocol !== \"https:\" ||\n (remote.hostname !== \"github.com\" && !remote.hostname.endsWith(\".ghe.com\"))\n ) {\n return undefined;\n }\n\n const repository = remote.pathname\n .replace(/\\.git\\/?$/, \"\")\n .replace(/\\/$/, \"\");\n const path = location.path.split(\"/\").map(encodeURIComponent).join(\"/\");\n remote.pathname = `${repository}/blob/${target.revision}/${path}`;\n remote.hash = `L${location.startLine}${\n location.endLine === undefined || location.endLine === location.startLine\n ? \"\"\n : `-L${location.endLine}`\n }`;\n return remote.toString();\n}\n\nfunction isSafeRepositoryPath(path: string): boolean {\n if (\n path.includes(\"\\\\\") ||\n /^[A-Za-z]:/.test(path) ||\n /[\\u0000-\\u001f\\u007f]/.test(path)\n ) {\n return false;\n }\n\n return path\n .split(\"/\")\n .every(\n (segment) =>\n segment.length > 0 &&\n segment !== \".\" &&\n segment !== \"..\" &&\n !/%(?:2e|2f|5c)/i.test(segment),\n );\n}\n"]}
1
+ {"version":3,"file":"publication.js","sourceRoot":"","sources":["../src/publication.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,GAE9B,MAAM,eAAe,CAAC;AAQvB,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAiCjD,MAAM,UAAU,0BAA0B,CACxC,WAAyC,EACzC,KAA+B;IAK/B,OAAO;QACL,IAAI,EAAE,WAAW,CAAC,MAAM;QACxB,GAAG,CAAC,WAAW,CAAC,SAAS,KAAK,SAAS;YACrC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,SAAS,EAAE,CAAC;QACvC,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,WAAW,EAAE,KAAK,CAAC,WAAW;QAC9B,GAAG,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC;KACtE,CAAC;AACJ,CAAC;AAED,MAAM,iBAAiB,GAAG;IACxB,QAAQ,EAAE,CAAC;IACX,IAAI,EAAE,CAAC;IACP,MAAM,EAAE,CAAC;IACT,GAAG,EAAE,CAAC;IACN,aAAa,EAAE,SAAS;CAC2C,CAAC;AAEtE,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,aAAqB,EACrB,OAAsC;IAEtC,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,sBAAsB,EAAE,GACvD,MAAM,6BAA6B,CAAC,aAAa,EAAE;QACjD,UAAU,EAAE,MAAM,iBAAiB,EAAE;QACrC,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;QACnE,cAAc,EAAE,OAAO,CAAC,cAAc;KACvC,CAAC,CAAC;IACL,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAClE,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;IAEzC,OAAO;QACL,MAAM;QACN,QAAQ,EAAE,MAAM;QAChB,aAAa,EAAE,sBAAsB;QACrC,WAAW,EAAE;YACX,IAAI,EAAE,OAAO,CAAC,WAAW;YACzB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,GAAG,CAAC,OAAO,CAAC,SAAS,KAAK,SAAS;gBACjC,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;SACtC;QACD,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YACjD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC3D,OAAO;gBACL,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,YAAY,EAAE,OAAO,CAAC,YAAY;gBAClC,KAAK,EAAE,oBAAoB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,KAAK,EAAE;gBACnF,WAAW,EAAE,wBAAwB,CAAC,QAAQ,EAAE,OAAO,EAAE,UAAU,CAAC;gBACpE,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC;aAChD,CAAC;QACJ,CAAC,CAAC;KACH,CAAC;AACJ,CAAC;AAED,SAAS,wBAAwB,CAC/B,QAAwB,EACxB,OAAgB,EAChB,UAAkB;IAElB,MAAM,EAAE,QAAQ,EAAE,GAAG,QAAQ,CAAC;IAC9B,MAAM,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC;IACnC,MAAM,KAAK,GAAG,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAElD,IAAI,OAAO,CAAC,UAAU,EAAE,OAAO,KAAK,SAAS,EAAE,CAAC;QAC9C,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,yBAAyB,EAAE,EAAE,EAAE,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IACpC,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAClC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC;IACjD,CAAC;SAAM,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QACnC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACjC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAE1D,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IACtC,MAAM,MAAM,GAAG;QACb,GAAG,IAAI,GAAG,CAAC;YACT,GAAG,CAAC,UAAU,EAAE,WAAW,IAAI,EAAE,CAAC;YAClC,GAAG,CAAC,UAAU,EAAE,eAAe,IAAI,EAAE,CAAC;YACtC,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,WAAW,IAAI,EAAE,CAAC;SAC3C,CAAC;KACH,CAAC;IACF,IAAI,UAAU,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnE,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,eAAe,EAAE,EAAE,CAAC,CAAC;QACpC,IAAI,UAAU,EAAE,OAAO;YAAE,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC5D,IAAI,UAAU,EAAE,MAAM;YAAE,KAAK,CAAC,IAAI,CAAC,eAAe,UAAU,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;QAC3E,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,IAAI,OAAO,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1E,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,yBAAyB,CAAC,CAAC;QAC1C,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YAC5C,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,EAAE,EACF,KAAK,EACL,EAAE,EACF,2BAA2B,EAC3B,EAAE,EACF,gBAAgB,IAAI,CAAC,EAAE,EAAE,EACzB,mBAAmB,OAAO,CAAC,SAAS,EAAE,EACtC,sBAAsB,OAAO,CAAC,YAAY,EAAE,EAC5C,oBAAoB,OAAO,CAAC,YAAY,CAAC,OAAO,EAAE,EAClD,iBAAiB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,EACvD,mBAAmB,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,EAC3D,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC;QACnC,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,CAAC,YAAY,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EACpD,EAAE,EACF,iBAAiB,EACjB,EAAE,EACF,mBAAmB,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,EAC5C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS;QAClC,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,CAAC,eAAe,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAC1C,GAAG,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,EACpC,sBAAsB,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,mBAAmB,EAAE,EACjF,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC;QACtC,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,CAAC,uBAAuB,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAClE,iBAAiB,QAAQ,CAAC,YAAY,EAAE,EACxC,sBAAsB,QAAQ,CAAC,IAAI,EAAE,EACrC,kBAAkB,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EAC3C,gBAAgB,IAAI,CAAC,SAAS,EAAE,EAChC,kBAAkB,IAAI,CAAC,WAAW,EAAE,EACpC,iBAAiB,UAAU,EAAE,EAC7B,EAAE,EACF,wBAAwB,EACxB,EAAE,EACF,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CACpC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CACtC,CACF,CAAC;IACF,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAwB;IACpD,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAClC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,eAAe,CAAC;QAC5E,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;IACjD,CAAC;IACD,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QACtC,KAAK,CAAC,IAAI,CAAC,2BAA2B,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QACtC,KAAK,CAAC,IAAI,CAAC,2BAA2B,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,IAAI,MAAM,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;QACxC,KAAK,CAAC,IAAI,CAAC,wBAAwB,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC;IAC9D,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,QAAQ,CAAC,IAAwC;IACxD,IAAI,IAAI,KAAK,iBAAiB;QAAE,OAAO,MAAM,CAAC;IAC9C,IAAI,IAAI,KAAK,YAAY;QAAE,OAAO,UAAU,CAAC;IAC7C,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,cAAc,CACrB,MAAwB,EACxB,QAAyB;IAEzB,MAAM,IAAI,GACR,QAAQ,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACzE,MAAM,KAAK,GAAG,GAAG,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,SAAS,GAClD,QAAQ,CAAC,OAAO,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,KAAK,QAAQ,CAAC,SAAS;QACvE,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,IAAI,QAAQ,CAAC,OAAO,EAC1B,EAAE,CAAC;IACH,MAAM,SAAS,GAAG,kBAAkB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACvD,OAAO,OAAO,IAAI,OAAO,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,KAAK,OAAO,SAAS,GAAG,EAAE,CAAC;AACvG,CAAC;AAED,SAAS,kBAAkB,CACzB,MAAwB,EACxB,QAA6B;IAE7B,MAAM,QAAQ,GAAoB;QAChC,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,SAAS,EAAE,QAAQ,CAAC,SAAS;QAC7B,GAAG,CAAC,QAAQ,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;QACxE,GAAG,CAAC,QAAQ,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC;KAChE,CAAC;IACF,OAAO;QACL,OAAO,QAAQ,CAAC,KAAK,EAAE;QACvB,EAAE;QACF,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC;QAChC,EAAE;QACF,UAAU,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAC5C,EAAE;QACF,QAAQ,CAAC,WAAW;KACrB,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,IAAY;IAChC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACxC,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AAC/D,CAAC;AAED,SAAS,UAAU,CAAC,IAAY,EAAE,QAAiB;IACjD,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACzC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC3D,CAAC;IACD,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACtC,MAAM,GAAG,GACP,QAAQ,KAAK,SAAS,IAAI,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC;QAC3D,CAAC,CAAC,QAAQ;QACV,CAAC,CAAC,EAAE,CAAC;IACT,OAAO,GAAG,KAAK,GAAG,GAAG,KAAK,IAAI,KAAK,KAAK,EAAE,CAAC;AAC7C,CAAC;AAED,SAAS,kBAAkB,CACzB,MAAwB,EACxB,QAAyB;IAEzB,IACE,MAAM,CAAC,IAAI,KAAK,cAAc;QAC9B,MAAM,CAAC,MAAM,KAAK,SAAS;QAC3B,MAAM,CAAC,QAAQ,KAAK,SAAS;QAC7B,CAAC,kCAAkC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QACzD,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,EACpC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,MAAW,CAAC;IAChB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IACE,MAAM,CAAC,QAAQ,KAAK,QAAQ;QAC5B,CAAC,MAAM,CAAC,QAAQ,KAAK,YAAY,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,EAC3E,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,CAAC,QAAQ;SAC/B,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;SACxB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACtB,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxE,MAAM,CAAC,QAAQ,GAAG,GAAG,UAAU,SAAS,MAAM,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;IAClE,MAAM,CAAC,IAAI,GAAG,IAAI,QAAQ,CAAC,SAAS,GAClC,QAAQ,CAAC,OAAO,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,KAAK,QAAQ,CAAC,SAAS;QACvE,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,KAAK,QAAQ,CAAC,OAAO,EAC3B,EAAE,CAAC;IACH,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;AAC3B,CAAC;AAED,SAAS,oBAAoB,CAAC,IAAY;IACxC,IACE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QACnB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;QACvB,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,EAClC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,IAAI;SACR,KAAK,CAAC,GAAG,CAAC;SACV,KAAK,CACJ,CAAC,OAAO,EAAE,EAAE,CACV,OAAO,CAAC,MAAM,GAAG,CAAC;QAClB,OAAO,KAAK,GAAG;QACf,OAAO,KAAK,IAAI;QAChB,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAClC,CAAC;AACN,CAAC","sourcesContent":["import {\n loadContractWithScanDirectory,\n type LoadedContract,\n} from \"./contract.js\";\nimport type {\n Finding,\n FindingCodeEvidence,\n FindingLocation,\n ScanTargetRecord,\n SeverityLevel,\n} from \"./models.js\";\nimport { bundledPluginRoot } from \"./runtime.js\";\n\nexport interface LinearPublicationDestination {\n type: \"linear\";\n teamId: string;\n projectId?: string;\n}\n\nexport interface PrepareScanPublicationOptions {\n destination: \"linear\";\n teamId: string;\n projectId?: string;\n uploadedAt?: string;\n signal?: AbortSignal;\n expectedScanId?: string;\n}\n\nexport interface PreparedPublicationIssue {\n findingId: string;\n occurrenceId: string;\n title: string;\n description: string;\n priority?: 1 | 2 | 3 | 4;\n}\n\nexport interface PreparedScanPublication {\n scanId: string;\n uploadId: string;\n scanDirectory: string;\n destination: LinearPublicationDestination;\n issues: PreparedPublicationIssue[];\n}\n\nexport function linearPublicationArguments(\n destination: LinearPublicationDestination,\n issue: PreparedPublicationIssue,\n): Pick<PreparedPublicationIssue, \"title\" | \"description\" | \"priority\"> & {\n team: string;\n project?: string;\n} {\n return {\n team: destination.teamId,\n ...(destination.projectId === undefined\n ? {}\n : { project: destination.projectId }),\n title: issue.title,\n description: issue.description,\n ...(issue.priority === undefined ? {} : { priority: issue.priority }),\n };\n}\n\nconst LINEAR_PRIORITIES = {\n critical: 1,\n high: 2,\n medium: 3,\n low: 4,\n informational: undefined,\n} as const satisfies Record<SeverityLevel, 1 | 2 | 3 | 4 | undefined>;\n\nexport async function prepareScanPublication(\n scanDirectory: string,\n options: PrepareScanPublicationOptions,\n): Promise<PreparedScanPublication> {\n const { contract, scanDirectory: canonicalScanDirectory } =\n await loadContractWithScanDirectory(scanDirectory, {\n pluginRoot: await bundledPluginRoot(),\n ...(options.signal === undefined ? {} : { signal: options.signal }),\n expectedScanId: options.expectedScanId,\n });\n const uploadedAt = options.uploadedAt ?? new Date().toISOString();\n const scanId = contract.manifest.scan.id;\n\n return {\n scanId,\n uploadId: scanId,\n scanDirectory: canonicalScanDirectory,\n destination: {\n type: options.destination,\n teamId: options.teamId,\n ...(options.projectId === undefined\n ? {}\n : { projectId: options.projectId }),\n },\n issues: contract.findings.findings.map((finding) => {\n const priority = LINEAR_PRIORITIES[finding.severity.level];\n return {\n findingId: finding.findingId,\n occurrenceId: finding.occurrenceId,\n title: `[Codex Security][${finding.severity.level.toUpperCase()}] ${finding.title}`,\n description: renderFindingDescription(contract, finding, uploadedAt),\n ...(priority === undefined ? {} : { priority }),\n };\n }),\n };\n}\n\nfunction renderFindingDescription(\n contract: LoadedContract,\n finding: Finding,\n uploadedAt: string,\n): string {\n const { coverage } = contract;\n const { scan } = contract.manifest;\n const lines = [\"## Summary\", \"\", finding.summary];\n\n if (finding.attackPath?.summary !== undefined) {\n lines.push(\"\", \"## Reproduction summary\", \"\", finding.attackPath.summary);\n }\n\n const rootCause = finding.rootCause;\n if (typeof rootCause === \"string\") {\n lines.push(\"\", \"## Root cause\", \"\", rootCause);\n } else if (rootCause !== undefined) {\n lines.push(\"\", \"## Root cause\", \"\", rootCause.summary);\n if (rootCause.code !== undefined) {\n lines.push(\"\", fencedCode(rootCause.code, rootCause.language));\n }\n }\n\n lines.push(\"\", \"## Remediation\", \"\", finding.remediation);\n\n const validation = finding.validation;\n const limits = [\n ...new Set([\n ...(validation?.limitations ?? []),\n ...(validation?.counterEvidence ?? []),\n ...(finding.attackPath?.limitations ?? []),\n ]),\n ];\n if (validation?.summary || validation?.method || limits.length > 0) {\n lines.push(\"\", \"## Validation\", \"\");\n if (validation?.summary) lines.push(validation.summary, \"\");\n if (validation?.method) lines.push(`**Method:** ${validation.method}`, \"\");\n lines.push(...limits.map((limit) => `- ${limit}`));\n }\n\n if (finding.codeEvidence !== undefined && finding.codeEvidence.length > 0) {\n lines.push(\"\", \"## Source-code evidence\");\n for (const evidence of finding.codeEvidence) {\n lines.push(\"\", ...renderCodeEvidence(scan.target, evidence));\n }\n }\n\n lines.push(\n \"\",\n \"---\",\n \"\",\n \"## Codex Security finding\",\n \"\",\n `**Scan ID:** ${scan.id}`,\n `**Finding ID:** ${finding.findingId}`,\n `**Occurrence ID:** ${finding.occurrenceId}`,\n `**Fingerprint:** ${finding.fingerprints.primary}`,\n `**Severity:** ${finding.severity.level.toUpperCase()}`,\n `**Confidence:** ${finding.confidence.level.toUpperCase()}`,\n ...(finding.taxonomy.cwe.length === 0\n ? []\n : [`**CWE:** ${finding.taxonomy.cwe.join(\", \")}`]),\n \"\",\n \"## Scanned code\",\n \"\",\n `**Repository:** ${scan.target.displayName}`,\n ...(scan.target.remote === undefined\n ? []\n : [`**Remote:** ${scan.target.remote}`]),\n ...renderTargetIdentity(scan.target),\n `**Scanned scope:** ${scan.scope.includePaths.join(\", \") || \"entire repository\"}`,\n ...(scan.scope.excludePaths.length === 0\n ? []\n : [`**Excluded scope:** ${scan.scope.excludePaths.join(\", \")}`]),\n `**Coverage:** ${coverage.completeness}`,\n `**Coverage mode:** ${coverage.mode}`,\n `**Scan mode:** ${scanMode(coverage.mode)}`,\n `**Started:** ${scan.startedAt}`,\n `**Completed:** ${scan.completedAt}`,\n `**Uploaded:** ${uploadedAt}`,\n \"\",\n \"### Affected locations\",\n \"\",\n ...finding.locations.map((location) =>\n renderLocation(scan.target, location),\n ),\n );\n return `${lines.join(\"\\n\")}\\n`;\n}\n\nfunction renderTargetIdentity(target: ScanTargetRecord): string[] {\n const lines: string[] = [];\n if (target.revision !== undefined) {\n const label = target.kind === \"git_revision\" ? \"Revision\" : \"Base revision\";\n lines.push(`**${label}:** ${target.revision}`);\n }\n if (target.baseRevision !== undefined) {\n lines.push(`**Diff base revision:** ${target.baseRevision}`);\n }\n if (target.headRevision !== undefined) {\n lines.push(`**Diff head revision:** ${target.headRevision}`);\n }\n if (target.snapshotDigest !== undefined) {\n lines.push(`**Snapshot digest:** ${target.snapshotDigest}`);\n }\n return lines;\n}\n\nfunction scanMode(mode: LoadedContract[\"coverage\"][\"mode\"]): string {\n if (mode === \"deep_repository\") return \"deep\";\n if (mode === \"repository\") return \"standard\";\n return mode;\n}\n\nfunction renderLocation(\n target: ScanTargetRecord,\n location: FindingLocation,\n): string {\n const role =\n location.role === undefined ? \"Location\" : humanizeRole(location.role);\n const label = `${location.path}:${location.startLine}${\n location.endLine === undefined || location.endLine === location.startLine\n ? \"\"\n : `-${location.endLine}`\n }`;\n const sourceUrl = immutableSourceUrl(target, location);\n return `- **${role}:** ${sourceUrl === undefined ? `\\`${label}\\`` : `[\\`${label}\\`](${sourceUrl})`}`;\n}\n\nfunction renderCodeEvidence(\n target: ScanTargetRecord,\n evidence: FindingCodeEvidence,\n): string[] {\n const location: FindingLocation = {\n path: evidence.path,\n startLine: evidence.startLine,\n ...(evidence.endLine === undefined ? {} : { endLine: evidence.endLine }),\n ...(evidence.role === undefined ? {} : { role: evidence.role }),\n };\n return [\n `### ${evidence.label}`,\n \"\",\n renderLocation(target, location),\n \"\",\n fencedCode(evidence.code, evidence.language),\n \"\",\n evidence.explanation,\n ];\n}\n\nfunction humanizeRole(role: string): string {\n const words = role.replaceAll(\"_\", \" \");\n return `${words.slice(0, 1).toUpperCase()}${words.slice(1)}`;\n}\n\nfunction fencedCode(code: string, language?: string): string {\n let fenceLength = 3;\n for (const match of code.matchAll(/`+/g)) {\n fenceLength = Math.max(fenceLength, match[0].length + 1);\n }\n const fence = \"`\".repeat(fenceLength);\n const tag =\n language !== undefined && /^[A-Za-z0-9_+.-]+$/.test(language)\n ? language\n : \"\";\n return `${fence}${tag}\\n${code}\\n${fence}`;\n}\n\nfunction immutableSourceUrl(\n target: ScanTargetRecord,\n location: FindingLocation,\n): string | undefined {\n if (\n target.kind !== \"git_revision\" ||\n target.remote === undefined ||\n target.revision === undefined ||\n !/^(?:[a-f0-9]{40}|[a-f0-9]{64})$/i.test(target.revision) ||\n !isSafeRepositoryPath(location.path)\n ) {\n return undefined;\n }\n\n let remote: URL;\n try {\n remote = new URL(target.remote);\n } catch {\n return undefined;\n }\n if (\n remote.protocol !== \"https:\" ||\n (remote.hostname !== \"github.com\" && !remote.hostname.endsWith(\".ghe.com\"))\n ) {\n return undefined;\n }\n\n const repository = remote.pathname\n .replace(/\\.git\\/?$/, \"\")\n .replace(/\\/$/, \"\");\n const path = location.path.split(\"/\").map(encodeURIComponent).join(\"/\");\n remote.pathname = `${repository}/blob/${target.revision}/${path}`;\n remote.hash = `L${location.startLine}${\n location.endLine === undefined || location.endLine === location.startLine\n ? \"\"\n : `-L${location.endLine}`\n }`;\n return remote.toString();\n}\n\nfunction isSafeRepositoryPath(path: string): boolean {\n if (\n path.includes(\"\\\\\") ||\n /^[A-Za-z]:/.test(path) ||\n /[\\u0000-\\u001f\\u007f]/.test(path)\n ) {\n return false;\n }\n\n return path\n .split(\"/\")\n .every(\n (segment) =>\n segment.length > 0 &&\n segment !== \".\" &&\n segment !== \"..\" &&\n !/%(?:2e|2f|5c)/i.test(segment),\n );\n}\n"]}
package/dist/publish.d.ts CHANGED
@@ -114,4 +114,14 @@ export declare function publishScan(scanDirectory: string, options: PublishScanO
114
114
  export declare function publishScanInternal(scanDirectory: string, options: PublishScanOptions, dependencies?: PublishScanDependencies): Promise<PublishScanResult>;
115
115
  export declare function checkScanPublication(scanDirectory: string, options: CheckScanPublicationOptions): Promise<CheckScanPublicationResult>;
116
116
  export declare function checkScanPublicationInternal(scanDirectory: string, options: CheckScanPublicationOptions, dependencies?: CheckScanPublicationDependencies): Promise<CheckScanPublicationResult>;
117
+ interface ForceTerminationDependencies {
118
+ platform?: NodeJS.Platform;
119
+ systemRoot?: string;
120
+ runTaskkill?: (command: string, args: readonly string[]) => {
121
+ error?: Error;
122
+ status: number | null;
123
+ };
124
+ }
125
+ export declare function forceTerminatePublicationProcesses(dependencies?: ForceTerminationDependencies): void;
126
+ export {};
117
127
  //# sourceMappingURL=publish.d.ts.map