mDNS(Team)Proxy

mDNS(Team)Proxyは、ネットワークセグメントを跨いだmDNS名前解決を実現する分散型プロキシシステムです。 各ネットワークセグメントに配置されたプロキシが互いに通信し、mDNSのホスト情報を交換・マージすることで、別セグメントのデバイスを名前解決できるようにします。

ディレクトリ構成

• db/: SQLite3データベースファイル（mdns_proxy.sqlite3）が保存されます。
• log/: ログファイル（mdns_proxy.log）が保存されます。
• src/: プログラムのソースコード。
• system.ini: システム全体の設定ファイル。
• search_hosts.ini: 検索対象となるローカルホスト名（ローカルFQDN）のリスト。

設定ファイル (*.ini)

システムを動作させるために、以下の設定ファイルを適切に編集してください。 各環境への導入時、これらは共通の設定ファイルとして使用されます。

system.ini

システム全体の動作設定やネットワーク設定を定義します。

[system]
# 実行間隔（秒）
interval = 10
# 発信トークン接頭語
token_prefix = mDNSProxy_
# HTTP待ち受けポート
port = 80
# TTL初期値（秒）
ttl = 120
# ノード識別ID（複数サーバで重複しない値となる）
# 初回起動時に自動生成されるため手動記入不要
node_id =

[network]
# 外部mDNSプロキシIPアドレスとポート（カンマ区切りで複数指定可能）
# 中継・収束方式に対応しており、フルメッシュで到達できない環境でも中継可能なプロキシを定義することで、全ノード間で自動同期されます
external_proxies = 192.168.1.10:53080,192.168.2.10:53080

# Wi-Fi設定（Raspberry Pi Pico W用）
wifi_ssid = your_wifi_ssid
# Wi-Fiパスワード(mDNS-Proxy-RasPiPicoW-Installer.py を使用して暗号化生成・設定します)
wifi_password_encrypted = 

# デバイスのホスト名（Raspberry Pi Pico W用）
# 空欄の場合、初回起動時にMACアドレスから自動生成されます
hostname =  

search_hosts.ini

検索対象とするローカルホスト名、またはローカルFQDNのリストを定義します。 .local の記述を省略した場合でも、自動的に .local が補完されて対象になります。 ホスト名の後に = IPアドレス を指定することで、mDNSの検索を行わずに指定した固定IPアドレスを応答させることも可能です。

[hosts]
# 検索対象とするローカルホスト名またはローカルFQDNを記載します
# 例:
# host1             (host1.localとして扱われます)
# serverA           (serverA.localとして扱われます)
# printer1.local
test-device1
test-device2.local

# IPアドレスを固定で指定する場合
test-device3 = 192.168.3.10

起動モードとCLIツールによる管理

src/main.py は起動時にコマンドライン引数（オプション）を指定することで動作モードを切り替えられます。

• --daemon: 常駐サービスデーモンとして起動（API・mDNS・Schedulerをすべて起動します。このモードのみ二重起動防止の排他ロック制御が有効になります）。
• 引数なし または --cli: 対話型CLIとして起動。バックエンドの常駐処理は一切起動せず、安全にデータの参照や静的ホストの追加削除が可能です（手動起動の際、引数（オプション）は不要です）。
• --once: スケジューラの同期や解決、マージ等の定期実行タスクを1回だけ実行して、即時終了する単発実行モードです。

CLI (cli.py) について

対話型CLIは、mDNS Proxyのデータベースに保存されている情報の確認や、静的ホストの管理を行うためのツールです。 オプションなし、もしくは --cli を付加して実行すると自動的に対話メニューが立ち上がります。

実行例:

sudo python3 /opt/mdns_proxy/src/main.py

起動すると、コンソール上に以下のような実際の対話メニューが表示されます：

--- mDNS Proxy CLI ---
1. マージ済みレコードの表示
2. 静的ホストの表示
3. 静的ホストの追加
4. 静的ホストの削除
5. インスタント実行 (Ctrl+Cで終了)
6. 終了
オプションを選択してください (1-6): 

メニュー各項目の機能説明:

1. マージ済みレコードの表示: プロキシが収集・マージしたmDNSレコード（ホスト名とIPアドレスの対応）を一覧表示します。
2. 静的ホストの表示: 手動で登録された静的ホストの一覧を表示します。
3. 静的ホストの追加: 対話プロンプトに従い、新しい静的ホスト（FQDN）を追加登録します。
4. 静的ホストの削除: 登録済みの静的ホストをID指定で削除します。
5. インスタント実行: インスタント実行モードを開始します。実行中は Ctrl+C で終了してメニューに戻ることができます。
6. 終了: CLIツールを終了します。(Ctrl+C での終了も可能です)

