libfic/flag: add validatorRegexp field

This commit is contained in:
nemunaire 2018-11-16 20:46:19 +01:00 committed by Pierre-Olivier Mercier
commit ff56ec9fe3
8 changed files with 111 additions and 35 deletions

View file

@ -162,6 +162,7 @@ CREATE TABLE IF NOT EXISTS exercice_flags(
type VARCHAR(255) NOT NULL,
help VARCHAR(255) NOT NULL,
ignorecase BOOLEAN NOT NULL DEFAULT 0,
validator_regexp VARCHAR(255) NULL,
cksum BINARY(64) NOT NULL,
FOREIGN KEY(id_exercice) REFERENCES exercices(id_exercice)
) DEFAULT CHARACTER SET = utf8mb4 COLLATE = utf8mb4_unicode_ci;

View file

@ -296,7 +296,7 @@ func (e Exercice) CheckResponse(respflags map[string]string, respmcq map[int64]b
for _, flag := range flags {
if res, ok := respflags[flag.Label]; !ok {
valid = false
} else if !flag.Check(res) {
} else if !flag.Check([]byte(res)) {
if !PartialValidation || t.HasPartiallySolved(flag) == nil {
valid = false
}

View file

@ -290,7 +290,7 @@ func (f EFile) GetDepends() ([]Flag, error) {
if err := rows.Scan(&d); err != nil {
return nil, err
}
deps = append(deps, Flag{d, f.IdExercice, "", "", false, []byte{}})
deps = append(deps, Flag{d, f.IdExercice, "", "", false, nil, []byte{}})
}
if err := rows.Err(); err != nil {
return nil, err

View file

@ -1,30 +1,34 @@
package fic
import (
"bytes"
"errors"
"regexp"
"time"
"golang.org/x/crypto/blake2b"
)
// Flag represents a flag's challenge, stored as hash.
type Flag struct {
Id int64 `json:"id"`
Id int64 `json:"id"`
// IdExercice is the identifier of the underlying challenge
IdExercice int64 `json:"idExercice"`
IdExercice int64 `json:"idExercice"`
// Label is the title of the flag as displayed to players
Label string `json:"label"`
Label string `json:"label"`
// Help is a small piece of text that aims to add useful information like flag format, ...
Help string `json:"help"`
Help string `json:"help"`
// IgnoreCase indicates if the case is sensitive to case or not
IgnoreCase bool `json:"ignorecase"`
IgnoreCase bool `json:"ignorecase"`
// ValidatorRegexp extracts a subset of the player's answer, that will be checked.
ValidatorRegexp *string `json:"validator_regexp"`
// Checksum is the expected hashed flag
Checksum []byte `json:"value"`
Checksum []byte `json:"value"`
}
// GetFlags returns a list of flags comming with the challenge.
func (e Exercice) GetFlags() ([]Flag, error) {
if rows, err := DBQuery("SELECT id_flag, id_exercice, type, help, ignorecase, cksum FROM exercice_flags WHERE id_exercice = ?", e.Id); err != nil {
if rows, err := DBQuery("SELECT id_flag, id_exercice, type, help, ignorecase, validator_regexp, cksum FROM exercice_flags WHERE id_exercice = ?", e.Id); err != nil {
return nil, err
} else {
defer rows.Close()
@ -34,9 +38,10 @@ func (e Exercice) GetFlags() ([]Flag, error) {
var k Flag
k.IdExercice = e.Id
if err := rows.Scan(&k.Id, &k.IdExercice, &k.Label, &k.Help, &k.IgnoreCase, &k.Checksum); err != nil {
if err := rows.Scan(&k.Id, &k.IdExercice, &k.Label, &k.Help, &k.IgnoreCase, &k.ValidatorRegexp, &k.Checksum); err != nil {
return nil, err
}
flags = append(flags, k)
}
if err := rows.Err(); err != nil {
@ -48,31 +53,59 @@ func (e Exercice) GetFlags() ([]Flag, error) {
}
// getHashedFlag calculates the expected checksum for the given raw_value.
func getHashedFlag(raw_value string) [blake2b.Size]byte {
hash := blake2b.Sum512([]byte(raw_value))
func getHashedFlag(raw_value []byte) [blake2b.Size]byte {
hash := blake2b.Sum512(raw_value)
return hash
}
// AddRawFlag creates and fills a new struct Flag, from a non-hashed flag, and registers it into the database.
func (e Exercice) AddRawFlag(name string, help string, ignorecase bool, raw_value string) (Flag, error) {
func (e Exercice) AddRawFlag(name string, help string, ignorecase bool, validator_regexp *string, raw_value []byte) (Flag, error) {
if ignorecase {
raw_value = bytes.ToLower(raw_value)
}
// Check that raw value passes through the regexp
if validator_regexp != nil {
if re, err := regexp.Compile(*validator_regexp); err != nil {
return Flag{}, err
} else if res := re.FindSubmatch(raw_value); res == nil {
return Flag{}, errors.New("Expected flag doesn't pass through the validator_regexp")
} else {
raw_value = bytes.Join(res[1:], []byte("+"))
}
}
hash := getHashedFlag(raw_value)
return e.AddFlag(name, help, ignorecase, hash[:])
return e.AddFlag(name, help, ignorecase, validator_regexp, hash[:])
}
// AddFlag creates and fills a new struct Flag, from a hashed flag, and registers it into the database.
func (e Exercice) AddFlag(name string, help string, ignorecase bool, checksum []byte) (Flag, error) {
if res, err := DBExec("INSERT INTO exercice_flags (id_exercice, type, help, ignorecase, cksum) VALUES (?, ?, ?, ?, ?)", e.Id, name, help, ignorecase, checksum); err != nil {
func (e Exercice) AddFlag(name string, help string, ignorecase bool, validator_regexp *string, checksum []byte) (Flag, error) {
// Check the regexp compile
if validator_regexp != nil {
if _, err := regexp.Compile(*validator_regexp); err != nil {
return Flag{}, err
}
}
if res, err := DBExec("INSERT INTO exercice_flags (id_exercice, type, help, ignorecase, validator_regexp, cksum) VALUES (?, ?, ?, ?, ?, ?)", e.Id, name, help, ignorecase, validator_regexp, checksum); err != nil {
return Flag{}, err
} else if kid, err := res.LastInsertId(); err != nil {
return Flag{}, err
} else {
return Flag{kid, e.Id, name, help, ignorecase, checksum}, nil
return Flag{kid, e.Id, name, help, ignorecase, validator_regexp, checksum}, nil
}
}
// Update applies modifications back to the database.
func (k Flag) Update() (int64, error) {
if res, err := DBExec("UPDATE exercice_flags SET id_exercice = ?, type = ?, help = ?, ignorecase = ?, cksum = ? WHERE id_flag = ?", k.IdExercice, k.Label, k.Help, k.IgnoreCase, k.Checksum, k.Id); err != nil {
if k.ValidatorRegexp != nil {
if _, err := regexp.Compile(*k.ValidatorRegexp); err != nil {
return 0, err
}
}
if res, err := DBExec("UPDATE exercice_flags SET id_exercice = ?, type = ?, help = ?, ignorecase = ?, validator_regexp = ?, cksum = ? WHERE id_flag = ?", k.IdExercice, k.Label, k.Help, k.IgnoreCase, k.ValidatorRegexp, k.Checksum, k.Id); err != nil {
return 0, err
} else if nb, err := res.RowsAffected(); err != nil {
return 0, err
@ -108,7 +141,24 @@ func (e Exercice) WipeFlags() (int64, error) {
}
// Check if the given val is the expected one for this flag.
func (k Flag) Check(val string) bool {
func (k Flag) Check(val []byte) bool {
if k.IgnoreCase {
val = bytes.ToLower(val)
}
// Check that raw value passes through the regexp
if k.ValidatorRegexp != nil {
re := regexp.MustCompile(*k.ValidatorRegexp)
if res := re.FindSubmatch(val); res != nil {
val = bytes.Join(res[1:], []byte("+"))
}
}
// Check that the value is not empty
if len(val) == 0 {
return false
}
hash := getHashedFlag(val)
if len(k.Checksum) != len(hash) {
return false