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
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
use super::request_builder::PqkdRequestBuilder;
use crate::error::PqkdError;
use crate::qrng::{QrngFormat, QrngReturnFormat};
use crate::request::{PqkdMethod, PqkdRequest};
use crate::response::PqkdResponse;
use crate::{Key, Keys, PqkdStatus};
use reqwest::blocking::Client;
use serde_json::{json, Value};
use url::Url;

/// Contains the necessary data for
/// communication with the pQKD device.
///
/// # Example
///
/// ```
/// use pqkd::blocking::BuilderPqkdClient;
/// use std::error::Error;
///
/// fn main() -> Result<(), Box<dyn Error>> {
///     
///     //let ca_cert = std::fs::read("ca.cert")?;
///     //let client_cert = std::fs::read("client.cert")?;
///     //let client_key = std::fs::read("client.key")?;
///
///
///     let pqkd_client_1 = BuilderPqkdClient::with_addr("http://172.16.0.154:8082")?
///         .with_qrng_addr("http://172.16.0.154:8085")?
///      //   .with_tls(&ca_cert, &client_cert, &client_key)?
///         .build();
///
///     let pqkd_client_2 = BuilderPqkdClient::with_addr("http://172.16.0.155:8082")?
///         .with_qrng_addr("http://172.16.0.155:8085")?
///         //.with_tls(&ca_cert, &client_cert, &client_key)?
///         .build();
///     
///     let status1 = pqkd_client_1.status("Test_2SAE")
///         .send()?;
///     let status2 = pqkd_client_2.status("Test_1SAE")
///         .send()?;
///
///     let key1 = pqkd_client_1.enc_keys("Test_2SAE")
///         .size(1024)
///         .send()?
///         .keys();
///     let key2 = pqkd_client_2.dec_keys("Test_1SAE")
///         .key_id(key1[0].key_id())
///         .send()?
///         .keys();
///     
///     assert_eq!(key1[0].key(), key2[0].key());
///
///     let keys1 = pqkd_client_1.enc_keys("Test_2SAE")
///         .number(10)
///         .size(512)
///         .send()?
///         .keys();
///     let keys2 = pqkd_client_2.dec_keys("Test_1SAE")
///         .key_ids(keys1.iter().map(|key| key.key_id()).collect::<Vec<&str>>())
///         .send()?
///         .keys();
///     
///     assert_eq!(keys1.len(), keys2.len());
///     let mut iter1 = keys1.iter();
///     keys2.iter().map(|key| assert_eq!(key, iter1.next().unwrap()));
///     
///
///     let random_hex = pqkd_client_1.get_random_hex(64).unwrap();
///     let random_bytes = pqkd_client_1.get_random_bytes(512).unwrap();
///     let random_base64 = pqkd_client_1.get_random_base64(256).unwrap();
///      
///     Ok(())
/// }
///
#[derive(Clone)]
pub struct PqkdClient {
    kme_addr: Url,
    qrng_addr: Url,
    client: Client,
    local_target: Vec<u8>,
    local_sae_id: String,
}

/// Build [PqkdClient](pqkd::PqkdClient) by combining an address KME server,
/// address QRNG server and request::Client with certificates.
///
/// ```
/// use pqkd::blocking::BuilderPqkdClient;
/// use std::error::Error;
///
/// fn build_pqkd() -> Result<(), Box<dyn Error>> {
///     
///     let ca_cert = std::fs::read("./ca.cert")?;
///     let client_cert = std::fs::read("./client.cert")?;
///     let client_key = std::fs::read("./client.keu")?;
///    
///     let pqkd = BuilderPqkdClient::with_addr("https://172.0.0.1:8082")?
///         .with_qrng_addr("http://127.0.0.1:8085")?
///         .with_tls(&ca_cert, &client_cert, &client_key)?
///         .build();
///     
///     Ok(())
/// }
///
/// ```
pub struct BuilderPqkdClient {
    kme_addr: Url,
    qrng_addr: Url,
    client: Client,
    local_target: Vec<u8>,
    local_sae_id: String,
}

