shiguredo_http11 2026.4.0

HTTP/1.1 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
//! HTTP ヘッダー型の定義

use crate::error::{EncodeError, Error};
use crate::status_code::StatusClass;
use crate::validate::{
    is_valid_field_value, is_valid_header_name, is_valid_method, is_valid_protocol_version,
    is_valid_reason_phrase, is_valid_request_target, is_valid_status_code,
};
use alloc::string::String;
use alloc::vec::Vec;

/// HTTP ヘッダー操作のための共通トレイト
pub trait HttpHead {
    /// HTTP バージョンを取得
    fn version(&self) -> &str;

    /// ヘッダーリストを取得
    fn headers(&self) -> &[(String, String)];

    /// ヘッダーを取得 (大文字小文字を区別しない)
    fn get_header(&self, name: &str) -> Option<&str> {
        self.headers()
            .iter()
            .find(|(n, _)| n.eq_ignore_ascii_case(name))
            .map(|(_, v)| v.as_str())
    }

    /// 指定した名前のヘッダーをすべて取得
    fn get_headers(&self, name: &str) -> Vec<&str> {
        self.headers()
            .iter()
            .filter(|(n, _)| n.eq_ignore_ascii_case(name))
            .map(|(_, v)| v.as_str())
            .collect()
    }

    /// ヘッダーが存在するか確認
    fn has_header(&self, name: &str) -> bool {
        self.headers()
            .iter()
            .any(|(n, _)| n.eq_ignore_ascii_case(name))
    }

    /// Connection ヘッダーの値を取得 (RFC 9110 Section 7.6.1)
    ///
    /// 最初の `Connection` ヘッダー値をそのままの `&str` で返す。
    /// カンマ区切りトークンリストの分割は行わない。
    /// 戻り値から自前でトークン分割する場合は `split(',')` を使用すること。
    /// `Connection` ヘッダーが存在しない場合は `None` を返す。
    fn connection(&self) -> Option<&str> {
        self.get_header("Connection")
    }

    /// キープアライブ接続かどうかを判定
    ///
    /// 判定ロジックは `Connection` ヘッダーのトークンリストを評価した後、
    /// プロトコルバージョンにフォールバックする:
    ///
    /// - RFC 9112 Section 9.3: 持続性の判定基準
    /// - RFC 9112 Section 9.6: close connection option の定義
    /// - RFC 9110 Section 7.6.1: Connection ヘッダーの定義
    /// - RFC 9110 Section 5.3: 複数ヘッダー行の結合規則
    ///
    /// 判定順序:
    ///
    /// 1. `Connection` ヘッダーのいずれかに `close` トークンが存在 → `false`
    ///    (`keep-alive` が同時に存在しても `close` が優先される)
    /// 2. `Connection` ヘッダーのいずれかに `keep-alive` トークンが存在 → `true`
    /// 3. それ以外 → `version` が `"HTTP/1.1"` 完全一致のときのみ `true`
    ///
    /// 注: HTTP/1.1 でも `Connection: close` が指定された場合は keep-alive にならない。
    /// HTTP/1.0 で `Connection: keep-alive` がない場合も keep-alive にならない。
    /// 本メソッドは HTTP プロトコルの persistent connection を判定する。RTSP
    /// (RFC 7826) など他プロトコルは persistent connection の意味論が異なるため、
    /// `RTSP/1.1` 等の version 文字列に対しては `Connection` ヘッダーで明示的に
    /// `keep-alive` が指定されない限り `false` を返す。RTSP の persistent
    /// connection 判定は上位層の責務である。
    /// RFC 9112 Section 9.3 の HTTP/1.0 keep-alive 持続に含まれる proxy 条件
    /// (recipient is not a proxy OR message is a response) は本メソッドでは区別しない。
    /// これは上位層の責務である。
    fn is_keep_alive(&self) -> bool {
        let mut has_keep_alive = false;
        // get_headers() を使わず headers().iter() で直接走査し allocation を回避する
        for (name, value) in self.headers() {
            if !name.eq_ignore_ascii_case("Connection") {
                continue;
            }
            // カンマ区切りトークンリストとして解析
            // close トークンがあれば即座に false (close 優先)
            for token in value.split(',') {
                let token = token.trim();
                if token.eq_ignore_ascii_case("close") {
                    return false;
                }
                if token.eq_ignore_ascii_case("keep-alive") {
                    has_keep_alive = true;
                }
            }
        }

        if has_keep_alive {
            return true;
        }
        // HTTP/1.1 完全一致のみ persistent をデフォルトとする。
        // `ends_with("/1.1")` だと `RTSP/1.1` / `FOO/1.1` のような他プロトコルで
        // 誤って persistent 判定する経路が生じるため厳格化する。
        self.version() == "HTTP/1.1"
    }

