Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Openapi viewer sicalert #2206

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 0 additions & 6 deletions .github/workflows/deploy-public-website.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,6 @@ jobs:
- name: Make destination directory for compiled CSS
run: mkdir -vp docs/stylesheets/

- name: Compile CSS from SCSS files
uses: gha-utilities/[email protected]
with:
source: src/sekoiaio.scss
destination: docs/stylesheets/sekoiaio.css

- name: Install Poetry
run: |
pip install poetry
Expand Down
6 changes: 0 additions & 6 deletions .github/workflows/preview.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,6 @@ jobs:
- name: Make destination directory for compiled CSS
run: mkdir -vp docs/stylesheets/

- name: Compile CSS from SCSS files
uses: gha-utilities/[email protected]
with:
source: src/sekoiaio.scss
destination: docs/stylesheets/sekoiaio.css

- name: Install Poetry
run: |
pip install poetry
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.idea
site
docs/stylesheets/sekoiaio.css
docs/stylesheets/openapi.css
venv
*~
redoc.egg-info
Expand Down
6 changes: 5 additions & 1 deletion _shared_content/automate/library/atlassian-jira.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ Add comment to an issue in JIRA

Create issue in JIRA

**Configuration**

{'title': 'Description', 'description': 'Description text in ADF (Atlassian Document Format)', 'type': 'object'}

**Arguments**

| Name | Type | Description |
Expand All @@ -70,4 +74,4 @@ Create issue in JIRA

## Extra

Module **`Atlassian JIRA` v1.2.0**
Module **`Atlassian JIRA` v1.3.0**
99 changes: 99 additions & 0 deletions _shared_content/automate/library/eset.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
uuid: 91140c5a-770f-44c6-81ce-ea57daf3fe34
name: Eset
type: playbook

# Eset

![Eset](/assets/playbooks/library/eset.png){ align=right width=150 }

ESET is a global cybersecurity company known for its antivirus and security software solutions for both businesses and consumers, providing advanced threat detection and malware protection.

## Configuration

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `region` | `string` | Region |
| `username` | `string` | Username |
| `password` | `string` | Password |

## Actions

### Deisolate endpoints

Deisolate a list of endpoints

**Configuration**

{'description': 'The reason of the deisolation', 'type': 'string'}

**Arguments**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `device_uuids` | `array` | The identifiers of the endpoints to deisolate |
| `display_name` | `string` | A name for the action |
| `description` | `string` | The reason of the deisolation |


**Outputs**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `status_code` | `integer` | HTTP status code |
| `body` | `object` | API Response |

### Isolate endpoints

Isolate a list of endpoints

**Configuration**

{'description': 'The reason of the isolation', 'type': 'string'}

**Arguments**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `device_uuids` | `array` | The identifiers of the endpoints to isolate |
| `display_name` | `string` | A name for the action |
| `description` | `string` | The reason of the isolation |


**Outputs**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `status_code` | `integer` | HTTP status code |
| `body` | `object` | API Response |

### Init a scan

Initialize a scan on a list of endpoints

**Configuration**

{'description': 'The reason of the scan', 'type': 'string'}

**Arguments**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `device_uuids` | `array` | The identifiers of the endpoints to scan |
| `scan_profile` | `string` | The profile of the scan |
| `display_name` | `string` | A name for the action |
| `description` | `string` | The reason of the scan |
| `cleaning_enabled` | `boolean` | Enable the cleaning |
| `shutdown_enabled` | `boolean` | Shutdown the endpoints after the scan |


**Outputs**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `status_code` | `integer` | HTTP status code |
| `body` | `object` | API Response |


## Extra

