This page includes answers to some frequently asked questions about Forseti Security.
Great! Please see the help page on how to submit your idea or get help.
Forseti documentation can be updated in the forsetisecurity.org-dev
branch.
You can test your documentation changes locally, by following the instructions here.
After your updated documentation is merged, the Forseti team will merge it
into the forsetisecurity.org
branch upon every major/minor release,
which will trigger a new build of the forsetisecurity.org website.
It depends on your setup:
Forseti | Security Health Analytics |
---|---|
Customer deployed and managed | Fully managed by GCP with SLA |
Community support | GCP support |
Customizable auditing | Comprehensive set of benchmarks (e.g. CIS certified) |
Policy-as-code ecosystem (write the rules once, and re-use them everywhere in your workflow) |
Managed rules added by GCP |
Real-time enforcement | Scanning only |
Basic integration with CSCC | Deeper integrations with CSCC (reporting, dashboards, etc.) |
Both services can be integrated with Cloud Security Command Center (CSCC) to receive notifications. Refer here for setting up Forseti to use CSCC.
For information about how to update Forseti to the latest release, see the Upgrade guide.
To correct mistakes in setup, edit your Forseti deployment script by Updating Forseti, or edit your Forseti configuration file by Configuring Forseti.
Following are the reasons you should run Forseti in a separate project:
If Forseti is reading data from only one project, your Forseti service account might have access only to that particular project. To get read access to all of the projects under your organization, add the service account to the organization’s Cloud IAM policy with the required roles. Your Organization Admin should be able to help you with that.
GCE VM instances have the unattended-upgrades tool to automatically update the operating system, software, or security patches from the Debian security repository.
However, kernel patches do not take effect until your VM instance is restarted. By default, GCE does not automatically restart running instances.So you must either restart your instances manually to update the kernel, or apply the mechanism provided by the unattended-upgrades tool to automatically do the restart.
Automatic updates from Debian security do not upgrade instances between major versions of the operating system. Debian also has a relevant guide: https://www.debian.org/doc/manuals/securing-debian-howto/index.en.html
Forseti is installed with the ubuntu
account on the server VM. To update the
cron job you need to SSH into the server VM and switch to the ubuntu
user to
update the cron job.
$ sudo crontab -u ubuntu -l # to see existing schedule
$ sudo crontab -u ubuntu -e # to edit cron schedule
Please follow the guidelines below, and the detailed steps in the referenced documentations, to install Forseti with internal IP only.
You are all set! To verify it works, access the forseti VMs by connecting through a bastion host.
A few common causes if you cannot access Forseti VMs from the bastion host:
gcloud auth login
We have some starter documentation for defining rules. If you have more questions, you can ask for help at discuss@forsetisecurity.org.
By default, Forseti runs Inventory and Scanner every 2 hours at random minutes, using a simple cronjob. To change the cron value, edit the server’s deployment template.
The installation log is stored in /tmp/deployment.log
on the Forseti
Compute Engine instance. You can view it with any editor. For example:
vim /tmp/deployment.log
To find the Forseti Inventory, Scanner, and Enforcer logs:
You can implement bucket lifecycle rules to delete the output or migrate them to a lower cost class. You can also export the output to BigQuery.
Follow the instruction here
to add/change password of MySQL user root
.
ssh to the Forseti server VM.
run command sudo vi /lib/systemd/system/forseti.service
and you should see the following:
[Unit]
Description=Forseti API Server
[Service]
User=ubuntu
Restart=always
RestartSec=3
ExecStart=/usr/local/bin/forseti_server --endpoint '[::]:50051' --forseti_db mysql://root@127.0.0.1:3306/forseti_security --config_file_path /home/ubuntu/forseti-security/configs/forseti_conf_server.yaml --services explain inventory model scanner notifier
[Install]
WantedBy=multi-user.target
Wants=cloudsqlproxy.service
Update the forseti_db
flag to the following:
[Unit]
Description=Forseti API Server
[Service]
User=ubuntu
Restart=always
RestartSec=3
ExecStart=/usr/local/bin/forseti_server --endpoint '[::]:50051' --forseti_db mysql://root:YOUR_PASSWORD@127.0.0.1:3306/forseti_security --config_file_path /home/ubuntu/forseti-security/configs/forseti_conf_server.yaml --services explain inventory model scanner notifier
[Install]
WantedBy=multi-user.target
Wants=cloudsqlproxy.service
Save and exit, run command sudo systemctl restart forseti
to restart the forseti service and you should now be able to connect to the database with the password.
Forseti uses a service account that is granted roles on the organization’s Cloud IAM policy. Because GCP roles are hierarchical, when someone has a Cloud IAM role at the organization level, child resources like folders and projects inherit the role. For example, if you grant the “Browser” role to someone at the organization level, they will also be able to see folders and projects within the organization.
For more information, see Service account for Forseti Security.
Because the Forseti service account needs many types of permissions to read certain data, you must grant grant Forseti the specific roles that it needs to do its job.
This page lists the Google Cloud Platform (GCP) resources that currently have coverage in Forseti or are planned to have coverage. If a resource you’re interested in isn’t listed, please open an issue or contribute!
This page lists the Google Cloud Platform (GCP) scanners that currently have coverage in Forseti or are planned to have coverage. If a scanner you’re interested in isn’t listed, please open an issue or contribute!
For more information, see the scanner descriptions.
Scanner |
---|
Audit Logging Configuration Scanner |
BigQuery Scanner |
Blacklist Scanner |
Bucket ACL Scanner |
Cloud SQL ACL Scanner |
Config Validator Scanner |
Enabled APIs Scanner |
External Project Access Scanner |
Firewall Rules Scanner |
Forwarding Rules Scanner |
Google Groups Scanner |
Groups Settings Scanner |
Cloud IAM Rules Scanner |
Cloud IAP Scanner |
Instance Network Interface Scanner |
Kubernetes Engine Scanner |
Kubernetes Engine Version Scanner |
KMS Scanner |
Lien Scanner |
Location Scanner |
Log Sink Scanner |
Resource Scanner |
Retention Scanner |
Role Scanner |
Service Account Key Scanner |
This section lists the Google Cloud Platform (GCP) enforcers that currently have coverage in Forseti or are planned to have coverage. If an enforcer you’re interested in isn’t listed, please open an issue or contribute!
For details about each of the enforcers, see the Enforcer guide.
Enforcer |
---|
Firewalls |
This section lists the Google Cloud Platform (GCP) resources that currently have coverage using the Real-Time Enforcer. If a resource you’re interested in isn’t listed, please open an issue or contribute!
For details about each of the resources, see the Real-Time Enforcer guide.
Real-time Enforcer |
---|
Cloud Storage |
Cloud SQL |
BigQuery |
Cloud Security Command Center only includes projects in an active state. The Forseti Inventory includes projects all possible states.