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

Feature/docs/18 docs update #20

Merged
merged 30 commits into from
Mar 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
cc96ce1
fixed .gitignore because of the folder switch
RabbITCybErSeC Mar 7, 2024
2842a0f
removal of netilfy toml + eu section + special thanks
RabbITCybErSeC Mar 7, 2024
2109820
updated a path for one image
RabbITCybErSeC Mar 7, 2024
cff1a0e
Add info on capabilities
hidde-jan Mar 7, 2024
b545a59
Fix directory name
hidde-jan Mar 8, 2024
30cbd85
Add primer on playbooks
hidde-jan Mar 8, 2024
679f8e5
Fix spelling
hidde-jan Mar 8, 2024
e6423a5
Fixed many typos and grammar errors in documentation
Mar 8, 2024
cd238cc
update on eu text according to feedback
RabbITCybErSeC Mar 8, 2024
5fd31c2
feedback on the sections
RabbITCybErSeC Mar 8, 2024
281ad95
typo's
RabbITCybErSeC Mar 8, 2024
1886144
added e-mail
RabbITCybErSeC Mar 8, 2024
d667f77
added slack channel
RabbITCybErSeC Mar 8, 2024
bc3bd75
added slack link
RabbITCybErSeC Mar 8, 2024
19f83bb
changed svg to png for better visibilty
RabbITCybErSeC Mar 8, 2024
2d1b133
Revert "changed svg to png for better visibilty"
RabbITCybErSeC Mar 8, 2024
507d72e
Auto stash before revert of "changed svg to png for better visibilty"
RabbITCybErSeC Mar 8, 2024
a50a2df
link update on communication channels
RabbITCybErSeC Mar 8, 2024
81b4d54
Updated contribution guidelines
MaartendeKruijf Mar 14, 2024
d3b8ad2
Updated text according to review result from RK
MaartendeKruijf Mar 14, 2024
59f2699
updated new brackground
RabbITCybErSeC Mar 14, 2024
b2fb2b1
added better scaling for 4k sizes of the background
RabbITCybErSeC Mar 14, 2024
75bdd5f
Update docs according to feedback
hidde-jan Mar 15, 2024
0e54208
Fix condition in example playbook
hidde-jan Mar 15, 2024
f6980d7
changed tagcloud to tags
RabbITCybErSeC Mar 15, 2024
4bb7451
change privacy statement link
RabbITCybErSeC Mar 15, 2024
673b725
removed blog contents
RabbITCybErSeC Mar 15, 2024
e6bc93d
Fixed uuids to be in line with playbook
MaartendeKruijf Mar 15, 2024
583db8f
Link to modules
MaartendeKruijf Mar 15, 2024
7f73ea2
added links to the discussions page
RabbITCybErSeC Mar 15, 2024
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
13 changes: 7 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,10 @@ test/cacao/flatfile-db-example.json
test/routes/__debug_bin2988553005


documentation/public
documentation/resources/
documentation/node_modules/
documentation/package-lock.json
documentation/.hugo_build.lock
**.hugo_build.lock
docs/public
docs/resources/
docs/node_modules/
docs/package-lock.json
docs/.hugo_build.lock
**.hugo_build.lock

8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ Security Orchestrator for Advanced Response to Cyber Attacks

SOARCA the TNO orchestrator for Open-C2, CACAO and STIX

## building / starting / stopping
## Building / starting / stopping
Install go via https://go.dev/doc/install

Install go plugin in VSCode
Install the go plugin in VSCode

project layout https://github.com/golang-standards/project-layout

Expand All @@ -21,7 +21,7 @@ make run


