Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zkat/srisum-rs
Compute and check subresource integrity digests.
https://github.com/zkat/srisum-rs
checksum digest shasum subresource-integrity
Last synced: about 1 month ago
JSON representation
Compute and check subresource integrity digests.
- Host: GitHub
- URL: https://github.com/zkat/srisum-rs
- Owner: zkat
- License: other
- Created: 2019-06-16T21:32:00.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-10-18T18:49:50.000Z (about 1 year ago)
- Last Synced: 2024-11-02T06:31:03.899Z (about 2 months ago)
- Topics: checksum, digest, shasum, subresource-integrity
- Language: Rust
- Homepage: https://crates.io/crates/srisum
- Size: 121 KB
- Stars: 14
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# srisum(1) -- compute and check subresource integrity digests
## SYNOPSIS
`$ srisum [OPTION]... [FILE]...`
## EXAMPLES
### Computing SRI Digests
For a single file:
```
$ srisum styles.css > styles.css.sri
```
For multiple different files:
```
$ srisum styles.css index.js package.json bundle.js > app.sri
```
From `stdin`:
```
$ cat styles.css | srisum -a sha1
sha1-hmkHOZdrfLUVOqpAgryfC8XNGtE -
```
Specify algorithms to generate:
```
$ srisum styles.css index.js --algorithms sha512 sha256 sha1 > styles.css.sri
```
### Checking Integrity
Passing checksum file as an argument:
```
$ srisum -c styles.css.sri
styles.css: OK (sha512)
```
Passing multiple checksum files:
```
$ srisum -c styles.css.sri js-files.sri
styles.css: OK (sha512)
index.js: OK (sha512)
lib/util.js: OK (sha512)
```
Checksum file from `stdin`:
```
$ cat styles.css.sri | srisum -c
styles.css: OK (sha512)
```
Checksum `stdin` itself:
```
$ echo "hello" | srisum > stdin.sri
$ echo "hello" | srisum -c stdin.sri
-: OK (sha512)
```
## DESCRIPTION
Print or check Subresource Integrity digests.
Spec: https://w3c.github.io/webappsec/specs/subresourceintegrity/
`srisum`'s API is based on the `SHA[N]SUM(1)` family of unix utilities.
With no `FILE` or when `FILE` is `-`, read standard input.
`-a, --algorithms [ALGO]...` - hash algorithms to generate for the `FILE`s
`-c, --check` - read SRI sums from the `FILE`s and check them
`-d, --digest-only` - only output the digest for each `FILE`, without filenames
`--help` - display help and exit
`--version` - output version information and exit
## The following options are useful only when verifying integrity:
`--ignore-missing` - don't fail or report status for missing files
`--quiet` - don't print OK for each successfully verified file
`--status` - don't output anything, status code shows success
`-w, --warn` - warn about improperly formatted SRI lines
When checking, the input should be a former output of this program. The default mode is to print line with space-separated SRI digests, one more space, and a name for each FILE.
Strict mode, enabled with `--strict`, will entirely ignore digests (in input and output) that fail all of the following conditions:
- `algorithms` must be one or more of: `sha1`, `sha256`, `sha384`, `sha512`
- digest strings must be valid `RFC4648` `Base64` strings.
## AUTHOR
Written by [Kat Marchán (@zkat)](https://github.com/zkat)
## CONTRIBUTING
The srisum team enthusiastically welcomes contributions and project
participation! There's a bunch of things you can do if you want to contribute!
The [Contributor Guide](CONTRIBUTING.md) has all the information you need for
everything from reporting bugs to contributing entire new features. Please
don't hesitate to jump in if you'd like to, or even ask us questions if
something isn't clear.
All participants and maintainers in this project are expected to follow [Code
of Conduct](CODE_OF_CONDUCT.md), and just generally be excellent to each
other.
Happy hacking!
## LICENSE
This project is licensed under [Apache-2.0](LICENSE-APACHE.md).