Skip to content

Commit

Permalink
chore: public beta
Browse files Browse the repository at this point in the history
  • Loading branch information
NicoFgrx committed Dec 29, 2024
1 parent b69d988 commit 1bf579b
Show file tree
Hide file tree
Showing 7 changed files with 63 additions and 18 deletions.
5 changes: 1 addition & 4 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,9 @@ jobs:

services:
chall-manager:
image: ctferio/chall-manager:v0.1.0-rc3@sha256:bc7b15549ec3606fe20ea68f50bc51e2d53178b1201c443be6b87fec24f9b762
image: ctferio/chall-manager:v0.1.1@sha256:196f0e1ebf5c0c900b8be04560824538a30cb851baced98fa7276fce727aba95
ports:
- 8080:8080
credentials:
username: ${{ secrets.docker_username }}
password: ${{ secrets.docker_password }}

ctfd:
image: ctfd/ctfd:3.7.5@sha256:7f456b23727286c9df2b58e0b7398cc0196e2b74e4c1c5b3cda7a5b71034637d
Expand Down
5 changes: 1 addition & 4 deletions .github/workflows/e2e.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,9 @@ jobs:

services:
chall-manager:
image: ctferio/chall-manager:v0.1.0-rc3@sha256:bc7b15549ec3606fe20ea68f50bc51e2d53178b1201c443be6b87fec24f9b762
image: ctferio/chall-manager:v0.1.1@sha256:196f0e1ebf5c0c900b8be04560824538a30cb851baced98fa7276fce727aba95
ports:
- 8080:8080
credentials:
username: ${{ secrets.docker_username }}
password: ${{ secrets.docker_password }}

redis-svc:
image: redis:7.0.10@sha256:92b8b307ee28ed74da17578064c73307ad41e43f422f0b7e4e91498b406c59e3
Expand Down
5 changes: 1 addition & 4 deletions .github/workflows/redis.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,9 @@ jobs:

services:
chall-manager:
image: ctferio/chall-manager:v0.1.0-rc3@sha256:bc7b15549ec3606fe20ea68f50bc51e2d53178b1201c443be6b87fec24f9b762
image: ctferio/chall-manager:v0.1.1@sha256:196f0e1ebf5c0c900b8be04560824538a30cb851baced98fa7276fce727aba95
ports:
- 8080:8080
credentials:
username: ${{ secrets.docker_username }}
password: ${{ secrets.docker_password }}

redis-svc:
image: redis:7.0.10@sha256:92b8b307ee28ed74da17578064c73307ad41e43f422f0b7e4e91498b406c59e3
Expand Down
35 changes: 35 additions & 0 deletions .github/workflows/scoreboard.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Scorecard supply-chain security
on:
branch_protection_rule:
schedule:
- cron: '30 6 * * 6'
push:
branches: [ "main" ]

permissions: read-all

jobs:
analysis:
name: Scorecard analysis
runs-on: ubuntu-latest
permissions:
security-events: write
id-token: write

steps:
- name: Checkout repository
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
persist-credentials: false

- name: Run analysis
uses: ossf/scorecard-action@62b2cac7ed8198b15735ed49ab1e5cf35480ba46 # v2.4.0
with:
results_file: results.sarif
results_format: sarif
publish_results: true

