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
// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2026 DeRec Alliance. All rights reserved.

use crate::{
    Error,
    derec_message::extract_inner_message,
    primitives::verification::{
        request::{
            extract as extract_verify_share_request,
            produce as produce_verify_share_request_message,
        },
        response::{
            extract as extract_verify_share_response,
            process as process_verify_share_response_message,
            produce as produce_verify_share_response_message,
        },
    },
    types::ChannelId,
};
use derec_proto::{DeRecMessage, MessageBody, StatusEnum};
use prost::Message;
use sha2::{Digest, Sha384};

fn parse_request(
    envelope_bytes: &[u8],
    shared_key: &[u8; 32],
) -> crate::primitives::verification::request::ExtractResult {
    extract_verify_share_request(envelope_bytes, shared_key)
        .expect("extract_verify_share_request failed")
}

#[test]
fn test_produce_verify_share_request_message_produces_non_empty_envelope() {
    let channel_id = ChannelId(7);
    let shared_key = [23u8; 32];

    let result = produce_verify_share_request_message(channel_id, 1, 5, &shared_key, None)
        .expect("failed to produce verification request");

    assert!(!result.envelope.is_empty());
    let decoded = DeRecMessage::decode(result.envelope.as_slice()).unwrap();
    assert_eq!(decoded.channel_id, u64::from(channel_id));
}

#[test]
fn test_extract_verify_share_request_extracts_all_fields() {
    let channel_id = ChannelId(5);
    let shared_key = [29u8; 32];
    let secret_id = 1;
    let version = 9;

    let produced =
        produce_verify_share_request_message(channel_id, secret_id, version, &shared_key, None)
            .expect("failed to produce verification request");

    let result = extract_verify_share_request(&produced.envelope, &shared_key)
        .expect("failed to extract verification request");

    assert_eq!(result.request.secret_id, secret_id);
    assert_eq!(result.request.version, version);
    assert_ne!(
        result.request.nonce, 0,
        "nonce must be a non-zero random value"
    );
}

#[test]
fn test_extract_verify_share_request_nonce_matches_inner_message() {
    let channel_id = ChannelId(2);
    let shared_key = [31u8; 32];

    let produced = produce_verify_share_request_message(channel_id, 2, 3, &shared_key, None)
        .expect("failed to produce verification request");

    let result = extract_verify_share_request(&produced.envelope, &shared_key)
        .expect("failed to extract verification request");

    // Cross-check by independently decoding the inner message.
    let outer = DeRecMessage::decode(produced.envelope.as_slice()).unwrap();
    let raw_request = match extract_inner_message(&outer.message, &shared_key)
        .expect("failed to decode inner request")
    {
        MessageBody::VerifyShareRequest(m) => m,
        _ => panic!("unexpected message body"),
    };

    assert_eq!(result.request.nonce, raw_request.nonce);
    assert_eq!(result.request.secret_id, raw_request.secret_id);
    assert_eq!(result.request.version, raw_request.version);
}

#[test]
fn test_extract_verify_share_request_rejects_tampered_timestamp() {
    let channel_id = ChannelId(4);
    let shared_key = [37u8; 32];

    let produced = produce_verify_share_request_message(channel_id, 4, 1, &shared_key, None)
        .expect("failed to produce verification request");

    let outer = DeRecMessage::decode(produced.envelope.as_slice()).unwrap();
    let message = match extract_inner_message(&outer.message, &shared_key)
        .expect("failed to decode request")
    {
        MessageBody::VerifyShareRequest(m) => m,
        _ => panic!("unexpected message body"),
    };

    let original_timestamp = outer.timestamp.expect("timestamp must be present");
    let mut tampered_timestamp = original_timestamp;
    tampered_timestamp.seconds += 1;

    // Build a tampered envelope with a mismatched outer timestamp.
    let tampered_envelope = crate::derec_message::DeRecMessageBuilder::channel()
        .channel_id(channel_id)
        .timestamp(tampered_timestamp)
        .message_body(MessageBody::VerifyShareRequest(message))
        .encrypt(&shared_key)
        .expect("failed to encrypt tampered request")
        .build()
        .expect("failed to build tampered envelope")
        .encode_to_vec();

    let result = extract_verify_share_request(&tampered_envelope, &shared_key);

    assert!(matches!(
        result,
        Err(Error::Invariant(
            "Envelope timestamp does not match request/response timestamp"
        ))
    ));
}

