https://github.com/crowdstrike/chronicle-intel-bridge

CrowdStrike to Chronicle Intel Bridge

https://github.com/crowdstrike/chronicle-intel-bridge

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.7%) to scientific vocabulary

Keywords from Contributors

scripts charts projection archival crowdstrike falcon powershell interactive generic sensor
Last synced: 11 months ago · JSON representation

Repository

CrowdStrike to Chronicle Intel Bridge

Basic Info
  • Host: GitHub
  • Owner: CrowdStrike
  • License: unlicense
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 44.9 KB
Statistics
  • Stars: 3
  • Watchers: 4
  • Forks: 4
  • Open Issues: 2
  • Releases: 3
Created over 3 years ago · Last pushed about 1 year ago
Metadata Files
Readme License Support

README.md

CrowdStrike to Chronicle Intel Bridge

Python Lint Container Build on Quay

CrowdStrike to Chronicle Intel Bridge forwards CrowdStrike Falcon Intelligence Indicators to Chronicle.

Prerequisites

  • Create new API key pair at CrowdStrike Falcon. This key pair will be used to read falcon events and supplementary information from CrowdStrike Falcon.

Make sure only the following permissions are assigned to the key pair: - Indicators (Falcon Intelligence): READ

  • Obtain a Chronicle Service Account file and Chronicle Customer ID. > A (JSON file) that contains the necessary credentials to authenticate with Chronicle. > > Your Chronicle Support representative should be able to provide you with your Chronicle Customer ID and Service Account JSON file.

Configuration

Environment Variables

Set the following environment variables:

bash export FALCON_CLOUD_REGION=YOUR_CLOUD_REGION (e.g., us-1, us-2, eu-1) export FALCON_CLIENT_ID=YOUR_CLIENT_ID export FALCON_CLIENT_SECRET=YOUR_CLIENT_SECRET export CHRONICLE_CUSTOMER_ID=YOUR_CUSTOMER_ID export CHRONICLE_REGION=YOUR_CHRONICLE_REGION (optional, defaults to US multi-region)

Chronicle Region Configuration

The CHRONICLE_REGION environment variable specifies which Chronicle regional endpoint to use. The following values are supported:

  • Legacy region codes: EU, UK, IL, AU, SG
  • Google Cloud region codes: US, EUROPE, EUROPE-WEST2, EUROPE-WEST3, EUROPE-WEST6, EUROPE-WEST9, EUROPE-WEST12, ME-WEST1, ME-CENTRAL1, ME-CENTRAL2, ASIA-SOUTH1, ASIA-SOUTHEAST1, ASIA-NORTHEAST1, AUSTRALIA-SOUTHEAST1, SOUTHAMERICA-EAST1, NORTHAMERICA-NORTHEAST2
  • If not specified or if an unrecognized value is provided, it defaults to the US multi-region endpoint

[!NOTE] Region codes are case-insensitive, so "eu", "EU", and "Eu" are all treated the same.

Advanced Configuration

Please refer to the config.ini file for advanced configuration options and customization.

  1. Download/Copy the config/config.ini file from this repository to use as a template
  2. Make any necessary changes to suit your needs
  3. Pass the config file to the container using the volume mount flag:

    bash -v /path/to/your/config.ini:/ccib/config.ini:ro

Deployment Instructions

Run the bridge application

Interactive mode (foreground)

bash docker run -it --rm \ --name chronicle-intel-bridge \ -e FALCON_CLIENT_ID="$FALCON_CLIENT_ID" \ -e FALCON_CLIENT_SECRET="$FALCON_CLIENT_SECRET" \ -e FALCON_CLOUD_REGION="$FALCON_CLOUD_REGION" \ -e CHRONICLE_CUSTOMER_ID="$CHRONICLE_CUSTOMER_ID" \ -e CHRONICLE_REGION="$CHRONICLE_REGION" \ -e GOOGLE_SERVICE_ACCOUNT_FILE=/gcloud/sa.json \ -v /path/to/your/service-account.json:/gcloud/sa.json:ro \ quay.io/crowdstrike/chronicle-intel-bridge:latest

Detached mode (background with restart policy)

bash docker run -d --restart unless-stopped \ --name chronicle-intel-bridge \ -e FALCON_CLIENT_ID="$FALCON_CLIENT_ID" \ -e FALCON_CLIENT_SECRET="$FALCON_CLIENT_SECRET" \ -e FALCON_CLOUD_REGION="$FALCON_CLOUD_REGION" \ -e CHRONICLE_CUSTOMER_ID="$CHRONICLE_CUSTOMER_ID" \ -e CHRONICLE_REGION="$CHRONICLE_REGION" \ -e GOOGLE_SERVICE_ACCOUNT_FILE=/gcloud/sa.json \ -v /path/to/your/service-account.json:/gcloud/sa.json:ro \ quay.io/crowdstrike/chronicle-intel-bridge:latest

