Metadata-Version: 2.4
Name: gcp-abuse-scanner
Version: 0.1.4
Summary: Preventive GCP security scanner for crypto mining and Gemini API abuse vectors
Project-URL: Homepage, https://github.com/lmoreno0435/gcp-abuse-scanner
Project-URL: Repository, https://github.com/lmoreno0435/gcp-abuse-scanner
Project-URL: Issues, https://github.com/lmoreno0435/gcp-abuse-scanner/issues
Project-URL: Documentation, https://github.com/lmoreno0435/gcp-abuse-scanner/tree/main/docs
Author: GCP Abuse Scanner Contributors
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship made available under
              the License, as indicated by a copyright notice that is included in
              or attached to the work (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other transformations
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean, as submitted to the Licensor for inclusion
              in the Work by the copyright owner or by an individual or Legal Entity
              authorized to submit on behalf of the copyright owner. For the purposes
              of this definition, "submit" means any form of electronic, verbal, or
              written communication sent to the Licensor or its representatives,
              including but not limited to communication on electronic mailing lists,
              source code control systems, and issue tracking systems that are managed
              by, or on behalf of, the Licensor for the purpose of discussing and
              improving the Work, but excluding communication that is conspicuously
              marked or designated in writing by the copyright owner as "Not a
              Contribution."
        
              "Contributor" shall mean Licensor and any Legal Entity on behalf of
              whom a Contribution has been received by the Licensor and included
              within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by the combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a cross-claim
              or counterclaim in a lawsuit) alleging that the Work or any
              Contribution embodied within the Work constitutes direct or contributory
              patent infringement, then any patent licenses granted to You under
              this License for that Work shall terminate as of the date such
              litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or Derivative
                  Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, You must include a readable copy of the
                  attribution notices contained within such NOTICE file, in
                  at least one of the following places: within a NOTICE text
                  file distributed as part of the Derivative Works; within
                  the Source form or documentation, if provided along with the
                  Derivative Works; or, within a display generated by the
                  Derivative Works, if and wherever such third-party notices
                  normally appear. The contents of the NOTICE file are for
                  informational purposes only and do not modify the License.
                  You may add Your own attribution notices within Derivative
                  Works that You distribute, alongside or as an addendum to
                  the NOTICE text from the Work, provided that such additional
                  attribution notices cannot be construed as modifying the License.
        
           You may add Your own license statement for Your modifications and
           may provide additional grant of rights to use, copy, modify, merge,
           publish, distribute, sublicense, and/or sell copies of the Work.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or reproducing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or exemplary damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (even if such Contributor has been advised of the possibility
              of such damages).
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may offer only
              conditions consistent with this License.
        
           END OF TERMS AND CONDITIONS
        
           Copyright 2024 GCP Abuse Scanner Contributors
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
Keywords: cloud,crypto-mining,gcp,gemini,scanner,security
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Security
Classifier: Topic :: System :: Systems Administration
Requires-Python: >=3.11
Requires-Dist: google-api-python-client>=2.130.0
Requires-Dist: google-auth>=2.29.0
Requires-Dist: google-cloud-aiplatform>=1.55.0
Requires-Dist: google-cloud-asset>=3.25.0
Requires-Dist: google-cloud-billing>=1.13.0
Requires-Dist: google-cloud-compute>=1.18.0
Requires-Dist: google-cloud-container>=2.45.0
Requires-Dist: google-cloud-monitoring>=2.21.0
Requires-Dist: google-cloud-resource-manager>=1.12.0
Requires-Dist: google-cloud-run>=0.10.0
Requires-Dist: google-cloud-service-usage>=1.10.0
Requires-Dist: jinja2>=3.1.4
Requires-Dist: pydantic-settings>=2.3.0
Requires-Dist: pydantic>=2.7.0
Requires-Dist: pyyaml>=6.0.1
Requires-Dist: rich>=13.7.0
Requires-Dist: tenacity>=8.3.0
Requires-Dist: typer>=0.12.0
Provides-Extra: dev
Requires-Dist: black>=24.4.0; extra == 'dev'
Requires-Dist: mypy>=1.10.0; extra == 'dev'
Requires-Dist: pre-commit>=3.7.0; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
Requires-Dist: pytest>=8.2.0; extra == 'dev'
Requires-Dist: responses>=0.25.0; extra == 'dev'
Requires-Dist: ruff>=0.4.0; extra == 'dev'
Requires-Dist: types-pyyaml>=6.0.12; extra == 'dev'
Requires-Dist: types-requests>=2.32.0; extra == 'dev'
Description-Content-Type: text/markdown

# gcp-abuse-scanner

> **Preventive GCP security scanner** for crypto mining and Gemini API abuse vectors.

