sia_storage 0.11.0

SDK for interacting with a Sia network indexer
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
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
752
753
754
755
756
use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use sia_core::rhp4::SECTOR_SIZE;

use crate::AppKey;
use crate::encryption::EncryptionKey;
use serde_with::base64::Base64;
use serde_with::{DefaultOnNull, serde_as};
use sia_core::blake2::{Blake2b256, Digest};
use sia_core::encoding::{self, SiaDecodable, SiaDecode, SiaEncodable, SiaEncode};
use sia_core::signing::{PublicKey, Signature};
use sia_core::types::Hash256;
use thiserror::Error;

use crate::object_encryption::{
    DecryptError, open_data_key, open_metadata, open_metadata_key, seal_data_key, seal_metadata,
    seal_metadata_key,
};

#[derive(Debug, Clone, PartialEq, Deserialize, Serialize, SiaEncode, SiaDecode)]
#[serde(rename_all = "camelCase")]
/// A Sector is a unit of data stored on the Sia network. It can be referenced by its Merkle root.
pub struct Sector {
    /// The Merkle root of the sector data.
    pub root: Hash256,
    /// The public key of the host storing this sector.
    pub host_key: PublicKey,
}

/// The version of the slab
#[repr(u8)]
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(try_from = "u8", into = "u8")]
pub enum SlabVersion {
    #[default]
    V0 = 0,
    /// V1 changes how the object data key works. When encrypting, the slab key is used as a nonce on the data key so that
    /// we can overwrite slab data without re-encrypting the whole object and without
    /// reusing the encryption key.
    V1 = 1,
}

impl From<SlabVersion> for u8 {
    fn from(value: SlabVersion) -> Self {
        value as u8
    }
}

impl SiaEncodable for SlabVersion {
    fn encode<W: std::io::prelude::Write>(&self, w: &mut W) -> encoding::Result<()> {
        w.write_all(&[*self as u8])?;
        Ok(())
    }

    fn encoded_length(&self) -> usize {
        1
    }
}

impl SiaDecodable for SlabVersion {
    fn decode<R: std::io::prelude::Read>(r: &mut R) -> encoding::Result<Self> {
        Self::try_from(u8::decode(r)?).map_err(encoding::Error::InvalidValue)
    }
}

impl TryFrom<u8> for SlabVersion {
    type Error = String;

    fn try_from(value: u8) -> std::result::Result<Self, Self::Error> {
        match value {
            0 => Ok(Self::V0),
            1 => Ok(Self::V1),
            _ => Err(format!("unsupported version {value}")),
        }
    }
}

/// A Slab is an erasure-coded collection of sectors. The sectors can be downloaded and
/// used to recover the original data.
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Slab {
    /// The encoding version of this slab.
    #[serde(default)]
    pub version: SlabVersion,
    /// The encryption key used to encrypt and decrypt this slab's data.
    pub encryption_key: EncryptionKey,
    /// The minimum number of sectors required to recover the slab's data.
    pub min_shards: u8,
    /// The sectors that make up this slab, spread across different hosts.
    pub sectors: Vec<Sector>,
    /// The byte offset of this slab's data within the parent object.
    pub offset: u32,
    /// The byte length of this slab's data.
    pub length: u32,
}

impl Slab {
    /// creates a unique identifier for the resulting slab to be referenced by hashing
    /// its contents, excluding the host key, length, and offset.
    pub fn digest(&self) -> Hash256 {
        let mut state = Blake2b256::new();
        if self.version != SlabVersion::V0 {
            // V0 doesn't have a version field and the existing IDs can't change for backwards compatibility
            self.version.encode(&mut state).unwrap();
        }
        (self.min_shards as u64).encode(&mut state).unwrap();
        self.encryption_key.encode(&mut state).unwrap();
        self.sectors.iter().for_each(|sector| {
            sector.root.encode(&mut state).unwrap();
        });
        state.finalize().into()
    }
}