impl BuilderPqkdClient {
    /// Add a KME server address of PQKD.
    /// Returns an error if parsing of the address failed.
    /// # Examples
    ///
    /// ```
    /// use pqkd::blocking::BuilderPqkdClient;
    /// use std::error::Error;
    ///
    /// fn build_pqkd() -> Result<(), Box<dyn Error>> {
    ///     
    ///     let pqkd_builder = BuilderPqkdClient::with_addr("http://172.0.0.1:8082")?;
    ///     
    ///     Ok(())
    /// }
    ///
    /// ```
    pub fn with_addr(addr: &str) -> Result<Self, PqkdError> {
        // TODO addr must be "mailto:rms@example.net"!!!!!
        let kme_addr = Url::parse(addr)
            .map_err(|_| PqkdError::BuildPqkdError("parsing failed.".to_string()))?;
        let mut qrng_addr = kme_addr.clone();
        let _ = qrng_addr
            .set_port(Some(8085))
            .map_err(|_| PqkdError::BuildPqkdError("".to_string()));
        Ok(Self {
            kme_addr,
            qrng_addr,
            client: reqwest::blocking::ClientBuilder::new()
                .http1_title_case_headers()
                .build()
                .unwrap(),
            local_target: Vec::new(),
            local_sae_id: String::new(),
        })
    }

    /// Add a QRNG server address of PQKD.
    /// If this method is not called, the default address will be used,
    /// i.e. the same as the KME server address of the pQKD only with port 8085.
    /// Returns an error if parsing of the address failed.
    /// # Examples
    ///
    /// ```
    /// use pqkd::blocking::BuilderPqkdClient;
    /// use std::error::Error;
    ///
    /// fn build_pqk() -> Result<(), Box<dyn Error>> {
    ///     
    ///     let pqkd_builder = BuilderPqkdClient::with_addr("https://172.0.0.1:8082")?
    ///         .with_qrng_addr("http://127.0.0.1:8085")?;
    ///     
    ///     Ok(())
    /// }
    /// ```
    pub fn with_qrng_addr(self, addr: &str) -> Result<Self, PqkdError> {
        let qrng_addr: Url = Url::parse(addr)
            .map_err(|_| PqkdError::BuildPqkdError("parsing failed.".to_string()))?;
        Ok(Self {
            kme_addr: self.kme_addr,
            qrng_addr,
            client: self.client,
            local_target: self.local_target,
            local_sae_id: self.local_sae_id,
        })
    }

    /// Add a CA certificate, client certificate and client key for TLS.
    /// This method accepts as parameters vectors of bytes certificates and key.
    /// File must be in pem format.   
    /// # Examples
    ///
    /// ```
    /// use pqkd::blocking::BuilderPqkdClient;
    /// use std::error::Error;
    ///
    /// fn build_pqk() -> Result<(), Box<dyn Error>> {
    ///     
    ///     let ca_cert = std::fs::read("ca.cert")?;
    ///     let client_cert = std::fs::read("client.cert")?;
    ///     let client_key = std::fs::read("client.key")?;
    ///     
    ///     let pqkd_builder = BuilderPqkdClient::with_addr("https://172.0.0.1:8082")?
    ///         .with_tls(&ca_cert, & client_cert, & client_key)?;
    ///     
    ///     Ok(())
    /// }
    /// ```
    pub fn with_tls(
        self,
        ca_cert: &Vec<u8>,
        client_cert: &Vec<u8>,
        client_key: &Vec<u8>,
    ) -> Result<Self, PqkdError> {
        let id = reqwest::Identity::from_pkcs8_pem(client_cert, client_key)?;
        let ca_cert = reqwest::Certificate::from_pem(ca_cert)?;
        Ok(Self {
            kme_addr: self.kme_addr,
            qrng_addr: self.qrng_addr,
            client: reqwest::blocking::Client::builder()
                .use_native_tls()
                .identity(id)
                .add_root_certificate(ca_cert)
                .build()?,
            local_target: self.local_target,
            local_sae_id: self.local_sae_id,
        })
    }

