From f6f40ecddb9cc49877f749dcf1e034db2231aa3d Mon Sep 17 00:00:00 2001 From: Koen Van Impe Date: Sat, 12 Jun 2021 01:44:37 +0200 Subject: [PATCH] Summary Suggestions for format --- .../common-exercise-format-cexf/README.md | 15 +++++++- .../format-description.md | 37 +++++++++++++++++++ 2 files changed, 51 insertions(+), 1 deletion(-) create mode 100644 exercises/common-exercise-format-cexf/format-description.md diff --git a/exercises/common-exercise-format-cexf/README.md b/exercises/common-exercise-format-cexf/README.md index ce72767..59b6928 100644 --- a/exercises/common-exercise-format-cexf/README.md +++ b/exercises/common-exercise-format-cexf/README.md @@ -11,6 +11,14 @@ Common Exercise Format is a proposed format to describe an exercise including th - To trace the evolution of an exercise (via diff ang git); - To allow external contributions by using a common format; +# Details + +- Create a new training repository according to the repository template, naming convention and license + - "misp-training-xxx" + - license ABC + - Copy folder from "base", change name +- + ## Common Exercise format - Sample @@ -20,13 +28,18 @@ Common Exercise Format is a proposed format to describe an exercise including th "uuid": "75d7460-af9d-4098-8ad1-754457076b32", "name": "Phishing e-mail", "description": "Simple Spear Phishing e-mail example, mimicing a fraud case", - "tags": ["exercise:software-scope=\"\misp\"", "state:production"] + "tags": ["exercise:software-scope=\"\misp\"", "state:production"], + "version": "20210611", + "valid_until": "20310611", + "level": "beginner", + "namespace": "phishing" }, "inject_flow": [ { "inject_uuid": "19272db1-a7c4-4cb3-aa33-df775b8fec8c", "trigger": "startex", "requirements": [] + "reporting_callback": [] }, { "inject_uuid": "c104aa37-e394-43ce-b82b-a733d3745468", diff --git a/exercises/common-exercise-format-cexf/format-description.md b/exercises/common-exercise-format-cexf/format-description.md new file mode 100644 index 0000000..22b9c9f --- /dev/null +++ b/exercises/common-exercise-format-cexf/format-description.md @@ -0,0 +1,37 @@ +# Introduction + +Placeholder to describe the format for the common exercise format. + + +## Header information + +uuid: uuid Auto-generated +name: string descriptive name +description: string short description +expanded: string long description +tags: list +version: string unique version ID; prefer to have the current date in YYYYMMDD +valid_until: string describe the timestamp how long this training is valid; no value means undefinite +level: the level of maturity from the student; beginnner; intermediate or advanced +namespace: string container to collect related exercises + +``` +"exercise": { + "uuid": "75d7460-af9d-4098-8ad1-754457076b32", + "name": "Phishing e-mail", + "description": "Simple Spear Phishing e-mail example, mimicing a fraud case", + "expanded": "# Simple Spear Phishing e-mail example, mimicing a fraud case", + "tags": [ + "exercise:software-scope=\"misp\"", + "state:production" + ], + "version": "20210611", + "valid_until": "20310611", + "level": "beginner", + "namespace": "phishing" + }, + ``` + + ## Infrastructure + + tbd \ No newline at end of file