#[test]
fn test_produce_verify_share_response_message_produces_non_empty_envelope() {
    let channel_id = ChannelId(1);
    let shared_key = [7u8; 32];

    let produced = produce_verify_share_request_message(channel_id, 10, 4, &shared_key, None)
        .expect("failed to produce verification request");

    let req = parse_request(&produced.envelope, &shared_key);

    let response = produce_verify_share_response_message(
        channel_id,
        &req.request,
        &shared_key,
        b"share_content",
    )
    .expect("failed to produce verification response");

    assert!(!response.envelope.is_empty());
}

#[test]
fn test_produce_verify_share_response_message_echo_fields() {
    let channel_id = ChannelId(2);
    let shared_key = [9u8; 32];
    let secret_id = 123;
    let version = 4;

    let produced =
        produce_verify_share_request_message(channel_id, secret_id, version, &shared_key, None)
            .expect("failed to produce verification request");

    let req = parse_request(&produced.envelope, &shared_key);

    let response = produce_verify_share_response_message(
        channel_id,
        &req.request,
        &shared_key,
        b"share_content",
    )
    .expect("failed to produce verification response");

    let response_outer = DeRecMessage::decode(response.envelope.as_slice()).unwrap();
    let response_message = match extract_inner_message(&response_outer.message, &shared_key)
        .expect("failed to decrypt verification response")
    {
        MessageBody::VerifyShareResponse(m) => m,
        _ => panic!("unexpected message body"),
    };

    assert_eq!(response_message.secret_id, secret_id);
    assert_eq!(response_message.version, version);
    assert_eq!(response_message.nonce, req.request.nonce);
    assert_eq!(
        response_message
            .result
            .as_ref()
            .expect("response result must be present")
            .status,
        StatusEnum::Ok as i32
    );
    assert!(response_outer.timestamp.is_some());
    assert_eq!(response_outer.timestamp, response_message.timestamp);
}

#[test]
fn test_full_verification_flow_success() {
    let channel_id = ChannelId(2);
    let shared_key = [7u8; 32];
    let secret_id = 987;
    let version = 4;
    let share_content = b"test_share_content";

    let produced =
        produce_verify_share_request_message(channel_id, secret_id, version, &shared_key, None)
            .expect("failed to produce verification request");

    // Helper side.
    let req = parse_request(&produced.envelope, &shared_key);

    assert_eq!(req.request.secret_id, secret_id);
    assert_eq!(req.request.version, version);

    let response =
        produce_verify_share_response_message(channel_id, &req.request, &shared_key, share_content)
            .expect("failed to produce verification response");

    // Owner side.
    let resp_result = extract_verify_share_response(&response.envelope, &shared_key)
        .expect("failed to extract verification response");

    assert!(matches!(
        process_verify_share_response_message(&req.request, &resp_result.response, share_content),
        Ok(valid) if valid
    ));
}

#[test]
fn test_full_verification_flow_wrong_share_returns_false() {
    let channel_id = ChannelId(2);
    let shared_key = [9u8; 32];
    let secret_id = 987654;
    let version = 4;
    let share_content = b"test_share_content";
    let wrong_share_content = b"wrong_content";

    let produced =
        produce_verify_share_request_message(channel_id, secret_id, version, &shared_key, None)
            .expect("failed to produce verification request");

    let req = parse_request(&produced.envelope, &shared_key);

    let response =
        produce_verify_share_response_message(channel_id, &req.request, &shared_key, share_content)
            .expect("failed to produce verification response");

    let resp_result = extract_verify_share_response(&response.envelope, &shared_key)
        .expect("failed to extract verification response");

    assert!(matches!(
        process_verify_share_response_message(
            &req.request,
            &resp_result.response,
            wrong_share_content
        ),
        Ok(valid) if !valid
    ));
}