- name: Upload to code-scanning
uses: github/codeql-action/upload-sarif@48ab28a6f5dbc2a99bf1e0131198dd8f1df78169 # v3.28.0
with:
sarif_file: results.sarif
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,16 @@
<p><b>Level Up CTFd with Infra-as-Code Challenges!</b><p>
<a href=""><img src="https://img.shields.io/github/license/ctfer-io/ctfd-chall-manager?style=for-the-badge" alt="License"></a>
<a href="https://github.com/ctfer-io/ctfd-chall-manager/actions?query=workflow%3Aci+"><img src="https://img.shields.io/github/actions/workflow/status/ctfer-io/ctfd-chall-manager/ci.yaml?style=for-the-badge&label=CI" alt="CI"></a>
<a href="https://github.com/ctfer-io/ctfd-chall-manager/actions/workflows/codeql-analysis.yaml"><img src="https://img.shields.io/github/actions/workflow/status/ctfer-io/ctfd-chall-manager/codeql-analysis.yaml?style=for-the-badge&label=CodeQL" alt="CodeQL"></a>
<a href="https://github.com/ctfer-io/ctfd-chall-manager/actions/workflows/codeql-analysis.yaml"><img src="https://img.shields.io/github/actions/workflow/status/ctfer-io/ctfd-chall-manager/codeql-analysis.yaml?style=for-the-badge&label=CodeQL" alt="CodeQL"></a>
<a href="https://securityscorecards.dev/viewer/?uri=github.com/ctfer-io/ctfd-chall-manager"><img src="https://img.shields.io/ossf-scorecard/github.com/ctfer-io/ctfd-chall-manager?label=openssf%20scorecard&style=for-the-badge" alt="OpenSSF Scoreboard"></a>
</div>

> [!CAUTION]
> CTFd-chall-Manager is currently in public beta phase.
> It could be run in production, but breaking changes are subject to happen in the upcoming months until General Availability.
>
> It has been tested under production workload during the NoBrackets 2024.
This plugin allow you to use the [chall-manager](https://github.com/ctfer-io/chall-manager), to manage scenario and permit Player's to deploy their instances.

Last version tested on: [3.7.5](https://github.com/CTFd/CTFd/releases/tag/3.7.5).
Expand All @@ -27,7 +34,7 @@ Last version tested on: [3.7.5](https://github.com/CTFd/CTFd/releases/tag/3.7.5)
<img style="width: 90%; display: block; margin: auto; box-sizing: border-box;" src="res/flags.png"/>

# How install and use
To install and use the plugin, refer to the documentation at https://alpha.ctfer.io/docs/ctfd-chall-manager.
To install and use the plugin, refer to the documentation at https://ctfer.io/docs/ctfd-chall-manager.

# Limitations
- Need to use the `core-beta` theme (cf https://github.com/CTFd/CTFd/pull/2630)
Expand Down
18 changes: 15 additions & 3 deletions hack/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,21 @@ services:
environment:
LOG_LEVEL: DEBUG
PLUGIN_SETTINGS_CM_API_URL: http://chall-manager:8080/api/v1
PLUGIN_SETTINGS_CM_MANA_TOTAL: 15
# REDIS_URL: redis://redis-svc:6379
PLUGIN_SETTINGS_CM_MANA_TOTAL: 10
REDIS_URL: redis://redis-svc:6379
DATABASE_URL : mysql+pymysql://root:password@mariadb-svc:3306/ctfd
depends_on:
- chall-manager
# - redis-svc
# - mariadb-svc
healthcheck:
test: python3 -c 'import requests; requests.get("http://localhost:8000")'
interval: 10s
retries: 3
timeout: 10s

chall-manager:
image: ctferio/chall-manager:v0.1.0-rc3@sha256:bc7b15549ec3606fe20ea68f50bc51e2d53178b1201c443be6b87fec24f9b762
image: ctferio/chall-manager:v0.1.1@sha256:196f0e1ebf5c0c900b8be04560824538a30cb851baced98fa7276fce727aba95
ports:
- 8080:8080
environment:
Expand All @@ -37,6 +39,16 @@ services:
# networks:
# - testing

# mariadb-svc:
# image: mariadb:10.11
# environment:
# MYSQL_ROOT_PASSWORD: password
# MYSQL_DATABASE: ctfd
# ports:
# - 3306:3306
# networks:
# - testing

ctfd-setup:
image: ctferio/ctfd-setup:v1.5.2@sha256:4308e91578532869eee94d68488ea51f222ca5e5944d05529eb59c2f2cc3404a
environment:
Expand Down
2 changes: 1 addition & 1 deletion webdocs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ description: >
---

{{% alert title="Warning" color="warning" %}}
Currently entering private alpha phase, for any issue: [email protected]
Currently entering public beta phase, for any issue: [email protected]
{{% /alert %}}

0 comments on commit 1bf579b

Please sign in to comment.