Developer instructions

If you want to build the container locally:

  1. Clone the repository
  2. Make any changes (ie config.ini) needed
  3. Build container

    bash docker build . -t ccib:latest

  4. Run the Bridge

    Interactive mode (foreground)

    bash docker run -it --rm \ --name chronicle-intel-bridge \ -e FALCON_CLIENT_ID="$FALCON_CLIENT_ID" \ -e FALCON_CLIENT_SECRET="$FALCON_CLIENT_SECRET" \ -e FALCON_CLOUD_REGION="$FALCON_CLOUD_REGION" \ -e CHRONICLE_CUSTOMER_ID="$CHRONICLE_CUSTOMER_ID" \ -e CHRONICLE_REGION="$CHRONICLE_REGION" \ -e GOOGLE_SERVICE_ACCOUNT_FILE=/gcloud/sa.json \ -v /path/to/your/service-account.json:/gcloud/sa.json:ro \ ccib:latest

    Detached mode (background with restart policy)

    bash docker run -d --restart unless-stopped \ --name chronicle-intel-bridge \ -e FALCON_CLIENT_ID="$FALCON_CLIENT_ID" \ -e FALCON_CLIENT_SECRET="$FALCON_CLIENT_SECRET" \ -e FALCON_CLOUD_REGION="$FALCON_CLOUD_REGION" \ -e CHRONICLE_CUSTOMER_ID="$CHRONICLE_CUSTOMER_ID" \ -e CHRONICLE_REGION="$CHRONICLE_REGION" \ -e GOOGLE_SERVICE_ACCOUNT_FILE=/gcloud/sa.json \ -v /path/to/your/service-account.json:/gcloud/sa.json:ro \ ccib:latest

Statement of Support

This project is a community-driven, open source project designed to forward CrowdStrike Falcon Intelligence Indicators to Chronicle.

While not a formal CrowdStrike product, this project is maintained by CrowdStrike and supported in partnership with the open source developer community.

For additional support, please see the SUPPORT file.

Owner

  • Name: CrowdStrike
  • Login: CrowdStrike
  • Kind: organization
  • Email: github@crowdstrike.com
  • Location: United States of America

GitHub Events

Total
  • Create event: 3
  • Release event: 1
  • Issues event: 6
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 2
  • Push event: 5
  • Pull request event: 8
  • Pull request review event: 3
Last Year
  • Create event: 3
  • Release event: 1
  • Issues event: 6
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 2
  • Push event: 5
  • Pull request event: 8
  • Pull request review event: 3

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 33
  • Total Committers: 5
  • Avg Commits per committer: 6.6
  • Development Distribution Score (DDS): 0.364
Past Year
  • Commits: 8
  • Committers: 2
  • Avg Commits per committer: 4.0
  • Development Distribution Score (DDS): 0.125
Top Committers
Name Email Commits
Simon Lukasik s****k@c****m 21
Carlos Matos c****s@c****m 7
dependabot[bot] 4****] 2
Adam Smith a****m@a****m 2
Gabe Alford r****s@g****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 5
  • Total pull requests: 10
  • Average time to close issues: about 2 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 4
  • Total pull request authors: 5
  • Average comments per issue: 0.8
  • Average comments per pull request: 0.1
  • Merged pull requests: 10
  • Bot issues: 0
  • Bot pull requests: 2
Past Year
  • Issues: 3
  • Pull requests: 4
  • Average time to close issues: 4 months
  • Average time to close pull requests: about 5 hours
  • Issue authors: 3
  • Pull request authors: 1
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • carlosmmatos (2)
  • brianjfranklondon (1)
  • jebotha (1)
  • jacreynolds (1)
Pull Request Authors
  • carlosmmatos (6)
  • dependabot[bot] (3)
  • redhatrises (2)
  • asmith-1 (1)
  • isimluk (1)
Top Labels
Issue Labels
documentation (1) enhancement (1) question (1)
Pull Request Labels
documentation (5) dependencies (3) github_actions (3) enhancement (2)

Dependencies

requirements.txt pypi
  • crowdstrike-falconpy *
  • google-api-python-client *
setup.py pypi
  • crowdstrike-falconpy *
  • google-api-python-client *
.github/workflows/container_build.yml actions
  • actions/checkout v3 composite
.github/workflows/docs.yml actions
  • actions/checkout v3 composite
  • gaurav-nelson/github-action-markdown-link-check v1 composite
.github/workflows/linting.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
Dockerfile docker
  • docker.io/python 3-slim-bullseye build