#[test]
fn test_verification_hash_is_correct_sha384() {
    let channel_id = ChannelId(1);
    let shared_key = [3u8; 32];
    let share_content = b"abc123";

    let produced = produce_verify_share_request_message(channel_id, 654321, 4, &shared_key, None)
        .expect("failed to produce verification request");

    let req = parse_request(&produced.envelope, &shared_key);

    let response =
        produce_verify_share_response_message(channel_id, &req.request, &shared_key, share_content)
            .expect("failed to produce verification response");

    let response_outer = DeRecMessage::decode(response.envelope.as_slice()).unwrap();
    let response_message = match extract_inner_message(&response_outer.message, &shared_key)
        .expect("failed to decrypt verification response")
    {
        MessageBody::VerifyShareResponse(m) => m,
        _ => panic!("unexpected message body"),
    };

    let mut hasher = Sha384::new();
    hasher.update(share_content);
    hasher.update(req.request.nonce.to_be_bytes());
    let expected_hash = hasher.finalize().to_vec();

    assert_eq!(response_message.hash, expected_hash);
}

#[test]
fn test_verification_fails_with_modified_response_nonce() {
    let channel_id = ChannelId(1);
    let shared_key = [5u8; 32];
    let share_content = b"nonce_test_content";

    let produced = produce_verify_share_request_message(channel_id, 654321, 4, &shared_key, None)
        .expect("failed to produce verification request");

    let req = parse_request(&produced.envelope, &shared_key);

    let response =
        produce_verify_share_response_message(channel_id, &req.request, &shared_key, share_content)
            .expect("failed to produce verification response");

    let response_outer = DeRecMessage::decode(response.envelope.as_slice()).unwrap();
    let mut response_message = match extract_inner_message(&response_outer.message, &shared_key)
        .expect("failed to decrypt verification response")
    {
        MessageBody::VerifyShareResponse(m) => m,
        _ => panic!("unexpected message body"),
    };

    response_message.nonce = 123;

    let tampered_envelope = crate::derec_message::DeRecMessageBuilder::channel()
        .channel_id(channel_id)
        .timestamp(
            response_outer
                .timestamp
                .expect("response envelope timestamp must be present"),
        )
        .message_body(MessageBody::VerifyShareResponse(response_message))
        .encrypt(&shared_key)
        .expect("failed to encrypt tampered response")
        .build()
        .expect("failed to build tampered response envelope")
        .encode_to_vec();

    let resp_result = extract_verify_share_response(&tampered_envelope, &shared_key)
        .expect("failed to extract tampered response");

    // Tampered response nonce no longer matches the originating request — the
    // binding gate rejects this before the SHA-384 check.
    assert!(matches!(
        process_verify_share_response_message(&req.request, &resp_result.response, share_content),
        Err(Error::Verification(
            crate::primitives::verification::VerificationError::ResponseBindingMismatch {
                field: "nonce",
                ..
            }
        ))
    ));
}

