@greenarmor/ges-scanner-integration 0.3.1 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +61 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# @greenarmor/ges-scanner-integration
|
|
2
|
+
|
|
3
|
+
Security scanner integrations for the [Green Engineering Standard Framework (GESF)](https://github.com/greenarmor/gesf).
|
|
4
|
+
|
|
5
|
+
Wraps industry-standard security scanners — Trivy, Gitleaks, Semgrep, npm audit, and pnpm audit — into a unified interface with structured results.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @greenarmor/ges-scanner-integration
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Exports
|
|
14
|
+
|
|
15
|
+
| Export | Description |
|
|
16
|
+
|--------|-------------|
|
|
17
|
+
| `ScanResult` | Interface for scanner output (scanner name, status, findings, raw output) |
|
|
18
|
+
| `runNpmAudit()` | Run `npm audit` and parse results |
|
|
19
|
+
| `runPnpmAudit()` | Run `pnpm audit` and parse results |
|
|
20
|
+
| `runTrivy()` | Run Trivy container/filesystem scan |
|
|
21
|
+
| `runGitleaks()` | Run Gitleaks secret detection |
|
|
22
|
+
| `runSemgrep()` | Run Semgrep static analysis |
|
|
23
|
+
| `runAllScans()` | Run all available scanners and collect results |
|
|
24
|
+
| `formatScanResults(results)` | Format scan results as a human-readable summary |
|
|
25
|
+
|
|
26
|
+
## Usage
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import { runAllScans, formatScanResults } from '@greenarmor/ges-scanner-integration';
|
|
30
|
+
|
|
31
|
+
const results = runAllScans();
|
|
32
|
+
console.log(formatScanResults(results));
|
|
33
|
+
|
|
34
|
+
// Or run individual scanners
|
|
35
|
+
import { runGitleaks } from '@greenarmor/ges-scanner-integration';
|
|
36
|
+
const secrets = runGitleaks();
|
|
37
|
+
if (secrets.status === 'found') {
|
|
38
|
+
console.log(`Found ${secrets.findings.length} secrets`);
|
|
39
|
+
}
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Supported Scanners
|
|
43
|
+
|
|
44
|
+
| Scanner | Purpose | Requirement |
|
|
45
|
+
|---------|---------|-------------|
|
|
46
|
+
| npm audit | Dependency vulnerabilities | npm projects |
|
|
47
|
+
| pnpm audit | Dependency vulnerabilities | pnpm projects |
|
|
48
|
+
| Trivy | Container and filesystem scanning | Trivy installed |
|
|
49
|
+
| Gitleaks | Secret detection in Git history | Gitleaks installed |
|
|
50
|
+
| Semgrep | Static analysis for security patterns | Semgrep installed |
|
|
51
|
+
|
|
52
|
+
Scanners that are not installed are gracefully skipped with a `not_available` status.
|
|
53
|
+
|
|
54
|
+
## Related Packages
|
|
55
|
+
|
|
56
|
+
- [`@greenarmor/ges-core`](https://www.npmjs.com/package/@greenarmor/ges-core) — Types and constants
|
|
57
|
+
- [`@greenarmor/ges-cicd-generator`](https://www.npmjs.com/package/@greenarmor/ges-cicd-generator) — CI/CD workflow generation
|
|
58
|
+
|
|
59
|
+
## License
|
|
60
|
+
|
|
61
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@greenarmor/ges-scanner-integration",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.2",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "GESF Scanner Integration - Trivy, Gitleaks, Semgrep, npm audit",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
}
|
|
13
13
|
},
|
|
14
14
|
"dependencies": {
|
|
15
|
-
"@greenarmor/ges-core": "0.3.
|
|
15
|
+
"@greenarmor/ges-core": "0.3.2"
|
|
16
16
|
},
|
|
17
17
|
"devDependencies": {
|
|
18
18
|
"typescript": "^6.0.0",
|