@b01lers/ctfd-api 1.2.0 → 1.2.2

package/README.md

@@ -48,10 +48,10 @@ const challs = await client.getChallenges();
 const scoreboard = await client.getScoreboard();
 console.log(scoreboard.slice(0, 5));
 
-// Get details about a challenge, and submits a flag
+// Get details about a challenge, and submit a flag
 const chall = challs.find((c) => c.name === 'The Lost Park')!;
 const details = await client.getChallengeDetails(chall.id);
 console.log(details.description);
 
-await client.submitFlag(chall.id, 'cftd{test_flag}');
+await client.submitFlag(chall.id, 'ctfd{test_flag}');
 ```

package/dist/index.js

@@ -39,6 +39,13 @@ class CTFdClient {
     })).json();
     return res.data;
   }
+  async getChallengeDetails(id) {
+    const { session } = await this.getAuthedSessionNonce();
+    const res = await (await fetch(`${this.url}/api/v1/challenges/${id}`, {
+      headers: { cookie: session }
+    })).json();
+    return res.data;
+  }
   async getScoreboard() {
     const { session, nonce } = await this.getAuthedSessionNonce();
     const res = await (await fetch(`${this.url}/api/v1/scoreboard`, {
@@ -55,7 +62,7 @@ class CTFdClient {
     const res = await fetch(`${this.url}/login`);
     const [session] = res.headers.getSetCookie()[0].split("; ");
     const nonce = extractNonce(await res.text());
-    const formData = new FormData();
+    const formData = new URLSearchParams();
     formData.append("name", this.username);
     formData.append("password", this.password);
     formData.append("_submit", "Submit");

package/dist/types.d.ts

@@ -5,8 +5,8 @@ type BaseScoreboardEntry = {
     oauth_id: null;
     name: string;
     score: number;
-    bracket_id: null;
-    bracket_name: null;
+    bracket_id: number | null;
+    bracket_name: string | null;
 };
 type ScoreboardUserEntry = BaseScoreboardEntry & {
     account_type: "user";
@@ -23,9 +23,10 @@ type ScoreboardTeamEntry = BaseScoreboardEntry & {
     }[];
 };
 type ScoreboardEntry = ScoreboardUserEntry | ScoreboardTeamEntry;
+type ChallengeType = 'standard' | 'multiple_choice' | 'code';
 type ChallengeData = {
     id: number;
-    type: 'standard' | 'multiple_choice' | 'code';
+    type: ChallengeType;
     name: string;
     category: string;
     script: string;
@@ -35,6 +36,49 @@ type ChallengeData = {
     template: string;
     value: number;
 };
+type BaseChallengeDetails = {
+    id: number;
+    name: string;
+    value: number;
+    description: string;
+    category: string;
+    state: "visible";
+    max_attempts: number;
+    type_data: {
+        id: ChallengeType;
+        name: ChallengeType;
+        templates: {
+            create: string;
+            update: string;
+            view: string;
+        };
+        scripts: {
+            create: string;
+            update: string;
+            view: string;
+        };
+    };
+    solves: number;
+    solved_by_me: boolean;
+    attempts: number;
+    files: string[];
+    tags: string[];
+    hints: string[];
+    view: string;
+};
+type StandardChallengeDetails = BaseChallengeDetails & {
+    type: Exclude<ChallengeType, 'code'>;
+    attribution: string | null;
+    connection_info: string | null;
+    next_id: number | null;
+};
+type ProgrammingChallengeDetails = BaseChallengeDetails & {
+    type: Extract<ChallengeType, 'code'>;
+    language: string;
+    version: null;
+    output_enabled: null;
+};
+type ChallengeDetails = StandardChallengeDetails | ProgrammingChallengeDetails;
 
 type ClientOptions = {
     url: string;
@@ -55,10 +99,20 @@ declare class CTFdClient {
     } | {
         status: "correct";
         message: "Correct";
+    } | {
+        status: "already_solved";
+        message: "You already solved this";
+    } | {
+        status: "paused";
+        message: `${string} is paused`;
+    } | {
+        status: "ratelimited";
+        message: "You're submitting flags too fast. Slow down.";
     }>;
     getChallenges(): Promise<ChallengeData[]>;
+    getChallengeDetails(id: number): Promise<ChallengeDetails>;
     getScoreboard(): Promise<ScoreboardEntry[]>;
     private getAuthedSessionNonce;
 }
 
-export { CTFdClient, type ChallengeData, type ScoreboardEntry };
+export { CTFdClient, type ChallengeData, type ChallengeDetails, type ChallengeType, type ScoreboardEntry };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@b01lers/ctfd-api",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "An API client for CTFd.",
   "main": "dist/index.js",
   "types": "dist/types.d.ts",

package/src/client.ts

@@ -87,7 +87,7 @@ export class CTFdClient {
         const [session] = res.headers.getSetCookie()[0].split('; ');
         const nonce = extractNonce(await res.text());
 
-        const formData = new FormData();
+        const formData = new URLSearchParams();
         formData.append('name', this.username);
         formData.append('password', this.password);
         formData.append('_submit', 'Submit');

package/src/types.ts

@@ -12,8 +12,8 @@ type BaseScoreboardEntry = {
     oauth_id: null,
     name: string,
     score: number,
-    bracket_id: null,
-    bracket_name: null
+    bracket_id: number | null,
+    bracket_name: string | null  // e.g. "Open Bracket"
 }
 
 type ScoreboardUserEntry = BaseScoreboardEntry & {
@@ -100,4 +100,10 @@ export type FlagSubmissionResponse = APISuccess<{
 } | {
     status: 'already_solved',
     message: 'You already solved this'
+} | {
+    status: 'paused',
+    message: `${string} is paused`
+} | {
+    status: 'ratelimited',
+    message: 'You\'re submitting flags too fast. Slow down.'
 }>

package/tests/rate-limit.ts

@@ -0,0 +1,19 @@
+import { CTFdClient } from '../src/client';
+
+
+;(async () => {
+    const client = new CTFdClient({
+        url: 'https://demo.ctfd.io/',
+        username: 'user',
+        password: 'password',
+    });
+
+    const chall = (await client.getChallenges()).find((c) => c.name === 'Too Many Puppers')!;
+
+    const res = await client.submitFlag(chall.id, 'test');
+    console.log(res);
+
+    for (let i = 0; i < 20; i++) {
+        console.log(await client.submitFlag(chall.id, 'test'));
+    }
+})()