shiguredo_http11 2026.1.0-canary.3

HTTP/1.1 Library
Documentation

http11-rs

shiguredo_http11 Documentation License

About Shiguredo's open source software

We will not respond to PRs or issues that have not been discussed on Discord. Also, Discord is only available in Japanese.

Please read https://github.com/shiguredo/oss before use.

時雨堂のオープンソースソフトウェアについて

利用前に https://github.com/shiguredo/oss をお読みください。

概要

Rust で実装された依存 0 かつ Sans I/O な HTTP/1.1 ライブラリです。

特徴

  • Sans I/O
  • 依存ライブラリ 0
  • 圧縮/展開トレイト (Compressor / Decompressor) の提供
    • ライブラリ本体は圧縮実装を含まず、利用者が任意の実装を組み込める

使い方

クライアント (リクエスト送信、レスポンス受信)

use shiguredo_http11::{Request, ResponseDecoder};

// リクエストを作成してエンコード
let request = Request::new("GET", "/")
    .header("Host", "example.com")
    .header("Connection", "close");
let bytes = request.encode();
// bytes を送信...

// レスポンスをデコード
let mut decoder = ResponseDecoder::new();
// 受信データを feed...
// decoder.feed(&received_data)?;
// if let Some(response) = decoder.decode()? { ... }

サーバー (リクエスト受信、レスポンス送信)

use shiguredo_http11::{RequestDecoder, Response};

// リクエストをデコード
let mut decoder = RequestDecoder::new();
// 受信データを feed...
// decoder.feed(&received_data)?;
// if let Some(request) = decoder.decode()? { ... }

// レスポンスを作成してエンコード
let response = Response::new(200, "OK")
    .header("Content-Type", "text/plain")
    .body(b"Hello, World!".to_vec());
let bytes = response.encode();
// bytes を送信...

圧縮/展開 (Content-Encoding)

ライブラリ本体は圧縮/展開の実装は含みません。 代わりに Compressor / Decompressor トレイトを提供し、利用者が任意の実装を組み込めます。

use shiguredo_http11::{ResponseDecoder, ResponseEncoder};
use shiguredo_http11::compression::{Compressor, Decompressor, NoCompression};

// 展開器を組み込んだデコーダー
let decoder = ResponseDecoder::with_decompressor(MyGzipDecompressor::new());

// 圧縮器を組み込んだエンコーダー
let encoder = ResponseEncoder::with_compressor(MyGzipCompressor::new());

// 従来通りの使い方 (圧縮なし)
let decoder = ResponseDecoder::new(); // NoCompression がデフォルト

サンプル (examples/) では flate2, brotli, zstd クレートを使った実装例を提供しています。

ストリーミングデコード

大きなボディを扱う場合や、ボディを受信しながら処理したい場合はストリーミング API を使用します。

  • decode_headers() - ヘッダーをデコードして (RequestHead/ResponseHead, BodyKind) を返す
  • peek_body() - 利用可能なボディデータをゼロコピーで取得
  • consume_body(len) - ボディデータを消費して BodyProgress を返す
  • progress() - 状態機械を進める (Chunked のチャンクサイズ行パース等)
  • mark_eof() - 接続終了を通知 (close-delimited ボディ用、ResponseDecoder のみ)

BodyKind はボディの種類を表します:

  • ContentLength(usize) - Content-Length による固定長
  • Chunked - Transfer-Encoding: chunked
  • CloseDelimited - 接続終了までがボディ (レスポンスのみ、RFC 9112)
  • None - ボディなし

BodyProgress はデコードの進捗を表します:

  • Continue - 継続中
  • Complete { trailers } - 完了 (トレーラーヘッダーがある場合は含む)

HTTP/1.1

このライブラリが対応している HTTP/1.1 の仕組みです。

Transfer-Encoding

  • chunked 転送エンコーディングのデコード/エンコード
  • チャンクサイズの 16 進数パース
  • トレーラーヘッダーの処理
  • ストリーミング送信用のチャンクエンコード API

Content-Length

  • Content-Length ヘッダーのパース
  • エンコード時の Content-Length 自動計算
  • ボディサイズ制限によるチェック

Connection

  • Connection ヘッダー (keep-alive, close) の処理
  • HTTP/1.1 デフォルトでの keep-alive 動作
  • is_keep_alive() によるキープアライブ判定

