shiguredo_http2 2026.1.0-canary.2

Sans I/O HTTP/2 Library
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
//! HTTP/2 フレームデコーダー

use crate::error::{Error, ErrorCode, Result};
use crate::frame::{
    CONNECTION_STREAM_ID, ContinuationFrame, DataFrame, FRAME_HEADER_SIZE, Frame, FrameFlags,
    FrameHeader, FrameType, GoawayFrame, HeadersFrame, PingFrame, PriorityFields, PriorityFrame,
    PriorityUpdateFrame, RstStreamFrame, SettingsFrame, WindowUpdateFrame,
};
use crate::settings::Setting;

/// フレームデコーダー
///
/// ストリーミング方式でフレームをデコードする。
#[derive(Debug)]
pub struct FrameDecoder {
    /// 最大フレームサイズ
    max_frame_size: u32,
    /// 内部バッファ
    buf: Vec<u8>,
    /// 現在パース中のフレームヘッダー
    current_header: Option<FrameHeader>,
    /// 最後にデコード試行したフレームのストリーム ID
    /// ストリームエラー時に RST_STREAM の送信先を特定するために使用する
    last_decoded_stream_id: Option<u32>,
}

impl FrameDecoder {
    /// 新しい `FrameDecoder` を生成する
    #[must_use]
    pub fn new(max_frame_size: u32) -> Self {
        Self {
            max_frame_size,
            buf: Vec::new(),
            current_header: None,
            last_decoded_stream_id: None,
        }
    }

    /// 最大フレームサイズを更新する
    pub fn set_max_frame_size(&mut self, max_frame_size: u32) {
        self.max_frame_size = max_frame_size;
    }

    /// データを入力バッファに追加する
    pub fn feed(&mut self, data: &[u8]) {
        self.buf.extend_from_slice(data);
    }

    /// フレームをデコードする
    ///
    /// 完全なフレームがデコードできた場合は `Ok(Some(frame))` を返す。
    /// データが不足している場合は `Ok(None)` を返す。
    /// デコードエラーの場合は `Err` を返す。
    pub fn decode(&mut self) -> Result<Option<Frame>> {
        // ヘッダーをまだ読んでいない場合
        if self.current_header.is_none() {
            if self.buf.len() < FRAME_HEADER_SIZE {
                return Ok(None);
            }

            let header = decode_header(&self.buf[..FRAME_HEADER_SIZE])?;

            // フレームサイズチェック
            if header.length > self.max_frame_size {
                return Err(Error::frame_size_error(format!(
                    "frame size {} exceeds max frame size {}",
                    header.length, self.max_frame_size
                )));
            }

            self.current_header = Some(header);
            self.buf.drain(..FRAME_HEADER_SIZE);
        }

        // ここに到達する時点で current_header は必ず Some (上の分岐で設定済み)
        let header = self
            .current_header
            .as_ref()
            .expect("current_header must be set");
        let payload_len = header.length as usize;

        // ペイロードが揃うまで待つ
        if self.buf.len() < payload_len {
            return Ok(None);
        }

        let header = self
            .current_header
            .take()
            .expect("current_header must be set");
        self.last_decoded_stream_id = Some(header.stream_id);
        let payload: Vec<u8> = self.buf.drain(..payload_len).collect();

        decode_frame(header, &payload).map(Some)
    }

    /// 内部バッファの残りデータ長を取得する
    #[must_use]
    pub fn buffered_len(&self) -> usize {
        self.buf.len()
    }

    /// 最後にデコード試行したフレームのストリーム ID を返す
    ///
    /// ストリームエラー発生時に RST_STREAM の送信先を特定するために使用する。
    #[must_use]
    pub fn last_decoded_stream_id(&self) -> Option<u32> {
        self.last_decoded_stream_id
    }

    /// 内部バッファをクリアする
    pub fn clear(&mut self) {
        self.buf.clear();
        self.current_header = None;
    }
}

impl Default for FrameDecoder {
    fn default() -> Self {
        Self::new(crate::settings::DEFAULT_MAX_FRAME_SIZE)
    }
}

/// フレームヘッダーをデコードする
///
/// # Errors
///
/// バッファが 9 バイト未満の場合は `Err` を返す。
pub fn decode_header(buf: &[u8]) -> Result<FrameHeader> {
    if buf.len() < FRAME_HEADER_SIZE {
        return Err(Error::incomplete());
    }

    // Length (24 bits)
    let length = (u32::from(buf[0]) << 16) | (u32::from(buf[1]) << 8) | u32::from(buf[2]);

    // Type (8 bits)
    let frame_type = buf[3];

    // Flags (8 bits)
    let flags = FrameFlags::from_bits(buf[4]);

    // Stream ID (31 bits)
    let stream_id = ((u32::from(buf[5]) & 0x7f) << 24)
        | (u32::from(buf[6]) << 16)
        | (u32::from(buf[7]) << 8)
        | u32::from(buf[8]);

    Ok(FrameHeader {
        length,
        frame_type,
        flags,
        stream_id,
    })
}

