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

[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

クライアント

ini
# /etc/mqvpn/client.conf
[Server]
Address = 203.0.113.1:443

[Auth]
Key = mPyVpoQWcp/5gr404xvS19aRC03o0XS2mrb2tZJ1Ii4=

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

[Multipath]
Scheduler = wlb
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"
}

クライアント

json
{
  "mode": "client",
  "server_addr": "203.0.113.1:443",
  "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",
  "paths": ["eth0", "wlan0"]
}

マルチユーザー認証

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

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

INFO

ユーザーを削除しても既存のセッションは切断されません。削除は新規接続にのみ反映され、既存セッションは切断またはサーバー再起動まで維持されます。

設定ファイルでの実行

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

設定リファレンス

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

キー説明デフォルト
Addressサーバーアドレス(HOST:PORT、IPv6 は [2001:db8::1]:443 形式)必須
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

[TLS](サーバーのみ)

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

[Auth]

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

[Multipath]

キー説明デフォルト
Schedulerスケジューラアルゴリズム(minrtt または wlbwlb
Pathバインドするネットワークインターフェース(複数指定可)デフォルトインターフェース

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

Control API

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

有効化

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

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

コマンド

ユーザーの追加:

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

WARNING

ユーザーを削除しても既存のセッションは切断されません。削除は新規接続にのみ反映され、既存セッションは切断またはサーバー再起動まで維持されます。

ユーザー一覧の取得:

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

統計情報の取得:

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

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

systemd

先にバイナリとユニットファイルをインストールします(初回のみ):

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

サーバー

bash
sudo cp systemd/server.conf.example /etc/mqvpn/server.conf
# /etc/mqvpn/server.conf を編集
sudo systemctl enable --now mqvpn-server

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

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

bash
sudo cp systemd/client.conf.example /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 に基づき公開