ボディ処理

  • Transfer-Encoding: chunked が最優先
  • Content-Length による固定長ボディ
  • ステータスコード 1xx/204/304 はボディなし
  • HEAD リクエストへのレスポンスはボディなし

ヘッダー

  • 大文字小文字を区別しないヘッダー名の比較
  • 同一名ヘッダーの複数値対応
  • ヘッダー数/行長の制限

キャッシュ (RFC 9111)

  • Cache-Control ヘッダー (max-age, public, private, no-cache, no-store など)
  • Age ヘッダー
  • Expires ヘッダー

条件付きリクエスト (RFC 9110)

  • If-Match / If-None-Match ヘッダー (ETag 比較)
  • If-Modified-Since / If-Unmodified-Since ヘッダー

Range リクエスト (RFC 9110)

  • Range ヘッダーのパース (bytes=0-499, 500-, -500)
  • Content-Range ヘッダーの生成
  • Accept-Ranges ヘッダー

認証 (RFC 7617, RFC 7616, RFC 6750)

  • Basic / Digest / Bearer 認証のエンコード/デコード
  • Authorization / WWW-Authenticate ヘッダー
  • Proxy-Authorization / Proxy-Authenticate ヘッダー

URI (RFC 3986)

  • URI のパース (scheme, host, port, path, query, fragment)
  • パーセントエンコーディング/デコーディング
  • 相対 URI の解決

その他のヘッダー

  • Content-Type (メディアタイプ、charset、boundary)
  • Content-Encoding (gzip, deflate, compress, identity)
  • Content-Disposition (inline/attachment、filename、filename*)
  • Content-Language
  • Content-Location
  • Date (HTTP-date 形式: IMF-fixdate, RFC 850, asctime)
  • ETag (Strong/Weak)
  • Cookie / Set-Cookie
  • Host ヘッダーのパース/検証
  • Multipart (multipart/form-data)
  • Trailer ヘッダー
  • Expect ヘッダー
  • Upgrade ヘッダー
  • Content-Digest / Repr-Digest / Want-Content-Digest / Want-Repr-Digest (RFC 9530)

コンテントネゴシエーション

  • Accept (media-type, q 値)
  • Accept-Charset
  • Accept-Encoding
  • Accept-Language
  • Vary

セキュリティ

  • Response Splitting 対策: ヘッダー行の CR/LF と obs-fold を拒否
  • Request Smuggling 対策: Transfer-Encoding と Content-Length の同時指定拒否
  • Request Smuggling 対策: Content-Length の不一致検出

制限 (DoS 対策)

デフォルト値:

  • 最大バッファサイズ: 64KB
  • 最大ヘッダー数: 100
  • 最大ヘッダー行長: 8KB
  • 最大ボディサイズ: 10MB

DecoderLimits で各制限値をカスタマイズ可能です。

サンプル

サンプルは Tokio と Rustls を利用しています。引数のライブラリには noargs を利用しています。

http11_client

HTTP/HTTPS クライアントの例です。

cargo run -p http11_client -- https://example.com/
cargo run -p http11_client -- http://httpbin.org/get

機能:

  • HTTP/HTTPS リクエスト送信
  • レスポンス受信とボディ表示
  • rustls-platform-verifier による TLS 検証

http11_server

HTTP/HTTPS サーバーの例です。

cargo run -p http11_server -- --port 8080
cargo run -p http11_server -- --port 8443 --tls --cert cert.pem --key key.pem

オプション:

  • -p, --port <PORT>: リッスンポート (デフォルト: 8080)
  • --tls: HTTPS 有効化 (ポートデフォルト: 8443)
  • --cert <PATH>: 証明書ファイル (PEM 形式)
  • --key <PATH>: 秘密鍵ファイル (PEM 形式)

http11_reverse_proxy

HTTP/HTTPS リバースプロキシの例です。

cargo run -p http11_reverse_proxy -- --port 8888 --upstream https://example.com
curl http://localhost:8888/

オプション:

  • -p, --port <PORT>: リッスンポート (デフォルト: 8888)
  • -u, --upstream <URL>: アップストリーム URL (デフォルト: https://example.com)

規格書

このライブラリが準拠している RFC 一覧です。

ライセンス

Apache License 2.0

Copyright 2026-2026, Shiguredo Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.