/// フレームをデコードする
fn decode_frame(header: FrameHeader, payload: &[u8]) -> Result<Frame> {
    match FrameType::from_u8(header.frame_type) {
        Some(FrameType::Data) => decode_data(header, payload),
        Some(FrameType::Headers) => decode_headers(header, payload),
        Some(FrameType::Priority) => decode_priority(header, payload),
        Some(FrameType::RstStream) => decode_rst_stream(header, payload),
        Some(FrameType::Settings) => decode_settings(header, payload),
        Some(FrameType::PushPromise) => decode_push_promise(header, payload),
        Some(FrameType::Ping) => decode_ping(header, payload),
        Some(FrameType::Goaway) => decode_goaway(header, payload),
        Some(FrameType::WindowUpdate) => decode_window_update(header, payload),
        Some(FrameType::Continuation) => decode_continuation(header, payload),
        Some(FrameType::PriorityUpdate) => decode_priority_update(header, payload),
        None => Ok(Frame::Unknown {
            header,
            payload: payload.to_vec(),
        }),
    }
}

/// DATA フレームをデコードする
fn decode_data(header: FrameHeader, payload: &[u8]) -> Result<Frame> {
    // DATA フレームはストリーム ID が 0 であってはならない
    if header.stream_id == CONNECTION_STREAM_ID {
        return Err(Error::protocol_error("DATA frame with stream ID 0"));
    }

    let end_stream = header.flags.is_end_stream();
    let padded = header.flags.is_padded();

    let (data, pad_length) = if padded {
        if payload.is_empty() {
            return Err(Error::frame_size_error(
                "PADDED flag set but no padding length",
            ));
        }
        let pad_len = payload[0] as usize;
        if payload.len() < 1 + pad_len {
            return Err(Error::protocol_error(
                "padding length exceeds frame payload",
            ));
        }
        (
            payload[1..payload.len() - pad_len].to_vec(),
            Some(payload[0]),
        )
    } else {
        (payload.to_vec(), None)
    };

    Ok(Frame::Data(DataFrame {
        stream_id: header.stream_id,
        end_stream,
        data,
        pad_length,
    }))
}

/// HEADERS フレームをデコードする
fn decode_headers(header: FrameHeader, payload: &[u8]) -> Result<Frame> {
    // HEADERS フレームはストリーム ID が 0 であってはならない
    if header.stream_id == CONNECTION_STREAM_ID {
        return Err(Error::protocol_error("HEADERS frame with stream ID 0"));
    }

    let end_stream = header.flags.is_end_stream();
    let end_headers = header.flags.is_end_headers();
    let padded = header.flags.is_padded();
    let priority = header.flags.is_priority();

    let mut offset = 0;
    let mut data_end = payload.len();
    let mut pad_length = None;

    if padded {
        if payload.is_empty() {
            return Err(Error::frame_size_error(
                "PADDED flag set but no padding length",
            ));
        }
        let pad_len = payload[0] as usize;
        pad_length = Some(payload[0]);
        offset = 1;
        if payload.len() < 1 + pad_len {
            return Err(Error::protocol_error(
                "padding length exceeds frame payload",
            ));
        }
        data_end = payload.len() - pad_len;
    }

    // PRIORITY フラグが設定されている場合、5 バイトの優先度フィールドをパース
    // RFC 9113 Section 6.2: 非推奨だが相互運用性のため処理する
    let priority_fields = if priority {
        if data_end - offset < 5 {
            return Err(Error::frame_size_error(
                "PRIORITY flag set but insufficient data for priority fields",
            ));
        }
        let exclusive = (payload[offset] & 0x80) != 0;
        let stream_dependency = ((u32::from(payload[offset]) & 0x7f) << 24)
            | (u32::from(payload[offset + 1]) << 16)
            | (u32::from(payload[offset + 2]) << 8)
            | u32::from(payload[offset + 3]);
        let weight = payload[offset + 4];
        offset += 5;
        Some(PriorityFields {
            exclusive,
            stream_dependency,
            weight,
        })
    } else {
        None
    };

    let header_block_fragment = payload[offset..data_end].to_vec();

    Ok(Frame::Headers(HeadersFrame {
        stream_id: header.stream_id,
        end_stream,
        end_headers,
        priority_fields,
        header_block_fragment,
        pad_length,
    }))
}

