wechat-media 2.4.2

Image inspection and decoding support for agent-wechat
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
use anyhow::{ensure, Result};
use image::{AnimationDecoder, ImageDecoder};
use serde::{Deserialize, Serialize};
use std::io::Cursor;

#[derive(Clone, Serialize, Deserialize, Debug)]
pub struct ImageInspection {
    pub content_type: String,
    pub width: u32,
    pub height: u32,
    pub frames: u32,
    pub animation_preserved: bool,
}

// JPEG segments can contain marker-shaped bytes, and scan data escapes them.
// Walk the framing so an EOI inside metadata cannot disguise truncation. Bytes
// after the actual EOI are permitted; received photos can include a trailer.
fn jpeg_has_end_marker(bytes: &[u8]) -> bool {
    if !bytes.starts_with(&[0xff, 0xd8]) {
        return false;
    }
    let mut position = 2;
    let mut in_scan = false;
    let mut saw_scan = false;
    while position < bytes.len() {
        if in_scan {
            while bytes.get(position).is_some_and(|b| *b != 0xff) {
                position += 1;
            }
        }
        if bytes.get(position) != Some(&0xff) {
            return false;
        }
        while bytes.get(position) == Some(&0xff) {
            position += 1;
        }
        let Some(&marker) = bytes.get(position) else {
            return false;
        };
        position += 1;
        match marker {
            0x00 | 0xd0..=0xd7 if in_scan => continue,
            0xd9 => return saw_scan,
            0x00 | 0xd0..=0xd8 => return false,
            0x01 => continue,
            _ => {
                let Some(length) = bytes.get(position..position + 2) else {
                    return false;
                };
                let length = u16::from_be_bytes([length[0], length[1]]) as usize;
                if length < 2 || position + length > bytes.len() {
                    return false;
                }
                position += length;
                if marker == 0xda {
                    saw_scan = true;
                    in_scan = true;
                } else if marker != 0xdc {
                    in_scan = false;
                }
            }
        }
    }
    false
}

fn gif_sub_blocks_end(bytes: &[u8], mut position: usize) -> Option<usize> {
    loop {
        let length = *bytes.get(position)? as usize;
        position = position.checked_add(1 + length)?;
        if position > bytes.len() {
            return None;
        }
        if length == 0 {
            return Some(position);
        }
    }
}

// A ';' inside a palette, extension or compressed frame is not the trailer.
// Follow block lengths; any bytes after the actual trailer stay in the source.
fn gif_has_trailer(bytes: &[u8]) -> bool {
    if bytes.len() < 13 || ![b"GIF87a", b"GIF89a"].iter().any(|h| bytes.starts_with(*h)) {
        return false;
    }
    let palette_size = |packed: u8| {
        if packed & 0x80 != 0 {
            3 * (2usize << (packed & 7))
        } else {
            0
        }
    };
    let mut position = 13 + palette_size(bytes[10]);
    while let Some(&block) = bytes.get(position) {
        position += 1;
        match block {
            0x3b => return true,
            0x21 => {
                if bytes.get(position).is_none() {
                    return false;
                }
                position += 1; // Extension label; its contents use sub-blocks.
            }
            0x2c => {
                let Some(descriptor) = bytes.get(position..position + 9) else {
                    return false;
                };
                position += 9 + palette_size(descriptor[8]);
                if bytes.get(position).is_none() {
                    return false;
                }
                position += 1; // LZW minimum code size, before data sub-blocks.
            }
            _ => return false,
        }
        let Some(end) = gif_sub_blocks_end(bytes, position) else {
            return false;
        };
        position = end;
    }
    false
}

