Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jnovikov committed Nov 11, 2023
1 parent 06fd56a commit e42044c
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 14 deletions.
44 changes: 30 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,34 @@
# ad-boilerplate

[![check-services](https://github.com/C4T-BuT-S4D/ad-boilerplate/actions/workflows/check-services.yml/badge.svg?branch=master&event=push)](https://github.com/C4T-BuT-S4D/ad-boilerplate/actions/workflows/check-services.yml)

Development workflow:
# BRICS+ CTF 2023 | Finals

The contest was held on November 11, 2023.

Repository contains source code of services, checkers and exploits.

## Results

![Top](scoreboard/top.png)

[Full scoreboard](scoreboard/full.png)

## Services

| Service | Language | Checker | Sploits | Authors |
|------------------------------------|---------------|-------------------------------|------------------------------|-------------------------------------------------------------------------------------|
| **[notify](services/notify/)** | Rust | [Checker](checkers/notify/) | [Sploits](sploits/notify/) | [@renbou](https://github.com/renbou) |
| **[restmenu](services/restmenu/)** | Kotlin & Java | [Checker](checkers/restmenu/) | [Sploits](sploits/restmenu/) | [@jnovikov](https://github.com/jnovikov) |
| **[leakless](services/leakless/)** | Go | [Checker](checkers/leakless/) | [Sploits](sploits/leakless/) | [@falamous](https://github.com/falamous) |
| **[notes](services/notes/)** | Python & C | [Checker](checkers/notes/) | [Sploits](sploits/notes/) | [@user39043346](https://github.com/user39043346) |

## Infrastructure

- DevOps: [@pomo_mondreganto](https://github.com/pomo-mondreganto)
- Checksystem: [ForcAD](https://github.com/pomo-mondreganto/ForcAD)

1) Create branch named `$SERVICE`.
2) Write your code in `services/$SERVICE`, `checkers/$SERVICE`, `sploits/$SERVICE` and `internal/$SERVICE` (if needed).
3) Validate your service with `SERVICE=$SERVICE ./check.py validate`.
4) Up your service with `SERVICE=$SERVICE ./check.py up`.
5) Check your service with `SERVICE=$SERVICE RUNS=200 ./check.py check`.
6) Down your service with `SERVICE=$SERVICE ./check.py down`.
7) Push your code and create pull request to master branch.
## Writeups

Don't forget to:
1) Add your checker requirements to `checkers/requirements.txt`.
2) Use `dedcleaner` container to delete old files if needed. Example can be found in `services/example/docker-compose.yml`.
3) Add info about your checker to `Checker` class. Example can be found in `checkers/example/checker.py`, line 11.
- [notify](/sploits/notify/)
- [restmenu](/sploits/restmenu/)
- [leakless](/sploits/leakless/)
- [notes](/sploits/notes/)
Binary file added scoreboard/full.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added scoreboard/top.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e42044c

Please sign in to comment.