hl-engine 0.1.11

Safe Rust lifecycle API for the standalone HL Linux guest engine
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

mod codec;
mod input;
mod model;
mod namespace;

pub use codec::{decode_reply, decode_request, encode_reply, encode_request};
pub use model::{Reply, Request, SeekWhence, ServiceFailure, ServiceStat};
pub use namespace::{
    decode_namespace_install, encode_namespace_install, ProjectionKind, ServiceProjection,
};

#[cfg(test)]
mod tests {
    use super::{
        codec::WRITE, decode_namespace_install, decode_reply, decode_request,
        encode_namespace_install, encode_reply, encode_request, input::protocol, ProjectionKind,
        Reply, Request, ServiceFailure, ServiceProjection,
    };
    use crate::api::extension::ServiceId;
    use crate::provider::{LinuxError, Readiness, ReadyState};

    #[test]
    fn frozen_codec_round_trips_requests_replies_and_errno() {
        let request = Request::Write {
            handle: 7,
            offset: 11,
            bytes: b"owned".to_vec(),
        };
        let encoded = encode_request(&request, 16).unwrap();
        assert_eq!(
            encoded,
            [
                vec![WRITE],
                7_u64.to_le_bytes().to_vec(),
                11_u64.to_le_bytes().to_vec(),
                5_u32.to_le_bytes().to_vec(),
                b"owned".to_vec(),
            ]
            .concat()
        );
        assert_eq!(decode_request(&encoded, 16).unwrap(), request);

        let ready = Reply::Ready(Readiness {
            states: [ReadyState::Readable, ReadyState::Hangup]
                .into_iter()
                .collect(),
        });
        let encoded = encode_reply(&Ok(ready.clone()), 16).unwrap();
        assert_eq!(decode_reply(&encoded, 16).unwrap(), ready);

        let failure = ServiceFailure::Linux(LinuxError {
            errno: 19,
            context: "provider unavailable".into(),
        });
        let encoded = encode_reply(&Err(failure.clone()), 64).unwrap();
        assert_eq!(decode_reply(&encoded, 64).unwrap_err(), failure);
    }

    #[test]
    fn codecs_reject_trailing_invalid_and_oversized_payloads() {
        let mut request = encode_request(&Request::Close { handle: 1 }, 8).unwrap();
        request.push(0);
        assert_eq!(decode_request(&request, 8).unwrap_err(), protocol());
        assert_eq!(decode_request(&[WRITE], 8).unwrap_err(), protocol());
        assert!(matches!(
            encode_request(
                &Request::Write {
                    handle: 1,
                    offset: 0,
                    bytes: vec![0; 9],
                },
                8,
            ),
            Err(ServiceFailure::Linux(LinuxError { errno: 22, .. }))
        ));
    }

    #[test]
    fn namespace_codec_enforces_transaction_bounds_and_normalization() {
        let entries = vec![ServiceProjection {
            path: "/run/provider".into(),
            service: ServiceId(9),
            mode: 0o660,
            uid: 10,
            gid: 20,
            kind: ProjectionKind::Service,
        }];
        let wire = encode_namespace_install(&entries, 4, 128).unwrap();
        assert_eq!(decode_namespace_install(&wire, 4, 128).unwrap(), entries);

        let devices = vec![ServiceProjection {
            path: "/dev/provider".into(),
            service: ServiceId(10),
            mode: 0o660,
            uid: 11,
            gid: 12,
            kind: ProjectionKind::CharacterDevice {
                major: 226,
                minor: 128,
            },
        }];
        let wire = encode_namespace_install(&devices, 4, 128).unwrap();
        assert_eq!(decode_namespace_install(&wire, 4, 128).unwrap(), devices);

        let conflicts = vec![
            ServiceProjection {
                path: "/run/provider".into(),
                service: ServiceId(1),
                mode: 0o600,
                uid: 0,
                gid: 0,
                kind: ProjectionKind::Service,
            },
            ServiceProjection {
                path: "/run/provider/child".into(),
                service: ServiceId(2),
                mode: 0o600,
                uid: 0,
                gid: 0,
                kind: ProjectionKind::Service,
            },
        ];
        assert!(matches!(
            encode_namespace_install(&conflicts, 4, 128),
            Err(ServiceFailure::Linux(LinuxError { errno: 20, .. }))
        ));

        let mut trailing = encode_namespace_install(&entries, 4, 128).unwrap();
        trailing.push(0);
        assert_eq!(
            decode_namespace_install(&trailing, 4, 128).unwrap_err(),
            protocol()
        );
    }
}