Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lirantal/lockfile-lint

Lint an npm or yarn lockfile to analyze and detect security issues
https://github.com/lirantal/lockfile-lint

hacktoberfest lint linter lockfile lockfiles nodejs npm yarn

Last synced: 2 days ago
JSON representation

Lint an npm or yarn lockfile to analyze and detect security issues

Host: GitHub
URL: https://github.com/lirantal/lockfile-lint
Owner: lirantal
License: apache-2.0
Created: 2019-06-01T13:11:44.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2024-09-12T17:53:24.000Z (3 months ago)
Last Synced: 2024-10-29T15:18:11.572Z (about 1 month ago)
Topics: hacktoberfest, lint, linter, lockfile, lockfiles, nodejs, npm, yarn
Language: JavaScript
Homepage:
Size: 1.11 MB
Stars: 785
Watchers: 9
Forks: 35
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

awesome - lockfile-lint - Lint an npm or yarn lockfile to analyze and detect security issues (JavaScript)
awesome-npm - lockfile-lint - Lint lockfiles for improved security and trust policies to mitigate malicious package injection and insecure lockfile resources. (Packages / Other)
awesome-software-supply-chain-security - lirantal/lockfile-lint: Lint an npm or yarn lockfile to analyze and detect security issues
awesome-nodejs-security - lockfile-lint - lint lockfiles for improved security and trust policies to keep clean from malicious package injection and other insecure configurations. (Static Code Analysis)
awesome-npm - lockfile-lint - Lint lockfiles for improved security and trust policies to mitigate malicious package injection and insecure lockfile resources. (Packages / Other)
awesome-nodejs-security - lockfile-lint - lint lockfiles for improved security and trust policies to keep clean from malicious package injection and other insecure configurations. (Static Code Analysis)
awesome-linters - lockfile-lint - Lint an npm or (Linters / npm)

README

lockfile linting 🌈

lint lockfiles for improved security and trust policies

# About

Lockfiles are used as trusted whitelist of resources manifest to fetch packages from.
However, keeping track of the changes introduced to lockfiles is not an easy task as they are designed to be consumed by machines 🤖.

What happens when someone creates a Pull Request and sneaks a malicious resource package that replaces a real library? 😱

Exactly!
Lint your lockfiles to ensure they adhere to pre-defined security policies and mitigate this vector of attack.

**Why is this important?** read: [Why npm lockfiles can be a security blindspot for injecting malicious modules](https://snyk.io/blog/why-npm-lockfiles-can-be-a-security-blindspot-for-injecting-malicious-modules/)

# Learn Node.js Security

![Screenshot 2024-09-12 at 20 08 07](https://github.com/user-attachments/assets/970a97fd-16bd-4b3c-b535-ae7445b52d4c)

Learn Node.js Secure Coding techniques and best practices from Liran Tal

# Usage

Easily invoked with npx on any project and lint it:

```bash
npx lockfile-lint --path yarn.lock --allowed-hosts npm yarn --validate-https
```

To lint the npm-shrinkwrap.json file, add the `--type npm` flag:

```bash
npx lockfile-lint --path npm-shrinkwrap.json --type npm --allowed-hosts npm yarn --validate-https
```

If you get no results, congratulations, the file passes!

If lockfile-lint detects exceptions to the policies it will report them:

![carbon](https://user-images.githubusercontent.com/316371/59755684-09923200-9291-11e9-9add-6886dfc6689a.png)

Refer to [lockfile-lint](https://github.com/lirantal/lockfile-lint/tree/main/packages/lockfile-lint) for more details on the CLI usage.

You can use `lockfile-lint` as a standalone CLI tool, or as an API library using the following npm packages:

- [lockfile-lint](https://github.com/lirantal/lockfile-lint/tree/main/packages/lockfile-lint) - a CLI tool that can be easily integrated as a pre-commit hook or part of a CI/build
- [lockfile-lint-api](https://github.com/lirantal/lockfile-lint/tree/main/packages/lockfile-lint-api) - a library providing a programmatic API

## Security Disclaimer

Please be advised of the following security disclaimers that are outside of the control of a lockfile linter:

When you whitelist all hosts from npmjs, yarnpkg, github or other registries you implicitly convey that you trust all the packages originating from these sources. As such, a malicious package can exist in a registry source that you whitelist. Direct dependencies that you should add to a project should be well vetted before adding such as using a tool like [npq](https://github.com/lirantal/npq).

# References

- [Secure Nodejs Guidelines section on Lockfile Attack](https://securenodejsguidelines.ulisesgascon.com/attacks/lockfile-posioned)
- [pnpm's lockfile injection #4361](https://github.com/pnpm/pnpm/issues/4361)
- [yarn's lockfile injection #4136](https://github.com/yarnpkg/berry/discussions/4136)

# FAQ

## What about pnpm support?

pnpm doesn't maintain the tarball source of an npm package so unlike yarn, and npm, there's no way to inject an attacker-controlled malicious source file in `pnpm-lock.yaml`. Other vectors that were explored were to inject new packages into the lockfile (that aren't in `package.json`) yet pnpm isn't prone to these malicious attempts and would not install them.

If you have witnessed a possible attack vector on pnpm's lockfile, please open an issue with reproducible steps.

## How is this different from `npm audit`?

`npm audit` is a tool to audit your dependencies for known vulnerabilities. However, it doesn't address the issue of malicious packages being injected into your lockfile. `lockfile-lint` is a tool that is designed to address this issue.

# Author