Skip to content

Commit

Permalink
chore: gen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
anasmuhmd committed Nov 20, 2024
1 parent a8f38ab commit 2138288
Show file tree
Hide file tree
Showing 4 changed files with 212 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/plugins/misp/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: blackstork/misp
weight: 20
plugin:
name: blackstork/misp
description: ""
tags: []
version: "v0.4.2"
source_github: "https://github.com/blackstork-io/fabric/tree/main/internal/misp/"
type: docs
hideInMenu: true
---

{{< plugin-header "blackstork/misp" "misp" "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/misp" = ">= v0.4.2"
}
}
```


## Data sources

{{< plugin-resources "misp" "data-source" >}}
143 changes: 143 additions & 0 deletions docs/plugins/misp/data-sources/misp_events.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
---
title: "`misp_events` data source"
plugin:
name: blackstork/misp
description: "The `misp_events` data source fetches MISP events"
tags: []
version: "v0.4.2"
source_github: "https://github.com/blackstork-io/fabric/tree/main/internal/misp/"
resource:
type: data-source
type: docs
---

{{< breadcrumbs 2 >}}

{{< plugin-resource-header "blackstork/misp" "misp" "v0.4.2" "misp_events" "data source" >}}

## Description
The `misp_events` data source fetches MISP events

## Installation

To use `misp_events` data source, you must install the plugin `blackstork/misp`.

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/misp" = ">= v0.4.2"
}
}
```

Note the version constraint set for the plugin.

## Configuration

The data source supports the following configuration arguments:

```hcl
config data misp_events {
# misp api key
#
# Required string.
# Must be non-empty
# For example:
api_key = "some string"
# misp base url
#
# Required string.
# Must be non-empty
# For example:
base_url = "some string"
# skip ssl verification
#
# Optional bool.
# Default value:
skip_ssl = false
}
```

## Usage

The data source supports the following execution arguments:

```hcl
data misp_events {
# Required string.
# For example:
value = "some string"
# Optional string.
# Default value:
type = null
# Optional string.
# Default value:
category = null
# Optional string.
# Default value:
org = null
# Optional list of string.
# Default value:
tags = null
# Optional list of string.
# Default value:
event_tags = null
# Optional string.
# Default value:
searchall = null
# Optional string.
# Default value:
from = null
# Optional string.
# Default value:
to = null
# Optional string.
# Default value:
last = null
# Optional number.
# Default value:
event_id = null
# Optional bool.
# Default value:
with_attachments = null
# Optional list of string.
# Default value:
sharing_groups = null
# Optional bool.
# Default value:
only_metadata = null
# Optional string.
# Default value:
uuid = null
# Optional bool.
# Default value:
include_sightings = null
# Optional number.
# Default value:
threat_level_id = null
# Optional number.
# Default value:
limit = 10
}
```
36 changes: 36 additions & 0 deletions docs/plugins/plugins.json
Original file line number Diff line number Diff line change
Expand Up @@ -534,6 +534,42 @@
}
]
},
{
"name": "blackstork/misp",
"version": "v0.4.2",
"shortname": "misp",
"resources": [
{
"name": "misp_events",
"type": "data-source",
"config_params": [
"api_key",
"base_url",
"skip_ssl"
],
"arguments": [
"category",
"event_id",
"event_tags",
"from",
"include_sightings",
"last",
"limit",
"only_metadata",
"org",
"searchall",
"sharing_groups",
"tags",
"threat_level_id",
"to",
"type",
"uuid",
"value",
"with_attachments"
]
}
]
},
{
"name": "blackstork/nist_nvd",
"version": "v0.4.2",
Expand Down
2 changes: 2 additions & 0 deletions tools/docgen/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"github.com/blackstork-io/fabric/internal/hackerone"
"github.com/blackstork-io/fabric/internal/iris"
"github.com/blackstork-io/fabric/internal/microsoft"
"github.com/blackstork-io/fabric/internal/misp"
"github.com/blackstork-io/fabric/internal/nistnvd"
"github.com/blackstork-io/fabric/internal/openai"
"github.com/blackstork-io/fabric/internal/opencti"
Expand Down Expand Up @@ -282,6 +283,7 @@ func main() {
microsoft.Plugin(version, nil, nil, nil, nil),
crowdstrike.Plugin(version, nil),
iris.Plugin(version, nil),
misp.Plugin(version, nil),
}
// generate markdown for each plugin
for _, p := range plugins {
Expand Down

0 comments on commit 2138288

Please sign in to comment.