diff --git a/docs/plugins/crowdstrike/_index.md b/docs/plugins/crowdstrike/_index.md new file mode 100644 index 00000000..cbf578ee --- /dev/null +++ b/docs/plugins/crowdstrike/_index.md @@ -0,0 +1,31 @@ +--- +title: blackstork/crowdstrike +weight: 20 +plugin: + name: blackstork/crowdstrike + description: "" + tags: [] + version: "v0.4.2" + source_github: "https://github.com/blackstork-io/fabric/tree/main/internal/crowdstrike/" +type: docs +hideInMenu: true +--- + +{{< plugin-header "blackstork/crowdstrike" "crowdstrike" "v0.4.2" >}} + +## Installation + +To install the plugin, add it to `plugin_versions` map in the Fabric global configuration block (see [Global configuration]({{< ref "configs.md#global-configuration" >}}) for more details), with a version constraint restricting which available versions of the plugin the codebase is compatible with: + +```hcl +fabric { + plugin_versions = { + "blackstork/crowdstrike" = ">= v0.4.2" + } +} +``` + + +## Data sources + +{{< plugin-resources "crowdstrike" "data-source" >}} diff --git a/docs/plugins/crowdstrike/data-sources/falcon_cspm_ioms.md b/docs/plugins/crowdstrike/data-sources/falcon_cspm_ioms.md new file mode 100644 index 00000000..b66fe9ac --- /dev/null +++ b/docs/plugins/crowdstrike/data-sources/falcon_cspm_ioms.md @@ -0,0 +1,87 @@ +--- +title: "`falcon_cspm_ioms` data source" +plugin: + name: blackstork/crowdstrike + description: "The `falcon_cspm_ioms` data source fetches cloud indicators of misconfigurations (IOMs) from the Falcon security posture management (CSPM) feature" + tags: [] + version: "v0.4.2" + source_github: "https://github.com/blackstork-io/fabric/tree/main/internal/crowdstrike/" +resource: + type: data-source +type: docs +--- + +{{< breadcrumbs 2 >}} + +{{< plugin-resource-header "blackstork/crowdstrike" "crowdstrike" "v0.4.2" "falcon_cspm_ioms" "data source" >}} + +## Description +The `falcon_cspm_ioms` data source fetches cloud indicators of misconfigurations (IOMs) from the Falcon security posture management (CSPM) feature + +## Installation + +To use `falcon_cspm_ioms` data source, you must install the plugin `blackstork/crowdstrike`. + +To install the plugin, add the full plugin name to the `plugin_versions` map in the Fabric global configuration block (see [Global configuration]({{< ref "configs.md#global-configuration" >}}) for more details), as shown below: + +```hcl +fabric { + plugin_versions = { + "blackstork/crowdstrike" = ">= v0.4.2" + } +} +``` + +Note the version constraint set for the plugin. + +## Configuration + +The data source supports the following configuration arguments: + +```hcl +config data falcon_cspm_ioms { + # Client ID for accessing CrowdStrike Falcon Platform + # + # Required string. + # Must be non-empty + # For example: + client_id = "some string" + + # Client Secret for accessing CrowdStrike Falcon Platform + # + # Required string. + # Must be non-empty + # For example: + client_secret = "some string" + + # Member CID for MSSP + # + # Optional string. + # Default value: + member_cid = null + + # Falcon cloud abbreviation + # + # Optional string. + # Must be one of: "autodiscover", "us-1", "us-2", "eu-1", "us-gov-1", "gov1" + # For example: + # client_cloud = "us-1" + # + # Default value: + client_cloud = null +} +``` + +## Usage + +The data source supports the following execution arguments: + +```hcl +data falcon_cspm_ioms { + # limit the number of queried items + # + # Required integer. + # For example: + size = 42 +} +``` \ No newline at end of file diff --git a/docs/plugins/plugins.json b/docs/plugins/plugins.json index c55d36e6..256e24dc 100644 --- a/docs/plugins/plugins.json +++ b/docs/plugins/plugins.json @@ -133,6 +133,26 @@ } ] }, + { + "name": "blackstork/crowdstrike", + "version": "v0.4.2", + "shortname": "crowdstrike", + "resources": [ + { + "name": "falcon_cspm_ioms", + "type": "data-source", + "config_params": [ + "client_cloud", + "client_id", + "client_secret", + "member_cid" + ], + "arguments": [ + "size" + ] + } + ] + }, { "name": "blackstork/elastic", "version": "v0.4.2", diff --git a/tools/docgen/main.go b/tools/docgen/main.go index c99b5b2e..9538df2b 100644 --- a/tools/docgen/main.go +++ b/tools/docgen/main.go @@ -16,6 +16,7 @@ import ( "github.com/spf13/pflag" "github.com/blackstork-io/fabric/internal/builtin" + "github.com/blackstork-io/fabric/internal/crowdstrike" "github.com/blackstork-io/fabric/internal/elastic" "github.com/blackstork-io/fabric/internal/github" "github.com/blackstork-io/fabric/internal/graphql" @@ -278,6 +279,7 @@ func main() { nistnvd.Plugin(version, nil), snyk.Plugin(version, nil), microsoft.Plugin(version, nil, nil, nil), + crowdstrike.Plugin(version, nil), } // generate markdown for each plugin for _, p := range plugins {