Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/usage/Config.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,23 @@ It can also be invoked while overriding the `baselines` parameter.
scubagoggles gws --config basic_config.yaml -b gmail chat
```

### SCuBA Complicance Configuration
The [SCuBA compliance](../../scubagoggles/sample-config-files/scuba_compliance.yaml)
is the **recommended starting point** for organizations seeking to meet SCuBA
compliance checks. This configuration file contains:

- Parameters necessary for service account authentication
- Additional organizational documentation fields
- Fields for omitting or annotating ScubaGoggles policy checks

Users are highly encouraged to read all the configuration file documentation
sections to understand what each field is for and to modify those fields to
successfully pass ScubaGoggles's SCuBA baseline compliance checks.

This configuration file includes the additional `orgname` and `orgunitname`
fields for documenting the organization and organizational subunit owner of the
GWS tenant ScubaGoggles is running against.

### Omit Policies

In some cases, it may be appropriate to omit specific policies from ScubaGoggles evaluation. For example:
Expand Down
36 changes: 36 additions & 0 deletions scubagoggles/sample-config-files/scuba_compliance.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# This is a ScubaGoggles sample configuration file for compliance use.
# In order to pass/omit certain policy checks made during a ScubaGoggles
# assessment run, necessary action is required to provide specific values
# unique to both your organization and GWS tenant in the fields below. Please
# read and understand the full ScubaGoggles configuration file documentation
# for both adding additional fields or modifying the fields below. The
# documentation can be found here:
# https://github.com/cisagov/ScubaGoggles/blob/main/docs/usage/Config.md

# These values are necessary for service account authentication:
# - subjectemail: The email address of the user the service account should act
# on behalf of. This user must have the necessary privileges to run
# ScubaGoggles (must be a super admin).
# - customerid: The unique ID assigned to your GWS tenant. See
# https://support.google.com/a/answer/10070793 for help finding this.
subjectemail: ""
customerid: ""

# The following fields are used to document what organization this
# configuration file belongs to.
orgname: Department of Example
orgunitname: Subdepartment of Example

# The omitpolicy field can be used to exclude policies from the SCuBA
# assessment results (e.g., for controls that are met using a third party tool
# or acceptance of risk). See
# https://github.com/cisagov/ScubaGoggles/blob/main/docs/usage/Config.md#omit-policies
# for in-depth details.
omitpolicy: {}

# Policies can be annotated to mark incorrect results and document plans of
# action. The annotation is appended in the Details column of the HTML report
# for the applicable controls. See
# https://github.com/cisagov/ScubaGoggles/blob/main/docs/usage/Config.md#annotate-policies
# for in-depth details.
annotatepolicy: {}
Loading