acls-in-yaml

command module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 8, 2022 License: Apache-2.0 Imports: 9 Imported by: 0

README

acls-in-yaml

Collect user ACLs from SaaS platforms and export them to YAML files.

acls-in-yaml

acls-in-yaml is designed to make regular access control audits easy by offering a familiar standardized format (YAML) for easy reviews and diffing.

The output is optimized for being reviewed by humans within a Github PR periodically and is carefully tuned to make policy drift easy to notice.

Supported Data Sources

  • Ghost Blog Staff (HTML)
  • Github Org Members (CSV)
  • Google Cloud Platform (gcloud)
  • Google Workspace (CSV)
  • Kolide (CSV)
  • Secureframe (CSV)
  • Slack (CSV)
  • Vercel (HTML)
  • Webflow (HTML)

Requirements

  • The Go Programming Language

Installation

go install github.com/chainguard-dev/acls-in-yaml@latest

Sample Output

This is the output of acls-in-yaml --vercel-html=</path/to/members.html>:

metadata:
    kind: vercel_members
    name: Vercel Members
    source_date: "2022-09-21"
    generated_at: 2022-09-21T17:01:57.546028-07:00
    generated_by: t
    process:
        - Open https://vercel.com/
        - Select your company/team
        - Click 'Settings'
        - Click 'Members'
        - Save this page (Complete)
        - Collect resulting .html file for analysis (the other files are not necessary)
        - Execute 'axsdump --vercel-members-html=Members - Team Settings – Dashboard – Vercel.html'
user_count: 7
users:
    - account: john@chainguard.dev
      role: Member

    - account: kamelot@chainguard.dev
      role: Member

    - account: t@chainguard.dev
      role: Owner
role_count: 2
roles:
    Member:
        - john@chainguard.dev
        - kamelot@chainguard.dev
    Owner:
        - t@chainguard.dev

Example command-line

Turn a pile of CSV and HTML pages into a directory full of easily auditable YAML files.

acls-in-yaml \
  --google-users-csv=User_Download.csv \
  --google-audit-csv=users_logs.csv \
  --github-org-csv=export-github.csv \
  --slack-csv=members.csv \
  --kolide-csv=kolide.csv \
  --out-dir=/path/to/github/repo

You can also pass in a single input file at a time.

Usage

acls-in-yaml takes many flags, though for most cases it is only necessary to pass one in at a time:

  -gcp-identity-project string
     Optional GCP project for group resolution (requires cloudidentity API)
  -gcp-projects string
     Comma-separated list of GCP projects to fetch IAM policies for
  -ghost-html string
     Path to Ghost Staff HTML
     Steps:
       * Open the corporate Ghost blog
       * Click 'Settings'
       * Click 'Staff'
       * Zoom out so that all users are visible on one screen
       * Save this page (Complete)
       * Collect resulting .html file for analysis (the other files are not necessary)
  -github-org-csv string
     Path to Github Org Members CSV
     Steps:
       * Open https://github.com/orgs/<org>/people
       * Click Export
       * Select 'CSV'
       * Download resulting CSV file for analysis
  -google-audit-csv string
     Path to Google Workspace Audit CSV (delayed).
     Steps:
       * Open https://admin.google.com/ac/reporting/report/user/accounts
       * Click Download icon
       * Select All Columns
       * Click CSV
       * Download resulting CSV file for analysis
  -google-users-csv string
     Path to Google Workspace Users CSV (live)
     Steps:
       * Open https://admin.google.com/ac/users
       * Click Download users
       * Select 'All user info Columns'
       * Select 'Comma-separated values (.csv)'
       * Download resulting CSV file for analysis
  -kolide-csv string
     Path to Kolide Users CSV
     Steps:
       * Open https://k2.kolide.com/3361/settings/admin/users
       * Click CSV
       * Download resulting CSV file for analysis
  -secureframe-csv string
     Path to Secureframe Personnel CSV
     Steps:
       * Open https://app.secureframe.com/personnel
       * Deselect any active filters
       * Click Export...
       * Select 'Direct Download'
       * Download resulting CSV file for analysis
  -slack-csv string
     Path to Slack Members CSV
     Steps:
       * Open Slack
       * Click <org name>▼
       * Select 'Settings & Administration'
       * Select 'Manage Members'
       * Select 'Export Member List'
       * Download resulting CSV file for analysis
  -vercel-html string
     Path to Vercel Members HTML
     Steps:
       * Open https://vercel.com/
       * Select your company/team
       * Click 'Settings'
       * Click 'Members'
       * Save this page (Complete)
       * Collect resulting .html file for analysis (the other files are not necessary)
  -webflow-html string
     Path to Ghost Members HTML
     Steps:
       * Open https://webflow.com/dashboard/sites/<site>/members
       * Save this page (Complete)
       * Collect resulting .html file for analysis (the other files are not necessary)

FAQ

Why not use the APIs provided by each vendor?

The current structure was put in place because of a separation of duties, where the person running the tool was not the one who had admin access to each SaaS platform. It doesn't help that many SaaS platforms do not provide a documented API to retrieve user lists (Vercel, I'm looking at you!)

At the moment, the only fully automated audit is GCP, though we would like to add more direct API support. HELP WANTED!

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg
axs

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL