derec-library 0.0.1-alpha.8

Rust SDK for the DeRec protocol, including native and WebAssembly bindings.
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
// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2026 DeRec Alliance. All rights reserved.

use crate::{
    Error,
    primitives::sharing::{
        SharingError,
        request::{
            ExtractResult as ExtractStoreShareRequestResult,
            ProduceResult as ProduceStoreShareRequestMessageResult, SplitResult,
            extract as extract_store_share_request, produce as produce_store_share_request_message,
            split,
        },
        response::{
            ExtractResult as ExtractStoreShareResponseResult,
            ProduceResult as ProduceStoreShareResponseMessageResult,
            extract as extract_store_share_response,
            process as process_store_share_response_message,
            produce as produce_store_share_response_message,
        },
    },
    types::ChannelId,
};
use derec_proto::{CommittedDeRecShare, DeRecShare};
use prost::Message;

fn make_channel_ids(ids: &[u64]) -> Vec<ChannelId> {
    ids.iter().map(|&id| ChannelId(id)).collect()
}

/// Build a valid `StoreShareRequestMessage` with a `CommittedDeRecShare`
/// that has been mutated by `mutate`. Returns the `StoreShareRequestMessage`
/// to pass directly to `produce_store_share_response_message`.
fn make_request_with_mutated_share(
    mutate: impl FnOnce(&mut CommittedDeRecShare),
) -> derec_proto::StoreShareRequestMessage {
    use crate::derec_message::current_timestamp;

    let secret_id: u64 = 1;
    let secret_data = b"test-data";
    let channels = make_channel_ids(&[1, 2, 3]);
    let version = 1;

    let SplitResult { mut shares } =
        split(&channels, secret_id, version, secret_data, 2).expect("split should succeed");

    let channel_id = ChannelId(1);
    let committed_share = shares.get_mut(&channel_id).expect("missing share");
    mutate(committed_share);

    let timestamp = current_timestamp();
    derec_proto::StoreShareRequestMessage {
        share: committed_share.encode_to_vec(),
        share_algorithm: 0,
        version,
        keep_list: vec![],
        version_description: String::new(),
        timestamp: Some(timestamp),
        secret_id,
        reply_to: None,
        replica_id: None,
    }
}

#[test]
fn test_split_empty_channels() {
    let secret_id: u64 = 1;
    let secret_data = b"secret-data";
    let threshold = 2;
    let version = 1;

    let result = split(&[], secret_id, version, secret_data, threshold);

    assert!(matches!(
        result,
        Err(Error::Sharing(SharingError::EmptyChannels))
    ));
}

#[test]
fn test_split_empty_secret_data() {
    let secret_id: u64 = 1;
    let empty_secret_data = b"";
    let channels = make_channel_ids(&[1, 2, 3]);
    let threshold = 2;
    let version = 1;

    let result = split(&channels, secret_id, version, empty_secret_data, threshold);

    assert!(matches!(
        result,
        Err(Error::Sharing(SharingError::EmptySecretData))
    ));
}

#[test]
fn test_split_invalid_threshold_too_low() {
    let secret_id: u64 = 1;
    let secret_data = b"secret-data";
    let channels = make_channel_ids(&[1, 2, 3]);
    let too_low_threshold = 1;
    let version = 1;

    let result = split(
        &channels,
        secret_id,
        version,
        secret_data,
        too_low_threshold,
    );

    assert!(matches!(
        result,
        Err(Error::Sharing(SharingError::InvalidThreshold {
            threshold: 1,
            channels: 3
        }))
    ));
}

#[test]
fn test_split_invalid_threshold_too_high() {
    let secret_id: u64 = 1;
    let secret_data = b"secret-data";
    let channels = make_channel_ids(&[1, 2, 3]);
    let too_high_threshold = 4;
    let version = 1;

    let result = split(
        &channels,
        secret_id,
        version,
        secret_data,
        too_high_threshold,
    );

    assert!(matches!(
        result,
        Err(Error::Sharing(SharingError::InvalidThreshold {
            threshold: 4,
            channels: 3
        }))
    ));
}

#[test]
fn test_split_valid_sharing() {
    let secret_id: u64 = 1;
    let secret_data = b"super_secret_value";
    let channels = make_channel_ids(&[1, 2, 3]);
    let threshold = 2;
    let version = 7;

    let SplitResult { shares } =
        split(&channels, secret_id, version, secret_data, threshold).expect("split should succeed");

    assert_eq!(
        shares.len(),
        channels.len(),
        "invalid number of shares given the number of channels"
    );

    for channel_id in &channels {
        let committed = shares
            .get(channel_id)
            .expect("missing CommittedDeRecShare for channel");

        assert!(
            !committed.commitment.is_empty(),
            "commitment must not be empty"
        );

        assert!(
            !committed.merkle_path.is_empty(),
            "merkle_path must not be empty"
        );

        let inner = DeRecShare::decode(&committed.de_rec_share[..])
            .expect("failed to decode inner DeRecShare");

        assert_eq!(inner.secret_id, secret_id);
        assert_eq!(inner.version, version);

        assert!(
            !inner.encrypted_secret.is_empty(),
            "encrypted_secret must not be empty"
        );
        assert!(!inner.x.is_empty(), "share x coordinate must not be empty");
        assert!(!inner.y.is_empty(), "share y coordinate must not be empty");
    }
}

#[test]
fn test_produce_store_share_request_message_valid() {
    let secret_id: u64 = 1;
    let secret_data = b"super_secret_value";
    let channels = make_channel_ids(&[1, 2, 3]);
    let threshold = 2;
    let version = 7;
    let shared_key = [42u8; 32];

    let SplitResult { shares } =
        split(&channels, secret_id, version, secret_data, threshold).expect("split should succeed");

    let channel_id = ChannelId(1);
    let committed_share = shares
        .get(&channel_id)
        .expect("missing share for channel 1");

    let ProduceStoreShareRequestMessageResult { envelope } = produce_store_share_request_message(
        channel_id,
        version,
        secret_id,
        committed_share,
        &[],
        "",
        &shared_key,
        None,
        None,
    )
    .expect("produce_store_share_request_message should succeed");

    assert!(
        !envelope.is_empty(),
        "envelope wire bytes must not be empty"
    );
}

#[test]
fn test_produce_store_share_request_message_with_keep_list_and_description() {
    let secret_id: u64 = 1;
    let secret_data = b"super_secret_value";
    let channels = make_channel_ids(&[1, 2, 3]);
    let threshold = 2;
    let version = 3;
    let shared_key = [7u8; 32];

    let SplitResult { shares } =
        split(&channels, secret_id, version, secret_data, threshold).expect("split should succeed");

    let channel_id = ChannelId(2);
    let committed_share = shares
        .get(&channel_id)
        .expect("missing share for channel 2");

    let ProduceStoreShareRequestMessageResult { envelope } = produce_store_share_request_message(
        channel_id,
        version,
        secret_id,
        committed_share,
        &[1, 2],
        "initial share distribution",
        &shared_key,
        None,
        None,
    )
    .expect("produce_store_share_request_message should succeed");

    assert!(
        !envelope.is_empty(),
        "envelope wire bytes must not be empty"
    );
}

