hakanai-lib 3.0.2

Client library for Hakanai, a secure secret sharing service.
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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
// SPDX-License-Identifier: Apache-2.0

use std::sync::Arc;
use std::time::Duration;

use async_trait::async_trait;
use bytes::Bytes;
use reqwest::{Body, Url};
use uuid::Uuid;

use crate::client::{Client, ClientError};
use crate::models::{PostSecretRequest, PostSecretResponse, restrictions};
use crate::observer::DataTransferObserver;
use crate::options::{SecretReceiveOptions, SecretSendOptions};

const SHORT_SECRET_PATH: &str = "s";
const API_SECRET_PATH: &str = "api/v1/secret";
const DEFAULT_REQUEST_TIMEOUT: Duration = Duration::from_secs(10);
const DEFAULT_USER_AGENT: &str = "hakanai-client";
const DEFAULT_CHUNK_SIZE: usize = 8192; // 8 KB

pub struct WebClient {
    web_client: reqwest::Client,
    upload_observer: Option<Arc<dyn DataTransferObserver>>,
}

impl WebClient {
    /// Creates a new instance of `WebClient`.
    pub fn new() -> Self {
        WebClient {
            web_client: reqwest::Client::new(),
            upload_observer: None,
        }
    }
}

#[async_trait]
impl Client<Vec<u8>> for WebClient {
    async fn send_secret(
        &self,
        base_url: Url,
        data: Vec<u8>,
        ttl: Duration,
        token: String,
        opts: Option<SecretSendOptions>,
    ) -> Result<Url, ClientError> {
        let url = base_url.join(API_SECRET_PATH)?;

        let secret = String::from_utf8(data)?;
        let mut req = PostSecretRequest::new(secret, ttl);

        let opt = opts.unwrap_or_default();
        if let Some(restrictions) = opt.restrictions.clone() {
            req = req.with_restrictions(restrictions);
        }

        let (body, content_length) = self.post_secret_body_from_req(req, &opt)?;

        let timeout = opt.timeout.unwrap_or(DEFAULT_REQUEST_TIMEOUT);
        let user_agent = opt.user_agent.unwrap_or(DEFAULT_USER_AGENT.to_string());
        let request_id = Uuid::new_v4().to_string();

        let mut req = self
            .web_client
            .post(url.to_string())
            .header("User-Agent", user_agent)
            .header("Content-Type", "application/json")
            .header("Content-Length", content_length.to_string())
            .header("X-Request-Id", request_id)
            .body(body)
            .timeout(timeout);

        if !token.is_empty() {
            req = req.bearer_auth(token);
        }

        let resp = req.send().await?;

        if resp.status() != reqwest::StatusCode::OK {
            let mut err_msg = format!("HTTP error: {}", resp.status());

            if let Ok(body) = resp.text().await {
                err_msg += &format!("\n{body}");
            }

            return Err(ClientError::Http(err_msg));
        }

        let res = resp.json::<PostSecretResponse>().await?;

        let secret_url = base_url.join(&format!("{}/{}", SHORT_SECRET_PATH, res.id))?;
        Ok(secret_url)
    }

    async fn receive_secret(
        &self,
        url: Url,
        opts: Option<SecretReceiveOptions>,
    ) -> Result<Vec<u8>, ClientError> {
        if !url.path().starts_with(&format!("/{SHORT_SECRET_PATH}/"))
            && !url.path().starts_with(&format!("/{API_SECRET_PATH}/"))
        {
            return Err(ClientError::Custom("Invalid API path".to_string()));
        }

        let opt = opts.unwrap_or_default();
        let user_agent = opt.user_agent.unwrap_or(DEFAULT_USER_AGENT.to_string());
        let timeout = opt.timeout.unwrap_or(DEFAULT_REQUEST_TIMEOUT);
        let request_id = Uuid::new_v4().to_string();

        let mut req = self
            .web_client
            .get(url)
            .header("User-Agent", user_agent)
            .header("X-Request-Id", request_id)
            .timeout(timeout);

        if let Some(ref hash) = opt.passphrase_hash {
            req = req.header(restrictions::PASSPHRASE_HEADER_NAME, hash)
        }

        let mut resp = req.send().await?;

        if resp.status() != reqwest::StatusCode::OK {
            let mut err_msg = format!("HTTP error: {}", resp.status());

            if let Ok(body) = resp.text().await {
                err_msg += &format!("\n{body}");
            }

            return Err(ClientError::Http(err_msg));
        }

        let observer = opt.observer.clone();
        let secret = self.read_body_in_chunks(&mut resp, observer).await?;

        Ok(secret)
    }
}

