Skip to content

Commit

Permalink
Update documentation: secrets
Browse files Browse the repository at this point in the history
  • Loading branch information
theodorsm committed Jul 27, 2023
1 parent 23bee9e commit 6392e85
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,14 @@ Each UE will only send one `LocationUpdate` message, containing one flag. To mak

### Secrets

The service uses symmetric encryption (AES), thus each team playing this service need a unique key. The checker also needs to have the key for each team. The secrets are set in the `.env` file in the same folder as the docker-compose file for both the service and checker. The secrets are:

- `PHREAKING_GRPC_PASS`
- Password for the gRPC server
- `PHREAKING_SIM_KEY`
- Key used for AES, must be of length 32.
The service uses symmetric encryption (AES), thus each team playing this service need a unique key. The checker also needs to have the key for each team. The secrets are set in the `.env` file in the same folder as the docker-compose file for both the service and checker.

- Service secrets:
- `PHREAKING_GRPC_PASS`: Password for the gRPC server
- `PHREAKING_SIM_KEY`: Key used for AES, must be of length 32.
- Checker secrets:
- `PHREAKING_<N>_GRPC_PASS`: Password for the gRPC server. N is team number
- `PHREAKING_<N>_SIM_KEY`: Key used for AES, must be of length 32. N is team number
- `REDIS_PASS`: Password for checker db.

Script for generating secrets for each team can be found in this [PR](https://github.com/enowars/bambictf/pull/55/files).
1 change: 1 addition & 0 deletions checker/.env
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
COMPOSE_PROJECT_NAME=phreaking_checker
REDIS_PASS=ifyoucanreadthisyouhaveaccess
PHREAKING_0_GRPC_PASS=ultrasecretpasswordthatwillneverbebroken
PHREAKING_0_SIM_KEY=passphrasewhichneedstobe32bytes!
PHREAKING_1_GRPC_PASS=ultrasecretpasswordthatwillneverbebroken
Expand Down

0 comments on commit 6392e85

Please sign in to comment.