search

aau-network-security / haaukins

A Highly Accessible and Automated Virtualization Platform for Security Education
https://general.haaukins.com
Apache License 2.0
187 stars 39 forks source link

Missing documentaiton on how to create exercises #216

Closed kidmose closed 5 years ago

kidmose commented 5 years ago

I went looking for documentation on how to create exercises, without any luck. Can one of you, who are more up to date on things than me, point me to it if exists, or confirm if it is missing?

kidmose commented 5 years ago

As always, when you post and look a bit more, you find the answer, or at least parts of it: https://github.com/aau-network-security/haaukins/wiki/Configuring-the-daemon#exercisesyml

What are our experiences by people who contribute excercises, but are not developers of the platform? Is this adequate, or do you actually have to be a dev of the platform to create an excercise?

kdhageman commented 5 years ago

To answer your questions:

  1. We have no experience with people contributing exercises, but I have always said: Make sure that you have a bunch of docker containers and have it configurable via env variables. We will take care of the rest
  2. So yeah, right now, you do need access to the platform to create a new exercise. I'm not sure it's worth the time investment to implement something you can do remotely. Depends on the use case in which the platform will be used I suppose.
kidmose commented 5 years ago

Sorry for not responding @kdhageman . Seems like I configured something so I don't get notefications :-/

Awesome! I'm interested in getting the "rest" part of "We will take care of the rest" documented. (I'm completely in line with your view in 2.)

Is that "rest" part documented so Ahmet or perhaps even I could carry it out?

mrtrkmn commented 5 years ago

@kidmose for sure. I am just trying to draw some "proof of concept" diagram of haaukins' architecture, indeed further information (regarding to "rest" part ) can be added. Regarding to environment variables there is an example explanation which is modified from previous works. Example

kdhageman commented 5 years ago

@kidmose The "rest" part is not yet documented, which will be done as part of solving this issue I think.

mrtrkmn commented 5 years ago

Regarding to exercises, new repo or existing one for instance can be used to store all existing and next exercises files that we will have.

tpanum commented 5 years ago

I wrote some on the wiki, which can always be extended based on needs.