cve-lite-cli 1.12.0 → 1.12.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +48 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -375,6 +375,52 @@ npm install
|
|
|
375
375
|
npm run build
|
|
376
376
|
```
|
|
377
377
|
|
|
378
|
+
## Governance
|
|
379
|
+
|
|
380
|
+
CVE Lite CLI is an OWASP Incubator Project maintained by Sonu Kapoor as project lead. The project follows a single-maintainer (benevolent dictator) governance model. The project lead makes final decisions on scope, design direction, and releases after considering input from contributors and the wider community.
|
|
381
|
+
|
|
382
|
+
### Roles
|
|
383
|
+
|
|
384
|
+
- **Project lead** — currently Sonu Kapoor. Owns the roadmap, sets release cadence, reviews and merges pull requests, and acts as the OWASP project leader for the Foundation.
|
|
385
|
+
- **Contributors** — anyone who opens an issue, proposes a pull request, or improves the documentation. No prior commit history is required to contribute, and contributions are welcome from outside OWASP.
|
|
386
|
+
|
|
387
|
+
### Decision-making
|
|
388
|
+
|
|
389
|
+
- Significant changes (new features, breaking changes, scope decisions) start as a GitHub issue so the design can be discussed in public before code is written.
|
|
390
|
+
- Pull requests are reviewed by the project lead. Small fixes can land directly. Larger changes may require revision or follow-up issues.
|
|
391
|
+
- Releases are cut by the project lead when accumulated changes warrant a version bump, following the process in [CONTRIBUTING.md](https://github.com/OWASP/cve-lite-cli/blob/main/src/docs/CONTRIBUTING.md).
|
|
392
|
+
|
|
393
|
+
### Dispute resolution
|
|
394
|
+
|
|
395
|
+
Technical disagreements are resolved by the project lead after weighing contributor input. Disputes that relate to community standards or [Code of Conduct](https://github.com/OWASP/cve-lite-cli/blob/main/CODE_OF_CONDUCT.md) enforcement can be escalated to the OWASP Foundation, which acts as a backstop for the project's community norms.
|
|
396
|
+
|
|
397
|
+
This governance model may evolve as the contributor base grows. Any change to the model will be documented here and announced via the GitHub repository.
|
|
398
|
+
|
|
399
|
+
## Security and verification
|
|
400
|
+
|
|
401
|
+
CVE Lite CLI signs both the source code release and the build artifact for each release. Either signature is sufficient on its own.
|
|
402
|
+
|
|
403
|
+
**Source code (signed git tags).** Starting with releases after v1.12.1, every release tag is a GPG-signed annotated tag. The project lead's public key is published at [`https://github.com/sonukapoor.gpg`](https://github.com/sonukapoor.gpg). The private key is held only on the project lead's local machine — not on GitHub, not on the npm registry, not in CI. Verify with:
|
|
404
|
+
|
|
405
|
+
```bash
|
|
406
|
+
curl -sSL https://github.com/sonukapoor.gpg | gpg --import
|
|
407
|
+
git tag -v vX.Y.Z
|
|
408
|
+
```
|
|
409
|
+
|
|
410
|
+
**Release tarball (Sigstore Artifact Attestations).** Each GitHub release attaches an `cve-lite-cli-X.Y.Z.tgz` asset signed at build time via [GitHub Artifact Attestations](https://docs.github.com/en/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). The signing keys are ephemeral OIDC-issued keys generated per build, providing SLSA Level 2 equivalent build provenance. Verify with:
|
|
411
|
+
|
|
412
|
+
```bash
|
|
413
|
+
gh attestation verify cve-lite-cli-X.Y.Z.tgz --repo OWASP/cve-lite-cli
|
|
414
|
+
```
|
|
415
|
+
|
|
416
|
+
**npm-installed package.** The npm registry adds an ECDSA signature to every published package, independent of the project's own signing keys above:
|
|
417
|
+
|
|
418
|
+
```bash
|
|
419
|
+
npm audit signatures
|
|
420
|
+
```
|
|
421
|
+
|
|
422
|
+
For full verification details, fingerprints, and security issue reports, see [SECURITY.md](https://github.com/OWASP/cve-lite-cli/blob/main/src/docs/SECURITY.md). For the project's threat model, trust boundaries, and how common implementation weaknesses are countered, see the [Security Assurance Case](https://owasp.org/cve-lite-cli/docs/security-assurance-case).
|
|
423
|
+
|
|
378
424
|
## Contributing
|
|
379
425
|
|
|
380
426
|
Feedback on output clarity, remediation guidance, ecosystem coverage, and CI usage is especially valuable.
|
|
@@ -399,6 +445,8 @@ Helpful feedback includes reproducible bug reports, real-world lockfile edge cas
|
|
|
399
445
|
|
|
400
446
|
For security-related reporting: [SECURITY.md](https://github.com/OWASP/cve-lite-cli/blob/main/src/docs/SECURITY.md)
|
|
401
447
|
|
|
448
|
+
This project follows a [Code of Conduct](https://github.com/OWASP/cve-lite-cli/blob/main/CODE_OF_CONDUCT.md). Please review it before participating.
|
|
449
|
+
|
|
402
450
|
If CVE Lite CLI helps your release workflow, a [GitHub star](https://github.com/OWASP/cve-lite-cli) helps more developers find it.
|
|
403
451
|
|
|
404
452
|
---
|