#[test]
fn test_process_verify_share_response_message_rejects_tampered_envelope_timestamp() {
    let channel_id = ChannelId(1);
    let shared_key = [13u8; 32];
    let share_content = b"response_timestamp_test_content";

    let produced = produce_verify_share_request_message(channel_id, 9873241, 4, &shared_key, None)
        .expect("failed to produce verification request");

    let req = parse_request(&produced.envelope, &shared_key);

    let response =
        produce_verify_share_response_message(channel_id, &req.request, &shared_key, share_content)
            .expect("failed to produce verification response");

    let response_outer = DeRecMessage::decode(response.envelope.as_slice()).unwrap();
    let response_message = match extract_inner_message(&response_outer.message, &shared_key)
        .expect("failed to decrypt verification response")
    {
        MessageBody::VerifyShareResponse(m) => m,
        _ => panic!("unexpected message body"),
    };

    let original_timestamp = response_outer
        .timestamp
        .expect("response envelope timestamp must be present");

    let mut tampered_timestamp = original_timestamp;
    tampered_timestamp.seconds += 1;

    let tampered_envelope = crate::derec_message::DeRecMessageBuilder::channel()
        .channel_id(channel_id)
        .timestamp(tampered_timestamp)
        .message_body(MessageBody::VerifyShareResponse(response_message))
        .encrypt(&shared_key)
        .expect("failed to encrypt tampered response")
        .build()
        .expect("failed to build tampered response")
        .encode_to_vec();

    assert!(matches!(
        extract_verify_share_response(&tampered_envelope, &shared_key),
        Err(Error::Invariant(
            "Envelope timestamp does not match request/response timestamp"
        ))
    ));
}

#[test]
fn test_extract_verify_share_response_returns_correct_channel_id() {
    let channel_id = ChannelId(7);
    let shared_key = [23u8; 32];

    let produced = produce_verify_share_request_message(channel_id, 987654, 1, &shared_key, None)
        .expect("failed to produce verification request");
    let req = parse_request(&produced.envelope, &shared_key);
    let response =
        produce_verify_share_response_message(channel_id, &req.request, &shared_key, b"share")
            .expect("failed to produce verification response");

    // The outer envelope channel_id must match the original.
    let decoded = DeRecMessage::decode(response.envelope.as_slice()).unwrap();
    assert_eq!(decoded.channel_id, u64::from(channel_id));
}

#[test]
fn test_extract_verify_share_response_returns_encrypted_bytes() {
    let channel_id = ChannelId(3);
    let shared_key = [11u8; 32];

    let produced = produce_verify_share_request_message(channel_id, 987654, 2, &shared_key, None)
        .expect("failed to produce verification request");
    let req = parse_request(&produced.envelope, &shared_key);
    let response = produce_verify_share_response_message(
        channel_id,
        &req.request,
        &shared_key,
        b"share_bytes",
    )
    .expect("failed to produce verification response");

    // Encrypted payload in the envelope must be non-empty.
    assert!(!response.envelope.is_empty());
}

#[test]
fn test_extract_verify_share_response_timestamp_matches_inner() {
    let channel_id = ChannelId(2);
    let shared_key = [31u8; 32];

    let produced = produce_verify_share_request_message(channel_id, 951984, 4, &shared_key, None)
        .expect("failed to produce verification request");
    let req = parse_request(&produced.envelope, &shared_key);
    let response =
        produce_verify_share_response_message(channel_id, &req.request, &shared_key, b"some_share")
            .expect("failed to produce verification response");

    let resp_result = extract_verify_share_response(&response.envelope, &shared_key)
        .expect("failed to extract verification response");

    // Cross-check: the inner response timestamp must match the envelope timestamp.
    let response_outer = DeRecMessage::decode(response.envelope.as_slice()).unwrap();
    let inner = match extract_inner_message(&response_outer.message, &shared_key)
        .expect("failed to decrypt response")
    {
        MessageBody::VerifyShareResponse(m) => m,
        _ => panic!("unexpected message body"),
    };

    assert_eq!(resp_result.response.timestamp, inner.timestamp);
}