#[test]
fn test_produce_store_share_response_message_valid() {
    let secret_id: u64 = 1;
    let secret_data = b"super_secret_value";
    let channels = make_channel_ids(&[1, 2, 3]);
    let threshold = 2;
    let version = 7;
    let shared_key = [42u8; 32];

    let SplitResult { shares } =
        split(&channels, secret_id, version, secret_data, threshold).expect("split should succeed");

    let channel_id = ChannelId(1);
    let committed_share = shares
        .get(&channel_id)
        .expect("missing share for channel 1");

    let ProduceStoreShareRequestMessageResult {
        envelope: request_envelope,
    } = produce_store_share_request_message(
        channel_id,
        version,
        secret_id,
        committed_share,
        &[],
        "",
        &shared_key,
        None,
        None,
    )
    .expect("produce_store_share_request_message should succeed");

    let ExtractStoreShareRequestResult { request } =
        extract_store_share_request(&request_envelope, &shared_key)
            .expect("extract_store_share_request should succeed");

    let ProduceStoreShareResponseMessageResult {
        envelope: response_envelope,
        committed_share: returned_share,
        secret_id: returned_secret_id,
        version: returned_version,
    } = produce_store_share_response_message(channel_id, &request, &shared_key)
        .expect("produce_store_share_response_message should succeed");

    assert!(
        !response_envelope.is_empty(),
        "response envelope wire bytes must not be empty"
    );

    assert_eq!(
        returned_share.commitment, committed_share.commitment,
        "returned commitment must match original"
    );
    assert_eq!(
        returned_share.de_rec_share, committed_share.de_rec_share,
        "returned de_rec_share must match original"
    );
    assert_eq!(
        returned_share.merkle_path.len(),
        committed_share.merkle_path.len(),
        "returned merkle_path length must match original"
    );

    assert_eq!(
        returned_secret_id, secret_id,
        "returned secret_id must match the original"
    );
    assert_eq!(
        returned_version, version,
        "returned version must match the request version"
    );
}

#[test]
fn test_extract_store_share_request_wrong_key() {
    let secret_id: u64 = 1;
    let secret_data = b"super_secret_value";
    let channels = make_channel_ids(&[1, 2, 3]);
    let threshold = 2;
    let version = 7;
    let shared_key = [42u8; 32];
    let wrong_key = [99u8; 32];

    let SplitResult { shares } =
        split(&channels, secret_id, version, secret_data, threshold).expect("split should succeed");

    let channel_id = ChannelId(1);
    let committed_share = shares
        .get(&channel_id)
        .expect("missing share for channel 1");

    let ProduceStoreShareRequestMessageResult {
        envelope: request_envelope,
    } = produce_store_share_request_message(
        channel_id,
        version,
        secret_id,
        committed_share,
        &[],
        "",
        &shared_key,
        None,
        None,
    )
    .expect("produce_store_share_request_message should succeed");

    let result = extract_store_share_request(&request_envelope, &wrong_key);
    assert!(result.is_err(), "should fail with wrong key");
}

#[test]
fn test_split_rejects_duplicate_channels() {
    let secret_id: u64 = 1;
    let secret_data = b"secret-data";
    let channels = make_channel_ids(&[1, 2, 3, 2, 1]);
    let threshold = 2;
    let version = 1;

    let result = split(&channels, secret_id, version, secret_data, threshold);

    assert!(
        matches!(
            result,
            Err(Error::Sharing(SharingError::DuplicateChannelId(_)))
        ),
        "expected DuplicateChannelId error"
    );
}

#[test]
fn test_split_rejects_single_duplicate_channel() {
    let secret_id: u64 = 1;
    let secret_data = b"secret-data";
    let channels = make_channel_ids(&[1, 2, 2]);
    let threshold = 2;
    let version = 1;

    let result = split(&channels, secret_id, version, secret_data, threshold);

    assert!(
        matches!(
            result,
            Err(Error::Sharing(SharingError::DuplicateChannelId(2)))
        ),
        "expected DuplicateChannelId(2)"
    );
}

#[test]
fn test_process_store_share_response_message_valid() {
    let secret_id: u64 = 1;
    let secret_data = b"super_secret_value";
    let channels = make_channel_ids(&[1, 2, 3]);
    let threshold = 2;
    let version = 7;
    let shared_key = [42u8; 32];

    let SplitResult { shares } =
        split(&channels, secret_id, version, secret_data, threshold).expect("split should succeed");

    let channel_id = ChannelId(1);
    let committed_share = shares
        .get(&channel_id)
        .expect("missing share for channel 1");

    let ProduceStoreShareRequestMessageResult {
        envelope: request_envelope,
    } = produce_store_share_request_message(
        channel_id,
        version,
        secret_id,
        committed_share,
        &[],
        "",
        &shared_key,
        None,
        None,
    )
    .expect("produce_store_share_request_message should succeed");

    let ExtractStoreShareRequestResult { request } =
        extract_store_share_request(&request_envelope, &shared_key)
            .expect("extract_store_share_request should succeed");

    let ProduceStoreShareResponseMessageResult {
        envelope: response_envelope,
        ..
    } = produce_store_share_response_message(channel_id, &request, &shared_key)
        .expect("produce_store_share_response_message should succeed");

    let ExtractStoreShareResponseResult { response } =
        extract_store_share_response(&response_envelope, &shared_key)
            .expect("extract_store_share_response should succeed");

    process_store_share_response_message(version, &response)
        .expect("process_store_share_response_message should succeed");
}

