rhombus 0.2.21

Next generation extendable CTF framework with batteries included
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
use std::{net::IpAddr, num::NonZeroU64};

use async_trait::async_trait;
use chrono::{DateTime, Utc};
use sqlx::{FromRow, PgPool};
use tokio_util::bytes::Bytes;

use crate::{
    internal::{
        auth::User,
        database::{
            cache::Writeups,
            provider::{
                Challenge, Challenges, Database, Email, FirstBloods, Leaderboard, Scoreboard,
                SetAccountNameError, SetTeamNameError, SiteStatistics, Team, TeamMeta,
                TeamStandings, Ticket,
            },
        },
        division::Division,
        settings::Settings,
    },
    Result,
};

#[derive(Clone)]
pub struct Postgres {
    pub pool: PgPool,
}

impl Postgres {
    pub fn new(db: PgPool) -> Self {
        Postgres { pool: db }
    }
}

#[async_trait]
impl Database for Postgres {
    async fn migrate(&self) -> Result<()> {
        Ok(sqlx::migrate!("migrations/postgresql")
            .run(&self.pool)
            .await?)
    }

    async fn upsert_user_by_discord_id(
        &self,
        name: &str,
        email: &str,
        avatar: &str,
        discord_id: NonZeroU64,
        _user_id: Option<i64>,
    ) -> Result<(i64, i64)> {
        #[derive(FromRow)]
        struct InsertUserResult {
            id: i64,
            team_id: i64,
        }

        let user = sqlx::query_as::<_, InsertUserResult>(
            r#"
            INSERT INTO "User" (name, email, avatar, discord_id) VALUES ($1, $2, $3, $4)
            ON CONFLICT (discord_id) DO UPDATE SET name = $1, email = $2, avatar = $3, updated_at = now()
            RETURNING id, team_id
            "#
        )
        .bind(name)
        .bind(email)
        .bind(avatar)
        .bind(discord_id.get() as i64)
        .fetch_one(&self.pool)
        .await?;

        Ok((user.id, user.team_id))
    }

    async fn upsert_user_by_email(
        &self,
        _name: &str,
        _email: &str,
        _avatar: &str,
    ) -> Result<(i64, i64)> {
        todo!()
    }

    async fn upsert_user_by_credentials(
        &self,
        _username: &str,
        _avatar: &str,
        _password: &str,
    ) -> Result<Option<(i64, i64)>> {
        todo!()
    }

    async fn upsert_user_by_ctftime(
        &self,
        _name: &str,
        _email: &str,
        _avatar: &str,
        _ctftime_user_id: i64,
        _ctftime_team_id: i64,
        _team_name: &str,
    ) -> Result<(i64, i64, Option<String>)> {
        todo!()
    }

    async fn insert_track(
        &self,
        ip: IpAddr,
        user_agent: Option<&str>,
        user_id: Option<i64>,
        _requests: u64,
    ) -> Result<()> {
        sqlx::query(
            r#"
            INSERT INTO Track (ip, user_agent, last_seen_at, user_id) VALUES ($1, $2, now(), $3)
            ON CONFLICT (ip, user_agent) DO
                UPDATE SET
                    user_id = ?3,
                    last_seen_at = now(),
                    requests = Track.requests + 1
            "#,
        )
        .bind(ip.to_string())
        .bind(user_agent)
        .bind(user_id)
        .execute(&self.pool)
        .await?;
        Ok(())
    }

    async fn get_challenges(&self) -> Result<Challenges> {
        // #[derive(FromRow)]
        // struct DBChallenge {
        //     id: i64,
        //     name: String,
        //     description: String,
        // }

        // let challenges = sqlx::query_as::<_, DBChallenge>("SELECT * FROM challenge")
        //     .fetch_all(&self.pool)
        //     .await?
        //     .into_iter()
        //     .map(|challenge| Challenge {
        //         id: challenge.id,
        //         name: challenge.name,
        //         description: challenge.description,
        //         category_id: 1,
        //     })
        //     .collect();

        todo!()
    }

    async fn set_challenge_health(
        &self,
        _challenge_id: i64,
        _healthy: Option<bool>,
        _checked_at: DateTime<Utc>,
    ) -> Result<()> {
        todo!()
    }

    async fn get_team_meta_from_invite_token(
        &self,
        _invite_token: &str,
    ) -> Result<Option<TeamMeta>> {
        todo!()
    }

    async fn get_team_from_id(&self, _user_id: i64) -> Result<Team> {
        todo!()
    }

    async fn add_user_to_team(
        &self,
        _user_id: i64,
        _team_id: i64,
        _old_team_id: Option<i64>,
    ) -> Result<()> {
        todo!()
    }

    async fn get_user_from_id(&self, _user_id: i64) -> Result<User> {
        todo!()
    }

    async fn get_user_from_discord_id(&self, _discord_id: NonZeroU64) -> Result<User> {
        todo!()
    }

    async fn kick_user(&self, _user_id: i64, _team_id: i64) -> Result<()> {
        todo!()
    }

    async fn roll_invite_token(&self, _team_id: i64) -> Result<String> {
        todo!()
    }

    async fn set_team_name(
        &self,
        _team_id: i64,
        _new_team_name: &str,
        _timeout_seconds: u64,
    ) -> Result<std::result::Result<(), SetTeamNameError>> {
        todo!()
    }

    async fn set_account_name(
        &self,
        _user_id: i64,
        _team_id: i64,
        _new_account_name: &str,
        _timeout_seconds: u64,
    ) -> Result<std::result::Result<(), SetAccountNameError>> {
        todo!()
    }