/// A response whose nonce differs from the originating request must be
/// rejected by the binding gate — even if the SHA-384 over (share || nonce)
/// happens to verify against the response's own nonce. This is the anti-replay
/// guarantee that lets the owner pin a captured response to one challenge.
#[test]
fn test_process_rejects_response_with_mismatched_request_nonce() {
    let channel_id = ChannelId(1);
    let shared_key = [41u8; 32];
    let share_content = b"binding_test_share";

    let req_a = parse_request(
        &produce_verify_share_request_message(channel_id, 1234, 1, &shared_key, None)
            .expect("produce A")
            .envelope,
        &shared_key,
    );
    let req_b = parse_request(
        &produce_verify_share_request_message(channel_id, 1234, 1, &shared_key, None)
            .expect("produce B")
            .envelope,
        &shared_key,
    );

    let resp_envelope =
        produce_verify_share_response_message(channel_id, &req_b.request, &shared_key, share_content)
            .expect("produce response for B")
            .envelope;
    let resp = extract_verify_share_response(&resp_envelope, &shared_key)
        .expect("extract response for B");

    // Helper computed hash binding to req_b's nonce, but we hand the owner
    // req_a as the originating request — the binding gate must reject.
    let result =
        process_verify_share_response_message(&req_a.request, &resp.response, share_content);
    assert!(matches!(
        result,
        Err(Error::Verification(
            crate::primitives::verification::VerificationError::ResponseBindingMismatch {
                field: "nonce",
                ..
            }
        ))
    ));
}

#[test]
fn test_process_rejects_response_with_mismatched_secret_id() {
    let channel_id = ChannelId(2);
    let shared_key = [43u8; 32];
    let share_content = b"binding_test_share_2";

    let req = parse_request(
        &produce_verify_share_request_message(channel_id, 100, 1, &shared_key, None)
            .expect("produce")
            .envelope,
        &shared_key,
    );

    let resp = extract_verify_share_response(
        &produce_verify_share_response_message(channel_id, &req.request, &shared_key, share_content)
            .expect("produce response")
            .envelope,
        &shared_key,
    )
    .expect("extract response");

    // Pretend the owner is checking against a different originating request
    // that carried a different secret_id.
    let mismatched_request = derec_proto::VerifyShareRequestMessage {
        secret_id: 999,
        version: req.request.version,
        nonce: req.request.nonce,
        timestamp: req.request.timestamp,
        reply_to: req.request.reply_to.clone(),
    };
    let result =
        process_verify_share_response_message(&mismatched_request, &resp.response, share_content);
    assert!(matches!(
        result,
        Err(Error::Verification(
            crate::primitives::verification::VerificationError::ResponseBindingMismatch {
                field: "secret_id",
                ..
            }
        ))
    ));
}

#[test]
fn test_process_rejects_response_with_mismatched_version() {
    let channel_id = ChannelId(3);
    let shared_key = [47u8; 32];
    let share_content = b"binding_test_share_3";

    let req = parse_request(
        &produce_verify_share_request_message(channel_id, 100, 1, &shared_key, None)
            .expect("produce")
            .envelope,
        &shared_key,
    );

    let resp = extract_verify_share_response(
        &produce_verify_share_response_message(channel_id, &req.request, &shared_key, share_content)
            .expect("produce response")
            .envelope,
        &shared_key,
    )
    .expect("extract response");

    let mismatched_request = derec_proto::VerifyShareRequestMessage {
        secret_id: req.request.secret_id,
        version: req.request.version + 1,
        nonce: req.request.nonce,
        timestamp: req.request.timestamp,
        reply_to: req.request.reply_to.clone(),
    };
    let result =
        process_verify_share_response_message(&mismatched_request, &resp.response, share_content);
    assert!(matches!(
        result,
        Err(Error::Verification(
            crate::primitives::verification::VerificationError::ResponseBindingMismatch {
                field: "version",
                ..
            }
        ))
    ));
}

/// 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_verify_share_request_rejects_scheme_mismatched_reply_to() {
    let channel_id = ChannelId(11);
    let shared_key = [42u8; 32];

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

    let produced = produce_verify_share_request_message(
        channel_id,
        1,
        1,
        &shared_key,
        Some(malicious_reply_to),
    )
    .expect("failed to produce verification request");

    let result = extract_verify_share_request(&produced.envelope, &shared_key);

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