    /// Content-Length ヘッダーの値を取得
    /// (RFC 9110 Section 8.6 / RFC 9112 Section 6.2)
    ///
    /// decoder 本体の `parse_content_length` を再利用し、OWS / カンマリスト /
    /// 複数行 / mismatched 値の解釈を decoder と統一する。
    ///
    /// 戻り値:
    /// - `Ok(None)`: `Content-Length` ヘッダーが存在しない
    /// - `Ok(Some(n))`: 単一値、または複数行で同値マージされた値
    /// - `Err(Error::InvalidData(...))`: 構文不正、mismatched 値、OWS 違反など
    ///   (HTTP Request Smuggling の兆候、呼出側は接続をクローズすべき)
    fn content_length(&self) -> Result<Option<u64>, Error> {
        crate::decoder::body::parse_content_length(self.headers())
    }

    /// Transfer-Encoding の最後が chunked かどうかを判定
    ///
    /// RFC 9112 Section 6.3: Transfer-Encoding の最後のエンコーディングが chunked
    /// であればメッセージボディは chunked フレーミングで転送される。
    ///
    /// `Transfer-Encoding: gzip, chunked` → true (最後が chunked)
    /// `Transfer-Encoding: chunked, gzip` → false (最後が chunked でない)
    /// `Transfer-Encoding: chunked` → true
    ///
    /// RFC 9110 Section 5.3: 複数の同名ヘッダーは結合して単一のリストとして扱う。
    fn is_chunked(&self) -> bool {
        let mut last_token: Option<&str> = None;
        // get_headers() を使わず headers().iter() で直接走査し allocation を回避する
        for (name, value) in self.headers() {
            if !name.eq_ignore_ascii_case("Transfer-Encoding") {
                continue;
            }
            for token in value.split(',') {
                let token = token.trim();
                if !token.is_empty() {
                    last_token = Some(token);
                }
            }
        }
        last_token.is_some_and(|t| t.eq_ignore_ascii_case("chunked"))
    }
}

/// リクエストヘッダー(ボディなし)
///
/// `RequestDecoder::decode_headers` の戻り値として返される、デコード済みの
/// リクエストヘッダーを表す。フィールドは非公開で、`new` / `with_version` /
/// `header` 等のバリデート付き API 経由でのみ構築できる。
///
/// `#[non_exhaustive]` を付与しているため、将来のフィールド追加は非破壊的に扱える。
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub struct RequestHead {
    /// HTTP メソッド (GET, POST, etc.)
    pub(crate) method: String,
    /// リクエスト URI
    pub(crate) uri: String,
    /// HTTP バージョン (HTTP/1.1 等)
    pub(crate) version: String,
    /// ヘッダー
    pub(crate) headers: Vec<(String, String)>,
}

impl RequestHead {
    /// 新しい `RequestHead` を HTTP/1.1 で作成する (バリデート付き)
    ///
    /// テスト用途や、別経路で受信したヘッダー情報から `RequestHead` を構築したい
    /// 場合に利用する。`RequestDecoder` 経由で得た `RequestHead` には呼び出す
    /// 必要はない。
    pub fn new(method: &str, uri: &str) -> Result<Self, EncodeError> {
        Self::with_version(method, uri, "HTTP/1.1")
    }

    /// 新しい `RequestHead` をバージョン指定付きで作成する (バリデート付き)
    pub fn with_version(method: &str, uri: &str, version: &str) -> Result<Self, EncodeError> {
        if !is_valid_method(method) {
            return Err(EncodeError::InvalidMethod {
                method: method.into(),
            });
        }
        if !is_valid_request_target(uri) {
            return Err(EncodeError::InvalidRequestTarget { uri: uri.into() });
        }
        if !is_valid_protocol_version(version) {
            return Err(EncodeError::InvalidVersion {
                version: version.into(),
            });
        }
        Ok(Self {
            method: method.into(),
            uri: uri.into(),
            version: version.into(),
            headers: Vec::new(),
        })
    }

    /// ヘッダーを追加する (バリデート付き、ビルダー)
    pub fn header(mut self, name: &str, value: &str) -> Result<Self, EncodeError> {
        self.add_header(name, value)?;
        Ok(self)
    }

    /// ヘッダーを追加する (バリデート付き、可変借用)
    pub fn add_header(&mut self, name: &str, value: &str) -> Result<&mut Self, EncodeError> {
        if !is_valid_header_name(name) {
            return Err(EncodeError::InvalidHeaderName { name: name.into() });
        }
        if !is_valid_field_value(value) {
            return Err(EncodeError::InvalidHeaderValue {
                name: name.into(),
                value: value.into(),
            });
        }
        self.headers.push((name.into(), value.into()));
        Ok(self)
    }