## Documentation
For documentation we use Markdown + [plantUML](https://plantuml.com/).
For documentation, we use Markdown + [plantUML](https://plantuml.com/).

Documentation will be stored in the [doc](doc/) folder.

Expand All @@ -31,7 +31,7 @@ To get started with plantUML in Markdown please install the following components
Markdown Kroki
VS Marketplace Link: https://marketplace.visualstudio.com/items?itemName=pomdtr.markdown-kroki

Once you installed them please enable Kroki in the settings, and add the following to use a non public Kroki server:
Once you installed them please enable Kroki in the settings, and add the following to use a non-public Kroki server:



Expand Down
2 changes: 0 additions & 2 deletions docs/content/en/blog/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,4 @@ title: Blog
menu: {main: {weight: 30}}
---

This is the **blog** section. It has two categories: News and Releases.

Files in these directories will be listed in reverse chronological order.
34 changes: 1 addition & 33 deletions docs/content/en/blog/news/first-post/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,44 +4,12 @@ title: SOARCA First release
linkTitle: Announcing SOARCA
description: >

author: Maarten de Kruijf, and Jan-Paul Konijn
author: authors
resources:
- src: "**.{png,jpg}"
title: "Image #:counter"
params:
byline: "Photo: any / CC-BY-CA"
---

**This is a typical blog post that includes images.**

The front matter specifies the date of the blog post, its title, a short description that will be displayed on the blog landing page, and its author.

## Including images

Here's an image (`featured-sunset-get.png`) that includes a byline and a caption.

{{< imgproc sunset Fill "600x300" >}}
Fetch and scale an image in the upcoming Hugo 0.43.
{{< /imgproc >}}

The front matter of this post specifies properties to be assigned to all image resources:

```
resources:
- src: "**.{png,jpg}"
title: "Image #:counter"
params:
byline: "Photo: Riona MacNamara / CC-BY-CA"
```

To include the image in a page, specify its details like this:

```
{{< imgproc sunset Fill "600x300" >}}
Fetch and scale an image in the upcoming Hugo 0.43.
{{< /imgproc >}}
```

The image will be rendered at the size and byline specified in the front matter.


Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,5 @@
title: SOARCA V1.0
date: 2023-01-04
description: >
A short lead description about this content page. Text here can also be
**bold** or _italic_ and can even be split over multiple paragraphs.

---
2 changes: 1 addition & 1 deletion docs/content/en/docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ weight: 21

### Does SOARCA have a GUI?

SOARCA currently does not feature a GUI for tracking the progress on playbook execution. Too edit [CACAO v2.0](https://docs.oasis-open.org/cacao/security-playbooks/v2.0/security-playbooks-v2.0.html) playbooks, consider using the [CACAO Roaster](https://github.com/opencybersecurityalliance/cacao-roaster) project.
SOARCA currently does not feature a GUI for tracking the progress of playbook execution. To edit [CACAO v2.0](https://docs.oasis-open.org/cacao/security-playbooks/v2.0/security-playbooks-v2.0.html) playbooks, consider using the [CACAO Roaster](https://github.com/opencybersecurityalliance/cacao-roaster) project.

18 changes: 8 additions & 10 deletions docs/content/en/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,16 @@ weight: 20


{{% alert title="Warning" color="warning" %}}
SOARCA is currently in its **alpha release**, with ongoing evelopment aimed at expanding its capabilities, improving integration, and enhancing its functionalities. You can track our progress and upcoming milestones at [LINK TO ROADMAP].
SOARCA is currently in its **alpha release**, with ongoing development aimed at expanding its capabilities, improving integration, and enhancing its functionalities. You can track our progress and upcoming milestones at [LINK TO ROADMAP].

We warmly welcome contributions to our repository. You can find the guidelines for contributing [here](/docs/contribution-guidelines).
{{% /alert %}}

SOARCA, an open-source SOAR (Security Orchestration, Automation and Response) tool developed by TNO, is designed be vendor-agnostic, allowing it to orchestrate various security actuators and systems. SOARCA is the first SOAR that aims to be compliant with the [CACAO v2.0](https://docs.oasis-open.org/cacao/security-playbooks/v2.0/security-playbooks-v2.0.html) standard.
SOARCA, an open-source SOAR (Security Orchestration, Automation and Response) tool developed by TNO, is designed be vendor-agnostic, allowing it to orchestrate various security actuators and systems. It is the first open-source SOAR that aims to be compliant with the [CACAO v2.0](https://docs.oasis-open.org/cacao/security-playbooks/v2.0/security-playbooks-v2.0.html) standard.

SOARCA enables cyber defenders to coordinate and automate their cyber operations, by using executable CACAO playbooks.
SOARCA enables cyber defenders to coordinate and automate their cyber operations, by using executable CACAO playbooks, and aims to achieve the following goals:

SOARCA aims to achieve the following goals:

- **Standard Compliance**: Adhering to the latest standards, including [CACAO v2.0](https://docs.oasis-open.org/cacao/security-playbooks/v2.0/security-playbooks-v2.0.html) and [OpenC2](https://openc2.org/), allows for interopability with a wide range of technologies.
- **Standard Compliance**: Adhering to the latest standards, including [CACAO v2.0](https://docs.oasis-open.org/cacao/security-playbooks/v2.0/security-playbooks-v2.0.html) and [OpenC2](https://openc2.org/), allows for interoperability with a wide range of technologies.
- **Extensibility with Open Interfaces**: Enjoy the flexibility of an extensible tool featuring open and well-defined interfaces, promoting adaptability, customization, and experimentation.
- **Open-Source**: Embrace an open-source model that not only offers cost-effective solutions but also supports unrestricted use and adaptation for research purposes.

Expand All @@ -33,15 +31,15 @@ SOARCA currently supports the following transport mechanisms:
<div class="works-well-with">
{{< cardpane >}}
{{% card header="OpenC2 - Native" %}}
[![OpenC2](/SOARCA/images/logos-external/openc2.svg)](/docs/soarca-extentions/native-capabilities/#openc2-capability)
[![OpenC2](/SOARCA/images/logos-external/openc2.svg)](/docs/soarca-extensions/native-capabilities/#openc2-capability)
{{% /card %}}

{{% card header="HTTP - Native" %}}
[![Http](/SOARCA/images/logos-external/http.svg)](/docs/soarca-extentions/native-capabilities/#http-api-capability)
[![Http](/SOARCA/images/logos-external/http.svg)](/docs/soarca-extensions/native-capabilities/#http-api-capability)
{{% /card %}}

{{% card header="SSH - Native" %}}
[![Ssh](/SOARCA/images/logos-external/ssh.svg)](/docs/soarca-extentions/native-capabilities/#ssh-capability)
[![Ssh](/SOARCA/images/logos-external/ssh.svg)](/docs/soarca-extensions/native-capabilities/#ssh-capability)
{{% /card %}}
{{< /cardpane >}}
</div>
Expand All @@ -54,5 +52,5 @@ SOARCA currently supports the following transport mechanisms:
## Where do I start?

{{% alert title="Follow our getting started!" color="primary" %}}
Following our [Getting started](/docs/getting-started/) guide will help you setup SOARCA and configure the SOAR for your internal security tooling. For more custom requirement
Following our [Getting started](/docs/getting-started/) guide will help you set up SOARCA and configure the SOAR for your internal security tooling. For more custom requirement
{{% /alert %}}
25 changes: 21 additions & 4 deletions docs/content/en/docs/about/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,32 @@ description:

## About COSSAS

SOARCA finds its home within the Community for Open Source Security Automation Software (COSSAS). [COSSAS](https://cossas-project.org/') offers a continuously expanding base of novel software components for cyber security automation that SOC, CERT and CTI professionals can deploy and trial in their own operational environments. COSSAS is an initiative of the TNO.
SOARCA finds its home within the Community for Open Source Security Automation Software (COSSAS). [COSSAS](https://cossas-project.org/') offers a continuously expanding base of novel software components for cyber security automation that SOC, CERT and CTI professionals can deploy and trial in their operational environments. COSSAS is an initiative of TNO.

## About TNO

SOARCA is an project initiated and support by [TNO](https://tno.nl), the Netherlands Organisation for Applied Scientific Research. TNO, an independent research, development, and consultancy organization in the Netherlands, is dedicated to driving innovation for a safer, healthier, and more sustainable life. TNO focuses on areas such as sustainability, health, safety, and digital transformation. The mission is to make knowledge serve the common good, connecting expertise to create impactful innovations. TNO actively engages with society, aiming for positive impact through its work and insights. Learn more about TNO on their official website .
SOARCA is a project initiated and supported by [TNO](https://tno.nl), the Netherlands Organisation for Applied Scientific Research. TNO, an independent research, development, and consultancy organization in the Netherlands, is dedicated to driving innovation for a safer, healthier, and more sustainable life. TNO focuses on areas such as sustainability, health, safety, and digital transformation. Its mission is to make knowledge serve the common good, connecting expertise to create impactful innovations. TNO actively engages with society, aiming for a positive impact through its work and insights. Learn more about TNO on their official [website](https://tno.nl).


## Developers
## Core Team

- Maarten de Kruijf (TNO)
- Jan-Paul Konijn (TNO)
- Hidde-Jan Jongsma (TNO)
- Luca Morgese (TNO)
- Richard Kerkdijk (TNO)
- Frank Fransen (TNO)
- Shari Finner (TNO)

## Special Thanks

## Special Thanks
A special thanks to:

- Sebastiaan Huskins for laying the initial and technical foundation for SOARCA.
- Myla Fransen for the logo designs.

## About SOARCA

This work has received funding from the European Union’s Horizon Europe Energy Research and Innovation programme under Grant Agreement No. 101075665 ([eFORT](https://efort-project.eu/) project) and the European Defence Fund (EDF) under Grant Agreement No. 101103385 ([AInception](https://www.ainception.eu/) project). Views and opinions expressed in this documentation are those of the authors only and do not necessarily reflect those of the European Union. Neither the European Union nor the granting authority can be held responsible for them.

![eu-funded](/SOARCA/images/eu-funded-logo.png)
Loading