localtoast

command module

v1.1.7 Latest Latest Go to latest Published: Feb 26, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/google/localtoast

Links

Open Source Insights

README ¶

Localtoast

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 a library with a custom wrapper to perform scans on e.g. container images or remote hosts.

How to use

As a standalone binary:

Install the build deps
make
sudo ./localtoast --config=configs/example.textproto --result=scan-result.textproto

Build and use OS-specific configs:

make configs
sudo ./localtoast --config=configs/full/cos_97/instance_scanning.textproto --result=scan-result.textproto

Build and run Localtoast with SQL scanning capabilities:

make configs
make localtoast_sql
sudo localtoast_sql/localtoast_sql --config=configs/full/cassandra-cql/instance_scanning.textproto --result=scan-result.textproto --cassandra-database=localhost:9042

As a library:

Import github.com/google/localtoast/scannerlib and github.com/google/localtoast/scanapi into your Go project
Write a custom implementation for the scanapi.ScanAPI interface
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.

Defining custom checks

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

Example

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

Build dependencies

To build Localtoast, you'll need to have the following installed:

go: Follow https://go.dev/doc/install
protoc: Install the appropriate package, e.g. apt install protobuf-compiler
protoc-gen-go: Run go install google.golang.org/protobuf/cmd/protoc-gen-go

Contributing

Read how to contribute to Localtoast.

License

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.

Disclaimers

Localtoast is not an official Google product.

Documentation ¶

Overview ¶

The localtoast command wraps around the scanner library to create a standalone CLI for the config scanner with direct access to the local machine's filesystem.

Source Files ¶

View all Source files

localtoast.go

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
cli
configs
genfullconfig The gen_full_config command creates full per-OS scan config files by combining the config definition and the reduced config files.	The gen_full_config command creates full per-OS scan config files by combining the config definition and the reduced config files.
genfullconfig/genfullconfiglib Package genfullconfiglib creates full per-OS scan config files by combining the config definition and the reduced config files.	Package genfullconfiglib creates full per-OS scan config files by combining the config definition and the reduced config files.
cqlquerier Package cqlquerier provides an utility function for running CQL queries.	Package cqlquerier provides an utility function for running CQL queries.
elsquerier Package elsquerier provides an utility function for running ElasticSearch queries.	Package elsquerier provides an utility function for running ElasticSearch queries.
fakedb Package fakedb provides a minimal fake implementation for a database/sql database, to be used in tests.	Package fakedb provides a minimal fake implementation for a database/sql database, to be used in tests.
localfilereader Package localfilereader provides utility functions for reading files and permissions from the local filesystem.	Package localfilereader provides utility functions for reading files and permissions from the local filesystem.
localtoast_sql The cis_scanner command wraps around the scanner library to create a standalone CLI for the scanner with direct access to the local machine's filesystem.	The cis_scanner command wraps around the scanner library to create a standalone CLI for the scanner with direct access to the local machine's filesystem.
protofilehandler Package protofilehandler provides a utility for reading and writing protos into zipped or unzipped textproto or binproto files.	Package protofilehandler provides a utility for reading and writing protos into zipped or unzipped textproto or binproto files.
scanapi Package scanapi defines the Localtoast scan API used to provide access to a local or remote filesystem and database to perform scans.	Package scanapi defines the Localtoast scan API used to provide access to a local or remote filesystem and database to perform scans.
scannercommon Package scannercommon provides the common functions used by the scanner binaries.	Package scannercommon provides the common functions used by the scanner binaries.
scannerlib Package scannerlib provides an interface for running compliance and config security checks on a machine.	Package scannerlib provides an interface for running compliance and config security checks on a machine.
configchecks Package configchecks provides the implementation of the various checks the scanner can perform behind a single general interface.	Package configchecks provides the implementation of the various checks the scanner can perform behind a single general interface.
fileset Package fileset provides a utility for resolving the file paths defined by a FileSet proto.	Package fileset provides a utility for resolving the file paths defined by a FileSet proto.
repeatconfig Package repeatconfig provides a utility for applying the RepeatConfig proto to config checks.	Package repeatconfig provides a utility for applying the RepeatConfig proto to config checks.
testconfigcreator Package testconfigcreator provides util functions for creating benchmark configs for testing.	Package testconfigcreator provides util functions for creating benchmark configs for testing.
sqlquerier Package sqlquerier provides an utility function for running SQL queries.	Package sqlquerier provides an utility function for running SQL queries.