Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added TransitiveWhitelisting explanation to rules.md #1150

Merged
merged 3 commits into from
Aug 14, 2023
Merged

Added TransitiveWhitelisting explanation to rules.md #1150

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9023c30
Added TransitiveWhitelisting explanation to rules.md
p-harrison Aug 11, 2023
c07b26f
Update docs/concepts/rules.md
p-harrison Aug 14, 2023
a747ff9
Update docs/concepts/rules.md
p-harrison Aug 14, 2023
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
13 changes: 11 additions & 2 deletions docs/concepts/rules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ parent: Concepts
## Rule Types

Rules provide the primary evaluation mechanism for allowing and blocking
binaries with Santa on macOS. There are four types of rules: binary, signing ID,
certificate, and Team ID.
binaries with Santa on macOS.

### Binary Rules

Expand Down Expand Up @@ -86,6 +85,16 @@ as a single developer account can and frequently will request/rotate between
multiple different signing certificates and entitlements. This is an even more
powerful rule with broader reach than individual certificate rules.

### Compiler/Transitive Rules

The transitive whitelist capability of Santa can automatically whitelist any files that are created by a set of specified binaries. A typical use-case is allowing any binaries compiled with XCode on developer machines to execute, as it would be slow and impractical to use other rule types to permit these.
p-harrison marked this conversation as resolved.
Show resolved Hide resolved

To begin using transitive whitelisting, `EnableTransitiveWhitelisting` should be set to true and Compiler rules (rules with the policy `ALLOWLIST_COMPILER`) should be added to indicate the binaries which will be writing the new files to be whitelisted. Santa will create and manage Transitive rules in its database automatically, they cannot be created directly.
p-harrison marked this conversation as resolved.
Show resolved Hide resolved





## Rule Evaluation

When a process is trying to execute, `santad` retrieves information on the
Expand Down