fn png_has_end_chunk(bytes: &[u8]) -> bool {
    if !bytes.starts_with(b"\x89PNG\r\n\x1a\n") {
        return false;
    }
    let mut position: usize = 8;
    while let Some(header) = bytes.get(position..position + 8) {
        let length = u32::from_be_bytes(header[..4].try_into().unwrap()) as usize;
        let Some(end) = position.checked_add(12).and_then(|n| n.checked_add(length)) else {
            return false;
        };
        if end > bytes.len() {
            return false;
        }
        if &header[4..8] == b"IEND" {
            // The decoder can finish the pixels before consuming IEND. Require
            // its zero-length chunk and fixed CRC without trimming the source.
            return length == 0 && bytes[end - 4..end] == [0xae, 0x42, 0x60, 0x82];
        }
        position = end;
    }
    false
}

/// Largest JPEG accepted for inspection: one ordinary image transfer.
const MAX_JPEG_BYTES: usize = 25 * 1024 * 1024 - 17;
/// JPEGs above this many pixels are checked with a reduced-resolution decode.
const FULL_DECODE_PIXELS: u64 = 16_777_216;

/// Inspect a still JPEG of up to 8,192 pixels per edge and 64 million pixels,
/// the size of an unchanged camera original. Every scan is decoded; photos
/// above [`FULL_DECODE_PIXELS`] decode at one-eighth scale so checking one does
/// not allocate the full pixel buffer.
fn inspect_jpeg(bytes: &[u8]) -> Result<ImageInspection> {
    ensure!(bytes.len() <= MAX_JPEG_BYTES, "image_size_limit");
    ensure!(jpeg_has_end_marker(bytes), "jpeg_trailer_missing");
    let failed = || anyhow::anyhow!("image_decode_failed");
    let (width, height) =
        image::ImageReader::with_format(Cursor::new(bytes), image::ImageFormat::Jpeg)
            .into_dimensions()
            .map_err(|_| failed())?;
    let pixels = u64::from(width) * u64::from(height);
    ensure!(
        width > 0 && height > 0 && width <= 8192 && height <= 8192 && pixels <= 64_000_000,
        "image_decode_limit"
    );
    if pixels <= FULL_DECODE_PIXELS {
        let mut reader =
            image::ImageReader::with_format(Cursor::new(bytes), image::ImageFormat::Jpeg);
        let mut limits = image::Limits::default();
        limits.max_image_width = Some(8192);
        limits.max_image_height = Some(8192);
        limits.max_alloc = Some(64 * 1024 * 1024);
        reader.limits(limits);
        let decoded = reader.decode().map_err(|_| failed())?;
        ensure!(
            (decoded.width(), decoded.height()) == (width, height),
            "image_decode_failed"
        );
    } else {
        let mut decoder = jpeg_decoder::Decoder::new(Cursor::new(bytes));
        decoder.set_max_decoding_buffer_size(128 * 1024 * 1024);
        decoder.read_info().map_err(|_| failed())?;
        let info = decoder.info().ok_or_else(failed)?;
        ensure!(
            (u32::from(info.width), u32::from(info.height)) == (width, height),
            "image_decode_failed"
        );
        ensure!(
            matches!(
                info.pixel_format,
                jpeg_decoder::PixelFormat::L8 | jpeg_decoder::PixelFormat::RGB24
            ),
            "image_format_unsupported"
        );
        decoder.scale(1, 1).map_err(|_| failed())?;
        decoder.decode().map_err(|_| failed())?;
    }
    Ok(ImageInspection {
        content_type: "image/jpeg".into(),
        width,
        height,
        frames: 1,
        animation_preserved: false,
    })
}

