EMQX

日本語

简体中文
English

日本語

简体中文
English

Appearance

お問い合わせ

ExProto ゲートウェイ ​

Extension Protocol（ExProto）は、gRPC通信を用いて実装されたカスタムプロトコル解析ゲートウェイです。Java、Python、Goなど、ユーザーが好みのプログラミング言語でgRPCサービスを開発できるようにします。これらのサービスはデバイスのネットワークプロトコルを解析し、デバイス接続、認証、メッセージ送信などの機能を支援します。

本ページでは、ExProtoゲートウェイの動作原理とEMQXにおけるExProtoゲートウェイの設定および利用方法を紹介します。

ExProtoゲートウェイとgRPCサービスの動作 ​

EMQXでExProtoゲートウェイを有効にすると、特定のポート（例：7993）でデバイス接続を待ち受けます。クライアントデバイスから接続を受け取ると、クライアントデバイスから生成されたバイトデータやイベントをユーザーのgRPCサービスに渡します。これは、ExProtoゲートウェイ内のgRPCクライアントが、ユーザーのgRPCサーバーで実装されたConnectionUnaryHandlerサービスのメソッドを呼び出すことで実現されます。

ユーザーのgRPCサーバー内のgRPCサービスは、ExProtoゲートウェイから受け取ったバイトデータやイベントを解析し、クライアントのネットワークプロトコルを解釈してバイトデータやイベントをPub/Subリクエストに変換し、ExProtoゲートウェイに返します。ExProtoゲートウェイに実装されたConnectionAdapterサービスは、ユーザーのgRPCサーバーとやり取りするためのインターフェースを提供します。これにより、クライアントデバイスはExProtoゲートウェイを通じてEMQXにメッセージをパブリッシュしたり、トピックをサブスクライブしたり、クライアント接続を管理したりできます。

以下の図は、ExProtoゲートウェイとgRPCサービスの動作アーキテクチャを示しています。

ExProtoゲートウェイのアーキテクチャ

exproto.proto ファイル ​

exproto.protoファイルは、ExProtoゲートウェイとユーザーのgRPCサービス間のインターフェースを定義します。ファイルには以下の2つのサービスが指定されています。

  • ConnectionAdapterサービス：ExProtoゲートウェイが実装し、gRPCサーバーへのインターフェースを提供します。
  • ConnectionUnaryHandlerサービス：ユーザーのgRPCサーバーが実装し、クライアントソケットの接続処理やバイト解析のメソッドを定義します。

ConnectionUnaryHandler サービス ​

ConnectionUnaryHandlerサービスは、ユーザーのgRPCサーバーが実装し、クライアントソケットの接続処理やバイト解析を担当します。

このサービスには以下のメソッドが含まれます。

メソッド名説明
OnSocketCreated新しいソケットがExProtoゲートウェイに接続されるたびに呼び出されるコールバックです。
OnSocketClosedソケットが閉じられるたびに呼び出されるコールバックです。
OnReceivedBytesクライアントのソケットからデータを受信するたびに呼び出されるコールバックです。
OnTimerTimeoutタイマーがタイムアウトするたびに呼び出されるコールバックです。
OnReceivedMessagesサブスクライブしたトピックにメッセージが届くたびに呼び出されるコールバックです。

ExProtoゲートウェイがこれらのメソッドを呼び出す際、どのソケットからのイベントかを識別するために一意の識別子connをパラメータとして渡します。例えば、OnSocketCreated関数のパラメータは以下のようになります。

message SocketCreatedRequest {
  string conn = 1;
  ConnInfo conninfo = 2;
}

TIP

ExProtoゲートウェイはプライベートプロトコルのメッセージフレームの開始・終了を認識できないため、TCPパケットのスティッキングや分割が発生した場合はOnReceivedBytesコールバック内で処理する必要があります。

ConnectionAdapter サービス ​

ConnectionAdapterサービスはExProtoゲートウェイが実装し、gRPCサービスがサブスクリプションの開始、メッセージのパブリッシュ、タイマーの開始、接続のクローズなど接続管理を行うための機能を提供します。以下のメソッドを含みます。

メソッド名説明
Send指定された接続にバイトを送信します。
Close指定された接続を閉じます。
AuthenticateクライアントをExProtoゲートウェイに登録し認証を完了します。
StartTimer指定された接続のためにタイマーを開始します。通常は生存確認に使用されます。
Publish指定された接続からEMQXにメッセージをパブリッシュします。
Subscribe指定された接続のためにサブスクリプションを作成します。
Unsubscribe指定された接続のためにサブスクリプションを削除します。
RawPublishEMQXにメッセージをパブリッシュします。

