Skip to content

設定

mqvpn は INI と JSON の両方の設定ファイルに対応しています。ファイルの内容が { で始まる場合は JSON、それ以外は INI として解析されます。CLI 引数は設定ファイルの値を上書きします。

INI 形式

サーバー

ini
# /etc/mqvpn/server.conf
[Interface]
Listen = 0.0.0.0:443
Subnet = 10.0.0.0/24
Subnet6 = 2001:db8:1::/112
# MTU = 1280

[TLS]
Cert = /etc/mqvpn/server.crt
Key = /etc/mqvpn/server.key

[Auth]
Key = mPyVpoQWcp/5gr404xvS19aRC03o0XS2mrb2tZJ1Ii4=
User = alice:<ALICE_PSK>
User = bob:<BOB_PSK>

[Multipath]
Scheduler = wlb
# CC = bbr2                     # Congestion control (bbr2|bbr|cubic|none)

クライアント

ini
# /etc/mqvpn/client.conf
[Server]
Address = 203.0.113.1:443
# ServerName = vpn.example.com  # TLS SNI / 証明書検証名(デフォルト: Address のホスト部)

[Auth]
Key = mPyVpoQWcp/5gr404xvS19aRC03o0XS2mrb2tZJ1Ii4=

[Interface]
TunName = mqvpn0
DNS = 1.1.1.1, 8.8.8.8
LogLevel = info
# MTU = 1280

[Multipath]
Scheduler = wlb
# CC = bbr2                     # Congestion control (bbr2|bbr|cubic|none)
Path = eth0
Path = wlan0

JSON 形式

JSON は構造化された設定管理や自動化ツールとの連携に便利です。

サーバー

json
{
  "mode": "server",
  "listen": "0.0.0.0:443",
  "tun_name": "mqvpn0",
  "log_level": "info",
  "subnet": "10.0.0.0/24",
  "subnet6": "2001:db8:1::/112",
  "cert_file": "/etc/mqvpn/server.crt",
  "key_file": "/etc/mqvpn/server.key",
  "auth_key": "<YOUR_PSK_HERE>",
  "users": [
    { "name": "alice", "key": "<ALICE_PSK>" },
    { "name": "bob", "key": "<BOB_PSK>" }
  ],
  "max_clients": 64,
  "scheduler": "wlb",
  "cc": "bbr2"
}

クライアント

json
{
  "mode": "client",
  "server_addr": "203.0.113.1:443",
  "tls_server_name": "vpn.example.com",
  "tun_name": "mqvpn0",
  "log_level": "info",
  "auth_key": "<YOUR_PSK_HERE>",
  "insecure": false,
  "dns": ["1.1.1.1", "8.8.8.8"],
  "kill_switch": false,
  "reconnect": true,
  "reconnect_interval": 5,
  "scheduler": "wlb",
  "cc": "bbr2",
  "paths": ["eth0", "wlan0"]
}

マルチユーザー認証

サーバーでは複数のユーザーをそれぞれ個別の PSK で認証できます。JSON config では users 配列で設定します。各要素はオブジェクト形式({"name":"alice","key":"..."})または省略形の文字列("alice:key")のどちらでも指定可能です。INI config では [Auth] セクションに User = NAME:KEY 行を複数書きます。Control API を使って実行中にユーザーを管理することもできます。

auth_key(グローバルキー)と users を両方設定した場合、クライアントはどちらでも認証可能です。名前付きユーザーのみに制限するには、auth_key を設定から削除してください。

Control API でユーザーを削除すると、そのユーザー名で認証された接続中のセッションも切断されます。

監視は per-user 鍵が必須

複数クライアントで auth_key(グローバル鍵)を共有しても VPN データプレーンは動作しますが、Control API と Prometheus exporter は user ラベルでクライアントを識別します。グローバル鍵で認証したセッションは user="(global)" として報告されるため、複数クライアントが同一ラベルに衝突して Prometheus のスクレイプ全体が破棄されます。複数クライアントを監視する場合は、各クライアントに users で個別エントリを作成するか、add_user で実行時に登録してください。

設定ファイルでの実行

bash
sudo mqvpn --config /etc/mqvpn/server.conf
sudo mqvpn --config /etc/mqvpn/server.json

設定リファレンス

[Server](クライアントのみ)

キー説明デフォルト
Addressサーバーアドレス(HOST:PORT、IPv6 は [2001:db8::1]:443 形式)必須
ServerNameTLS SNI および証明書検証名。IP 直接接続でドメイン証明書を検証する場合に使用Address のホスト部
InsecureTLS 証明書検証をスキップfalse

[Interface]

キー説明デフォルト
Listenリッスンアドレス(サーバーのみ)0.0.0.0:443
Subnetクライアント IPv4 プール(サーバーのみ)10.0.0.0/24
Subnet6クライアント IPv6 プール(サーバーのみ)
TunNameTUN デバイス名mqvpn0
DNSDNS サーバー(カンマ区切り)
LogLevelログレベル(debuginfowarnerrorinfo
KillSwitchVPN 外への通信を遮断(クライアントのみ)false
Reconnect自動再接続を有効化(クライアントのみ)true
ReconnectInterval再接続の間隔(秒)5
ManageRoutesホストのルーティングテーブルを管理する(VPN ルートとサーバー pin ルート)。自前でルーティングを管理する場合は false(または --no-manage-routes)を指定true
MTUTUN MTU(1280–9000)。クライアント: 上限指定 — ネゴシエーション値のほうが小さい場合はそちらが使われる。サーバー: TUN MTU を直接設定。auto(クライアント ~1382 ネゴシエーション、サーバー 1382)

[TLS](サーバーのみ)

キー説明デフォルト
CertTLS 証明書パス(PEM)必須
KeyTLS 秘密鍵パス(PEM)必須

[Auth]

キー説明デフォルト
Key事前共有鍵(base64、mqvpn --genkey で生成)User 未設定時は必須
Userユーザー個別の PSK(NAME:KEY 形式、複数指定可)
MaxClients最大同時接続クライアント数(サーバーのみ)64

JSON ではクライアント・サーバーとも auth_key を使います(上の例のとおり)。

[Multipath]

キー説明デフォルト
Schedulerスケジューラアルゴリズム(minrtt, wlb, wlb_udp_pin, または backup_fecwlb
CC輻輳制御アルゴリズム(bbr2, bbr, cubic, または nonebbr2
Pathバインドするネットワークインターフェース(複数指定可)デフォルトインターフェース
InitMaxPathIdMP-QUIC draft-21 テスト用ノブ: transport parameters で広告する初期 Maximum Path Identifier(142949672950 = xquic デフォルト 80

スケジューラの詳細はマルチパスを参照してください。

backup_fec は実験的機能で、両ピアが mqvpn 0.4.0 以降かつ FEC ビルド (-DXQC_ENABLE_FEC=ON -DXQC_ENABLE_XOR=ON) を有効にしている必要があります。 詳細はマルチパスを参照。

CC = none(輻輳制御なし)は xquic を -DXQC_ENABLE_UNLIMITED=ON でビルドする必要があります。

[Reorder]

内側 UDP トラフィック向けの、フロー単位の reorder バッファです。mqvpn のマルチパス集約によって複数経路に分散される単一の内側コネクション(例: 内側 QUIC)を対象とし、順序が乱れたデータグラムを短時間だけ保持して順序どおりに配送することで、内側エンドポイントが受け取る順序の乱れを軽減します。デフォルトは無効(Enabled = off)で、無効時はこのセクションは効果を持たず、パケットはそのまま転送されます。

対象範囲: reorder バッファは現在 内側 UDP フローのみ に適用されます。内側 TCP はまだ reorder バッファでは扱いません(TODO)。 内側 TCP は代わりに、TCP フローを単一経路に固定するスケジューラのフローピン留め(wlb / wlb_udp_pin)と、TCP 自身の順序乱れ耐性(RACK/SACK)に依存します。

キー説明デフォルト
Enabledマスタースイッチ(on / offoff
MaxWaitMs欠落データグラムをスキップするまで、ギャップを保持する時間(ms)30
CapPacketsフローあたりの最大バッファデータグラム数(2 のべき乗)1024
MaxBytesPerFlowフローあたりの最大バッファバイト数1572864
ClassifyWindowフローの方向を判定するために観測するデータグラム数(0 で ACK 方向のデモートを無効化)64
AckDemoteMaxLargeこの値以下の大パケット数であればフローを ACK 方向と判定する3
SmallPacketThresholdsmall / large を分ける内側ペイロードのバイト数200
ResetMarkPacketsフロー再開時に送出する FLOW_RESET マーク数8
ResetIdleGraceMsフローがこの時間以上アイドルだった場合のみ FLOW_RESET を尊重する(ms)10000
MaxFlows追跡する最大フロー数65536
GlobalMaxBytes全フロー共有のバッファバイト予算67108864
IngressIdleSec受信側のアイドル退避タイムアウト(EgressIdleSec より小さい必要あり)30
EgressIdleSec送信側のアイドル退避タイムアウト300

ACK 方向のデモートは自動です。ACK / 制御ストリームのように見える(ほとんどが小さいパケットの)フローはパススルーへ移され、遅延されることがなくなります。これは内部的な挙動であり設定可能なつまみではありません — ClassifyWindow / AckDemoteMaxLarge / SmallPacketThreshold を通じて間接的に調整します。

reorder はスループットとレイテンシのトレードオフで、bulk 転送には効きますが、対象になるすべてのフローに最大 MaxWaitMs の遅延を上乗せします。1 本のトンネルは通常その両方のトラフィックを運ぶため、ポート単位の [ReorderRule] で、効く所(bulk な内側 QUIC)だけ有効にし、低遅延トラフィック(DNS, NTP, リアルタイム UDP)はパススルーさせられます。マッチしない UDP はデフォルトでパススルーなので、reorder したいポートだけルールを書けば済みます:

ini
[Reorder]
Enabled = on

[ReorderRule]          # bulk な内側 QUIC: reorder 有効
Proto = udp
Port = 443
Profile = fiber_lte

[ReorderRule]          # DNS: 遅延を絶対に足さない
Proto = udp
Port = 53
Profile = default_udp

…または JSON でも同様に設定できます。reorder オブジェクトは上記 INI キーに 1:1 で対応する snake_case キーを使い、reorder_rules{proto, port, profile} オブジェクトの配列です(各ルールには任意で max_wait_ms / cap_packets のオーバーライドを付けられます):

json
{
  "reorder": {
    "enabled": "on",
    "max_wait_ms": 30,
    "cap_packets": 1024,
    "max_bytes_per_flow": 1572864,
    "classify_window": 64,
    "ack_demote_max_large": 3,
    "small_packet_threshold": 200,
    "reset_mark_packets": 8,
    "reset_idle_grace_ms": 10000,
    "max_flows": 65536,
    "global_max_bytes": 67108864,
    "ingress_idle_sec": 30,
    "egress_idle_sec": 300
  },
  "reorder_rules": [
    { "proto": "udp", "port": 443, "profile": "cellular_bond" },
    { "proto": "udp", "port": 4500, "profile": "fiber_lte", "max_wait_ms": 50, "cap_packets": 2048 }
  ]
}

プロファイルプリセット

各プロファイルは、実測でチューニングした (MaxWaitMs, CapPackets) のプリセットを持ちます。これらの値は 16 種類のリンク環境にわたる netem マルチパス実測スイープから選定したもので、手法と環境別データの詳細はreorder-only マルチパス実測レポートにあります:

プロファイルMaxWaitMsCapPackets備考
cellular_bond501024セルラーボンディング(例: デュアル LTE)
fiber_lte502048光 + LTE の混在。BDP が大きいため cap を拡大
quic_bulk501024cellular_bond の後方互換エイリアス
low_latency予約済み。プリセットなし(無効)
default_udpマッチするが reorder しない(パススルー / OFF)

ルールの実効 (MaxWaitMs, CapPackets)優先順位(高い順):

  1. ルール自身に明示された MaxWaitMs / CapPackets キー。
  2. グローバルな [Reorder] に明示された MaxWaitMs / CapPackets
  3. ルールのプロファイルプリセット(上表)。
  4. ビルトインのデフォルト(MaxWaitMs = 30CapPackets = 1024)。

つまり、数値が明示されていれば常にプロファイルより優先されます。グローバルな [Reorder] MaxWaitMsProfile = quic_bulk と併用している設定が、明示したグローバル値をそのまま使い続けるのはこのためです。

reorder を有効にすべきとき

reorder はデフォルトで無効であり、有効な範囲の中でのみ opt-in で使うことを想定しています。実測では、その範囲はおおむね RTT のばらつきが 15〜100 ms、ジッタのある経路、または帯域が非対称なケースです。

  • 帯域の非対称が強い場合(おおむね 8:1 以上): MaxWaitMs150200 まで上げることを検討してください(未検証 — 実回線での検証を要するフォローアップとして扱ってください)。
  • RTT のばらつきが極端な場合(285 ms 以上、静止衛星クラス): ここでは reorder はかえって性能を下げます。その種のトラフィックでは Profile = default_udp で無効のままにしてください。

[ReorderRule](繰り返し可)

キー説明デフォルト
Protoマッチする L4 プロトコル(udpudp
Portマッチするポート(送信元または宛先)
Profilecellular_bond, fiber_lte, quic_bulk, low_latency, または default_udpquic_bulk
MaxWaitMsこのルールのみの保持時間(ms)のオーバーライド。0 は警告付きで拒否されます — ポートを素通しさせたい場合は代わりに Profile = default_udp を使ってくださいプロファイルプリセット
CapPacketsこのルールのみのフローあたりバッファ上限のオーバーライド。0 以外の 2 のべき乗である必要があり、そうでなければ警告付きで拒否されますプロファイルプリセット

[Hybrid]

内側 TCP をクライアントでローカル終端し、HTTP/3 リクエストストリームで中継することで、単一の TCP フローでも複数パスの帯域を集約できるようにします。デフォルト無効。レーン図・egress ACL の意味論・既知の制限はハイブリッドモードを参照してください。

キー説明対象デフォルト
Enabledマスタースイッチclient + serverfalse
Tcpフロー単位の TCP レーンポリシー: stream(常に使用)、raw(不使用 — hybrid 無効時とバイト同一)、auto(SYN 時点でアクティブパスが 2 本以上なら TCP レーン。判定はフローの生存期間中固定)clientauto
TcpMaxFlows同時 TCP レーンフロー数の上限。client と server で実装も失敗時の挙動も異なる — 詳細はこの表の直下の client と server で挙動が違う を参照client + server256
TcpIdleTimeoutSecTCP レーンフローのアイドル破棄タイムアウト。0 で無効化client + server300
TcpConnectTimeoutSecサーバの egress connect() タイムアウト。超過時クライアントは HTTP 504 を受け取りますserver10
TcpMaxGlobalFlows全セッション合計の egress TCP フロー数のサーバ全体上限server4096
EgressAllowプライベートレンジ向けデフォルト拒否 egress ACL を通す CIDR(繰り返し可、最大 32)server
EgressDeny追加で拒否する CIDR。EgressAllow の後に評価されます(繰り返し可、最大 32)server

TcpMaxFlows — client と server で挙動が違う

共通しているのはキー名だけで、数える対象も、上限に当たったときの結果も別物。

clientserver
数える場所レーン自身のフローテーブルクライアントセッション単位
判定タイミングlwIP が SYN を見る前CONNECT-TCP 要求の到着時
内側 TCP の終端lwIP (レーン内)しない (通常のカーネルソケットで中継)
上限超過時RAW レーンに降格 — 接続は成立する (失敗ではない)HTTP 503 → client はその内側コネクションを RST。この時点で RAW 降格はない
per-flow メモリ~0.75 MiB (uplink キューの上限)~8 KiB (遅延確保の 4 KiB 中継バッファ × 2) + fd 1 本
先に尽きる資源RAM — worst case は TcpMaxFlows × 0.75 MiB (既定 256 で約 192 MiB、4096 で約 3.0 GiB)fd 予算 — 全体上限の TcpMaxGlobalFlows が先に判定される
実効値の clamplwIP TCP pcb プールの半分まで (下記)なし (lwIP を使わないため)

client の clamp について。 実効値は lwIP TCP pcb プールの半分に制限される — desktop/router ビルド (Linux / Windows / macOS) で 4096、Android で 256iOS lwIP プロファイル64。clamp が働いた場合はログに出る。 既定値 256 は desktop/router では clamp されない (256 < 4096)。

これは設定値を半分にするものではない。 実効値ぶんのフローは同時に張れる。プールの 残り半分は、フローテーブルが数えなくなった pcb (TIME_WAIT / LAST_ACK / CLOSING はフローより 長生きする) が居座るための余白。この余白があるおかげで、プールが「生きたフローだけ」で 埋まることが構造的に起こり得ず、lwIP の tcp_alloc() が枯渇時に行う段階的な回収 (TIME_WAIT → LAST_ACK → CLOSING → 確立済み pcb) が最後の段に到達しない。 つまり「レーン側の cap が先に安く断る」という設計が、運任せではなく構造で保証される。

JSON では "hybrid" オブジェクトに snake_case キーで指定します(enabled, tcp, tcp_max_flows, tcp_idle_timeout_sec, tcp_connect_timeout_sec, tcp_max_global_flows, egress_allow, egress_deny)。

egress ACL は EgressAllow/EgressDeny を何も設定しなくても RFC1918・ ループバック・リンクローカル宛をデフォルト拒否します。侵害されたクライアントが サーバを内部ネットワークへの踏み台に使うことへの安全側デフォルトです。

[Advanced]

キー説明デフォルト
RecvRateLimitコネクションレベルの受信レート上限(バイト/秒)。QUIC の集約受信ウィンドウを rate × RTT に制限します。クライアント側のみ有効 — サーバは無視します(サーバ側で制限するとクライアントのアップロードを絞ってしまうため)。最大値は 10000000000(10 GB/s)で、それを超える値は警告とともに拒否され 0 にフォールバックします。メモリ制約がある場合を除き 0 のままにしてください(モバイルクライアントは内部で設定します)0(無効)

JSON では "advanced" オブジェクトに snake_case キーで指定します(recv_rate_limit)。

MTU ガイドライン

デフォルト(auto)— 通常はそのままで OK

ほとんどの環境では MTU を設定する必要はありません。自動ネゴシエーションで決まる値(約 1382)は、標準的な Ethernet(1500)、PPPoE(1492)、モバイル回線でそのまま使えます。

MTU を明示的に設定すべきケース

シナリオ推奨設定
標準的な Ethernet / モバイル設定不要(auto で約 1382)
多段トンネル構成(mqvpn → WG → 別トンネルなど)残りの MTU を計算し、1280 に近ければ明示指定

クライアントでは、MTU を設定すると min(設定値, ネゴシエーション値) が実際の TUN MTU になり、設定値がネゴシエーション値を超えている場合は warning ログが出力されます。サーバーでは、MTU は TUN MTU をそのまま設定します(デフォルト 1382)。

TIP

クライアントで MTU にネゴシエーション値(約 1382)より大きい値を指定しても効果はありません。ネゴシエーション値が常に上限になります。サーバーでは設定値がそのまま TUN デバイスに適用され、各クライアントのネゴシエーション MSS を超えるパケットには ICMP Packet Too Big を送信元へ返し、送信元側でパケットサイズを調整させます(Path MTU Discovery)。

TUN MTU の算出方法

mqvpn は接続確立時に、QUIC DATAGRAM の Maximum Segment Size(MSS)をもとに TUN MTU を算出します。max_pkt_out_size がデフォルトの 1400 の場合、オーバーヘッドの内訳は以下のとおりです:

max_pkt_out_size           1400 bytes
 − QUIC short header         13 bytes
 − DATAGRAM frame header      3 bytes
 − MASQUE datagram header      2 bytes
                           ─────────
 = TUN MTU                  1382 bytes

このネゴシエーションはクライアント側で接続確立時に行われ、クライアントの TUN MTU はそれに追従します。サーバーは起動時に TUN MTU を一度だけ設定します(デフォルト 1382、または設定値)。ネゴシエーション MSS が 1382 より小さいクライアント宛の超過パケットは、サーバーがそのクライアントの MSS を MTU 値として ICMP Packet Too Big を送信元へ返します。送信元はこれを受けてパケットサイズを下げるため(Path MTU Discovery)、サーバーの TUN MTU を全クライアント共通で縮める必要はありません。

mqvpn トンネル内で別のトンネルを使う場合

mqvpn の上にさらに WireGuard や IPsec、GRE などを重ねると、その分だけ有効 MTU が小さくなります。内側プロトコルの最低 MTU 要件を満たしているか確認してください。

例:mqvpn の上で WireGuard を使う

mqvpn TUN MTU                    1382 bytes
 − WireGuard オーバーヘッド(IPv6)  80 bytes
                                 ─────────
 = WireGuard 内側 MTU            1302 bytes
   → IPv6 最小 MTU(1280)          ✓
   → QUIC/HTTP3 UDP ペイロード    1254 bytes > 1200  ✓

制約一覧

制約根拠
config 下限1280IPv6 最小 MTU(RFC 8200)
config 上限9000ジャンボフレーム MTU
QUIC 最小 UDP ペイロード1200RFC 9000 §14(ハンドシェイク要件)
auto の値~1382(クライアント: ネゴシエーション、サーバー: 固定デフォルト)max_pkt_out_size(1400)から導出

Control API

稼働中のサーバーに対して、ローカル TCP ソケット経由で JSON コマンドを送ることで、再起動なしにユーザーの追加・削除などの管理操作が行えます。

有効化

bash
sudo mqvpn --mode server ... --control-port 9090

デフォルトでは 127.0.0.1 にバインドされます。認証機能はないため、信頼できるインターフェースのみにバインドしてください。

設定ファイルから有効化する

Control API は /etc/mqvpn/server.conf からも有効化できます:

ini
[Control]
Listen = 127.0.0.1:9090

JSON 設定の場合:

json
{
  "control_listen": "127.0.0.1:9090"
}

CLI フラグ(--control-port, --control-addr)は設定ファイルの値をフィールド単位で上書きします。--control-port 0 を指定すると、[Control] Listen が設定ファイルに書かれていても明示的に無効化できます。

コマンド

ユーザーの追加:

bash
echo '{"cmd":"add_user","name":"carol","key":"carol-secret"}' | nc 127.0.0.1 9090

ユーザーの削除:

bash
echo '{"cmd":"remove_user","name":"carol"}' | nc 127.0.0.1 9090

ユーザーを削除すると、そのユーザー名で認証された接続中のセッションも切断されます。

ユーザー一覧の取得:

bash
echo '{"cmd":"list_users"}' | nc 127.0.0.1 9090

統計情報の取得:

bash
echo '{"cmd":"get_stats"}' | nc 127.0.0.1 9090

詳細なステータスの取得(クライアント・パス単位):

bash
echo '{"cmd":"get_status"}' | nc 127.0.0.1 9090

整形された出力には組み込みの status コマンドも使えます:

bash
mqvpn --status --control-port 9090

すべてのコマンドは "ok" フィールドを含む JSON レスポンスを返します。各接続は 1 コマンドを処理するとサーバー側で切断されるため、コマンドごとに新しい接続を開いてください。

systemd

deb パッケージや install.sh でインストール済みの場合、systemd ユニットは自動的に配置されます。ソースからビルドした場合は手動でインストールします:

bash
sudo cmake --install build --prefix /usr/local

サーバー

install.sh を使った場合は /etc/mqvpn/server.conf が自動生成されています。手動で設定する場合はサンプルをコピーします:

bash
sudo cp /etc/mqvpn/server.conf.example /etc/mqvpn/server.conf
sudo vi /etc/mqvpn/server.conf   # 証明書パス、認証キーなどを編集
sudo systemctl enable --now mqvpn-server

クライアント(テンプレートユニット)

クライアントはテンプレートユニットを使用します。インスタンス名が設定ファイル名に対応します:

bash
sudo cp /etc/mqvpn/client.conf.example /etc/mqvpn/client-home.conf
sudo vi /etc/mqvpn/client-home.conf   # サーバーアドレス、認証キーなどを編集
sudo systemctl enable --now mqvpn-client@home
# → /etc/mqvpn/client-home.conf を読み込みます

INFO

systemd ユニットは INI 形式の .conf ファイルを前提としています。サーバーユニットの NAT ヘルパースクリプトも INI を直接パースするため、標準ユニットのままでは JSON は使用できません。

Apache License 2.0 に基づき公開