pub(crate) fn inspect_standard_image(bytes: &[u8]) -> Result<ImageInspection> {
    ensure!(!bytes.is_empty(), "image_size_limit");
    let format =
        image::guess_format(bytes).map_err(|_| anyhow::anyhow!("image_format_unsupported"))?;
    if format == image::ImageFormat::Jpeg {
        return inspect_jpeg(bytes);
    }
    ensure!(bytes.len() <= 16 * 1024 * 1024, "image_size_limit");
    let limits = || {
        let mut l = image::Limits::default();
        l.max_image_width = Some(4096);
        l.max_image_height = Some(4096);
        l.max_alloc = Some(64 * 1024 * 1024);
        l
    };
    let mut frames = 0u32;
    let mut total = 0u64;
    let mut width = 0;
    let mut height = 0;
    let mut count = |frame: image::ImageResult<image::Frame>| -> Result<()> {
        let f = frame.map_err(|_| anyhow::anyhow!("image_decode_failed"))?;
        let (w, h) = f.buffer().dimensions();
        ensure!(
            w > 0 && h > 0 && w as u64 * h as u64 <= 4_000_000,
            "image_decode_limit"
        );
        total += w as u64 * h as u64;
        frames += 1;
        ensure!(frames <= 500 && total <= 100_000_000, "image_decode_limit");
        width = width.max(w);
        height = height.max(h);
        Ok(())
    };
    let mime = match format {
        image::ImageFormat::Gif => {
            ensure!(gif_has_trailer(bytes), "gif_trailer_missing");
            let mut decoder = image::codecs::gif::GifDecoder::new(Cursor::new(bytes))?;
            decoder.set_limits(limits())?;
            for frame in decoder.into_frames() {
                count(frame)?;
            }
            "image/gif"
        }
        image::ImageFormat::WebP => {
            let encoded_length = bytes
                .get(4..8)
                .map(|b| u32::from_le_bytes(b.try_into().unwrap()) as u64 + 8)
                .and_then(|n| usize::try_from(n).ok())
                .filter(|n| *n >= 12 && *n <= bytes.len())
                .ok_or_else(|| anyhow::anyhow!("webp_length_invalid"))?;
            // The RIFF boundary limits decoding, not the retained source bytes.
            // https://developers.google.com/speed/webp/docs/riff_container
            ensure!(encoded_length % 2 == 0, "webp_length_invalid");
            let mut decoder =
                image::codecs::webp::WebPDecoder::new(Cursor::new(&bytes[..encoded_length]))?;
            decoder.set_limits(limits())?;
            if decoder.has_animation() {
                for frame in decoder.into_frames() {
                    count(frame)?;
                }
            } else {
                let (w, h) = decoder.dimensions();
                ensure!(
                    w > 0 && h > 0 && w as u64 * h as u64 <= 4_000_000,
                    "image_decode_limit"
                );
                image::DynamicImage::from_decoder(decoder)
                    .map_err(|_| anyhow::anyhow!("image_decode_failed"))?;
                width = w;
                height = h;
                frames = 1;
            }
            "image/webp"
        }
        image::ImageFormat::Png => {
            ensure!(png_has_end_chunk(bytes), "png_trailer_missing");
            let mut reader = image::ImageReader::with_format(Cursor::new(bytes), format);
            reader.limits(limits());
            let decoded = reader
                .decode()
                .map_err(|_| anyhow::anyhow!("image_decode_failed"))?;
            width = decoded.width();
            height = decoded.height();
            ensure!(
                width > 0 && height > 0 && width as u64 * height as u64 <= 16_777_216,
                "image_decode_limit"
            );
            frames = 1;
            "image/png"
        }
        _ => anyhow::bail!("image_format_unsupported"),
    };
    ensure!(frames > 0, "image_no_frames");
    Ok(ImageInspection {
        content_type: mime.into(),
        width,
        height,
        frames,
        animation_preserved: frames > 1,
    })
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::inspect_image;
    #[test]
    fn png_is_fully_decoded_and_truncation_fails() {
        let mut bytes = std::io::Cursor::new(vec![]);
        image::DynamicImage::new_rgb8(8, 8)
            .write_to(&mut bytes, image::ImageFormat::Png)
            .unwrap();
        let good = bytes.into_inner();
        assert_eq!(inspect_image(&good).unwrap().frames, 1);
        for length in [20, good.len() - 12, good.len() - 1] {
            assert!(
                inspect_image(&good[..length]).is_err(),
                "accepted PNG truncated to {length}"
            );
        }
        let mut missing_end = good[..good.len() - 12].to_vec();
        missing_end.extend_from_slice(&12u32.to_be_bytes());
        missing_end.extend_from_slice(b"tEXt");
        missing_end.extend_from_slice(&good[good.len() - 12..]);
        missing_end.extend_from_slice(&[0; 4]);
        assert_eq!(
            inspect_image(&missing_end).unwrap_err().to_string(),
            "png_trailer_missing"
        );
    }

    fn still_image(format: image::ImageFormat) -> Vec<u8> {
        let mut out = Cursor::new(Vec::new());
        image::DynamicImage::new_rgb8(8, 8)
            .write_to(&mut out, format)
            .unwrap();
        out.into_inner()
    }

    #[test]
    fn non_jpeg_images_with_appended_data_retain_source_bytes() {
        for (format, mime) in [
            (image::ImageFormat::Png, "image/png"),
            (image::ImageFormat::Gif, "image/gif"),
            (image::ImageFormat::WebP, "image/webp"),
        ] {
            let mut bytes = still_image(format);
            bytes.extend_from_slice(b"synthetic-opaque-trailer!");
            let original = bytes.clone();
            let inspection = inspect_image(&bytes).unwrap_or_else(|e| panic!("{format:?}: {e}"));
            assert_eq!(inspection.content_type, mime);
            assert_eq!((inspection.width, inspection.height), (8, 8));
            assert_eq!(bytes, original);
        }
    }

    #[test]
    fn webp_declared_boundary_cannot_use_bytes_outside_riff() {
        let good = still_image(image::ImageFormat::WebP);
        assert_eq!(inspect_image(&good).unwrap().content_type, "image/webp");
        assert!(inspect_image(&good[..good.len() - 1]).is_err());
        let mut short_boundary = good;
        short_boundary[4..8].copy_from_slice(&4u32.to_le_bytes());
        assert!(inspect_image(&short_boundary).is_err());
        short_boundary[4..8].copy_from_slice(&u32::MAX.to_le_bytes());
        assert!(inspect_image(&short_boundary).is_err());
    }

    #[test]
    fn animated_webp_keeps_all_frames_with_appended_data() {
        let mut bytes = include_bytes!("../tests/fixtures/two-frame.webp").to_vec();
        let plain = inspect_image(&bytes).unwrap();
        assert_eq!(plain.frames, 2);
        assert!(plain.animation_preserved);
        bytes.extend_from_slice(b"extra-source-data");
        let original = bytes.clone();
        let inspected = inspect_image(&bytes).unwrap();
        assert_eq!(inspected.frames, 2);
        assert_eq!((inspected.width, inspected.height), (12, 8));
        assert!(inspected.animation_preserved);
        assert_eq!(bytes, original);
    }

    #[test]
    fn gif_animation_and_real_trailer_are_checked_separately() {
        let mut bytes = Vec::new();
        {
            let mut encoder = image::codecs::gif::GifEncoder::new(&mut bytes);
            encoder
                .encode_frames([
                    image::Frame::new(image::RgbaImage::from_pixel(
                        8,
                        8,
                        image::Rgba([0, 0, 0, 255]),
                    )),
                    image::Frame::new(image::RgbaImage::from_pixel(
                        8,
                        8,
                        image::Rgba([255, 0, 0, 255]),
                    )),
                ])
                .unwrap();
        }
        let complete_length = bytes.len();
        assert_eq!(bytes.last(), Some(&b';'));
        bytes.extend_from_slice(b"opaque-appended-data");
        let result = inspect_image(&bytes).unwrap();
        assert_eq!(result.frames, 2);
        assert!(result.animation_preserved);

        // A marker-shaped byte in a comment is not the stream's trailer.
        let mut missing_trailer = bytes[..complete_length - 1].to_vec();
        missing_trailer.extend_from_slice(&[0x21, 0xfe, 1, b';', 0]);
        assert_eq!(
            inspect_image(&missing_trailer).unwrap_err().to_string(),
            "gif_trailer_missing"
        );
        // A truncated comment cannot be skipped just because it contains ';'.
        missing_trailer.truncate(missing_trailer.len() - 1);
        assert!(inspect_image(&missing_trailer).is_err());
    }

    fn jpeg() -> Vec<u8> {
        let mut bytes = Cursor::new(vec![]);
        image::DynamicImage::new_rgb8(8, 8)
            .write_to(&mut bytes, image::ImageFormat::Jpeg)
            .unwrap();
        bytes.into_inner()
    }

    #[test]
    fn jpeg_originals_larger_than_other_formats_are_inspected() {
        let encode = |width, height, format| {
            let mut bytes = Cursor::new(vec![]);
            image::DynamicImage::new_rgb8(width, height)
                .write_to(&mut bytes, format)
                .unwrap();
            bytes.into_inner()
        };
        // Past the 4,096-pixel edge, then past the full-decode pixel count.
        for (width, height) in [(5000, 16), (8192, 2064)] {
            let inspection = inspect_image(&encode(width, height, image::ImageFormat::Jpeg));
            let inspection = inspection.unwrap();
            assert_eq!((inspection.width, inspection.height), (width, height));
            assert_eq!(inspection.content_type, "image/jpeg");
        }
        let too_wide = encode(8193, 16, image::ImageFormat::Jpeg);
        assert!(inspect_image(&too_wide).is_err());
        let mut truncated = encode(8192, 2064, image::ImageFormat::Jpeg);
        truncated.truncate(truncated.len() / 2);
        assert!(inspect_image(&truncated).is_err());
        assert!(inspect_image(&encode(5000, 16, image::ImageFormat::Png)).is_err());
    }
    #[test]
    fn jpeg_with_trailing_data_decodes_without_changing_source_bytes() {
        let mut bytes = jpeg();
        let checksum = <md5::Md5 as md5::Digest>::digest(&bytes);
        bytes.extend_from_slice(&0x12345678u64.to_le_bytes());
        bytes.extend_from_slice(&checksum);
        let original = bytes.clone();
        let inspected = inspect_image(&bytes).unwrap();
        assert_eq!(inspected.content_type, "image/jpeg");
        assert_eq!(
            (inspected.width, inspected.height, inspected.frames),
            (8, 8, 1)
        );
        assert_eq!(bytes, original);
    }

    #[test]
    fn progressive_jpeg_multiple_scans_allow_trailing_data() {
        let mut bytes = include_bytes!("../tests/fixtures/progressive.jpg").to_vec();
        bytes.extend_from_slice(b"synthetic-photo-trailer!");
        let inspected = inspect_image(&bytes).unwrap();
        assert_eq!((inspected.width, inspected.height), (16, 12));
        assert_eq!(inspected.content_type, "image/jpeg");
        let end = bytes.len() - 24 - 2;
        assert!(!jpeg_has_end_marker(&bytes[..end]));
    }

    #[test]
    fn jpeg_end_marker_inside_metadata_does_not_hide_truncation() {
        let image = jpeg();
        let mut bytes = vec![0xff, 0xd8, 0xff, 0xfe, 0, 6, 0x11, 0xff, 0xd9, 0x22];
        bytes.extend_from_slice(&image[2..]);
        assert!(inspect_image(&bytes).is_ok());
        bytes.truncate(bytes.len() - 2);
        assert_eq!(
            inspect_image(&bytes).unwrap_err().to_string(),
            "jpeg_trailer_missing"
        );
        bytes[4..6].copy_from_slice(&u16::MAX.to_be_bytes());
        bytes.extend_from_slice(&[0xff, 0xd9]);
        assert!(!jpeg_has_end_marker(&bytes));
    }

    #[test]
    fn jpeg_scan_stuffing_and_restart_markers_are_not_end_markers() {
        let bytes = [
            0xff, 0xd8, 0xff, 0xda, 0, 2, 7, 0xff, 0, 0xd9, 0xff, 0xd0, 9, 0xff,
        ];
        assert!(!jpeg_has_end_marker(&bytes));
        let mut complete = bytes.to_vec();
        complete.push(0xd9);
        assert!(jpeg_has_end_marker(&complete));
    }
}