ExProtoゲートウェイの有効化 ​

EMQXのExProtoゲートウェイは、ダッシュボード、HTTP API、または設定ファイルbase.hoconを通じて設定および有効化できます。本節ではダッシュボードを使った有効化方法を説明します。

EMQXダッシュボードの左側ナビゲーションメニューから Management -> Gateways をクリックします。Gatewaysページにはサポートされているすべてのゲートウェイが一覧表示されます。ExProtoを見つけ、Actions列のSetupをクリックすると、Initialize ExProtoページに遷移します。

TIP

EMQXをクラスターで運用している場合、ダッシュボードやHTTP APIで行った設定はクラスター全体に影響します。特定のノードのみ設定を変更したい場合は、base.hoconでゲートウェイを設定してください。

設定を簡単にするため、EMQXはGatewaysページのすべての必須フィールドにデフォルト値を用意しています。大幅なカスタマイズが不要な場合、わずか3クリックでExProtoゲートウェイを有効化できます。

  1. Basic ConfigurationステップページでNextをクリックし、すべてのデフォルト設定を受け入れます。
  2. 次に表示されるListenersステップページでは、EMQXがポート7993でTCPリスナーを事前設定しています。設定を確認し、再度Nextをクリックします。
  3. EnableボタンをクリックしてExProtoゲートウェイを有効化します。

ゲートウェイの有効化が完了すると、Gatewaysページに戻り、ExProtoゲートウェイがEnabledステータスで表示されます。

有効化されたExProtoゲートウェイ

上記の設定はHTTP APIでも可能です。

例：

bash
curl -X 'PUT' 'http://127.0.0.1:18083/api/v5/gateway/exproto' \
  -u <your-application-key>:<your-security-key> \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "exproto",
  "enable": true,
  "mountpoint": "exproto/",
  "server": {
    "bind": "0.0.0.0:9100"
  }
  "handler": {
    "address": "http://127.0.0.1:9001"
    "ssl_options": {"enable": false}
  }
  "listeners": [
    {
      "type": "tcp",
      "bind": "7993",
      "name": "default",
      "max_conn_rate": 1000,
      "max_connections": 1024000
    }
  ]
}'

詳細なREST APIの説明はREST APIを参照してください。

より細かいカスタマイズやリスナーの追加、認証ルールの追加が必要な場合は、Customize Your ExProto Gatewayをお読みください。

ExProtoゲートウェイのカスタマイズ ​

デフォルト設定に加え、EMQXはさまざまな設定オプションを提供し、特定のビジネス要件に柔軟に対応できます。本節ではGatewaysページで利用可能な設定オプションを詳しく解説します。

基本設定 ​

GatewaysページでExProtoを見つけ、Actions列のSettingsをクリックします。Settingsタブでは、ConnectionUnaryHandlerサービスのアドレス、ConnectionAdapterのリスニングポート、ゲートウェイのMountPoint文字列をカスタマイズできます。

基本設定
  • Enable Statistics：ゲートウェイが統計情報を収集・報告するかどうかを設定します。デフォルトはtrue。選択肢はtrue、falseです。
  • Idle Timeout：接続中のクライアントが非アクティブとなってから切断とみなすまでの秒数を設定します。デフォルトは30秒です。
  • MountPoint：パブリッシュやサブスクライブ時にすべてのトピックに接頭辞として付与される文字列を設定します。異なるプロトコル間でのメッセージルーティングの分離を実現します（例：mqttsn/）。このトピック接頭辞はゲートウェイが管理し、クライアントは明示的に追加する必要はありません。
  • gRPC ConnectionAdapter：ConnectionAdapterサービスの起動設定を行います。
    • Bind：gRPCサーバーのリスニングアドレスとポート。デフォルトは0.0.0.0:9100です。
      • TLS Verify Client：ピア認証の有効・無効を設定します。デフォルトは無効です。有効にすると、関連するTLS Cert、TLS Key、CA Cert情報をファイルの内容入力またはSelect Fileボタンでアップロードして設定できます。詳細はEnable SSL/TLS Connectionを参照してください。
  • gRPC ConnectionHandler：ConnectionUnaryHandlerを実装したコールバックサーバーの設定を行います。
    • Server：コールバックgRPCサーバーのアドレス。
      • Enable TLS：gRPCサーバーのTLS接続を有効にします。デフォルトは無効です。有効にすると以下の設定が可能です。
        • TLS Verify：ピア認証の有効・無効。デフォルトは無効。設定方法は上記と同様です。
        • SNI：TLS Server Name Indication拡張で使用するホスト名を指定します。