/// PRIORITY フレームをデコードする
///
/// # 非推奨 (Deprecated)
///
/// RFC 9113 で優先度シグナリングは非推奨となった。
/// 相互運用性のため受信は処理するが、優先度制御には使用しない。
fn decode_priority(header: FrameHeader, payload: &[u8]) -> Result<Frame> {
    // PRIORITY フレームはストリーム ID が 0 であってはならない
    if header.stream_id == CONNECTION_STREAM_ID {
        return Err(Error::protocol_error("PRIORITY frame with stream ID 0"));
    }

    // RFC 9113 Section 6.3: PRIORITY フレームは常に 5 バイト。
    // 長さが異なる場合はストリームエラーの FRAME_SIZE_ERROR として扱う。
    if payload.len() != 5 {
        return Err(Error::stream_error(
            crate::error::ErrorCode::FrameSizeError,
            "PRIORITY frame must be 5 bytes",
        ));
    }

    let exclusive = (payload[0] & 0x80) != 0;
    let stream_dependency = ((u32::from(payload[0]) & 0x7f) << 24)
        | (u32::from(payload[1]) << 16)
        | (u32::from(payload[2]) << 8)
        | u32::from(payload[3]);
    let weight = payload[4];

    Ok(Frame::Priority(PriorityFrame {
        stream_id: header.stream_id,
        exclusive,
        stream_dependency,
        weight,
    }))
}

/// RST_STREAM フレームをデコードする
fn decode_rst_stream(header: FrameHeader, payload: &[u8]) -> Result<Frame> {
    // RST_STREAM フレームはストリーム ID が 0 であってはならない
    if header.stream_id == CONNECTION_STREAM_ID {
        return Err(Error::protocol_error("RST_STREAM frame with stream ID 0"));
    }

    // RST_STREAM フレームは常に 4 バイト
    if payload.len() != 4 {
        return Err(Error::frame_size_error("RST_STREAM frame must be 4 bytes"));
    }

    let error_code = u32::from_be_bytes([payload[0], payload[1], payload[2], payload[3]]);

    Ok(Frame::RstStream(RstStreamFrame {
        stream_id: header.stream_id,
        error_code,
    }))
}

/// SETTINGS フレームをデコードする
fn decode_settings(header: FrameHeader, payload: &[u8]) -> Result<Frame> {
    // SETTINGS フレームはストリーム ID が 0 でなければならない
    if header.stream_id != CONNECTION_STREAM_ID {
        return Err(Error::protocol_error(
            "SETTINGS frame with non-zero stream ID",
        ));
    }

    let ack = header.flags.is_ack();

    // ACK フラグが設定されている場合、ペイロードは空でなければならない
    if ack {
        if !payload.is_empty() {
            return Err(Error::frame_size_error(
                "SETTINGS ACK frame with non-empty payload",
            ));
        }
        return Ok(Frame::Settings(SettingsFrame::ack()));
    }

    // ペイロードは 6 バイトの倍数でなければならない
    if !payload.len().is_multiple_of(6) {
        return Err(Error::frame_size_error(
            "SETTINGS frame payload must be a multiple of 6 bytes",
        ));
    }

    let mut settings = Vec::with_capacity(payload.len() / 6);
    for chunk in payload.chunks(6) {
        let id = u16::from_be_bytes([chunk[0], chunk[1]]);
        let value = u32::from_be_bytes([chunk[2], chunk[3], chunk[4], chunk[5]]);
        settings.push(Setting::new(id, value));
    }

    Ok(Frame::Settings(SettingsFrame {
        ack: false,
        settings,
    }))
}

/// PING フレームをデコードする
fn decode_ping(header: FrameHeader, payload: &[u8]) -> Result<Frame> {
    // PING フレームはストリーム ID が 0 でなければならない
    if header.stream_id != CONNECTION_STREAM_ID {
        return Err(Error::protocol_error("PING frame with non-zero stream ID"));
    }

    // PING フレームは常に 8 バイト
    if payload.len() != 8 {
        return Err(Error::frame_size_error("PING frame must be 8 bytes"));
    }

    let ack = header.flags.is_ack();
    let mut opaque_data = [0u8; 8];
    opaque_data.copy_from_slice(payload);

    Ok(Frame::Ping(PingFrame { ack, opaque_data }))
}