    pub fn with_local_target(self, local_target: Vec<u8>) -> Self {
        Self {
            kme_addr: self.kme_addr,
            qrng_addr: self.qrng_addr,
            client: self.client,
            local_target,
            local_sae_id: self.local_sae_id,
        }
    }

    pub fn with_local_sae_id(self, local_sae_id: &str) -> Self {
        Self {
            kme_addr: self.kme_addr,
            qrng_addr: self.qrng_addr,
            client: self.client,
            local_target: self.local_target,
            local_sae_id: String::from(local_sae_id),
        }
    }

    /// Creates PqkdClient by passing it the data it contains and return it.
    ///
    /// # Examples
    ///
    /// ```
    /// use pqkd::blocking::BuilderPqkdClient;
    /// use std::error::Error;
    ///
    /// fn build_pqk() -> Result<(), Box<dyn Error>> {
    ///     
    ///     let ca_cert = std::fs::read("ca.cert")?;
    ///     let client_cert = std::fs::read("client.cert")?;
    ///     let client_key = std::fs::read("client.key")?;
    ///     
    ///     let pqkd = BuilderPqkdClient::with_addr("https://172.0.0.1:8082")?
    ///         .with_qrng_addr("http://127.0.0.1:8085")?
    ///         .with_tls(&ca_cert, &client_cert, & client_key)?
    ///         .build();
    ///     
    ///     Ok(())
    /// }
    /// ```
    pub fn build(self) -> PqkdClient {
        PqkdClient::new(
            self.kme_addr,
            self.qrng_addr,
            self.client,
            self.local_target,
            self.local_sae_id,
        )
    }
}

impl PqkdClient {
    /// Create a new ['PqkdClient'] from the given
    /// url of kme server, url of qrng server.
    pub fn new(
        kme_addr: Url,
        qrng_addr: Url,
        client: Client,
        local_target: Vec<u8>,
        local_sae_id: String,
    ) -> Self {
        Self {
            kme_addr,
            qrng_addr,
            client,
            local_target,
            local_sae_id,
        }
    }

    // pub async fn status(&self, sae_id: &str) -> Result<PqkdStatus, PqkdError> {
    //     self._fetch_status(sae_id).await
    // }

    pub fn status(&self, sae_id: &str) -> PqkdRequestBuilder {
        PqkdRequestBuilder::new(self.clone(), PqkdRequest::new(PqkdMethod::Status, sae_id))
    }

    // pub async fn enc_key(&self, sae_id: &str, size: u32) -> Result<Key, PqkdError> {
    //     let mut vec = self._fetch_enc_keys(sae_id, 1, size, None).await?;
    //     let key = vec.pop().unwrap();
    //     Ok(key)
    // }

    pub fn enc_keys(&self, sae_id: &str) -> PqkdRequestBuilder {
        PqkdRequestBuilder::new(self.clone(), PqkdRequest::new(PqkdMethod::EncKeys, sae_id))
    }

    // pub async fn enc_key_with_key_id(&self, sae_id: &str, size: u32, key_id: &str) -> Result<Key, PqkdError> {
    //     let mut vec = self._fetch_enc_keys(sae_id, 1, size, Some(vec![key_id])).await?;
    //     let key = vec.pop().unwrap();
    //     Ok(key)
    // }

    // pub async fn enc_keys(&self, sae_id: &str, number: u32, size: u32) -> Result<Vec<Key>, PqkdError> {
    //     self._fetch_enc_keys(sae_id, number, size, None).await
    // }

    // pub async fn enc_keys_with_key_ids(&self, sae_id: &str, size: u32, key_ids: Vec<&str>) -> Result<Vec<Key>, PqkdError> {
    //     self._fetch_enc_keys(sae_id, 1u32, size, Some(key_ids)).await
    // }

    // pub async fn dec_key(&self, sae_id: &str, key_id: &str) -> Result<Key, PqkdError> {
    //     let mut vec = self._fetch_dec_keys(sae_id, vec![key_id]).await?;
    //     let key = vec.pop().unwrap();
    //     Ok(key)
    // }

