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
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
use super::{
blob_storage::{BlobStorage, BlobStorageDryRun},
Client,
};
use crate::client::Error;
use crate::messaging::client::{ChunkRead, ChunkWrite, DataCmd, DataQuery, Query, QueryResponse};
use crate::types::{Chunk, ChunkAddress, PrivateChunk, PublicChunk, PublicKey};
use bincode::{deserialize, serialize};
use log::{info, trace};
use self_encryption::{DataMap, SelfEncryptor};
use serde::{Deserialize, Serialize};
#[derive(Serialize, Deserialize)]
enum DataMapLevel {
Root(DataMap),
Child(DataMap),
}
impl Client {
pub async fn read_blob(
&self,
head_address: ChunkAddress,
position: Option<usize>,
len: Option<usize>,
) -> Result<Vec<u8>, Error>
where
Self: Sized,
{
trace!(
"Fetch head chunk of blob at: {:?} Position: {:?} Len: {:?}",
&head_address,
&position,
&len
);
let chunk = self.fetch_blob_from_network(head_address).await?;
let public = head_address.is_public();
let data_map = self.unpack(chunk).await?;
let raw_data = self
.read_using_data_map(data_map, public, position, len)
.await?;
Ok(raw_data)
}
pub async fn store_public_blob(&self, data: &[u8]) -> Result<ChunkAddress, Error> {
self.create_new_blob(data, true).await
}
pub async fn store_private_blob(&self, data: &[u8]) -> Result<ChunkAddress, Error> {
self.create_new_blob(data, false).await
}
async fn create_new_blob(&self, data: &[u8], public: bool) -> Result<ChunkAddress, Error> {
let data_map = self.write_to_network(data, public).await?;
let chunk_content = serialize(&DataMapLevel::Root(data_map))?;
let chunk = self.pack(chunk_content, public).await?;
let blob_head = *chunk.address();
self.store_chunk_on_network(chunk).await?;
Ok(blob_head)
}
pub(crate) async fn fetch_blob_from_network(
&self,
head_address: ChunkAddress,
) -> Result<Chunk, Error> {
let res = self
.send_query(Query::Data(DataQuery::Blob(ChunkRead::Get(head_address))))
.await?;
let msg_id = res.msg_id;
let chunk: Chunk = match res.response {
QueryResponse::GetChunk(result) => result.map_err(|err| Error::from((err, msg_id))),
_ => return Err(Error::ReceivedUnexpectedEvent),
}?;
Ok(chunk)
}
pub(crate) async fn delete_chunk_from_network(
&self,
address: ChunkAddress,
) -> Result<(), Error> {
let cmd = DataCmd::Blob(ChunkWrite::DeletePrivate(address));
self.pay_and_send_data_command(cmd).await?;
Ok(())
}
pub(crate) async fn store_chunk_on_network(&self, chunk: Chunk) -> Result<(), Error> {
if !chunk.validate_size() {
return Err(Error::NetworkDataError(crate::types::Error::ExceededSize));
}
let cmd = DataCmd::Blob(ChunkWrite::New(chunk));
self.pay_and_send_data_command(cmd).await?;
Ok(())
}
pub async fn delete_blob(&self, head_chunk: ChunkAddress) -> Result<(), Error> {
info!("Deleting blob at given address: {:?}", head_chunk);
let mut chunk = self.fetch_blob_from_network(head_chunk).await?;
self.delete_chunk_from_network(head_chunk).await?;
loop {
match deserialize(chunk.value())? {
DataMapLevel::Root(data_map) => {
self.delete_using_data_map(data_map).await?;
return Ok(());
}
DataMapLevel::Child(data_map) => {
let serialized_chunk = self
.read_using_data_map(data_map.clone(), false, None, None)
.await?;
self.delete_using_data_map(data_map).await?;
chunk = deserialize(&serialized_chunk)?;
}
}
}
}
pub async fn blob_data_map(
mut data: Vec<u8>,
privately_owned: Option<PublicKey>,
) -> Result<(DataMap, ChunkAddress), Error> {
let mut is_original_data = true;
let (data_map, head_chunk) = loop {
let blob_storage = BlobStorageDryRun::new(privately_owned);
let self_encryptor =
SelfEncryptor::new(blob_storage, DataMap::None).map_err(Error::SelfEncryption)?;
self_encryptor
.write(&data, 0)
.await
.map_err(Error::SelfEncryption)?;
let (data_map, _) = self_encryptor
.close()
.await
.map_err(Error::SelfEncryption)?;
let chunk_content = if is_original_data {
is_original_data = false;
serialize(&DataMapLevel::Root(data_map.clone()))?
} else {
serialize(&DataMapLevel::Child(data_map.clone()))?
};
let chunk: Chunk = if let Some(owner) = privately_owned {
PrivateChunk::new(chunk_content, owner).into()
} else {
PublicChunk::new(chunk_content).into()
};
if chunk.validate_size() {
break (data_map, chunk);
} else {
data = serialize(&chunk)?;
}
};
Ok((data_map, *head_chunk.address()))
}
async fn write_to_network(&self, data: &[u8], public: bool) -> Result<DataMap, Error> {
let blob_storage = BlobStorage::new(self.clone(), public);
let self_encryptor = SelfEncryptor::new(blob_storage.clone(), DataMap::None)
.map_err(Error::SelfEncryption)?;
self_encryptor
.write(data, 0)
.await
.map_err(Error::SelfEncryption)?;
let (data_map, _) = self_encryptor
.close()
.await
.map_err(Error::SelfEncryption)?;
Ok(data_map)
}
async fn read_using_data_map(
&self,
data_map: DataMap,
public: bool,
position: Option<usize>,
len: Option<usize>,
) -> Result<Vec<u8>, Error> {
let blob_storage = BlobStorage::new(self.clone(), public);
let self_encryptor =
SelfEncryptor::new(blob_storage, data_map).map_err(Error::SelfEncryption)?;
let length = match len {
None => self_encryptor.len().await,
Some(request_length) => request_length,
};
let read_position = position.unwrap_or(0);
match self_encryptor.read(read_position, length).await {
Ok(data) => Ok(data),
Err(error) => Err(Error::SelfEncryption(error)),
}
}
async fn delete_using_data_map(&self, data_map: DataMap) -> Result<(), Error> {
let blob_storage = BlobStorage::new(self.clone(), false);
let self_encryptor =
SelfEncryptor::new(blob_storage, data_map).map_err(Error::SelfEncryption)?;
match self_encryptor.delete().await {
Ok(_) => Ok(()),
Err(error) => Err(Error::SelfEncryption(error)),
}
}
async fn pack(&self, mut contents: Vec<u8>, public: bool) -> Result<Chunk, Error> {
loop {
let chunk: Chunk = if public {
PublicChunk::new(contents).into()
} else {
PrivateChunk::new(contents, self.public_key()).into()
};
if chunk.validate_size() {
return Ok(chunk);
} else {
let serialized_chunk = serialize(&chunk)?;
let data_map = self.write_to_network(&serialized_chunk, public).await?;
contents = serialize(&DataMapLevel::Child(data_map))?;
}
}
}
async fn unpack(&self, mut chunk: Chunk) -> Result<DataMap, Error> {
loop {
let public = chunk.is_public();
match deserialize(chunk.value())? {
DataMapLevel::Root(data_map) => {
return Ok(data_map);
}
DataMapLevel::Child(data_map) => {
let serialized_chunk = self
.read_using_data_map(data_map, public, None, None)
.await?;
chunk = deserialize(&serialized_chunk)?;
}
}
}
}
}
#[cfg(test)]
mod tests {
use super::{Chunk, ChunkAddress, Client, DataMap, DataMapLevel, Error};
use crate::client::client_api::blob_storage::BlobStorage;
use crate::client::utils::{generate_random_vector, test_utils::create_test_client};
use crate::messaging::client::Error as ErrorMessage;
use crate::types::{PrivateChunk, PublicChunk, Token};
use crate::{retry_err_loop, retry_loop};
use anyhow::{anyhow, bail, Result};
use bincode::deserialize;
use self_encryption::Storage;
use std::str::FromStr;
#[tokio::test]
pub async fn public_blob_test() -> Result<()> {
let client = create_test_client().await?;
let value = generate_random_vector::<u8>(10);
let (_, expected_address) = Client::blob_data_map(value.clone(), None).await?;
match client.read_blob(expected_address, None, None).await {
Ok(data) => bail!("public chunk should not exist yet: {:?}", data),
Err(Error::ErrorMessage {
source: ErrorMessage::DataNotFound(_),
..
}) => (),
Err(e) => bail!("Unexpected: {:?}", e),
}
let public_address = client.store_public_blob(&value).await?;
assert_eq!(expected_address, public_address);
let fetched_data = retry_loop!(client.read_blob(public_address, None, None));
assert_eq!(value, fetched_data);
let addr = client.store_public_blob(&value).await?;
assert_eq!(addr, public_address);
Ok(())
}
#[tokio::test]
pub async fn private_blob_test() -> Result<()> {
let client = create_test_client().await?;
let value = generate_random_vector::<u8>(10);
let owner = client.public_key();
let (_, expected_address) = Client::blob_data_map(value.clone(), Some(owner)).await?;
match client.read_blob(expected_address, None, None).await {
Ok(_) => bail!("private chunk should not exist yet"),
Err(Error::ErrorMessage {
source: ErrorMessage::DataNotFound(_),
..
}) => (),
Err(e) => bail!("Expecting DataNotFound error, got: {:?}", e),
}
let priv_address = client.store_private_blob(&value).await?;
assert_eq!(expected_address, priv_address);
let fetched_data = retry_loop!(client.read_blob(priv_address, None, None));
assert_eq!(value, fetched_data);
let addr = client.store_private_blob(&value).await?;
assert_eq!(addr, priv_address);
let public_address = client.store_public_blob(&value).await?;
let fetched_data = retry_loop!(client.read_blob(public_address, None, None));
assert_eq!(value, fetched_data);
client.delete_blob(priv_address).await?;
let mut attempts = 10u8;
while client.read_blob(priv_address, None, None).await.is_ok() {
tokio::time::sleep(tokio::time::Duration::from_millis(4000)).await;
if attempts == 0 {
bail!("The private chunk was not deleted: {:?}", priv_address);
} else {
attempts -= 1;
}
}
let new_addr = client.store_private_blob(&value).await?;
assert_eq!(new_addr, priv_address);
let fetched_data = retry_loop!(client.read_blob(priv_address, None, None));
assert_eq!(value, fetched_data);
Ok(())
}
#[tokio::test]
pub async fn private_delete_large() -> Result<()> {
let client = create_test_client().await?;
let value = generate_random_vector::<u8>(1024 * 1024);
let address = client.store_private_blob(&value).await?;
let _ = retry_loop!(client.read_blob(address, None, None));
let fetched_data = retry_loop!(client.fetch_blob_from_network(address));
let root_data_map = match deserialize(fetched_data.value())? {
DataMapLevel::Root(data_map) => data_map,
DataMapLevel::Child(data_map) => bail!(
"A DataMapLevel::Child data-map was unexpectedly returned: {:?}",
data_map
),
};
client.delete_blob(address).await?;
let mut blob_storage = BlobStorage::new(client, false);
if let DataMap::Chunks(chunks) = root_data_map {
for chunk in chunks {
let _ = retry_err_loop!(blob_storage.get(&chunk.hash));
}
Ok(())
} else {
Err(anyhow!(
"It didn't return DataMap::Chunks, instead: {:?}",
root_data_map
))
}
}
#[tokio::test]
pub async fn blob_deletions_should_cost_put_price() -> Result<()> {
let client = create_test_client().await?;
let address = client
.store_private_blob(&generate_random_vector::<u8>(10))
.await?;
let _ = retry_loop!(client.read_blob(address, None, None));
let balance_before_delete = client.get_balance().await?;
client.delete_blob(address).await?;
let new_balance = client.get_balance().await?;
assert_ne!(balance_before_delete, Token::from_str("0")?);
assert_ne!(balance_before_delete, new_balance);
Ok(())
}
#[tokio::test]
pub async fn create_and_retrieve_1kb_pub_unencrypted() -> Result<()> {
let size = 1024;
gen_data_then_create_and_retrieve(size, true).await?;
Ok(())
}
#[tokio::test]
pub async fn create_and_retrieve_1kb_private_unencrypted() -> Result<()> {
let size = 1024;
gen_data_then_create_and_retrieve(size, false).await?;
Ok(())
}
#[tokio::test]
pub async fn create_and_retrieve_1kb_put_pub_retrieve_private() -> Result<()> {
let size = 1024;
let data = generate_random_vector(size);
let client = create_test_client().await?;
let address = client.store_public_blob(&data).await?;
let _ = retry_loop!(client.read_blob(address, None, None));
let res = client
.read_blob(ChunkAddress::Private(*address.name()), None, None)
.await;
assert!(res.is_err());
Ok(())
}
#[tokio::test]
pub async fn create_and_retrieve_1kb_put_private_retrieve_pub() -> Result<()> {
let size = 1024;
let value = generate_random_vector(size);
let client = create_test_client().await?;
let address = client.store_private_blob(&value).await?;
let _ = retry_loop!(client.read_blob(address, None, None));
let res = client
.read_blob(ChunkAddress::Public(*address.name()), None, None)
.await;
assert!(res.is_err());
Ok(())
}
#[tokio::test]
pub async fn create_and_retrieve_1mb_public() -> Result<()> {
let size = 1024 * 1024;
gen_data_then_create_and_retrieve(size, true).await?;
Ok(())
}
#[tokio::test]
pub async fn create_and_retrieve_1mb_private() -> Result<()> {
let size = 1024 * 1024;
gen_data_then_create_and_retrieve(size, false).await?;
Ok(())
}
#[tokio::test]
pub async fn create_and_retrieve_10mb_private() -> Result<()> {
let size = 1024 * 1024 * 10;
gen_data_then_create_and_retrieve(size, false).await?;
Ok(())
}
#[tokio::test]
pub async fn create_and_retrieve_10mb_public() -> Result<()> {
let size = 1024 * 1024 * 10;
gen_data_then_create_and_retrieve(size, true).await?;
Ok(())
}
#[tokio::test]
#[ignore = "too heavy for CI"]
pub async fn create_and_retrieve_100mb_public() -> Result<()> {
let size = 1024 * 1024 * 100;
gen_data_then_create_and_retrieve(size, true).await?;
Ok(())
}
#[tokio::test]
pub async fn create_and_retrieve_index_based() -> Result<()> {
create_and_index_based_retrieve(1024).await
}
async fn create_and_index_based_retrieve(size: usize) -> Result<()> {
let data = generate_random_vector(size);
let client = create_test_client().await?;
let address = client.store_public_blob(&data).await?;
let fetched_data = retry_loop!(client.read_blob(address, None, Some(size / 2)));
assert_eq!(fetched_data, data[0..size / 2].to_vec());
let data = generate_random_vector(size);
let client = create_test_client().await?;
let address = client.store_public_blob(&data).await?;
let fetched_data = retry_loop!(client.read_blob(address, Some(size / 2), Some(size / 2)));
assert_eq!(fetched_data, data[size / 2..size].to_vec());
Ok(())
}
#[allow(clippy::match_wild_err_arm)]
async fn gen_data_then_create_and_retrieve(size: usize, public: bool) -> Result<()> {
let raw_data = generate_random_vector(size);
let client = create_test_client().await?;
let chunk = if public {
Chunk::Public(PublicChunk::new(raw_data.clone()))
} else {
Chunk::Private(PrivateChunk::new(raw_data.clone(), client.public_key()))
};
let address_before = chunk.address();
let res = client.read_blob(*address_before, None, None).await;
match res {
Err(Error::ErrorMessage {
source: ErrorMessage::DataNotFound(_),
..
}) => (),
Ok(_) => bail!("Blob unexpectedly retrieved using address generated by gen_data_map"),
Err(_) => bail!(
"Unexpected error when Blob retrieved using address generated by gen_data_map"
),
};
let address = if public {
client.store_public_blob(&raw_data).await?
} else {
client.store_private_blob(&raw_data).await?
};
let fetched_data = retry_loop!(client.read_blob(address, None, None));
assert_eq!(fetched_data, raw_data);
let privately_owned = if public {
None
} else {
Some(client.public_key())
};
let (_, head_chunk_address) = Client::blob_data_map(raw_data, privately_owned).await?;
assert_eq!(head_chunk_address, address);
Ok(())
}
}