リスナーの追加 ​

デフォルトで、ポート7993に名前defaultのTCPリスナーが設定されており、1秒あたり最大1,000接続、最大1,024,000同時接続をサポートします。より詳細な設定をしたい場合は、Listenersタブで編集、削除、新規追加が可能です。

ExProtoリスナー設定

+ Add ListenerをクリックするとAdd Listenerページが開き、以下の設定が行えます。

基本設定

  • Name：リスナーの一意識別子を設定します。
  • Type：プロトコルタイプを選択します。ExProtoの場合、udpまたはdtlsを選択可能です。
  • Bind：リスナーが接続を受け付けるポート番号を設定します。
  • MountPoint（任意）：パブリッシュやサブスクライブ時にトピックに付与する接頭辞を設定し、異なるプロトコル間のメッセージルーティング分離を実現します。

リスナー設定

  • Acceptor：アクセプタプールのサイズを設定します。デフォルトは16です。
  • Max Connections：リスナーが処理可能な最大同時接続数を設定します。デフォルトは1024000です。
  • Max Connection Rate：リスナーが1秒あたり受け入れ可能な新規接続の最大レートを設定します。デフォルトは1000です。
  • Proxy Protocol：EMQXクラスターがHAProxyやNGINXの背後にある場合、Proxy Protocol V1/V2を有効にします。デフォルトはfalseです。
  • Proxy Protocol Timeout：Proxy Protocolパケット受信のタイムアウト時間（秒）。タイムアウト内に受信できない場合、EMQXはTCP接続を閉じます。デフォルトは3秒です。

TCP設定

  • ActiveN：ソケットの{active, N}オプションを設定します。これはソケットが積極的に処理可能な受信パケット数を示します。詳細はErlang Documentation - setopts/2を参照してください。
  • Buffer：受信および送信パケットを格納するバッファサイズ（KB単位）を設定します。
  • TCP_NODELAY：接続に対してTCP_NODELAYフラグを設定します。デフォルトはfalseです。
  • SO_REUSEADDR：ローカルポート番号の再利用を許可するかどうかを設定します。デフォルトはtrueです。
  • Send Timeout：接続のTCP送信タイムアウト時間を秒単位で設定します。デフォルトは15秒です。
  • Send Timeout Close：送信タイムアウト時に接続を閉じるかどうかを設定します。デフォルトはtrueです。

TLS設定（SSLリスナーのみ）

TLS Verifyの有効化はトグルスイッチで設定できますが、その前に関連するTLS Cert、TLS Key、CA Cert情報をファイルの内容入力またはSelect Fileボタンでアップロードして設定してください。詳細はEnable SSL/TLS Connectionを参照してください。

続いて以下の設定が可能です。

  • SSL Versions：サポートするTLSバージョンを設定します。デフォルトはtlsv1、tlsv1.1、tlsv1.2、tlsv1.3です。
  • SSL Fail If No Peer Cert：クライアントが空の証明書を送信した場合に接続を拒否するかどうかを設定します。デフォルトはfalse。選択肢はtrue、falseです。
  • CACert Depth：ピア証明書に続く有効な認証パスに含まれる自己発行でない中間証明書の最大数を設定します。デフォルトは10です。
  • Key File Passphrase：秘密鍵がパスワード保護されている場合に使用するパスワードを設定します。

認証の設定 ​

ExProtoゲートウェイは以下のような多様な認証方式をサポートしています。

クライアント情報のClient ID、Username、PasswordはすべてConnectionAdapterのAuthenticateメソッドに渡されたパラメータから取得されます。

本節ではダッシュボードを例に認証設定方法を説明します。

ExProtoページでAuthenticationタブをクリックします。

+ Create Authenticationをクリックし、MechanismにPassword-Basedを選択、BackendにHTTP Serverを選択してNextをクリックします。Configurationでは認証ルールを設定できます。各項目の詳細はHTTP Server Authenticationを参照してください。

mqttsn認証設定

上記の設定はHTTP APIでも可能です。

例：

bash
curl -X 'POST' 'http://127.0.0.1:18083/api/v5/gateway/exproto/authentication' \
  -u <your-application-key>:<your-security-key> \
  -H 'Content-Type: application/json' \
  -d '{
  "method": "post",
  "url": "http://127.0.0.1:8080",
  "headers": {
    "content-type": "application/json"
  },
  "body": {
    "username": "${username}",
    "password": "${password}"
  },
  "pool_size": 8,
  "connect_timeout": "5s",
  "request_timeout": "5s",
  "enable_pipelining": 100,
  "ssl": {
    "enable": false,
    "verify": "verify_none"
  },
  "backend": "http",
  "mechanism": "password_based",
  "enable": true
}'