Windows環境での利用について: Windows向けにビルドされた mdns_proxy.exe をコマンドプロンプトやPowerShell等から直接実行した（引数なしで起動した）際にも、標準のコンソールアプリとしてこの対話メニューが利用可能な状態で実装されています（サービスとしてバックグラウンドで起動している場合は、二重起動排他ロックのため別途 --cli モードなどで起動して安全に対話メニューにアクセスします）。

導入方法

Linux (Ubuntu 24.04) の場合

インストーラースクリプト mDNS-Proxy-Ubuntu-Installer.sh を使用して、簡単にセットアップとサービス登録ができます。

1. インストーラーの実行: リポジトリをクローンまたはダウンロードした後、以下のコマンドを実行します。

   cd /path/to/mdns_proxy_directory
   sudo bash mDNS-Proxy-Ubuntu-Installer.sh

2. セットアップ: スクリプトが自動的に以下の作業を行います。
   • 必要なパッケージ（python3, pip）のインストール
   • ファイルの /opt/mdns_proxy への配置
   • systemdサービスの作成と有効化
3. 設定の編集: インストール後、/opt/mdns_proxy/system.ini と /opt/mdns_proxy/search_hosts.ini を環境に合わせて編集してください。
4. サービスの再起動: 設定ファイルを変更した後は、サービスを再起動して変更を反映させます。

   sudo systemctl restart mdns_proxy

アンインストールする場合は mDNS-Proxy-Ubuntu-Uninstaller.sh を実行してください。

Raspberry Pi Pico W の場合（MicroPython）

インストーラースクリプト mDNS-Proxy-RasPiPicoW-Installer.py を使用して、必要なファイルの転送と設定を対話形式で簡単に行うことができます。

1. 事前準備:
   • PCにPython3とpipがインストールされていること。
   • Pico Wに最新のMicroPythonファームウェアが書き込まれていること。
2. インストーラーの実行: PCで以下のコマンドを実行します。

   cd /path/to/mdns_proxy_directory
   # 依存ライブラリのインストール (初回のみ)
   pip install -r requirements_installer.txt
   # インストーラーの起動
   python mDNS-Proxy-RasPiPicoW-Installer.py

3. 対話セットアップ: スクリプトを起動すると、対話メニューが表示されます。
   • Pico Wが接続されているシリアルポートの選択
   • src/ ディレクトリ配下の全ファイルのPicoへの転送
   • system.ini, search_hosts.ini のPicoへの転送
   • Wi-Fi設定: SSIDとパスワードを尋ねられ、パスワードは暗号化されて system.ini に書き込まれます。
   • 転送完了後、Picoは自動的に再起動し、mDNS Proxyが起動します。

Windowsの場合（EXE化・サービス起動）

Python環境がないWindows PCでも動作するように、PyInstallerを用いてEXE化できます。

1. ビルド（EXE化）: 開発環境（Pythonインストール済み）で以下のコマンドを実行します。

   pip install pyinstaller
   pyinstaller --onefile --name mdns_proxy src/main.py

   ビルドが成功すると、dist/mdns_proxy.exe が生成されます。

2. 配置: mdns_proxy.exe と同じディレクトリに db/, log/, system.ini, search_hosts.ini を配置してください。

3. サービスとして起動する: NSSM (Non-Sucking Service Manager) や Windowsの sc コマンドを使用して、バックグラウンドサービスとして登録できます。 例（NSSMを使用）:

   nssm install mDNSProxy "C:\path\to\mdns_proxy.exe"
   nssm start mDNSProxy

ログ出力内容

log/mdns_proxy.log には、システムの動作状況に関するログが出力されます。主な出力内容は以下の通りです。

• 起動・停止ログ: プログラムの起動時および終了時のメッセージ。
  • 出力例: INFO - mDNS Proxy started on 0.0.0.0
• エラー・警告ログ: データベースのアクセスエラー、ネットワーク通信の失敗、設定ファイルの読み込みエラーなど。
  • 出力例: ERROR - Failed to connect to external proxy at 192.168.1.10
• 名前解決ログ: ローカルネットワークでのmDNS名前解決リクエストおよびレスポンスの処理状況。
  • 出力例: DEBUG - Resolved test-device1.local to 192.168.0.50
• 同期・マージログ: 他のセグメントのプロキシから取得したホスト情報の同期およびデータベースへのマージに関する記録。
  • 出力例: INFO - Merged 3 records from external proxy 192.168.1.10
• スケジューラー実行ログ: 定期実行される外部プロキシとの通信や、期限切れ（TTLオーバー）レコードのクリーンアップ処理の記録。
  • 出力例: INFO - Removed 2 expired records during cleanup

ログローテーション

ログファイルは1日ごとにローテーションされます。

• 古いログはZIP圧縮されて保存されます。
• 最大で3世代前（3日分）までのアーカイブが保持され、それより古いログファイルは自動的に削除されます。