Fleetspeak is a framework for communicating with a fleet of machines, with a focus on security monitoring and basic administrative use cases. It is a subproject of GRR, and can be seen as an effort to modularizing and modernizing its communication mechanism.
We have this code working internally as part of our GRR installation.
On linux, assuming a recent version of the go development environment (see the
go.mod file for the exact requirement) and virtualenv, the following sequence
of commands will build and test this pre-release:
go get -v -t github.com/google/fleetspeak/...
# Assuming default $GOPATH:
cd ~/go/src/github.com/google/fleetspeak
# Setup virtualenv - fleetspeak provides some python integration libraries,
# and this ensures they are set up in a known way.
virtualenv $HOME/FSENV
source $HOME/FSENV/bin/activate
pip install -e fleetspeak_python/
# Set mysql parameters. The mysql datastore test will run if the following environment
# variables are set. Otherwise it will be skipped.
export MYSQL_TEST_USER=<username>
export MYSQL_TEST_PASS=<password> # will assume null password if unset.
export MYSQL_TEST_ADDR=<host:port>
# Build and test the release:
fleetspeak/build.sh
fleetspeak/test.sh
# After modifying proto files, the resulting go and python files need to be regenerated:
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.34.1
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.4
fleetspeak/generate_go_py_protos.shOnce built, you can take a look at the files and instructions in our demo directory.
While the code presented here is in some sense feature complete, much of it is barely tested or documented, and breaking changes are still possible. Therefore, please consider this a preview release while the dust settles. Suggestions and pull requests are very much appreciated.
