Skip to main content

Python tool that helps you enhance your GitHub security posture at scale.

Project description

gitsec

A modular Python CLI tool for auditing GitHub security posture at organization and repository level.

Features

gitsec provides comprehensive security auditing for GitHub repositories and organizations through three main modules:

1. Secret Scanning

Detect hardcoded secrets and credentials in your codebase using the detect-secrets library with custom plugins.

  • API keys (AWS, Google Cloud, Azure, OpenAI, Anthropic, etc.)
  • Database connection strings
  • Private keys and certificates
  • OAuth tokens and webhook secrets

2. Dependency Scanning

Identify vulnerabilities in your project dependencies using the deps.dev API.

  • Known CVEs and security advisories
  • CVSS severity scoring
  • Deprecated packages detection
  • Unpinned dependencies identification
  • Support for multiple ecosystems (npm, pip, Maven, Go, etc.)

3. Security Checks

Audit GitHub security configurations at organization and repository level.

Organization-level checks:

  • MFA requirement status
  • SSO/SAML configuration
  • Commit signing enforcement
  • Pull request requirements
  • Push protection
  • Tag deletion protection
  • Secrets and runners scope
  • User access analysis

Repository-level checks:

  • Commit signing requirements
  • Pull request requirements
  • Push protection
  • Tag deletion protection
  • Runners scope

Installation

Using pip (recommended)

pip install gitsec

Using pipx (isolated installation)

pipx install gitsec

For Development

  1. Clone the repository:
git clone https://github.com/yourusername/gitsec.git
cd gitsec
  1. Install dependencies:
poetry install

Authentication

Set your GitHub token:

export GITHUB_TOKEN=your_github_personal_access_token

Usage

Quick Start

Run a comprehensive audit on an organization:

gitsec audit-all --org your-org --out results

Run a comprehensive audit on a single repository:

gitsec audit-all --repo owner/repo --out results

Comprehensive Audit

The audit-all command runs all three security modules and generates a single Excel report.

# Organization
gitsec audit-all --org myorg --out out

# Single repository
gitsec audit-all --repo owner/repo --out out

# Local repository
gitsec audit-all --local-repo /path/to/repo --out out

# GitHub Enterprise Server
gitsec audit-all --org myorg --base-url https://github.mycorp.com --out out

Output: Single Excel file (audit_all_<target>.xlsx) with all findings and a combined summary sheet.

Note: Security checks are not available for local repositories.

Secret Scanning

# Single repository
gitsec scan-secrets --repo owner/repo --out out

# Organization
gitsec scan-secrets --org myorg --out out

# Local repository
gitsec scan-secrets --local-repo /path/to/repo --out out

# Choose output format (csv, xls, or csv,xls)
gitsec scan-secrets --repo owner/repo --format csv,xls --out out

Dependency Scanning

# Single repository
gitsec scan-dependencies --repo owner/repo --out out

# Organization
gitsec scan-dependencies --org myorg --out out

# Local repository
gitsec scan-dependencies --local-repo /path/to/repo --out out

# Choose output format (csv, xls, or csv,xls)
gitsec scan-dependencies --repo owner/repo --format xls --out out

Security Checks

Run all checks or specific modules:

# All organization-level checks
gitsec security-checks all-org --org myorg --out out

# All repository-level checks
gitsec security-checks all-repo --repo owner/repo --out out

# Specific checks (can combine multiple)
gitsec security-checks org-mfa org-sso --org myorg --out out
gitsec security-checks repo-commit-signing repo-pr-required --repo owner/repo --out out

Available Security Check Modules

Organization-level

  • org-mfa - Check if MFA is required for all organization members
  • org-sso - Check if SSO/SAML is configured
  • org-commit-signing - Check commit signing enforcement across all repositories
  • org-pr-required - Check PR requirements across all repositories
  • org-push-protection - Check push protection across all repositories
  • org-tag-deletion-protection - Check tag deletion protection across all repositories
  • org-secrets-scope - Audit organization secrets visibility and scope
  • org-runners-scope - Audit self-hosted runners scope and visibility
  • org-user-access - Analyze user access patterns and permissions

Repository-level

  • repo-commit-signing - Check if commit signing is required
  • repo-pr-required - Check if PRs are required on default branch
  • repo-push-protection - Check if direct pushes to default branch are blocked
  • repo-tag-deletion-protection - Check if tag deletion is protected
  • repo-runners-scope - Audit self-hosted runners scope

Output

All commands generate reports in the specified output directory:

  • CSV format: Individual CSV files for each finding type
  • Excel format: Comprehensive Excel workbook with multiple sheets and summary
  • Combined format: Both CSV and Excel (use --format csv,xls)

The audit-all command generates a single Excel file containing all findings with a summary sheet.

GitHub Enterprise Server Support

All commands support GitHub Enterprise Server via the --base-url flag:

gitsec audit-all --org myorg --base-url https://github.mycorp.com --out out

Token Permissions

The GitHub personal access token requires the following scopes:

  • repo - Full control of private repositories
  • read:org - Read organization data
  • admin:org - Read organization security settings

For GitHub Enterprise Server, ensure the token has equivalent permissions.

License

MIT

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gitsec-1.0.tar.gz (35.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gitsec-1.0-py3-none-any.whl (50.9 kB view details)

Uploaded Python 3

File details

Details for the file gitsec-1.0.tar.gz.

File metadata

  • Download URL: gitsec-1.0.tar.gz
  • Upload date:
  • Size: 35.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.13.9 Darwin/24.6.0

File hashes

Hashes for gitsec-1.0.tar.gz
Algorithm Hash digest
SHA256 41b1a73c9c85d5ee70cd1d11b9c389dff6f87c5f09f75814c2f278b27591a2f1
MD5 7b5358d1e64d80241c67cfd0b04ec1ea
BLAKE2b-256 c1ce4b27d0d589ac15e7bf6bd05ef5e4f778aa9a5576e6123f0c9031b925e2d1

See more details on using hashes here.

File details

Details for the file gitsec-1.0-py3-none-any.whl.

File metadata

  • Download URL: gitsec-1.0-py3-none-any.whl
  • Upload date:
  • Size: 50.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.13.9 Darwin/24.6.0

File hashes

Hashes for gitsec-1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0fdba84d0760c2a8e3fc6eef38c40c22711ef7a0095c5240bc7ce26cf30418e0
MD5 a96d0fa284d55dc7827b9315be6e96db
BLAKE2b-256 6bf5993318131a0743a5bf61d80659817af237e8a9d8d681796d93ecbd87062a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page