マルチプロトコルゲートウェイ
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
異なるゲートウェイ間でのClient IDの重複は可能ですが、同一ゲートウェイ内で重複したClient IDがログインすると、既存のそのClient 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 |
セッションおよびメッセージ関連のフックはプロトコル間の異質性がないため、各ゲートウェイタイプで完全にサポートされています。
フックの詳細についてはHooksをご参照ください。