README
¶
sops-check
[!NOTE] This project is still in an early development stage and a lot of the desired features are not implemented yet.
Check SOPS files for correct and compliant usage without decrypting them to ensure that all SOPS files are configured in the desired fashion. The goal is to provide a security linter that safeguards the security of the data protected by the SOPS files against common mistakes and against malicious configurations.
We are following a design-first approach, please take a look at the design document. We are happy to hear your thoughts about it.
Installation
The simplest way is to install the latest version via:
go install github.com/Bonial-International-GmbH/sops-check@latest
Finally, consult the help for usage instructions:
sops-check --help
Development
Run the tests:
make coverage
Lint the codebase:
make lint
Build locally:
make build
License
The source code of sops-check is released under the Apache License, Version 2.0. See the bundled LICENSE file for details.
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
config
Package config provides utility functions for the sops-check.
|
Package config provides utility functions for the sops-check. |
|
rules
Package rules contains the interface for the rule engine and all supported rule types together with their rule evaluation logic.
|
Package rules contains the interface for the rule engine and all supported rule types together with their rule evaluation logic. |