マルチプロトコルゲートウェイ
EMQX マルチプロトコルゲートウェイは、MQTT以外のすべてのプロトコル接続、認証、およびメッセージの送受信を処理できる機能を提供します。さまざまなプロトコルに対して統一された概念モデルを提供します。
EMQX 5.0以前は、MQTT以外のプロトコルアクセスは個別のプロトコルプラグインで実装されていました。これらのプラグインは設計や実装が異なり、利用が難しい面がありました。
5.0以降は、EMQXはマルチプロトコルゲートウェイとして統一された概念および運用モデルを定義し、より使いやすくなっています。
マルチプロトコルゲートウェイは、MQTT-SN、STOMP、CoAP、LwM2Mなどのプロトコルをサポートしています。Dashboard上で直接有効化・設定できるほか、HTTP APIやbase.hoconで管理可能です。これらのゲートウェイの有効化方法やビジネスニーズに合わせた設定カスタマイズについては、以下のリンクをご参照ください。
マルチプロトコルゲートウェイの仕組み
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 | ✔︎ | ✔︎ |
メッセージフォーマット
PUB/SUBメッセージモデルとの互換性を確保するため、各ゲートウェイタイプは基盤となるプロトコルにPUB/SUBの概念があるかどうかに適応する必要があります。
MQTT-SNやStompのようにPUB/SUBの概念を持つプロトコルでは、クライアントが送信するトピックとペイロードを利用するため、メッセージフォーマットの変換は不要です。
一方、CoAPやLwM2MのようにPUB/SUBの概念を持たないプロトコルでは、トピックやパブリッシュ、サブスクライブの定義がありません。この場合、ゲートウェイがメッセージ内容のフォーマットを設計し、各タイプで異なるフォーマットを使用することがあります。
- CoAP：CoAPゲートウェイは、Publish-Subscribe Broker for the CoAP標準で定義されたURIパスとメソッドを使用します。詳細はMessage Publish、Topic Subscribe、Topic Unsubscribeをご覧ください。
- LwM2M：LwM2Mプロトコルのメッセージモデルは、Resources Model and Operationsに基づいており、MQTTのPublish/Subscribeモデルとは全く異なります。詳細はLwM2M Gateway - Message Formatをご参照ください。
認証
認証は、システムに接続しようとするクライアントの身元を検証するプロセスです。バージョン5.0以降、ゲートウェイはログイン認可のための認証機能をサポートしています。
ゲートウェイによってサポートする認証タイプは異なりますが、すべてのゲートウェイはHTTPベースの認証をサポートしています。HTTPベース認証をご参照ください。以下の表はサポートされる認証タイプを示しています：
| HTTP Server | Built-in Database | 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 |
注：認証機能が設定されていない場合は、どのクライアントもログイン可能です。
ゲートウェイにおける認証の仕組み
EMQX マルチプロトコルゲートウェイは、接続してくるクライアントの認証を担当します。これは接続ごとにClientInfoを作成することで実現されます。
ClientInfoには、認証に一般的に使用されるUsernameやPasswordなどの共通フィールドが含まれます。加えて、LwM2MのEndpoint Nameのように、各ゲートウェイ固有のクライアント情報フィールドも認証に利用される場合があります。
認証機能が設定されている場合、ゲートウェイはクライアントのUsernameとPasswordを自身のデータベースに保存された情報と照合し、一致すればクライアントは認証されゲートウェイへのアクセスが許可されます。
TIP
異なるゲートウェイ間でクライアントIDは重複可能ですが、同一ゲートウェイ内で重複したクライアントIDがログインすると、既存のそのクライアントIDに紐づくセッションは切断されます。
外部システムとの連携
外部システムとの連携を強化するため、ゲートウェイはEMQXで定義されたフックもサポートしています。
ゲートウェイ間の意味論の違いにより、利用可能なコアフックは一部に限られます。
クライアント接続関連のフックのサポート状況は以下の通りです：
外部システムとの相互運用性向上のため、ゲートウェイはEMQXで定義されたフックをサポートする設計となっています。
ただし、各ゲートウェイ間の意味論の違いにより、コアフックのうち一部のみ利用可能です。以下の表はクライアント接続関連のサポートされるフックを示しています：
| Name | 必須かどうか | 説明 | 対応プロトコル |
|---|---|---|---|
client.connect | 任意 | クライアント接続要求の数（成功・失敗を含む） | 全ゲートウェイ |
client.connack | 任意 | クライアントが受信したCONNACKメッセージの数 | 全ゲートウェイ |
client.authenticate | 必須 | 認証されたクライアントの数 | |
client.connected | 必須 | 成功裏に接続したクライアントの数 | 全ゲートウェイ |
client.disconnected | 必須 | クライアント切断数（正常・異常切断を含む） | 全ゲートウェイ |
client.authorize | 必須 | 認可されたクライアントのパブリッシュ／サブスクライブ要求数 | 全ゲートウェイ |
client.subscribe | 任意 | クライアントのトピックサブスクライブ試行数 | MQTT-SN STOMP |
client.unsubscribe | 任意 | クライアントのトピックサブスクライブ解除試行数 | MQTT-SN STOMP |
セッションおよびメッセージ関連のフックはプロトコル間の意味論の違いがないため、各ゲートウェイタイプで完全にサポートされています。
フックの詳細についてはHooksをご覧ください。