README.md

hashlock

---

Use it as a CLI to check hash files like something.txt.sha256:

hashlock check .

Or to generate hash lock files:

hashlock -a sha256 generate something.txt
# equivalent to `sha256sum something.txt > something.txt.sha256`

Or, use it as a GitHub Action:

- name: 'Check: Hashes'
  uses: sgammon/hashlock@v1

Or, use it as a library, from TypeScript or JavaScript:

{
  "devDependencies": {
    "hashlock": "..."
  }
}

import { checkHashes } from 'hashlock'

---

Usage: CLI

This package is also usable as a command line tool, under the name hashlock. The CLI is distributed on NPM as a JavaScript package, as well as here, on GitHub, as a standalone executable built by Bun.

Note

The CLI does not support Windows yet. Once Bun ships support for standalone Windows executables, this project will follow suit.

Installing the CLI

npm install -g hashlock
yarn install -g hashlock
pnpm install -g hashlock
bun install -g hashlock

Using the CLI

hashlock --help

Quick runs without installing

npx hashlock ...
yarnpkg hashlock ...
pnpm dlx hashlock ...
bun x hashlock ...

---

Usage: Actions

- name: 'Check: Hashes'
  uses: sgammon/hashlock@v1

This will check all files in your codebase that look like:

filename.ext
filename.ext.{md5,sha,sha1,sha256,sha512}

For example, say you have a hash file:

something.txt.sha256:

98ea6e4f216f2fb4b69fff9b3a44842c38686ca685f3f55dc48c5d3fb1107be4  something.txt

And you have the subject it asserts upon:

something.txt:

hi

This action will detect something.txt.sha256, find something.txt, hash it according to SHA-256, and make sure the two match.

Inputs

Input	Description	Default
paths	Paths to search under. See Paths.	.
strict	Activate strict mode. See below.	false
ignored	Paths to ignore. See Paths.	node_modules/
follow-symbolic-links	Controls link behavior with globs.	true
globs	Controls whether paths are interpreted as globs.	true
warn-only	Doesn't fail the build if hashes mismatch.	false

By default, the following cases will fail the action:

• There was a hash file, the subject file was found, the hash did not match
• There was a hash file, the subject file was not found
• There was a hash file, it was malformed or broken
• There was a hash file with no subject or the subject file is ambiguous

In strict mode, the following additional cases fail the action:

• There were no hash files found under any paths, or all of them were ignored

Examples

Fail if hash files are not found

Strict mode will fail if hash files are not found or all of them are ignored:

- name: 'Check: Hashes'
  uses: sgammon/hashlock@v1
  with:
    strict: true

Verify a specific set of hash files

Turn off globs to do that. Multi-line values are accepted for paths:

- name: 'Check: Hashes'
  uses: sgammon/hashlock@v1
  with:
    globs: false
    paths: |
      some/cool/hashfile.txt.sha256

Behavior

This section describes in detail how the action behaves.

Paths

By default, paths and ignored are treated as globs. Entries in ignored are actually just globbed against each algorithm, same as paths, but with ! prepended. So, for example:

- name: 'Check: Hashes'
  uses: sgammon/hashlock@v1
  with:
    paths: hello
    ignored: goodbye

The effective glob is:

hello/**/*.{md5,sha,sha1,sha256,sha512}
!goodbye

Literal paths mode

When you pass globs: false, the paths entries become regular literal paths:

- name: 'Check: Hashes'
  uses: sgammon/hashlock@v1
  with:
    paths: |
      hello.sha256
      djkhaledanotherone.sha256
    globs: false

The effective paths are:

hello.sha256
djkhaledanotherone.sha256

---

Usage: Library

This package is also usable as a JavaScript or TypeScript library. Simply install hashlock and you should have the main code + typings. The package ships with source maps as well.

---

Dependency Security

SLSA, Sigstore provenance, and SPDX are all supported by this package. All release artifacts are shipped with provenance metadata.