@candidpartners/snitch-utils v2.3.0

Matter Compliance - Snitch Utilities

The snitch-utils package contains a set of common utilities that make it easier to author custom compliance rules

Usage

To install:

npm i @candidpartners/snitch-utils

Key exports:

• Rule utils

  import { isRule } from '@candidpartners/snitch-utils';
  
  const rule = {
    name: 'aws_my_rule',
    uuid: 'abc-123',
    docs: { description: 'My rule does something good' },
    groupName: 'myGroup',
    terraformType: 'aws_s3_resource',
    terraform: ({plan}) => {
      // ...
    }
  };
  
  isRule(rule); // true

• Terraform

  • TerraformPlan
    • Class wrappers for the terraform plan with a number of convenience functions for accessing resources
  • TerraformGraph
    • Used to build an in-memory graph of all resources in the terraform to evaluate relationships and inheritance
• Policy Analyzer
  • IAMPolicy
    • Class wrapper for an IAM Policy that provides evaluation of actions
  • PolicyStatement
    • Class wrapper for an individual policy statement