vest_lib 0.2.2

Verified parser and serializer combinators in Verus
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
//! CBOR byte-string and text-string chunk formats (used for indefinite strings).
use alloc::{string::String, vec::Vec};

use crate::asn1::Utf8StringFmt;
use crate::combinators::{
    bytes::ExactLen, mapped::spec::FnSpecMapper, Bind, Mapped, Sum, Tail, Void,
};
use crate::core::exec::{
    input::{InputBuf, InputSlice},
    parser::*,
    ParseError,
};
use crate::core::{proof::*, spec::*};
use crate::Never;
use vstd::prelude::*;
use vstd::string::StringSliceAdditionalSpecFns;

use super::{CborHead, CborHeadFmt, CborHeadValue, MajorType};
use Sum::Inl as L;
use Sum::Inr as R;

verus! {

pub type ByteChunkWire = (CborHead, Sum<Seq<u8>, Never>);

pub type ByteChunkInnerFmt<const DET: bool> = Mapped<
    Bind<CborHeadFmt<DET>, spec_fn(CborHead) -> Sum<ExactLen<Tail, u64>, Void>>,
    FnSpecMapper<ByteChunkWire, Seq<u8>>,
>;

/// One definite byte-string chunk. Indefinite strings use this as their repeat element.
#[doc(hidden)]
pub open spec fn byte_chunk_fmt<const DET: bool>() -> ByteChunkInnerFmt<DET> {
    Mapped {
        inner: Bind(
            CborHeadFmt::<DET>,
            |head: CborHead|
                match head {
                    CborHead { major: MajorType::Bytes, value: CborHeadValue::Argument(len) } => {
                        L(ExactLen(len, Tail))
                    },
                    _ => R(Void("expected a definite CBOR byte-string chunk")),
                },
        ),
        mapper: (
            |wire: ByteChunkWire|
                match wire.1 {
                    L(bytes) => bytes,
                    R(_) => arbitrary(),
                },
            |bytes: Seq<u8>|
                (
                    CborHead {
                        major: MajorType::Bytes,
                        value: CborHeadValue::Argument(bytes.len() as u64),
                    },
                    L(bytes),
                ),
        ),
    }
}

#[derive(Clone, Copy)]
pub struct ByteChunkFmt<const DET: bool>;

impl<'i, const DET: bool> Parser<&'i [u8]> for ByteChunkFmt<DET> {
    type PT = &'i [u8];

    fn parse(&self, input: &&'i [u8]) -> PResult<Self::PT> {
        broadcast use crate::core::spec::SafeParser::lemma_parse_safe;

        let _ = input.len();
        let (head_len, head) = CborHeadFmt::<DET>.parse(input)?;
        match head {
            CborHead { major: MajorType::Bytes, value: CborHeadValue::Argument(len) } => {
                let rest = input.skip(head_len);
                let (content_len, bytes) = ExactLen(len, Tail).parse(&rest)?;
                Ok((head_len + content_len, bytes))
            },
            _ => Err(ParseError::custom("expected a definite CBOR byte-string chunk")),
        }
    }
}

pub type TextChunkWire = (CborHead, Sum<Seq<char>, Never>);

pub type TextChunkInnerFmt<const DET: bool> = Mapped<
    Bind<CborHeadFmt<DET>, spec_fn(CborHead) -> Sum<ExactLen<Utf8StringFmt, u64>, Void>>,
    FnSpecMapper<TextChunkWire, Seq<char>>,
>;

/// One definite text-string chunk. Each chunk validates UTF-8 independently, as RFC 8949
/// requires for indefinite-length text strings.
#[doc(hidden)]
pub open spec fn text_chunk_fmt<const DET: bool>() -> TextChunkInnerFmt<DET> {
    Mapped {
        inner: Bind(
            CborHeadFmt::<DET>,
            |head: CborHead|
                match head {
                    CborHead { major: MajorType::Text, value: CborHeadValue::Argument(len) } => {
                        L(ExactLen(len, Utf8StringFmt))
                    },
                    _ => R(Void("expected a definite CBOR text-string chunk")),
                },
        ),
        mapper: (
            |wire: TextChunkWire|
                match wire.1 {
                    L(text) => text,
                    R(_) => arbitrary(),
                },
            |text: Seq<char>|
                (
                    CborHead {
                        major: MajorType::Text,
                        value: CborHeadValue::Argument(vstd::utf8::encode_utf8(text).len() as u64),
                    },
                    L(text),
                ),
        ),
    }
}

#[derive(Clone, Copy)]
pub struct TextChunkFmt<const DET: bool>;

impl<'i, const DET: bool> Parser<&'i [u8]> for TextChunkFmt<DET> {
    type PT = &'i str;

    fn parse(&self, input: &&'i [u8]) -> PResult<Self::PT> {
        broadcast use crate::core::spec::SafeParser::lemma_parse_safe;

        let _ = input.len();
        let (head_len, head) = CborHeadFmt::<DET>.parse(input)?;
        match head {
            CborHead { major: MajorType::Text, value: CborHeadValue::Argument(len) } => {
                let rest = input.skip(head_len);
                let (content_len, text) = ExactLen(len, Utf8StringFmt).parse(&rest)?;
                Ok((head_len + content_len, text))
            },
            _ => Err(ParseError::custom("expected a definite CBOR text-string chunk")),
        }
    }
}

#[verifier::loop_isolation(false)]
pub fn flatten_byte_chunks(chunks: Vec<&[u8]>) -> (flat: Vec<u8>)
    ensures
        flat.deep_view() == chunks.deep_view().flatten(),
{
    broadcast use vstd::seq_lib::group_seq_properties;

    let ghost chunk_views = chunks.deep_view();
    let mut flat = Vec::new();
    for i in 0..chunks.len()
        invariant
            flat.deep_view() == chunk_views[0..i].flatten(),
    {
        let chunk = chunks[i];
        proof {
            let prefix = chunk_views[0..i];
            prefix.lemma_flatten_push(chunk.deep_view());
            assert(chunk_views[0..i + 1] == prefix.push(chunk.deep_view()));
        }
        flat.extend_from_slice(chunk);
    }
    flat
}

pub proof fn lemma_encode_utf8_flatten(chunks: Seq<Seq<char>>)
    ensures
        vstd::utf8::encode_utf8(chunks.flatten()) == chunks.map_values(
            |chunk: Seq<char>| vstd::utf8::encode_utf8(chunk),
        ).flatten(),
    decreases chunks.len(),
{
    broadcast use vstd::seq_lib::group_seq_properties;
    broadcast use vstd::utf8::encode_utf8_concat;

    let encode = |chunk: Seq<char>| vstd::utf8::encode_utf8(chunk);
    if chunks.len() == 0 {
    } else {
        let prefix = chunks.drop_last();
        let last = chunks.last();
        lemma_encode_utf8_flatten(prefix);
        chunks.lemma_add_last_back();
        prefix.lemma_flatten_push(last);
        prefix.lemma_push_map_commute(encode, last);
        let encoded_prefix = prefix.map_values(encode);
        encoded_prefix.lemma_flatten_push(encode(last));
    }
}

#[verifier::loop_isolation(false)]
pub fn flatten_text_chunks(chunks: Vec<&str>) -> (flat: String)
    ensures
        flat.deep_view() =~= chunks.deep_view().flatten(),
{
    broadcast use vstd::seq_lib::group_seq_properties;
    broadcast use vstd::utf8::encode_utf8_valid_utf8;

    let ghost char_views = chunks.deep_view();
    let ghost byte_views = char_views.map_values(|chunk: Seq<char>| vstd::utf8::encode_utf8(chunk));
    let mut bytes = Vec::new();
    for i in 0..chunks.len()
        invariant
            bytes.deep_view() == byte_views[0..i].flatten(),
    {
        let chunk = chunks[i];
        let chunk_bytes = chunk.as_bytes();
        proof {
            let prefix = byte_views[0..i];
            prefix.lemma_flatten_push(chunk_bytes.deep_view());
            assert(chunk_bytes.deep_view() == vstd::utf8::encode_utf8(chunk.deep_view()));
            assert(byte_views[0..i + 1] == prefix.push(chunk_bytes.deep_view()));
        }
        bytes.extend_from_slice(chunk_bytes);
    }

    proof {
        lemma_encode_utf8_flatten(char_views);
        assert(vstd::utf8::valid_utf8(bytes.deep_view()));
    }
    // SAFETY: concatenating independently valid UTF-8 chunks remains valid UTF-8.
    let flat = unsafe { String::from_utf8_unchecked(bytes) };
    proof {
        vstd::utf8::encode_utf8_decode_utf8(char_views.flatten());
    }
    flat
}

mod derived_specs {
    use super::*;

    impl<const DET: bool> SpecParser for ByteChunkFmt<DET> {
        type PVal = Seq<u8>;

        open spec fn spec_parse(&self, input: Seq<u8>) -> Option<(int, Self::PVal)> {
            byte_chunk_fmt::<DET>().spec_parse(input)
        }
    }

    impl<const DET: bool> Consistency for ByteChunkFmt<DET> {
        type Val = Seq<u8>;

        open spec fn consistent(&self, value: Self::Val) -> bool {
            byte_chunk_fmt::<DET>().consistent(value)
        }
    }

    impl<const DET: bool> SpecSerializerDps for ByteChunkFmt<DET> {
        type SValue = Seq<u8>;

        open spec fn spec_serialize_dps(&self, value: Self::SValue, out: Seq<u8>) -> Seq<u8> {
            byte_chunk_fmt::<DET>().spec_serialize_dps(value, out)
        }
    }

    impl<const DET: bool> SpecSerializer for ByteChunkFmt<DET> {
        type SVal = Seq<u8>;

        open spec fn spec_serialize(&self, value: Self::SVal) -> Seq<u8> {
            byte_chunk_fmt::<DET>().spec_serialize(value)
        }
    }

    impl<const DET: bool> SpecByteLen for ByteChunkFmt<DET> {
        type T = Seq<u8>;

        open spec fn byte_len(&self, value: Self::T) -> nat {
            byte_chunk_fmt::<DET>().byte_len(value)
        }
    }

    impl<const DET: bool> SpecParser for TextChunkFmt<DET> {
        type PVal = Seq<char>;

        open spec fn spec_parse(&self, input: Seq<u8>) -> Option<(int, Self::PVal)> {
            text_chunk_fmt::<DET>().spec_parse(input)
        }
    }

    impl<const DET: bool> Consistency for TextChunkFmt<DET> {
        type Val = Seq<char>;

        open spec fn consistent(&self, value: Self::Val) -> bool {
            text_chunk_fmt::<DET>().consistent(value)
        }
    }

    impl<const DET: bool> SpecSerializerDps for TextChunkFmt<DET> {
        type SValue = Seq<char>;

        open spec fn spec_serialize_dps(&self, value: Self::SValue, out: Seq<u8>) -> Seq<u8> {
            text_chunk_fmt::<DET>().spec_serialize_dps(value, out)
        }
    }

    impl<const DET: bool> SpecSerializer for TextChunkFmt<DET> {
        type SVal = Seq<char>;

        open spec fn spec_serialize(&self, value: Self::SVal) -> Seq<u8> {
            text_chunk_fmt::<DET>().spec_serialize(value)
        }
    }

    impl<const DET: bool> SpecByteLen for TextChunkFmt<DET> {
        type T = Seq<char>;

        open spec fn byte_len(&self, value: Self::T) -> nat {
            text_chunk_fmt::<DET>().byte_len(value)
        }
    }

}

mod derived_proofs {
    use super::*;

    impl<const DET: bool> SafeParser for ByteChunkFmt<DET> {
        proof fn lemma_parse_safe(&self, input: Seq<u8>) {
            byte_chunk_fmt::<DET>().lemma_parse_safe(input);
        }
    }

    impl<const DET: bool> Productive for ByteChunkFmt<DET> {
        proof fn lemma_productive(&self, input: Seq<u8>) {
            byte_chunk_fmt::<DET>().lemma_productive(input);
        }
    }

    impl SoundParser for ByteChunkFmt<true> {
        proof fn lemma_parse_sound_consumption(&self, input: Seq<u8>) {
            byte_chunk_fmt::<true>().lemma_parse_sound_consumption(input);
        }

        proof fn lemma_parse_sound_value(&self, input: Seq<u8>) {
            byte_chunk_fmt::<true>().lemma_parse_sound_value(input);
        }
    }

    impl<const DET: bool> GoodSerializer for ByteChunkFmt<DET> {
        proof fn lemma_serialize_len(&self, value: Self::SVal) {
            byte_chunk_fmt::<DET>().lemma_serialize_len(value);
        }
    }

    impl<const DET: bool> NonTailFmt for ByteChunkFmt<DET> {
        proof fn lemma_serialize_dps_prepend(&self, value: Self::SValue, out: Seq<u8>) {
            byte_chunk_fmt::<DET>().lemma_serialize_dps_prepend(value, out);
        }

        proof fn lemma_serialize_dps_len(&self, value: Self::SValue, out: Seq<u8>) {
            byte_chunk_fmt::<DET>().lemma_serialize_dps_len(value, out);
        }
    }

    impl<const DET: bool> SPRoundTripDps for ByteChunkFmt<DET> {
        proof fn theorem_serialize_dps_parse_roundtrip(&self, value: Self::T, out: Seq<u8>) {
            byte_chunk_fmt::<DET>().theorem_serialize_dps_parse_roundtrip(value, out);
        }
    }

    impl NonMalleable for ByteChunkFmt<true> {
        proof fn lemma_parse_non_malleable(&self, left: Seq<u8>, right: Seq<u8>) {
            byte_chunk_fmt::<true>().lemma_parse_non_malleable(left, right);
        }
    }

    impl<const DET: bool> NoLookAhead for ByteChunkFmt<DET> {
        proof fn lemma_no_lookahead(&self, left: Seq<u8>, right: Seq<u8>) {
            byte_chunk_fmt::<DET>().lemma_no_lookahead(left, right);
        }
    }

    impl<const DET: bool> EquivSerializersGeneral for ByteChunkFmt<DET> {
        proof fn lemma_serialize_equiv(&self, value: Self::SVal, out: Seq<u8>) {
            byte_chunk_fmt::<DET>().lemma_serialize_equiv(value, out);
        }
    }

    impl<const DET: bool> EquivSerializers for ByteChunkFmt<DET> {
        proof fn lemma_serialize_equiv_on_empty(&self, value: Self::SVal) {
            byte_chunk_fmt::<DET>().lemma_serialize_equiv_on_empty(value);
        }
    }

    impl<const DET: bool> SafeParser for TextChunkFmt<DET> {
        proof fn lemma_parse_safe(&self, input: Seq<u8>) {
            text_chunk_fmt::<DET>().lemma_parse_safe(input);
        }
    }

    impl<const DET: bool> Productive for TextChunkFmt<DET> {
        proof fn lemma_productive(&self, input: Seq<u8>) {
            text_chunk_fmt::<DET>().lemma_productive(input);
        }
    }

    impl SoundParser for TextChunkFmt<true> {
        proof fn lemma_parse_sound_consumption(&self, input: Seq<u8>) {
            text_chunk_fmt::<true>().lemma_parse_sound_consumption(input);
        }

        proof fn lemma_parse_sound_value(&self, input: Seq<u8>) {
            text_chunk_fmt::<true>().lemma_parse_sound_value(input);
        }
    }

    impl<const DET: bool> GoodSerializer for TextChunkFmt<DET> {
        proof fn lemma_serialize_len(&self, value: Self::SVal) {
            text_chunk_fmt::<DET>().lemma_serialize_len(value);
        }
    }

    impl<const DET: bool> NonTailFmt for TextChunkFmt<DET> {
        proof fn lemma_serialize_dps_prepend(&self, value: Self::SValue, out: Seq<u8>) {
            text_chunk_fmt::<DET>().lemma_serialize_dps_prepend(value, out);
        }

        proof fn lemma_serialize_dps_len(&self, value: Self::SValue, out: Seq<u8>) {
            text_chunk_fmt::<DET>().lemma_serialize_dps_len(value, out);
        }
    }

    impl<const DET: bool> SPRoundTripDps for TextChunkFmt<DET> {
        proof fn theorem_serialize_dps_parse_roundtrip(&self, value: Self::T, out: Seq<u8>) {
            text_chunk_fmt::<DET>().theorem_serialize_dps_parse_roundtrip(value, out);
        }
    }

    impl NonMalleable for TextChunkFmt<true> {
        proof fn lemma_parse_non_malleable(&self, left: Seq<u8>, right: Seq<u8>) {
            text_chunk_fmt::<true>().lemma_parse_non_malleable(left, right);
        }
    }

    impl<const DET: bool> NoLookAhead for TextChunkFmt<DET> {
        proof fn lemma_no_lookahead(&self, left: Seq<u8>, right: Seq<u8>) {
            text_chunk_fmt::<DET>().lemma_no_lookahead(left, right);
        }
    }

    impl<const DET: bool> EquivSerializersGeneral for TextChunkFmt<DET> {
        proof fn lemma_serialize_equiv(&self, value: Self::SVal, out: Seq<u8>) {
            text_chunk_fmt::<DET>().lemma_serialize_equiv(value, out);
        }
    }

    impl<const DET: bool> EquivSerializers for TextChunkFmt<DET> {
        proof fn lemma_serialize_equiv_on_empty(&self, value: Self::SVal) {
            text_chunk_fmt::<DET>().lemma_serialize_equiv_on_empty(value);
        }
    }

}

} // verus!