    /// HTTP メソッドを取得
    #[must_use]
    pub fn method(&self) -> &str {
        &self.method
    }

    /// リクエスト URI を取得
    #[must_use]
    pub fn uri(&self) -> &str {
        &self.uri
    }

    /// HTTP プロトコルバージョンを取得 (例: `"HTTP/1.1"`)。
    ///
    /// RFC 9112 Section 2.3 HTTP-version。
    #[must_use]
    pub fn version(&self) -> &str {
        &self.version
    }

    /// ヘッダーリストを取得。
    ///
    /// RFC 9110 Section 5。順序は受信順を保持する。
    #[must_use]
    pub fn headers(&self) -> &[(String, String)] {
        &self.headers
    }

    /// `RequestDecoder` 内部からの構築用 (バリデーションスキップ)
    ///
    /// `RequestDecoder::decode_headers` は start-line / ヘッダーをデコード時に
    /// 各フィールドをバリデート済み (`is_valid_method` / `is_valid_request_target` /
    /// `is_valid_protocol_version` / `is_valid_header_name` / `is_valid_field_value`)
    /// であるため、ここで再検証は不要。
    ///
    /// 命名は標準ライブラリの unsafe 慣習 (`Vec::from_raw_parts` 等) と表面的に
    /// 衝突するが、本関数は unsafe ではない (整合性責任が呼出側にある点だけが
    /// 共通)。
    #[cfg(debug_assertions)]
    pub(crate) fn from_validated_parts(
        method: String,
        uri: String,
        version: String,
        headers: Vec<(String, String)>,
    ) -> Self {
        debug_assert!(is_valid_method(&method), "method must be valid token");
        debug_assert!(
            is_valid_request_target(&uri),
            "uri must be valid request-target"
        );
        debug_assert!(
            is_valid_protocol_version(&version),
            "version must be valid HTTP-version"
        );
        for (name, value) in &headers {
            debug_assert!(
                is_valid_header_name(name),
                "header name must be valid token"
            );
            debug_assert!(is_valid_field_value(value), "header value must be valid");
        }
        Self {
            method,
            uri,
            version,
            headers,
        }
    }

    #[cfg(not(debug_assertions))]
    pub(crate) fn from_validated_parts(
        method: String,
        uri: String,
        version: String,
        headers: Vec<(String, String)>,
    ) -> Self {
        Self {
            method,
            uri,
            version,
            headers,
        }
    }
}

impl HttpHead for RequestHead {
    fn version(&self) -> &str {
        &self.version
    }

    fn headers(&self) -> &[(String, String)] {
        &self.headers
    }
}

/// レスポンスヘッダー(ボディなし)
///
/// `ResponseDecoder::decode_headers` の戻り値として返される、デコード済みの
/// レスポンスヘッダーを表す。フィールドは非公開で、`new` / `with_version` /
/// `header` 等のバリデート付き API 経由でのみ構築できる。これにより
/// `status_code` の不変条件 (RFC 9110 Section 15: 100..=599) が型レベルで
/// 保証され、`status_class()` の panic 経路を塞ぐ。
///
/// `#[non_exhaustive]` を付与しているため、将来のフィールド追加は非破壊的に扱える。
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub struct ResponseHead {
    /// HTTP バージョン (HTTP/1.1 等)
    pub(crate) version: String,
    /// ステータスコード (100..=599)
    pub(crate) status_code: u16,
    /// ステータスフレーズ (OK, Not Found, etc.)
    pub(crate) reason_phrase: String,
    /// ヘッダー
    pub(crate) headers: Vec<(String, String)>,
}

impl ResponseHead {
    /// 新しい `ResponseHead` を HTTP/1.1 で作成する (バリデート付き)
    ///
    /// テスト用途や、別経路で受信したヘッダー情報から `ResponseHead` を構築したい
    /// 場合に利用する。`ResponseDecoder` 経由で得た `ResponseHead` には呼び出す
    /// 必要はない。
    ///
    /// `reason_phrase` は空文字列を許容する (RFC 9112 Section 4 の absent 扱い)。
    pub fn new(status_code: u16, reason_phrase: &str) -> Result<Self, EncodeError> {
        Self::with_version("HTTP/1.1", status_code, reason_phrase)
    }

