Contribute
Add a Security Rule
Guide to add a custom security rule
Here are the steps to add your own custom security rule:
- Create a file under
backend/rules
like this one.- Specify a
UID
likeiam/no_root_access_keys
. This is made from a service (e.g.iam
) and a rule name (e.g.no_root_access_keys
). - Specify a short
Description
for the rule. - Choose a
Severity
level fromLow
,Moderate
,High
, andCritical
. - List out
RiskCategories
that describe the rule. Choose fromInsufficient Monitoring
,Publicly Exposed
,Poor Encryption
,IAM Misconfiguration
,Patching Issue
,Unused Resource
,Data Access
, andPoor Backup
. - Fill out rule execution logic under
Execute
. This is a Cypher query that returns aresource_id
,resource_type
,account_id
,status
, andcontext
.
- Specify a
- Add your rule to
MisconfigurationRulesToExecute
orAttackPathsRulesToExecute
here - Optionally add remediation steps like here.
- Optionally add a
displayType
entry here. (This is to set the label of the resource in the UI.)