#[test]
fn test_process_store_share_response_message_wrong_version() {
    let secret_id: u64 = 1;
    let secret_data = b"super_secret_value";
    let channels = make_channel_ids(&[1, 2, 3]);
    let threshold = 2;
    let version = 7;
    let shared_key = [42u8; 32];

    let SplitResult { shares } =
        split(&channels, secret_id, version, secret_data, threshold).expect("split should succeed");

    let channel_id = ChannelId(1);
    let committed_share = shares
        .get(&channel_id)
        .expect("missing share for channel 1");

    let ProduceStoreShareRequestMessageResult {
        envelope: request_envelope,
    } = produce_store_share_request_message(
        channel_id,
        version,
        secret_id,
        committed_share,
        &[],
        "",
        &shared_key,
        None,
        None,
    )
    .expect("produce_store_share_request_message should succeed");

    let ExtractStoreShareRequestResult { request } =
        extract_store_share_request(&request_envelope, &shared_key)
            .expect("extract_store_share_request should succeed");

    let ProduceStoreShareResponseMessageResult {
        envelope: response_envelope,
        ..
    } = produce_store_share_response_message(channel_id, &request, &shared_key)
        .expect("produce_store_share_response_message should succeed");

    let ExtractStoreShareResponseResult { response } =
        extract_store_share_response(&response_envelope, &shared_key)
            .expect("extract_store_share_response should succeed");

    let wrong_version = version + 1;
    let result = process_store_share_response_message(wrong_version, &response);
    assert!(result.is_err(), "should fail when version does not match");
}

#[test]
fn test_extract_store_share_response_wrong_key() {
    let secret_id: u64 = 1;
    let secret_data = b"super_secret_value";
    let channels = make_channel_ids(&[1, 2, 3]);
    let threshold = 2;
    let version = 7;
    let shared_key = [42u8; 32];
    let wrong_key = [99u8; 32];

    let SplitResult { shares } =
        split(&channels, secret_id, version, secret_data, threshold).expect("split should succeed");

    let channel_id = ChannelId(1);
    let committed_share = shares
        .get(&channel_id)
        .expect("missing share for channel 1");

    let ProduceStoreShareRequestMessageResult {
        envelope: request_envelope,
    } = produce_store_share_request_message(
        channel_id,
        version,
        secret_id,
        committed_share,
        &[],
        "",
        &shared_key,
        None,
        None,
    )
    .expect("produce_store_share_request_message should succeed");

    let ExtractStoreShareRequestResult { request } =
        extract_store_share_request(&request_envelope, &shared_key)
            .expect("extract_store_share_request should succeed");

    let ProduceStoreShareResponseMessageResult {
        envelope: response_envelope,
        ..
    } = produce_store_share_response_message(channel_id, &request, &shared_key)
        .expect("produce_store_share_response_message should succeed");

    let result = extract_store_share_response(&response_envelope, &wrong_key);
    assert!(result.is_err(), "should fail with wrong key");
}

#[test]
fn test_produce_store_share_response_message_rejects_empty_commitment() {
    let request = make_request_with_mutated_share(|share| {
        share.commitment.clear();
    });

    let shared_key = [1u8; 32];
    let channel_id = ChannelId(1);

    let result = produce_store_share_response_message(channel_id, &request, &shared_key);
    assert!(result.is_err(), "should reject share with empty commitment");
}

#[test]
fn test_produce_store_share_response_message_rejects_empty_merkle_path() {
    let request = make_request_with_mutated_share(|share| {
        share.merkle_path.clear();
    });

    let shared_key = [1u8; 32];
    let channel_id = ChannelId(1);

    let result = produce_store_share_response_message(channel_id, &request, &shared_key);
    assert!(
        result.is_err(),
        "should reject share with empty merkle_path"
    );
}

