Localtoast is a scanner for running security-related configuration checks such as CIS benchmarks in an easily configurable manner.
The scanner can either be used as a standalone binary to scan the local machine or as 8000 a library with a custom wrapper to perform scans on e.g. container images or remote hosts.
makesudo ./localtoast --config=configs/example.textproto --result=scan-result.textproto
make configssudo ./localtoast --config=configs/full/cos_97/instance_scanning.textproto --result=scan-result.textproto
- Import
github.com/google/localtoast/scannerlibandgithub.com/google/localtoast/scanapiinto your Go project - Write a custom implementation for the
scanapi.ScanAPIinterface - Call
scannerlib.Scanner{}.Scan()with the appropriate config and the implementation
See the scan config and result protos for details on the input+output format.
To add your own checks to a scan config,
- Define the check in one of the definition files
- Example
- See the instruction proto for details on the instruction syntax
- Add a reference to the check in the scan config you want to extend
- Re-build the config file with
make configs - Use the re-generated config file in your scans, e.g.
sudo ./localtoast --config=configs/full/cos_97/instance_scanning.textproto --result=scan-result.textproto
Read how to contribute to Localtoast.
Localtoast is released under the Apache 2.0 license.
Copyright 2021 Google Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Localtoast is not an official Google product.