Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chainguard-dev/yacls
Collect ACLs from SaaS platforms for periodic user access reviews
https://github.com/chainguard-dev/yacls
acl gcp saas slack yaml
Last synced: about 17 hours ago
JSON representation
Collect ACLs from SaaS platforms for periodic user access reviews
- Host: GitHub
- URL: https://github.com/chainguard-dev/yacls
- Owner: chainguard-dev
- License: apache-2.0
- Created: 2022-08-09T13:53:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-15T12:03:54.000Z (3 months ago)
- Last Synced: 2024-08-15T13:44:58.538Z (3 months ago)
- Topics: acl, gcp, saas, slack, yaml
- Language: Go
- Homepage:
- Size: 1.53 MB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# yacls
[](https://goreportcard.com/badge/github.com/chainguard-dev/yacls)
[](https://github.com/chainguard-dev/yacls/releases/latest)
[](http://github.com/badges/stability-badges)
Collect user ACLs from SaaS platforms and export them to YAML files - optimized for diffs and readability by engineers or auditors.
yacls 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
* 1Password (CSV)
* Auth0 (HTML)
* Docker Hub (HTML)
* Ghost Blog (HTML)
* Github Org Members (CSV)
* Google Cloud Platform (gcloud)
* Google Workspace (CSV)
* Kolide (CSV)
* Pulumi (HTML)
* Secureframe (CSV)
* Slack (CSV)
* Vercel (HTML)
* Webflow (HTML)
## Requirements
* The Go Programming Language
## Installation
```shell
go install github.com/chainguard-dev/yacls@latest
```
## Sample Output
This is the output of `yacls --vercel-html=`:
```yaml
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 'yacls --vercel-members-html=Members - Team Settings – Dashboard – Vercel.html'
user_count: 7
users:
- account: [email protected]
role: Member
- account: [email protected]
role: Member
- account: [email protected]
role: Owner
role_count: 2
roles:
Member:
- [email protected]
- [email protected]
Owner:
- [email protected]
```
## Example command-line
Create an audit YAML for a GCP project:
```shell
yacls --kind=gcp --project=prod-env --out-dir=./out
```
Create an audit YAML from a Vercel page:
```shell
yacls --input vercel.html --kind vercel
```
Turn a directory full of input files into a directory full of easily auditable YAML files:
```shell
yacls --input-dir=in/ --out-dir=out/
```
The input files should be named after the appropriate `kind`, so for instance, `ghost.csv` or `secureframe.html`.
## Usage
Flags for `yacls`:
```yaml
-gcp-identity-project string
project to use for GCP Cloud Identity lookups
-input string
path to input file
-kind string
kind of input to process. valid values:
* 1password
* gcp
* ghost
* github-org
* google-workspace-audit
* google-workspace-users
* kolide
* secureframe
* slack
* vercel
* webflow
Detailed steps for each kind:
# Ghost Blog Permissions
* 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)
* Execute 'yacls --kind={{.Kind}} --input={{.Path}}'
# Github Organization Members
* Open https://github.com/orgs//people
* Click Export
* Select 'CSV'
* Download resulting CSV file for analysis
* Execute 'yacls --kind={{.Kind}} --input={{.Path}}'
# Google Cloud Project IAM Policies
* Execute 'yacls --kind={{.Kind}} --project={{.Project}}'
# Google Workspace User Audit
* Open https://admin.google.com/ac/reporting/report/user/accounts
* Click Download icon
* Select All Columns
* Click CSV
* Download resulting CSV file for analysis
* Execute 'yacls --kind={{.Kind}} --input={{.Path}}'
# Google Workspace Users
* 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
* Execute 'yacls --kind={{.Kind}} --input={{.Path}}'
# Kolide Users
* Open https://k2.kolide.com/3361/settings/admin/users
* Click CSV
* Download resulting CSV file for analysis
* Execute 'yacls --kind={{.Kind}} --input={{.Path}}'
# 1Password Team Members
* To be documented
* Download resulting CSV file for analysis
* Execute 'yacls --kind={{.Kind}} --input={{.Path}}'
# Secureframe Personnel
* Open https://app.secureframe.com/personnel
* Deselect any active filters
* Click Export...
* Select 'Direct Download'
* Download resulting CSV file for analysis
* Execute 'yacls --kind={{.Kind}} --input={{.Path}}'
# Slack Members
* Open Slack
* Click ▼
* Select 'Settings & Administration'
* Select 'Manage Members'
* Select 'Export Member List'
* Download resulting CSV file for analysis
* Execute 'yacls --kind={{.Kind}} --input={{.Path}}'
# Vercel Site Permissions
* 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 'yacls --kind={{.Kind}} --input={{.Path}}'
# Webflow Site Permissions
* Open https://webflow.com/dashboard/sites//members
* Save this page (Complete)
* Collect resulting .html file for analysis (the other files are not necessary)
* Execute 'yacls --kind={{.Kind}} --input={{.Path}}'
-out-dir string
output YAML files to this directory
-project string
specific project to process within the kind
-serve
Enable server mode (web UI)
```
## 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!