#[test]
fn test_produce_store_share_response_message_rejects_tampered_commitment() {
    let request = make_request_with_mutated_share(|share| {
        if let Some(first) = share.commitment.first_mut() {
            *first ^= 0xFF;
        }
    });

    let shared_key = [1u8; 32];
    let channel_id = ChannelId(1);

    let result = produce_store_share_response_message(channel_id, &request, &shared_key);
    assert!(
        result.is_err(),
        "should reject share whose commitment does not match Merkle proof"
    );
}

/// A peer-supplied `reply_to` that declares `Protocol::Https` but ships
/// a URI with an unsupported scheme is rejected at extract — the
/// scheme-vs-protocol gate is what stops a malicious request sender
/// from redirecting our response onto an arbitrary non-HTTP(S) channel.
/// (`http://` is intentionally accepted as a dev-mode affordance and
/// is flagged via `tracing::warn!`; see `crate::transport`.)
#[test]
fn test_extract_store_share_request_rejects_scheme_mismatched_reply_to() {
    let secret_id: u64 = 1;
    let secret_data = b"share-extract-validation";
    let channels = make_channel_ids(&[1, 2, 3]);
    let version = 1;

    let SplitResult { shares } =
        split(&channels, secret_id, version, secret_data, 2).expect("split should succeed");

    let channel_id = ChannelId(1);
    let committed_share = shares.get(&channel_id).expect("missing share");
    let shared_key = [1u8; 32];

    let malicious_reply_to = derec_proto::TransportProtocol {
        uri: "ws://attacker.example/inbox".to_owned(),
        protocol: derec_proto::Protocol::Https as i32,
    };

    let ProduceStoreShareRequestMessageResult { envelope } = produce_store_share_request_message(
        channel_id,
        version,
        secret_id,
        committed_share,
        &[],
        String::new(),
        &shared_key,
        Some(malicious_reply_to),
        None,
    )
    .expect("failed to produce store share request");

    let result = extract_store_share_request(&envelope, &shared_key);

    assert!(matches!(
        result,
        Err(Error::Transport(
            crate::transport::TransportValidationError::SchemeMismatch { .. }
        ))
    ));
}

/// `produce` stamps `replica_id` onto the wire message and `extract`
/// round-trips it. Owner case (`None`) and replica case (`Some(_)`)
/// both pass through unchanged so the helper-side handler can
/// disambiguate concurrent writes from distinct replicas reusing the
/// source's shared key.
#[test]
fn test_store_share_request_round_trips_replica_id() {
    let secret_id: u64 = 1;
    let secret_data = b"replica-id-roundtrip";
    let channels = make_channel_ids(&[1, 2, 3]);
    let version = 1;

    let SplitResult { shares } =
        split(&channels, secret_id, version, secret_data, 2).expect("split should succeed");

    let channel_id = ChannelId(1);
    let committed_share = shares.get(&channel_id).expect("missing share");
    let shared_key = [42u8; 32];

    let owner_env = produce_store_share_request_message(
        channel_id,
        version,
        secret_id,
        committed_share,
        &[],
        String::new(),
        &shared_key,
        None,
        None,
    )
    .expect("owner-side produce")
    .envelope;
    let owner_extracted =
        extract_store_share_request(&owner_env, &shared_key).expect("owner-side extract");
    assert_eq!(owner_extracted.request.replica_id, None);

    let replica_env = produce_store_share_request_message(
        channel_id,
        version,
        secret_id,
        committed_share,
        &[],
        String::new(),
        &shared_key,
        None,
        Some(0xCAFE_BABE_DEAD_BEEF),
    )
    .expect("replica-side produce")
    .envelope;
    let replica_extracted = extract_store_share_request(&replica_env, &shared_key)
        .expect("replica-side extract");
    assert_eq!(
        replica_extracted.request.replica_id,
        Some(0xCAFE_BABE_DEAD_BEEF)
    );
}