テスト用のサンプルgRPCサービスの起動 ​

本節では、ExProtoゲートウェイとgRPCサービスが連携して動作する様子を、サンプルgRPCサービスを起動して示します。

このデモでは、telnetコマンドを使ってTCPプロトコルでメッセージの送受信を行うクライアントをシミュレートします。実際の環境では、カスタムプライベートプロトコルを実装したデバイスがポート7993のTCPリスナーに接続します。ExProtoゲートウェイはポート7993でクライアント接続を受け付け、ポート9100でexproto.protoファイルに定義されたConnectionAdapterサービスを提供します。

emqx-extension-examplesには様々な言語で書かれたサンプルgRPCサービスがあります。本デモでは、PythonでConnectionUnaryHandlerサービスを実装したエコープログラムexproto-svr-pythonを例に使います。このプログラムはTCPクライアントから受信したデータをそのまま返します。実際の環境では、これらのアップストリームメッセージをEMQXにパブリッシュしたり、EMQXからメッセージを受信してクライアント接続に届けたりします。

以下はexproto-svr-pythonを例にした手順です。

前提条件

開始前に以下を完了していることを確認してください。

  • EMQX 5.1.0以上を起動し、ExProtoゲートウェイをデフォルト設定で有効化していること。

  • Python 3.7以上をインストールし、以下の依存パッケージをインストールしていること。

    python -m pip install grpcio
python -m pip install grpcio-tools

  1. EMQXが動作している同一マシンで、サンプルコードをクローンし、exproto-svr-pythonディレクトリに移動します。

    bash
    git clone https://github.com/emqx/emqx-extension-examples
cd exproto-svr-python

  2. 次のコマンドでgRPCサーバーを起動します。

    python exproto_server.py

    起動に成功すると、以下のような出力が表示されます。

    ConnectionUnaryHandler started successfully, listening on 9001

Tips: If the Listener of EMQX ExProto gateway listen on 7993:
      You can use the telnet to test the server, for example:

      telnet 127.0.0.1 7993

Waiting for client connections...

  3. telnetを使ってExProtoゲートウェイがリッスンしているポート7993にアクセスし、Hi, this is tcp client!と入力してgRPCサーバーが正常に動作しているかテストします。例：

    $ telnet 127.0.0.1 7993
Trying 127.0.0.1...
Connected to 127.0.0.1.
Escape character is '^]'.
Hi, this is tcp client!
Hi, this is tcp client!

  4. EMQXダッシュボードで左側ナビゲーションメニューから Management -> Gateways をクリックし、ExProtoのClientsをクリックします。ExProtoページでtelnetで接続したクライアントが表示されます。

    接続されたExProtoクライアント

サンプルのシーケンス図 ​

以下の図は、本例における接続とメッセージ配送のシーケンスを示しています。

ExProtoシーケンス図> exproto-svr-python: Succeed

exproto-svr-python ->> ExProto Gateway: Call 'Subscribe' to subscribe 'test/echo' ExProto Gateway -->> exproto-svr-python: Succeed exproto-svr-python ->> ExProto Gateway: Call 'StartTimer' to start keepalive timer ExProto Gateway -->> exproto-svr-python: Succeed exproto-svr-python -->> ExProto Gateway: OnSocketCreated return end Telnet ->> ExProto Gateway: Send 'Hi, this is...' rect rgb(100,150, 240) ExProto Gateway ->> exproto-svr-python: Call OnReceivedBytes exproto-svr-python --> exproto-svr-python: Use 'Hi, this is...' to create a message exproto-svr-python ->> ExProto Gateway: Call Publish to publish message to 'test/echo' ExProto Gateway -->> ExProto Gateway: Route the message ExProto Gateway -->> exproto-svr-python: Succeed exproto-svr-python -->> ExProto Gateway: OnReceivedBytes return end rect rgb(100, 150, 200) ExProto Gateway ->> exproto-svr-python: Call OnReceivedMessages exproto-svr-python -->> exproto-svr-python: Use message payload exproto-svr-python ->> ExProto Gateway: Call Send to deliver bytes 'Hi, this is ...' ExProto Gateway -->> exproto-svr-python: Succeed ExProto Gateway ->> Telnet: Deliver 'Hi, this is...' exproto-svr-python -->> ExProto Gateway: OnReceivedMessages return end ```-->