https://github.com/sans-sroc/integrity
Validation tool for SANS Courseware files. Generates and validates against a checksum file.
https://github.com/sans-sroc/integrity
checksums cli go golang
Last synced: 7 months ago
JSON representation
Validation tool for SANS Courseware files. Generates and validates against a checksum file.
- Host: GitHub
- URL: https://github.com/sans-sroc/integrity
- Owner: sans-sroc
- License: mit
- Created: 2020-12-30T16:37:52.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-02-12T20:29:19.000Z (8 months ago)
- Last Synced: 2025-02-12T21:31:14.828Z (8 months ago)
- Topics: checksums, cli, go, golang
- Language: Go
- Homepage:
- Size: 3.93 MB
- Stars: 18
- Watchers: 5
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Integrity
## Overview
File validation at it's finest.
## Help
```help
NAME:
integrity - integrity
USAGE:
integrity [global options] command [command options] [arguments...]
AUTHORS:
Ryan Nicholson
Don Williams
Erik Kristensen
COMMANDS:
create create integrity files
validate validate integrity files
version print version
GLOBAL OPTIONS:
--help, -h show help (default: false)
```
### Create
```help
NAME:
integrity create - create integrity files
USAGE:
integrity create [command options] [arguments...]
OPTIONS:
--name value, -n value The name that will be given to the ISO volume during USB creation. [$NAME]
--user value, -u value allow setting what user created the file (default: "ekristen") [$USER]
--log-level value, -l value Log Level (default: "info") [$LOG_LEVEL]
--directory value, -d value The directory that will be the current working directory for the tool when it runs (default: ".") [$DIRECTORY]
--help, -h show help (default: false)
```
### Validate
```help
NAME:
integrity validate - validate integrity files
USAGE:
integrity validate [command options] [arguments...]
OPTIONS:
--output-format value, --format value Chose which format to output the validation results (default is none) (valid options: none, json) (default: "none") [$OUTPUT_FORMAT]
--output value, -o value When output-format is specified, this controls where it goes, (defaults to stdout) (default: "-") [$OUTPUT]
--log-level value, -l value Log Level (default: "info") [$LOG_LEVEL]
--directory value, -d value The directory that will be the current working directory for the tool when it runs (default: ".") [$DIRECTORY]
--help, -h show help (default: false)
```
#### Validate Output
The validate output options change the behavior of the too slightly.
If the `--output-format` is set to `json` and the `--log-level` has not been set to `none` it will write all logs to `STDERR` while the JSON format is written to `STDOUT`, this is to allow the capture of the `json` separately from the log output.
## Examples
### Simple Create
```bash
integrity create -n 572.00.0
```
### Create w/ Specified Directory
```bash
integrity create -n 572.00.0 -d /tmp
```
### Simple Validate
**Note:** this assumes the create was run in the current working directory and `sans-integrity.yml` already exists.
```bash
integrity validate
```
### Validate w/ Specified Directory
```bash
integrity validate -d /tmp
```
### Validate w/ JSON Output
**Note:** this is really only useful for programmatic validation purposes.
```bash
integrity validate --output-format json
```
### Validate w/ JSON Output to File
**Note:** this is really only useful for programmatic validation purposes.
```bash
integrity validate --output-format json --output results.json
```
## Building
Requires [goreleaser](https://goreleaser.com/) to build the binaries.
To simply build for development purposes:
```bash
goreleaser build --clean --snapshot
```
## Development
There are go modules included on this project, so you will need to make sure you run `go mod vendor` to bring them to
your local directory if you are using the Makefile as the makefile prefers the use of the vendor directory.
If you are simply running `go run main.go` the modules will be pulled from vendor or your go root depending on where it
finds it. Golang will also automatically pull the mods down when you run if there are changes.
During iterative updates if the modules change you will find yourself needing to run `go mod vendor` or at least
`go mod download` to ensure you have the updated modules locally.
### Ignore Files
There are two types of ignore files. `IgnoreOnCreate` and `IgnoreAlways`, both are defined in [pkg/common/constants.go](pkg/common/constants.go).
Files that should go in the `IgnoreOnCreate` are things like `.DS_Store`, whereas files that should go into
`IgnoreAlways` is the `sans-integrity.yml` and `sans-integrity.yml.gpg`
Changing the ignore files will require a new release of the tool.
**Note:** to aid developers, the option `-i` is present that allows you to pass a custom ignore strictly for development
purposes while testing and developing on the tool. This is useful when needing to ensure the validation tool is properly
picking up files that are not in the file.