impl WebClient {
    async fn read_body_in_chunks(
        &self,
        resp: &mut reqwest::Response,
        observer: Option<Arc<dyn DataTransferObserver>>,
    ) -> Result<Vec<u8>, ClientError> {
        let total_size = resp.content_length().unwrap_or(0);
        if total_size == 0 {
            return Err(ClientError::Custom(
                "Response body is empty or content length is not set".to_string(),
            ));
        }

        let mut result = Vec::with_capacity(total_size as usize);
        let mut bytes_read = 0u64;

        while let Some(chunk) = resp.chunk().await? {
            result.extend_from_slice(&chunk);
            bytes_read += chunk.len() as u64;

            if let Some(ref obs) = observer {
                obs.on_progress(bytes_read, total_size).await;
            }
        }

        Ok(result)
    }

    fn post_secret_body_from_req(
        &self,
        req: PostSecretRequest,
        opts: &SecretSendOptions,
    ) -> Result<(Body, usize), ClientError> {
        let json_bytes = serde_json::to_vec(&req)?;
        let json_len = json_bytes.len();

        let chunk_size = opts.chunk_size.unwrap_or(DEFAULT_CHUNK_SIZE);
        if chunk_size == 0 {
            return Err(ClientError::Custom(
                "Chunk size must be greater than 0".to_string(),
            ));
        }

        let mut bytes_uploaded = 0u64;
        let upload_observer = self.upload_observer.clone();
        let stream = async_stream::stream! {
            let mut offset = 0;

            while offset < json_len {
                let end = std::cmp::min(offset + chunk_size, json_bytes.len());
                let chunk = Bytes::copy_from_slice(&json_bytes[offset..end]);
                bytes_uploaded += chunk.len() as u64;

                if let Some(ref observer) = upload_observer {
                    observer.on_progress(bytes_uploaded, json_len as u64).await;
                }

                yield Ok::<_, std::io::Error>(chunk);
                offset = end;
            }
        };

        Ok((Body::wrap_stream(stream), json_len))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::error::Error;
    use std::time::Duration;

    use ulid::Ulid;
    use url::Url;

    type Result<T> = std::result::Result<T, Box<dyn Error>>;

    #[tokio::test]
    async fn test_send_secret_success() -> Result<()> {
        let mut server = mockito::Server::new_async().await;
        let client = WebClient::new();

        let secret_id = Ulid::new();
        let _m = server
            .mock("POST", "/api/v1/secret")
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(format!(r#"{{"id":"{secret_id}"}}"#))
            .create_async()
            .await;

        let base_url = Url::parse(&server.url())?;
        let result = client
            .send_secret(
                base_url.clone(),
                b"test_secret".to_vec(),
                Duration::from_secs(3600),
                "".to_string(),
                None,
            )
            .await;

        let url = result?;
        assert_eq!(url.as_str(), format!("{base_url}s/{secret_id}"));
        Ok(())
    }

    #[tokio::test]
    async fn test_send_secret_server_error() -> Result<()> {
        let mut server = mockito::Server::new_async().await;
        let client = WebClient::new();

        let _m = server
            .mock("POST", "/api/v1/secret")
            .with_status(500)
            .create_async()
            .await;

        let base_url = Url::parse(&server.url())?;
        let result = client
            .send_secret(
                base_url,
                b"test_secret".to_vec(),
                Duration::from_secs(3600),
                "".to_string(),
                None,
            )
            .await;

        assert!(
            result.is_err(),
            "Expected error for server error, got: {:?}",
            result
        );
        Ok(())
    }

    #[tokio::test]
    async fn test_receive_secret_success() -> Result<()> {
        let mut server = mockito::Server::new_async().await;
        let client = WebClient::new();

        let secret_id = Ulid::new();
        let secret_data = b"my_secret_data";

        let _m = server
            .mock("GET", format!("/s/{secret_id}").as_str())
            .with_status(200)
            .with_body(secret_data)
            .create_async()
            .await;

        let base_url = Url::parse(&server.url())?;
        let url = base_url.join(&format!("/s/{secret_id}"))?;
        let result = client.receive_secret(url, None).await;

        let data = result?;
        assert_eq!(data, secret_data);
        Ok(())
    }

    #[tokio::test]
    async fn test_receive_secret_not_found() -> Result<()> {
        let mut server = mockito::Server::new_async().await;
        let client = WebClient::new();

        let secret_id = Ulid::new();

        let _m = server
            .mock("GET", format!("/s/{secret_id}").as_str())
            .with_status(404)
            .create_async()
            .await;

        let base_url = Url::parse(&server.url())?;
        let url = base_url.join(&format!("/s/{secret_id}"))?;
        let result = client.receive_secret(url, None).await;
        assert!(result.is_err(), "Expected error for 404, got: {:?}", result);
        Ok(())
    }

    #[tokio::test]
    async fn test_send_secret_invalid_json_response() -> Result<()> {
        let mut server = mockito::Server::new_async().await;
        let client = WebClient::new();

        let _m = server
            .mock("POST", "/api/v1/secret")
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(r#"{"invalid": "json"}"#)
            .create_async()
            .await;

        let base_url = Url::parse(&server.url())?;
        let result = client
            .send_secret(
                base_url,
                b"test_secret".to_vec(),
                Duration::from_secs(3600),
                "".to_string(),
                None,
            )
            .await;

        assert!(
            result.is_err(),
            "Expected error for invalid JSON, got: {:?}",
            result
        );
        Ok(())
    }

    // Tests for passphrase functionality in WebClient
    #[tokio::test]
    async fn test_receive_secret_with_passphrase() -> Result<()> {
        let mut server = mockito::Server::new_async().await;
        let client = WebClient::new();

        let secret_id = Ulid::new();
        let secret_data = b"passphrase_protected_secret";

        let _m = server
            .mock("GET", format!("/s/{secret_id}").as_str())
            .match_header(
                restrictions::PASSPHRASE_HEADER_NAME,
                "5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8",
            ) // SHA-256 of "password"
            .with_status(200)
            .with_body(secret_data)
            .create_async()
            .await;

        let base_url = Url::parse(&server.url())?;
        let url = base_url.join(&format!("/s/{secret_id}"))?;

        let opts = SecretReceiveOptions::new().with_passphrase(b"password");
        let result = client.receive_secret(url, Some(opts)).await;

        let data = result?;
        assert_eq!(
            data, secret_data,
            "Should receive secret data with correct passphrase"
        );
        Ok(())
    }

    #[tokio::test]
    async fn test_receive_secret_with_empty_passphrase() -> Result<()> {
        let mut server = mockito::Server::new_async().await;
        let client = WebClient::new();

        let secret_id = Ulid::new();
        let secret_data = b"empty_passphrase_secret";

        let _m = server
            .mock("GET", format!("/s/{secret_id}").as_str())
            .with_status(200)
            .with_body(secret_data)
            .create_async()
            .await;

        let base_url = Url::parse(&server.url())?;
        let url = base_url.join(&format!("/s/{secret_id}"))?;

        let opts = SecretReceiveOptions::new().with_passphrase(b"");
        let result = client.receive_secret(url, Some(opts)).await;

        let data = result?;
        assert_eq!(
            data, secret_data,
            "Should receive secret data with empty passphrase"
        );
        Ok(())
    }

    #[tokio::test]
    async fn test_receive_secret_without_passphrase() -> Result<()> {
        let mut server = mockito::Server::new_async().await;
        let client = WebClient::new();

        let secret_id = Ulid::new();
        let secret_data = b"unprotected_secret";

        let _m = server
            .mock("GET", format!("/s/{secret_id}").as_str())
            .match_header(
                restrictions::PASSPHRASE_HEADER_NAME,
                mockito::Matcher::Missing,
            ) // No passphrase header expected
            .with_status(200)
            .with_body(secret_data)
            .create_async()
            .await;

        let base_url = Url::parse(&server.url())?;
        let url = base_url.join(&format!("/s/{secret_id}"))?;

        let result = client.receive_secret(url, None).await;

        let data = result?;
        assert_eq!(
            data, secret_data,
            "Should receive secret data without passphrase"
        );
        Ok(())
    }

    #[tokio::test]
    async fn test_receive_secret_with_wrong_passphrase_401() -> Result<()> {
        let mut server = mockito::Server::new_async().await;
        let client = WebClient::new();

        let secret_id = Ulid::new();

        let _m = server
            .mock("GET", format!("/s/{secret_id}").as_str())
            .match_header(restrictions::PASSPHRASE_HEADER_NAME, mockito::Matcher::Any)
            .with_status(401) // Unauthorized - wrong passphrase
            .with_body("Passphrase required or incorrect")
            .create_async()
            .await;

        let base_url = Url::parse(&server.url())?;
        let url = base_url.join(&format!("/s/{secret_id}"))?;

        let opts = SecretReceiveOptions::new().with_passphrase(b"wrongpassword");
        let result = client.receive_secret(url, Some(opts)).await;

        assert!(result.is_err(), "Should return error for wrong passphrase");
        if let Err(ClientError::Http(msg)) = result {
            assert!(msg.contains("401"), "Error should mention 401 status");
        } else {
            panic!("Expected HTTP error for wrong passphrase");
        }
        Ok(())
    }

    #[tokio::test]
    async fn test_receive_secret_passphrase_with_other_options() -> Result<()> {
        let mut server = mockito::Server::new_async().await;
        let client = WebClient::new();

        let secret_id = Ulid::new();
        let secret_data = b"multi_option_secret";

        let _m = server
            .mock("GET", format!("/s/{secret_id}").as_str())
            .match_header("User-Agent", "CustomAgent/1.0")
            .match_header(restrictions::PASSPHRASE_HEADER_NAME, mockito::Matcher::Any)
            .with_status(200)
            .with_body(secret_data)
            .create_async()
            .await;

        let base_url = Url::parse(&server.url())?;
        let url = base_url.join(&format!("/s/{secret_id}"))?;

        let opts = SecretReceiveOptions::new()
            .with_user_agent("CustomAgent/1.0".to_string())
            .with_timeout(Duration::from_secs(30))
            .with_passphrase(b"combined_test");
        let result = client.receive_secret(url, Some(opts)).await;

        let data = result?;
        assert_eq!(
            data, secret_data,
            "Should work with multiple options including passphrase"
        );
        Ok(())
    }

    #[tokio::test]
    async fn test_receive_secret_passphrase_header_format() -> Result<()> {
        let mut server = mockito::Server::new_async().await;
        let client = WebClient::new();

        let secret_id = Ulid::new();
        let secret_data = b"header_format_test";

        // Verify the exact hash format
        let expected_hash = "5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8"; // SHA-256 of "password"

        let _m = server
            .mock("GET", format!("/s/{secret_id}").as_str())
            .match_header(restrictions::PASSPHRASE_HEADER_NAME, expected_hash)
            .with_status(200)
            .with_body(secret_data)
            .create_async()
            .await;

        let base_url = Url::parse(&server.url())?;
        let url = base_url.join(&format!("/s/{secret_id}"))?;

        let opts = SecretReceiveOptions::new().with_passphrase(b"password");
        let result = client.receive_secret(url, Some(opts)).await;

        let data = result?;
        assert_eq!(
            data, secret_data,
            "Should send passphrase as lowercase hex SHA-256 hash"
        );
        Ok(())
    }
}