pim-protocol 0.1.6

Wire protocol types and frame serialization for the Proximity Internet Mesh
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

use super::super::*;

#[test]
fn ipv4_legacy_tags_are_rejected() {
    // 0x01 = old IpRequest, 0x02 = old IpAssign — both removed when
    // mesh addresses became deterministic. A daemon receiving a
    // legacy frame from a mismatched peer should fail decoding
    // cleanly rather than panic or silently mis-tag.
    for tag in [0x01u8, 0x02] {
        let mut buf = BytesMut::from(&[tag][..]);
        assert!(
            ControlFrame::decode(&mut buf).is_err(),
            "control type 0x{tag:02x} must be rejected after removal"
        );
    }
}

#[test]
fn goodbye_round_trip() {
    let frame = ControlFrame::Goodbye {
        departing_id: NodeId::from_bytes([0xAB; 16]),
        reason: 0,
    };
    let mut buf = BytesMut::new();
    frame.encode(&mut buf);
    let decoded = ControlFrame::decode(&mut buf).unwrap();
    assert_eq!(frame, decoded);
}

#[test]
fn rekey_round_trip() {
    let frame = ControlFrame::Rekey;
    let mut buf = BytesMut::new();
    frame.encode(&mut buf);
    let decoded = ControlFrame::decode(&mut buf).unwrap();
    assert_eq!(frame, decoded);
}

#[test]
fn ping_pong_round_trip() {
    let ping = ControlFrame::Ping { nonce: 12345 };
    let pong = ControlFrame::Pong { nonce: 12345 };

    for frame in [ping, pong] {
        let mut buf = BytesMut::new();
        frame.encode(&mut buf);
        let decoded = ControlFrame::decode(&mut buf).unwrap();
        assert_eq!(frame, decoded);
    }
}

#[test]
fn reject_empty() {
    let mut buf = BytesMut::new();
    assert!(ControlFrame::decode(&mut buf).is_err());
}

#[test]
fn reject_unknown_type() {
    let mut buf = BytesMut::from(&[0xFF][..]);
    assert!(ControlFrame::decode(&mut buf).is_err());
}

#[test]
fn peer_info_round_trip() {
    let frame = ControlFrame::PeerInfo {
        x25519_pub: [0x11; 32],
        friendly_name: "client-a-macbook".into(),
    };
    let mut buf = BytesMut::new();
    frame.encode(&mut buf);
    let decoded = ControlFrame::decode(&mut buf).unwrap();
    assert_eq!(frame, decoded);
}

#[test]
fn peer_info_empty_name_round_trip() {
    let frame = ControlFrame::PeerInfo {
        x25519_pub: [0x22; 32],
        friendly_name: String::new(),
    };
    let mut buf = BytesMut::new();
    frame.encode(&mut buf);
    let decoded = ControlFrame::decode(&mut buf).unwrap();
    assert_eq!(frame, decoded);
}

#[test]
fn plugin_payload_round_trip() {
    let frame = ControlFrame::PluginPayload {
        kind: "messaging.msg".into(),
        body: bytes::Bytes::from_static(&[0xDE, 0xAD, 0xBE, 0xEF]),
    };
    let mut buf = BytesMut::new();
    frame.encode(&mut buf);
    let decoded = ControlFrame::decode(&mut buf).unwrap();
    assert_eq!(frame, decoded);
}

#[test]
fn plugin_payload_empty_body_round_trip() {
    let frame = ControlFrame::PluginPayload {
        kind: "messaging.ack".into(),
        body: bytes::Bytes::new(),
    };
    let mut buf = BytesMut::new();
    frame.encode(&mut buf);
    let decoded = ControlFrame::decode(&mut buf).unwrap();
    assert_eq!(frame, decoded);
}

#[test]
fn reject_truncated_peer_info() {
    let mut buf = BytesMut::from(&[0x07, 0x00, 0x01][..]); // too short
    assert!(ControlFrame::decode(&mut buf).is_err());
}

#[test]
fn reject_truncated_plugin_payload_header() {
    // tag + kind_len = 0x05 promising 5 bytes of kind, but no kind/body follows.
    let mut buf = BytesMut::from(&[0x08, 0x05][..]);
    assert!(ControlFrame::decode(&mut buf).is_err());
}

#[test]
fn reject_truncated_plugin_payload_body() {
    // tag + kind_len(1) + kind("a") + body_len(0x0008) + only 2 body bytes.
    let mut buf = BytesMut::from(&[0x08, 0x01, b'a', 0x00, 0x08, 0xAA, 0xBB][..]);
    assert!(ControlFrame::decode(&mut buf).is_err());
}