impl SiaEncodable for Slab {
    fn encoded_length(&self) -> usize {
        self.version.encoded_length()
            + self.encryption_key.encoded_length()
            + self.min_shards.encoded_length()
            + self.sectors.encoded_length()
            + 8 // combined offset|length u64
    }

    fn encode<W: std::io::Write>(&self, w: &mut W) -> encoding::Result<()> {
        self.version.encode(w)?;
        self.encryption_key.encode(w)?;
        self.min_shards.encode(w)?;
        self.sectors.encode(w)?;
        let combined: u64 = (self.offset as u64) << 32 | (self.length as u64);
        combined.encode(w)?;
        Ok(())
    }
}

impl SiaDecodable for Slab {
    fn decode<R: std::io::Read>(r: &mut R) -> encoding::Result<Self> {
        let version = SlabVersion::decode(r)?;
        let encryption_key = EncryptionKey::decode(r)?;
        let min_shards = u8::decode(r)?;
        let sectors = Vec::<Sector>::decode(r)?;
        let combined = u64::decode(r)?;

        Ok(Self {
            version,
            encryption_key,
            min_shards,
            sectors,
            offset: (combined >> 32) as u32,
            length: combined as u32,
        })
    }
}

#[derive(Debug, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
/// A slab that has been pinned to the indexer.
pub struct PinnedSlab {
    /// The encoding version of this slab.
    #[serde(default)]
    pub version: SlabVersion,
    /// The unique identifier of the slab.
    pub id: Hash256,
    /// The encryption key used to encrypt and decrypt this slab's data.
    pub encryption_key: EncryptionKey,
    /// The minimum number of sectors required to recover the slab's data.
    pub min_shards: u8,
    /// The sectors that make up this slab.
    pub sectors: Vec<Sector>,
}

