CLI specification

Syntax

• Square brackets [] are required arguments
• Round brackets () are optional arguments

Required commands

For cli version 1.0 we consider the same functionality that go-ntp also provided beforehand. The commands to implement are as follows:

• ntp user invite
• ntp user signup - prompt for signup key, username and password
• ntp user login - prompt for username and password
• ntp event create [tag] [-n name] (-b buffer) (-c capacity) (-f frontends) (-ex exercises)
• ntp event stop [tag]
• ntp event list - list all currently running events. Example output:

EVENT TAG   NAME            # GROUPS    # EXERCISES     CAPACITY
test        Test event      13          4               20
exam        Important exam  25          2               25
htx         HTX event       56          8               60

• ntp exercise reset [tag] [-ev event_id] (-g group_ids) - reset a certain exercise for an event for a set of groups (used to fix exercises that have been broken by the groups themselves).

Upcoming commands

And a non-exhaustive list of future additions:

• ntp exercise update [id] (-ev event_id) - update a certain exercise to its newest version (from the docker registry) and update running instances with the updated version (used for fixing broken exercises on the fly).
• ntp event list [tag] groups - list the groups that participate in the event. Example output:

GROUP ID         NAME              EMAIL
f58a13m          BestTeam          [email protected]
jg018do          WorstTeam         [email protected]

• ntp event list [tag] exercises - list the exercises used in the event. Example output:

EXERCISE ID
sql
xss
phishing

• ntp event list [id] instances (-g group_ids) (-i image_ids) - list the images for a certain event, with the option to filter on group- and image identifiers. Will be used to get an overview of what versions of images certain groups are running and to identify outliers. Example output (note that the N denotes the newest version of the image):

IMAGE ID                   TYPE      DIGEST         GROUP ID
aau/sqlinjection-client    docker    N jb8mn21      f58a13m, jg018do
aau/sqlinjection-server    docker    N f81jbz9      f58a13m, jg018do
tpanum/unbound             docker    N 4efh9a       f58a13m
                                       8al134a      jg018do
windows                    vm        N 74ab21a      f58a13m, jg018do

• ntp group reset [group id] lab - Reset the lab of a group. In case of complete failure (for instance breaking their kali VM).