Module **`Eset` v1.0.0**
130 changes: 124 additions & 6 deletions _shared_content/automate/library/glimps.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,112 @@ type: playbook

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `base_url` | `string` | Glimps base URL (ex. https://gmalware.ggp.glimps.re) |
| `api_key` | `string` | APIKEY for the Glimps's API |
| `api_key` | `string` | Glimps detect token |
| `base_url` | `string` | Glimps detect url |

## Actions

### Get the results of an analysis
### [TEST] Analyse a file

Submit file to Glimps Detect to be analysed

**Configuration**

{'title': 'Description', 'description': 'Description added to the analysis', 'type': 'string'}

**Arguments**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `file_name` | `string` | Name of submitted file |
| `bypass_cache` | `boolean` | If true, file is analyzed, even if a result already exists |
| `user_tags` | `array` | Analysis will be tagged with those tags |
| `description` | `string` | Description added to the analysis |
| `archive_pwd` | `string` | Password used to extract archive |
| `push_timeout` | `number` | Maximum time (in seconds) to wait for a response when submitting file |


**Outputs**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `status` | `boolean` | False means that an error occured |
| `uuid` | `string` | UUID of the submitted analysis |

### [TEST] Analyse a file and wait for result

Submit file to Glimps Detect to be analysed and wait for its results

**Configuration**

{'title': 'Description', 'description': 'Description added to the analysis', 'type': 'string'}

**Arguments**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `file_name` | `string` | Name of submitted file |
| `bypass_cache` | `boolean` | If true, file is analyzed, even if a result already exists |
| `user_tags` | `array` | Analysis will be tagged with those tags |
| `description` | `string` | Description added to the analysis |
| `archive_pwd` | `string` | Password used to extract archive |
| `push_timeout` | `number` | Maximum time (in seconds) to wait for a response when submitting file |
| `pull_time` | `number` | Time to wait (in seconds) between each requests to get a result |
| `timeout` | `number` | Maximum time (in seconds) to wait for the analysis to end |


**Outputs**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `analysis` | `` | Analysis response details |
| `view_url` | `string` | Analysis URL |

### [TEST] Export analysis result

Export analysis result with the requested layout and format

**Arguments**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `uuid` | `string` | Unique analysis identifier |
| `format` | `string` | Export format |
| `layout` | `string` | Export layout |
| `is_full` | `string` | Export full analysis or summarized |

### [TEST] Get profile status

Get Glimps detect profile status, it includes quotas, eastimated analysis duration and cache

**Outputs**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `daily_quota` | `integer` | Number of submissions authorized for the profile within 24h |
| `available_daily_quota` | `integer` | Number of submissions still available within 24h. It's a sliding window, so a new slot will be released 24h after each submission |
| `cache` | `boolean` | If True, the profile is configured to use cached result by default |
| `estimated_analysis_duration` | `integer` | Estimation of the duration for the next submissions in milliseconds. It's based on the average time of submissions and the submission queue state. The real duration could differ from the estimation |

### [TEST] Retrieve analysis

Retrieve the analysis matching the given uuid

**Arguments**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `uuid` | `string` | UUID of the analysis |


**Outputs**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `analysis` | `` | Analysis response details |
| `view_url` | `string` | Analysis URL |

### [Deprecated] Get the results of an analysis



Expand Down Expand Up @@ -54,7 +154,7 @@ type: playbook
| `token` | `string` | token that can be used to view analysis result in expert view |
| `uuid` | `string` | Unique analysis identifier |

### Search previous analysis
### [Deprecated] Search previous analysis



Expand Down Expand Up @@ -91,7 +191,25 @@ type: playbook
| `token` | `string` | token that can be used to view analysis result in expert view |
| `uuid` | `string` | Unique analysis identifier<br/> |

### Analyse a file
### Search analysis

Search an analysis for a given sha256 input file

**Arguments**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `sha256` | `string` | SHA256 of file to search |


**Outputs**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `analysis` | `` | Analysis response details |
| `view_url` | `string` | Analysis URL |

### [Deprecated] Analyse a file



Expand All @@ -114,4 +232,4 @@ type: playbook

## Extra

Module **`GLIMPS` v1.13.0**
Module **`GLIMPS` v1.14.2**
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ Search in AD

## Extra

Module **`Microsoft Active Directory` v1.3.7**
Module **`Microsoft Active Directory` v1.3.8**
Loading