/// GOAWAY フレームをデコードする
fn decode_goaway(header: FrameHeader, payload: &[u8]) -> Result<Frame> {
    // GOAWAY フレームはストリーム ID が 0 でなければならない
    if header.stream_id != CONNECTION_STREAM_ID {
        return Err(Error::protocol_error(
            "GOAWAY frame with non-zero stream ID",
        ));
    }

    // GOAWAY フレームは最低 8 バイト
    if payload.len() < 8 {
        return Err(Error::frame_size_error(
            "GOAWAY frame must be at least 8 bytes",
        ));
    }

    let last_stream_id = ((u32::from(payload[0]) & 0x7f) << 24)
        | (u32::from(payload[1]) << 16)
        | (u32::from(payload[2]) << 8)
        | u32::from(payload[3]);

    let error_code = u32::from_be_bytes([payload[4], payload[5], payload[6], payload[7]]);

    let debug_data = if payload.len() > 8 {
        payload[8..].to_vec()
    } else {
        Vec::new()
    };

    Ok(Frame::Goaway(GoawayFrame {
        last_stream_id,
        error_code,
        debug_data,
    }))
}

/// WINDOW_UPDATE フレームをデコードする
fn decode_window_update(header: FrameHeader, payload: &[u8]) -> Result<Frame> {
    // WINDOW_UPDATE フレームは常に 4 バイト
    if payload.len() != 4 {
        return Err(Error::frame_size_error(
            "WINDOW_UPDATE frame must be 4 bytes",
        ));
    }

    let window_size_increment = ((u32::from(payload[0]) & 0x7f) << 24)
        | (u32::from(payload[1]) << 16)
        | (u32::from(payload[2]) << 8)
        | u32::from(payload[3]);

    // window_size_increment が 0 は無効
    if window_size_increment == 0 {
        if header.stream_id == CONNECTION_STREAM_ID {
            return Err(Error::connection_error(
                ErrorCode::ProtocolError,
                "WINDOW_UPDATE with zero increment on connection",
            ));
        }
        return Err(Error::stream_error(
            ErrorCode::ProtocolError,
            "WINDOW_UPDATE with zero increment on stream",
        ));
    }

    Ok(Frame::WindowUpdate(WindowUpdateFrame {
        stream_id: header.stream_id,
        window_size_increment,
    }))
}

/// CONTINUATION フレームをデコードする
fn decode_continuation(header: FrameHeader, payload: &[u8]) -> Result<Frame> {
    // CONTINUATION フレームはストリーム ID が 0 であってはならない
    if header.stream_id == CONNECTION_STREAM_ID {
        return Err(Error::protocol_error("CONTINUATION frame with stream ID 0"));
    }

    let end_headers = header.flags.is_end_headers();
    let header_block_fragment = payload.to_vec();

    Ok(Frame::Continuation(ContinuationFrame {
        stream_id: header.stream_id,
        end_headers,
        header_block_fragment,
    }))
}

/// PUSH_PROMISE フレームをデコードする (RFC 9113 Section 6.6)
///
/// # 非サポート
///
/// サーバープッシュは主要ブラウザでサポートが削除されているため、
/// このライブラリでは送信機能を提供しない。
/// 受信時はストリーム ID のみ抽出し、connection モジュールでエラー処理する。
fn decode_push_promise(header: FrameHeader, _payload: &[u8]) -> Result<Frame> {
    // PUSH_PROMISE フレームはストリーム ID が 0 であってはならない
    if header.stream_id == CONNECTION_STREAM_ID {
        return Err(Error::protocol_error("PUSH_PROMISE frame with stream ID 0"));
    }

    // ペイロードの詳細なデコードは不要 (エラーを返すため)
    Ok(Frame::PushPromise {
        stream_id: header.stream_id,
    })
}

/// PRIORITY_UPDATE フレームをデコードする (RFC 9218 Section 4)
fn decode_priority_update(header: FrameHeader, payload: &[u8]) -> Result<Frame> {
    // RFC 9218 Section 4: PRIORITY_UPDATE フレームはストリーム ID が 0 でなければならない
    if header.stream_id != CONNECTION_STREAM_ID {
        return Err(Error::protocol_error(
            "PRIORITY_UPDATE frame with non-zero stream ID",
        ));
    }

    // RFC 9218 Section 4: ペイロードは最低 4 バイト (Prioritized Element ID)
    if payload.len() < 4 {
        return Err(Error::frame_size_error(
            "PRIORITY_UPDATE frame must be at least 4 bytes",
        ));
    }

    // Prioritized Element ID (31 bits)
    let prioritized_element_id = ((u32::from(payload[0]) & 0x7f) << 24)
        | (u32::from(payload[1]) << 16)
        | (u32::from(payload[2]) << 8)
        | u32::from(payload[3]);

    // Priority Field Value (残りのバイト)
    let priority_field_value = if payload.len() > 4 {
        payload[4..].to_vec()
    } else {
        Vec::new()
    };

    Ok(Frame::PriorityUpdate(PriorityUpdateFrame {
        prioritized_element_id,
        priority_field_value,
    }))
}