    pub fn dec_keys(&self, sae_id: &str) -> PqkdRequestBuilder {
        PqkdRequestBuilder::new(self.clone(), PqkdRequest::new(PqkdMethod::DesKeys, sae_id))
    }

    // pub async fn dec_keys(&self, sae_id: &str, key_ids: Vec<&str>) -> Result<Vec<Key>, PqkdError> {
    //     self._fetch_dec_keys(sae_id, key_ids).await
    // }

    pub fn get_random_hex(&self, size: u32) -> Result<String, PqkdError> {
        Ok(self._fetch_random(QrngFormat::Hex, size)?.as_hex().unwrap())
    }

    pub fn get_random_bytes(&self, size: u32) -> Result<Vec<u8>, PqkdError> {
        Ok(self
            ._fetch_random(QrngFormat::Bytes, size)?
            .as_bytes()
            .unwrap())
    }

    pub fn get_random_base64(&self, size: u32) -> Result<String, PqkdError> {
        Ok(self
            ._fetch_random(QrngFormat::Base64, size)?
            .as_base64()
            .unwrap())
    }

    pub fn get_sae_ids(&self) -> Result<Vec<String>, PqkdError> {
        todo!();
    }

    pub fn add_target(&self) -> Result<(), PqkdError> {
        todo!();
    }

    pub fn remove_target(&self) -> Result<(), PqkdError> {
        todo!();
    }

    pub fn local_target(&self) -> &[u8] {
        &self.local_target
    }

    pub fn local_sae_id(&self) -> &str {
        &self.local_sae_id
    }
}

impl PqkdClient {
    pub fn kme_execute_request(
        &self,
        pqkd_request: PqkdRequest,
    ) -> Result<PqkdResponse, PqkdError> {
        match pqkd_request.pqkd_method() {
            PqkdMethod::Status => {
                let url = self
                    .kme_addr
                    .join(&format!("api/v1/keys/{}/status", pqkd_request.sae_id()))
                    .map_err(|_| PqkdError::ErrorKmeRequest)
                    .unwrap();
                let res = self.client.get(url).send()?.error_for_status()?;

                let body = res.text()?;
                let status: PqkdStatus = serde_json::from_str(&body).unwrap();
                Ok(PqkdResponse::Status(status))
            }
            PqkdMethod::EncKeys => {
                let url = self
                    .kme_addr
                    .join(&format!("/api/v1/keys/{}/enc_keys", pqkd_request.sae_id()))
                    .map_err(|_| PqkdError::ErrorKmeRequest)
                    .unwrap();
                let body = if pqkd_request.key_ids().len() > 0 {
                    let ids: Vec<&str> = pqkd_request
                        .key_ids()
                        .iter()
                        .map(|id| id.as_str())
                        .collect();
                    json!({"size": pqkd_request.size(), "key_IDs": ids})
                } else {
                    json!({"size": pqkd_request.size(), "number": pqkd_request.number()})
                };

                let res = self.client.post(url).body(body.to_string());
                let res = res.send()?.error_for_status().unwrap();

                let body = res.text()?;
                let keys: Keys = serde_json::from_str(&body)?;
                Ok(PqkdResponse::Keys(keys.keys))
            }
            PqkdMethod::DesKeys => {
                let url = self
                    .kme_addr
                    .join(&format!("/api/v1/keys/{}/dec_keys", pqkd_request.sae_id()))
                    .map_err(|_| PqkdError::ErrorKmeRequest)
                    .unwrap();
                let key_ids: Vec<serde_json::Value> = pqkd_request
                    .key_ids()
                    .iter()
                    .map(|key_id| json!({"key_ID": key_id}))
                    .collect();
                let body = json!({"key_IDs": key_ids});

                let res = self
                    .client
                    .post(url)
                    .header("Content-Type", "application/json")
                    .body(body.to_string())
                    .send()?
                    .error_for_status()
                    .unwrap();

                let body = res.text().unwrap();
                let keys: Keys = serde_json::from_str(&body).unwrap();
                Ok(PqkdResponse::Keys(keys.keys))
            }
        }
    }

