htb-cli 0.1.11

Hack The Box CLI
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

use serde_json::json;

use crate::error::HtbError;
use crate::models::challenge::{
    Challenge, ChallengeCategoriesResponse, ChallengeCategory, ChallengeDetail,
    ChallengeDetailResponse, ChallengeDownloadResponse, ChallengeOwnResponse,
    ChallengeWriteupResponse,
};
use crate::models::{ActionResponse, Paginated};

use super::HtbClient;

pub struct ChallengeApi<'a>(pub(crate) &'a HtbClient);

impl ChallengeApi<'_> {
    pub async fn list(
        &self,
        page: u32,
        per_page: u32,
        keyword: Option<&str>,
    ) -> Result<Paginated<Challenge>, HtbError> {
        let mut url = format!("/api/v4/challenges?per_page={per_page}&page={page}");
        if let Some(kw) = keyword {
            url.push_str(&format!("&keyword={}", super::encode_path(kw)));
        }
        self.0.get(&url).await
    }

    pub async fn categories(&self) -> Result<Vec<ChallengeCategory>, HtbError> {
        let resp: ChallengeCategoriesResponse =
            self.0.get("/api/v4/challenge/categories/list").await?;
        Ok(resp.info)
    }

    pub async fn info(&self, slug: &str) -> Result<ChallengeDetail, HtbError> {
        let encoded = super::encode_path(slug);
        let resp: ChallengeDetailResponse = self
            .0
            .get(&format!("/api/v4/challenge/info/{encoded}"))
            .await?;
        Ok(resp.challenge)
    }

    pub async fn start(&self, challenge_id: u64) -> Result<ActionResponse, HtbError> {
        self.0
            .post(
                "/api/v4/container/start",
                &json!({"containerable_id": challenge_id}),
            )
            .await
    }

    pub async fn stop(&self, challenge_id: u64) -> Result<ActionResponse, HtbError> {
        self.0
            .post(
                "/api/v4/container/stop",
                &json!({"containerable_id": challenge_id}),
            )
            .await
    }

    pub async fn submit_flag(
        &self,
        challenge_id: u64,
        flag: &str,
    ) -> Result<ChallengeOwnResponse, HtbError> {
        self.0
            .post(
                "/api/v4/challenge/own",
                &json!({"challenge_id": challenge_id, "flag": flag}),
            )
            .await
    }

    pub async fn download_link(&self, challenge_id: u64) -> Result<String, HtbError> {
        let resp: ChallengeDownloadResponse = self
            .0
            .get(&format!("/api/v4/challenges/{challenge_id}/download_link"))
            .await?;
        Ok(resp.url)
    }

    pub async fn download_file(&self, url: &str) -> Result<Vec<u8>, HtbError> {
        self.0.get_bytes(url).await
    }

    pub async fn writeup_info(
        &self,
        challenge_id: u64,
    ) -> Result<ChallengeWriteupResponse, HtbError> {
        self.0
            .get(&format!("/api/v4/challenge/{challenge_id}/writeup"))
            .await
    }

    pub async fn writeup_download(&self, challenge_id: u64) -> Result<Vec<u8>, HtbError> {
        self.0
            .get_bytes(&format!(
                "/api/v4/challenge/{challenge_id}/writeup/official"
            ))
            .await
    }
}