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.

Sign up for GitHub

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

Add documentation on how to run the UI plugins #1088

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add documentation on how to run the UI plugins #1088

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions plugins/external_lookup/assemblyline_lookup/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Assemblyline 4 - Assemblyline UI Plugin

This UI plugin allows you to pull in information from another Assemblyline instance about tagged IOCs or file hashes to display within Assemblyline.

## Image variants and tags

| **Tag Type** | **Description** | **Example Tag** |
| :----------: | :----------------------------------------------------------------------------------------------- | :------------------------: |
| latest | The most recent build (can be unstable). | `latest` |
| build_type | The type of build used. `dev` is the latest unstable build. `stable` is the latest stable build. | `stable` or `dev` |
| series | Complete build details, including version and build type: `version.buildType`. | `4.5.stable`, `4.5.1.dev3` |

#### Running this component

```bash
docker run --name ui-plugin-lookup-assemblyline cccs/assemblyline-ui-plugin-lookup-assemblyline
```

## Documentation

For more information about this Assemblyline component, follow this [overview](https://cybercentrecanada.github.io/assemblyline4_docs/overview/architecture/) of the system's architecture.

---

# Assemblyline 4 - Assemblyline UI Plugin

Ce plugin d'interface utilisateur vous permet d'extraire de l'information d'une autre instance d'Assemblyline sur les IOCs marqués ou les hashs de fichiers pour les afficher dans Assemblyline.

## Variantes et étiquettes d'image

| **Type d'étiquette** | **Description** | **Exemple d'étiquette** |
| :------------------: | :--------------------------------------------------------------------------------------------------------------- | :------------------------: |
| dernière | La version la plus récente (peut être instable). | `latest` |
| build_type | Le type de compilation utilisé. `dev` est la dernière version instable. `stable` est la dernière version stable. | `stable` ou `dev` |
| séries | Le détail de compilation utilisé, incluant la version et le type de compilation : `version.buildType`. | `4.5.stable`, `4.5.1.dev3` |

#### Exécuter ce composant

```bash
docker run --name ui-plugin-lookup-assemblyline cccs/assemblyline-ui-plugin-lookup-assemblyline
```

## Documentation

Pour plus d'informations sur ce composant Assemblyline, suivez ce [overview](https://cybercentrecanada.github.io/assemblyline4_docs/overview/architecture/) de l'architecture du système.
45 changes: 45 additions & 0 deletions plugins/external_lookup/malware_bazaar/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Assemblyline 4 - MalwareBazaar UI Plugin

This UI plugin allows you to pull in information from MalwareBazaar about tagged IOCs or file hashes to display within Assemblyline.

## Image variants and tags

| **Tag Type** | **Description** | **Example Tag** |
| :----------: | :----------------------------------------------------------------------------------------------- | :------------------------: |
| latest | The most recent build (can be unstable). | `latest` |
| build_type | The type of build used. `dev` is the latest unstable build. `stable` is the latest stable build. | `stable` or `dev` |
| series | Complete build details, including version and build type: `version.buildType`. | `4.5.stable`, `4.5.1.dev3` |

#### Running this component

```bash
docker run --name ui-plugin-lookup-malwarebazaar cccs/assemblyline-ui-plugin-lookup-malwarebazaar
```

## Documentation

For more information about this Assemblyline component, follow this [overview](https://cybercentrecanada.github.io/assemblyline4_docs/overview/architecture/) of the system's architecture.

---

# Assemblyline 4 - MalwareBazaar UI Plugin

Ce plugin d'interface utilisateur vous permet d'extraire des informations de MalwareBazaar sur les IOC marqués ou les hachages de fichiers pour les afficher dans Assemblyline.

## Variantes et étiquettes d'image

| **Type d'étiquette** | **Description** | **Exemple d'étiquette** |
| :------------------: | :--------------------------------------------------------------------------------------------------------------- | :------------------------: |
| dernière | La version la plus récente (peut être instable). | `latest` |
| build_type | Le type de compilation utilisé. `dev` est la dernière version instable. `stable` est la dernière version stable. | `stable` ou `dev` |
| séries | Le détail de compilation utilisé, incluant la version et le type de compilation : `version.buildType`. | `4.5.stable`, `4.5.1.dev3` |

#### Exécuter ce composant

```bash
docker run --name ui-plugin-lookup-malwarebazaar cccs/assemblyline-ui-plugin-lookup-malwarebazaar
```

## Documentation

Pour plus d'informations sur ce composant Assemblyline, suivez ce [overview](https://cybercentrecanada.github.io/assemblyline4_docs/overview/architecture/) de l'architecture du système.
45 changes: 45 additions & 0 deletions plugins/external_lookup/virustotal/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Assemblyline 4 - VirusTotal UI Plugin

This UI plugin allows you to pull in information from VirusTotal about tagged IOCs or file hashes to display within Assemblyline.

## Image variants and tags

| **Tag Type** | **Description** | **Example Tag** |
| :----------: | :----------------------------------------------------------------------------------------------- | :------------------------: |
| latest | The most recent build (can be unstable). | `latest` |
| build_type | The type of build used. `dev` is the latest unstable build. `stable` is the latest stable build. | `stable` or `dev` |
| series | Complete build details, including version and build type: `version.buildType`. | `4.5.stable`, `4.5.1.dev3` |

#### Running this component

```bash
docker run --name ui-plugin-lookup-virustotal cccs/assemblyline-ui-plugin-lookup-virustotal
```

## Documentation

For more information about this Assemblyline component, follow this [overview](https://cybercentrecanada.github.io/assemblyline4_docs/overview/architecture/) of the system's architecture.

---

# Assemblyline 4 - VirusTotal UI Plugin

Ce plugin d'interface utilisateur vous permet d'extraire des informations de VirusTotal sur les IOC marqués ou les hachages de fichiers pour les afficher dans Assemblyline.

## Variantes et étiquettes d'image

| **Type d'étiquette** | **Description** | **Exemple d'étiquette** |
| :------------------: | :--------------------------------------------------------------------------------------------------------------- | :------------------------: |
| dernière | La version la plus récente (peut être instable). | `latest` |
| build_type | Le type de compilation utilisé. `dev` est la dernière version instable. `stable` est la dernière version stable. | `stable` ou `dev` |
| séries | Le détail de compilation utilisé, incluant la version et le type de compilation : `version.buildType`. | `4.5.stable`, `4.5.1.dev3` |

#### Exécuter ce composant

```bash
docker run --name ui-plugin-lookup-virustotal cccs/assemblyline-ui-plugin-lookup-virustotal
```

## Documentation

Pour plus d'informations sur ce composant Assemblyline, suivez ce [overview](https://cybercentrecanada.github.io/assemblyline4_docs/overview/architecture/) de l'architecture du système.