/// Errors that can occur when opening or verifying a sealed object.
#[derive(Debug, Error)]
pub enum SealedObjectError {
    /// The encrypted data could not be decrypted.
    #[error("decryption error: {0}")]
    Decryption(#[from] DecryptError),
    /// The sealed object's ID does not match its contents.
    #[error("sealed object ID does not match contents")]
    ContentsMismatch,
    /// An error occurred during encoding or decoding.
    #[error("encoding error: {0}")]
    Encoding(#[from] encoding::Error),
    /// The signature on the sealed object is invalid.
    #[error("invalid signature")]
    InvalidSignature,
}

#[serde_as]
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
/// An encrypted, signed representation of an [Object] that can be stored on the indexer.
///
/// A sealed object can be opened with [SealedObject::open] using the same [AppKey] that sealed it.
pub struct SealedObject {
    /// The encrypted data encryption key.
    #[serde_as(as = "Base64")]
    pub encrypted_data_key: Vec<u8>,
    /// The erasure-coded slabs that make up the object's data.
    pub slabs: Vec<Slab>,
    /// A signature over the data key and slabs.
    pub data_signature: Signature,

    /// The encrypted metadata encryption key.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    #[serde_as(as = "DefaultOnNull<Base64>")]
    pub encrypted_metadata_key: Vec<u8>,
    /// The encrypted metadata.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    #[serde_as(as = "DefaultOnNull<Base64>")]
    pub encrypted_metadata: Vec<u8>,
    /// A signature over the metadata key and metadata.
    pub metadata_signature: Signature,

    /// The time the object was created.
    pub created_at: DateTime<Utc>,
    /// The time the object was last updated.
    pub updated_at: DateTime<Utc>,
}

impl SiaDecodable for SealedObject {
    fn decode<R: std::io::Read>(r: &mut R) -> encoding::Result<Self> {
        let encrypted_data_key = Vec::<u8>::decode(r)?;
        let slabs = Vec::<Slab>::decode(r)?;
        let data_signature = Signature::decode(r)?;
        let encrypted_metadata_key = Vec::<u8>::decode(r)?;
        let encrypted_metadata = Vec::<u8>::decode(r)?;
        let metadata_signature = Signature::decode(r)?;
        let created_at = DateTime::<Utc>::decode(r)?;
        let updated_at = DateTime::<Utc>::decode(r)?;

        Ok(Self {
            encrypted_data_key,
            slabs,
            data_signature,
            encrypted_metadata_key,
            encrypted_metadata,
            metadata_signature,
            created_at,
            updated_at,
        })
    }
}

impl SealedObject {
    fn data_sig_hash(object_id: &Hash256, encrypted_data_key: &[u8]) -> Hash256 {
        let mut state = Blake2b256::default();
        object_id.encode(&mut state).unwrap();
        state.update(encrypted_data_key);
        state.finalize().into()
    }

    fn meta_sig_hash(
        object_id: &Hash256,
        encrypted_meta_key: &[u8],
        encrypted_metadata: &[u8],
    ) -> Hash256 {
        let mut state = Blake2b256::default();
        object_id.encode(&mut state).unwrap();
        state.update(encrypted_meta_key);
        state.update(encrypted_metadata);
        state.finalize().into()
    }

    fn verify_signatures(
        &self,
        app_key: &PublicKey,
        object_id: &Hash256,
    ) -> Result<(), SealedObjectError> {
        let data_sig_hash = Self::data_sig_hash(object_id, &self.encrypted_data_key);
        let meta_sig_hash = Self::meta_sig_hash(
            object_id,
            &self.encrypted_metadata_key,
            &self.encrypted_metadata,
        );

        if !app_key.verify(data_sig_hash.as_ref(), &self.data_signature) {
            return Err(SealedObjectError::InvalidSignature);
        }

        if !app_key.verify(meta_sig_hash.as_ref(), &self.metadata_signature) {
            return Err(SealedObjectError::InvalidSignature);
        }

        Ok(())
    }

    /// Returns the unique identifier of the sealed object.
    pub fn id(&self) -> Hash256 {
        object_id(&self.slabs)
    }

    /// Decrypts and verifies the sealed object, returning the underlying [Object].
    pub fn open(self, app_key: &AppKey) -> Result<Object, SealedObjectError> {
        // verify signatures first
        let object_id = self.id();
        self.verify_signatures(&app_key.public_key(), &object_id)?;

        // decrypt data key and metadata
        let data_key = open_data_key(&app_key.0, &object_id, &self.encrypted_data_key)?;
        let metadata = if !self.encrypted_metadata.is_empty() {
            let metadata_key =
                open_metadata_key(&app_key.0, &object_id, &self.encrypted_metadata_key)?;
            open_metadata(&metadata_key, &self.encrypted_metadata)?
        } else {
            Vec::new()
        };

        Ok(Object {
            data_key,
            slabs: self.slabs,
            metadata,
            created_at: self.created_at,
            updated_at: self.updated_at,
        })
    }
}

/// An ObjectEvent represents an object and whether it was deleted or not.
#[derive(Debug, Clone, PartialEq)]
pub struct ObjectEvent {
    /// The unique identifier of the object.
    pub id: Hash256,
    /// Whether the object was deleted.
    pub deleted: bool,
    /// The time the event occurred.
    pub updated_at: DateTime<Utc>,
    /// The object, if it was not deleted.
    pub object: Option<Object>,
}

/// A file stored on the Sia network, consisting of erasure-coded slabs and
/// optional metadata.
///
/// Objects can be sealed with [Object::seal] for storage on the indexer.
#[derive(Debug, Clone, PartialEq)]
pub struct Object {
    pub(crate) data_key: EncryptionKey,
    pub(crate) slabs: Vec<Slab>,
    /// Application-defined metadata stored alongside the object. Encrypted when sealed.
    pub metadata: Vec<u8>,
    /// The creation timestamp of the object. Overwritten by the indexer.
    pub created_at: DateTime<Utc>,
    /// The last updated timestamp of the object. Overwritten by the indexer.
    pub updated_at: DateTime<Utc>,
}

impl Object {
    /// Creates a new empty object with a unique data key and optional
    /// application-defined metadata.
    ///
    /// Objects can be passed to [Sdk::upload](crate::Sdk::upload) to add data
    /// to them and [Sdk::download](crate::Sdk::download) to retrieve the data
    /// from the network.
    ///
    /// After uploading, objects should be pinned with
    /// [Sdk::pin_object](crate::Sdk::pin_object) so the object is tracked and
    /// remains available.
    pub fn new(metadata: Option<Vec<u8>>) -> Self {
        Object {
            data_key: EncryptionKey::from(rand::random::<[u8; 32]>()),
            slabs: Vec::new(),
            metadata: metadata.unwrap_or_default(),
            created_at: Utc::now(),
            updated_at: Utc::now(),
        }
    }

    /// Creates an [Object] directly from an existing data key and slabs,
    /// bypassing the SDK's upload pipeline. Prefer [Object::new] or [Object::default].
    ///
    /// This is useful for interoperability with systems such as IPFS or LBRY,
    /// where an object's components are persisted separately and the object
    /// must be reconstructed from them.
    ///
    /// Objects produced by
    /// [Sdk::upload](crate::Sdk::upload) are guaranteed to be safe to
    /// reconstruct. Others, not so much. Here be dragons.
    ///
    /// **Invariants:**
    /// - The data key must be the one that encrypted the slabs. A mismatched
    ///   key fails silently: downloads succeed but return garbage.
    /// - Slab keys must never be reused. Reuse compromises encryption.
    /// - Each slab's `version` must match the version it was encrypted with.
    ///   A mislabeled slab decrypts to garbage without error.
    /// - Each slab's `offset` and `length` must match how the data was
    ///   encrypted: `offset` seeks the keystream, and slab order defines the
    ///   object's byte stream. Wrong values silently corrupt or reorder the
    ///   data.
    #[cfg(feature = "less-safe-crypto")]
    pub fn less_safe_new(
        data_key: EncryptionKey,
        slabs: Vec<Slab>,
        metadata: Option<Vec<u8>>,
    ) -> Self {
        Object {
            data_key,
            slabs,
            metadata: metadata.unwrap_or_default(),
            created_at: Utc::now(),
            updated_at: Utc::now(),
        }
    }

    /// Returns the unique identifier of the object.
    pub fn id(&self) -> Hash256 {
        object_id(&self.slabs)
    }

    /// Returns the data key so it can be exported and later re-imported
    /// with [Object::less_safe_new].
    ///
    /// The data key alone decrypts the object's data. Never store it in
    /// plaintext and do not reuse it for new objects.
    ///
    /// Prefer sealing the object with [Object::seal] instead.
    #[cfg(feature = "less-safe-crypto")]
    pub fn data_key(&self) -> &EncryptionKey {
        &self.data_key
    }

    /// Returns the slabs that make up the object.
    pub fn slabs(&self) -> &[Slab] {
        &self.slabs
    }

    /// Returns the total size of the object by summing the lengths of its slabs.
    pub fn size(&self) -> u64 {
        self.slabs.iter().fold(0_u64, |v, s| v + s.length as u64)
    }

    /// Returns the total encoded size of the object after erasure coding
    /// by summing the sizes of its slabs.
    pub fn encoded_size(&self) -> u64 {
        self.slabs.iter().fold(0_u64, |v, s| {
            v + (s.sectors.len() as u64 * SECTOR_SIZE as u64)
        })
    }

    /// Encrypts and signs the object, producing a [SealedObject] that can be pinned to the indexer.
    pub fn seal(&self, app_key: &AppKey) -> SealedObject {
        let object_id = self.id();

        // encrypt data key and create data signature
        let encrypted_data_key = seal_data_key(&app_key.0, &object_id, &self.data_key);
        let data_signature = {
            let sig_hash = SealedObject::data_sig_hash(&object_id, &encrypted_data_key);
            app_key.sign(sig_hash.as_ref())
        };

        // encrypt metadata key and metadata, if present, and create metadata signature
        let (encrypted_metadata_key, encrypted_metadata) = if !self.metadata.is_empty() {
            let metadata_key = EncryptionKey::from(rand::random::<[u8; 32]>());
            let encrypted_metadata_key = seal_metadata_key(&app_key.0, &object_id, &metadata_key);
            let encrypted_metadata = seal_metadata(&metadata_key, &self.metadata);
            (encrypted_metadata_key, encrypted_metadata)
        } else {
            (Vec::new(), Vec::new())
        };

        let metadata_signature = {
            let sig_hash = SealedObject::meta_sig_hash(
                &object_id,
                &encrypted_metadata_key,
                &encrypted_metadata,
            );
            app_key.sign(sig_hash.as_ref())
        };

        SealedObject {
            encrypted_data_key,
            encrypted_metadata_key,
            slabs: self.slabs.clone(),
            encrypted_metadata,
            data_signature,
            metadata_signature,

            created_at: self.created_at,
            updated_at: self.updated_at,
        }
    }
}

impl Default for Object {
    fn default() -> Self {
        Self::new(None)
    }
}

pub(crate) fn object_id(slabs: &[Slab]) -> Hash256 {
    let mut state = Blake2b256::default();
    for slab in slabs.iter() {
        let slab_id = slab.digest();
        slab_id
            .encode(&mut state)
            .expect("hashing slab_id shouldn't fail");
        ((slab.offset as u64) << 32 | slab.length as u64)
            .encode(&mut state)
            .expect("hashing slab offset/length shouldn't fail");
    }
    state.finalize().into()
}

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

    fn random_bytes_32() -> [u8; 32] {
        let mut buf = [0u8; 32];
        getrandom::fill(&mut buf).unwrap();
        buf
    }

    #[sia_core_derive::cross_target_test]
    fn test_slab_version_serde_numeric() {
        let slab = Slab {
            version: SlabVersion::V1,
            encryption_key: [1u8; 32].into(),
            min_shards: 1,
            sectors: vec![],
            offset: 0,
            length: 0,
        };

        let mut value = serde_json::to_value(&slab).unwrap();
        assert_eq!(value["version"], serde_json::json!(1));
        assert_eq!(
            serde_json::from_value::<Slab>(value.clone())
                .unwrap()
                .version,
            SlabVersion::V1
        );

        // legacy data without a version field decodes as V0
        value.as_object_mut().unwrap().remove("version");
        assert_eq!(
            serde_json::from_value::<Slab>(value).unwrap().version,
            SlabVersion::V0
        );
    }

    #[sia_core_derive::cross_target_test]
    fn test_object_id() {
        let slabs = vec![Slab {
            version: SlabVersion::V0,
            encryption_key: [0u8; 32].into(),
            min_shards: 1,
            sectors: vec![Sector {
                root: Hash256::new([1u8; 32]),
                host_key: PublicKey::new([2u8; 32]),
            }],
            offset: 10,
            length: 100,
        }];

        let id = object_id(&slabs);
        assert_eq!(
            id.to_string(),
            "1b13d5dd22605af0573cae7fe9242c1ee83727c29798308b2b170864677b46d0"
        );
    }

    /// Tests ObjectID of a SealedObject
    /// Port of objects_test.go:TestObjectID
    #[sia_core_derive::cross_target_test]
    fn test_sealed_object_id_golden() {
        let mut encryption_key = [0u8; 32];
        encryption_key[..3].copy_from_slice(&[4, 5, 6]);
        let mut sector_root = [0u8; 32];
        sector_root[..3].copy_from_slice(&[7, 8, 9]);
        let mut public_key = [0u8; 32];
        public_key[..3].copy_from_slice(&[10, 11, 12]);
        let mut data_signature = [0u8; 64];
        data_signature[..3].copy_from_slice(&[22, 23, 24]);
        let mut metadata_signature = [0u8; 64];
        metadata_signature[..3].copy_from_slice(&[24, 23, 22]);

        let sealed = SealedObject {
            encrypted_data_key: vec![1, 2, 3],
            encrypted_metadata_key: vec![3, 2, 1],
            slabs: vec![Slab {
                version: SlabVersion::V0,
                encryption_key: encryption_key.into(),
                min_shards: 1,
                sectors: vec![Sector {
                    root: sector_root.into(),
                    host_key: PublicKey::new(public_key),
                }],
                offset: 131415,
                length: 161718,
            }],
            encrypted_metadata: vec![19, 20, 21],
            data_signature: Signature::new(data_signature),
            metadata_signature: Signature::new(metadata_signature),
            created_at: DateTime::from_timestamp(25, 26).unwrap(),
            updated_at: DateTime::from_timestamp(27, 28).unwrap(),
        };

        assert_eq!(
            hash_256!("92b456fd0320c6595cf40280fafde2e3c549e09f6e7168ebdd963500830f50b5"),
            sealed.id()
        )
    }

    /// tests Slab.digest against a reference digest
    #[sia_core_derive::cross_target_test]
    fn test_slab_digest() {
        let s = Slab {
            version: SlabVersion::V0,
            min_shards: 1,
            encryption_key: [
                152, 138, 169, 77, 22, 195, 154, 192, 91, 139, 241, 61, 75, 225, 38, 124, 225, 31,
                187, 165, 80, 215, 75, 121, 115, 204, 235, 9, 90, 248, 68, 92,
            ]
            .into(),
            sectors: vec![
                Sector {
                    root: hash_256!(
                        "fb0a42cce246d6bb9716eb0e97579a1d0d5c2bb34d7234e9ae271d4fd8201b24"
                    ),
                    host_key: PublicKey::new(random_bytes_32()), // host key is not included in the digest
                },
                Sector {
                    root: hash_256!(
                        "8125994daee38e1fbaf7a26c7935420ce055202f7175eae98d291ebe80f2b00e"
                    ),
                    host_key: PublicKey::new(random_bytes_32()), // host key is not included in the digest
                },
                Sector {
                    root: hash_256!(
                        "54ee41b57b9439868b119b8fe1c6c602bd6b35e27d31400c5bb85912b60c9f0a"
                    ),
                    host_key: PublicKey::new(random_bytes_32()), // host key is not included in the digest
                },
            ],
            // length and offset are not included in the digest
            length: 100,
            offset: 100,
        };

        assert_eq!(
            s.digest().to_string(),
            "d1aea84f8682d7ae17b6c1f14dc344eb70b9328ee913a76fc241559657b06284"
        )
    }

    #[sia_core_derive::cross_target_test]
    fn test_object_roundtrip() {
        let slabs = vec![
            Slab {
                version: SlabVersion::V0,
                encryption_key: random_bytes_32().into(),
                min_shards: 2,
                sectors: vec![],
                offset: 0,
                length: 100,
            },
            Slab {
                version: SlabVersion::V0,
                encryption_key: random_bytes_32().into(),
                min_shards: 2,
                sectors: vec![],
                offset: 0,
                length: 100,
            },
        ];
        let meta = b"hello, world!".to_vec();
        let obj = Object {
            slabs: slabs.clone(),
            metadata: meta.clone(),
            ..Default::default()
        };

        let seed: [u8; 32] = random_bytes_32();
        let private_key = AppKey::import(seed);

        let sealed = obj.seal(&private_key);
        let opened = sealed.open(&private_key).expect("should open");

        assert_eq!(opened.slabs, slabs);
        assert_eq!(opened.metadata, meta);
    }

    #[cfg(feature = "less-safe-crypto")]
    #[sia_core_derive::cross_target_test]
    fn test_less_safe_new_roundtrip() {
        let data_key = EncryptionKey::from(random_bytes_32());
        let slabs = vec![Slab {
            version: SlabVersion::V1,
            encryption_key: random_bytes_32().into(),
            min_shards: 10,
            sectors: (0..30)
                .map(|_| Sector {
                    root: random_bytes_32().into(),
                    host_key: PublicKey::new(random_bytes_32()),
                })
                .collect(),
            offset: 0,
            length: 100,
        }];
        let meta = b"hello, world!".to_vec();

        let reconstructed =
            Object::less_safe_new(data_key.clone(), slabs.clone(), Some(meta.clone()));
        let original = Object {
            data_key,
            slabs,
            metadata: meta,
            created_at: reconstructed.created_at,
            updated_at: reconstructed.updated_at,
        };
        assert_eq!(original, reconstructed);
        assert_eq!(original.id(), reconstructed.id());

        let app_key = AppKey::import(random_bytes_32());
        let opened_original = original.seal(&app_key).open(&app_key).expect("should open");
        let opened_reconstructed = reconstructed
            .seal(&app_key)
            .open(&app_key)
            .expect("should open");
        assert_eq!(opened_original, original);
        assert_eq!(opened_original, opened_reconstructed);
    }

    /// tests that the SealedObject struct is compatible with the Go implementation
    /// by deserializing a reference object
    #[sia_core_derive::cross_target_test]
    fn test_sealed_object_golden() {
        let mut seed = [0u8; 32];
        hex::decode_to_slice(
            "9593edfd90ef2da9973af3bca88afdf54b6e7ff66ff6c749505734b9cf6b8aec",
            &mut seed,
        )
        .expect("hex");
        let app_key = AppKey::import(seed);

        let mut expected_object_key = [0u8; 32];
        hex::decode_to_slice(
            "cd280dd064e3c2d4259579bf0deda2492962c130ee8d7d2e11f1daca3e5cc579",
            &mut expected_object_key,
        )
        .expect("hex");
        let expected_object_key = EncryptionKey::from(expected_object_key);

        let expected_metadata = hex::decode("b9d615255cc17596e3870c3adf5e11c1da0dd78e30f29c6b6d223949c7d91492db55cdc6e04ce65b5b1fea4ccc953e883d5bf23e9c893ecb5221e7315f16e7f95dfc70f0ed1ee1306e8733a22a5faf1b139f01f0f77ae00d71fe3bbefa4b65aca80f749e4788ace89beaa79ac651aedc54cba7066264df9db54c22c1e17cea1a").expect("hex");

        let sealed_data = hex::decode("480000000000000063f49bd7cf21d25565ebb26a900efabec342418989958f09b735073af7dd5076231c32524ff6208f3a85f8cc8dd4a6ac913e0df51a34ab9ee325b41fc3de93a1107becc3b527f487020000000000000000739b1966a1d8ab194c0f0ebe012b00259491c13b73e1ad67128957590714dd33000000000000000000881300000a00000000a4e3e3f002e05ff9d05a3193cc1513a66c10d82979a0a2fc9aa0aa4c7de2c64600000000000000000000100000200000005cc53fb91b99eb0d4aa422a820d2e64109a344e5234d7fb31ec62460f5dc52b6ae0b67c71093cebdb7a6cb79a65dfb6f2cb28eb3704a302a4517269fce75680c48000000000000008465df0369c7a4144257ce38bb566b47350e21ae0049b97d56348c1269c4fa5a1ea32f88c20e0ba000446f66e955c191d816bd4f3576caacbd309149343c629c0c7a7fc99201644da800000000000000f58f39972c8b1db49fef8606f20e690fb68fc9d29b5ab0da3a871ddb0cd5e66968ea0cf852a521697f422baac24c9418ca42fbc766d08fe0b55417e4d0f42831040e1c4e3dba1557ef7285649ab1c810ee1771a4c04d2bea4b2bbf592d3e3a1cee7a9217191242a6526db0c0ac09398f2090179063b0bdc2278a88540531f6ad3b5d44ecac36b1fef09205a2011ea4539a9abb914f23461a443efe47e581698416e452fa37af929a8bf8668d999920b5ec04005f2b947194b19271846b3c375e75257eebaad288bcb1eb36f6748562d97fcd0904eb491090ea8f61c0ddbc741f187af2b22151180400096e88f1ffffff00096e88f1ffffff").expect("hex");
        let sealed = SealedObject::decode(&mut &sealed_data[..]).expect("decode");
        let opened = sealed.open(&app_key).expect("open");

        assert_eq!(opened.data_key, expected_object_key);
        assert_eq!(opened.slabs.len(), 2);
        assert_eq!(opened.metadata, expected_metadata);
    }
}