    /// 新しい `ResponseHead` をバージョン指定付きで作成する (バリデート付き)
    pub fn with_version(
        version: &str,
        status_code: u16,
        reason_phrase: &str,
    ) -> Result<Self, EncodeError> {
        if !is_valid_protocol_version(version) {
            return Err(EncodeError::InvalidVersion {
                version: version.into(),
            });
        }
        if !is_valid_status_code(status_code) {
            return Err(EncodeError::InvalidStatusCode { code: status_code });
        }
        // reason-phrase 空文字列は absent 扱いで許容、非空ならバリデート
        if !reason_phrase.is_empty() && !is_valid_reason_phrase(reason_phrase) {
            return Err(EncodeError::InvalidReasonPhrase {
                phrase: reason_phrase.into(),
            });
        }
        Ok(Self {
            version: version.into(),
            status_code,
            reason_phrase: reason_phrase.into(),
            headers: Vec::new(),
        })
    }

    /// ヘッダーを追加する (バリデート付き、ビルダー)
    pub fn header(mut self, name: &str, value: &str) -> Result<Self, EncodeError> {
        self.add_header(name, value)?;
        Ok(self)
    }

    /// ヘッダーを追加する (バリデート付き、可変借用)
    pub fn add_header(&mut self, name: &str, value: &str) -> Result<&mut Self, EncodeError> {
        if !is_valid_header_name(name) {
            return Err(EncodeError::InvalidHeaderName { name: name.into() });
        }
        if !is_valid_field_value(value) {
            return Err(EncodeError::InvalidHeaderValue {
                name: name.into(),
                value: value.into(),
            });
        }
        self.headers.push((name.into(), value.into()));
        Ok(self)
    }

    /// ステータスコードを取得 (100..=599 が保証される)
    #[must_use]
    pub fn status_code(&self) -> u16 {
        self.status_code
    }

    /// ステータスフレーズを取得 (空文字列は absent 扱い)
    #[must_use]
    pub fn reason_phrase(&self) -> &str {
        &self.reason_phrase
    }

    /// ステータスコードのクラス分類を返す。
    ///
    /// RFC 9110 Section 15 に基づく分類。
    ///
    /// フィールド非公開化と `new` / `with_version` のバリデーションにより
    /// `status_code` は 100..=599 が型レベルで保証されているため、
    /// `StatusClass::from_status_code` は必ず `Some` を返す。
    #[must_use]
    pub fn status_class(&self) -> StatusClass {
        StatusClass::from_status_code(self.status_code)
            .expect("status_code is in 100..=599 by construction invariant")
    }

    /// HTTP プロトコルバージョンを取得 (例: `"HTTP/1.1"`)。
    ///
    /// RFC 9112 Section 2.3 HTTP-version。
    #[must_use]
    pub fn version(&self) -> &str {
        &self.version
    }

    /// ヘッダーリストを取得。
    ///
    /// RFC 9110 Section 5。順序は受信順を保持する。
    #[must_use]
    pub fn headers(&self) -> &[(String, String)] {
        &self.headers
    }

    /// `ResponseDecoder` 内部からの構築用 (バリデーションスキップ)
    ///
    /// `ResponseDecoder::decode_headers` は status-line / ヘッダーをデコード時に
    /// 各フィールドをバリデート済みであるため、ここで再検証は不要。
    ///
    /// 命名は標準ライブラリの unsafe 慣習 (`Vec::from_raw_parts` 等) と表面的に
    /// 衝突するが、本関数は unsafe ではない (整合性責任が呼出側にある点だけが
    /// 共通)。
    #[cfg(debug_assertions)]
    pub(crate) fn from_validated_parts(
        version: String,
        status_code: u16,
        reason_phrase: String,
        headers: Vec<(String, String)>,
    ) -> Self {
        debug_assert!(
            is_valid_protocol_version(&version),
            "version must be valid HTTP-version"
        );
        debug_assert!(
            is_valid_status_code(status_code),
            "status_code must be in 100..=599"
        );
        debug_assert!(
            reason_phrase.is_empty() || is_valid_reason_phrase(&reason_phrase),
            "reason_phrase must be valid or empty"
        );
        for (name, value) in &headers {
            debug_assert!(
                is_valid_header_name(name),
                "header name must be valid token"
            );
            debug_assert!(is_valid_field_value(value), "header value must be valid");
        }
        Self {
            version,
            status_code,
            reason_phrase,
            headers,
        }
    }

    #[cfg(not(debug_assertions))]
    pub(crate) fn from_validated_parts(
        version: String,
        status_code: u16,
        reason_phrase: String,
        headers: Vec<(String, String)>,
    ) -> Self {
        Self {
            version,
            status_code,
            reason_phrase,
            headers,
        }
    }
}

impl HttpHead for ResponseHead {
    fn version(&self) -> &str {
        &self.version
    }

    fn headers(&self) -> &[(String, String)] {
        &self.headers
    }
}