SOARCA icon indicating copy to clipboard operation
SOARCA copied to clipboard

Fix docs according to feedback

Open RabbITCybErSeC opened this issue 2 years ago • 0 comments

Updates on the docs required:

  • https://cossas.github.io/SOARCA/docs/core-components/api-design/ - “cacao playbook JSON” & “GET /status/playbook”: presents the CACAO v1.1 (instead of CACAO v2)

  • Few URLs are resolving to the main page instead of the dedicated website. (E.g., fin ref for python and go in https://cossas.github.io/SOARCA/docs/soarca-extensions/)

  • https://cossas.github.io/SOARCA/docs/core-components/modules/ - SSH capability: states the support for “private key” authentication. (The correct name is “public key” authentication. Nevertheless, CACAO v2 does not have that capability)

Inconsistency between two pages regarding soarca agent type:

  • https://cossas.github.io/SOARCA/docs/core-components/executer/ - Native capabilities: “... The convention is that the agent type must equal soarca-, e.g. soarca-ssh or soarca-openc2-http.”
  • https://cossas.github.io/SOARCA/docs/core-components/modules/ - Native modules in SOARCA: “... The agent should be of type soarca and have a name corresponding to soarca-[capability name].”

RabbITCybErSeC avatar Mar 19 '24 15:03 RabbITCybErSeC