    fn _fetch_random(&self, format: QrngFormat, size: u32) -> Result<QrngReturnFormat, PqkdError> {
        format.check_size(size)?;

        let url = self
            .qrng_addr
            .join(&format!("qrng/{}?size={}", &format.to_string(), size))
            .map_err(|_| PqkdError::ErrorQrngRequest)
            .unwrap();

        let res = self.client.get(url).send()?.error_for_status()?;
        let res = match format {
            QrngFormat::Base64 => {
                let body = res.text()?;
                let v: Value = serde_json::from_str(&body)?;
                QrngReturnFormat::Base64(v["result"].as_str().unwrap().to_string())
            }
            QrngFormat::Bytes => {
                let body = res.bytes()?;
                QrngReturnFormat::Bytes(body.to_vec())
            }
            QrngFormat::Hex => {
                let body = res.text()?;
                let v: Value = serde_json::from_str(&body)?;
                QrngReturnFormat::Hex(v["result"].as_str().unwrap().to_string())
            }
        };
        Ok(res)
    }

    fn _fetch_status(&self, sae_id: &str) -> Result<PqkdStatus, PqkdError> {
        let url = self
            .kme_addr
            .join(&format!("api/v1/keys/{}/status", sae_id))
            .map_err(|_| PqkdError::ErrorKmeRequest)
            .unwrap();

        let res = self.client.get(url).send()?.error_for_status()?;

        let body = res.text()?;
        let status: PqkdStatus = serde_json::from_str(&body).unwrap();
        Ok(status)
    }

    fn _fetch_enc_keys(
        &self,
        sae_id: &str,
        number: u32,
        size: u32,
        key_ids: Option<Vec<&str>>,
    ) -> Result<Vec<Key>, PqkdError> {
        if number == 0 {
            return Err(PqkdError::NumberOfKeysError);
        }
        if size < 64 || size % 8 != 0 || size > 4096 {
            return Err(PqkdError::SizeOfKeysError);
        }
        let url = self
            .kme_addr
            .join(&format!("/api/v1/keys/{}/enc_keys", sae_id))
            .map_err(|_| PqkdError::ErrorKmeRequest)
            .unwrap();
        let body = if let Some(ids) = key_ids {
            let ids: Vec<&str> = ids.iter().map(|id| *id).collect();
            json!({"size": size, "key_IDs": ids})
        } else {
            json!({"size": size, "number": number})
        };

        let res = self.client.post(url).body(body.to_string());
        let res = res.send()?.error_for_status().unwrap();

        let body = res.text()?;
        let keys: Keys = serde_json::from_str(&body)?;
        Ok(keys.keys)
    }

    fn _fetch_dec_keys(&self, sae_id: &str, key_ids: Vec<&str>) -> Result<Vec<Key>, PqkdError> {
        let url = self
            .kme_addr
            .join(&format!("/api/v1/keys/{}/dec_keys", sae_id))
            .map_err(|_| PqkdError::ErrorKmeRequest)
            .unwrap();
        let key_ids: Vec<serde_json::Value> = key_ids
            .iter()
            .map(|key_id| json!({"key_ID": *key_id}))
            .collect();
        let body = json!({"key_IDs": key_ids});
        // let body = KeyIds{
        //     key_IDs: key_ids.iter().map(|key_id| KeyId { key_ID: key_id.to_string()}).collect(),
        // };

        let res = self
            .client
            .post(url)
            .header("Content-Type", "application/json")
            .body(body.to_string())
            .send()?
            .error_for_status()
            .unwrap();

        let body = res.text().unwrap();
        let keys: Keys = serde_json::from_str(&body).unwrap();
        Ok(keys.keys)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_builder() {
        let _pqkd_client = BuilderPqkdClient::with_addr("http://127.0.0.1:8082")
            .unwrap()
            .with_qrng_addr("http://127.0.0.1:8085")
            .unwrap()
            .build();
    }
}