Refactor challenge.txt
continuous-integration/drone/push Build is passing Details

This commit is contained in:
nemunaire 2022-10-30 20:16:19 +01:00
parent 6bb8049b35
commit 2ef1dd0eb0
1 changed files with 94 additions and 10 deletions

View File

@ -4,40 +4,121 @@ title: challenge.txt
weight: 15
---
Le fichier `challenge.txt` définit les paramètres de votre étape (au format [toml](https://github.com/toml-lang/toml/blob/master/versions/en/toml-v0.4.0.md)) :
Le fichier `challenge.txt` définit les paramètres de votre étape (au format [toml](https://github.com/toml-lang/toml/blob/master/versions/en/toml-v0.4.0.md)).
On y retrouve notamment :
- [les gains](#les-gains) ;
- [les métadonnées](#les-métadonnées) ;
- [les dépendances](#les-dépendances) ;
- [les flags](#les-flags) ;
- [les dépendances entre les flags](#dépendances-entre-flags) ;
- [les débloquages de fichiers](#débloquage-de-fichier) ;
- [les indices](#les-indices) (fichier ou simple texte).
## Les gains
`gain = 42` : nombre de points que rapporte cette étape.
Généralement les gains se répartissent comment suit :
- étape 1 : 5 points ;
- étape 2 : 11 points ;
- étape 3 : 23 points ;
- étape 4 : 47 points ;
- étape 5 : 95 points.
Vous pouvez intervertir ou moduler en fonction de la difficulté réelle par rapport aux autres scénarios.
## Les métadonnées
### Les tags
`tags = ["Android", "RAT", "ROM"]` : mots-clefs de l'étape.
Les tags représentent les points d'intérêt de votre étape.
C'est utile aux participants pour essayer de filtrer les scénarios qu'ils souhaientent faire en fonction de leurs compétences.
## Les dépendances
Chaque étape, à l'exception de la première qui est ouverte à tous, doit déclarer une dépendance sur la résolution de l'étape précédente.
- `gain = 42` : nombre de points que rapporte cette étape ;
- `tags = ["Android", "RAT", "ROM"]` : mots-clefs de l'étape ;
- `[[depend]]` : dépendance à une autre étape :
* `id = CHID` : identifiant de l'étape dont on dépend ;
* `theme = "NomDuTheme"` : (facultatif) nom du scénario/thème dans lequel aller chercher l'identifiant (par défaut, on prend le scénario courant) ;
### Exemple
```
[[depend]]
id = 2
```
## Les flags
Retrouvez les différents flags supportés dans [la section dédiée de la documentation]({{< relref "/responses" >}}).
Voici un aperçu des propriétés disponibles :
- `[[flag]]` : chaîne de validation pour résoudre l'étape :
* `type = "key"` : (facultatif, par défaut "key") type de flag :
+ `key` : [drapeau classique]({{< relref "/responses/simple.md" >}}),
+ `number` : [drapeau numérique]({{< relref "/responses/number.md" >}}),
+ `vector` : [liste de drapeaux]({{< relref "/responses/vector.md" >}}),
+ `text` : [contenu sur plusieurs lignes]({{< relref "/responses/multiline.md" >}}),
+ `mcq` : [question à choix multiple]({{< relref "/responses/mcq.md" >}}) (cases à cocher) avec ou sans [justification]({{< relref "/responses/mcq_justified.md" >}}),
+ `ucq` : [liste de choix]({{< relref "/responses/ucq.md" >}}) ;
+ `ucq` : [liste de choix]({{< relref "/responses/ucq.md" >}}),
+ `label` : [texte informatif]({{< relref "/responses/label.md" >}}) qui ne donne pas lieu à validation ;
* `id = 42` : (facultatif) identifiant du flag au sein de l'étape, pour définir des dépendances ;
* `label = "Intitulé"` : (facultatif, par défaut : `Flag`) intitulé du drapeau ;
* `raw = 'MieH2athxuPhai6u'` ou `raw = ['part1', 'part2']` : drapeau(x) exact(s) à trouver ; sous forme de tableau, le participant n'aura pas connaissaance du nombre d'éléments (à moins de définir l'attribut `showlines`) ;
* `showlines = false` : (facultatif, par défaut : `false`) lorsque le drapeau est un tableau et que `showlines` est vrai, le nombre d'éléments du tableau sera donné au participant, sinon il devra déterminer lui-même le nombre d'éléments à trouver (pour l'instant cette option est limitée à un tableau de 9 éléments maximum, c'est normal si ça bug au delà, demandez-moi si vous avez besoin de plus) ;
* `bonus_gain = 33` : (facultatif) donne des points supplémentaire si complété ;
* `ordered = false` : (facultatif, par défaut : `false`) ignore l'ordre dans lequels les éléments du tableau sont passés ;
* `validator_regexp = "^(?:sudo +)?(.*)$"` : (facultatif) expression rationnelle dont les groupes capturés serviront comme chaîne à valider (notez que `?:` au début d'un groupe ne le capturera pas) ;
* `casesensitive = true` : (facultatif, par défaut : `false`) prend en compte la casse de ce drapeau ;
* `placeholder = "dd/mm/yyyy"` : (facultatif) chaîne de caractères initiale placée dans le champ du formulaire, idéale pour donner une indication de format ;
* `help = "Complément"` : (facultatif) petit paragraphe placé sous le champ du formulaire, idéal pour donner une indication complémentaire ;
* `unit = "°C"` : (facultatif) chaîne de caractères accolée à la fin du champ de texte, idéale pour préciser l'unité liée au contenu demandé ;
* `choices_cost = 42` : (facultatif) coût pour afficher les choix : avant l'affichage, se comporte comme un drapeau `key` classique (à 0, les choix sont affichés directement)
* `noshuffle = true` : (facultatif, par défaut `false`) conserve l'ordre des propositions, au lieu de les mélanger ;
* `[[flag.unlock_file]]` : bloque l'accès à un fichier tant que le flag n'est pas obtenu :
+ `filename = "toto.txt"` : nom du fichier tel qu'il apparaît dans le dossier `files` ;
* `[[flag.need_flag]]` : liste des flags devant être validés avant de débloquer celui-ci :
+ `id = 23` : identifiant du flag tel qu'il a été défini plus tôt dans le fichier ;
* `[[flag.choice]]` : représente un choix, répétez autant de fois qu'il y a de choix (pour les `mcq` et `ucq`) :
+ `label = "Intitulé de la réponse"` (facultatif, par défaut `raw`),
+ `value = true` (facultatif, par défaut `false`, sauf si `raw` est précisé) : valeur attendue pour ce choix,
+ `raw = "Justification"` (nécessaire pour un [QCM justifié]({{< relref "/responses/mcq_justified.md" >}})) : utilisez une chaîne de caractères (notez qu'il n'est pas possible de combiner des réponses vraies justifiées et non justifiées),
+ `help = "Flag correspondant"` : (facultatif) indication affichée dans le champ de texte des QCM justifiés,
+ ... toutes les autres propriétés applicables à un flag simple peuvent être utilisées : `ordered`, `validator_regexp`, `casesensitive`, ... ;
## Dépendances entre flags
Un flag peut avoir une dépendance sur l'état de validation d'un ou plusieurs autres flags.
Il convient de déclarer la dépendance au sein du `[[flag]]` qui porte la dépendance.
- `[[flag]]`
* `[[flag.need_flag]]` : liste des flags devant être validés avant de débloquer celui-ci :
+ `id = 23` : identifiant du flag tel qu'il a été défini plus tôt dans le fichier ;
## Débloquage de fichier
Un fichier peut n'être dévoilé qu'après qu'un flag ait été validé.
Il convient de déclarer le débloquage au sein du `[[flag]]` qui, une fois validé, débloquera le-dit fichier.
- `[[flag]]`
* `[[flag.unlock_file]]` : bloque l'accès à un fichier tant que le flag n'est pas obtenu :
+ `filename = "toto.txt"` : nom du fichier tel qu'il apparaît dans le dossier `files` ;
## Les indices
Les étapes peuvent avoir des indices, sous forme de fichier à télécharger (avec un attribut `filename`) ou sous forme de texte (attribut `content`) :
- `[[hint]]` : paramètres pour un indice :
* `filename = "toto.txt"` : (mutuellement exclusif avec `content`) nom du fichier tel qu'il apparaît dans le dossier `hints` ;
* `content = "Contenu de l'indice"` : (mutuellement exclusif avec `filename`) contenu de l'indice affiché, en markdown ;
@ -46,9 +127,8 @@ Le fichier `challenge.txt` définit les paramètres de votre étape (au format [
* `[[hint.need_flag]]` : liste des flags devant être validés pour débloquer cet indice :
+ `id = 23` : identifiant du flag ;
Voir aussi [la section sur les flags]({{< relref "/responses" >}}).
## Exemple
## Exemple d'un `challenge.txt` complet
```toml
gain = 42
@ -66,6 +146,7 @@ label = "IPv6 d'exfiltration"
raw = 'fe80::319c:1002:7c60:68fa'
[[flag]]
id = 2
type = "mcq"
label = "Conditions générales de validation de challenge"
raw = 'conscent'
@ -95,6 +176,9 @@ choices_cost = 21
label = "Crème"
value = 'Blanc'
[[flag.need_flag]]
id = 2
[[flag]]
type = "mcq"
label = "Quels sont les films réalisés par C. Nolan ?"