https://github.com/crowdstrike/gcp-vm-manager-os-policy

https://github.com/crowdstrike/gcp-vm-manager-os-policy

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 (8.5%) to scientific vocabulary

Keywords from Contributors

archival projection profiles interactive sequences generic observability autograding hacking shellcodes
Last synced: 11 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: CrowdStrike
  • License: mit
  • Language: Go
  • Default Branch: main
  • Size: 1.45 MB
Statistics
  • Stars: 2
  • Watchers: 4
  • Forks: 1
  • Open Issues: 4
  • Releases: 3
Created over 2 years ago · Last pushed 12 months ago
Metadata Files
Readme License

README.md

cs-policy

A helper tool for deploying CrowdStrike OS Poilcies to GCP Zones. This tool automates many of the manual steps required to create & deploy OS Policies to GCP VMs.

The tool does the following:

  • Downloads the N-1 version of the CrowdStrike Falcon Sensor
  • Uploads the CrowdStrike Falcon Sensors to the GCP Storage Bucket of your choice
  • Generates a OS Policy template for your environment
  • Creates a OS Policy Assignment in the GCP Zones of your choice

terminal

Supported Operating Systems

The CrowdStrike OS Policy currently supports the following operating systems:

| Operating System | Architecture | | -------------------------------------------------------- | ------------- | | Red Hat Enterprise Linux 7 | x8664 | | Red Hat Enterprise Linux 8 | x8664 | | Red Hat Enterprise Linux 9 | x8664 | | CentOS 7 | x8664 | | CentOS 8 | x8664 | | SUSE Linux Enterprise Server 12 | x8664 | | SUSE Linux Enterprise Server 15 | x8664 | | Ubuntu 16.04 | x8664 | | Ubuntu 18.04 | x8664 | | Ubuntu 20.04 | x8664 | | Ubuntu 22.04 | x8664 | | Debian 9 | x8664 | | Debian 10 | x8664 | | Debian 11 | x8664 | | Debian 12 | x8664 | | All Windows Versions supported by the CrowdStrike Sensor | x8664 |

Note: For supported Windows versions, check the CrowdStrike documentation.

Requirements

  • CrowdStrike API Keys with the Sensor Download scope
  • gcloud cli installed
  • Project with VM Manager setup
  • GCP permissions to create OS Policy Assignments and upload files to the target GCP Storage Bucket

GCP VM Manager

OS Policy is a feature of GCP VM Manager. In order to use OS Policies to deploy the CrowdStrike Falcon Sensor, you must setup VM Manager. See the GCP VM Manager documentation for more information about VM Manager and how to set it up.

Generate API Keys

  1. In the CrowdStrike console, navigate to Support and resources > API Clients & Keys. Click Add new API Client.
  2. Add the following api scopes:

    | Scope | Permission | Description | | ------------------- | ---------- | ---------------------------------------------------------------------------- | | Sensor Download | READ | Allows the tool to download the sensor and grab your CID from the CrowdStrike API. |

  3. Click Add to create the API client. The next screen will display the API CLIENT ID, SECRET, and BASE URL. You will need all three for the next step.

    picture

    ![api-client-keys](https://raw.githubusercontent.com/CrowdStrike/aws-ssm-distributor/main/official-package/assets/api-client-keys.png)

[!IMPORTANT] This page is only shown once. Make sure you copy CLIENT ID, SECRET, and BASE URL to a secure location.

  1. Use BASE_URL to infer the FALCON_CLOUD value. | BASE URL | FALCON_CLOUD | | ------------------- | ------------ | | https://api.crowdstrike.com | us-1 | | https://api.us-2.crowdstrike.com | us-2 | | https://api.eu-1.crowdstrike.com | eu-1 | | https://api.laggar.gcw.crowdstrike.com | us-gov-1 |

Installation

Download release binaries that match your platform

Usage

  1. Authenticate with the gcloud CLI.

    bash gcloud auth application-default login

    Note: There are other ways to authenticate with GCP like using a service account. Use whichever method is best for your environment. The cs-policy tool will find the credentials and use them.

  2. Set the project to the project you want to deploy the OS Policies to.

    bash gcloud config set project cs-policy

  3. OPTIONAL: Export the CrowdStrike API keys as environment variables. Alternatively you can provide the keys as command line arguments. See cs-policy create --help for more information.

    bash export FALCON_CLIENT_ID=******** export FALCON_CLIENT_SECRET=******** export FALCON_CLOUD=********

[!IMPORTANT] FALCON_CLOUD supports the following values autodiscover, us-1, us-2, eu-1, us-gov-1. If not provided, the tool will default to autodiscover.

  1. Run the tool.

    bash cs-policy create --bucket=example-bucket --zones=us-central1-a,us-central1-b --linux-install-params='--tags="Washington/DC_USA,Production" --aph=proxy.example.com --app=8080' --windows-install-params='GROUPING_TAGS="Washington/DC_USA,Production" APP_PROXYNAME=proxy.example.com APP_PROXYPORT=8080'

    Use the --help flag to see all available options and more examples.

    bash cs-policy --help

Owner

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

GitHub Events

Total
  • Issues event: 3
  • Watch event: 2
  • Delete event: 5
  • Issue comment event: 10
  • Push event: 9
  • Pull request review event: 2
  • Pull request event: 10
  • Fork event: 1
  • Create event: 4
Last Year
  • Issues event: 3
  • Watch event: 2
  • Delete event: 5
  • Issue comment event: 10
  • Push event: 9
  • Pull request review event: 2
  • Pull request event: 10
  • Fork event: 1
  • Create event: 4

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 17
  • Total Committers: 2
  • Avg Commits per committer: 8.5
  • Development Distribution Score (DDS): 0.118
Past Year
  • Commits: 8
  • Committers: 2
  • Avg Commits per committer: 4.0
  • Development Distribution Score (DDS): 0.25
Top Committers
Name Email Commits
ffalor 3****r 15
dependabot[bot] 4****] 2

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 6
  • Total pull requests: 11
  • Average time to close issues: 1 day
  • Average time to close pull requests: 4 days
  • Total issue authors: 3
  • Total pull request authors: 2
  • Average comments per issue: 1.33
  • Average comments per pull request: 0.09
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 5
Past Year
  • Issues: 2
  • Pull requests: 7
  • Average time to close issues: 1 day
  • Average time to close pull requests: 7 days
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 4.0
  • Average comments per pull request: 0.14
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 5
Top Authors
Issue Authors
  • ffalor (3)
  • PaulYounan (1)
  • thecloudgeek (1)
Pull Request Authors
  • dependabot[bot] (10)
  • ffalor (7)
Top Labels
Issue Labels
enhancement (3)
Pull Request Labels
dependencies (10) go (6)