[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
[![Python](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/)
[![CI](https://github.com/lmoreno0435/gcp-abuse-scanner/actions/workflows/ci.yml/badge.svg)](https://github.com/lmoreno0435/gcp-abuse-scanner/actions)
[![PyPI](https://img.shields.io/pypi/v/gcp-abuse-scanner.svg)](https://pypi.org/project/gcp-abuse-scanner/)
[![Docker](https://img.shields.io/badge/docker-ghcr.io-blue)](https://ghcr.io/lmoreno0435/gcp-abuse-scanner)
[![codecov](https://codecov.io/gh/lmoreno0435/gcp-abuse-scanner/branch/main/graph/badge.svg)](https://codecov.io/gh/lmoreno0435/gcp-abuse-scanner)

`gcp-abuse-scanner` is an open source CLI tool that scans Google Cloud Platform organizations and projects for **security misconfigurations** that can be exploited for:

- 🪙 **Crypto mining** — unauthorized compute resource abuse
- 🤖 **Gemini API abuse** — unauthorized or uncontrolled access to Generative AI APIs

The tool is **read-only** and **preventive**: it never modifies resources, never disables APIs, and never revokes permissions. It produces a **prioritized remediation report** so you know exactly what to fix and in what order.

---

## Features

- 🔍 **~65+ security checks** across Compute, GKE, Cloud Run, IAM, Networking, API Keys, Vertex AI, Billing, and Org Policies
- 🏢 **Organization-wide or per-project** scanning
- 🔐 **Service account authentication** (impersonation recommended, key file supported)
- 📊 **Multiple output formats**: Console (rich), JSON, Markdown, HTML, SARIF 2.1.0
- ⚡ **Concurrent collection** with retry/backoff — handles large orgs with thousands of projects
- 🎯 **Prioritized findings** with CRITICAL / HIGH / MEDIUM / LOW severity
- 🚫 **Allowlist support** for known exceptions
- 🔌 **Plugin architecture** — add new checks without touching the core

---

## Quickstart

### Installation

```bash
# Recommended: pipx (isolated environment)
pipx install gcp-abuse-scanner

# Or pip
pip install gcp-abuse-scanner

# Or Docker
docker run --rm -v ~/.config/gcloud:/root/.config/gcloud \
  ghcr.io/lmoreno0435/gcp-abuse-scanner:latest scan --org YOUR_ORG_ID
```

### Authentication

**Recommended: Service Account Impersonation**
```bash
gcp-abuse-scanner scan --org 123456789012 \
  --impersonate-service-account scanner-sa@your-project.iam.gserviceaccount.com
```

**Alternative: Service Account Key File**
```bash
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/sa-key.json
gcp-abuse-scanner scan --org 123456789012
```

> ⚠️ Using key files is an anti-pattern. Prefer impersonation or Workload Identity Federation.

### Basic Usage

```bash
# Scan entire organization
gcp-abuse-scanner scan --org 123456789012

# Scan specific projects
gcp-abuse-scanner scan --project my-project-1 --project my-project-2

# Output as JSON
gcp-abuse-scanner scan --org 123456789012 --format json --output report.json

# Output as Markdown
gcp-abuse-scanner scan --org 123456789012 --format markdown --output report.md

# Output as self-contained HTML report
gcp-abuse-scanner scan --org 123456789012 --format html --output report.html

# Output as SARIF 2.1.0 (GitHub Advanced Security, VS Code)
gcp-abuse-scanner scan --org 123456789012 --format sarif --output results.sarif

# All formats at once (auto-named files)
gcp-abuse-scanner scan --org 123456789012 --format all

# Scan only Gemini abuse vector
gcp-abuse-scanner scan --org 123456789012 --vector gemini_abuse

# Speed up re-runs with inventory cache (1h TTL)
gcp-abuse-scanner scan --org 123456789012 --cache

# List all available checks
gcp-abuse-scanner list-checks

# Dry run (resolve scope without scanning)
gcp-abuse-scanner scan --org 123456789012 --dry-run
```

---

## Prerequisites — GCP APIs

The scanner calls GCP APIs to collect resource inventory. **These APIs must be enabled before running a scan.**

### Quick setup (recommended)

```bash
# Clone the repo to get the script, then run:
bash scripts/enable_apis.sh \
  --org YOUR_ORG_ID \
  --scanner-project YOUR_SCANNER_PROJECT

# Dry-run first to preview changes:
bash scripts/enable_apis.sh \
  --org YOUR_ORG_ID \
  --scanner-project YOUR_SCANNER_PROJECT \
  --dry-run
```

### Manual setup

**In the scanner project** (enable once):
```bash
gcloud services enable \
  cloudasset.googleapis.com \
  cloudbilling.googleapis.com \
  billingbudgets.googleapis.com \
  orgpolicy.googleapis.com \
  --project=YOUR_SCANNER_PROJECT
```

**In each scanned project**:
```bash
gcloud services enable \
  serviceusage.googleapis.com \
  iam.googleapis.com \
  compute.googleapis.com \
  container.googleapis.com \
  run.googleapis.com \
  aiplatform.googleapis.com \
  apikeys.googleapis.com \
  recommender.googleapis.com \
  --project=PROJECT_ID
```

> **What happens if an API is disabled?** The scanner skips that resource type for that project — it does not fail the scan. Use `--verbose` to see which APIs were skipped. See [docs/apis.md](docs/apis.md) for the full dependency map.

---

## Required IAM Roles

The service account running this tool needs the following **read-only** roles, assigned at the **organization level** (for org-wide scans) or project level:

| Role | Purpose |
|------|---------|
| `roles/cloudasset.viewer` | Enumerate all resources and IAM policies efficiently |
| `roles/iam.securityReviewer` | Read IAM policies across all resources |
| `roles/compute.viewer` | Read Compute Engine instances, firewall rules, networks |
| `roles/container.viewer` | Read GKE clusters and node pools |
| `roles/run.viewer` | Read Cloud Run services and jobs |
| `roles/serviceusage.serviceUsageViewer` | Determine which APIs are enabled per project |
| `roles/serviceusage.apiKeysViewer` | List API keys and their restrictions |
| `roles/aiplatform.viewer` | Read Vertex AI endpoints and model configuration |
| `roles/billing.viewer` | Verify billing accounts and budget existence |
| `roles/recommender.viewer` | Read IAM recommender insights |
| `roles/orgpolicy.policyViewer` | Read Organization Policy constraints |
| `roles/monitoring.viewer` | *(Optional)* Verify alerting policies |

See [docs/iam-setup.md](docs/iam-setup.md) for step-by-step setup instructions and [docs/apis.md](docs/apis.md) for the complete API reference.

---

## Security Checks

### Crypto Mining Vector (~40 checks)

| ID | Severity | Description |
|----|----------|-------------|
| CM-001 | HIGH | VM instances with external IP addresses |
| CM-004 | CRITICAL | Firewall allows SSH/RDP from 0.0.0.0/0 |
| CM-009 | MEDIUM | Shielded VM not enabled |
| CM-020 | HIGH | GKE node pools with unbounded autoscaling |
| CM-023 | HIGH | GKE cluster with public endpoint and no authorized networks |
| CM-030 | HIGH | Cloud Run services with public invoker (allUsers) |
| CM-040 | HIGH | SA with compute admin roles granted broadly |
| CM-041 | HIGH | Service accounts with user-managed (exported) keys |
| CM-043 | CRITICAL | IAM binding grants allUsers/allAuthenticatedUsers |
| CM-044 | HIGH | Default Compute SA has Editor/Owner role |
| ... | ... | See [docs/checks/crypto_mining.md](docs/checks/crypto_mining.md) |

### Gemini API Abuse Vector (~25 checks)

| ID | Severity | Description |
|----|----------|-------------|
| GEM-001 | CRITICAL | API key has no API restrictions |
| GEM-002 | CRITICAL | API key has no application restrictions |
| GEM-003 | HIGH | API key explicitly targets Gemini API without app restrictions |
| GEM-020 | HIGH | Vertex AI role granted to broad principal (domain/group) |
| GEM-021 | CRITICAL | Vertex AI role granted to allUsers/allAuthenticatedUsers |
| GEM-030 | HIGH | Vertex AI endpoint accessible without private endpoint |
| GEM-040 | MEDIUM | Vertex AI quotas at default (high) values |
| GEM-051 | HIGH | No budget covering Vertex AI/Gemini spend |
| ... | ... | See [docs/checks/gemini_abuse.md](docs/checks/gemini_abuse.md) |

### Common Checks (~6 checks)

| ID | Severity | Description |
|----|----------|-------------|
| CMN-001 | HIGH | Billing account has no budget configured |
| CMN-002 | MEDIUM | Budget exists but has no threshold alert rules |
| CMN-005 | MEDIUM | Key org policy constraints absent |
| CMN-006 | MEDIUM | Cloud Audit Logs (Data Access) disabled |

---

## Report Format

Each finding includes:
- **Severity**: CRITICAL / HIGH / MEDIUM / LOW
- **Priority rank**: Global ordering for the remediation plan
- **Evidence**: Exact resource details that triggered the finding
- **Impact**: What an attacker can do with this misconfiguration
- **Remediation**: Step-by-step fix with `gcloud` commands, Terraform reference, and effort estimate

Example finding (JSON):
```json
{
  "check_id": "GEM-002",
  "title": "API key has no application restrictions",
  "severity": "CRITICAL",
  "priority_rank": 1,
  "resource": {"project_id": "my-project", "resource_id": "..."},
  "remediation": {
    "summary": "Add HTTP referrer or IP restrictions to the key.",
    "effort": "LOW",
    "gcloud_commands": ["gcloud services api-keys update KEY_UID --allowed-referrers=..."]
  }
}
```

---

## Configuration

Create a `config.yaml` to customize behavior:

```yaml
# See examples/config.example.yaml for full reference
allowlist:
  - check_id: CM-001
    project_id: my-legacy-project
    reason: "External IP required for on-prem VPN — reviewed 2024-01-15"
```

---

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for how to add new checks, collectors, and reporters.

---

## License

Apache 2.0 — see [LICENSE](LICENSE).

> **Disclaimer**: This tool is read-only and preventive. It does not guarantee detection of all security issues. Always combine with other security controls and monitoring.
