マルチプロトコルゲートウェイ
EMQX マルチプロトコルゲートウェイは、MQTT以外のすべてのプロトコル接続、認証、およびメッセージの送受信を処理する機能を提供します。さまざまなプロトコルに対して統一された概念モデルを提供します。
EMQX 5.0以前は、MQTT以外のプロトコルアクセスは個別のプロトコルプラグインによって実装されていました。これらのプラグインは設計や実装が異なり、利用が難しい面がありました。
5.0以降、EMQXはマルチプロトコルゲートウェイを提供し、統一された概念および運用モデルを定義することで、より使いやすくなっています。
マルチプロトコルゲートウェイは、MQTT-SN、STOMP、CoAP、LwM2Mなどのプロトコルをサポートしています。ダッシュボードから直接有効化および設定できるほか、REST APIやbase.hoconで管理することも可能です。これらのゲートウェイの有効化方法やビジネスニーズに合わせた設定カスタマイズについては、以下のリンクをご参照ください。
重要なお知らせ
ExProtoゲートウェイはEMQX 6.2.0で非推奨となり、EMQX 7で削除予定です。
マルチプロトコルゲートウェイの仕組み
EMQX マルチプロトコルゲートウェイは、リスナー、接続／セッション、パブリッシュ／サブスクライブ、認証、認可などの主要コンポーネントに対して統一された概念および運用モデルを定義しています。
各コンポーネントの概要は以下の通りです：
- リスナー：TCP、SSL、UDP、DTLSのリスナータイプをサポートします。各ゲートウェイは複数のリスナーを作成可能です。
- 接続／セッション：ゲートウェイは受け入れたクライアント接続ごとにセッションを作成し、サブスクリプションリスト、配信／受信キュー、およびクライアントメッセージの再送制御を管理します。
- パブリッシュ／サブスクライブ：各ゲートウェイタイプは、MQTTプロトコルのPUB/SUBメッセージモデルに適応する方法を定義します。PUB/SUBを持たないプロトコルでは、メッセージのトピックやペイロードの設定が必要であり、ゲートウェイタイプごとに異なるメッセージフォーマットを使用する場合があります。
- 認証：各ゲートウェイはクライアント情報を用いたログイン認可のために認証機能を設定可能です。
主な機能
リスナー
各ゲートウェイは複数のリスナーを有効化でき、プロトコルごとに以下のリスナータイプをサポートしています：
| TCP | UDP | SSL | DTLS | Websocket | Websocket over TLS | |
|---|---|---|---|---|---|---|
| MQTT-SN | ✔︎ | ✔︎ | ||||
| STOMP | ✔︎ | ✔︎ | ||||
| CoAP | ✔︎ | ✔︎ | ||||
| LwM2M | ✔︎ | ✔︎ | ||||
| ExProto | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ||
| OCPP | ✔︎ | ✔︎ | ||||
| GB/T 32960 | ✔︎ | ✔︎ | ||||
| JT/T 808 | ✔︎ | ✔︎ | ||||
| NATS | ✔︎ | ✔︎ | ✔︎ | ✔︎ |
メッセージフォーマット
PUB/SUBメッセージモデルとの互換性を確保するため、各ゲートウェイタイプは基盤となるプロトコルにPUB/SUBの概念があるかどうかに適応する必要があります。
MQTT-SNやSTOMPのようにPUB/SUBの概念があるプロトコルでは、クライアントが送信するトピックとペイロードをそのまま使用するため、メッセージフォーマットの変換は不要です。
CoAPやLwM2MのようにPUB/SUBの概念がないプロトコルでは、トピックやパブリッシュ、サブスクライブの定義がありません。この場合、ゲートウェイ側でメッセージ内容のフォーマットを設計し、ゲートウェイタイプごとに異なるフォーマットを使用することがあります。
- CoAP：CoAPゲートウェイはPublish-Subscribe Broker for the CoAP標準で定義されたURIパスとメソッドを使用します。詳細はメッセージパブリッシュ、トピックサブスクライブ、トピックサブスクライブ解除をご覧ください。
- LwM2M：LwM2Mプロトコルのメッセージモデルはリソースモデルと操作に基づいており、MQTTのパブリッシュ／サブスクライブモデルとは全く異なります。詳細はLwM2Mゲートウェイ - メッセージフォーマットをご参照ください。
認証
認証は、システムに接続しようとするクライアントの身元を検証するプロセスです。バージョン5.0以降、ゲートウェイはログイン認可のための認証機能をサポートしています。
ゲートウェイによってサポートされる認証タイプは異なりますが、すべてのゲートウェイはHTTPベースの認証をサポートしています。HTTPベース認証の詳細は以下の表をご覧ください。
| HTTPサーバー | 組み込みデータベース | MySQL | MongoDB | PostgreSQL | Redis | JWT | LDAP | |
|---|---|---|---|---|---|---|---|---|
| MQTT-SN | ✔︎ | |||||||
| STOMP | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ |
| CoAP | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ |
| LwM2M | ✔︎ | |||||||
| Exproto | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ |
| OCPP | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ |
| GB/T 32960 | ✔︎ | |||||||
| JT/T 808 | N/A | N/A | N/A | N/A | N/A | N/A | N/A | |
| NATS | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ | ✔︎ |
注：認証機能が設定されていない場合、どのクライアントもログイン可能です。
ゲートウェイにおける認証の仕組み
EMQX マルチプロトコルゲートウェイは、接続してくるクライアントの認証を担当します。これは接続ごとにClientInfoを作成することで実現されます。
ClientInfoには、認証に一般的に使用されるUsernameやPasswordなどの共通フィールドが含まれています。さらに、各ゲートウェイはLwM2MのEndpoint Nameのような独自のクライアント情報フィールドを持ち、これらも認証に利用される場合があります。
認証機能が設定されている場合、ゲートウェイはクライアントのUsernameとPasswordをデータベース内の情報と照合し、一致すればクライアントを認証し、ゲートウェイへのアクセスを許可します。
TIP
異なるゲートウェイ間でクライアントIDは重複可能ですが、同じゲートウェイ内で重複したクライアントIDがログインすると、既存のそのクライアントIDに紐づくセッションは切断されます。
外部システムとの連携
外部システムとの連携を強化するため、ゲートウェイはEMQXで定義されたフックもサポートしています。
ゲートウェイ間で意味論の異質性があるため、利用可能なコアフックは一部に限られています。
クライアント接続関連のフックのサポート状況は以下の通りです：
外部システムとの相互運用性向上のため、ゲートウェイはEMQXで定義されたフックをサポートするよう設計されています。
ただし、各ゲートウェイ間で意味論が異なるため、利用可能なコアフックは限定的です。クライアント接続関連のサポートされるフックは以下の表をご参照ください。
| 名前 | 必須かどうか | 説明 | 対応プロトコル |
|---|---|---|---|
client.connect | 任意 | クライアント接続要求の数（成功・失敗を含む） | すべてのゲートウェイ |
client.connack | 任意 | クライアントが受信したCONNACKメッセージの数 | すべてのゲートウェイ |
client.authenticate | 必須 | 認証されたクライアントの数 | |
client.connected | 必須 | 正常に接続されたクライアントの数 | すべてのゲートウェイ |
client.disconnected | 必須 | アクティブまたは異常切断を含む切断されたクライアントの数 | すべてのゲートウェイ |
client.authorize | 必須 | 認可されたクライアントのパブリッシュ／サブスクライブ要求の数 | すべてのゲートウェイ |
client.subscribe | 任意 | クライアントのトピックサブスクライブ試行回数 | MQTT-SN STOMP |
client.unsubscribe | 任意 | クライアントのトピックサブスクライブ解除試行回数 | MQTT-SN STOMP |
セッションおよびメッセージ関連のフックはプロトコル間で意味論の違いがないため、各ゲートウェイタイプで完全にサポートされています。
フックの詳細についてはフックをご覧ください。