trapdef.json
trapdef.json
to plik zawierający wszystkie metadane pułapki. Musi on się znajdować w paczce pułapki
pod dokładnie taką nazwą, aby została ona poprawnie odczytania przez TrapInit.
Jest to plik json
, zawierający określone pola. Minimalny przykładowy trapdef.json
jaki jest potrzebny do działania
pułapki został przedstawiony poniżej:
{
"$schema": "https://raw.githubusercontent.com/TrapTech/trapdef-schema/main/TrapDef.schema.json",
"def": "1.0",
"private": true,
"name": "<trap name here>",
"identifier": "<trap identifier here>",
"authors": ["<you>"],
"version": "0.0.1",
"supportedRunners": ["Docker"],
"dockerRunnerDefinition": {
"dockerComposePath": "./docker-compose.yml",
"imagesPath": "./images.tar"
}
}
Możliwe wartości
Poniżej znajduje się lista wszystkich wartości możliwych do ustawianie w pliku trapdef.json
wraz z ich opisem.
Te informacje dostępne są jako JSON Schema pod adresem
https://raw.githubusercontent.com/TrapTech/trapdef-schema/main/TrapDef.schema.json
.
Dzięki temu, można łatwo uzyskać podpowiedzi w obsługiwanych edytorach ustawiając pole $schema
:
{
"$schema": "https://raw.githubusercontent.com/TrapTech/trapdef-schema/main/TrapDef.schema.json"
}