track team for instance

.gitignore

@@ -0,0 +1 @@
+out

README.md

@@ -0,0 +1,11 @@
+# ubcctf/instanced
+
+Manages challenge instances on-demand.
+
+`instanced` runs in the cluster and exposes an HTTP API which is used to request instances.
+
+- GET `/instances` - get list of active instances
+- POST `/instances?chal=$CHALLNAME&team=$ID` - provision an instance for specific challenge and team
+- DELETE `/instances?id=$ID` - delete challenge with id
+
+Authenticate with `Bearer token`

db.go

@@ -8,10 +8,12 @@ import (
 	_ "modernc.org/sqlite"
 )
 
+// InstanceRecord is a record used to keep track of an active instance
 type InstanceRecord struct {
 	Id        int64     `json:"id"`
 	Expiry    time.Time `json:"expiry"`
 	Challenge string    `json:"challenge"`
+	TeamID    string    `json:"team"`
 }
 
 func (in *Instancer) InitDB(file string) error {
@@ -20,7 +22,7 @@ func (in *Instancer) InitDB(file string) error {
 		return err
 	}
 	in.db = db
-	_, err = db.Exec("CREATE TABLE IF NOT EXISTS instances(id INTEGER PRIMARY KEY, challenge TEXT, expiry INTEGER);")
+	_, err = db.Exec("CREATE TABLE IF NOT EXISTS instances(id INTEGER PRIMARY KEY, challenge TEXT, team TEXT, expiry INTEGER);")
 	if err != nil {
 		return err
 	}
@@ -37,19 +39,19 @@ func (in *Instancer) InitDB(file string) error {
 	return nil
 }
 
-func (in *Instancer) InsertInstanceRecord(ttl time.Duration, challenge string) (InstanceRecord, error) {
+func (in *Instancer) InsertInstanceRecord(ttl time.Duration, team string, challenge string) (InstanceRecord, error) {
 	if in.db == nil {
 		return InstanceRecord{}, errors.New("db not initialized")
 	}
 	expiry := time.Now().Add(ttl)
 
-	stmt, err := in.db.Prepare("INSERT INTO instances(challenge, expiry) values(?, ?)")
+	stmt, err := in.db.Prepare("INSERT INTO instances(challenge, team, expiry) values(?, ?, ?)")
 	if err != nil {
 		return InstanceRecord{}, err
 	}
 	defer stmt.Close()
 
-	res, err := stmt.Exec(challenge, expiry.Unix())
+	res, err := stmt.Exec(challenge, team, expiry.Unix())
 	if err != nil {
 		return InstanceRecord{}, err
 	}
@@ -88,7 +90,7 @@ func (in *Instancer) ReadInstanceRecords() ([]InstanceRecord, error) {
 	if in.db == nil {
 		return nil, errors.New("db not initialized")
 	}
-	rows, err := in.db.Query("SELECT id, challenge, expiry FROM instances")
+	rows, err := in.db.Query("SELECT id, challenge, team, expiry FROM instances")
 	if err != nil {
 		return nil, err
 	}
@@ -97,7 +99,7 @@ func (in *Instancer) ReadInstanceRecords() ([]InstanceRecord, error) {
 	for rows.Next() {
 		record := InstanceRecord{}
 		var t int64
-		err = rows.Scan(&record.Id, &record.Challenge, &t)
+		err = rows.Scan(&record.Id, &record.Challenge, &record.TeamID, &t)
 		if err != nil {
 			return records, err
 		}

instancer.go

@@ -125,7 +125,7 @@ func (in *Instancer) DestroyInstance(rec InstanceRecord) error {
 	return nil
 }
 
-func (in *Instancer) CreateInstance(challenge string) (InstanceRecord, error) {
+func (in *Instancer) CreateInstance(challenge, team string) (InstanceRecord, error) {
 	log := in.log.With().Str("component", "instanced").Logger()
 
 	chal, ok := in.challengeObjs[challenge]
@@ -141,7 +141,7 @@ func (in *Instancer) CreateInstance(challenge string) (InstanceRecord, error) {
 		ttl = 10 * time.Minute
 	}
 
-	rec, err := in.InsertInstanceRecord(ttl, challenge)
+	rec, err := in.InsertInstanceRecord(ttl, team, challenge)
 	if err != nil {
 		log.Error().Err(err).Msg("could not create instance record")
 	} else {

main_test.go

@@ -142,7 +142,7 @@ spec:
 func ExampleInsertInstanceRecord() {
 	in := Instancer{}
 	in.InitDB("./tmp/test.db")
-	in.InsertInstanceRecord(time.Hour, "test_challenge")
+	in.InsertInstanceRecord(time.Hour, "1", "test_challenge")
 	recs, err := in.ReadInstanceRecords()
 	if err != nil {
 		log.Fatal(err)

webserver.go

@@ -23,6 +23,7 @@ type InstancesResponse struct {
 	Action    string `json:"action"`
 	Challenge string `json:"challenge"`
 	ID        int64  `json:"id"`
+	URL       string `json:"url"`
 }
 
 func (in *Instancer) handleLivenessCheck(c echo.Context) error {
@@ -31,14 +32,9 @@ func (in *Instancer) handleLivenessCheck(c echo.Context) error {
 
 func (in *Instancer) handleInstanceCreate(c echo.Context) error {
 	chalName := c.QueryParam("chal")
-	token := c.QueryParam("token")
+	teamID := c.QueryParam("team")
 
-	// todo: check an auth token or something
-	if token == "" {
-		c.Logger().Info("request rejected with no token")
-		return c.JSON(http.StatusForbidden, "team token not provided")
-	}
-	rec, err := in.CreateInstance(chalName)
+	rec, err := in.CreateInstance(chalName, teamID)
 	if _, ok := err.(*ChallengeNotFoundError); ok {
 		return c.JSON(http.StatusNotFound, "challenge not supported")
 	}
@@ -49,25 +45,18 @@ func (in *Instancer) handleInstanceCreate(c echo.Context) error {
 		return c.JSON(http.StatusInternalServerError, "challenge deploy failed: contact admin")
 	}
 	c.Logger().Info("processed request to provision new instance")
-	return c.JSON(http.StatusAccepted, InstancesResponse{"created", chalName, rec.Id})
+	return c.JSON(http.StatusAccepted, InstancesResponse{"created", chalName, rec.Id, "TODO"})
 }
 
 func (in *Instancer) handleInstanceDelete(c echo.Context) error {
 	chalName := c.QueryParam("chal")
-	token := c.QueryParam("token")
 	instanceID, err := strconv.ParseInt(c.QueryParam("id"), 10, 64)
 
 	if err != nil {
 		return c.JSON(http.StatusBadRequest, "invalid id")
 	}
 
-	// todo: check an auth token or something
-	if token == "" {
-		c.Logger().Info("request rejected with no token")
-		return c.JSON(http.StatusForbidden, "team token not provided")
-	}
-
-	err = in.DestroyInstance(InstanceRecord{instanceID, time.Now(), chalName})
+	err = in.DestroyInstance(InstanceRecord{instanceID, time.Now(), chalName, ""})
 
 	if _, ok := err.(*ChallengeNotFoundError); ok {
 		return c.JSON(http.StatusNotFound, "challenge not supported")
@@ -80,7 +69,7 @@ func (in *Instancer) handleInstanceDelete(c echo.Context) error {
 	}
 	c.Logger().Info("processed request to destroy an instance")
 
-	return c.JSON(http.StatusAccepted, InstancesResponse{"destroyed", chalName, instanceID})
+	return c.JSON(http.StatusAccepted, InstancesResponse{"destroyed", chalName, instanceID, "TODO"})
 }
 
 func (in *Instancer) handleInstanceList(c echo.Context) error {