    async fn solve_challenge(
        &self,
        _user_id: i64,
        _team_id: i64,
        _challenge: &Challenge,
    ) -> Result<FirstBloods> {
        todo!()
    }

    async fn add_writeup(
        &self,
        _user_id: i64,
        _team_id: i64,
        _challenge_id: i64,
        _writeup_url: &str,
    ) -> Result<()> {
        todo!()
    }

    async fn get_writeups_from_user_id(&self, _user_id: i64) -> Result<Writeups> {
        todo!()
    }

    async fn delete_writeup(&self, _challenge_id: i64, _user_id: i64, _team_id: i64) -> Result<()> {
        todo!()
    }

    async fn get_next_ticket_number(&self) -> Result<u64> {
        todo!()
    }

    async fn create_ticket(
        &self,
        _ticket_number: u64,
        _user_id: i64,
        _challenge_id: i64,
        _discord_channel_id: NonZeroU64,
    ) -> Result<()> {
        todo!()
    }

    async fn get_ticket_by_ticket_number(&self, _ticket_number: u64) -> Result<Ticket> {
        todo!()
    }

    async fn get_ticket_by_discord_channel_id(
        &self,
        _discord_channel_id: NonZeroU64,
    ) -> Result<Ticket> {
        todo!()
    }

    async fn close_ticket(&self, _ticket_number: u64, _time: DateTime<Utc>) -> Result<()> {
        todo!()
    }

    async fn reopen_ticket(&self, _ticket_number: u64) -> Result<()> {
        todo!()
    }

    async fn add_email_message_id_to_ticket(
        &self,
        _ticket_number: u64,
        _message_id: &str,
        _user_sent: bool,
    ) -> Result<()> {
        todo!()
    }

    async fn get_ticket_number_by_message_id(&self, _message_id: &str) -> Result<Option<u64>> {
        todo!()
    }

    async fn load_settings(&self, _settings: &mut Settings) -> Result<()> {
        todo!()
    }

    async fn save_settings(&self, _settings: &Settings) -> Result<()> {
        todo!()
    }

    async fn get_scoreboard(&self, _division_id: i64) -> Result<Scoreboard> {
        todo!()
    }

    async fn get_leaderboard(&self, _division_id: i64, _page: Option<u64>) -> Result<Leaderboard> {
        todo!()
    }

    async fn get_emails_for_user_id(&self, _user_id: i64) -> Result<Vec<Email>> {
        todo!()
    }

    async fn create_email_verification_callback_code(
        &self,
        _user_id: i64,
        _email: &str,
    ) -> Result<String> {
        todo!()
    }

    async fn verify_email_verification_callback_code(&self, _code: &str) -> Result<()> {
        todo!()
    }

    async fn get_email_verification_by_callback_code(&self, _code: &str) -> Result<String> {
        todo!()
    }

    async fn create_email_signin_callback_code(&self, _email: &str) -> Result<String> {
        todo!()
    }

    async fn verify_email_signin_callback_code(&self, _code: &str) -> Result<String> {
        todo!()
    }

    async fn get_email_signin_by_callback_code(&self, _code: &str) -> Result<String> {
        todo!()
    }

    async fn delete_email(&self, _user_id: i64, _email: &str) -> Result<()> {
        todo!()
    }

    async fn get_user_divisions(&self, _user_id: i64) -> Result<Vec<i64>> {
        todo!()
    }

    async fn set_user_division(
        &self,
        _user_id: i64,
        _team_id: i64,
        _division_id: i64,
        _join: bool,
    ) -> Result<()> {
        todo!()
    }

    async fn insert_divisions(&self, _divisions: &[Division]) -> Result<()> {
        todo!()
    }

    async fn get_team_divisions(&self, _team_id: i64) -> Result<Vec<i64>> {
        todo!()
    }

    async fn get_team_division_last_edit_time(
        &self,
        _team_id: i64,
        _division_id: i64,
    ) -> Result<Option<DateTime<Utc>>> {
        todo!()
    }

    async fn set_team_division_last_edit_time(
        &self,
        _team_id: i64,
        _division_id: i64,
    ) -> Result<()> {
        todo!()
    }

    async fn set_team_division(&self, _team_id: i64, _division_id: i64, _join: bool) -> Result<()> {
        todo!()
    }

    async fn get_team_standings(&self, _team_id: i64) -> Result<TeamStandings> {
        todo!();
    }

    async fn upload_file(&self, _hash: &str, _filename: &str, _bytes: &[u8]) -> Result<()> {
        todo!()
    }

    async fn download_file(&self, _hash: &str) -> Result<(Bytes, String)> {
        todo!()
    }

    async fn get_site_statistics(&self) -> Result<SiteStatistics> {
        todo!()
    }

    async fn get_last_created_ticket_time(&self, _user_id: i64) -> Result<Option<DateTime<Utc>>> {
        todo!()
    }
}

#[cfg(test)]
mod test {
    use sqlx::postgres::PgPoolOptions;
    use testcontainers::runners::AsyncRunner;
    use testcontainers_modules::postgres::Postgres;

    use crate::internal::database::provider::Database;

    #[cfg_attr(not(feature = "testcontainers"), ignore)]
    #[tokio::test]
    async fn migrate_postgres() {
        let postgres_instance = Postgres::default().start().await.unwrap();
        let database_url = format!(
            "postgres://postgres:postgres@127.0.0.1:{}/postgres",
            postgres_instance.get_host_port_ipv4(5432).await.unwrap()
        );

        let pool = PgPoolOptions::new().connect(&database_url).await.unwrap();
        let database = crate::internal::database::postgres::Postgres::new(pool);
        database.migrate().await.unwrap();
    }
}