@opensip-cli/tool-gitleaks 0.1.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/NOTICE +8 -0
- package/README.md +33 -0
- package/dist/__tests__/parse-gitleaks-json.test.d.ts +7 -0
- package/dist/__tests__/parse-gitleaks-json.test.d.ts.map +1 -0
- package/dist/__tests__/parse-gitleaks-json.test.js +100 -0
- package/dist/__tests__/parse-gitleaks-json.test.js.map +1 -0
- package/dist/__tests__/suite-step-e2e.test.d.ts +48 -0
- package/dist/__tests__/suite-step-e2e.test.d.ts.map +1 -0
- package/dist/__tests__/suite-step-e2e.test.js +262 -0
- package/dist/__tests__/suite-step-e2e.test.js.map +1 -0
- package/dist/__tests__/tool.test.d.ts +11 -0
- package/dist/__tests__/tool.test.d.ts.map +1 -0
- package/dist/__tests__/tool.test.js +197 -0
- package/dist/__tests__/tool.test.js.map +1 -0
- package/dist/__tests__/worker-e2e.test.d.ts +28 -0
- package/dist/__tests__/worker-e2e.test.d.ts.map +1 -0
- package/dist/__tests__/worker-e2e.test.js +425 -0
- package/dist/__tests__/worker-e2e.test.js.map +1 -0
- package/dist/index.d.ts +11 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +11 -0
- package/dist/index.js.map +1 -0
- package/dist/parse-gitleaks-json.d.ts +26 -0
- package/dist/parse-gitleaks-json.d.ts.map +1 -0
- package/dist/parse-gitleaks-json.js +88 -0
- package/dist/parse-gitleaks-json.js.map +1 -0
- package/dist/tool.d.ts +74 -0
- package/dist/tool.d.ts.map +1 -0
- package/dist/tool.js +140 -0
- package/dist/tool.js.map +1 -0
- package/package.json +142 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
OpenSIP CLI
|
|
2
|
+
Copyright 2026 opensip-ai
|
|
3
|
+
|
|
4
|
+
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
|
|
5
|
+
this software except in compliance with the License. A copy of the License is
|
|
6
|
+
included in the LICENSE file and is also available at:
|
|
7
|
+
|
|
8
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
package/README.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
<!-- Generated by scripts/build-package-readmes.mjs — do not edit by hand.
|
|
2
|
+
Change the package's "description" (or the generator template) and run
|
|
3
|
+
`pnpm docs:readmes`. CI enforces sync via `pnpm docs:readmes:check`. -->
|
|
4
|
+
|
|
5
|
+
# @opensip-cli/tool-gitleaks
|
|
6
|
+
|
|
7
|
+
> External Tool Adapter for Gitleaks — wraps the gitleaks secret scanner as an opensip-cli tool (opensip gitleaks / opensip secrets)
|
|
8
|
+
|
|
9
|
+
This package is the **engine** behind a first-party `opensip-cli` tool. The CLI bundles it — you do not normally install it directly.
|
|
10
|
+
|
|
11
|
+
Part of [**opensip-cli**](https://github.com/opensip-ai/opensip-cli) — an open-source codebase intelligence CLI: fitness checks (`fit`), static call-graph analysis (`graph`), simulation (`sim`), and advisory reduction audits (`yagni`).
|
|
12
|
+
|
|
13
|
+
**Distribution model:** the published `opensip-cli` npm package is a full-stack bundle of first-party tools, check packs, and language adapters. Third-party tools install separately via the `opensipTools` manifest and host allowlist; a slim install without bundled tools is not a current goal.
|
|
14
|
+
|
|
15
|
+
## Install
|
|
16
|
+
|
|
17
|
+
Most users install the CLI, which bundles the first-party tools:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
curl -fsSL https://opensip.ai/cli/install.sh | bash
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
This package is published for the CLI and advanced plugin authors; most users should not install `@opensip-cli/tool-gitleaks` directly.
|
|
24
|
+
|
|
25
|
+
## Documentation
|
|
26
|
+
|
|
27
|
+
- 📚 Project docs: https://opensip.ai/docs/opensip-cli/
|
|
28
|
+
- 🧭 Package catalog (what every package does): https://github.com/opensip-ai/opensip-cli/blob/v0.1.15/docs/public/70-reference/02-package-catalog.md
|
|
29
|
+
- 📦 Source: https://github.com/opensip-ai/opensip-cli/tree/v0.1.15/packages/tool-gitleaks
|
|
30
|
+
|
|
31
|
+
## License
|
|
32
|
+
|
|
33
|
+
Apache-2.0 © opensip-ai
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Tier-1 (in-process) unit tests for the gitleaks JSON parser + redaction
|
|
3
|
+
* (ADR-0090 D6 Tier 1). The committed golden drives the normalized-signal golden;
|
|
4
|
+
* a dedicated case proves NO raw `Secret`/`Match` substring survives normalization.
|
|
5
|
+
*/
|
|
6
|
+
export {};
|
|
7
|
+
//# sourceMappingURL=parse-gitleaks-json.test.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"parse-gitleaks-json.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/parse-gitleaks-json.test.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Tier-1 (in-process) unit tests for the gitleaks JSON parser + redaction
|
|
3
|
+
* (ADR-0090 D6 Tier 1). The committed golden drives the normalized-signal golden;
|
|
4
|
+
* a dedicated case proves NO raw `Secret`/`Match` substring survives normalization.
|
|
5
|
+
*/
|
|
6
|
+
import { readFileSync } from 'node:fs';
|
|
7
|
+
import { fileURLToPath } from 'node:url';
|
|
8
|
+
import { normalizedSignalShape } from '@opensip-cli/external-tool-adapter';
|
|
9
|
+
import { describe, expect, it } from 'vitest';
|
|
10
|
+
import { parseGitleaksJson } from '../parse-gitleaks-json.js';
|
|
11
|
+
const GOLDEN_RAW = readFileSync(fileURLToPath(new URL('../../__fixtures__/gitleaks-golden.json', import.meta.url)), 'utf8');
|
|
12
|
+
const EXPECTED = JSON.parse(readFileSync(fileURLToPath(new URL('../../__fixtures__/expected-signals.json', import.meta.url)), 'utf8'));
|
|
13
|
+
// The matched-credential strings the parser must NEVER let escape (the golden's
|
|
14
|
+
// `Secret` and `Match` values).
|
|
15
|
+
const RAW_SECRETS = ['AKIAIOSFODNN7EXAMPLE', 'glpat-XXXXXXXXXXXXXXXXXXXX', 'aws_key = AKIA'];
|
|
16
|
+
/** A minimal context — the gitleaks parser ignores it entirely. */
|
|
17
|
+
const CTX = { tool: 'gitleaks' };
|
|
18
|
+
function parsed(raw) {
|
|
19
|
+
let json;
|
|
20
|
+
try {
|
|
21
|
+
json = JSON.parse(raw);
|
|
22
|
+
}
|
|
23
|
+
catch {
|
|
24
|
+
json = undefined;
|
|
25
|
+
}
|
|
26
|
+
return { kind: 'json', raw, ...(json === undefined ? {} : { json }) };
|
|
27
|
+
}
|
|
28
|
+
describe('parseGitleaksJson', () => {
|
|
29
|
+
it('normalizes the golden to the expected signal shapes', () => {
|
|
30
|
+
const signals = parseGitleaksJson(parsed(GOLDEN_RAW), CTX);
|
|
31
|
+
expect(signals.map(normalizedSignalShape)).toEqual(EXPECTED);
|
|
32
|
+
});
|
|
33
|
+
it('maps every secret to a high-severity security signal from gitleaks', () => {
|
|
34
|
+
const signals = parseGitleaksJson(parsed(GOLDEN_RAW), CTX);
|
|
35
|
+
expect(signals).toHaveLength(2);
|
|
36
|
+
for (const s of signals) {
|
|
37
|
+
expect(s.severity).toBe('high');
|
|
38
|
+
expect(s.category).toBe('security');
|
|
39
|
+
expect(s.source).toBe('gitleaks');
|
|
40
|
+
}
|
|
41
|
+
});
|
|
42
|
+
it('carries native metadata (fingerprint, entropy, tags) and a NULL native severity', () => {
|
|
43
|
+
const [first] = parseGitleaksJson(parsed(GOLDEN_RAW), CTX);
|
|
44
|
+
expect(first?.metadata).toMatchObject({
|
|
45
|
+
nativeFingerprint: 'config/prod.env:aws-access-token:12',
|
|
46
|
+
entropy: 3.65,
|
|
47
|
+
tags: ['key', 'AWS'],
|
|
48
|
+
nativeSeverity: null,
|
|
49
|
+
});
|
|
50
|
+
});
|
|
51
|
+
it('REDACTS the raw secret to a short preview and never leaks Secret/Match', () => {
|
|
52
|
+
const signals = parseGitleaksJson(parsed(GOLDEN_RAW), CTX);
|
|
53
|
+
// The preview is a 4-char + ellipsis mask, never the full credential.
|
|
54
|
+
expect(signals[0]?.metadata.secretPreview).toBe('AKIA…');
|
|
55
|
+
expect(signals[1]?.metadata.secretPreview).toBe('glpa…');
|
|
56
|
+
// No raw secret/match substring anywhere in the serialized signals.
|
|
57
|
+
const serialized = JSON.stringify(signals);
|
|
58
|
+
for (const raw of RAW_SECRETS) {
|
|
59
|
+
expect(serialized).not.toContain(raw);
|
|
60
|
+
}
|
|
61
|
+
// And the `Match` field is dropped entirely (never copied to metadata).
|
|
62
|
+
expect(serialized).not.toContain('"Match"');
|
|
63
|
+
expect(serialized.toLowerCase()).not.toContain('aws_key =');
|
|
64
|
+
});
|
|
65
|
+
it('returns [] for a clean run (empty array)', () => {
|
|
66
|
+
expect(parseGitleaksJson(parsed('[]'), CTX)).toEqual([]);
|
|
67
|
+
});
|
|
68
|
+
it('returns [] for malformed JSON (never throws)', () => {
|
|
69
|
+
expect(parseGitleaksJson({ kind: 'json', raw: 'not json{' }, CTX)).toEqual([]);
|
|
70
|
+
});
|
|
71
|
+
it('returns [] when the document is not an array', () => {
|
|
72
|
+
expect(parseGitleaksJson(parsed('{"results":[]}'), CTX)).toEqual([]);
|
|
73
|
+
});
|
|
74
|
+
it('skips non-object array entries', () => {
|
|
75
|
+
const signals = parseGitleaksJson(parsed('["nope", 42, null]'), CTX);
|
|
76
|
+
expect(signals).toEqual([]);
|
|
77
|
+
});
|
|
78
|
+
it('applies defensive fallbacks for a finding missing RuleID/Description/File and omits absent line/column', () => {
|
|
79
|
+
const signals = parseGitleaksJson(parsed('[{"Secret":"x"}]'), CTX);
|
|
80
|
+
expect(signals).toHaveLength(1);
|
|
81
|
+
const [s] = signals;
|
|
82
|
+
expect(s?.ruleId).toBe('gitleaks-secret');
|
|
83
|
+
expect(s?.message).toBe('Secret detected (gitleaks-secret)');
|
|
84
|
+
expect(s?.filePath).toBe('');
|
|
85
|
+
expect(s?.line).toBeUndefined();
|
|
86
|
+
expect(s?.column).toBeUndefined();
|
|
87
|
+
// A 1-char secret collapses to the bare ellipsis (never the raw value).
|
|
88
|
+
expect(s?.metadata.secretPreview).toBe('…');
|
|
89
|
+
});
|
|
90
|
+
it('omits secretPreview entirely when no Secret field is present', () => {
|
|
91
|
+
const [s] = parseGitleaksJson(parsed('[{"RuleID":"r","File":"f"}]'), CTX);
|
|
92
|
+
expect(s?.metadata).not.toHaveProperty('secretPreview');
|
|
93
|
+
});
|
|
94
|
+
it('parses from raw bytes when the descriptor has no pre-parsed json', () => {
|
|
95
|
+
// The acceptance-harness path passes only raw; the parser must still work.
|
|
96
|
+
const signals = parseGitleaksJson({ kind: 'json', raw: GOLDEN_RAW }, CTX);
|
|
97
|
+
expect(signals).toHaveLength(2);
|
|
98
|
+
});
|
|
99
|
+
});
|
|
100
|
+
//# sourceMappingURL=parse-gitleaks-json.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"parse-gitleaks-json.test.js","sourceRoot":"","sources":["../../src/__tests__/parse-gitleaks-json.test.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAI9D,MAAM,UAAU,GAAG,YAAY,CAC7B,aAAa,CAAC,IAAI,GAAG,CAAC,yCAAyC,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAClF,MAAM,CACP,CAAC;AACF,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CACzB,YAAY,CACV,aAAa,CAAC,IAAI,GAAG,CAAC,0CAA0C,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EACnF,MAAM,CACP,CACW,CAAC;AAEf,gFAAgF;AAChF,gCAAgC;AAChC,MAAM,WAAW,GAAG,CAAC,sBAAsB,EAAE,4BAA4B,EAAE,gBAAgB,CAAC,CAAC;AAE7F,mEAAmE;AACnE,MAAM,GAAG,GAAG,EAAE,IAAI,EAAE,UAAU,EAAkC,CAAC;AAEjE,SAAS,MAAM,CAAC,GAAW;IACzB,IAAI,IAAa,CAAC;IAClB,IAAI,CAAC;QACH,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAY,CAAC;IACpC,CAAC;IAAC,MAAM,CAAC;QACP,IAAI,GAAG,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;AACxE,CAAC;AAED,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC7D,MAAM,OAAO,GAAG,iBAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,CAAC;QAC3D,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oEAAoE,EAAE,GAAG,EAAE;QAC5E,MAAM,OAAO,GAAG,iBAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,CAAC;QAC3D,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAChC,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;YACxB,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAChC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACpC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACpC,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iFAAiF,EAAE,GAAG,EAAE;QACzF,MAAM,CAAC,KAAK,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,CAAC;QAC3D,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,aAAa,CAAC;YACpC,iBAAiB,EAAE,qCAAqC;YACxD,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;YACpB,cAAc,EAAE,IAAI;SACrB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wEAAwE,EAAE,GAAG,EAAE;QAChF,MAAM,OAAO,GAAG,iBAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,CAAC;QAC3D,sEAAsE;QACtE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEzD,oEAAoE;QACpE,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC3C,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;YAC9B,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACxC,CAAC;QACD,wEAAwE;QACxE,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC5C,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACjF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACxC,MAAM,OAAO,GAAG,iBAAiB,CAAC,MAAM,CAAC,oBAAoB,CAAC,EAAE,GAAG,CAAC,CAAC;QACrE,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wGAAwG,EAAE,GAAG,EAAE;QAChH,MAAM,OAAO,GAAG,iBAAiB,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,GAAG,CAAC,CAAC;QACnE,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAChC,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;QACpB,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC1C,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;QAC7D,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7B,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,aAAa,EAAE,CAAC;QAChC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,aAAa,EAAE,CAAC;QAClC,wEAAwE;QACxE,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACtE,MAAM,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC,6BAA6B,CAAC,EAAE,GAAG,CAAC,CAAC;QAC1E,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;QAC1E,2EAA2E;QAC3E,MAAM,OAAO,GAAG,iBAAiB,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE,GAAG,CAAC,CAAC;QAC1E,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 04↔05 integration E2E — an EXTERNAL tool adapter (plan 04) runs as a host-owned
|
|
3
|
+
* SUITE step (plan 05 / ADR-0093) over the REAL forked-worker boundary, end-to-end
|
|
4
|
+
* against the BUILT CLI.
|
|
5
|
+
*
|
|
6
|
+
* This locks in the seam between the two planes that otherwise only meet at run
|
|
7
|
+
* time: the gitleaks adapter is an installed, EXTERNAL-provenance tool, so when it
|
|
8
|
+
* appears as a `suites:` step the orchestrator's `maybeDispatchExternal` hook MUST
|
|
9
|
+
* fork the ADR-0054 worker (it never runs the untrusted runtime in-host), and the
|
|
10
|
+
* worker's verdict MUST flow back into the suite's worst-of exit aggregation.
|
|
11
|
+
*
|
|
12
|
+
* The harness mirrors `worker-e2e.test.ts` (least-effort path): the REAL gitleaks
|
|
13
|
+
* package is presented as an installed npm tool (symlinked into the throwaway
|
|
14
|
+
* project's `node_modules` so the worker resolves its `@opensip-cli/*` workspace
|
|
15
|
+
* deps via realpath), a FAKE `gitleaks` on PATH makes the scan deterministic (copy
|
|
16
|
+
* the committed golden to `--report-path`, exit 1 like real gitleaks on findings),
|
|
17
|
+
* and `OPENSIP_CLI_ALLOW_INSTALLED_TOOLS` trusts it (installed tools are
|
|
18
|
+
* deny-by-default). The fake's golden path rides the documented
|
|
19
|
+
* `OPENSIP_CLI_TOOL_ENV_PASSTHROUGH` into the worker fork's curated env.
|
|
20
|
+
*
|
|
21
|
+
* What it proves:
|
|
22
|
+
* - `suite add security --tool gitleaks --command gitleaks` resolves the tool
|
|
23
|
+
* NAME to its canonical `ToolMetadata.id` UUID in `opensip-cli.config.yml`.
|
|
24
|
+
* - `suite run security` dispatches the step through the forked worker: the raw
|
|
25
|
+
* artifact lands at `.runtime/artifacts/gitleaks/<runId>/gitleaks.json`
|
|
26
|
+
* (mode 0600 in a 0700 dir) — the worker boundary actually ran the scan.
|
|
27
|
+
* - the gitleaks findings verdict propagates into the suite worst-of exit
|
|
28
|
+
* (the 2 fixture secrets trip the findings gate ⇒ the suite exits non-zero,
|
|
29
|
+
* the step summary records exit 1).
|
|
30
|
+
* - the run persists under the suite grouping (`suiteRunId` / `suiteName`) with
|
|
31
|
+
* the gitleaks verdict + finding count.
|
|
32
|
+
* - the secret-egress guarantee STILL holds inside a suite (no raw `Secret`/
|
|
33
|
+
* `Match` reaches the emitted output; only the masked preview survives).
|
|
34
|
+
* - deny-by-default STILL applies in suite context: WITHOUT the trust env the
|
|
35
|
+
* step is denied (non-zero exit, no artifact, no session) — it never silently
|
|
36
|
+
* succeeds.
|
|
37
|
+
*
|
|
38
|
+
* Requires `pnpm build` first (the CLI dist + the gitleaks dist). Missing builds
|
|
39
|
+
* FAIL loudly (no silent skip).
|
|
40
|
+
*
|
|
41
|
+
* NOTE on the step command name: the adapter declares its scan command as `scan`,
|
|
42
|
+
* but `defineExternalToolAdapter` makes the first command the PRIMARY, which
|
|
43
|
+
* `defineTool` names from `identity.name` — so the resolvable `commandSpecs` name
|
|
44
|
+
* (and the suite step `command`) is `gitleaks`, not `scan`. `suite add --command
|
|
45
|
+
* scan` is rejected (`CONFIG.SUITE_ADD.UNKNOWN_COMMAND`, exit 2).
|
|
46
|
+
*/
|
|
47
|
+
export {};
|
|
48
|
+
//# sourceMappingURL=suite-step-e2e.test.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"suite-step-e2e.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/suite-step-e2e.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG"}
|